chiark / gitweb /
4f2b2c1f73b35ee1c8603f16627cf65ee876c263
[elogind.git] / src / udev / udev-builtin-net_id.c
1 /***
2   This file is part of systemd.
3
4   Copyright 2012 Kay Sievers <kay@vrfy.org>
5
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.
10
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.
15
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/>.
18 ***/
19
20 /*
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
26  *
27  * http://www.freedesktop.org/wiki/Software/systemd/PredictableNetworkInterfaceNames
28  *
29  * Two character prefixes based on the type of interface:
30  *   en -- ethernet
31  *   sl -- serial line IP (slip)
32  *   wl -- wlan
33  *   ww -- wwan
34  *
35  * Type of names:
36  *   o<index>                              -- on-board device index number
37  *   s<slot>[f<function>][d<dev_id>]       -- hotplug slot index number
38  *   x<MAC>                                -- MAC address
39  *   [P<domain>]p<bus>s<slot>[f<function>][d<dev_id>]
40  *                                         -- PCI geographical location
41  *   [P<domain>]p<bus>s<slot>[f<function>][u<port>][..][c<config>][i<interface>]
42  *                                         -- USB port number chain
43  *
44  * All multi-function PCI devices will carry the [f<function>] number in the
45  * device name, including the function 0 device.
46  *
47  * When using PCI geography, The PCI domain is only prepended when it is not 0.
48  *
49  * For USB devices the full chain of port numbers of hubs is composed. If the
50  * name gets longer than the maximum number of 15 characters, the name is not
51  * exported.
52  * The usual USB configuration == 1 and interface == 0 values are suppressed.
53  *
54  * PCI ethernet card with firmware index "1":
55  *   ID_NET_NAME_ONBOARD=eno1
56  *   ID_NET_NAME_ONBOARD_LABEL=Ethernet Port 1
57  *
58  * PCI ethernet card in hotplug slot with firmware index number:
59  *   /sys/devices/pci0000:00/0000:00:1c.3/0000:05:00.0/net/ens1
60  *   ID_NET_NAME_MAC=enx000000000466
61  *   ID_NET_NAME_PATH=enp5s0
62  *   ID_NET_NAME_SLOT=ens1
63  *
64  * PCI ethernet multi-function card with 2 ports:
65  *   /sys/devices/pci0000:00/0000:00:1c.0/0000:02:00.0/net/enp2s0f0
66  *   ID_NET_NAME_MAC=enx78e7d1ea46da
67  *   ID_NET_NAME_PATH=enp2s0f0
68  *   /sys/devices/pci0000:00/0000:00:1c.0/0000:02:00.1/net/enp2s0f1
69  *   ID_NET_NAME_MAC=enx78e7d1ea46dc
70  *   ID_NET_NAME_PATH=enp2s0f1
71  *
72  * PCI wlan card:
73  *   /sys/devices/pci0000:00/0000:00:1c.1/0000:03:00.0/net/wlp3s0
74  *   ID_NET_NAME_MAC=wlx0024d7e31130
75  *   ID_NET_NAME_PATH=wlp3s0
76  *
77  * USB built-in 3G modem:
78  *   /sys/devices/pci0000:00/0000:00:1d.0/usb2/2-1/2-1.4/2-1.4:1.6/net/wwp0s29u1u4i6
79  *   ID_NET_NAME_MAC=wwx028037ec0200
80  *   ID_NET_NAME_PATH=wwp0s29u1u4i6
81  *
82  * USB Android phone:
83  *   /sys/devices/pci0000:00/0000:00:1d.0/usb2/2-1/2-1.2/2-1.2:1.0/net/enp0s29u1u2
84  *   ID_NET_NAME_MAC=enxd626b3450fb5
85  *   ID_NET_NAME_PATH=enp0s29u1u2
86  */
87
88 #include <stdio.h>
89 #include <stdlib.h>
90 #include <stdarg.h>
91 #include <unistd.h>
92 #include <string.h>
93 #include <errno.h>
94 #include <net/if.h>
95 #include <linux/pci_regs.h>
96
97 #include "udev.h"
98 #include "fileio.h"
99
100 enum netname_type{
101         NET_UNDEF,
102         NET_PCI,
103         NET_USB,
104         NET_BCMA,
105         NET_VIRTIO,
106         NET_CCWGROUP,
107 };
108
109 struct netnames {
110         enum netname_type type;
111
112         uint8_t mac[6];
113         bool mac_valid;
114
115         struct udev_device *pcidev;
116         char pci_slot[IFNAMSIZ];
117         char pci_path[IFNAMSIZ];
118         char pci_onboard[IFNAMSIZ];
119         const char *pci_onboard_label;
120
121         char usb_ports[IFNAMSIZ];
122
123         char bcma_core[IFNAMSIZ];
124
125         char virtio_core[IFNAMSIZ];
126
127         char ccw_core[IFNAMSIZ];
128 };
129
130 /* retrieve on-board index number and label from firmware */
131 static int dev_pci_onboard(struct udev_device *dev, struct netnames *names) {
132         const char *index;
133         int idx;
134
135         /* ACPI _DSM  -- device specific method for naming a PCI or PCI Express device */
136         index = udev_device_get_sysattr_value(names->pcidev, "acpi_index");
137         /* SMBIOS type 41 -- Onboard Devices Extended Information */
138         if (!index)
139                 index = udev_device_get_sysattr_value(names->pcidev, "index");
140         if (!index)
141                 return -ENOENT;
142         idx = strtoul(index, NULL, 0);
143         if (idx <= 0)
144                 return -EINVAL;
145         snprintf(names->pci_onboard, sizeof(names->pci_onboard), "o%d", idx);
146
147         names->pci_onboard_label = udev_device_get_sysattr_value(names->pcidev, "label");
148         return 0;
149 }
150
151 /* read the 256 bytes PCI configuration space to check the multi-function bit */
152 static bool is_pci_multifunction(struct udev_device *dev) {
153         char filename[256];
154         FILE *f = NULL;
155         char config[64];
156         bool multi = false;
157
158         snprintf(filename, sizeof(filename), "%s/config", udev_device_get_syspath(dev));
159         f = fopen(filename, "re");
160         if (!f)
161                 goto out;
162         if (fread(&config, sizeof(config), 1, f) != 1)
163                 goto out;
164
165         /* bit 0-6 header type, bit 7 multi/single function device */
166         if ((config[PCI_HEADER_TYPE] & 0x80) != 0)
167                 multi = true;
168 out:
169         if (f)
170                 fclose(f);
171         return multi;
172 }
173
174 static int dev_pci_slot(struct udev_device *dev, struct netnames *names) {
175         struct udev *udev = udev_device_get_udev(names->pcidev);
176         unsigned domain, bus, slot, func, dev_id = 0;
177         size_t l;
178         char *s;
179         const char *attr;
180         struct udev_device *pci = NULL;
181         char slots[256], str[256];
182         _cleanup_closedir_ DIR *dir = NULL;
183         struct dirent *dent;
184         int hotplug_slot = 0, err = 0;
185
186         if (sscanf(udev_device_get_sysname(names->pcidev), "%x:%x:%x.%u", &domain, &bus, &slot, &func) != 4)
187                 return -ENOENT;
188
189         /* kernel provided multi-device index */
190         attr = udev_device_get_sysattr_value(dev, "dev_id");
191         if (attr)
192                 dev_id = strtol(attr, NULL, 16);
193
194         /* compose a name based on the raw kernel's PCI bus, slot numbers */
195         s = names->pci_path;
196         l = sizeof(names->pci_path);
197         if (domain > 0)
198                 l = strpcpyf(&s, l, "P%d", domain);
199         l = strpcpyf(&s, l, "p%ds%d", bus, slot);
200         if (func > 0 || is_pci_multifunction(names->pcidev))
201                 l = strpcpyf(&s, l, "f%d", func);
202         if (dev_id > 0)
203                 l = strpcpyf(&s, l, "d%d", dev_id);
204         if (l == 0)
205                 names->pci_path[0] = '\0';
206
207         /* ACPI _SUN  -- slot user number */
208         pci = udev_device_new_from_subsystem_sysname(udev, "subsystem", "pci");
209         if (!pci) {
210                 err = -ENOENT;
211                 goto out;
212         }
213         snprintf(slots, sizeof(slots), "%s/slots", udev_device_get_syspath(pci));
214         dir = opendir(slots);
215         if (!dir) {
216                 err = -errno;
217                 goto out;
218         }
219
220         for (dent = readdir(dir); dent != NULL; dent = readdir(dir)) {
221                 int i;
222                 char *rest;
223                 char *address;
224
225                 if (dent->d_name[0] == '.')
226                         continue;
227                 i = strtol(dent->d_name, &rest, 10);
228                 if (rest[0] != '\0')
229                         continue;
230                 if (i < 1)
231                         continue;
232                 snprintf(str, sizeof(str), "%s/%s/address", slots, dent->d_name);
233                 if (read_one_line_file(str, &address) >= 0) {
234                         /* match slot address with device by stripping the function */
235                         if (strneq(address, udev_device_get_sysname(names->pcidev), strlen(address)))
236                                 hotplug_slot = i;
237                         free(address);
238                 }
239
240                 if (hotplug_slot > 0)
241                         break;
242         }
243
244         if (hotplug_slot > 0) {
245                 s = names->pci_slot;
246                 l = sizeof(names->pci_slot);
247                 if (domain > 0)
248                         l = strpcpyf(&s, l, "P%d", domain);
249                 l = strpcpyf(&s, l, "s%d", hotplug_slot);
250                 if (func > 0 || is_pci_multifunction(names->pcidev))
251                         l = strpcpyf(&s, l, "f%d", func);
252                 if (dev_id > 0)
253                         l = strpcpyf(&s, l, "d%d", dev_id);
254                 if (l == 0)
255                         names->pci_path[0] = '\0';
256         }
257 out:
258         udev_device_unref(pci);
259         return err;
260 }
261
262 static int names_pci(struct udev_device *dev, struct netnames *names) {
263         struct udev_device *parent;
264
265         parent = udev_device_get_parent(dev);
266         if (!parent)
267                 return -ENOENT;
268         /* check if our direct parent is a PCI device with no other bus in-between */
269         if (streq_ptr("pci", udev_device_get_subsystem(parent))) {
270                 names->type = NET_PCI;
271                 names->pcidev = parent;
272         } else {
273                 names->pcidev = udev_device_get_parent_with_subsystem_devtype(dev, "pci", NULL);
274                 if (!names->pcidev)
275                         return -ENOENT;
276         }
277         dev_pci_onboard(dev, names);
278         dev_pci_slot(dev, names);
279         return 0;
280 }
281
282 static int names_usb(struct udev_device *dev, struct netnames *names) {
283         struct udev_device *usbdev;
284         char name[256];
285         char *ports;
286         char *config;
287         char *interf;
288         size_t l;
289         char *s;
290
291         usbdev = udev_device_get_parent_with_subsystem_devtype(dev, "usb", "usb_interface");
292         if (!usbdev)
293                 return -ENOENT;
294
295         /* get USB port number chain, configuration, interface */
296         strscpy(name, sizeof(name), udev_device_get_sysname(usbdev));
297         s = strchr(name, '-');
298         if (!s)
299                 return -EINVAL;
300         ports = s+1;
301
302         s = strchr(ports, ':');
303         if (!s)
304                 return -EINVAL;
305         s[0] = '\0';
306         config = s+1;
307
308         s = strchr(config, '.');
309         if (!s)
310                 return -EINVAL;
311         s[0] = '\0';
312         interf = s+1;
313
314         /* prefix every port number in the chain with "u"*/
315         s = ports;
316         while ((s = strchr(s, '.')))
317                 s[0] = 'u';
318         s = names->usb_ports;
319         l = strpcpyl(&s, sizeof(names->usb_ports), "u", ports, NULL);
320
321         /* append USB config number, suppress the common config == 1 */
322         if (!streq(config, "1"))
323                 l = strpcpyl(&s, sizeof(names->usb_ports), "c", config, NULL);
324
325         /* append USB interface number, suppress the interface == 0 */
326         if (!streq(interf, "0"))
327                 l = strpcpyl(&s, sizeof(names->usb_ports), "i", interf, NULL);
328         if (l == 0)
329                 return -ENAMETOOLONG;
330
331         names->type = NET_USB;
332         return 0;
333 }
334
335 static int names_bcma(struct udev_device *dev, struct netnames *names) {
336         struct udev_device *bcmadev;
337         unsigned int core;
338
339         bcmadev = udev_device_get_parent_with_subsystem_devtype(dev, "bcma", NULL);
340         if (!bcmadev)
341                 return -ENOENT;
342
343         /* bus num:core num */
344         if (sscanf(udev_device_get_sysname(bcmadev), "bcma%*u:%u", &core) != 1)
345                 return -EINVAL;
346         /* suppress the common core == 0 */
347         if (core > 0)
348                 snprintf(names->bcma_core, sizeof(names->bcma_core), "b%u", core);
349
350         names->type = NET_BCMA;
351         return 0;
352 }
353
354 static int names_virtio(struct udev_device *dev, struct netnames *names) {
355         struct udev_device *virtdev;
356         unsigned int core;
357
358         virtdev = udev_device_get_parent_with_subsystem_devtype(dev, "virtio", NULL);
359         if (!virtdev)
360                 return -ENOENT;
361
362         /* core num */
363         if (sscanf(udev_device_get_sysname(virtdev), "virtio%u", &core) != 1)
364                 return -EINVAL;
365         /* suppress the common core == 0 */
366         if (core > 0)
367                 snprintf(names->virtio_core, sizeof(names->virtio_core), "v%u", core);
368
369         names->type = NET_VIRTIO;
370         return 0;
371 }
372
373 static int names_ccw(struct  udev_device *dev, struct netnames *names) {
374         struct udev_device *cdev;
375         const char *bus_id;
376         size_t bus_id_len;
377         int rc;
378
379         /* Retrieve the associated CCW device */
380         cdev = udev_device_get_parent(dev);
381         if (!cdev)
382                 return -ENOENT;
383
384         /* Network devices are always grouped CCW devices */
385         if (!streq_ptr("ccwgroup", udev_device_get_subsystem(cdev)))
386                 return -ENOENT;
387
388         /* Retrieve bus-ID of the grouped CCW device.  The bus-ID uniquely
389          * identifies the network device on the Linux on System z channel
390          * subsystem.  Note that the bus-ID contains lowercase characters.
391          */
392         bus_id = udev_device_get_sysname(cdev);
393         if (!bus_id)
394                 return -ENOENT;
395
396         /* Check the length of the bus-ID.  Rely on that the kernel provides
397          * a correct bus-ID; alternatively, improve this check and parse and
398          * verify each bus-ID part...
399          */
400         bus_id_len = strlen(bus_id);
401         if (!bus_id_len || bus_id_len < 8 || bus_id_len > 9)
402                 return -EINVAL;
403
404         /* Store the CCW bus-ID for use as network device name */
405         rc = snprintf(names->ccw_core, sizeof(names->ccw_core), "ccw%s", bus_id);
406         if (rc >= 0 && rc < (int)sizeof(names->ccw_core))
407                 names->type = NET_CCWGROUP;
408         return 0;
409 }
410
411 static int names_mac(struct udev_device *dev, struct netnames *names) {
412         const char *s;
413         unsigned int i;
414         unsigned int a1, a2, a3, a4, a5, a6;
415
416         /* check for NET_ADDR_PERM, skip random MAC addresses */
417         s = udev_device_get_sysattr_value(dev, "addr_assign_type");
418         if (!s)
419                 return EXIT_FAILURE;
420         i = strtoul(s, NULL, 0);
421         if (i != 0)
422                 return 0;
423
424         s = udev_device_get_sysattr_value(dev, "address");
425         if (!s)
426                 return -ENOENT;
427         if (sscanf(s, "%x:%x:%x:%x:%x:%x", &a1, &a2, &a3, &a4, &a5, &a6) != 6)
428                 return -EINVAL;
429
430         /* skip empty MAC addresses */
431         if (a1 + a2 + a3 + a4 + a5 + a6 == 0)
432                 return -EINVAL;
433
434         names->mac[0] = a1;
435         names->mac[1] = a2;
436         names->mac[2] = a3;
437         names->mac[3] = a4;
438         names->mac[4] = a5;
439         names->mac[5] = a6;
440         names->mac_valid = true;
441         return 0;
442 }
443
444 /* IEEE Organizationally Unique Identifier vendor string */
445 static int ieee_oui(struct udev_device *dev, struct netnames *names, bool test) {
446         char str[32];
447
448         if (!names->mac_valid)
449                 return -ENOENT;
450         /* skip commonly misused 00:00:00 (Xerox) prefix */
451         if (memcmp(names->mac, "\0\0\0", 3) == 0)
452                 return -EINVAL;
453         snprintf(str, sizeof(str), "OUI:%02X%02X%02X%02X%02X%02X",
454                  names->mac[0], names->mac[1], names->mac[2],
455                  names->mac[3], names->mac[4], names->mac[5]);
456         udev_builtin_hwdb_lookup(dev, NULL, str, NULL, test);
457         return 0;
458 }
459
460 static int builtin_net_id(struct udev_device *dev, int argc, char *argv[], bool test) {
461         const char *s;
462         const char *p;
463         unsigned int i;
464         const char *devtype;
465         const char *prefix = "en";
466         struct netnames names = {};
467         int err;
468
469         /* handle only ARPHRD_ETHER and ARPHRD_SLIP devices */
470         s = udev_device_get_sysattr_value(dev, "type");
471         if (!s)
472                 return EXIT_FAILURE;
473         i = strtoul(s, NULL, 0);
474         switch (i) {
475         case 1: /* ARPHRD_ETHER */
476                 prefix = "en";
477                 break;
478         case 256: /* ARPHRD_SLIP */
479                 prefix = "sl";
480                 break;
481         default:
482                 return 0;
483         }
484
485         /* skip stacked devices, like VLANs, ... */
486         s = udev_device_get_sysattr_value(dev, "ifindex");
487         if (!s)
488                 return EXIT_FAILURE;
489         p = udev_device_get_sysattr_value(dev, "iflink");
490         if (!p)
491                 return EXIT_FAILURE;
492         if (!streq(s, p))
493                 return 0;
494
495         devtype = udev_device_get_devtype(dev);
496         if (devtype) {
497                 if (streq("wlan", devtype))
498                         prefix = "wl";
499                 else if (streq("wwan", devtype))
500                         prefix = "ww";
501         }
502
503         err = names_mac(dev, &names);
504         if (err >= 0 && names.mac_valid) {
505                 char str[IFNAMSIZ];
506
507                 snprintf(str, sizeof(str), "%sx%02x%02x%02x%02x%02x%02x", prefix,
508                          names.mac[0], names.mac[1], names.mac[2],
509                          names.mac[3], names.mac[4], names.mac[5]);
510                 udev_builtin_add_property(dev, test, "ID_NET_NAME_MAC", str);
511
512                 ieee_oui(dev, &names, test);
513         }
514
515         /* get path names for Linux on System z network devices */
516         err = names_ccw(dev, &names);
517         if (err >= 0 && names.type == NET_CCWGROUP) {
518                 char str[IFNAMSIZ];
519
520                 if (snprintf(str, sizeof(str), "%s%s", prefix, names.ccw_core) < (int)sizeof(str))
521                         udev_builtin_add_property(dev, test, "ID_NET_NAME_PATH", str);
522                 goto out;
523         }
524
525         /* get PCI based path names, we compose only PCI based paths */
526         err = names_pci(dev, &names);
527         if (err < 0)
528                 goto out;
529
530         /* plain PCI device */
531         if (names.type == NET_PCI) {
532                 char str[IFNAMSIZ];
533
534                 if (names.pci_onboard[0])
535                         if (snprintf(str, sizeof(str), "%s%s", prefix, names.pci_onboard) < (int)sizeof(str))
536                                 udev_builtin_add_property(dev, test, "ID_NET_NAME_ONBOARD", str);
537
538                 if (names.pci_onboard_label)
539                         if (snprintf(str, sizeof(str), "%s%s", prefix, names.pci_onboard_label) < (int)sizeof(str))
540                                 udev_builtin_add_property(dev, test, "ID_NET_LABEL_ONBOARD", str);
541
542                 if (names.pci_path[0])
543                         if (snprintf(str, sizeof(str), "%s%s", prefix, names.pci_path) < (int)sizeof(str))
544                                 udev_builtin_add_property(dev, test, "ID_NET_NAME_PATH", str);
545
546                 if (names.pci_slot[0])
547                         if (snprintf(str, sizeof(str), "%s%s", prefix, names.pci_slot) < (int)sizeof(str))
548                                 udev_builtin_add_property(dev, test, "ID_NET_NAME_SLOT", str);
549                 goto out;
550         }
551
552         /* USB device */
553         err = names_usb(dev, &names);
554         if (err >= 0 && names.type == NET_USB) {
555                 char str[IFNAMSIZ];
556
557                 if (names.pci_path[0])
558                         if (snprintf(str, sizeof(str), "%s%s%s", prefix, names.pci_path, names.usb_ports) < (int)sizeof(str))
559                                 udev_builtin_add_property(dev, test, "ID_NET_NAME_PATH", str);
560
561                 if (names.pci_slot[0])
562                         if (snprintf(str, sizeof(str), "%s%s%s", prefix, names.pci_slot, names.usb_ports) < (int)sizeof(str))
563                                 udev_builtin_add_property(dev, test, "ID_NET_NAME_SLOT", str);
564                 goto out;
565         }
566
567         /* Broadcom bus */
568         err = names_bcma(dev, &names);
569         if (err >= 0 && names.type == NET_BCMA) {
570                 char str[IFNAMSIZ];
571
572                 if (names.pci_path[0])
573                         if (snprintf(str, sizeof(str), "%s%s%s", prefix, names.pci_path, names.bcma_core) < (int)sizeof(str))
574                                 udev_builtin_add_property(dev, test, "ID_NET_NAME_PATH", str);
575
576                 if (names.pci_slot[0])
577                         if (snprintf(str, sizeof(str), "%s%s%s", prefix, names.pci_slot, names.bcma_core) < (int)sizeof(str))
578                                 udev_builtin_add_property(dev, test, "ID_NET_NAME_SLOT", str);
579                 goto out;
580         }
581
582         /* virtio bus */
583         err = names_virtio(dev, &names);
584         if (err >= 0 && names.type == NET_VIRTIO) {
585                 char str[IFNAMSIZ];
586
587                 if (names.pci_path[0])
588                         if (snprintf(str, sizeof(str), "%s%s%s", prefix, names.pci_path, names.virtio_core) < (int)sizeof(str))
589                                 udev_builtin_add_property(dev, test, "ID_NET_NAME_PATH", str);
590
591                 if (names.pci_slot[0])
592                         if (snprintf(str, sizeof(str), "%s%s%s", prefix, names.pci_slot, names.virtio_core) < (int)sizeof(str))
593                                 udev_builtin_add_property(dev, test, "ID_NET_NAME_SLOT", str);
594                 goto out;
595         }
596
597 out:
598         return EXIT_SUCCESS;
599 }
600
601 const struct udev_builtin udev_builtin_net_id = {
602         .name = "net_id",
603         .cmd = builtin_net_id,
604         .help = "network device properties",
605 };