chiark / gitweb /
hwdb: add IAB to the OUI database
[elogind.git] / src / udev / udev-builtin-net_id.c
index b6e7eee6d8f1af14ac4313e371ba0ba925ce9d4f..977545d996554dc557c714a9e4da1de203b97773 100644 (file)
 ***/
 
 /*
- * prefixes:
+ * 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:
  *   en -- ethernet
  *   wl -- wlan
  *   ww -- wwan
  *
- * types:
- *   o<index>                 -- on-board device index
- *   s<slot>f<function>       -- hotplug slot number
- *   x<MAC>                   -- MAC address
- *   p<bus>s<slot>f<function> -- PCI/physical location
+ * 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
+ *
+ * All multi-function devices will carry the [f<function>] number in the
+ * device name, including the function 0 device.
  *
- * example:
+ * examples:
  *   ID_NET_NAME_ONBOARD=eno1
- *   ID_NET_NAME_SLOT=ens1f0
+ *   ID_NET_NAME_SLOT=ens1
+ *   ID_NET_NAME_SLOT=ens2f0
+ *   ID_NET_NAME_SLOT=ens2f1
  *   ID_NET_NAME_MAC=enxf0def180d479
- *   ID_NET_NAME_PATH=enp19s0f0
+ *   ID_NET_NAME_PATH=enp0s25
+ *   ID_NET_NAME_PATH=enp19s3f0
+ *   ID_NET_NAME_PATH=enp19s3f1
  */
 
 #include <stdio.h>
 #include <unistd.h>
 #include <string.h>
 #include <errno.h>
+#include <linux/pci_regs.h>
 
 #include "udev.h"
 
 /* retrieve on-board index number and label from firmware */
