expose SRIOV information by ffromani · Pull Request #230 · jaypipes/ghw

ffromani · 2021-02-24T11:58:04Z

Expose informations about SRIOV devices. After some design iterations, we fixed these goals:

model SRIOV devices like GPUs, so with a top-level package.
to shape the API, we start checking what the k8s SRIOV operator needs
to further refine later, we will check what other projects like the k8s node feature discovery consume
the goal is to enable such projects to switch to ghw if/when they want.

There are few more noteworthy items in this PR:

due to lack of resources, initial support is for linux only. Nothing linux-specific should have sneaked in the API. Should the current API design make unnecessarily hard to add support on other platforms (e.g. windows) this should be treated as bug
the code prefers Physical Functions for discovery, but we acknowledge that forcing consumers to traverse the physical functions to learn about virtual functions is awkward, so the API provides shallow references to the Virtual Functions for the sake of practicality.

Fixes: #92

Signed-off-by: Francesco Romani fromani@redhat.com

ffromani · 2021-02-24T11:58:35Z

Example output, PF device:

lssriov is the same code shown in the example added to the README (see)

./lssriov 0000:05:00.0 | jq
{
  "driver": "igb",
  "interfaces": [
    "enp5s0f0"
  ],
  "physfn": {
    "max_vf_num": 7,
    "vfs": [
      {
        "id": 0,
        "pci_address": "0000:05:10.0"
      },
      {
        "id": 1,
        "pci_address": "0000:05:10.4"
      },
      {
        "id": 2,
        "pci_address": "0000:05:11.0"
      },
      {
        "id": 3,
        "pci_address": "0000:05:11.4"
      }
    ]
  }
}

ffromani · 2021-02-24T11:58:58Z

Example output, VF device:

lssriov is the same code shown in the example added to the README (see)

/lssriov 0000:05:10.0 | jq
{
  "driver": "igbvf",
  "interfaces": [
    "enp5s0f0v0"
  ],
  "virtfn": {
    "parent_pci_address": "0000:05:00.0"
  }
}

ffromani · 2021-02-25T08:01:34Z

README.md

+*This API is PROVISIONAL! ghw will try hard to not make breaking changes to this API, but still users are advice this new API is not
+declared stable yet. We expect to declare it stable with ghw version 1.0.0*
+
+SRIOV (Single-Root Input/Output Virtualization) is a class of PCI devices that ghw treats explicitely, like gpus; but unlike


s/treats/handles/

ffromani · 2021-03-17T12:49:23Z

We are converging about which information we should expose about SRIOV devices. The current set of attributes represents what other established components, for example the k8s SRIOV operator exposes . Please note that in case of ghw, the same amount of data is split between the pci, net package and this new SRIOV addition. I think this is a fair enough representation which expands nicely the current layout of ghw packages, and provides a convenient enough API.
Of course, reviews and feedback are welcome to futher improve and to fill any gaps that may have escaped investigation up until now.

The biggest problem however is how to represent the SRIOV devices proper.
At best of knowledge, all the SRIOV devices are also pci devices. Is not possible, in the foreseeable feature, to have SRIOV devices which aren't also PCI devices. This seems to suggest a is-a relationship between SRIOV and PCI.
So should SRIOV devices be presented as subclasses of PCI devices?

Should SRIOV be a subpackage of the pci package (like in the current PR?)
Or should SRIOV be independent, same-level package, mimicing the relationship we currently have between gpu and pci packages?

ffromani · 2021-03-18T14:47:36Z

We are converging about which information we should expose about SRIOV devices. The current set of attributes represents what other established components, for example the k8s SRIOV operator exposes . Please note that in case of ghw, the same amount of data is split between the pci, net package and this new SRIOV addition. I think this is a fair enough representation which expands nicely the current layout of ghw packages, and provides a convenient enough API.
Of course, reviews and feedback are welcome to futher improve and to fill any gaps that may have escaped investigation up until now.

The biggest problem however is how to represent the SRIOV devices proper.
At best of knowledge, all the SRIOV devices are also pci devices. Is not possible, in the foreseeable feature, to have SRIOV devices which aren't also PCI devices. This seems to suggest a is-a relationship between SRIOV and PCI.
So should SRIOV devices be presented as subclasses of PCI devices?

Should SRIOV be a subpackage of the pci package (like in the current PR?)
Or should SRIOV be independent, same-level package, mimicing the relationship we currently have between gpu and pci packages?

