extras/path_id/path_id.c

   1 /*
   2  * compose persisistent device path
   3  *
   4  * Copyright (C) 2009 Kay Sievers <kay.sievers@vrfy.org>
   5  *
   6  * This program 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 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include <stdio.h>
  21 #include <stdlib.h>
  22 #include <stdarg.h>
  23 #include <unistd.h>
  24 #include <string.h>
  25 #include <ctype.h>
  26 #include <fcntl.h>
  27 #include <errno.h>
  28 #include <dirent.h>
  29 #include <getopt.h>
  30
  31 #include <libudev.h>
  32 #include <../../udev/udev.h>
  33
  34 int debug;
  35
  36 static void log_fn(struct udev *udev, int priority,
  37                    const char *file, int line, const char *fn,
  38                    const char *format, va_list args)
  39 {
  40         if (debug) {
  41                 fprintf(stderr, "%s: ", fn != NULL ? fn : file);
  42                 vfprintf(stderr, format, args);
  43         } else {
  44                 vsyslog(priority, format, args);
  45         }
  46 }
  47
  48 static int path_prepend(char **path, const char *fmt, ...)
  49 {
  50         va_list va;
  51         char *old;
  52         char *pre;
  53         int err;
  54
  55         old = *path;
  56
  57         va_start(va, fmt);
  58         err = vasprintf(&pre, fmt, va);
  59         va_end(va);
  60         if (err < 0)
  61                 return err;
  62
  63         if (old != NULL) {
  64                 err = asprintf(path, "%s-%s", pre, old);
  65                 if (err < 0)
  66                         return err;
  67                 free(pre);
  68         } else {
  69                 *path = pre;
  70         }
  71
  72         free(old);
  73         return 0;
  74 }
  75
  76 static struct udev_device *skip_subsystem(struct udev_device *dev, const char *subsys)
  77 {
  78         struct udev_device *parent = dev;
  79
  80         while (parent != NULL) {
  81                 const char *subsystem;
  82
  83                 subsystem = udev_device_get_subsystem(parent);
  84                 if (subsystem == NULL || strcmp(subsystem, subsys) != 0)
  85                         break;
  86                 dev = parent;
  87                 parent = udev_device_get_parent(parent);
  88         }
  89         return dev;
  90 }
  91
  92 /* find smallest number of instances of <syspath>/<name><number> */
  93 static int base_number(const char *syspath, const char *name)
  94 {
  95         char *base;
  96         char *pos;
  97         DIR *dir;
  98         struct dirent *dent;
  99         size_t len;
 100         int number = -1;
 101
 102         base = strdup(syspath);
 103         if (base == NULL)
 104                 goto out;
 105
 106         pos = strrchr(base, '/');
 107         if (pos == NULL)
 108                 goto out;
 109         pos[0] = '\0';
 110
 111         len = strlen(name);
 112         dir = opendir(base);
 113         if (dir == NULL)
 114                 goto out;
 115         for (dent = readdir(dir); dent != NULL; dent = readdir(dir)) {
 116                 char *rest;
 117                 int i;
 118
 119                 if (dent->d_name[0] == '.')
 120                         continue;
 121                 if (dent->d_type != DT_DIR && dent->d_type != DT_LNK)
 122                         continue;
 123                 if (strncmp(dent->d_name, name, len) != 0)
 124                         continue;
 125                 i = strtoul(&dent->d_name[len], &rest, 10);
 126                 if (rest[0] != '\0')
 127                         continue;
 128                 if (number == -1 || i < number)
 129                         number = i;
 130         }
 131         closedir(dir);
 132 out:
 133         free(base);
 134         return number;
 135 }
 136
 137 static struct udev_device *handle_fc(struct udev_device *parent, char **path)
 138 {
 139         path_prepend(path, "fc-PATH_ID_NOT_IMPLEMENTED");
 140         return parent;
 141 }
 142
 143 static struct udev_device *handle_sas(struct udev_device *parent, char **path)
 144 {
 145         path_prepend(path, "sas-PATH_ID_NOT_IMPLEMENTED");
 146         return parent;
 147 }
 148
 149 static struct udev_device *handle_iscsi(struct udev_device *parent, char **path)
 150 {
 151         path_prepend(path, "ip-PATH_ID_NOT_IMPLEMENTED");
 152         return parent;
 153 }
 154
 155 static struct udev_device *handle_scsi(struct udev_device *parent, char **path)
 156 {
 157         struct udev_device *hostdev;
 158         int host, bus, target, lun;
 159         const char *name;
 160         int base;
 161
 162         hostdev = udev_device_get_parent_with_subsystem_devtype(parent, "scsi", "scsi_host");
 163         if (hostdev == NULL)
 164                 return parent;
 165
 166         name = udev_device_get_sysname(parent);
 167         if (sscanf(name, "%d:%d:%d:%d", &host, &bus, &target, &lun) != 4)
 168                 return parent;
 169
 170         /* rebase host offset to get the local relative number */
 171         base = base_number(udev_device_get_syspath(hostdev), "host");
 172         if (base < 0)
 173                 return parent;
 174         host -= base;
 175
 176         path_prepend(path, "scsi-%u:%u:%u:%u", host, bus, target, lun);
 177         return hostdev;
 178 }
 179
 180 static struct udev_device *handle_scsi_lun(struct udev_device *parent, char **path)
 181 {
 182         const char *devtype;
 183         const char *name;
 184         const char *id;
 185
 186         devtype = udev_device_get_devtype(parent);
 187         if (devtype == NULL || strcmp(devtype, "scsi_device") != 0)
 188                 return parent;
 189
 190         /* firewire */
 191         id = udev_device_get_sysattr_value(parent, "ieee1394_id");
 192         if (id != NULL) {
 193                 parent = skip_subsystem(parent, "scsi");
 194                 path_prepend(path, "ieee1394-0x%s", id);
 195                 goto out;
 196         }
 197
 198         name = udev_device_get_syspath(parent);
 199
 200         /* fibre channel */
 201         if (strstr(name, "/rport-") != NULL) {
 202                 parent = handle_fc(parent, path);
 203                 goto out;
 204         }
 205
 206         /* sas */
 207         if (strstr(name, "/end_device-") != NULL) {
 208                 parent = handle_sas(parent, path);
 209                 goto out;
 210         }
 211
 212         /* iSCSI */
 213         if (strstr(name, "/session") != NULL) {
 214                 parent = handle_iscsi(parent, path);
 215                 goto out;
 216         }
 217
 218         /* default */
 219         parent = handle_scsi(parent, path);
 220 out:
 221         return parent;
 222 }
 223
 224 static void handle_scsi_tape(struct udev_device *dev, char **suffix)
 225 {
 226         const char *name;
 227
 228         name = udev_device_get_sysname(dev);
 229         if (strncmp(name, "nst", 3) == 0 && strchr("lma", name[3]) != NULL)
 230                 asprintf(suffix, "nst%c", name[3]);
 231         else if (strncmp(name, "st", 2) == 0 && strchr("lma", name[2]) != NULL)
 232                 asprintf(suffix, "st%c", name[2]);
 233 }
 234
 235 static struct udev_device *handle_usb(struct udev_device *parent, char **path)
 236 {
 237         const char *devtype;
 238         const char *str;
 239         const char *port;
 240
 241         devtype = udev_device_get_devtype(parent);
 242         if (devtype == NULL || strcmp(devtype, "usb_interface") != 0)
 243                 return parent;
 244
 245         str = udev_device_get_sysname(parent);
 246         port = strchr(str, '-');
 247         if (port == NULL)
 248                 return parent;
 249         port++;
 250
 251         parent = skip_subsystem(parent, "usb");
 252         path_prepend(path, "usb-0:%s", port);
 253         return parent;
 254 }
 255
 256 static struct udev_device *handle_cciss(struct udev_device *parent, char **path)
 257 {
 258         path_prepend(path, "cciss-PATH_ID_NOT_IMPLEMENTED");
 259         return parent;
 260 }
 261
 262 static struct udev_device *handle_ccw(struct udev_device *parent, struct udev_device *dev, char **path)
 263 {
 264         struct udev_device *scsi_dev;
 265
 266         scsi_dev = udev_device_get_parent_with_subsystem_devtype(dev, "scsi", "scsi_device");
 267         if (scsi_dev != NULL) {
 268                 const char *wwpn;
 269                 const char *lun;
 270                 const char *hba_id;
 271
 272                 hba_id = udev_device_get_sysattr_value(scsi_dev, "hba_id");
 273                 wwpn = udev_device_get_sysattr_value(scsi_dev, "wwpn");
 274                 lun = udev_device_get_sysattr_value(scsi_dev, "fcp_lun");
 275                 if (hba_id != NULL && lun != NULL && wwpn != NULL) {
 276                         path_prepend(path, "ccw-%s-zfcp-%s:%s", hba_id, wwpn, lun);
 277                         goto out;
 278                 }
 279         }
 280
 281         path_prepend(path, "ccw-%s", udev_device_get_sysname(parent));
 282 out:
 283         parent = skip_subsystem(parent, "ccw");
 284         return parent;
 285 }
 286
 287 int main(int argc, char **argv)
 288 {
 289         static const struct option options[] = {
 290                 { "debug", no_argument, NULL, 'd' },
 291                 { "help", no_argument, NULL, 'h' },
 292                 {}
 293         };
 294         struct udev *udev;
 295         struct udev_device *dev;
 296         struct udev_device *parent;
 297         char syspath[UTIL_PATH_SIZE];
 298         const char *devpath;
 299         char *path;
 300         char *path_suffix;
 301         int rc = 1;
 302
 303         udev = udev_new();
 304         if (udev == NULL)
 305                 goto exit;
 306
 307         logging_init("usb_id");
 308         udev_set_log_fn(udev, log_fn);
 309
 310         while (1) {
 311                 int option;
 312
 313                 option = getopt_long(argc, argv, "dh", options, NULL);
 314                 if (option == -1)
 315                         break;
 316
 317                 switch (option) {
 318                 case 'd':
 319                         debug = 1;
 320                         if (udev_get_log_priority(udev) < LOG_INFO)
 321                                 udev_set_log_priority(udev, LOG_INFO);
 322                         break;
 323                 case 'h':
 324                         printf("Usage: path_id [--debug] [--help] <devpath>\n"
 325                                "  --debug    print debug information\n"
 326                                "  --help      print this help text\n\n");
 327                 default:
 328                         rc = 1;
 329                         goto exit;
 330                 }
 331         }
 332
 333         devpath = argv[optind];
 334         if (devpath == NULL) {
 335                 fprintf(stderr, "No device specified\n");
 336                 rc = 2;
 337                 goto exit;
 338         }
 339
 340         util_strscpyl(syspath, sizeof(syspath), udev_get_sys_path(udev), devpath, NULL);
 341         dev = udev_device_new_from_syspath(udev, syspath);
 342         if (dev == NULL) {
 343                 fprintf(stderr, "unable to access '%s'\n", devpath);
 344                 rc = 3;
 345                 goto exit;
 346         }
 347
 348         path = NULL;
 349         path_suffix = NULL;
 350
 351         /* S390 ccw bus */
 352         parent = udev_device_get_parent_with_subsystem_devtype(dev, "ccw", NULL);
 353         if (parent != NULL) {
 354                 handle_ccw(parent, dev, &path);
 355                 goto out;
 356         }
 357
 358         /* walk up the chain of devices and compose path */
 359         parent = dev;
 360         while (parent != NULL) {
 361                 const char *subsys;
 362
 363                 subsys = udev_device_get_subsystem(parent);
 364
 365                 if (subsys == NULL) {
 366                         ;
 367                 } else if (strcmp(subsys, "scsi_tape") == 0) {
 368                         handle_scsi_tape(parent, &path_suffix);
 369                 } else if (strcmp(subsys, "scsi") == 0) {
 370                         parent = handle_scsi_lun(parent, &path);
 371                 } else if (strcmp(subsys, "cciss") == 0) {
 372                         handle_cciss(parent, &path);
 373                 } else if (strcmp(subsys, "usb") == 0) {
 374                         parent = handle_usb(parent, &path);
 375                 } else if (strcmp(subsys, "serio") == 0) {
 376                         path_prepend(&path, "serio-%s", udev_device_get_sysnum(parent));
 377                         parent = skip_subsystem(parent, "serio");
 378                 } else if (strcmp(subsys, "pci") == 0) {
 379                         path_prepend(&path, "pci-%s", udev_device_get_sysname(parent));
 380                         parent = skip_subsystem(parent, "pci");
 381                 } else if (strcmp(subsys, "platform") == 0) {
 382                         path_prepend(&path, "platform-%s", udev_device_get_sysname(parent));
 383                         parent = skip_subsystem(parent, "platform");
 384                 } else if (strcmp(subsys, "xen") == 0) {
 385                         path_prepend(&path, "xen-%s", udev_device_get_sysname(parent));
 386                         parent = skip_subsystem(parent, "xen");
 387                 }
 388
 389                 parent = udev_device_get_parent(parent);
 390         }
 391 out:
 392         if (path != NULL) {
 393                 if (path_suffix != NULL) {
 394                         printf("ID_PATH=%s%s\n", path, path_suffix);
 395                         free(path_suffix);
 396                 } else {
 397                         printf("ID_PATH=%s\n", path);
 398                 }
 399                 free(path);
 400                 rc = 0;
 401         }
 402
 403         udev_device_unref(dev);
 404 exit:
 405         udev_unref(udev);
 406         logging_close();
 407         return rc;
 408 }