ieee1275: Fix crash in of_path_of_nvme when of_path is empty
[grub.git] / grub-core / osdep / linux / ofpath.c
1 /* ofpath.c - calculate OpenFirmware path names given an OS device */
2 /*
3  *  GRUB  --  GRand Unified Bootloader
4  *  Copyright (C) 2009, 2011,2012, 2013  Free Software Foundation, Inc.
5  *
6  *  GRUB is free software: you can redistribute it and/or modify
7  *  it under the terms of the GNU General Public License as published by
8  *  the Free Software Foundation, either version 3 of the License, or
9  *  (at your option) any later version.
10  *
11  *  GRUB is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  *  GNU General Public License for more details.
15  *
16  *  You should have received a copy of the GNU General Public License
17  *  along with GRUB.  If not, see <http://www.gnu.org/licenses/>.
18  */
19
20 #undef OFPATH_STANDALONE
21
22 #ifndef OFPATH_STANDALONE
23 #include <grub/types.h>
24 #include <grub/util/misc.h>
25 #include <grub/util/ofpath.h>
26 #include <grub/i18n.h>
27 #endif
28
29 #include <limits.h>
30 #include <stdlib.h>
31 #include <stdio.h>
32 #include <stdarg.h>
33 #include <unistd.h>
34 #include <string.h>
35 #include <sys/types.h>
36 #include <sys/stat.h>
37 #include <fcntl.h>
38 #include <errno.h>
39 #include <ctype.h>
40
41 #ifdef __sparc__
42 typedef enum
43   {
44     GRUB_OFPATH_SPARC_WWN_ADDR = 1,
45     GRUB_OFPATH_SPARC_TGT_LUN,
46   } ofpath_sparc_addressing;
47
48 struct ofpath_sparc_hba
49 {
50   grub_uint32_t device_id;
51   ofpath_sparc_addressing addressing;
52 };
53
54 static struct ofpath_sparc_hba sparc_lsi_hba[] = {
55   /* Rhea, Jasper 320, LSI53C1020/1030. */
56   {0x30, GRUB_OFPATH_SPARC_TGT_LUN},
57   /* SAS-1068E. */
58   {0x50, GRUB_OFPATH_SPARC_TGT_LUN},
59   /* SAS-1064E. */
60   {0x56, GRUB_OFPATH_SPARC_TGT_LUN},
61   /* Pandora SAS-1068E. */
62   {0x58, GRUB_OFPATH_SPARC_TGT_LUN},
63   /* Aspen, Invader, LSI SAS-3108. */
64   {0x5d, GRUB_OFPATH_SPARC_TGT_LUN},
65   /* Niwot, SAS 2108. */
66   {0x79, GRUB_OFPATH_SPARC_TGT_LUN},
67   /* Erie, Falcon, LSI SAS 2008. */
68   {0x72, GRUB_OFPATH_SPARC_WWN_ADDR},
69   /* LSI WarpDrive 6203. */
70   {0x7e, GRUB_OFPATH_SPARC_WWN_ADDR},
71   /* LSI SAS 2308. */
72   {0x87, GRUB_OFPATH_SPARC_WWN_ADDR},
73   /* LSI SAS 3008. */
74   {0x97, GRUB_OFPATH_SPARC_WWN_ADDR},
75   {0, 0}
76 };
77
78 static const int LSI_VENDOR_ID = 0x1000;
79 #endif
80
81 #ifdef OFPATH_STANDALONE
82 #define xmalloc malloc
83 void
84 grub_util_error (const char *fmt, ...)
85 {
86   va_list ap;
87
88   fprintf (stderr, "ofpath: error: ");
89   va_start (ap, fmt);
90   vfprintf (stderr, fmt, ap);
91   va_end (ap);
92   fputc ('\n', stderr);
93   exit (1);
94 }
95
96 void
97 grub_util_info (const char *fmt, ...)
98 {
99   va_list ap;
100
101   fprintf (stderr, "ofpath: info: ");
102   va_start (ap, fmt);
103   vfprintf (stderr, fmt, ap);
104   va_end (ap);
105   fputc ('\n', stderr);
106 }
107
108 #define grub_util_warn grub_util_info
109 #define _(x) x
110 #define xstrdup strdup
111 #endif
112
113 static void
114 kill_trailing_dir(char *path)
115 {
116   char *end = path + strlen(path) - 1;
117
118   while (end >= path)
119     {
120       if (*end != '/')
121         {
122           end--;
123           continue;
124         }
125       *end = '\0';
126       break;
127     }
128 }
129
130 static void
131 trim_newline (char *path)
132 {
133   char *end = path + strlen(path) - 1;
134
135   while (*end == '\n')
136     *end-- = '\0';
137 }
138
139 #define MAX_DISK_CAT    64
140
141 static char *
142 find_obppath (const char *sysfs_path_orig)
143 {
144   char *sysfs_path, *path;
145   size_t path_size = strlen (sysfs_path_orig) + sizeof ("/obppath");
146
147   sysfs_path = xstrdup (sysfs_path_orig);
148   path = xmalloc (path_size);
149
150   while (1)
151     {
152       int fd;
153       char *of_path;
154       struct stat st;
155       size_t size;
156
157       snprintf(path, path_size, "%s/obppath", sysfs_path);
158 #if 0
159       printf("Trying %s\n", path);
160 #endif
161
162       fd = open(path, O_RDONLY);
163
164 #ifndef __sparc__
165       if (fd < 0 || fstat (fd, &st) < 0)
166         {
167           if (fd >= 0)
168             close (fd);
169           snprintf(path, path_size, "%s/devspec", sysfs_path);
170           fd = open(path, O_RDONLY);
171         }
172 #endif
173
174       if (fd < 0 || fstat (fd, &st) < 0)
175         {
176           if (fd >= 0)
177             close (fd);
178           kill_trailing_dir(sysfs_path);
179           if (!strcmp(sysfs_path, "/sys"))
180             {
181               grub_util_info (_("`obppath' not found in parent dirs of `%s',"
182                                 " no IEEE1275 name discovery"),
183                               sysfs_path_orig);
184               free (path);
185               free (sysfs_path);
186               return NULL;
187             }
188           continue;
189         }
190       size = st.st_size;
191       of_path = xmalloc (size + MAX_DISK_CAT + 1);
192       memset(of_path, 0, size + MAX_DISK_CAT + 1);
193       if (read(fd, of_path, size) < 0)
194         {
195           grub_util_info (_("cannot read `%s': %s"), path, strerror (errno));
196           close(fd);
197           free (path);
198           free (of_path);
199           free (sysfs_path);
200           return NULL;
201         }
202       close(fd);
203
204       trim_newline(of_path);
205       free (path);
206       free (sysfs_path);
207       return of_path;
208     }
209 }
210
211 static char *
212 xrealpath (const char *in)
213 {
214   char *out;
215 #ifdef PATH_MAX
216   out = xmalloc (PATH_MAX);
217   out = realpath (in, out);
218 #else
219   out = realpath (in, NULL);
220 #endif
221   if (!out)
222     grub_util_error (_("failed to get canonical path of `%s'"), in);
223   return out;
224 }
225
226 static char *
227 block_device_get_sysfs_path_and_link(const char *devicenode)
228 {
229   char *rpath;
230   char *rpath2;
231   char *ret;
232   size_t tmp_size = strlen (devicenode) + sizeof ("/sys/block/");
233   char *tmp = xmalloc (tmp_size);
234
235   memcpy (tmp, "/sys/block/", sizeof ("/sys/block/"));
236   strcat (tmp, devicenode);
237
238   rpath = xrealpath (tmp);
239   rpath2 = xmalloc (strlen (rpath) + sizeof ("/device"));
240   strcpy (rpath2, rpath);
241   strcat (rpath2, "/device");
242
243   ret = xrealpath (rpath2);
244
245   free (tmp);
246   free (rpath);
247   free (rpath2);
248   return ret;
249 }
250
251 static inline int
252 my_isdigit (int c)
253 {
254   return (c >= '0' && c <= '9');
255 }
256
257 static const char *
258 trailing_digits (const char *p)
259 {
260   const char *end;
261
262   end = p + strlen(p) - 1;
263   while (end >= p)
264     {
265       if (! my_isdigit(*end))
266         break;
267       end--;
268     }
269
270   return end + 1;
271 }
272
273 static char *
274 __of_path_common(char *sysfs_path,
275                  const char *device, int devno)
276 {
277   const char *digit_string;
278   char disk[MAX_DISK_CAT];
279   char *of_path = find_obppath(sysfs_path);
280
281   if (!of_path)
282     return NULL;
283
284   digit_string = trailing_digits (device);
285   if (*digit_string == '\0')
286     {
287       snprintf(disk, sizeof (disk), "/disk@%d", devno);
288     }
289   else
290     {
291       int part;
292
293       sscanf(digit_string, "%d", &part);
294       snprintf(disk, sizeof (disk), "/disk@%d:%c", devno, 'a' + (part - 1));
295     }
296   strcat(of_path, disk);
297   return of_path;
298 }
299
300 static char *
301 get_basename(char *p)
302 {
303   char *ret = p;
304
305   while (*p)
306     {
307       if (*p == '/')
308         ret = p + 1;
309       p++;
310     }
311
312   return ret;
313 }
314
315 static char *
316 of_path_of_vdisk(const char *sys_devname __attribute__((unused)),
317                  const char *device,
318                  const char *devnode __attribute__((unused)),
319                  const char *devicenode)
320 {
321   char *sysfs_path, *p;
322   int devno, junk;
323   char *ret;
324
325   sysfs_path = block_device_get_sysfs_path_and_link(devicenode);
326   p = get_basename (sysfs_path);
327   sscanf(p, "vdc-port-%d-%d", &devno, &junk);
328   ret = __of_path_common (sysfs_path, device, devno);
329
330   free (sysfs_path);
331   return ret;
332 }
333
334 static char *
335 of_path_of_ide(const char *sys_devname __attribute__((unused)), const char *device,
336                const char *devnode __attribute__((unused)),
337                const char *devicenode)
338 {
339   char *sysfs_path, *p;
340   int chan, devno;
341   char *ret;
342
343   sysfs_path = block_device_get_sysfs_path_and_link(devicenode);
344   p = get_basename (sysfs_path);
345   sscanf(p, "%d.%d", &chan, &devno);
346
347   ret = __of_path_common(sysfs_path, device, 2 * chan + devno);
348
349   free (sysfs_path);
350   return ret;
351 }
352
353 static char *
354 of_path_of_nvme(const char *sys_devname __attribute__((unused)),
355                 const char *device,
356                 const char *devnode __attribute__((unused)),
357                 const char *devicenode)
358 {
359   char *sysfs_path, *of_path, disk[MAX_DISK_CAT];
360   const char *digit_string, *part_end;
361
362   digit_string = trailing_digits (device);
363   part_end = devicenode + strlen (devicenode) - 1;
364
365   if ((*digit_string != '\0') && (*part_end == 'p'))
366     {
367       /* We have a partition number, strip it off. */
368       int part;
369       char *nvmedev, *end;
370
371       nvmedev = strdup (devicenode);
372
373       if (!nvmedev)
374         return NULL;
375
376       end = nvmedev + strlen (nvmedev) - 1;
377       /* Remove the p. */
378       *end = '\0';
379       sscanf (digit_string, "%d", &part);
380       snprintf (disk, sizeof (disk), "/disk@1:%c", 'a' + (part - 1));
381       sysfs_path = block_device_get_sysfs_path_and_link (nvmedev);
382       free (nvmedev);
383     }
384   else
385     {
386       /* We do not have the parition. */
387       snprintf (disk, sizeof (disk), "/disk@1");
388       sysfs_path = block_device_get_sysfs_path_and_link (device);
389     }
390
391   of_path = find_obppath (sysfs_path);
392
393   if (of_path)
394     strcat (of_path, disk);
395
396   free (sysfs_path);
397   return of_path;
398 }
399
400 static int
401 vendor_is_ATA(const char *path)
402 {
403   int fd, err;
404   char *bufname;
405   char bufcont[3];
406   size_t path_size;
407
408   path_size = strlen (path) + sizeof ("/vendor");
409
410   bufname = xmalloc (path_size);
411
412   snprintf (bufname, path_size, "%s/vendor", path);
413   fd = open (bufname, O_RDONLY);
414   if (fd < 0)
415     grub_util_error (_("cannot open `%s': %s"), bufname, strerror (errno));
416
417   memset(bufcont, 0, sizeof (bufcont));
418   err = read(fd, bufcont, sizeof (bufcont));
419   if (err < 0)
420     grub_util_error (_("cannot open `%s': %s"), bufname, strerror (errno));
421
422   close(fd);
423   free (bufname);
424
425   return (memcmp(bufcont, "ATA", 3) == 0);
426 }
427
428 #ifdef __sparc__
429 static void
430 check_hba_identifiers (const char *sysfs_path, int *vendor, int *device_id)
431 {
432   char *ed = strstr (sysfs_path, "host");
433   size_t path_size;
434   char *p, *path;
435   char buf[8];
436   int fd;
437
438   if (!ed)
439     return;
440
441   p = xstrdup (sysfs_path);
442   ed = strstr (p, "host");
443
444   *ed = '\0';
445
446   path_size = (strlen (p) + sizeof ("vendor"));
447   path = xmalloc (path_size);
448
449   if (!path)
450     goto out;
451
452   snprintf (path, path_size, "%svendor", p);
453   fd = open (path, O_RDONLY);
454
455   if (fd < 0)
456     goto out;
457
458   memset (buf, 0, sizeof (buf));
459
460   if (read (fd, buf, sizeof (buf) - 1) < 0)
461     goto out;
462
463   close (fd);
464   sscanf (buf, "%x", vendor);
465
466   snprintf (path, path_size, "%sdevice", p);
467   fd = open (path, O_RDONLY);
468
469   if (fd < 0)
470     goto out;
471
472   memset (buf, 0, sizeof (buf));
473
474   if (read (fd, buf, sizeof (buf) - 1) < 0)
475     goto out;
476
477   close (fd);
478   sscanf (buf, "%x", device_id);
479
480  out:
481   free (path);
482   free (p);
483 }
484 #endif
485
486 static void
487 check_sas (const char *sysfs_path, int *tgt, unsigned long int *sas_address)
488 {
489   char *ed = strstr (sysfs_path, "end_device");
490   char *p, *q, *path;
491   char phy[21];
492   int fd;
493   size_t path_size;
494
495   if (!ed)
496     return;
497
498   /* SAS devices are identified using disk@$PHY_ID */
499   p = xstrdup (sysfs_path);
500   ed = strstr(p, "end_device");
501   if (!ed)
502     return;
503
504   q = ed;
505   while (*q && *q != '/')
506     q++;
507   *q = '\0';
508
509   path_size = (strlen (p) + strlen (ed)
510                + sizeof ("%s/sas_device/%s/phy_identifier"));
511   path = xmalloc (path_size);
512   snprintf (path, path_size, "%s/sas_device/%s/phy_identifier", p, ed);
513   fd = open (path, O_RDONLY);
514   if (fd < 0)
515     grub_util_error (_("cannot open `%s': %s"), path, strerror (errno));
516
517   memset (phy, 0, sizeof (phy));
518   if (read (fd, phy, sizeof (phy) - 1) < 0)
519     grub_util_error (_("cannot read `%s': %s"), path, strerror (errno));
520
521   close (fd);
522
523   sscanf (phy, "%d", tgt);
524
525   snprintf (path, path_size, "%s/sas_device/%s/sas_address", p, ed);
526   fd = open (path, O_RDONLY);
527   if (fd < 0)
528     grub_util_error (_("cannot open `%s': %s"), path, strerror (errno));
529
530   memset (phy, 0, sizeof (phy));
531   if (read (fd, phy, sizeof (phy) - 1) < 0)
532     grub_util_error (_("cannot read `%s': %s"), path, strerror (errno));
533   sscanf (phy, "%lx", sas_address);
534
535   free (path);
536   free (p);
537   close (fd);
538 }
539
540 static char *
541 of_path_of_scsi(const char *sys_devname __attribute__((unused)), const char *device,
542                 const char *devnode __attribute__((unused)),
543                 const char *devicenode)
544 {
545   const char *p, *digit_string, *disk_name;
546   int host, bus, tgt, lun;
547   unsigned long int sas_address = 0;
548   char *sysfs_path, disk[MAX_DISK_CAT - sizeof ("/fp@0,0")];
549   char *of_path;
550
551   sysfs_path = block_device_get_sysfs_path_and_link(devicenode);
552   p = get_basename (sysfs_path);
553   sscanf(p, "%d:%d:%d:%d", &host, &bus, &tgt, &lun);
554   check_sas (sysfs_path, &tgt, &sas_address);
555
556   if (vendor_is_ATA(sysfs_path))
557     {
558       of_path = __of_path_common(sysfs_path, device, tgt);
559       free (sysfs_path);
560       return of_path;
561     }
562
563   of_path = find_obppath(sysfs_path);
564   if (!of_path)
565     goto out;
566
567   if (strstr (of_path, "qlc"))
568     strcat (of_path, "/fp@0,0");
569
570   if (strstr (of_path, "sbus"))
571     disk_name = "sd";
572   else
573     disk_name = "disk";
574
575   digit_string = trailing_digits (device);
576   if (strncmp (of_path, "/vdevice/", sizeof ("/vdevice/") - 1) == 0)
577     {
578       unsigned long id = 0x8000 | (tgt << 8) | (bus << 5) | lun;
579       if (*digit_string == '\0')
580         {
581           snprintf(disk, sizeof (disk), "/%s@%04lx000000000000", disk_name, id);
582         }
583       else
584         {
585           int part;
586
587           sscanf(digit_string, "%d", &part);
588           snprintf(disk, sizeof (disk),
589                    "/%s@%04lx000000000000:%c", disk_name, id, 'a' + (part - 1));
590         }
591     }
592   else
593     {
594 #ifdef __sparc__
595       ofpath_sparc_addressing addressing = GRUB_OFPATH_SPARC_TGT_LUN;
596       int vendor = 0, device_id = 0;
597       char *optr = disk;
598
599       check_hba_identifiers (sysfs_path, &vendor, &device_id);
600
601       if (vendor == LSI_VENDOR_ID)
602         {
603           struct ofpath_sparc_hba *lsi_hba;
604
605           /*
606            * Over time different OF addressing schemes have been supported.
607            * There is no generic addressing scheme that works across
608            * every HBA.
609            */
610           for (lsi_hba = sparc_lsi_hba; lsi_hba->device_id; lsi_hba++)
611             if (lsi_hba->device_id == device_id)
612               {
613                 addressing = lsi_hba->addressing;
614                 break;
615               }
616         }
617
618       if (addressing == GRUB_OFPATH_SPARC_WWN_ADDR)
619         optr += snprintf (disk, sizeof (disk), "/%s@w%lx,%x", disk_name,
620                           sas_address, lun);
621       else
622         optr += snprintf (disk, sizeof (disk), "/%s@%x,%x", disk_name, tgt,
623                           lun);
624
625       if (*digit_string != '\0')
626         {
627           int part;
628
629           sscanf (digit_string, "%d", &part);
630           snprintf (optr, sizeof (disk) - (optr - disk - 1), ":%c", 'a'
631                     + (part - 1));
632         }
633 #else
634       if (lun == 0)
635         {
636           int sas_id = 0;
637           sas_id = bus << 16 | tgt << 8 | lun;
638
639           if (*digit_string == '\0')
640             {
641               snprintf(disk, sizeof (disk), "/sas/%s@%x", disk_name, sas_id);
642             }
643           else
644             {
645               int part;
646
647               sscanf(digit_string, "%d", &part);
648               snprintf(disk, sizeof (disk),
649                        "/sas/%s@%x:%c", disk_name, sas_id, 'a' + (part - 1));
650             }
651         }
652       else
653         {
654           char *lunstr;
655           int lunpart[4];
656
657           lunstr = xmalloc (20);
658
659           lunpart[0] = (lun >> 8) & 0xff;
660           lunpart[1] = lun & 0xff;
661           lunpart[2] = (lun >> 24) & 0xff;
662           lunpart[3] = (lun >> 16) & 0xff;
663
664           sprintf(lunstr, "%02x%02x%02x%02x00000000", lunpart[0], lunpart[1], lunpart[2], lunpart[3]);
665           long int longlun = atol(lunstr);
666
667           if (*digit_string == '\0')
668             {
669               snprintf(disk, sizeof (disk), "/sas/%s@%lx,%lu", disk_name, sas_address, longlun);
670             }
671           else
672             {
673               int part;
674
675               sscanf(digit_string, "%d", &part);
676               snprintf(disk, sizeof (disk),
677                        "/sas/%s@%lx,%lu:%c", disk_name, sas_address, longlun, 'a' + (part - 1));
678             }
679           free (lunstr);
680         }
681 #endif
682     }
683   strcat(of_path, disk);
684
685  out:
686   free (sysfs_path);
687   return of_path;
688 }
689
690 static char *
691 strip_trailing_digits (const char *p)
692 {
693   char *new, *end;
694
695   new = strdup (p);
696   end = new + strlen(new) - 1;
697   while (end >= new)
698     {
699       if (! my_isdigit(*end))
700         break;
701       *end-- = '\0';
702     }
703
704   return new;
705 }
706
707 char *
708 grub_util_devname_to_ofpath (const char *sys_devname)
709 {
710   char *name_buf, *device, *devnode, *devicenode, *ofpath;
711
712   name_buf = xrealpath (sys_devname);
713
714   device = get_basename (name_buf);
715   devnode = strip_trailing_digits (name_buf);
716   devicenode = strip_trailing_digits (device);
717
718   if (device[0] == 'h' && device[1] == 'd')
719     ofpath = of_path_of_ide(name_buf, device, devnode, devicenode);
720   else if (device[0] == 's'
721            && (device[1] == 'd' || device[1] == 'r'))
722     ofpath = of_path_of_scsi(name_buf, device, devnode, devicenode);
723   else if (device[0] == 'v' && device[1] == 'd' && device[2] == 'i'
724            && device[3] == 's' && device[4] == 'k')
725     ofpath = of_path_of_vdisk(name_buf, device, devnode, devicenode);
726   else if (device[0] == 'f' && device[1] == 'd'
727            && device[2] == '0' && device[3] == '\0')
728     /* All the models I've seen have a devalias "floppy".
729        New models have no floppy at all. */
730     ofpath = xstrdup ("floppy");
731   else if (device[0] == 'n' && device[1] == 'v' && device[2] == 'm'
732            && device[3] == 'e')
733     ofpath = of_path_of_nvme (name_buf, device, devnode, devicenode);
734   else
735     {
736       grub_util_warn (_("unknown device type %s"), device);
737       ofpath = NULL;
738     }
739
740   free (devnode);
741   free (devicenode);
742   free (name_buf);
743
744   return ofpath;
745 }
746
747 #ifdef OFPATH_STANDALONE
748 int main(int argc, char **argv)
749 {
750   char *of_path;
751
752   if (argc != 2)
753     {
754       printf(_("Usage: %s DEVICE\n"), argv[0]);
755       return 1;
756     }
757
758   of_path = grub_util_devname_to_ofpath (argv[1]);
759   if (of_path)
760     printf("%s\n", of_path);
761   free (of_path);
762
763   return 0;
764 }
765 #endif