Had a chat with @jaypipes and the my takeaways are:

we agreed about modeling SRIOV devices like GPUs, so with a top-level package.
we agreed that the k8s SRIOV operator is a good testbed for this API - if this new API (+ other enhancemenets we did/are doing in ghw) is enough to fill their use case, our API is good enough.
we will watch the k8s node feature discovery them and, if possible and convenient, enable them to consume ghw instead of writing their own code.

ffromani · 2021-03-30T08:09:19Z

ok, test failure is unexpected. I'll have a look ASAP.

ffromani · 2021-03-30T17:01:03Z

ok, test failure is unexpected. I'll have a look ASAP.

weird, can't reproduce inside a xenial container:

FROM ubuntu:xenial

RUN apt update
RUN apt install -y curl git make gcc

RUN curl -sL -o /usr/local/bin/gimme https://raw.githubusercontent.com/travis-ci/gimme/master/gimme && chmod 0755 /usr/local/bin/gimme
RUN gimme 1.16

WORKDIR /go/src/github.com/jaypipes/ghw

# Force the go compiler to use modules.
ENV GO111MODULE=on
ENV GOPROXY=direct

# go.mod and go.sum go into their own layers.
COPY go.mod .
COPY go.sum .

COPY . .

CMD /bin/bash

ffromani · 2021-03-30T17:07:39Z

