11 #include <mpath_persist.h>
17 static const char * pr_type_strs[] = {
23 "Write Exclusive, registrants only",
24 "Exclusive Access, registrants only",
25 "Write Exclusive, all registrants",
26 "Exclusive Access, all registrants",
27 "obsolete [9]", "obsolete [0xa]", "obsolete [0xb]", "obsolete [0xc]",
28 "obsolete [0xd]", "obsolete [0xe]", "obsolete [0xf]",
31 int get_transportids_length(unsigned char * transportid_arr, int max_transportid, int num_transportids);
32 void mpath_print_buf_readcap(struct prin_resp *pr_buff);
33 void mpath_print_buf_readfullstat(struct prin_resp *pr_buff);
34 void mpath_print_buf_readresv(struct prin_resp *pr_buff);
35 void mpath_print_buf_readkeys(struct prin_resp *pr_buff);
36 void dumpHex(const char* str, int len, int no_ascii);
37 void * mpath_alloc_prin_response(int prin_sa);
38 void mpath_print_transport_id(struct prin_fulldescr *fdesc);
39 int construct_transportid(const char * inp, struct transportid transid[], int num_transportids);
42 unsigned int mpath_mx_alloc_len;
44 int main (int argc, char * argv[])
47 const char *device_name = NULL;
50 int num_prout_param = 0;
55 uint64_t param_sark = 0;
56 unsigned int prout_type = 0;
57 int param_alltgpt = 0;
59 uint64_t param_rk = 0;
60 unsigned int param_rtp = 0;
61 int num_transportids = 0;
62 struct transportid transportids[MPATH_MX_TIDS];
72 struct transportid * tmp;
73 struct udev *udev = NULL;
78 fprintf (stderr, "No parameter used\n");
85 fprintf (stderr, "need to be root\n");
91 memset(transportids,0,MPATH_MX_TIDS);
97 c = getopt_long (argc, argv, "v:Cd:hHioZK:S:PAT:skrGILcRX:l:",
98 long_options, &option_index);
105 if (1 != sscanf (optarg, "%d", &loglevel))
107 fprintf (stderr, "bad argument to '--verbose'\n");
108 return MPATH_PR_SYNTAX_ERROR;
113 prout_sa = MPATH_PROUT_CLEAR_SA;
118 device_name = optarg;
142 if (1 != sscanf (optarg, "%" SCNx64 "", ¶m_rk))
144 fprintf (stderr, "bad argument to '--param-rk'\n");
145 return MPATH_PR_SYNTAX_ERROR;
151 if (1 != sscanf (optarg, "%" SCNx64 "", ¶m_sark))
153 fprintf (stderr, "bad argument to '--param-sark'\n");
154 return MPATH_PR_SYNTAX_ERROR;
160 prout_sa = MPATH_PROUT_PREE_SA;
165 prout_sa = MPATH_PROUT_PREE_AB_SA;
170 if (1 != sscanf (optarg, "%x", &prout_type))
172 fprintf (stderr, "bad argument to '--prout-type'\n");
173 return MPATH_PR_SYNTAX_ERROR;
179 prin_sa = MPATH_PRIN_RFSTAT_SA;
184 prin_sa = MPATH_PRIN_RKEY_SA;
189 prin_sa = MPATH_PRIN_RRES_SA;
194 prout_sa = MPATH_PROUT_REG_SA;
199 prout_sa = MPATH_PROUT_REG_IGN_SA;
204 prout_sa = MPATH_PROUT_REL_SA;
209 prin_sa = MPATH_PRIN_RCAP_SA;
214 prout_sa = MPATH_PROUT_RES_SA;
219 if (0 != construct_transportid(optarg, transportids, num_transport)) {
220 fprintf(stderr, "bad argument to '--transport-id'\n");
221 return MPATH_PR_SYNTAX_ERROR;
228 if (1 != sscanf(optarg, "%u", &mpath_mx_alloc_len)) {
229 fprintf(stderr, "bad argument to '--alloc-length'\n");
230 return MPATH_PR_SYNTAX_ERROR;
231 } else if (MPATH_MAX_PARAM_LEN < mpath_mx_alloc_len) {
232 fprintf(stderr, "'--alloc-length' argument exceeds maximum"
233 " limit(%d)\n", MPATH_MAX_PARAM_LEN);
234 return MPATH_PR_SYNTAX_ERROR;
239 fprintf(stderr, "unrecognised switch " "code 0x%x ??\n", c);
241 ret = MPATH_PR_SYNTAX_ERROR;
249 if (NULL == device_name)
251 device_name = argv[optind];
256 for (; optind < argc; ++optind)
257 fprintf (stderr, "Unexpected extra argument: %s\n", argv[optind]);
259 ret = MPATH_PR_SYNTAX_ERROR;
265 noisy = (loglevel >= 3) ? 1 : hex;
266 verbose = (loglevel >= 3)? 3: loglevel;
268 if ((prout_flag + prin_flag) == 0)
270 fprintf (stderr, "choose either '--in' or '--out' \n");
272 ret = MPATH_PR_SYNTAX_ERROR;
275 if ((prout_flag + prin_flag) > 1)
277 fprintf (stderr, "choose either '--in' or '--out' \n");
279 ret = MPATH_PR_SYNTAX_ERROR;
283 { /* syntax check on PROUT arguments */
285 if ((1 != num_prout_sa) || (0 != num_prin_sa))
287 fprintf (stderr, " For Persistent Reserve Out only one "
288 "appropriate\n service action must be "
290 ret = MPATH_PR_SYNTAX_ERROR;
295 { /* syntax check on PRIN arguments */
297 if (num_prout_sa > 0)
299 fprintf (stderr, " When a service action for Persistent "
300 "Reserve Out is chosen the\n"
301 " '--out' option must be given \n");
302 ret = MPATH_PR_SYNTAX_ERROR;
305 if (0 == num_prin_sa)
308 " No service action given for Persistent Reserve IN\n");
310 ret = MPATH_PR_SYNTAX_ERROR;
312 else if (num_prin_sa > 1)
314 fprintf (stderr, " Too many service actions given; choose "
317 ret = MPATH_PR_SYNTAX_ERROR;
323 ret = MPATH_PR_SYNTAX_ERROR;
327 if ((param_rtp) && (MPATH_PROUT_REG_MOV_SA != prout_sa))
329 fprintf (stderr, " --relative-target-port"
330 " only useful with --register-move\n");
332 ret = MPATH_PR_SYNTAX_ERROR;
336 if (((MPATH_PROUT_RES_SA == prout_sa) ||
337 (MPATH_PROUT_REL_SA == prout_sa) ||
338 (MPATH_PROUT_PREE_SA == prout_sa) ||
339 (MPATH_PROUT_PREE_AB_SA == prout_sa)) &&
341 fprintf(stderr, "Warning: --prout-type probably needs to be "
344 if ((verbose > 2) && num_transportids)
346 fprintf (stderr, "number of tranport-ids decoded from "
347 "command line : %d\n", num_transportids);
350 if (device_name == NULL)
352 fprintf (stderr, "No device name given \n");
354 ret = MPATH_PR_SYNTAX_ERROR;
359 if ((fd = open (device_name, O_WRONLY)) < 0)
361 fprintf (stderr, "%s: error opening file (rw) fd=%d\n",
363 ret = MPATH_PR_FILE_ERROR;
370 resp = mpath_alloc_prin_response(prin_sa);
373 fprintf (stderr, "failed to allocate PRIN response buffer\n");
374 ret = MPATH_PR_OTHER;
378 ret = mpath_persistent_reserve_in (fd, prin_sa, resp, noisy, verbose);
379 if (ret != MPATH_PR_SUCCESS )
381 fprintf (stderr, "Persistent Reserve IN command failed\n");
387 case MPATH_PRIN_RKEY_SA:
388 mpath_print_buf_readkeys(resp);
390 case MPATH_PRIN_RRES_SA:
391 mpath_print_buf_readresv(resp);
393 case MPATH_PRIN_RCAP_SA:
394 mpath_print_buf_readcap(resp);
396 case MPATH_PRIN_RFSTAT_SA:
397 mpath_print_buf_readfullstat(resp);
405 struct prout_param_descriptor *paramp;
407 paramp= malloc(sizeof(struct prout_param_descriptor) + (sizeof(struct transportid *)*(MPATH_MX_TIDS )));
409 memset(paramp, 0, sizeof(struct prout_param_descriptor) + (sizeof(struct transportid *)*(MPATH_MX_TIDS)));
411 for (j = 7; j >= 0; --j) {
412 paramp->key[j] = (param_rk & 0xff);
416 for (j = 7; j >= 0; --j) {
417 paramp->sa_key[j] = (param_sark & 0xff);
422 paramp->sa_flags |= 0x4;
424 paramp->sa_flags |= 0x1;
428 paramp->sa_flags |= MPATH_F_SPEC_I_PT_MASK;
429 paramp->num_transportid = num_transport;
430 for (j = 0 ; j < num_transport; j++)
432 paramp->trnptid_list[j] = (struct transportid *)malloc(sizeof(struct transportid));
433 memcpy(paramp->trnptid_list[j], &transportids[j],sizeof(struct transportid));
437 /* PROUT commands other than 'register and move' */
438 ret = mpath_persistent_reserve_out (fd, prout_sa, 0, prout_type,
439 paramp, noisy, verbose);
440 for (j = 0 ; j < num_transport; j++)
442 tmp = paramp->trnptid_list[j];
448 if (ret != MPATH_PR_SUCCESS)
452 case MPATH_PR_SENSE_UNIT_ATTENTION:
453 printf("persistent reserve out: scsi status: Unit Attention\n");
455 case MPATH_PR_RESERV_CONFLICT:
456 printf("persistent reserve out: scsi status: Reservation Conflict\n");
459 printf("PR out: command failed\n");
467 return MPATH_PR_FILE_ERROR;
473 return (ret >= 0) ? ret : MPATH_PR_OTHER;
477 get_transportids_length(unsigned char * transportid_arr, int max_transportid, int num_transportids)
480 unsigned char * ucp = transportid_arr;
481 int k, off, protocol_id, len;
482 for (k = 0, off = 0; ((k < num_transportids) && (k < max_transportid));
483 ++k, off += MPATH_MX_TID_LEN) {
484 protocol_id = ucp[off] & 0xf;
485 if (5 == protocol_id) {
486 len = (ucp[off + 2] << 8) + ucp[off + 3] + 4;
489 if (off > compact_len)
490 memmove(ucp + compact_len, ucp + off, len);
494 if (off > compact_len)
495 memmove(ucp + compact_len, ucp + off, 24);
503 void mpath_print_buf_readkeys( struct prin_resp *pr_buff)
508 printf(" PR generation=0x%x, ", pr_buff->prin_descriptor.prin_readkeys.prgeneration);
510 num = pr_buff->prin_descriptor.prin_readkeys.additional_length / 8;
512 printf(" 0 registered reservation key.\n");
516 printf(" 1 registered reservation key follows:\n");
518 printf(" %d registered reservation keys follow:\n", num);
521 keyp = (unsigned char *)&pr_buff->prin_descriptor.prin_readkeys.key_list[0];
522 for (i = 0; i < num ; i++)
525 for (j = 0; j < 8; ++j) {
531 printf(" 0x%" PRIx64 "\n", prkey);
533 keyp = (unsigned char *)&pr_buff->prin_descriptor.prin_readkeys.key_list[k];
537 void mpath_print_buf_readresv( struct prin_resp *pr_buff)
539 int j, num, scope=0, type=0;
543 num = pr_buff->prin_descriptor.prin_readresv.additional_length / 8;
546 printf(" PR generation=0x%x, there is NO reservation held \n", pr_buff->prin_descriptor.prin_readresv.prgeneration);
550 printf(" PR generation=0x%x, Reservation follows:\n", pr_buff->prin_descriptor.prin_readresv.prgeneration);
551 keyp = (unsigned char *)&pr_buff->prin_descriptor.prin_readkeys.key_list[0];
553 for (j = 0; j < 8; ++j) {
559 printf(" Key = 0x%" PRIx64 "\n", prkey);
561 scope = (pr_buff->prin_descriptor.prin_readresv.scope_type >> 4) & 0x0f;
562 type = pr_buff->prin_descriptor.prin_readresv.scope_type & 0x0f;
565 printf(" scope = LU_SCOPE, type = %s", pr_type_strs[type]);
567 printf(" scope = %d, type = %s", scope, pr_type_strs[type]);
573 void mpath_print_buf_readcap( struct prin_resp *pr_buff)
575 if ( pr_buff->prin_descriptor.prin_readcap.length <= 2 ) {
576 fprintf(stderr, "Unexpected response for PRIN Report "
581 printf("Report capabilities response:\n");
583 printf(" Compatible Reservation Handling(CRH): %d\n", !!(pr_buff->prin_descriptor.prin_readcap.flags[0] & 0x10));
584 printf(" Specify Initiator Ports Capable(SIP_C): %d\n",!!(pr_buff->prin_descriptor.prin_readcap.flags[0] & 0x8));
585 printf(" All Target Ports Capable(ATP_C): %d\n",!!(pr_buff->prin_descriptor.prin_readcap.flags[0] & 0x4 ));
586 printf(" Persist Through Power Loss Capable(PTPL_C): %d\n",!!(pr_buff->prin_descriptor.prin_readcap.flags[0]));
587 printf(" Type Mask Valid(TMV): %d\n", !!(pr_buff->prin_descriptor.prin_readcap.flags[1] & 0x80));
588 printf(" Allow Commands: %d\n", !!(( pr_buff->prin_descriptor.prin_readcap.flags[1] >> 4) & 0x7));
589 printf(" Persist Through Power Loss Active(PTPL_A): %d\n",
590 !!(pr_buff->prin_descriptor.prin_readcap.flags[1] & 0x1));
592 if(pr_buff->prin_descriptor.prin_readcap.flags[1] & 0x80)
594 printf(" Support indicated in Type mask:\n");
596 printf(" %s: %d\n", pr_type_strs[7], pr_buff->prin_descriptor.prin_readcap.pr_type_mask & 0x80);
597 printf(" %s: %d\n", pr_type_strs[6], pr_buff->prin_descriptor.prin_readcap.pr_type_mask & 0x40);
598 printf(" %s: %d\n", pr_type_strs[5], pr_buff->prin_descriptor.prin_readcap.pr_type_mask & 0x20);
599 printf(" %s: %d\n", pr_type_strs[3], pr_buff->prin_descriptor.prin_readcap.pr_type_mask & 0x8);
600 printf(" %s: %d\n", pr_type_strs[1], pr_buff->prin_descriptor.prin_readcap.pr_type_mask & 0x2);
601 printf(" %s: %d\n", pr_type_strs[8], pr_buff->prin_descriptor.prin_readcap.pr_type_mask & 0x100);
605 void mpath_print_buf_readfullstat( struct prin_resp *pr_buff)
610 uint16_t rel_pt_addr;
611 unsigned char * keyp;
613 num = pr_buff->prin_descriptor.prin_readfd.number_of_descriptor;
616 printf(" PR generation=0x%x \n", pr_buff->prin_descriptor.prin_readfd.prgeneration);
620 printf(" PR generation=0x%x \n", pr_buff->prin_descriptor.prin_readfd.prgeneration);
622 for (i = 0 ; i < num; i++)
624 keyp = (unsigned char *)&pr_buff->prin_descriptor.prin_readfd.descriptors[i]->key;
627 for (j = 0; j < 8; ++j) {
633 printf(" Key = 0x%" PRIx64 "\n", prkey);
635 if (pr_buff->prin_descriptor.prin_readfd.descriptors[i]->flag & 0x02)
636 printf(" All target ports bit set\n");
638 printf(" All target ports bit clear\n");
640 rel_pt_addr = pr_buff->prin_descriptor.prin_readfd.descriptors[i]->rtpi;
641 printf(" Relative port address: 0x%x\n",
645 if (pr_buff->prin_descriptor.prin_readfd.descriptors[i]->flag & 0x1) {
646 printf(" << Reservation holder >>\n");
647 j = ((pr_buff->prin_descriptor.prin_readfd.descriptors[i]->scope_type>> 4) & 0xf);
649 printf(" scope: LU_SCOPE, ");
651 printf(" scope: %d ", j);
652 j = (pr_buff->prin_descriptor.prin_readfd.descriptors[i]->scope_type & 0xf);
653 printf(" type: %s\n", pr_type_strs[j]);
655 printf(" not reservation holder\n");
656 mpath_print_transport_id(pr_buff->prin_descriptor.prin_readfd.descriptors[i]);
663 "Usage: mpathpersist [OPTIONS] [DEVICE]\n"
665 " --verbose|-v level verbosity level\n"
666 " 0 Critical messages\n"
667 " 1 Error messages\n"
668 " 2 Warning messages\n"
669 " 3 Informational messages\n"
670 " 4 Informational messages with trace enabled\n"
671 " --clear|-C PR Out: Clear\n"
672 " --device=DEVICE|-d DEVICE query or change DEVICE\n"
673 " --help|-h output this usage message\n"
674 " --hex|-H output response in hex\n"
675 " --in|-i request PR In command \n"
676 " --out|-o request PR Out command\n"
677 " --param-aptpl|-Z PR Out parameter 'APTPL'\n"
678 " --read-keys|-k PR In: Read Keys\n"
679 " --param-sark=SARK|-S SARK PR Out parameter service "
681 " reservation key (SARK is in "
683 " --preempt|-P PR Out: Preempt\n"
684 " --preempt-abort|-A PR Out: Preempt and Abort\n"
685 " --prout-type=TYPE|-T TYPE PR Out command type\n"
686 " --read-full-status|-s PR In: Read Full Status\n"
687 " --read-keys|-k PR In: Read Keys\n"
688 " --read-reservation|-r PR In: Read Reservation\n"
689 " --register|-G PR Out: Register\n"
690 " --register-ignore|-I PR Out: Register and Ignore\n"
691 " --release|-L PR Out: Release\n"
692 " --report-capabilities|-c PR In: Report Capabilities\n"
693 " --reserve|-R PR Out: Reserve\n"
694 " --transport-id=TIDS|-X TIDS TransportIDs can be mentioned \n"
695 " in several forms\n"
697 " mpathpersist --out --register --param-sark=123abc --prout-type=5 /dev/mapper/mpath9\n"
698 " mpathpersist -i -k /dev/mapper/mpath9\n" );
702 mpath_print_transport_id(struct prin_fulldescr *fdesc)
704 switch (fdesc->trnptid.protocol_id) {
705 case MPATH_PROTOCOL_ID_FC:
707 if (0 != fdesc->trnptid.format_code)
708 printf(" [Unexpected format code: %d]\n",
709 fdesc->trnptid.format_code);
710 dumpHex((const char *)fdesc->trnptid.n_port_name, 8, 0);
712 case MPATH_PROTOCOL_ID_ISCSI:
714 if (0 == fdesc->trnptid.format_code) {
715 printf("name: %.*s\n", (int)sizeof(fdesc->trnptid.iscsi_name),
716 fdesc->trnptid.iscsi_name);
717 }else if (1 == fdesc->trnptid.format_code){
718 printf("world wide unique port id: %.*s\n",
719 (int)sizeof(fdesc->trnptid.iscsi_name),
720 fdesc->trnptid.iscsi_name);
722 printf(" [Unexpected format code: %d]\n", fdesc->trnptid.format_code);
723 dumpHex((const char *)fdesc->trnptid.iscsi_name,
724 (int)sizeof(fdesc->trnptid.iscsi_name), 0);
727 case MPATH_PROTOCOL_ID_SAS:
729 if (0 != fdesc->trnptid.format_code)
730 printf(" [Unexpected format code: %d]\n",
731 fdesc->trnptid.format_code);
732 dumpHex((const char *)fdesc->trnptid.sas_address, 8, 0);
740 construct_transportid(const char * lcp, struct transportid transid[], int num_transportids)
743 int j, n, b, c, len, alen;
747 if ((0 == memcmp("fcp,", lcp, 4)) ||
748 (0 == memcmp("FCP,", lcp, 4))) {
750 k = strspn(lcp, "0123456789aAbBcCdDeEfF");
754 fprintf(stderr, "badly formed symbolic FCP TransportID: %s\n",
758 transid[num_transportids].format_code = MPATH_PROTOCOL_ID_FC;
759 transid[num_transportids].protocol_id = MPATH_WWUI_DEVICE_NAME;
760 for (k = 0, j = 0, b = 0; k < 16; ++k) {
769 transid[num_transportids].n_port_name[j] = b | n;
776 if ((0 == memcmp("sas,", lcp, 4)) || (0 == memcmp("SAS,", lcp, 4))) {
778 k = strspn(lcp, "0123456789aAbBcCdDeEfF");
781 fprintf(stderr, "badly formed symbolic SAS TransportID: %s\n",
785 transid[num_transportids].format_code = MPATH_PROTOCOL_ID_SAS;
786 transid[num_transportids].protocol_id = MPATH_WWUI_DEVICE_NAME;
787 memcpy(&transid[num_transportids].sas_address, lcp, 8);
791 if (0 == memcmp("iqn.", lcp, 4)) {
792 ecp = strpbrk(lcp, " \t");
793 isip = strstr(lcp, ",i,0x");
794 if (ecp && (isip > ecp))
796 len = ecp ? (ecp - lcp) : (int)strlen(lcp);
797 transid[num_transportids].format_code = (isip ? MPATH_WWUI_PORT_IDENTIFIER:MPATH_WWUI_DEVICE_NAME);
798 transid[num_transportids].protocol_id = MPATH_PROTOCOL_ID_ISCSI;
799 alen = len + 1; /* at least one trailing null */
802 else if (0 != (alen % 4))
803 alen = ((alen / 4) + 1) * 4;
804 if (alen > 241) { /* sam5r02.pdf A.2 (Annex) */
805 fprintf(stderr, "iSCSI name too long, alen=%d\n", alen);
808 transid[num_transportids].iscsi_name[1] = alen & 0xff;
809 memcpy(&transid[num_transportids].iscsi_name[2], lcp, len);
813 if (k >= MPATH_MAX_PARAM_LEN) {
814 fprintf(stderr, "build_transportid: array length exceeded\n");