-static int dev_pci_onboard(struct udev_device *dev, const char *prefix, bool test) {
+static int dev_pci_onboard(struct udev_device *dev, struct udev_device *parent, const char *prefix, bool test) {
         const char *index;
         int idx;
         const char *label;
@@ -54,10 +68,10 @@ static int dev_pci_onboard(struct udev_device *dev, const char *prefix, bool tes
         int err;
 
         /* ACPI _DSM  -- device specific method for naming a PCI or PCI Express device */
-        index = udev_device_get_sysattr_value(dev, "acpi_index");
+        index = udev_device_get_sysattr_value(parent, "acpi_index");
         /* SMBIOS type 41 -- Onboard Devices Extended Information */
         if (!index)
-                index = udev_device_get_sysattr_value(dev, "index");
+                index = udev_device_get_sysattr_value(parent, "index");
         if (!index)
                 return -ENOENT;
         idx = strtoul(index, NULL, 0);
@@ -68,7 +82,7 @@ static int dev_pci_onboard(struct udev_device *dev, const char *prefix, bool tes
         if (err < 0)
                 return err;
 
-        label = udev_device_get_sysattr_value(dev, "label");
+        label = udev_device_get_sysattr_value(parent, "label");
         if (label) {
                 err = udev_builtin_add_property(dev, test, "ID_NET_LABEL_ONBOARD", label);
                 if (err < 0)
@@ -77,7 +91,29 @@ static int dev_pci_onboard(struct udev_device *dev, const char *prefix, bool tes
         return 0;
 }
 
-static int dev_pci_slot(struct udev_device *dev, const char *prefix, bool test) {
+/* read the 256 bytes PCI configuration space to check the multi-function bit */
+static bool is_pci_singlefunction(struct udev_device *dev) {
+        char filename[256];
+        FILE *f;
+        char config[256];
+        bool single = false;
+
+        snprintf(filename, sizeof(filename), "%s/config", udev_device_get_syspath(dev));
+        f = fopen(filename, "re");
+        if (!f)
+                goto out;
+        if (fread(&config, sizeof(config), 1, f) != 1)
+                goto out;
+
+        /* bit 0-6 header type, bit 7 multi/single function device */
+        if ((config[PCI_HEADER_TYPE] & 0x80) == 0)
+                single = true;
+out:
+        fclose(f);
+        return single;
+}
+
+static int dev_pci_slot(struct udev_device *dev, struct udev_device *parent, const char *prefix, bool test) {
         struct udev *udev = udev_device_get_udev(dev);
         unsigned int bus;
         unsigned int slot;
@@ -91,9 +127,12 @@ static int dev_pci_slot(struct udev_device *dev, const char *prefix, bool test)
         int err = 0;
 
         /* compose a name based on the raw kernel's PCI bus, slot numbers */
-        if (sscanf(udev_device_get_sysname(dev), "0000:%x:%x.%d", &bus, &slot, &func) != 3)
+        if (sscanf(udev_device_get_sysname(parent), "0000:%x:%x.%d", &bus, &slot, &func) != 3)
                 return -ENOENT;
-        snprintf(str, sizeof(str), "%sp%ds%df%d", prefix, bus, slot, func);
+        if (func == 0 && is_pci_singlefunction(parent))
+                snprintf(str, sizeof(str), "%sp%ds%d", prefix, bus, slot);
+        else
+                snprintf(str, sizeof(str), "%sp%ds%df%d", prefix, bus, slot, func);
         err = udev_builtin_add_property(dev, test, "ID_NET_NAME_PATH", str);
         if (err < 0)
                 return err;
@@ -126,7 +165,7 @@ static int dev_pci_slot(struct udev_device *dev, const char *prefix, bool test)
                 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(dev), strlen(address)) == 0)
+                        if (strncmp(address, udev_device_get_sysname(parent), strlen(address)) == 0)
                                 hotplug_slot = i;
                         free(address);
                 }
@@ -137,7 +176,10 @@ static int dev_pci_slot(struct udev_device *dev, const char *prefix, bool test)
         closedir(dir);
 
         if (hotplug_slot > 0) {
-                snprintf(str, sizeof(str), "%ss%df%d", prefix, hotplug_slot, func);
+                if (func == 0 && is_pci_singlefunction(parent))
+                        snprintf(str, sizeof(str), "%ss%d", prefix, hotplug_slot);
+                else
+                        snprintf(str, sizeof(str), "%ss%df%d", prefix, hotplug_slot, func);
                 err = udev_builtin_add_property(dev, test, "ID_NET_NAME_SLOT", str);
         }
 out:
@@ -146,15 +188,15 @@ out:
 }
 
 static int dev_pci(struct udev_device *dev, const char *prefix, bool test) {
-        struct udev_device *d;
+        struct udev_device *parent;
 
         /* skip other buses than direct PCI parents */
-        d = udev_device_get_parent(dev);
-        if (!d || !streq("pci", udev_device_get_subsystem(d)))
+        parent = udev_device_get_parent(dev);
+        if (!parent || !streq("pci", udev_device_get_subsystem(parent)))
                 return -ENOENT;
 
-        dev_pci_onboard(d, prefix, test);
-        dev_pci_slot(d, prefix, test);
+        dev_pci_onboard(dev, parent, prefix, test);
+        dev_pci_slot(dev, parent, prefix, test);
         return 0;
 }
 
@@ -182,11 +224,16 @@ static int dev_mac(struct udev_device *dev, const char *prefix, bool test) {
         if (a1 + a2 + a3 + a4 + a5 + a6 == 0)
                 return -EINVAL;
 
-        /* add IEEE Organizationally Unique Identifier */
-        snprintf(str, sizeof(str), "OUI:%X%X%X", a1, a2, a3);
-        udev_builtin_hwdb_lookup(dev, str, test);
+        /*
+         * IEEE Organizationally Unique Identifier vendor string
+         * skip commonly misused 00:00:00 (Xerox) prefix
+         */
+        if (a1 + a2 + a3 > 0) {
+                snprintf(str, sizeof(str), "OUI:%02X%02X%02X%02X%02X%02X", a1, a2, a3, a4, a5, a6);
+                udev_builtin_hwdb_lookup(dev, str, test);
+        }
 
-        snprintf(str, sizeof(str), "%sx%x%x%x%x%x%x", prefix, a1, a2, a3, a4, a5, a6);
+        snprintf(str, sizeof(str), "%sx%02x%02x%02x%02x%02x%02x", prefix, a1, a2, a3, a4, a5, a6);
         return udev_builtin_add_property(dev, test, "ID_NET_NAME_MAC", str);
 }