Merge pull request #255 from cloudflare/ivan/pci

Add `pci_vendor`, `pci_device`, `pci_class`, `pci_subclass` decoders

.github/workflows/ci.yml

@@ -89,6 +89,11 @@ jobs:
       - name: Install libelf-dev
         run: sudo apt-get install -y libelf-dev
 
+      - name: Update pci.ids
+        run: |
+          curl -o /tmp/pci.ids https://raw.githubusercontent.com/pciutils/pciids/master/pci.ids
+          sudo mv /tmp/pci.ids /usr/share/misc/pci.ids
+
       - name: Build
         run: make build
 

README.md

@@ -555,6 +555,28 @@ you need to wrap it with `KPROBE_REGS_IP_FIX()` from `regs-ip.bpf.h`.
 With major-minor decoder you can turn kernel's combined u32 view
 of major and minor device numbers into a device name in `/dev`.
 
+### `pci_vendor`
+
+With `pci_vendor` decoder you can transform PCI vendor IDs like 0x8086
+into human readable vendor names like `Intel Corporation`.
+
+### `pci_device`
+
+With `pci_vendor` decoder you can transform PCI vendor IDs like 0x80861000
+into human readable names like `82542 Gigabit Ethernet Controller (Fiber)`.
+
+Note that the you need to concatenate vendor and device id together for this.
+
+### `pci_class`
+
+With `pci_class` decoder you can transform PCI class ID (the lowest byte) into
+the class name like `Network controller`.
+
+### `pci_subclass`
+
+With `pci_subclass` decoder you can transform PCI subclass (two lowest bytes)
+into the subclass name like `Ethernet controller`.
+
 #### `regexp`
 
 Regexp decoder takes list of strings from `regexp` configuration key

decoder/decoder.go

