chiark / gitweb /
Use initalization instead of explicit zeroing
[elogind.git] / src / udev / udev-builtin-net_id.c
index 94fefc5f9d961bd67c9cd61c2b991512d59e490c..5719021e93bca5f0e6fe40e929b22880e3a743fc 100644 (file)
 ***/
 
 /*
- * predictable network interface device names based on:
+ * Predictable network interface device names based on:
  *  - firmware/bios-provided index numbers for on-board devices
  *  - firmware-provided pci-express hotplug slot index number
  *  - physical/geographical location of the hardware
  *  - the interface's MAC address
  *
- * two character prefixes based on the type of interface:
+ * http://www.freedesktop.org/wiki/Software/systemd/PredictableNetworkInterfaceNames
+ *
+ * Two character prefixes based on the type of interface:
  *   en -- ethernet
  *   wl -- wlan
  *   ww -- wwan
  *
- * type of names:
- *   o<index>                   -- on-board device index number
- *   s<slot>[f<function>]       -- hotplug slot index number
- *   x<MAC>                     -- MAC address
- *   p<bus>s<slot>[f<function>] -- PCI geographical location
+ * Type of names:
+ *   o<index>                              -- on-board device index number
+ *   s<slot>[f<function>][d<dev_id>]       -- hotplug slot index number
+ *   x<MAC>                                -- MAC address
+ *   p<bus>s<slot>[f<function>][d<dev_id>] -- PCI geographical location
+ *   p<bus>s<slot>[f<function>][u<port>][..][c<config>][i<interface>]
+ *                                         -- USB port number chain
  *
- * All multi-function devices will carry the [f<function>] number in the
+ * All multi-function PCI devices will carry the [f<function>] number in the
  * device name, including the function 0 device.
  *
- * examples:
+ * For USB devices the full chain of port numbers of hubs is composed. If the
+ * name gets longer than the maximum number of 15 characters, the name is not
+ * exported.
+ * The usual USB configuration == 1 and interface == 0 values are suppressed.
+ *
+ * PCI ethernet card with firmware index "1":
  *   ID_NET_NAME_ONBOARD=eno1
+ *   ID_NET_NAME_ONBOARD_LABEL=Ethernet Port 1
+ *
+ * PCI ethernet card in hotplug slot with firmware index number:
+ *   /sys/devices/pci0000:00/0000:00:1c.3/0000:05:00.0/net/ens1
+ *   ID_NET_NAME_MAC=enx000000000466
+ *   ID_NET_NAME_PATH=enp5s0
  *   ID_NET_NAME_SLOT=ens1
- *   ID_NET_NAME_SLOT=ens2f0
- *   ID_NET_NAME_SLOT=ens2f1
- *   ID_NET_NAME_MAC=enxf0def180d479
- *   ID_NET_NAME_PATH=enp0s25
- *   ID_NET_NAME_PATH=enp19s3f0
- *   ID_NET_NAME_PATH=enp19s3f1
+ *
+ * PCI ethernet multi-function card with 2 ports:
+ *   /sys/devices/pci0000:00/0000:00:1c.0/0000:02:00.0/net/enp2s0f0
+ *   ID_NET_NAME_MAC=enx78e7d1ea46da
+ *   ID_NET_NAME_PATH=enp2s0f0
+ *   /sys/devices/pci0000:00/0000:00:1c.0/0000:02:00.1/net/enp2s0f1
+ *   ID_NET_NAME_MAC=enx78e7d1ea46dc
+ *   ID_NET_NAME_PATH=enp2s0f1
+ *
+ * PCI wlan card:
+ *   /sys/devices/pci0000:00/0000:00:1c.1/0000:03:00.0/net/wlp3s0
+ *   ID_NET_NAME_MAC=wlx0024d7e31130
+ *   ID_NET_NAME_PATH=wlp3s0
+ *
+ * USB built-in 3G modem:
+ *   /sys/devices/pci0000:00/0000:00:1d.0/usb2/2-1/2-1.4/2-1.4:1.6/net/wwp0s29u1u4i6
+ *   ID_NET_NAME_MAC=wwx028037ec0200
+ *   ID_NET_NAME_PATH=wwp0s29u1u4i6
+ *
+ * USB Android phone:
+ *   /sys/devices/pci0000:00/0000:00:1d.0/usb2/2-1/2-1.2/2-1.2:1.0/net/enp0s29u1u2
+ *   ID_NET_NAME_MAC=enxd626b3450fb5
+ *   ID_NET_NAME_PATH=enp0s29u1u2
  */
 
 #include <stdio.h>
 #include <linux/pci_regs.h>
 
 #include "udev.h"
