Bump version to 0.8.3
[multipath-tools/.git] / libmpathpersist / mpath_pr_ioctl.c
1 #include <stdio.h>
2 #include <stdlib.h>
3
4 #include <sys/types.h>
5 #include <sys/stat.h>
6 #include <fcntl.h>
7 #include <scsi/sg.h>
8 #include <scsi/scsi.h>
9 #include <unistd.h>
10 #include <string.h>
11 #include <sys/ioctl.h>
12 #include <unistd.h>
13 #include <libudev.h>
14 #include "mpath_pr_ioctl.h"
15 #include "mpath_persist.h"
16 #include "unaligned.h"
17
18 #include "debug.h"
19
20 #define FILE_NAME_SIZE          256
21
22 #define TIMEOUT 2000
23 #define MAXRETRY 5
24
25 int prin_do_scsi_ioctl(char * dev, int rq_servact, struct prin_resp *resp, int noisy);
26 void mpath_format_readkeys(struct prin_resp *pr_buff, int len , int noisy);
27 void mpath_format_readfullstatus(struct prin_resp *pr_buff, int len, int noisy);
28 int mpath_translate_response (char * dev, struct sg_io_hdr io_hdr,
29                               SenseData_t *Sensedata, int noisy);
30 void dumpHex(const char* str, int len, int no_ascii);
31 int prout_do_scsi_ioctl( char * dev, int rq_servact, int rq_scope,
32                 unsigned int rq_type, struct prout_param_descriptor *paramp, int noisy);
33 uint32_t  format_transportids(struct prout_param_descriptor *paramp);
34 void convert_be32_to_cpu(uint32_t *num);
35 void convert_be16_to_cpu(uint16_t *num);
36 void decode_transport_id(struct prin_fulldescr *fdesc, unsigned char * p, int length);
37 int get_prin_length(int rq_servact);
38 int mpath_isLittleEndian(void);
39
40 unsigned int mpath_mx_alloc_len;
41
42 int prout_do_scsi_ioctl(char * dev, int rq_servact, int rq_scope,
43                 unsigned int rq_type, struct prout_param_descriptor *paramp, int noisy)
44 {
45
46         int status, paramlen = 24, ret = 0;
47         uint32_t translen=0;
48         int retry = MAXRETRY;
49         SenseData_t Sensedata;
50         struct sg_io_hdr io_hdr;
51         char devname[FILE_NAME_SIZE];
52         int fd = -1;
53
54         snprintf(devname, FILE_NAME_SIZE, "/dev/%s",dev);
55         fd = open(devname, O_RDONLY);
56         if(fd < 0){
57                 condlog (1, "%s: unable to open device.", dev);
58                 return MPATH_PR_FILE_ERROR;
59         }
60
61         unsigned char cdb[MPATH_PROUT_CMDLEN] =
62         {MPATH_PROUT_CMD, 0, 0, 0, 0, 0, 0, 0, 0, 0};
63
64
65         if (paramp->sa_flags & MPATH_F_SPEC_I_PT_MASK)
66         {
67                 translen = format_transportids(paramp);
68                 paramlen = 24 + translen;
69         }
70         else
71                 paramlen = 24;
72
73         if ( rq_servact > 0)
74                 cdb[1] = (unsigned char)(rq_servact & 0x1f);
75         cdb[2] = (((rq_scope & 0xf) << 4) | (rq_type & 0xf));
76         cdb[7] = (unsigned char)((paramlen >> 8) & 0xff);
77         cdb[8] = (unsigned char)(paramlen & 0xff);
78
79 retry :
80         condlog(4, "%s: rq_servact = %d", dev, rq_servact);
81         condlog(4, "%s: rq_scope = %d ", dev, rq_scope);
82         condlog(4, "%s: rq_type = %d ", dev, rq_type);
83         condlog(4, "%s: paramlen = %d", dev, paramlen);
84
85         if (noisy)
86         {
87                 condlog(4, "%s: Persistent Reservation OUT parameter:", dev);
88                 dumpHex((const char *)paramp, paramlen,1);
89         }
90
91         memset(&Sensedata, 0, sizeof(SenseData_t));
92         memset(&io_hdr,0 , sizeof( struct sg_io_hdr));
93         io_hdr.interface_id = 'S';
94         io_hdr.cmd_len = MPATH_PROUT_CMDLEN;
95         io_hdr.cmdp = cdb;
96         io_hdr.sbp = (void *)&Sensedata;
97         io_hdr.mx_sb_len = sizeof (SenseData_t);
98         io_hdr.timeout = TIMEOUT;
99
100         if (paramlen > 0) {
101                 io_hdr.dxferp = (void *)paramp;
102                 io_hdr.dxfer_len = paramlen;
103                 io_hdr.dxfer_direction = SG_DXFER_TO_DEV ;
104         }
105         else {
106                 io_hdr.dxfer_direction = SG_DXFER_NONE;
107         }
108         ret = ioctl(fd, SG_IO, &io_hdr);
109         if (ret < 0)
110         {
111                 condlog(0, "%s: ioctl failed %d", dev, ret);
112                 close(fd);
113                 return ret;
114         }
115
116         condlog(4, "%s: Duration=%u (ms)", dev, io_hdr.duration);
117
118         status = mpath_translate_response(dev, io_hdr, &Sensedata, noisy);
119         condlog(3, "%s: status = %d", dev, status);
120
121         if (status == MPATH_PR_SENSE_UNIT_ATTENTION && (retry > 0))
122         {
123                 --retry;
124                 condlog(3, "%s: retrying for Unit Attention. Remaining retries = %d",
125                         dev, retry);
126                 goto retry;
127         }
128
129         if (((status == MPATH_PR_SENSE_NOT_READY )&& (Sensedata.ASC == 0x04)&&
130                                 (Sensedata.ASCQ == 0x07))&& (retry > 0))
131         {
132                 usleep(1000);
133                 --retry;
134                 condlog(3, "%s: retrying for sense 02/04/07."
135                         " Remaining retries = %d", dev, retry);
136                 goto retry;
137         }
138
139         close(fd);
140         return status;
141 }
142
143 uint32_t  format_transportids(struct prout_param_descriptor *paramp)
144 {
145         int i = 0, len;
146         uint32_t buff_offset = 4;
147         memset(paramp->private_buffer, 0, MPATH_MAX_PARAM_LEN);
148         for (i=0; i < paramp->num_transportid; i++ )
149         {
150                 paramp->private_buffer[buff_offset] = (uint8_t)((paramp->trnptid_list[i]->format_code & 0xff)|
151                                                         (paramp->trnptid_list[i]->protocol_id & 0xff));
152                 buff_offset += 1;
153                 switch(paramp->trnptid_list[i]->protocol_id)
154                 {
155                         case MPATH_PROTOCOL_ID_FC:
156                                 buff_offset += 7;
157                                 memcpy(&paramp->private_buffer[buff_offset], &paramp->trnptid_list[i]->n_port_name, 8);
158                                 buff_offset +=8 ;
159                                 buff_offset +=8 ;
160                                 break;
161                         case MPATH_PROTOCOL_ID_SAS:
162                                 buff_offset += 3;
163                                 memcpy(&paramp->private_buffer[buff_offset], &paramp->trnptid_list[i]->sas_address, 8);
164                                 buff_offset += 12;
165                                 break;
166                         case MPATH_PROTOCOL_ID_ISCSI:
167                                 buff_offset += 1;
168                                 len = (paramp->trnptid_list[i]->iscsi_name[1] & 0xff)+2;
169                                 memcpy(&paramp->private_buffer[buff_offset], &paramp->trnptid_list[i]->iscsi_name,len);
170                                 buff_offset += len ;
171                                 break;
172                 }
173
174         }
175         buff_offset -= 4;
176         paramp->private_buffer[0] = (unsigned char)((buff_offset >> 24) & 0xff);
177         paramp->private_buffer[1] = (unsigned char)((buff_offset >> 16) & 0xff);
178         paramp->private_buffer[2] = (unsigned char)((buff_offset >> 8) & 0xff);
179         paramp->private_buffer[3] = (unsigned char)(buff_offset & 0xff);
180         buff_offset += 4;
181         return buff_offset;
182 }
183
184 void mpath_format_readkeys( struct prin_resp *pr_buff, int len, int noisy)
185 {
186         convert_be32_to_cpu(&pr_buff->prin_descriptor.prin_readkeys.prgeneration);
187         convert_be32_to_cpu(&pr_buff->prin_descriptor.prin_readkeys.additional_length);
188 }
189
190 void mpath_format_readresv(struct prin_resp *pr_buff, int len, int noisy)
191 {
192
193         convert_be32_to_cpu(&pr_buff->prin_descriptor.prin_readkeys.prgeneration);
194         convert_be32_to_cpu(&pr_buff->prin_descriptor.prin_readkeys.additional_length);
195
196         return;
197 }
198
199 void mpath_format_reportcapabilities(struct prin_resp *pr_buff, int len, int noisy)
200 {
201         convert_be16_to_cpu(&pr_buff->prin_descriptor.prin_readcap.length);
202         convert_be16_to_cpu(&pr_buff->prin_descriptor.prin_readcap.pr_type_mask);
203
204         return;
205 }
206
207 void mpath_format_readfullstatus(struct prin_resp *pr_buff, int len, int noisy)
208 {
209         int num, k, tid_len_len=0;
210         uint32_t fdesc_count=0;
211         unsigned char *p;
212         char  *ppbuff;
213         uint32_t additional_length;
214         char tempbuff[MPATH_MAX_PARAM_LEN];
215         struct prin_fulldescr fdesc;
216
217         convert_be32_to_cpu(&pr_buff->prin_descriptor.prin_readfd.prgeneration);
218         convert_be32_to_cpu(&pr_buff->prin_descriptor.prin_readfd.number_of_descriptor);
219
220         if (pr_buff->prin_descriptor.prin_readfd.number_of_descriptor == 0)
221         {
222                 condlog(3, "No registration or reservation found.");
223                 return;
224         }
225
226         additional_length = pr_buff->prin_descriptor.prin_readfd.number_of_descriptor;
227         if (additional_length > MPATH_MAX_PARAM_LEN) {
228                 condlog(3, "PRIN length %u exceeds max length %d", additional_length,
229                         MPATH_MAX_PARAM_LEN);
230                 return;
231         }
232
233         memset(&fdesc, 0, sizeof(struct prin_fulldescr));
234
235         memcpy( tempbuff, pr_buff->prin_descriptor.prin_readfd.private_buffer,MPATH_MAX_PARAM_LEN );
236         memset(&pr_buff->prin_descriptor.prin_readfd.private_buffer, 0, MPATH_MAX_PARAM_LEN);
237
238         p =(unsigned char *)tempbuff;
239         ppbuff = (char *)pr_buff->prin_descriptor.prin_readfd.private_buffer;
240
241         for (k = 0; k < additional_length; k += num, p += num) {
242                 memcpy(&fdesc.key, p, 8 );
243                 fdesc.flag = p[12];
244                 fdesc.scope_type =  p[13];
245                 fdesc.rtpi = get_unaligned_be16(&p[18]);
246
247                 tid_len_len = get_unaligned_be32(&p[20]);
248                 if (tid_len_len + 24 + k > additional_length) {
249                         condlog(0,
250                                 "%s: corrupt PRIN response: status descriptor end %d exceeds length %d",
251                                 __func__, tid_len_len + k + 24,
252                                 additional_length);
253                         tid_len_len = additional_length - k - 24;
254                 }
255
256                 if (tid_len_len > 0)
257                         decode_transport_id( &fdesc, &p[24], tid_len_len);
258
259                 num = 24 + tid_len_len;
260                 memcpy(ppbuff, &fdesc, sizeof(struct prin_fulldescr));
261                 pr_buff->prin_descriptor.prin_readfd.descriptors[fdesc_count]= (struct prin_fulldescr *)ppbuff;
262                 ppbuff += sizeof(struct prin_fulldescr);
263                 ++fdesc_count;
264         }
265
266         pr_buff->prin_descriptor.prin_readfd.number_of_descriptor = fdesc_count;
267
268         return;
269 }
270
271 void
272 decode_transport_id(struct prin_fulldescr *fdesc, unsigned char * p, int length)
273 {
274         int num, k;
275         int jump;
276         for (k = 0, jump = 24; k < length; k += jump, p += jump) {
277                 fdesc->trnptid.format_code = ((p[0] >> 6) & 0x3);
278                 fdesc->trnptid.protocol_id = (p[0] & 0xf);
279                 switch (fdesc->trnptid.protocol_id) {
280                 case MPATH_PROTOCOL_ID_FC:
281                         memcpy(&fdesc->trnptid.n_port_name, &p[8], 8);
282                         jump = 24;
283                         break;
284                 case MPATH_PROTOCOL_ID_ISCSI:
285                         num = get_unaligned_be16(&p[2]);
286                         if (num >= sizeof(fdesc->trnptid.iscsi_name))
287                                 num = sizeof(fdesc->trnptid.iscsi_name);
288                         memcpy(&fdesc->trnptid.iscsi_name, &p[4], num);
289                         jump = (((num + 4) < 24) ? 24 : num + 4);
290                         break;
291                 case MPATH_PROTOCOL_ID_SAS:
292                         memcpy(&fdesc->trnptid.sas_address, &p[4], 8);
293                         jump = 24;
294                         break;
295                 default:
296                         jump = 24;
297                         break;
298                 }
299         }
300 }
301
302 int prin_do_scsi_ioctl(char * dev, int rq_servact, struct prin_resp * resp, int noisy)
303 {
304
305         int ret, status, got, fd;
306         int mx_resp_len;
307         SenseData_t Sensedata;
308         int retry = MAXRETRY;
309         struct sg_io_hdr io_hdr;
310         char devname[FILE_NAME_SIZE];
311         unsigned char cdb[MPATH_PRIN_CMDLEN] =
312         {MPATH_PRIN_CMD, 0, 0, 0, 0, 0, 0, 0, 0, 0};
313
314         snprintf(devname, FILE_NAME_SIZE, "/dev/%s",dev);
315         fd = open(devname, O_RDONLY);
316         if(fd < 0){
317                 condlog(0, "%s: Unable to open device ", dev);
318                 return MPATH_PR_FILE_ERROR;
319         }
320
321         if (mpath_mx_alloc_len)
322                 mx_resp_len = mpath_mx_alloc_len;
323         else
324                 mx_resp_len = get_prin_length(rq_servact);
325
326         if (mx_resp_len == 0) {
327                 status = MPATH_PR_SYNTAX_ERROR;
328                 goto out;
329         }
330
331         cdb[1] = (unsigned char)(rq_servact & 0x1f);
332         cdb[7] = (unsigned char)((mx_resp_len >> 8) & 0xff);
333         cdb[8] = (unsigned char)(mx_resp_len & 0xff);
334
335 retry :
336         memset(&Sensedata, 0, sizeof(SenseData_t));
337         memset(&io_hdr,0 , sizeof( struct sg_io_hdr));
338
339         io_hdr.interface_id = 'S';
340         io_hdr.cmd_len = MPATH_PRIN_CMDLEN;
341         io_hdr.mx_sb_len = sizeof (SenseData_t);
342         io_hdr.dxfer_direction = SG_DXFER_FROM_DEV;
343         io_hdr.cmdp = cdb;
344         io_hdr.sbp = (void *)&Sensedata;
345         io_hdr.timeout = TIMEOUT;
346
347
348
349         io_hdr.dxfer_len = mx_resp_len;
350         io_hdr.dxferp = (void *)resp;
351
352         ret =ioctl(fd, SG_IO, &io_hdr);
353         if (ret < 0){
354                 condlog(0, "%s: IOCTL failed %d", dev, ret);
355                 status = MPATH_PR_OTHER;
356                 goto out;
357         }
358
359         got = mx_resp_len - io_hdr.resid;
360
361         condlog(3, "%s: duration = %u (ms)", dev, io_hdr.duration);
362         condlog(4, "%s: persistent reservation in: requested %d bytes but got %d bytes)", dev, mx_resp_len, got);
363
364         status = mpath_translate_response(dev, io_hdr, &Sensedata, noisy);
365
366         if (status == MPATH_PR_SENSE_UNIT_ATTENTION && (retry > 0))
367         {
368                 --retry;
369                 condlog(3, "%s: retrying for Unit Attention. Remaining retries = %d", dev, retry);
370                 goto retry;
371         }
372
373         if (((status == MPATH_PR_SENSE_NOT_READY )&& (Sensedata.ASC == 0x04)&&
374                                 (Sensedata.ASCQ == 0x07))&& (retry > 0))
375         {
376                 usleep(1000);
377                 --retry;
378                 condlog(3, "%s: retrying for 02/04/07. Remaining retries = %d", dev, retry);
379                 goto retry;
380         }
381
382         if (status != MPATH_PR_SUCCESS)
383                 goto out;
384
385         if (noisy)
386                 dumpHex((const char *)resp, got , 1);
387
388
389         switch (rq_servact)
390         {
391                 case MPATH_PRIN_RKEY_SA :
392                         mpath_format_readkeys(resp, got, noisy);
393                         break;
394                 case MPATH_PRIN_RRES_SA :
395                         mpath_format_readresv(resp, got, noisy);
396                         break;
397                 case MPATH_PRIN_RCAP_SA :
398                         mpath_format_reportcapabilities(resp, got, noisy);
399                         break;
400                 case MPATH_PRIN_RFSTAT_SA :
401                         mpath_format_readfullstatus(resp, got, noisy);
402         }
403
404 out:
405         close(fd);
406         return status;
407 }
408
409 int mpath_translate_response (char * dev, struct sg_io_hdr io_hdr,
410                               SenseData_t *Sensedata, int noisy)
411 {
412         condlog(3, "%s: status driver:%02x host:%02x scsi:%02x", dev,
413                         io_hdr.driver_status, io_hdr.host_status ,io_hdr.status);
414         io_hdr.status &= 0x7e;
415         if ((0 == io_hdr.status) &&
416             (0 == io_hdr.host_status) &&
417             (0 == io_hdr.driver_status))
418                 return MPATH_PR_SUCCESS;
419
420         switch(io_hdr.status) {
421         case SAM_STAT_GOOD:
422                 break;
423         case SAM_STAT_CHECK_CONDITION:
424                 condlog(3, "%s: Sense_Key=%02x, ASC=%02x ASCQ=%02x",
425                         dev, Sensedata->Sense_Key,
426                         Sensedata->ASC, Sensedata->ASCQ);
427                 switch(Sensedata->Sense_Key) {
428                 case NO_SENSE:
429                         return MPATH_PR_NO_SENSE;
430                 case RECOVERED_ERROR:
431                         return MPATH_PR_SUCCESS;
432                 case NOT_READY:
433                         return MPATH_PR_SENSE_NOT_READY;
434                 case MEDIUM_ERROR:
435                         return MPATH_PR_SENSE_MEDIUM_ERROR;
436                 case BLANK_CHECK:
437                         return MPATH_PR_OTHER;
438                 case HARDWARE_ERROR:
439                         return MPATH_PR_SENSE_HARDWARE_ERROR;
440                 case ILLEGAL_REQUEST:
441                         return MPATH_PR_ILLEGAL_REQ;
442                 case UNIT_ATTENTION:
443                         return MPATH_PR_SENSE_UNIT_ATTENTION;
444                 case DATA_PROTECT:
445                 case COPY_ABORTED:
446                         return MPATH_PR_OTHER;
447                 case ABORTED_COMMAND:
448                         return MPATH_PR_SENSE_ABORTED_COMMAND;
449
450                 default :
451                         return MPATH_PR_OTHER;
452                 }
453         case SAM_STAT_RESERVATION_CONFLICT:
454                 return MPATH_PR_RESERV_CONFLICT;
455
456         default :
457                 return  MPATH_PR_OTHER;
458         }
459
460         switch(io_hdr.host_status) {
461         case DID_OK :
462                 break;
463         default :
464                 return MPATH_PR_OTHER;
465         }
466         switch(io_hdr.driver_status)
467         {
468         case DRIVER_OK:
469                 break;
470         default :
471                 return MPATH_PR_OTHER;
472         }
473         return MPATH_PR_SUCCESS;
474 }
475
476 void convert_be16_to_cpu(uint16_t *num)
477 {
478         *num = get_unaligned_be16(num);
479 }
480
481 void convert_be32_to_cpu(uint32_t *num)
482 {
483         *num = get_unaligned_be32(num);
484 }
485
486 void
487 dumpHex(const char* str, int len, int log)
488 {
489         const char * p = str;
490         unsigned char c;
491         char buff[82];
492         const int bpstart = 5;
493         int bpos = bpstart;
494         int  k;
495
496         if (len <= 0)
497                 return;
498         memset(buff, ' ', 80);
499         buff[80] = '\0';
500         for (k = 0; k < len; k++) {
501                 c = *p++;
502                 bpos += 3;
503                 if (bpos == (bpstart + (9 * 3)))
504                         bpos++;
505                 sprintf(&buff[bpos], "%.2x", (int)(unsigned char)c);
506                 buff[bpos + 2] = ' ';
507                 if ((k > 0) && (0 == ((k + 1) % 16))) {
508                         if (log)
509                                 condlog(0, "%.76s" , buff);
510                         else
511                                 printf("%.76s" , buff);
512                         bpos = bpstart;
513                         memset(buff, ' ', 80);
514                 }
515         }
516         if (bpos > bpstart) {
517                 buff[bpos + 2] = '\0';
518                 if (log)
519                         condlog(0, "%s", buff);
520                 else
521                         printf("%s\n" , buff);
522         }
523         return;
524 }
525
526 int get_prin_length(int rq_servact)
527 {
528         int mx_resp_len;
529         switch (rq_servact)
530         {
531                 case MPATH_PRIN_RKEY_SA:
532                         mx_resp_len =  sizeof(struct prin_readdescr);
533                         break;
534                 case MPATH_PRIN_RRES_SA :
535                         mx_resp_len =  sizeof(struct prin_resvdescr);
536                         break;
537                 case MPATH_PRIN_RCAP_SA :
538                         mx_resp_len = sizeof(struct prin_capdescr);
539                         break;
540                 case MPATH_PRIN_RFSTAT_SA:
541                         mx_resp_len = sizeof(struct print_fulldescr_list) + sizeof(struct prin_fulldescr *)*32;
542                         break;
543                 default:
544                         condlog(0, "invalid service action, %d", rq_servact);
545                         mx_resp_len = 0;
546                         break;
547         }
548         return mx_resp_len;
549 }