@@ -28,16 +28,20 @@ type Set struct {
 func NewSet() *Set {
 	return &Set{
 		decoders: map[string]Decoder{
-			"cgroup":     &CGroup{},
-			"ksym":       &KSym{},
-			"majorminor": &MajorMinor{},
-			"regexp":     &Regexp{},
-			"static_map": &StaticMap{},
-			"string":     &String{},
-			"dname":      &Dname{},
-			"uint":       &UInt{},
-			"inet_ip":    &InetIP{},
-			"syscall":    &Syscall{},
+			"cgroup":       &CGroup{},
+			"ksym":         &KSym{},
+			"majorminor":   &MajorMinor{},
+			"regexp":       &Regexp{},
+			"static_map":   &StaticMap{},
+			"string":       &String{},
+			"dname":        &Dname{},
+			"uint":         &UInt{},
+			"inet_ip":      &InetIP{},
+			"pci_vendor":   &PCIVendor{},
+			"pci_device":   &PCIDevice{},
+			"pci_class":    &PCIClass{},
+			"pci_subclass": &PCISubClass{},
+			"syscall":      &Syscall{},
 		},
 	}
 }

decoder/pci.go

@@ -0,0 +1,27 @@
+package decoder
+
+import (
+	"log"
+	"os"
+
+	"github.com/jaypipes/pcidb"
+)
+
+const pciIdsPath = "/usr/share/misc/pci.ids"
+const missingPciIdsText = "missing pci.ids db"
+
+var pci *pcidb.PCIDB
+
+func init() {
+	if _, err := os.Stat(pciIdsPath); err != nil {
+		log.Printf("PCI DB path %q is not accessible: %v", pciIdsPath, err)
+		return
+	}
+
+	db, err := pcidb.New()
+	if err != nil {
+		log.Fatalf("Error initializing PCI DB: %v", err)
+	}
+
+	pci = db
+}

decoder/pci_class.go

@@ -0,0 +1,31 @@
+package decoder
+
+import (
+	"fmt"
+	"strconv"
+
+	"github.com/cloudflare/ebpf_exporter/v2/config"
+)
+
+// PCIClass is a decoder that transforms PCI class id into a name
+type PCIClass struct{}
+
+// Decode transforms PCI class id into a name
+func (d *PCIClass) Decode(in []byte, conf config.Decoder) ([]byte, error) {
+	if pci == nil {
+		return []byte(missingPciIdsText), nil
+	}
+
+	num, err := strconv.Atoi(string(in))
+	if err != nil {
+		return nil, err
+	}
+
+	key := fmt.Sprintf("%02x", num)
+
+	if device, ok := pci.Classes[key]; ok {
+		return []byte(device.Name), nil
+	} else {
+		return []byte(fmt.Sprintf("unknown pci class: 0x%s", key)), nil
+	}
+}

decoder/pci_class_test.go

@@ -0,0 +1,82 @@
+package decoder
+
+import (
+	"bytes"
+	"testing"
+
+	"github.com/cloudflare/ebpf_exporter/v2/config"
+)
+
+func TestPCIClassDecoderMissing(t *testing.T) {
+	if pci != nil {
+		t.Skip("PCI DB is available")
+	}
+
+	cases := [][]byte{
+		[]byte("1"),
+		[]byte("2"),
+		[]byte("6"),
+	}
+
+	for _, c := range cases {
+		d := &PCIClass{}
+
+		out, err := d.Decode(c, config.Decoder{})
+		if err != nil {
+			t.Errorf("Error decoding %#v: %v", c, err)
+		}
+
+		if !bytes.Equal(out, []byte(missingPciIdsText)) {
+			t.Errorf("Expected %q, got %s", missingPciIdsText, out)
+		}
+	}
+}
+
+func TestPCIClassDecoderPresent(t *testing.T) {
+	if pci == nil {
+		t.Skip("PCI DB is not available")
+	}
+
+	cases := []struct {
+		in  []byte
+		out []byte
+	}{
+		{
+			in:  []byte("1"),
+			out: []byte("Mass storage controller"),
+		},
+		{
+			in:  []byte("2"),
+			out: []byte("Network controller"),
+		},
+		{
+			in:  []byte("3"),
+			out: []byte("Display controller"),
+		},
+		{
+			in:  []byte("6"),
+			out: []byte("Bridge"),
+		},
+		{
+			in:  []byte("12"),
+			out: []byte("Serial bus controller"),
+		},
+		{
+			in:  []byte("253"),
+			out: []byte("unknown pci class: 0xfd"),
+		},
+	}
+
+	for _, c := range cases {
+		d := &PCIClass{}
+
+		out, err := d.Decode(c.in, config.Decoder{})
+		if err != nil {
+			t.Errorf("Error decoding %#v: %v", c.in, err)
+		}
+
+		if !bytes.Equal(out, c.out) {
+			t.Errorf("Expected %q, got %q", c.out, out)
+		}
+	}
+}

decoder/pci_device.go

@@ -0,0 +1,31 @@
+package decoder
+
+import (
+	"fmt"
+	"strconv"
+
+	"github.com/cloudflare/ebpf_exporter/v2/config"
+)
+
+// PCIDevice2 is a decoder that transforms PCI device id into a name
+type PCIDevice struct{}
+
+// Decode transforms PCI device id into a name
+func (d *PCIDevice) Decode(in []byte, conf config.Decoder) ([]byte, error) {
+	if pci == nil {
+		return []byte(missingPciIdsText), nil
+	}
+
+	num, err := strconv.Atoi(string(in))
+	if err != nil {
+		return nil, err
+	}
+
+	key := fmt.Sprintf("%04x", num)
+
+	if device, ok := pci.Products[key]; ok {
+		return []byte(device.Name), nil
+	} else {
+		return []byte(fmt.Sprintf("unknown pci device: 0x%s", key)), nil
+	}
+}

decoder/pci_device_test.go

@@ -0,0 +1,86 @@
+package decoder
+
+import (
+	"bytes"
+	"testing"
+
+	"github.com/cloudflare/ebpf_exporter/v2/config"
+)
+
+func TestPCIDeviceDecoderMissing(t *testing.T) {
+	if pci != nil {
+		t.Skip("PCI DB is available")
+	}
+
+	cases := [][]byte{
+		[]byte("2156269568"), // 0x80861000
+		[]byte("268596191"),  // 0x100273df
+		[]byte("282994436"),  // 0x10de2704
+	}
+
+	for _, c := range cases {
+		d := &PCIDevice{}
+
+		out, err := d.Decode(c, config.Decoder{})
+		if err != nil {
+			t.Errorf("Error decoding %#v: %v", c, err)
+		}
+
+		if !bytes.Equal(out, []byte(missingPciIdsText)) {
+			t.Errorf("Expected %q, got %s", missingPciIdsText, out)
+		}
+	}
+}
+
+func TestPCIDeviceDecoderPresent(t *testing.T) {
+	if pci == nil {
+		t.Skip("PCI DB is not available")
+	}
+
+	cases := []struct {
+		in  []byte
+		out []byte
+	}{
+		{
+			in:  []byte("2156269568"), // 0x80861000
+			out: []byte("82542 Gigabit Ethernet Controller (Fiber)"),
+		},
+		{
+			in:  []byte("268596191"), // 0x100273df
+			out: []byte("Navi 22 [Radeon RX 6700/6700 XT/6750 XT / 6800M/6850M XT]"),
+		},
+		{
+			in:  []byte("282994436"), // 0x10de2704
+			out: []byte("AD103 [GeForce RTX 4080]"),
+		},
+		{
+			in:  []byte("364056607"), // 0x15b3101f
+			out: []byte("MT2894 Family [ConnectX-6 Lx]"),
+		},
+		{
+			in:  []byte("340633610"), // 0x144da80a
+			out: []byte("NVMe SSD Controller PM9A1/PM9A3/980PRO"),
+		},
+		{
+			in:  []byte("350492180"), // 0x14e41614
+			out: []byte("BCM57454 NetXtreme-E 10Gb/25Gb/40Gb/50Gb/100Gb Ethernet"),
+		},
+		{
+			in:  []byte("3735928559"), // 0xdeadbeef
+			out: []byte("unknown pci device: 0xdeadbeef"),
+		},
+	}
+
+	for _, c := range cases {
+		d := &PCIDevice{}
+
+		out, err := d.Decode(c.in, config.Decoder{})
+		if err != nil {
+			t.Errorf("Error decoding %#v: %v", c.in, err)
+		}
+
+		if !bytes.Equal(out, c.out) {
+			t.Errorf("Expected %q, got %q", c.out, out)
+		}
+	}
+}

decoder/pci_subclass.go

@@ -0,0 +1,38 @@
+package decoder
+
+import (
+	"fmt"
+	"strconv"
+
+	"github.com/cloudflare/ebpf_exporter/v2/config"
+)
+
+// PCISubClass is a decoder that transforms PCI class id into a name
+type PCISubClass struct{}
+
+// Decode transforms PCI class id into a name
+func (d *PCISubClass) Decode(in []byte, conf config.Decoder) ([]byte, error) {
+	if pci == nil {
+		return []byte(missingPciIdsText), nil
+	}
+
+	num, err := strconv.Atoi(string(in))
+	if err != nil {
+		return nil, err
+	}
+
+	classID := fmt.Sprintf("%02x", num>>8)
+
+	if class, ok := pci.Classes[classID]; ok {
+		subclassID := fmt.Sprintf("%02x", num&0xff)
+		for _, subclass := range class.Subclasses {
+			if subclass.ID == subclassID {
+				return []byte(subclass.Name), nil
+			}
+		}
+
+		return []byte(fmt.Sprintf("unknown pci subclass: 0x%s (class 0x%s)", subclassID, classID)), nil
+	} else {
+		return []byte(fmt.Sprintf("unknown pci class: 0x%s", classID)), nil
+	}
+}