2 * compose persistent device path
4 * Copyright (C) 2009-2011 Kay Sievers <kay@vrfy.org>
6 * Logic based on Hannes Reinecke's shell script.
8 * This program is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
36 static int path_prepend(char **path
, const char *fmt
, ...) {
42 err
= vasprintf(&pre
, fmt
, va
);
50 err
= asprintf(&new, "%s-%s", pre
, *path
);
64 ** Linux only supports 32 bit luns.
65 ** See drivers/scsi/scsi_scan.c::scsilun_to_int() for more details.
67 static int format_lun_number(struct udev_device
*dev
, char **path
) {
68 unsigned long lun
= strtoul(udev_device_get_sysnum(dev
), NULL
, 10);
70 /* address method 0, peripheral device addressing with bus id of zero */
72 return path_prepend(path
, "lun-%lu", lun
);
73 /* handle all other lun addressing methods by using a variant of the original lun format */
74 return path_prepend(path
, "lun-0x%04lx%04lx00000000", lun
& 0xffff, (lun
>> 16) & 0xffff);
77 static struct udev_device
*skip_subsystem(struct udev_device
*dev
, const char *subsys
) {
78 struct udev_device
*parent
= dev
;
83 while (parent
!= NULL
) {
84 const char *subsystem
;
86 subsystem
= udev_device_get_subsystem(parent
);
87 if (subsystem
== NULL
|| !streq(subsystem
, subsys
))
90 parent
= udev_device_get_parent(parent
);
95 static struct udev_device
*handle_scsi_fibre_channel(struct udev_device
*parent
, char **path
) {
96 struct udev
*udev
= udev_device_get_udev(parent
);
97 struct udev_device
*targetdev
;
98 struct udev_device
*fcdev
= NULL
;
105 targetdev
= udev_device_get_parent_with_subsystem_devtype(parent
, "scsi", "scsi_target");
106 if (targetdev
== NULL
)
109 fcdev
= udev_device_new_from_subsystem_sysname(udev
, "fc_transport", udev_device_get_sysname(targetdev
));
112 port
= udev_device_get_sysattr_value(fcdev
, "port_name");
118 format_lun_number(parent
, &lun
);
119 path_prepend(path
, "fc-%s-%s", port
, lun
);
122 udev_device_unref(fcdev
);
126 static struct udev_device
*handle_scsi_sas_wide_port(struct udev_device
*parent
, char **path
) {
127 struct udev
*udev
= udev_device_get_udev(parent
);
128 struct udev_device
*targetdev
;
129 struct udev_device
*target_parent
;
130 struct udev_device
*sasdev
;
131 const char *sas_address
;
137 targetdev
= udev_device_get_parent_with_subsystem_devtype(parent
, "scsi", "scsi_target");
138 if (targetdev
== NULL
)
141 target_parent
= udev_device_get_parent(targetdev
);
142 if (target_parent
== NULL
)
145 sasdev
= udev_device_new_from_subsystem_sysname(udev
, "sas_device",
146 udev_device_get_sysname(target_parent
));
150 sas_address
= udev_device_get_sysattr_value(sasdev
, "sas_address");
151 if (sas_address
== NULL
) {
156 format_lun_number(parent
, &lun
);
157 path_prepend(path
, "sas-%s-%s", sas_address
, lun
);
160 udev_device_unref(sasdev
);
164 static struct udev_device
*handle_scsi_sas(struct udev_device
*parent
, char **path
)
166 struct udev
*udev
= udev_device_get_udev(parent
);
167 struct udev_device
*targetdev
;
168 struct udev_device
*target_parent
;
169 struct udev_device
*port
;
170 struct udev_device
*expander
;
171 struct udev_device
*target_sasdev
= NULL
;
172 struct udev_device
*expander_sasdev
= NULL
;
173 struct udev_device
*port_sasdev
= NULL
;
174 const char *sas_address
= NULL
;
176 const char *phy_count
;
182 targetdev
= udev_device_get_parent_with_subsystem_devtype(parent
, "scsi", "scsi_target");
183 if (targetdev
== NULL
)
186 target_parent
= udev_device_get_parent(targetdev
);
187 if (target_parent
== NULL
)
191 target_sasdev
= udev_device_new_from_subsystem_sysname(udev
,
192 "sas_device", udev_device_get_sysname(target_parent
));
193 if (target_sasdev
== NULL
)
196 /* The next parent is sas port */
197 port
= udev_device_get_parent(target_parent
);
203 /* Get port device */
204 port_sasdev
= udev_device_new_from_subsystem_sysname(udev
,
205 "sas_port", udev_device_get_sysname(port
));
207 phy_count
= udev_device_get_sysattr_value(port_sasdev
, "num_phys");
208 if (phy_count
== NULL
) {
213 /* Check if we are simple disk */
214 if (strncmp(phy_count
, "1", 2) != 0) {
215 parent
= handle_scsi_sas_wide_port(parent
, path
);
219 /* Get connected phy */
220 phy_id
= udev_device_get_sysattr_value(target_sasdev
, "phy_identifier");
221 if (phy_id
== NULL
) {
226 /* The port's parent is either hba or expander */
227 expander
= udev_device_get_parent(port
);
228 if (expander
== NULL
) {
233 /* Get expander device */
234 expander_sasdev
= udev_device_new_from_subsystem_sysname(udev
,
235 "sas_device", udev_device_get_sysname(expander
));
236 if (expander_sasdev
!= NULL
) {
237 /* Get expander's address */
238 sas_address
= udev_device_get_sysattr_value(expander_sasdev
,
240 if (sas_address
== NULL
) {
246 format_lun_number(parent
, &lun
);
248 path_prepend(path
, "sas-exp%s-phy%s-%s", sas_address
, phy_id
, lun
);
250 path_prepend(path
, "sas-phy%s-%s", phy_id
, lun
);
254 udev_device_unref(target_sasdev
);
255 udev_device_unref(expander_sasdev
);
256 udev_device_unref(port_sasdev
);
260 static struct udev_device
*handle_scsi_iscsi(struct udev_device
*parent
, char **path
) {
261 struct udev
*udev
= udev_device_get_udev(parent
);
262 struct udev_device
*transportdev
;
263 struct udev_device
*sessiondev
= NULL
;
266 struct udev_device
*conndev
= NULL
;
274 /* find iscsi session */
275 transportdev
= parent
;
277 transportdev
= udev_device_get_parent(transportdev
);
278 if (transportdev
== NULL
)
280 if (startswith(udev_device_get_sysname(transportdev
), "session"))
284 /* find iscsi session device */
285 sessiondev
= udev_device_new_from_subsystem_sysname(udev
, "iscsi_session", udev_device_get_sysname(transportdev
));
286 if (sessiondev
== NULL
)
288 target
= udev_device_get_sysattr_value(sessiondev
, "targetname");
289 if (target
== NULL
) {
294 if (asprintf(&connname
, "connection%s:0", udev_device_get_sysnum(transportdev
)) < 0) {
298 conndev
= udev_device_new_from_subsystem_sysname(udev
, "iscsi_connection", connname
);
300 if (conndev
== NULL
) {
304 addr
= udev_device_get_sysattr_value(conndev
, "persistent_address");
305 port
= udev_device_get_sysattr_value(conndev
, "persistent_port");
306 if (addr
== NULL
|| port
== NULL
) {
311 format_lun_number(parent
, &lun
);
312 path_prepend(path
, "ip-%s:%s-iscsi-%s-%s", addr
, port
, target
, lun
);
315 udev_device_unref(sessiondev
);
316 udev_device_unref(conndev
);
320 static struct udev_device
*handle_scsi_default(struct udev_device
*parent
, char **path
) {
321 struct udev_device
*hostdev
;
322 int host
, bus
, target
, lun
;
333 hostdev
= udev_device_get_parent_with_subsystem_devtype(parent
, "scsi", "scsi_host");
337 name
= udev_device_get_sysname(parent
);
338 if (sscanf(name
, "%d:%d:%d:%d", &host
, &bus
, &target
, &lun
) != 4)
342 * Rebase host offset to get the local relative number
344 * Note: This is by definition racy, unreliable and too simple.
345 * Please do not copy this model anywhere. It's just a left-over
346 * from the time we had no idea how things should look like in
349 * Making assumptions about a global in-kernel counter and use
350 * that to calculate a local offset is a very broken concept. It
351 * can only work as long as things are in strict order.
353 * The kernel needs to export the instance/port number of a
354 * controller directly, without the need for rebase magic like
355 * this. Manual driver unbind/bind, parallel hotplug/unplug will
356 * get into the way of this "I hope it works" logic.
359 base
= strdup(udev_device_get_syspath(hostdev
));
362 pos
= strrchr(base
, '/');
373 for (dent
= readdir(dir
); dent
!= NULL
; dent
= readdir(dir
)) {
377 if (dent
->d_name
[0] == '.')
379 if (dent
->d_type
!= DT_DIR
&& dent
->d_type
!= DT_LNK
)
381 if (!startswith(dent
->d_name
, "host"))
383 i
= strtoul(&dent
->d_name
[4], &rest
, 10);
387 * find the smallest number; the host really needs to export its
388 * own instance number per parent device; relying on the global host
389 * enumeration and plainly rebasing the numbers sounds unreliable
391 if (basenum
== -1 || i
< basenum
)
401 path_prepend(path
, "scsi-%u:%u:%u:%u", host
, bus
, target
, lun
);
407 static struct udev_device
*handle_scsi_hyperv(struct udev_device
*parent
, char **path
) {
408 struct udev_device
*hostdev
;
409 struct udev_device
*vmbusdev
;
410 const char *guid_str
;
418 hostdev
= udev_device_get_parent_with_subsystem_devtype(parent
, "scsi", "scsi_host");
422 vmbusdev
= udev_device_get_parent(hostdev
);
426 guid_str
= udev_device_get_sysattr_value(vmbusdev
, "device_id");
430 if (strlen(guid_str
) < 37 || guid_str
[0] != '{' || guid_str
[36] != '}')
433 for (i
= 1, k
= 0; i
< 36; i
++) {
434 if (guid_str
[i
] == '-')
436 guid
[k
++] = guid_str
[i
];
440 format_lun_number(parent
, &lun
);
441 path_prepend(path
, "vmbus-%s-%s", guid
, lun
);
446 static struct udev_device
*handle_scsi(struct udev_device
*parent
, char **path
, bool *supported_parent
) {
451 devtype
= udev_device_get_devtype(parent
);
452 if (devtype
== NULL
|| !streq(devtype
, "scsi_device"))
456 id
= udev_device_get_sysattr_value(parent
, "ieee1394_id");
458 parent
= skip_subsystem(parent
, "scsi");
459 path_prepend(path
, "ieee1394-0x%s", id
);
460 *supported_parent
= true;
464 /* scsi sysfs does not have a "subsystem" for the transport */
465 name
= udev_device_get_syspath(parent
);
467 if (strstr(name
, "/rport-") != NULL
) {
468 parent
= handle_scsi_fibre_channel(parent
, path
);
469 *supported_parent
= true;
473 if (strstr(name
, "/end_device-") != NULL
) {
474 parent
= handle_scsi_sas(parent
, path
);
475 *supported_parent
= true;
479 if (strstr(name
, "/session") != NULL
) {
480 parent
= handle_scsi_iscsi(parent
, path
);
481 *supported_parent
= true;
486 * We do not support the ATA transport class, it uses global counters
487 * to name the ata devices which numbers spread across multiple
490 * The real link numbers are not exported. Also, possible chains of ports
491 * behind port multipliers cannot be composed that way.
493 * Until all that is solved at the kernel level, there are no by-path/
494 * links for ATA devices.
496 if (strstr(name
, "/ata") != NULL
) {
501 if (strstr(name
, "/vmbus_") != NULL
) {
502 parent
= handle_scsi_hyperv(parent
, path
);
506 parent
= handle_scsi_default(parent
, path
);
511 static struct udev_device
*handle_cciss(struct udev_device
*parent
, char **path
) {
513 unsigned int controller
, disk
;
515 str
= udev_device_get_sysname(parent
);
516 if (sscanf(str
, "c%ud%u%*s", &controller
, &disk
) != 2)
519 path_prepend(path
, "cciss-disk%u", disk
);
520 parent
= skip_subsystem(parent
, "cciss");
524 static void handle_scsi_tape(struct udev_device
*dev
, char **path
) {
527 /* must be the last device in the syspath */
531 name
= udev_device_get_sysname(dev
);
532 if (startswith(name
, "nst") && strchr("lma", name
[3]) != NULL
)
533 path_prepend(path
, "nst%c", name
[3]);
534 else if (startswith(name
, "st") && strchr("lma", name
[2]) != NULL
)
535 path_prepend(path
, "st%c", name
[2]);
538 static struct udev_device
*handle_usb(struct udev_device
*parent
, char **path
) {
543 devtype
= udev_device_get_devtype(parent
);
546 if (!streq(devtype
, "usb_interface") && !streq(devtype
, "usb_device"))
549 str
= udev_device_get_sysname(parent
);
550 port
= strchr(str
, '-');
555 parent
= skip_subsystem(parent
, "usb");
556 path_prepend(path
, "usb-0:%s", port
);
560 static struct udev_device
*handle_bcma(struct udev_device
*parent
, char **path
) {
564 sysname
= udev_device_get_sysname(parent
);
565 if (sscanf(sysname
, "bcma%*u:%u", &core
) != 1)
568 path_prepend(path
, "bcma-%u", core
);
572 static struct udev_device
*handle_ccw(struct udev_device
*parent
, struct udev_device
*dev
, char **path
) {
573 struct udev_device
*scsi_dev
;
579 scsi_dev
= udev_device_get_parent_with_subsystem_devtype(dev
, "scsi", "scsi_device");
580 if (scsi_dev
!= NULL
) {
585 hba_id
= udev_device_get_sysattr_value(scsi_dev
, "hba_id");
586 wwpn
= udev_device_get_sysattr_value(scsi_dev
, "wwpn");
587 lun
= udev_device_get_sysattr_value(scsi_dev
, "fcp_lun");
588 if (hba_id
!= NULL
&& lun
!= NULL
&& wwpn
!= NULL
) {
589 path_prepend(path
, "ccw-%s-zfcp-%s:%s", hba_id
, wwpn
, lun
);
594 path_prepend(path
, "ccw-%s", udev_device_get_sysname(parent
));
596 parent
= skip_subsystem(parent
, "ccw");
600 static int builtin_path_id(struct udev_device
*dev
, int argc
, char *argv
[], bool test
) {
601 struct udev_device
*parent
;
603 bool supported_transport
= false;
604 bool supported_parent
= false;
609 parent
= udev_device_get_parent_with_subsystem_devtype(dev
, "ccw", NULL
);
610 if (parent
!= NULL
) {
611 handle_ccw(parent
, dev
, &path
);
615 /* walk up the chain of devices and compose path */
617 while (parent
!= NULL
) {
620 subsys
= udev_device_get_subsystem(parent
);
621 if (subsys
== NULL
) {
623 } else if (streq(subsys
, "scsi_tape")) {
624 handle_scsi_tape(parent
, &path
);
625 } else if (streq(subsys
, "scsi")) {
626 parent
= handle_scsi(parent
, &path
, &supported_parent
);
627 supported_transport
= true;
628 } else if (streq(subsys
, "cciss")) {
629 parent
= handle_cciss(parent
, &path
);
630 supported_transport
= true;
631 } else if (streq(subsys
, "usb")) {
632 parent
= handle_usb(parent
, &path
);
633 supported_transport
= true;
634 } else if (streq(subsys
, "bcma")) {
635 parent
= handle_bcma(parent
, &path
);
636 supported_transport
= true;
637 } else if (streq(subsys
, "serio")) {
638 path_prepend(&path
, "serio-%s", udev_device_get_sysnum(parent
));
639 parent
= skip_subsystem(parent
, "serio");
640 } else if (streq(subsys
, "pci")) {
641 path_prepend(&path
, "pci-%s", udev_device_get_sysname(parent
));
642 parent
= skip_subsystem(parent
, "pci");
643 supported_parent
= true;
644 } else if (streq(subsys
, "platform")) {
645 path_prepend(&path
, "platform-%s", udev_device_get_sysname(parent
));
646 parent
= skip_subsystem(parent
, "platform");
647 supported_transport
= true;
648 supported_parent
= true;
649 } else if (streq(subsys
, "acpi")) {
650 path_prepend(&path
, "acpi-%s", udev_device_get_sysname(parent
));
651 parent
= skip_subsystem(parent
, "acpi");
652 supported_parent
= true;
653 } else if (streq(subsys
, "xen")) {
654 path_prepend(&path
, "xen-%s", udev_device_get_sysname(parent
));
655 parent
= skip_subsystem(parent
, "xen");
656 supported_parent
= true;
657 } else if (streq(subsys
, "scm")) {
658 path_prepend(&path
, "scm-%s", udev_device_get_sysname(parent
));
659 parent
= skip_subsystem(parent
, "scm");
660 supported_transport
= true;
661 supported_parent
= true;
665 parent
= udev_device_get_parent(parent
);
669 * Do not return devices with an unknown parent device type. They
670 * might produce conflicting IDs if the parent does not provide a
671 * unique and predictable name.
673 if (!supported_parent
)
677 * Do not return block devices without a well-known transport. Some
678 * devices do not expose their buses and do not provide a unique
679 * and predictable name that way.
681 if (streq(udev_device_get_subsystem(dev
), "block") && !supported_transport
)
686 char tag
[UTIL_NAME_SIZE
];
690 /* compose valid udev tag name */
691 for (p
= path
, i
= 0; *p
; p
++) {
692 if ((*p
>= '0' && *p
<= '9') ||
693 (*p
>= 'A' && *p
<= 'Z') ||
694 (*p
>= 'a' && *p
<= 'z') ||
700 /* skip all leading '_' */
704 /* avoid second '_' */
710 /* strip trailing '_' */
711 while (i
> 0 && tag
[i
-1] == '_')
715 udev_builtin_add_property(dev
, test
, "ID_PATH", path
);
716 udev_builtin_add_property(dev
, test
, "ID_PATH_TAG", tag
);
723 const struct udev_builtin udev_builtin_path_id
= {
725 .cmd
= builtin_path_id
,
726 .help
= "Compose persistent device path",