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