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