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 * Two character prefixes based on the type of interface:
33 * o<index> -- on-board device index number
34 * s<slot>[f<function>] -- hotplug slot index number
35 * x<MAC> -- MAC address
36 * p<bus>s<slot>[f<function>] -- PCI geographical location
37 * p<bus>s<slot>[f<function>][u<port>][...][c<config>][i<interface>]
38 * -- USB port number chain
40 * All multi-function PCI devices will carry the [f<function>] number in the
41 * device name, including the function 0 device.
43 * For USB devices the full chain of port numbers of hubs is composed. If the
44 * name gets longer than the maximum number of 15 characters, the name is not
46 * The usual USB configuration == 1 and interface == 0 values are suppressed.
48 * PCI ethernet card with firmware index "1":
49 * ID_NET_NAME_ONBOARD=eno1
50 * ID_NET_NAME_ONBOARD_LABEL=Ethernet Port 1
52 * PCI ethernet card in hotplug slot with firmware index number:
53 * /sys/devices/pci0000:00/0000:00:1c.3/0000:05:00.0/net/ens1
54 * ID_NET_NAME_MAC=enx000000000466
55 * ID_NET_NAME_PATH=enp5s0
56 * ID_NET_NAME_SLOT=ens1
58 * PCI ethernet multi-function card with 2 ports:
59 * /sys/devices/pci0000:00/0000:00:1c.0/0000:02:00.0/net/enp2s0f0
60 * ID_NET_NAME_MAC=enx78e7d1ea46da
61 * ID_NET_NAME_PATH=enp2s0f0
62 * /sys/devices/pci0000:00/0000:00:1c.0/0000:02:00.1/net/enp2s0f1
63 * ID_NET_NAME_MAC=enx78e7d1ea46dc
64 * ID_NET_NAME_PATH=enp2s0f1
67 * /sys/devices/pci0000:00/0000:00:1c.1/0000:03:00.0/net/wlp3s0
68 * ID_NET_NAME_MAC=wlx0024d7e31130
69 * ID_NET_NAME_PATH=wlp3s0
71 * USB built-in 3G modem:
72 * /sys/devices/pci0000:00/0000:00:1d.0/usb2/2-1/2-1.4/2-1.4:1.6/net/wwp0s29u1u4i6
73 * ID_NET_NAME_MAC=wwx028037ec0200
74 * ID_NET_NAME_PATH=wwp0s29u1u4i6
77 * /sys/devices/pci0000:00/0000:00:1d.0/usb2/2-1/2-1.2/2-1.2:1.0/net/enp0s29u1u2
78 * ID_NET_NAME_MAC=enxd626b3450fb5
79 * ID_NET_NAME_PATH=enp0s29u1u2
89 #include <linux/pci_regs.h>
100 enum netname_type type;
105 struct udev_device *pcidev;
106 char pci_slot[IFNAMSIZ];
107 char pci_path[IFNAMSIZ];
108 char pci_onboard[IFNAMSIZ];
109 const char *pci_onboard_label;
111 struct udev_device *usbdev;
112 char usb_ports[IFNAMSIZ];
115 /* retrieve on-board index number and label from firmware */
116 static int dev_pci_onboard(struct udev_device *dev, struct netnames *names) {
120 /* ACPI _DSM -- device specific method for naming a PCI or PCI Express device */
121 index = udev_device_get_sysattr_value(names->pcidev, "acpi_index");
122 /* SMBIOS type 41 -- Onboard Devices Extended Information */
124 index = udev_device_get_sysattr_value(names->pcidev, "index");
127 idx = strtoul(index, NULL, 0);
130 snprintf(names->pci_onboard, sizeof(names->pci_onboard), "o%d", idx);
132 names->pci_onboard_label = udev_device_get_sysattr_value(names->pcidev, "label");
136 /* read the 256 bytes PCI configuration space to check the multi-function bit */
137 static bool is_pci_singlefunction(struct udev_device *dev) {
143 snprintf(filename, sizeof(filename), "%s/config", udev_device_get_syspath(dev));
144 f = fopen(filename, "re");
147 if (fread(&config, sizeof(config), 1, f) != 1)
150 /* bit 0-6 header type, bit 7 multi/single function device */
151 if ((config[PCI_HEADER_TYPE] & 0x80) == 0)
158 static int dev_pci_slot(struct udev_device *dev, struct netnames *names) {
159 struct udev *udev = udev_device_get_udev(names->pcidev);
163 struct udev_device *pci = NULL;
168 int hotplug_slot = 0;
171 /* compose a name based on the raw kernel's PCI bus, slot numbers */
172 if (sscanf(udev_device_get_sysname(names->pcidev), "0000:%x:%x.%d", &bus, &slot, &func) != 3)
174 if (func == 0 && is_pci_singlefunction(names->pcidev))
175 snprintf(names->pci_path, sizeof(names->pci_path), "p%ds%d", bus, slot);
177 snprintf(names->pci_path, sizeof(names->pci_path), "p%ds%df%d", bus, slot, func);
179 /* ACPI _SUN -- slot user number */
180 pci = udev_device_new_from_subsystem_sysname(udev, "subsystem", "pci");
185 snprintf(slots, sizeof(slots), "%s/slots", udev_device_get_syspath(pci));
186 dir = opendir(slots);
192 for (dent = readdir(dir); dent != NULL; dent = readdir(dir)) {
197 if (dent->d_name[0] == '.')
199 i = strtol(dent->d_name, &rest, 10);
204 snprintf(str, sizeof(str), "%s/%s/address", slots, dent->d_name);
205 if (read_one_line_file(str, &address) >= 0) {
206 /* match slot address with device by stripping the function */
207 if (strncmp(address, udev_device_get_sysname(names->pcidev), strlen(address)) == 0)
212 if (hotplug_slot > 0)
217 if (hotplug_slot > 0) {
218 if (func == 0 && is_pci_singlefunction(names->pcidev))
219 snprintf(names->pci_slot, sizeof(names->pci_slot), "s%d", hotplug_slot);
221 snprintf(names->pci_slot, sizeof(names->pci_slot), "s%df%d", hotplug_slot, func);
224 udev_device_unref(pci);
228 static int names_pci(struct udev_device *dev, struct netnames *names) {
229 struct udev_device *parent;
231 parent = udev_device_get_parent(dev);
234 /* check if our direct parent is a PCI device with no other bus in-between */
235 if (streq("pci", udev_device_get_subsystem(parent))) {
236 names->type = NET_PCI;
237 names->pcidev = parent;
239 names->pcidev = udev_device_get_parent_with_subsystem_devtype(dev, "pci", NULL);
243 dev_pci_onboard(dev, names);
244 dev_pci_slot(dev, names);
248 static int names_usb(struct udev_device *dev, struct netnames *names) {
256 names->usbdev = udev_device_get_parent_with_subsystem_devtype(dev, "usb", "usb_interface");
260 /* get USB port number chain, configuration, interface */
261 util_strscpy(name, sizeof(name), udev_device_get_sysname(names->usbdev));
262 s = strchr(name, '-');
267 s = strchr(ports, ':');
273 s = strchr(config, '.');
279 /* prefix every port number in the chain with "u"*/
281 while ((s = strchr(s, '.')))
283 s = names->usb_ports;
284 l = util_strpcpyl(&s, sizeof(names->usb_ports), "u", ports, NULL);
286 /* append USB config number, suppress the common config == 1 */
287 if (!streq(config, "1"))
288 l = util_strpcpyl(&s, sizeof(names->usb_ports), "c", config, NULL);
290 /* append USB interface number, suppress the interface == 0 */
291 if (!streq(interf, "0"))
292 l = util_strpcpyl(&s, sizeof(names->usb_ports), "i", interf, NULL);
294 return -ENAMETOOLONG;
296 names->type = NET_USB;
300 static int names_mac(struct udev_device *dev, struct netnames *names) {
303 unsigned int a1, a2, a3, a4, a5, a6;
305 /* check for NET_ADDR_PERM, skip random MAC addresses */
306 s = udev_device_get_sysattr_value(dev, "addr_assign_type");
309 i = strtoul(s, NULL, 0);
313 s = udev_device_get_sysattr_value(dev, "address");
316 if (sscanf(s, "%x:%x:%x:%x:%x:%x", &a1, &a2, &a3, &a4, &a5, &a6) != 6)
319 /* skip empty MAC addresses */
320 if (a1 + a2 + a3 + a4 + a5 + a6 == 0)
329 names->mac_valid = true;
333 /* IEEE Organizationally Unique Identifier vendor string */
334 static int ieee_oui(struct udev_device *dev, struct netnames *names, bool test) {
337 if (!names->mac_valid)
339 /* skip commonly misused 00:00:00 (Xerox) prefix */
340 if (memcmp(names->mac, "\0\0\0", 3) == 0)
342 snprintf(str, sizeof(str), "OUI:%02X%02X%02X%02X%02X%02X",
343 names->mac[0], names->mac[1], names->mac[2],
344 names->mac[3], names->mac[4], names->mac[5]);
345 udev_builtin_hwdb_lookup(dev, str, test);
349 static int builtin_net_id(struct udev_device *dev, int argc, char *argv[], bool test) {
353 const char *prefix = "en";
354 struct netnames names;
357 /* handle only ARPHRD_ETHER devices */
358 s = udev_device_get_sysattr_value(dev, "type");
361 i = strtoul(s, NULL, 0);
365 devtype = udev_device_get_devtype(dev);
367 if (streq("wlan", devtype))
369 else if (streq("wwan", devtype))
374 err = names_mac(dev, &names);
375 if (err >= 0 && names.mac_valid) {
378 snprintf(str, sizeof(str), "%sx%02x%02x%02x%02x%02x%02x", prefix,
379 names.mac[0], names.mac[1], names.mac[2],
380 names.mac[3], names.mac[4], names.mac[5]);
381 udev_builtin_add_property(dev, test, "ID_NET_NAME_MAC", str);
383 ieee_oui(dev, &names, test);
386 /* get PCI based path names, we compose only PCI based paths */
387 err = names_pci(dev, &names);
391 /* plain PCI device */
392 if (names.type == NET_PCI) {
395 if (names.pci_onboard[0])
396 if (snprintf(str, sizeof(str), "%s%s", prefix, names.pci_onboard) < (int)sizeof(str))
397 udev_builtin_add_property(dev, test, "ID_NET_NAME_ONBOARD", str);
399 if (names.pci_onboard_label)
400 if (snprintf(str, sizeof(str), "%s%s", prefix, names.pci_onboard_label) < (int)sizeof(str))
401 udev_builtin_add_property(dev, test, "ID_NET_LABEL_ONBOARD", str);
403 if (names.pci_path[0])
404 if (snprintf(str, sizeof(str), "%s%s", prefix, names.pci_path) < (int)sizeof(str))
405 udev_builtin_add_property(dev, test, "ID_NET_NAME_PATH", str);
407 if (names.pci_slot[0])
408 if (snprintf(str, sizeof(str), "%s%s", prefix, names.pci_slot) < (int)sizeof(str))
409 udev_builtin_add_property(dev, test, "ID_NET_NAME_SLOT", str);
414 err = names_usb(dev, &names);
415 if (err >= 0 && names.type == NET_USB) {
418 if (names.pci_path[0])
419 if (snprintf(str, sizeof(str), "%s%s%s", prefix, names.pci_path, names.usb_ports) < (int)sizeof(str))
420 udev_builtin_add_property(dev, test, "ID_NET_NAME_PATH", str);
422 if (names.pci_slot[0])
423 if (snprintf(str, sizeof(str), "%s%s%s", prefix, names.pci_slot, names.usb_ports) < (int)sizeof(str))
424 udev_builtin_add_property(dev, test, "ID_NET_NAME_SLOT", str);
430 const struct udev_builtin udev_builtin_net_id = {
432 .cmd = builtin_net_id,
433 .help = "network device properties",