pci

Documentation

Index

• type Device
  • func (d *Device) MarshalJSON() ([]byte, error)
  • func (d *Device) String() string
• type Info
  • func New(opts ...*option.Option) (*Info, error)
  • func (info *Info) GetDevice(address string) *Device
  • func (i *Info) JSONString(indent bool) string
  • func (info *Info) ParseDevice(address, modalias string) *Device
  • func (i *Info) String() string
  • func (i *Info) YAMLString() string

Types

type Device

type Device struct {
	// The PCI address of the device
	Address   string         `json:"address"`
	Vendor    *pcidb.Vendor  `json:"vendor"`
	Product   *pcidb.Product `json:"product"`
	Revision  string         `json:"revision"`
	Subsystem *pcidb.Product `json:"subsystem"`
	// optional subvendor/sub-device information
	Class *pcidb.Class `json:"class"`
	// optional sub-class for the device
	Subclass *pcidb.Subclass `json:"subclass"`
	// optional programming interface
	ProgrammingInterface *pcidb.ProgrammingInterface `json:"programming_interface"`
	// Topology node that the PCI device is affined to. Will be nil if the
	// architecture is not NUMA.
	Node   *topology.Node `json:"node,omitempty"`
	Driver string         `json:"driver"`
}

func (*Device) MarshalJSON

func (d *Device) MarshalJSON() ([]byte, error)

NOTE(jaypipes) Device has a custom JSON marshaller because we don't want to serialize the entire PCIDB information for the Vendor (which includes all of the vendor's products, etc). Instead, we simply serialize the ID and human-readable name of the vendor, product, class, etc.

func (*Device) String

func (d *Device) String() string

type Info

type Info struct {

	// All PCI devices on the host system
	Devices []*Device
	// contains filtered or unexported fields
}

func New

func New(opts ...*option.Option) (*Info, error)

New returns a pointer to an Info struct that contains information about the PCI devices on the host system

func (*Info) GetDevice

func (info *Info) GetDevice(address string) *Device

GetDevice returns a pointer to a Device struct that describes the PCI device at the requested address. If no such device could be found, returns nil.

func (*Info) JSONString

func (i *Info) JSONString(indent bool) string

JSONString returns a string with the PCI information formatted as JSON under a top-level "pci:" key

func (*Info) ParseDevice

func (info *Info) ParseDevice(address, modalias string) *Device

ParseDevice returns a pointer to a Device given its describing data. The PCI device obtained this way may not exist in the system; use GetDevice to get a *Device which is found in the system

func (*Info) String

func (i *Info) String() string

func (*Info) YAMLString

func (i *Info) YAMLString() string

YAMLString returns a string with the PCI information formatted as YAML under a top-level "pci:" key