4308fceda35adeed6fb1a207e7f5119dac741750
[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   free (sysfs_path);
393   strcat (of_path, disk);
394   return of_path;
395 }
396
397 static int
398 vendor_is_ATA(const char *path)
399 {
400   int fd, err;
401   char *bufname;
402   char bufcont[3];
403   size_t path_size;
404
405   path_size = strlen (path) + sizeof ("/vendor");
406
407   bufname = xmalloc (path_size);
408
409   snprintf (bufname, path_size, "%s/vendor", path);
410   fd = open (bufname, O_RDONLY);
411   if (fd < 0)
412     grub_util_error (_("cannot open `%s': %s"), bufname, strerror (errno));
413
414   memset(bufcont, 0, sizeof (bufcont));
415   err = read(fd, bufcont, sizeof (bufcont));
416   if (err < 0)
417     grub_util_error (_("cannot open `%s': %s"), bufname, strerror (errno));
418
419   close(fd);
420   free (bufname);
421
422   return (memcmp(bufcont, "ATA", 3) == 0);
423 }
424
425 #ifdef __sparc__
426 static void
427 check_hba_identifiers (const char *sysfs_path, int *vendor, int *device_id)
428 {
429   char *ed = strstr (sysfs_path, "host");
430   size_t path_size;
431   char *p, *path;
432   char buf[8];
433   int fd;
434
435   if (!ed)
436     return;
437
438   p = xstrdup (sysfs_path);
439   ed = strstr (p, "host");
440
441   *ed = '\0';
442
443   path_size = (strlen (p) + sizeof ("vendor"));
444   path = xmalloc (path_size);
445
446   if (!path)
447     goto out;
448
449   snprintf (path, path_size, "%svendor", p);
450   fd = open (path, O_RDONLY);
451
452   if (fd < 0)
453     goto out;
454
455   memset (buf, 0, sizeof (buf));
456
457   if (read (fd, buf, sizeof (buf) - 1) < 0)
458     goto out;
459
460   close (fd);
461   sscanf (buf, "%x", vendor);
462
463   snprintf (path, path_size, "%sdevice", p);
464   fd = open (path, O_RDONLY);
465
466   if (fd < 0)
467     goto out;
468
469   memset (buf, 0, sizeof (buf));
470
471   if (read (fd, buf, sizeof (buf) - 1) < 0)
472     goto out;
473
474   close (fd);
475   sscanf (buf, "%x", device_id);
476
477  out:
478   free (path);
479   free (p);
480 }
481 #endif
482
483 static void
484 check_sas (const char *sysfs_path, int *tgt, unsigned long int *sas_address)
485 {
486   char *ed = strstr (sysfs_path, "end_device");
487   char *p, *q, *path;
488   char phy[21];
489   int fd;
490   size_t path_size;
491
492   if (!ed)
493     return;
494
495   /* SAS devices are identified using disk@$PHY_ID */
496   p = xstrdup (sysfs_path);
497   ed = strstr(p, "end_device");
498   if (!ed)
499     return;
500
501   q = ed;
502   while (*q && *q != '/')
503     q++;
504   *q = '\0';
505
506   path_size = (strlen (p) + strlen (ed)
507                + sizeof ("%s/sas_device/%s/phy_identifier"));
508   path = xmalloc (path_size);
509   snprintf (path, path_size, "%s/sas_device/%s/phy_identifier", p, ed);
510   fd = open (path, O_RDONLY);
511   if (fd < 0)
512     grub_util_error (_("cannot open `%s': %s"), path, strerror (errno));
513
514   memset (phy, 0, sizeof (phy));
515   if (read (fd, phy, sizeof (phy) - 1) < 0)
516     grub_util_error (_("cannot read `%s': %s"), path, strerror (errno));
517
518   close (fd);
519
520   sscanf (phy, "%d", tgt);
521
522   snprintf (path, path_size, "%s/sas_device/%s/sas_address", p, ed);
523   fd = open (path, O_RDONLY);
524   if (fd < 0)
525     grub_util_error (_("cannot open `%s': %s"), path, strerror (errno));
526
527   memset (phy, 0, sizeof (phy));
528   if (read (fd, phy, sizeof (phy) - 1) < 0)
529     grub_util_error (_("cannot read `%s': %s"), path, strerror (errno));
530   sscanf (phy, "%lx", sas_address);
531
532   free (path);
533   free (p);
534   close (fd);
535 }
536
537 static char *
538 of_path_of_scsi(const char *sys_devname __attribute__((unused)), const char *device,
539                 const char *devnode __attribute__((unused)),
540                 const char *devicenode)
541 {
542   const char *p, *digit_string, *disk_name;
543   int host, bus, tgt, lun;
544   unsigned long int sas_address = 0;
545   char *sysfs_path, disk[MAX_DISK_CAT - sizeof ("/fp@0,0")];
546   char *of_path;
547
548   sysfs_path = block_device_get_sysfs_path_and_link(devicenode);
549   p = get_basename (sysfs_path);
550   sscanf(p, "%d:%d:%d:%d", &host, &bus, &tgt, &lun);
551   check_sas (sysfs_path, &tgt, &sas_address);
552
553   if (vendor_is_ATA(sysfs_path))
554     {
555       of_path = __of_path_common(sysfs_path, device, tgt);
556       free (sysfs_path);
557       return of_path;
558     }
559
560   of_path = find_obppath(sysfs_path);
561   if (!of_path)
562     goto out;
563
564   if (strstr (of_path, "qlc"))
565     strcat (of_path, "/fp@0,0");
566
567   if (strstr (of_path, "sbus"))
568     disk_name = "sd";
569   else
570     disk_name = "disk";
571
572   digit_string = trailing_digits (device);
573   if (strncmp (of_path, "/vdevice/", sizeof ("/vdevice/") - 1) == 0)
574     {
575       unsigned long id = 0x8000 | (tgt << 8) | (bus << 5) | lun;
576       if (*digit_string == '\0')
577         {
578           snprintf(disk, sizeof (disk), "/%s@%04lx000000000000", disk_name, id);
579         }
580       else
581         {
582           int part;
583
584           sscanf(digit_string, "%d", &part);
585           snprintf(disk, sizeof (disk),
586                    "/%s@%04lx000000000000:%c", disk_name, id, 'a' + (part - 1));
587         }
588     }
589   else
590     {
591 #ifdef __sparc__
592       ofpath_sparc_addressing addressing = GRUB_OFPATH_SPARC_TGT_LUN;
593       int vendor = 0, device_id = 0;
594       char *optr = disk;
595
596       check_hba_identifiers (sysfs_path, &vendor, &device_id);
597
598       if (vendor == LSI_VENDOR_ID)
599         {
600           struct ofpath_sparc_hba *lsi_hba;
601
602           /*
603            * Over time different OF addressing schemes have been supported.
604            * There is no generic addressing scheme that works across
605            * every HBA.
606            */
607           for (lsi_hba = sparc_lsi_hba; lsi_hba->device_id; lsi_hba++)
608             if (lsi_hba->device_id == device_id)
609               {
610                 addressing = lsi_hba->addressing;
611                 break;
612               }
613         }
614
615       if (addressing == GRUB_OFPATH_SPARC_WWN_ADDR)
616         optr += snprintf (disk, sizeof (disk), "/%s@w%lx,%x", disk_name,
617                           sas_address, lun);
618       else
619         optr += snprintf (disk, sizeof (disk), "/%s@%x,%x", disk_name, tgt,
620                           lun);
621
622       if (*digit_string != '\0')
623         {
624           int part;
625
626           sscanf (digit_string, "%d", &part);
627           snprintf (optr, sizeof (disk) - (optr - disk - 1), ":%c", 'a'
628                     + (part - 1));
629         }
630 #else
631       if (lun == 0)
632         {
633           int sas_id = 0;
634           sas_id = bus << 16 | tgt << 8 | lun;
635
636           if (*digit_string == '\0')
637             {
638               snprintf(disk, sizeof (disk), "/sas/%s@%x", disk_name, sas_id);
639             }
640           else
641             {
642               int part;
643
644               sscanf(digit_string, "%d", &part);
645               snprintf(disk, sizeof (disk),
646                        "/sas/%s@%x:%c", disk_name, sas_id, 'a' + (part - 1));
647             }
648         }
649       else
650         {
651           char *lunstr;
652           int lunpart[4];
653
654           lunstr = xmalloc (20);
655
656           lunpart[0] = (lun >> 8) & 0xff;
657           lunpart[1] = lun & 0xff;
658           lunpart[2] = (lun >> 24) & 0xff;
659           lunpart[3] = (lun >> 16) & 0xff;
660
661           sprintf(lunstr, "%02x%02x%02x%02x00000000", lunpart[0], lunpart[1], lunpart[2], lunpart[3]);
662           long int longlun = atol(lunstr);
663
664           if (*digit_string == '\0')
665             {
666               snprintf(disk, sizeof (disk), "/sas/%s@%lx,%lu", disk_name, sas_address, longlun);
667             }
668           else
669             {
670               int part;
671
672               sscanf(digit_string, "%d", &part);
673               snprintf(disk, sizeof (disk),
674                        "/sas/%s@%lx,%lu:%c", disk_name, sas_address, longlun, 'a' + (part - 1));
675             }
676           free (lunstr);
677         }
678 #endif
679     }
680   strcat(of_path, disk);
681
682  out:
683   free (sysfs_path);
684   return of_path;
685 }
686
687 static char *
688 strip_trailing_digits (const char *p)
689 {
690   char *new, *end;
691
692   new = strdup (p);
693   end = new + strlen(new) - 1;
694   while (end >= new)
695     {
696       if (! my_isdigit(*end))
697         break;
698       *end-- = '\0';
699     }
700
701   return new;
702 }
703
704 char *
705 grub_util_devname_to_ofpath (const char *sys_devname)
706 {
707   char *name_buf, *device, *devnode, *devicenode, *ofpath;
708
709   name_buf = xrealpath (sys_devname);
710
711   device = get_basename (name_buf);
712   devnode = strip_trailing_digits (name_buf);
713   devicenode = strip_trailing_digits (device);
714
715   if (device[0] == 'h' && device[1] == 'd')
716     ofpath = of_path_of_ide(name_buf, device, devnode, devicenode);
717   else if (device[0] == 's'
718            && (device[1] == 'd' || device[1] == 'r'))
719     ofpath = of_path_of_scsi(name_buf, device, devnode, devicenode);
720   else if (device[0] == 'v' && device[1] == 'd' && device[2] == 'i'
721            && device[3] == 's' && device[4] == 'k')
722     ofpath = of_path_of_vdisk(name_buf, device, devnode, devicenode);
723   else if (device[0] == 'f' && device[1] == 'd'
724            && device[2] == '0' && device[3] == '\0')
725     /* All the models I've seen have a devalias "floppy".
726        New models have no floppy at all. */
727     ofpath = xstrdup ("floppy");
728   else if (device[0] == 'n' && device[1] == 'v' && device[2] == 'm'
729            && device[3] == 'e')
730     ofpath = of_path_of_nvme (name_buf, device, devnode, devicenode);
731   else
732     {
733       grub_util_warn (_("unknown device type %s"), device);
734       ofpath = NULL;
735     }
736
737   free (devnode);
738   free (devicenode);
739   free (name_buf);
740
741   return ofpath;
742 }
743
744 #ifdef OFPATH_STANDALONE
745 int main(int argc, char **argv)
746 {
747   char *of_path;
748
749   if (argc != 2)
750     {
751       printf(_("Usage: %s DEVICE\n"), argv[0]);
752       return 1;
753     }
754
755   of_path = grub_util_devname_to_ofpath (argv[1]);
756   if (of_path)
757     printf("%s\n", of_path);
758   free (of_path);
759
760   return 0;
761 }
762 #endif