same with go1.14.15 (yep, copypasta here #230 (comment))

ffromani · 2021-03-31T06:50:02Z

Interesting. We had apparently-random CI failures on xenial only.
I added multiple tests consuming the pci package, and the second/third (can't pinpoint further) was always failing regardless of the order of the tests. The code looks innocent and the stacktrace run deep into the pcidb package. This change seems to fix everything

	// debug CI failures on travis on xenial
	if err := os.Setenv("PCIDB_DISABLE_NETWORK_FETCH", "1"); err != nil {
		t.Fatalf("Canoot set PCIDB_DISABLE_NETWORK_FETCH")
	}

Now I wonder if the default behaviour of pcidb should be reversed: leave network alone unless explicitely requested. @jaypipes any thoughts? worth a issue on the pcidb project for further discussion?

Should the pcidb pkg fail to find a local pci database, it optionally fetches an updated copy from the network. Even though this is unlikely to happen, and even though this is a nice feature to have, this is enabled by default and can lead to hard-to-debug issues. we seen this first with failing CI on xenial in travis (jaypipes#230 (comment)) It's possible the ultimate cause is out of date test VM, or any CI failure; but it is also true this a symptom of a deeper issue: test environments should be tightly controlled in order to be reproducible. Fetching data from the network, even though from a safe and trusted location, voids this assumption. So we need to force this off in the test path. Unfortunately this patch has its own drawback: it changes the pcidb default behaviour, so test code and production code have different preferred code paths. To really fix this behaviour completely we should probably file a pcidb issue (+ PR) to change its defaults. Signed-off-by: Francesco Romani <fromani@redhat.com>

ffromani · 2021-04-07T16:03:30Z

Interesting. We had apparently-random CI failures on xenial only.
I added multiple tests consuming the pci package, and the second/third (can't pinpoint further) was always failing regardless of the order of the tests. The code looks innocent and the stacktrace run deep into the pcidb package. This change seems to fix everything
	// debug CI failures on travis on xenial
	if err := os.Setenv("PCIDB_DISABLE_NETWORK_FETCH", "1"); err != nil {
		t.Fatalf("Canoot set PCIDB_DISABLE_NETWORK_FETCH")
	}
Now I wonder if the default behaviour of pcidb should be reversed: leave network alone unless explicitely requested. @jaypipes any thoughts? worth a issue on the pcidb project for further discussion?

Well this still have some merits, turns out it was in turn a symptom. The real issue -with is fix- is captured in 62a092d

ffromani · 2021-05-13T06:52:59Z

depends on #247 - intentionally NOT fixing the conflict to reflect we should not move forward until we discuss #247

ffromani · 2021-09-29T16:09:41Z

back to WIP: need to finish the rebase, and I'd like to land also #281 before to finish this PR.

ffromani · 2021-11-04T14:39:53Z

All the deps of this PR have been merged! removing the WIP status
...but we had some bitrot. I'll take care ASAP.

ffromani · 2021-11-23T10:25:59Z

@jaypipes at last! all the dependencies of this PR have been merged, CI is green and it's ready for a new review round!

ffromani · 2021-11-23T10:26:20Z

Fixes: #92

ffromani · 2021-11-23T10:32:10Z

Example output (long):

# ./ghwc -h

          __
 .-----. |  |--. .--.--.--.
 |  _  | |     | |  |  |  |
 |___  | |__|__| |________|
 |_____|

Discover hardware information.

https://github.com/jaypipes/ghw

Usage:
  ghwc [flags]
  ghwc [command]

Available Commands:
  baseboard   Show baseboard information for the host system
  bios        Show BIOS information for the host system
  block       Show block storage information for the host system
  chassis     Show chassis information for the host system
  cpu         Show CPU information for the host system
  gpu         Show graphics/GPU information for the host system
  help        Help about any command
  memory      Show memory information for the host system
  net         Show network information for the host system
  pci         Show information about PCI devices on the host system
  product     Show product information for the host system
  sriov       Show SRIOV devices information for the host system
  topology    Show topology information for the host system
  version     Display the version of gofile

Flags:
      --debug           Enable or disable debug mode
  -f, --format string   Output format.
                        Choices are 'json','yaml', and 'human'. (default "human")
  -h, --help            help for ghwc
      --pretty          When outputting JSON, use indentation

Use "ghwc [command] --help" for more information about a command.

# ./ghwc sriov
sriov (2 phsyical 8 virtual devices)
 physical function  [affined to NUMA node 0]@0000:05:00.0 -> driver: 'igb' class: 'Network controller' vendor: 'Intel Corporation' product: 'I350 Gigabit Network Connection' with 4/7 virtual functions
 physical function  [affined to NUMA node 1]@0000:05:00.1 -> driver: 'igb' class: 'Network controller' vendor: 'Intel Corporation' product: 'I350 Gigabit Network Connection' with 4/7 virtual functions

# ./ghwc sriov -f yaml
sriov:
  physical_functions:
  - address:
      Bus: "05"
      Device: "00"
      Domain: "0000"
      Function: "0"
    interfaces:
    - enp5s0f0
    max_vf_num: 7
    pci:
      address: "0000:05:00.0"
      class:
        id: "02"
        name: Network controller
      driver: igb
      product:
        id: "1521"
        name: I350 Gigabit Network Connection
      programming_interface:
        id: "00"
        name: unknown
      revision: "0x01"
      subclass:
        id: "00"
        name: Ethernet controller
      subsystem:
        id: "0000"
        name: AOC-SGP-i4
      vendor:
        id: "8086"
        name: Intel Corporation
    vfs:
    - address:
        Bus: "05"
        Device: "10"
        Domain: "0000"
        Function: "0"
      id: 0
      interfaces:
      - enp5s0f0v0
      parent_address:
        Bus: "05"
        Device: "00"
        Domain: "0000"
        Function: "0"
      pci:
        address: "0000:05:10.0"
        class:
          id: "02"
          name: Network controller
        driver: igbvf
        product:
          id: "1520"
          name: I350 Ethernet Controller Virtual Function
        programming_interface:
          id: "00"
          name: unknown
        revision: "0x01"
        subclass:
          id: "00"
          name: Ethernet controller
        subsystem:
          id: "0000"
          name: unknown
        vendor:
          id: "8086"
          name: Intel Corporation
    - address:
        Bus: "05"
        Device: "10"
        Domain: "0000"
        Function: "4"
      id: 1
      interfaces:
      - enp5s0f0v1
      parent_address:
        Bus: "05"
        Device: "00"
        Domain: "0000"
        Function: "0"
      pci:
        address: "0000:05:10.4"
        class:
          id: "02"
          name: Network controller
        driver: igbvf
        product:
          id: "1520"
          name: I350 Ethernet Controller Virtual Function
        programming_interface:
          id: "00"
          name: unknown
        revision: "0x01"
        subclass:
          id: "00"
          name: Ethernet controller
        subsystem:
          id: "0000"
          name: unknown
        vendor:
          id: "8086"
          name: Intel Corporation
    - address:
        Bus: "05"
        Device: "11"
        Domain: "0000"
        Function: "0"
      id: 2
      interfaces:
      - enp5s0f0v2
      parent_address:
        Bus: "05"
        Device: "00"
        Domain: "0000"
        Function: "0"
      pci:
        address: "0000:05:11.0"
        class:
          id: "02"
          name: Network controller
        driver: igbvf
        product:
          id: "1520"
          name: I350 Ethernet Controller Virtual Function
        programming_interface:
          id: "00"
          name: unknown
        revision: "0x01"
        subclass:
          id: "00"
          name: Ethernet controller
        subsystem:
          id: "0000"
          name: unknown
        vendor:
          id: "8086"
          name: Intel Corporation
    - address:
        Bus: "05"
        Device: "11"
        Domain: "0000"
        Function: "4"
      id: 3
      interfaces:
      - enp5s0f0v3
      parent_address:
        Bus: "05"
        Device: "00"
        Domain: "0000"
        Function: "0"
      pci:
        address: "0000:05:11.4"
        class:
          id: "02"
          name: Network controller
        driver: igbvf
        product:
          id: "1520"
          name: I350 Ethernet Controller Virtual Function
        programming_interface:
          id: "00"
          name: unknown
        revision: "0x01"
        subclass:
          id: "00"
          name: Ethernet controller
        subsystem:
          id: "0000"
          name: unknown
        vendor:
          id: "8086"
          name: Intel Corporation
  - address:
      Bus: "05"
      Device: "00"
      Domain: "0000"
      Function: "1"
    interfaces:
    - enp5s0f1
    max_vf_num: 7
    pci:
      address: "0000:05:00.1"
      class:
        id: "02"
        name: Network controller
      driver: igb
      product:
        id: "1521"
        name: I350 Gigabit Network Connection
      programming_interface:
        id: "00"
        name: unknown
      revision: "0x01"
      subclass:
        id: "00"
        name: Ethernet controller
      subsystem:
        id: "0000"
        name: AOC-SGP-i4
      vendor:
        id: "8086"
        name: Intel Corporation
    vfs:
    - address:
        Bus: "05"
        Device: "10"
        Domain: "0000"
        Function: "1"
      id: 0
      interfaces:
      - enp5s0f1v0
      parent_address:
        Bus: "05"
        Device: "00"
        Domain: "0000"
        Function: "1"
      pci:
        address: "0000:05:10.1"
        class:
          id: "02"
          name: Network controller
        driver: igbvf
        product:
          id: "1520"
          name: I350 Ethernet Controller Virtual Function
        programming_interface:
          id: "00"
          name: unknown
        revision: "0x01"
        subclass:
          id: "00"
          name: Ethernet controller
        subsystem:
          id: "0000"
          name: unknown
        vendor:
          id: "8086"
          name: Intel Corporation
    - address:
        Bus: "05"
        Device: "10"
        Domain: "0000"
        Function: "5"
      id: 1
      interfaces:
      - enp5s0f1v1
      parent_address:
        Bus: "05"
        Device: "00"
        Domain: "0000"
        Function: "1"
      pci:
        address: "0000:05:10.5"
        class:
          id: "02"
          name: Network controller
        driver: igbvf
        product:
          id: "1520"
          name: I350 Ethernet Controller Virtual Function
        programming_interface:
          id: "00"
          name: unknown
        revision: "0x01"
        subclass:
          id: "00"
          name: Ethernet controller
        subsystem:
          id: "0000"
          name: unknown
        vendor:
          id: "8086"
          name: Intel Corporation
    - address:
        Bus: "05"
        Device: "11"
        Domain: "0000"
        Function: "1"
      id: 2
      interfaces:
      - enp5s0f1v2
      parent_address:
        Bus: "05"
        Device: "00"
        Domain: "0000"
        Function: "1"
      pci:
        address: "0000:05:11.1"
        class:
          id: "02"
          name: Network controller
        driver: igbvf
        product:
          id: "1520"
          name: I350 Ethernet Controller Virtual Function
        programming_interface:
          id: "00"
          name: unknown
        revision: "0x01"
        subclass:
          id: "00"
          name: Ethernet controller
        subsystem:
          id: "0000"
          name: unknown
        vendor:
          id: "8086"
          name: Intel Corporation
    - address:
        Bus: "05"
        Device: "11"
        Domain: "0000"
        Function: "5"
      id: 3
      interfaces:
      - enp5s0f1v3
      parent_address:
        Bus: "05"
        Device: "00"
        Domain: "0000"
        Function: "1"
      pci:
        address: "0000:05:11.5"
        class:
          id: "02"
          name: Network controller
        driver: igbvf
        product:
          id: "1520"
          name: I350 Ethernet Controller Virtual Function
        programming_interface:
          id: "00"
          name: unknown
        revision: "0x01"
        subclass:
          id: "00"
          name: Ethernet controller
        subsystem:
          id: "0000"
          name: unknown
        vendor:
          id: "8086"
          name: Intel Corporation
  virtual_functions:
  - address:
      Bus: "05"
      Device: "10"
      Domain: "0000"
      Function: "0"
    id: 0
    interfaces:
    - enp5s0f0v0
    parent_address:
      Bus: "05"
      Device: "00"
      Domain: "0000"
      Function: "0"
    pci:
      address: "0000:05:10.0"
      class:
        id: "02"
        name: Network controller
      driver: igbvf
      product:
        id: "1520"
        name: I350 Ethernet Controller Virtual Function
      programming_interface:
        id: "00"
        name: unknown
      revision: "0x01"
      subclass:
        id: "00"
        name: Ethernet controller
      subsystem:
        id: "0000"
        name: unknown
      vendor:
        id: "8086"
        name: Intel Corporation
  - address:
      Bus: "05"
      Device: "10"
      Domain: "0000"
      Function: "4"
    id: 1
    interfaces:
    - enp5s0f0v1
    parent_address:
      Bus: "05"
      Device: "00"
      Domain: "0000"
      Function: "0"
    pci:
      address: "0000:05:10.4"
      class:
        id: "02"
        name: Network controller
      driver: igbvf
      product:
        id: "1520"
        name: I350 Ethernet Controller Virtual Function
      programming_interface:
        id: "00"
        name: unknown
      revision: "0x01"
      subclass:
        id: "00"
        name: Ethernet controller
      subsystem:
        id: "0000"
        name: unknown
      vendor:
        id: "8086"
        name: Intel Corporation
  - address:
      Bus: "05"
      Device: "11"
      Domain: "0000"
      Function: "0"
    id: 2
    interfaces:
    - enp5s0f0v2
    parent_address:
      Bus: "05"
      Device: "00"
      Domain: "0000"
      Function: "0"
    pci:
      address: "0000:05:11.0"
      class:
        id: "02"
        name: Network controller
      driver: igbvf
      product:
        id: "1520"
        name: I350 Ethernet Controller Virtual Function
      programming_interface:
        id: "00"
        name: unknown
      revision: "0x01"
      subclass:
        id: "00"
        name: Ethernet controller
      subsystem:
        id: "0000"
        name: unknown
      vendor:
        id: "8086"
        name: Intel Corporation
  - address:
      Bus: "05"
      Device: "11"
      Domain: "0000"
      Function: "4"
    id: 3
    interfaces:
    - enp5s0f0v3
    parent_address:
      Bus: "05"
      Device: "00"
      Domain: "0000"
      Function: "0"
    pci:
      address: "0000:05:11.4"
      class:
        id: "02"
        name: Network controller
      driver: igbvf
      product:
        id: "1520"
        name: I350 Ethernet Controller Virtual Function
      programming_interface:
        id: "00"
        name: unknown
      revision: "0x01"
      subclass:
        id: "00"
        name: Ethernet controller
      subsystem:
        id: "0000"
        name: unknown
      vendor:
        id: "8086"
        name: Intel Corporation
  - address:
      Bus: "05"
      Device: "10"
      Domain: "0000"
      Function: "1"
    id: 0
    interfaces:
    - enp5s0f1v0
    parent_address:
      Bus: "05"
      Device: "00"
      Domain: "0000"
      Function: "1"
    pci:
      address: "0000:05:10.1"
      class:
        id: "02"
        name: Network controller
      driver: igbvf
      product:
        id: "1520"
        name: I350 Ethernet Controller Virtual Function
      programming_interface:
        id: "00"
        name: unknown
      revision: "0x01"
      subclass:
        id: "00"
        name: Ethernet controller
      subsystem:
        id: "0000"
        name: unknown
      vendor:
        id: "8086"
        name: Intel Corporation
  - address:
      Bus: "05"
      Device: "10"
      Domain: "0000"
      Function: "5"
    id: 1
    interfaces:
    - enp5s0f1v1
    parent_address:
      Bus: "05"
      Device: "00"
      Domain: "0000"
      Function: "1"
    pci:
      address: "0000:05:10.5"
      class:
        id: "02"
        name: Network controller
      driver: igbvf
      product:
        id: "1520"
        name: I350 Ethernet Controller Virtual Function
      programming_interface:
        id: "00"
        name: unknown
      revision: "0x01"
      subclass:
        id: "00"
        name: Ethernet controller
      subsystem:
        id: "0000"
        name: unknown
      vendor:
        id: "8086"
        name: Intel Corporation
  - address:
      Bus: "05"
      Device: "11"
      Domain: "0000"
      Function: "1"
    id: 2
    interfaces:
    - enp5s0f1v2
    parent_address:
      Bus: "05"
      Device: "00"
      Domain: "0000"
      Function: "1"
    pci:
      address: "0000:05:11.1"
      class:
        id: "02"
        name: Network controller
      driver: igbvf
      product:
        id: "1520"
        name: I350 Ethernet Controller Virtual Function
      programming_interface:
        id: "00"
        name: unknown
      revision: "0x01"
      subclass:
        id: "00"
        name: Ethernet controller
      subsystem:
        id: "0000"
        name: unknown
      vendor:
        id: "8086"
        name: Intel Corporation
  - address:
      Bus: "05"
      Device: "11"
      Domain: "0000"
      Function: "5"
    id: 3
    interfaces:
    - enp5s0f1v3
    parent_address:
      Bus: "05"
      Device: "00"
      Domain: "0000"
      Function: "1"
    pci:
      address: "0000:05:11.5"
      class:
        id: "02"
        name: Network controller
      driver: igbvf
      product:
        id: "1520"
        name: I350 Ethernet Controller Virtual Function
      programming_interface:
        id: "00"
        name: unknown
      revision: "0x01"
      subclass:
        id: "00"
        name: Ethernet controller
      subsystem:
        id: "0000"
        name: unknown
      vendor:
        id: "8086"
        name: Intel Corporation

Add support to report SRIOV devices. Much like GPU devices, support is added using a new top-level package. SRIOV devices are either Physical Functions or Virtual functions. The preferred representation for ghw is Physical Functions, whose dependent devices will be Virtual Functions; however, for the sake of practicality, the API also exposes soft references to Virtual Functions, so consumers of the API can access them directly and not navigating the parent devices. This patch also adds support in `ghwc`, to report the sriov information, and in the `snapshot` package, to make sure to capture all the files in sysfs that ghw cares about. Last but not least, lacking access to suitable non-linux systems, support is provided only on linux OS, even though the API tries hard not to be linux-specific. Resolves: jaypipes#92 Signed-off-by: Francesco Romani <fromani@redhat.com>

jaypipes

@fromanirh, the more I look at this patch, the more I think these changes belong in the pkg/pci package and not as a new pkg/sriov package. The fact is, SR-IOV is specific to PCI Express and therefore should really be a set of additional attributes on the existing pkg/pci.Device struct.

See inline for more explanation.

jaypipes · 2021-11-23T15:56:27Z

README.md


+### SRIOV
+
+*This API is PROVISIONAL! ghw will try hard to not make breaking changes to this API, but still users are advice this new API is not


Recommend removing this. :) The interfaces we publish are specific to a Git tag or SHA1 per Go package versioning and semver behaviour.

no problem! will remove.

jaypipes · 2021-11-23T16:08:18Z

pkg/snapshot/clonetree_pci_linux.go

+		"virtfn*",
+	}
+
+	ignoreSet := newKeySet(


I don't think it's necessary to create a new keySet typedef. We can just use map[string]bool here and where you're doing the ignoreSet.Contains call below, just do:

if _, ignored := ignoreSet[globbedEntry]; ignored { continue }

sure thing, will simplify

jaypipes · 2021-11-23T16:23:23Z

pkg/sriov/sriov_linux.go

+	}
+}
+
+func findNetworks(ctx *context.Context, devPath string) []string {


are they network names or are they network interface names? :)

yes, they are actually network interface names. Will clarify the function name.

jaypipes · 2021-11-23T16:31:03Z

pkg/sriov/sriov.go

+type Device struct {
+	Interfaces []string `json:"interfaces"`
+	// the PCI address where the SRIOV instance can be found
+	Address *pciaddr.Address `json:"address"`
+	PCI     *pci.Device      `json:"pci"`
+}


Instead of creating a new pkg/sriov package and pkg/sriov.Device structI think we should just modify thepkg/pci.Device` struct to read SR-IOV (and network interface) information when the PCI device is a PF or VF.

We should add a new Interface struct to pkg/net:

// Interface represents a physical or virtual network interface on the host type Interface struct { // Name is the name of the interface on the host Name string `json:"name"` }

We can then modify the pkg/pci.Device struct to add the following:

... import ( ... "github.com/jaypipes/ghw/pkg/net" ... ) ... type Device struct { ... // NetworkInterfaces is the collection of network interfaces housed on this // PCI device. NetworkInterfaces []net.Interface `json:"network_interfaces,omitempty"` }

This is an interesting idea. I'd like to process the concept a bit more to fully grok it but doesn't look bad at all. However this also mean that we aim to absorb all the PCI device type (= gpu) into the PCI package in the long run?
Or it's just SRIOV which is not special enough? (again no strong feeling, but wondering about the general direction)

jaypipes · 2021-11-23T16:31:57Z

pkg/sriov/sriov.go

+}
+
+type PhysicalFunction struct {
+	Device


And here, we'd inherit from pkg/pci.Device instead.

jaypipes · 2021-11-23T16:32:05Z

pkg/sriov/sriov.go

+}
+
+type VirtualFunction struct {
+	Device


jaypipes · 2021-11-23T16:32:49Z

pkg/sriov/sriov.go

+
+type VirtualFunction struct {
+	Device
+	ID int `json:"id"`


Is this the index of the VF within the PF? If so, should we call this Index?

Yep, it should be called probably Index and I should clarify it with a code comment.

jaypipes · 2021-11-23T16:33:21Z

pkg/sriov/sriov.go

+	// Address of the (parent) Physical Function this Virtual Function pertains to.
+	ParentAddress *pciaddr.Address `json:"parent_address,omitempty"`


Should we just store a pointer to the parent pkg/pci.Device struct instead?

Come to think of it, could we just use a single Function struct to describe all of the SR-IOV functions, both physical and virtual?

// Function describes an SR-IOV physical or virtual function. Physical functions // will have no Parent Function struct pointer and will have one or more Function // structs in the Functions field. type Function struct { Device // All Functions are PCI Devices // Parent contains a pointer to the parent physical function. // Will be empty when this is a physical function Parent *Function `json:"parent,omitempty"` // MaxVFs contains the maximum number of supported virtual // functions for this physical function MaxVFs int `json:"max_vfs" // Functions contains the physical function's virtual functions Functions []*Function `json:"functions"` }

You could create a simple IsPhysical utility method on pkg/pci.Function:

// IsPhysical returns true if the PCIe function is a physical function, false // if it is a virtual function func (f *Function) IsPhysical() bool { return f.Parent == nil }

Interesting angle, I don't have again strong feelings about this idea. With respect the current approach, we lose something, we gain something. I'll file a separate PR so we can compare the two approaches, and I'll close the one we like less (with rationale of course).

ffromani · 2022-01-31T08:13:40Z

sorry for the delay, caused by winter holidays plus crazy january. I'll resume work here ASAP, let's try this variation!

ffromani · 2022-03-18T09:02:41Z

@fromanirh, the more I look at this patch, the more I think these changes belong in the pkg/pci package and not as a new pkg/sriov package. The fact is, SR-IOV is specific to PCI Express and therefore should really be a set of additional attributes on the existing pkg/pci.Device struct.

See inline for more explanation.

(at LONG last I finally got some time to resume working on this PR!)
I don't have strong feelings here, so I'm fine modeling SRIOV devices as extra attributes of PCI devices.
The only minor question that this would arise is, however, related to GPU devices which sit in their own module. Do we want to absorb GPU devices in the PCI devices someday in the future?

Again, I don't have strong feelings here, but this (perceived?) inconsistency makes me think.
Going to address your comments now, thanks for your review!

ffromani · 2022-05-01T08:41:09Z

at long last, the alternate implementation is available: #315

ffromani · 2023-07-21T08:19:06Z

we agreed to move forward with #315

ffromani mentioned this pull request Feb 24, 2021

Grab information on VFs for SR-IOV PFs #92

Open

ffromani commented Feb 25, 2021

View reviewed changes

ffromani force-pushed the net-sriov-info branch 2 times, most recently from 7e97f20 to 5e67349 Compare March 2, 2021 12:56

ffromani force-pushed the net-sriov-info branch from 5e67349 to 79f1dbc Compare March 9, 2021 17:07

ffromani force-pushed the net-sriov-info branch 2 times, most recently from bbe0fb9 to 8b33ae8 Compare March 18, 2021 11:12

ffromani force-pushed the net-sriov-info branch from 8b33ae8 to 8cf64a0 Compare March 19, 2021 08:07

ffromani force-pushed the net-sriov-info branch 2 times, most recently from 2f4aee4 to b146139 Compare March 29, 2021 15:25

ffromani changed the title ~~WIP: RFC: expose SRIOV information~~ expose SRIOV information Mar 29, 2021

ffromani force-pushed the net-sriov-info branch 3 times, most recently from 9b6c782 to f88d4a5 Compare March 31, 2021 06:45

ffromani force-pushed the net-sriov-info branch 3 times, most recently from 0f62884 to 62a092d Compare April 7, 2021 16:00

ffromani mentioned this pull request Apr 12, 2021

context: introduce dependent context #238

Closed

ffromani force-pushed the net-sriov-info branch 2 times, most recently from 080eb0b to 1b41001 Compare April 12, 2021 05:39

ffromani force-pushed the net-sriov-info branch from 1b41001 to 1e9aa06 Compare April 25, 2021 11:31

ffromani mentioned this pull request May 13, 2021

Dependent contexts #247

Closed

ffromani force-pushed the net-sriov-info branch 3 times, most recently from ea52d44 to 4715e44 Compare June 25, 2021 15:01

ffromani force-pushed the net-sriov-info branch from 4715e44 to cf6f510 Compare September 29, 2021 16:08

ffromani changed the title ~~expose SRIOV information~~ WIP: expose SRIOV information Sep 29, 2021

ffromani force-pushed the net-sriov-info branch from cf6f510 to 40ad1e1 Compare November 4, 2021 14:39

ffromani changed the title ~~WIP: expose SRIOV information~~ expose SRIOV information Nov 4, 2021

ffromani force-pushed the net-sriov-info branch from 40ad1e1 to ce233e2 Compare November 23, 2021 10:23

ffromani requested a review from jaypipes November 23, 2021 10:24

ffromani force-pushed the net-sriov-info branch from ce233e2 to 901f511 Compare November 23, 2021 15:41

ffromani force-pushed the net-sriov-info branch from 901f511 to 9058f61 Compare November 23, 2021 15:42

jaypipes requested changes Nov 23, 2021

View reviewed changes

ffromani mentioned this pull request May 1, 2022

expose SRIOV information as PCI devices #315

Open

ffromani closed this Jul 21, 2023


		### SRIOV

		*This API is PROVISIONAL! ghw will try hard to not make breaking changes to this API, but still users are advice this new API is not

		// Address of the (parent) Physical Function this Virtual Function pertains to.
		ParentAddress *pciaddr.Address `json:"parent_address,omitempty"`

Conversation

ffromani commented Feb 24, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ffromani commented Feb 24, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ffromani commented Feb 24, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ffromani commented Mar 17, 2021

Uh oh!

ffromani commented Mar 18, 2021

Uh oh!

ffromani commented Mar 30, 2021

Uh oh!

ffromani commented Mar 30, 2021

Uh oh!

ffromani commented Mar 30, 2021

Uh oh!

ffromani commented Mar 31, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ffromani commented Apr 7, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ffromani commented May 13, 2021

Uh oh!

ffromani commented Sep 29, 2021

Uh oh!

ffromani commented Nov 4, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ffromani commented Nov 23, 2021

Uh oh!

ffromani commented Nov 23, 2021

Uh oh!

ffromani commented Nov 23, 2021

Uh oh!

jaypipes left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ffromani commented Jan 31, 2022

Uh oh!

ffromani commented Mar 18, 2022

Uh oh!

ffromani commented May 1, 2022

Uh oh!

ffromani commented Feb 24, 2021 •

edited

Loading

ffromani commented Feb 24, 2021 •

edited

Loading

ffromani commented Feb 24, 2021 •

edited

Loading

ffromani commented Mar 31, 2021 •

edited

Loading

ffromani commented Apr 7, 2021 •

edited

Loading

ffromani commented Nov 4, 2021 •

edited

Loading