2 This file is part of systemd.
4 Copyright 2012 Kay Sievers <kay@vrfy.org>
6 systemd is free software; you can redistribute it and/or modify it
7 under the terms of the GNU Lesser General Public License as published by
8 the Free Software Foundation; either version 2.1 of the License, or
9 (at your option) any later version.
11 systemd is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Lesser General Public License for more details.
16 You should have received a copy of the GNU Lesser General Public License
17 along with systemd; If not, see <http://www.gnu.org/licenses/>.
21 * Predictable network interface device names based on:
22 * - firmware/bios-provided index numbers for on-board devices
23 * - firmware-provided pci-express hotplug slot index number
24 * - physical/geographical location of the hardware
25 * - the interface's MAC address
27 * http://www.freedesktop.org/wiki/Software/systemd/PredictableNetworkInterfaceNames
29 * Two character prefixes based on the type of interface:
31 * sl -- serial line IP (slip)
36 * b<number> -- BCMA bus core number
37 * ccw<name> -- CCW bus group name
38 * o<index> -- on-board device index number
39 * s<slot>[f<function>][d<dev_id>] -- hotplug slot index number
40 * x<MAC> -- MAC address
41 * [P<domain>]p<bus>s<slot>[f<function>][d<dev_id>]
42 * -- PCI geographical location
43 * [P<domain>]p<bus>s<slot>[f<function>][u<port>][..][c<config>][i<interface>]
44 * -- USB port number chain
46 * All multi-function PCI devices will carry the [f<function>] number in the
47 * device name, including the function 0 device.
49 * When using PCI geography, The PCI domain is only prepended when it is not 0.
51 * For USB devices the full chain of port numbers of hubs is composed. If the
52 * name gets longer than the maximum number of 15 characters, the name is not
54 * The usual USB configuration == 1 and interface == 0 values are suppressed.
56 * PCI ethernet card with firmware index "1":
57 * ID_NET_NAME_ONBOARD=eno1
58 * ID_NET_NAME_ONBOARD_LABEL=Ethernet Port 1
60 * PCI ethernet card in hotplug slot with firmware index number:
61 * /sys/devices/pci0000:00/0000:00:1c.3/0000:05:00.0/net/ens1
62 * ID_NET_NAME_MAC=enx000000000466
63 * ID_NET_NAME_PATH=enp5s0
64 * ID_NET_NAME_SLOT=ens1
66 * PCI ethernet multi-function card with 2 ports:
67 * /sys/devices/pci0000:00/0000:00:1c.0/0000:02:00.0/net/enp2s0f0
68 * ID_NET_NAME_MAC=enx78e7d1ea46da
69 * ID_NET_NAME_PATH=enp2s0f0
70 * /sys/devices/pci0000:00/0000:00:1c.0/0000:02:00.1/net/enp2s0f1
71 * ID_NET_NAME_MAC=enx78e7d1ea46dc
72 * ID_NET_NAME_PATH=enp2s0f1
75 * /sys/devices/pci0000:00/0000:00:1c.1/0000:03:00.0/net/wlp3s0
76 * ID_NET_NAME_MAC=wlx0024d7e31130
77 * ID_NET_NAME_PATH=wlp3s0
79 * USB built-in 3G modem:
80 * /sys/devices/pci0000:00/0000:00:1d.0/usb2/2-1/2-1.4/2-1.4:1.6/net/wwp0s29u1u4i6
81 * ID_NET_NAME_MAC=wwx028037ec0200
82 * ID_NET_NAME_PATH=wwp0s29u1u4i6
85 * /sys/devices/pci0000:00/0000:00:1d.0/usb2/2-1/2-1.2/2-1.2:1.0/net/enp0s29u1u2
86 * ID_NET_NAME_MAC=enxd626b3450fb5
87 * ID_NET_NAME_PATH=enp0s29u1u2
97 #include <linux/pci_regs.h>
112 enum netname_type type;
117 struct udev_device *pcidev;
118 char pci_slot[IFNAMSIZ];
119 char pci_path[IFNAMSIZ];
120 char pci_onboard[IFNAMSIZ];
121 const char *pci_onboard_label;
123 char usb_ports[IFNAMSIZ];
124 char bcma_core[IFNAMSIZ];
125 char ccw_group[IFNAMSIZ];
128 /* retrieve on-board index number and label from firmware */
129 static int dev_pci_onboard(struct udev_device *dev, struct netnames *names) {
133 /* ACPI _DSM -- device specific method for naming a PCI or PCI Express device */
134 index = udev_device_get_sysattr_value(names->pcidev, "acpi_index");
135 /* SMBIOS type 41 -- Onboard Devices Extended Information */
137 index = udev_device_get_sysattr_value(names->pcidev, "index");
140 idx = strtoul(index, NULL, 0);
143 snprintf(names->pci_onboard, sizeof(names->pci_onboard), "o%d", idx);
145 names->pci_onboard_label = udev_device_get_sysattr_value(names->pcidev, "label");
149 /* read the 256 bytes PCI configuration space to check the multi-function bit */
150 static bool is_pci_multifunction(struct udev_device *dev) {
156 snprintf(filename, sizeof(filename), "%s/config", udev_device_get_syspath(dev));
157 f = fopen(filename, "re");
160 if (fread(&config, sizeof(config), 1, f) != 1)
163 /* bit 0-6 header type, bit 7 multi/single function device */
164 if ((config[PCI_HEADER_TYPE] & 0x80) != 0)
172 static int dev_pci_slot(struct udev_device *dev, struct netnames *names) {
173 struct udev *udev = udev_device_get_udev(names->pcidev);
174 unsigned domain, bus, slot, func, dev_id = 0;
178 struct udev_device *pci = NULL;
179 char slots[256], str[256];
180 _cleanup_closedir_ DIR *dir = NULL;
182 int hotplug_slot = 0, err = 0;
184 if (sscanf(udev_device_get_sysname(names->pcidev), "%x:%x:%x.%u", &domain, &bus, &slot, &func) != 4)
187 /* kernel provided multi-device index */
188 attr = udev_device_get_sysattr_value(dev, "dev_id");
190 dev_id = strtol(attr, NULL, 16);
192 /* compose a name based on the raw kernel's PCI bus, slot numbers */
194 l = sizeof(names->pci_path);
196 l = strpcpyf(&s, l, "P%d", domain);
197 l = strpcpyf(&s, l, "p%ds%d", bus, slot);
198 if (func > 0 || is_pci_multifunction(names->pcidev))
199 l = strpcpyf(&s, l, "f%d", func);
201 l = strpcpyf(&s, l, "d%d", dev_id);
203 names->pci_path[0] = '\0';
205 /* ACPI _SUN -- slot user number */
206 pci = udev_device_new_from_subsystem_sysname(udev, "subsystem", "pci");
211 snprintf(slots, sizeof(slots), "%s/slots", udev_device_get_syspath(pci));
212 dir = opendir(slots);
218 for (dent = readdir(dir); dent != NULL; dent = readdir(dir)) {
223 if (dent->d_name[0] == '.')
225 i = strtol(dent->d_name, &rest, 10);
230 snprintf(str, sizeof(str), "%s/%s/address", slots, dent->d_name);
231 if (read_one_line_file(str, &address) >= 0) {
232 /* match slot address with device by stripping the function */
233 if (strneq(address, udev_device_get_sysname(names->pcidev), strlen(address)))
238 if (hotplug_slot > 0)
242 if (hotplug_slot > 0) {
244 l = sizeof(names->pci_slot);
246 l = strpcpyf(&s, l, "P%d", domain);
247 l = strpcpyf(&s, l, "s%d", hotplug_slot);
248 if (func > 0 || is_pci_multifunction(names->pcidev))
249 l = strpcpyf(&s, l, "f%d", func);
251 l = strpcpyf(&s, l, "d%d", dev_id);
253 names->pci_path[0] = '\0';
256 udev_device_unref(pci);
260 static int names_pci(struct udev_device *dev, struct netnames *names) {
261 struct udev_device *parent;
263 parent = udev_device_get_parent(dev);
266 /* check if our direct parent is a PCI device with no other bus in-between */
267 if (streq_ptr("pci", udev_device_get_subsystem(parent))) {
268 names->type = NET_PCI;
269 names->pcidev = parent;
271 names->pcidev = udev_device_get_parent_with_subsystem_devtype(dev, "pci", NULL);
275 dev_pci_onboard(dev, names);
276 dev_pci_slot(dev, names);
280 static int names_usb(struct udev_device *dev, struct netnames *names) {
281 struct udev_device *usbdev;
289 usbdev = udev_device_get_parent_with_subsystem_devtype(dev, "usb", "usb_interface");
293 /* get USB port number chain, configuration, interface */
294 strscpy(name, sizeof(name), udev_device_get_sysname(usbdev));
295 s = strchr(name, '-');
300 s = strchr(ports, ':');
306 s = strchr(config, '.');
312 /* prefix every port number in the chain with "u"*/
314 while ((s = strchr(s, '.')))
316 s = names->usb_ports;
317 l = strpcpyl(&s, sizeof(names->usb_ports), "u", ports, NULL);
319 /* append USB config number, suppress the common config == 1 */
320 if (!streq(config, "1"))
321 l = strpcpyl(&s, sizeof(names->usb_ports), "c", config, NULL);
323 /* append USB interface number, suppress the interface == 0 */
324 if (!streq(interf, "0"))
325 l = strpcpyl(&s, sizeof(names->usb_ports), "i", interf, NULL);
327 return -ENAMETOOLONG;
329 names->type = NET_USB;
333 static int names_bcma(struct udev_device *dev, struct netnames *names) {
334 struct udev_device *bcmadev;
337 bcmadev = udev_device_get_parent_with_subsystem_devtype(dev, "bcma", NULL);
341 /* bus num:core num */
342 if (sscanf(udev_device_get_sysname(bcmadev), "bcma%*u:%u", &core) != 1)
344 /* suppress the common core == 0 */
346 snprintf(names->bcma_core, sizeof(names->bcma_core), "b%u", core);
348 names->type = NET_BCMA;
352 static int names_ccw(struct udev_device *dev, struct netnames *names) {
353 struct udev_device *cdev;
358 /* Retrieve the associated CCW device */
359 cdev = udev_device_get_parent(dev);
363 /* Network devices are always grouped CCW devices */
364 if (!streq_ptr("ccwgroup", udev_device_get_subsystem(cdev)))
367 /* Retrieve bus-ID of the grouped CCW device. The bus-ID uniquely
368 * identifies the network device on the Linux on System z channel
369 * subsystem. Note that the bus-ID contains lowercase characters.
371 bus_id = udev_device_get_sysname(cdev);
375 /* Check the length of the bus-ID. Rely on that the kernel provides
376 * a correct bus-ID; alternatively, improve this check and parse and
377 * verify each bus-ID part...
379 bus_id_len = strlen(bus_id);
380 if (!bus_id_len || bus_id_len < 8 || bus_id_len > 9)
383 /* Store the CCW bus-ID for use as network device name */
384 rc = snprintf(names->ccw_group, sizeof(names->ccw_group), "ccw%s", bus_id);
385 if (rc >= 0 && rc < (int)sizeof(names->ccw_group))
386 names->type = NET_CCWGROUP;
390 static int names_mac(struct udev_device *dev, struct netnames *names) {
393 unsigned int a1, a2, a3, a4, a5, a6;
395 /* check for NET_ADDR_PERM, skip random MAC addresses */
396 s = udev_device_get_sysattr_value(dev, "addr_assign_type");
399 i = strtoul(s, NULL, 0);
403 s = udev_device_get_sysattr_value(dev, "address");
406 if (sscanf(s, "%x:%x:%x:%x:%x:%x", &a1, &a2, &a3, &a4, &a5, &a6) != 6)
409 /* skip empty MAC addresses */
410 if (a1 + a2 + a3 + a4 + a5 + a6 == 0)
419 names->mac_valid = true;
423 /* IEEE Organizationally Unique Identifier vendor string */
424 static int ieee_oui(struct udev_device *dev, struct netnames *names, bool test) {
427 if (!names->mac_valid)
429 /* skip commonly misused 00:00:00 (Xerox) prefix */
430 if (memcmp(names->mac, "\0\0\0", 3) == 0)
432 snprintf(str, sizeof(str), "OUI:%02X%02X%02X%02X%02X%02X",
433 names->mac[0], names->mac[1], names->mac[2],
434 names->mac[3], names->mac[4], names->mac[5]);
435 udev_builtin_hwdb_lookup(dev, NULL, str, NULL, test);
439 static int builtin_net_id(struct udev_device *dev, int argc, char *argv[], bool test) {
444 const char *prefix = "en";
445 struct netnames names = {};
448 /* handle only ARPHRD_ETHER and ARPHRD_SLIP devices */
449 s = udev_device_get_sysattr_value(dev, "type");
452 i = strtoul(s, NULL, 0);
454 case 1: /* ARPHRD_ETHER */
457 case 256: /* ARPHRD_SLIP */
464 /* skip stacked devices, like VLANs, ... */
465 s = udev_device_get_sysattr_value(dev, "ifindex");
468 p = udev_device_get_sysattr_value(dev, "iflink");
474 devtype = udev_device_get_devtype(dev);
476 if (streq("wlan", devtype))
478 else if (streq("wwan", devtype))
482 err = names_mac(dev, &names);
483 if (err >= 0 && names.mac_valid) {
486 snprintf(str, sizeof(str), "%sx%02x%02x%02x%02x%02x%02x", prefix,
487 names.mac[0], names.mac[1], names.mac[2],
488 names.mac[3], names.mac[4], names.mac[5]);
489 udev_builtin_add_property(dev, test, "ID_NET_NAME_MAC", str);
491 ieee_oui(dev, &names, test);
494 /* get path names for Linux on System z network devices */
495 err = names_ccw(dev, &names);
496 if (err >= 0 && names.type == NET_CCWGROUP) {
499 if (snprintf(str, sizeof(str), "%s%s", prefix, names.ccw_group) < (int)sizeof(str))
500 udev_builtin_add_property(dev, test, "ID_NET_NAME_PATH", str);
504 /* get PCI based path names, we compose only PCI based paths */
505 err = names_pci(dev, &names);
509 /* plain PCI device */
510 if (names.type == NET_PCI) {
513 if (names.pci_onboard[0])
514 if (snprintf(str, sizeof(str), "%s%s", prefix, names.pci_onboard) < (int)sizeof(str))
515 udev_builtin_add_property(dev, test, "ID_NET_NAME_ONBOARD", str);
517 if (names.pci_onboard_label)
518 if (snprintf(str, sizeof(str), "%s%s", prefix, names.pci_onboard_label) < (int)sizeof(str))
519 udev_builtin_add_property(dev, test, "ID_NET_LABEL_ONBOARD", str);
521 if (names.pci_path[0])
522 if (snprintf(str, sizeof(str), "%s%s", prefix, names.pci_path) < (int)sizeof(str))
523 udev_builtin_add_property(dev, test, "ID_NET_NAME_PATH", str);
525 if (names.pci_slot[0])
526 if (snprintf(str, sizeof(str), "%s%s", prefix, names.pci_slot) < (int)sizeof(str))
527 udev_builtin_add_property(dev, test, "ID_NET_NAME_SLOT", str);
532 err = names_usb(dev, &names);
533 if (err >= 0 && names.type == NET_USB) {
536 if (names.pci_path[0])
537 if (snprintf(str, sizeof(str), "%s%s%s", prefix, names.pci_path, names.usb_ports) < (int)sizeof(str))
538 udev_builtin_add_property(dev, test, "ID_NET_NAME_PATH", str);
540 if (names.pci_slot[0])
541 if (snprintf(str, sizeof(str), "%s%s%s", prefix, names.pci_slot, names.usb_ports) < (int)sizeof(str))
542 udev_builtin_add_property(dev, test, "ID_NET_NAME_SLOT", str);
547 err = names_bcma(dev, &names);
548 if (err >= 0 && names.type == NET_BCMA) {
551 if (names.pci_path[0])
552 if (snprintf(str, sizeof(str), "%s%s%s", prefix, names.pci_path, names.bcma_core) < (int)sizeof(str))
553 udev_builtin_add_property(dev, test, "ID_NET_NAME_PATH", str);
555 if (names.pci_slot[0])
556 if (snprintf(str, sizeof(str), "%s%s%s", prefix, names.pci_slot, names.bcma_core) < (int)sizeof(str))
557 udev_builtin_add_property(dev, test, "ID_NET_NAME_SLOT", str);
564 const struct udev_builtin udev_builtin_net_id = {
566 .cmd = builtin_net_id,
567 .help = "network device properties",