+#include "fileio.h"
 
 enum netname_type{
         NET_UNDEF,
         NET_PCI,
         NET_USB,
+        NET_BCMA,
 };
 
 struct netnames {
@@ -78,8 +112,9 @@ struct netnames {
         char pci_onboard[IFNAMSIZ];
         const char *pci_onboard_label;
 
-        struct udev_device *usbdev;
         char usb_ports[IFNAMSIZ];
+
+        char bcma_core[IFNAMSIZ];
 };
 
 /* retrieve on-board index number and label from firmware */
@@ -104,11 +139,11 @@ static int dev_pci_onboard(struct udev_device *dev, struct netnames *names) {
 }
 
 /* read the 256 bytes PCI configuration space to check the multi-function bit */
-static bool is_pci_singlefunction(struct udev_device *dev) {
+static bool is_pci_multifunction(struct udev_device *dev) {
         char filename[256];
-        FILE *f;
+        FILE *f = NULL;
         char config[64];
-        bool single = false;
+        bool multi = false;
 
         snprintf(filename, sizeof(filename), "%s/config", udev_device_get_syspath(dev));
         f = fopen(filename, "re");
@@ -118,11 +153,12 @@ static bool is_pci_singlefunction(struct udev_device *dev) {
                 goto out;
 
         /* bit 0-6 header type, bit 7 multi/single function device */
-        if ((config[PCI_HEADER_TYPE] & 0x80) == 0)
-                single = true;
+        if ((config[PCI_HEADER_TYPE] & 0x80) != 0)
+                multi = true;
 out:
-        fclose(f);
-        return single;
+        if(f)
+                fclose(f);
+        return multi;
 }
 
 static int dev_pci_slot(struct udev_device *dev, struct netnames *names) {
@@ -130,6 +166,10 @@ static int dev_pci_slot(struct udev_device *dev, struct netnames *names) {
         unsigned int bus;
         unsigned int slot;
         unsigned int func;
+        unsigned int dev_id = 0;
+        size_t l;
+        char *s;
+        const char *attr;
         struct udev_device *pci = NULL;
         char slots[256];
         DIR *dir;
@@ -138,13 +178,23 @@ static int dev_pci_slot(struct udev_device *dev, struct netnames *names) {
         int hotplug_slot = 0;
         int err = 0;
 
-        /* compose a name based on the raw kernel's PCI bus, slot numbers */
         if (sscanf(udev_device_get_sysname(names->pcidev), "0000:%x:%x.%d", &bus, &slot, &func) != 3)
                 return -ENOENT;
-        if (func == 0 && is_pci_singlefunction(names->pcidev))
-                snprintf(names->pci_path, sizeof(names->pci_path), "p%ds%d", bus, slot);
-        else
-                snprintf(names->pci_path, sizeof(names->pci_path), "p%ds%df%d", bus, slot, func);
+
+        /* kernel provided multi-device index */
+        attr = udev_device_get_sysattr_value(dev, "dev_id");
+        if (attr)
+                dev_id = strtol(attr, NULL, 16);
+
+        /* compose a name based on the raw kernel's PCI bus, slot numbers */
+        s = names->pci_path;
+        l = strpcpyf(&s, sizeof(names->pci_path), "p%ds%d", bus, slot);
+        if (func > 0 || is_pci_multifunction(names->pcidev))
+                l = strpcpyf(&s, l, "f%d", func);
+        if (dev_id > 0)
+                l = strpcpyf(&s, l, "d%d", dev_id);
+        if (l == 0)
+                names->pci_path[0] = '\0';
 
         /* ACPI _SUN  -- slot user number */
         pci = udev_device_new_from_subsystem_sysname(udev, "subsystem", "pci");
@@ -174,7 +224,7 @@ static int dev_pci_slot(struct udev_device *dev, struct netnames *names) {
                 snprintf(str, sizeof(str), "%s/%s/address", slots, dent->d_name);
                 if (read_one_line_file(str, &address) >= 0) {
                         /* match slot address with device by stripping the function */
-                        if (strncmp(address, udev_device_get_sysname(names->pcidev), strlen(address)) == 0)
+                        if (strneq(address, udev_device_get_sysname(names->pcidev), strlen(address)))
                                 hotplug_slot = i;
                         free(address);
                 }
@@ -185,10 +235,14 @@ static int dev_pci_slot(struct udev_device *dev, struct netnames *names) {
         closedir(dir);
 
         if (hotplug_slot > 0) {
-                if (func == 0 && is_pci_singlefunction(names->pcidev))
-                        snprintf(names->pci_slot, sizeof(names->pci_slot), "s%d", hotplug_slot);
-                else
-                        snprintf(names->pci_slot, sizeof(names->pci_slot), "s%df%d", hotplug_slot, func);
+                s = names->pci_slot;
+                l = strpcpyf(&s, sizeof(names->pci_slot), "s%d", hotplug_slot);
+                if (func > 0 || is_pci_multifunction(names->pcidev))
+                        l = strpcpyf(&s, l, "f%d", func);
+                if (dev_id > 0)
+                        l = strpcpyf(&s, l, "d%d", dev_id);
+                if (l == 0)
+                        names->pci_path[0] = '\0';
         }
 out:
         udev_device_unref(pci);
@@ -202,7 +256,7 @@ static int names_pci(struct udev_device *dev, struct netnames *names) {
         if (!parent)
                 return -ENOENT;
         /* check if our direct parent is a PCI device with no other bus in-between */
-        if (streq("pci", udev_device_get_subsystem(parent))) {
+        if (streq_ptr("pci", udev_device_get_subsystem(parent))) {
                 names->type = NET_PCI;
                 names->pcidev = parent;
         } else {
@@ -216,6 +270,7 @@ static int names_pci(struct udev_device *dev, struct netnames *names) {
 }
 
 static int names_usb(struct udev_device *dev, struct netnames *names) {
+        struct udev_device *usbdev;
         char name[256];
         char *ports;
         char *config;
@@ -223,12 +278,12 @@ static int names_usb(struct udev_device *dev, struct netnames *names) {
         size_t l;
         char *s;
 
-        names->usbdev = udev_device_get_parent_with_subsystem_devtype(dev, "usb", "usb_interface");
-        if (!names->usbdev)
+        usbdev = udev_device_get_parent_with_subsystem_devtype(dev, "usb", "usb_interface");
+        if (!usbdev)
                 return -ENOENT;
 
         /* get USB port number chain, configuration, interface */
-        util_strscpy(name, sizeof(name), udev_device_get_sysname(names->usbdev));
+        strscpy(name, sizeof(name), udev_device_get_sysname(usbdev));
         s = strchr(name, '-');
         if (!s)
                 return -EINVAL;
@@ -251,15 +306,15 @@ static int names_usb(struct udev_device *dev, struct netnames *names) {
         while ((s = strchr(s, '.')))
                 s[0] = 'u';
         s = names->usb_ports;
-        l = util_strpcpyl(&s, sizeof(names->usb_ports), "u", ports, NULL);
+        l = strpcpyl(&s, sizeof(names->usb_ports), "u", ports, NULL);
 
         /* append USB config number, suppress the common config == 1 */
         if (!streq(config, "1"))
-                l = util_strpcpyl(&s, sizeof(names->usb_ports), "c", config, NULL);
+                l = strpcpyl(&s, sizeof(names->usb_ports), "c", config, NULL);
 
         /* append USB interface number, suppress the interface == 0 */
         if (!streq(interf, "0"))
-                l = util_strpcpyl(&s, sizeof(names->usb_ports), "i", interf, NULL);
+                l = strpcpyl(&s, sizeof(names->usb_ports), "i", interf, NULL);
         if (l == 0)
                 return -ENAMETOOLONG;
 
@@ -267,6 +322,25 @@ static int names_usb(struct udev_device *dev, struct netnames *names) {
         return 0;
 }
 
+static int names_bcma(struct udev_device *dev, struct netnames *names) {
+        struct udev_device *bcmadev;
+        unsigned int core;
+
+        bcmadev = udev_device_get_parent_with_subsystem_devtype(dev, "bcma", NULL);
+        if (!bcmadev)
+                return -ENOENT;
+
+        /* bus num:core num */
+        if (sscanf(udev_device_get_sysname(bcmadev), "bcma%*d:%d", &core) != 1)
+                return -EINVAL;
+        /* suppress the common core == 0 */
+        if (core > 0)
+                snprintf(names->bcma_core, sizeof(names->bcma_core), "b%d", core);
+
+        names->type = NET_BCMA;
+        return 0;
+}
+
 static int names_mac(struct udev_device *dev, struct netnames *names) {
         const char *s;
         unsigned int i;
@@ -302,9 +376,9 @@ static int names_mac(struct udev_device *dev, struct netnames *names) {
 
 /* IEEE Organizationally Unique Identifier vendor string */
 static int ieee_oui(struct udev_device *dev, struct netnames *names, bool test) {
-        char str[IFNAMSIZ];
+        char str[32];
 
-        if (names->mac_valid)
+        if (!names->mac_valid)
                 return -ENOENT;
         /* skip commonly misused 00:00:00 (Xerox) prefix */
         if (memcmp(names->mac, "\0\0\0", 3) == 0)
@@ -318,10 +392,11 @@ static int ieee_oui(struct udev_device *dev, struct netnames *names, bool test)
 
 static int builtin_net_id(struct udev_device *dev, int argc, char *argv[], bool test) {
         const char *s;
+        const char *p;
         unsigned int i;
         const char *devtype;
         const char *prefix = "en";
-        struct netnames names;
+        struct netnames names = {};
         int err;
 
         /* handle only ARPHRD_ETHER devices */
@@ -332,6 +407,16 @@ static int builtin_net_id(struct udev_device *dev, int argc, char *argv[], bool
         if (i != 1)
                 return 0;
 
+        /* skip stacked devices, like VLANs, ... */
+        s = udev_device_get_sysattr_value(dev, "ifindex");
+        if (!s)
+                return EXIT_FAILURE;
+        p = udev_device_get_sysattr_value(dev, "iflink");
+        if (!p)
+                return EXIT_FAILURE;
+        if (!streq(s, p))
+                return 0;
+
         devtype = udev_device_get_devtype(dev);
         if (devtype) {
                 if (streq("wlan", devtype))
@@ -340,7 +425,6 @@ static int builtin_net_id(struct udev_device *dev, int argc, char *argv[], bool
                         prefix = "ww";
         }
 
-        zero(names);
         err = names_mac(dev, &names);
         if (err >= 0 && names.mac_valid) {
                 char str[IFNAMSIZ];
@@ -392,7 +476,24 @@ static int builtin_net_id(struct udev_device *dev, int argc, char *argv[], bool
                 if (names.pci_slot[0])
                         if (snprintf(str, sizeof(str), "%s%s%s", prefix, names.pci_slot, names.usb_ports) < (int)sizeof(str))
                                 udev_builtin_add_property(dev, test, "ID_NET_NAME_SLOT", str);
+                goto out;
         }
+
+        /* Broadcom bus */
+        err = names_bcma(dev, &names);
+        if (err >= 0 && names.type == NET_BCMA) {
+                char str[IFNAMSIZ];
+
+                if (names.pci_path[0])
+                        if (snprintf(str, sizeof(str), "%s%s%s", prefix, names.pci_path, names.bcma_core) < (int)sizeof(str))
+                                udev_builtin_add_property(dev, test, "ID_NET_NAME_PATH", str);
+
+                if (names.pci_slot[0])
+                        if (snprintf(str, sizeof(str), "%s%s%s", prefix, names.pci_slot, names.bcma_core) < (int)sizeof(str))
+                                udev_builtin_add_property(dev, test, "ID_NET_NAME_SLOT", str);
+                goto out;
+        }
+
 out:
         return EXIT_SUCCESS;
 }