ghw

package module
v1.0.5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 10, 2025 License: Apache-2.0 Imports: 12 Imported by: 0

README

ghw - Golang HardWare discovery/inspection library

This is a stripped-down fork of ghw to minimize dependencies. Please refer to the original repo for the cannonical package.

Documentation

Overview

package ghw can determine various hardware-related information about the host computer:

* Memory * CPU * Block storage * Topology * Network * PCI * GPU

Memory

Information about the host computer's memory can be retrieved using the Memory function which returns a pointer to a MemoryInfo struct. 

package main

import (
	"fmt"

	"github.com/jackmordaunt/ghw"
)

func main() {
	memory, err := ghw.Memory()
	if err != nil {
		fmt.Printf("Error getting memory info: %v", err)
	}

	fmt.Println(memory.String())
}

CPU

The CPU function returns a CPUInfo struct that contains information about the CPUs on the host system. 

package main

import (
	"fmt"
	"math"
	"strings"

	"github.com/jackmordaunt/ghw"
)

func main() {
	cpu, err := ghw.CPU()
	if err != nil {
		fmt.Printf("Error getting CPU info: %v", err)
	}

	fmt.Printf("%v\n", cpu)

	for _, proc := range cpu.Processors {
		fmt.Printf(" %v\n", proc)
		for _, core := range proc.Cores {
			fmt.Printf("  %v\n", core)
		}
		if len(proc.Capabilities) > 0 {
			// pretty-print the (large) block of capability strings into rows
			// of 6 capability strings
			rows := int(math.Ceil(float64(len(proc.Capabilities)) / float64(6)))
			for row := 1; row < rows; row = row + 1 {
				rowStart := (row * 6) - 1
				rowEnd := int(math.Min(float64(rowStart+6), float64(len(proc.Capabilities))))
				rowElems := proc.Capabilities[rowStart:rowEnd]
				capStr := strings.Join(rowElems, " ")
				if row == 1 {
					fmt.Printf("  capabilities: [%s\n", capStr)
				} else if rowEnd < len(proc.Capabilities) {
					fmt.Printf("                 %s\n", capStr)
				} else {
					fmt.Printf("                 %s]\n", capStr)
				}
			}
		}
	}
}

Block storage

Information about the host computer's local block storage is returned from the Block function. This function returns a pointer to a BlockInfo struct. 

package main

import (
	"fmt"

	"github.com/jackmordaunt/ghw"
)

func main() {
	block, err := ghw.Block()
	if err != nil {
		fmt.Printf("Error getting block storage info: %v", err)
	}

	fmt.Printf("%v\n", block)

	for _, disk := range block.Disks {
		fmt.Printf(" %v\n", disk)
		for _, part := range disk.Partitions {
			fmt.Printf("  %v\n", part)
		}
	}
}

Topology

Information about the host computer's architecture (NUMA vs. SMP), the host's node layout and processor caches can be retrieved from the Topology function. This function returns a pointer to a TopologyInfo struct. 

package main

import (
	"fmt"

	"github.com/jackmordaunt/ghw"
)

func main() {
	topology, err := ghw.Topology()
	if err != nil {
		fmt.Printf("Error getting topology info: %v", err)
	}

	fmt.Printf("%v\n", topology)

	for _, node := range topology.Nodes {
		fmt.Printf(" %v\n", node)
		for _, cache := range node.Caches {
			fmt.Printf("  %v\n", cache)
		}
	}
}

Network

Information about the host computer's networking hardware is returned from the Network function. This function returns a pointer to a NetworkInfo struct. 

package main

import (
	"fmt"

	"github.com/jackmordaunt/ghw"
)

func main() {
	net, err := ghw.Network()
	if err != nil {
		fmt.Printf("Error getting network info: %v", err)
	}

	fmt.Printf("%v\n", net)

	for _, nic := range net.NICs {
		fmt.Printf(" %v\n", nic)

		enabledCaps := make([]int, 0)
		for x, cap := range nic.Capabilities {
			if cap.IsEnabled {
				enabledCaps = append(enabledCaps, x)
			}
		}
		if len(enabledCaps) > 0 {
			fmt.Printf("  enabled capabilities:\n")
			for _, x := range enabledCaps {
				fmt.Printf("   - %s\n", nic.Capabilities[x].Name)
			}
		}
	}
}

PCI

ghw contains a PCI database inspection and querying facility that allows developers to not only gather information about devices on a local PCI bus but also query for information about hardware device classes, vendor and product information.

**NOTE**: Parsing of the PCI-IDS file database is provided by the separate http://github.com/jackmordaunt/pcidb library. You can read that library's README for more information about the various structs that are exposed on the PCIInfo struct.

PCIInfo.ListDevices is used to iterate over a host's PCI devices: 

package main

import (
	"fmt"

	"github.com/jackmordaunt/ghw"
)

func main() {
	pci, err := ghw.PCI()
	if err != nil {
		fmt.Printf("Error getting PCI info: %v", err)
	}
	fmt.Printf("host PCI devices:\n")
	fmt.Println("====================================================")
	devices := pci.ListDevices()
	if len(devices) == 0 {
		fmt.Printf("error: could not retrieve PCI devices\n")
		return
	}

	for _, device := range devices {
		vendor := device.Vendor
		vendorName := vendor.Name
		if len(vendor.Name) > 20 {
			vendorName = string([]byte(vendorName)[0:17]) + "..."
		}
		product := device.Product
		productName := product.Name
		if len(product.Name) > 40 {
			productName = string([]byte(productName)[0:37]) + "..."
		}
		fmt.Printf("%-12s\t%-20s\t%-40s\n", device.Address, vendorName, productName)
	}
}

The following code snippet shows how to call the PCIInfo.GetDevice method and use its returned PCIDevice struct pointer: 

package main

import (
	"fmt"
	"os"

	"github.com/jackmordaunt/ghw"
)

func main() {
	pci, err := ghw.PCI()
	if err != nil {
		fmt.Printf("Error getting PCI info: %v", err)
	}

	addr := "0000:00:00.0"
	if len(os.Args) == 2 {
		addr = os.Args[1]
	}
	fmt.Printf("PCI device information for %s\n", addr)
	fmt.Println("====================================================")
	deviceInfo := pci.GetDevice(addr)
	if deviceInfo == nil {
		fmt.Printf("could not retrieve PCI device information for %s\n", addr)
		return
	}

	vendor := deviceInfo.Vendor
	fmt.Printf("Vendor: %s [%s]\n", vendor.Name, vendor.ID)
	product := deviceInfo.Product
	fmt.Printf("Product: %s [%s]\n", product.Name, product.ID)
	subsystem := deviceInfo.Subsystem
	subvendor := pci.Vendors[subsystem.VendorID]
	subvendorName := "UNKNOWN"
	if subvendor != nil {
		subvendorName = subvendor.Name
	}
	fmt.Printf("Subsystem: %s [%s] (Subvendor: %s)\n", subsystem.Name, subsystem.ID, subvendorName)
	class := deviceInfo.Class
	fmt.Printf("Class: %s [%s]\n", class.Name, class.ID)
	subclass := deviceInfo.Subclass
	fmt.Printf("Subclass: %s [%s]\n", subclass.Name, subclass.ID)
	progIface := deviceInfo.ProgrammingInterface
	fmt.Printf("Programming Interface: %s [%s]\n", progIface.Name, progIface.ID)
}

GPU

Information about the host computer's graphics hardware is returned from the GPU function. This function returns a pointer to a GPUInfo struct. 

package main

import (
	"fmt"

	"github.com/jackmordaunt/ghw"
)

func main() {
	gpu, err := ghw.GPU()
	if err != nil {
		fmt.Printf("Error getting GPU info: %v", err)
	}

	fmt.Printf("%v\n", gpu)

	for _, card := range gpu.GraphicsCards {
		fmt.Printf(" %v\n", card)
	}
}

Index

Constants

View Source 
const (
	MEMORY_CACHE_TYPE_UNIFIED     = memory.CACHE_TYPE_UNIFIED
	MEMORY_CACHE_TYPE_INSTRUCTION = memory.CACHE_TYPE_INSTRUCTION
	MEMORY_CACHE_TYPE_DATA        = memory.CACHE_TYPE_DATA
)
View Source 
const (
	ARCHITECTURE_SMP  = topology.ARCHITECTURE_SMP
	ARCHITECTURE_NUMA = topology.ARCHITECTURE_NUMA
)

Variables

View Source 
var (
	WithChroot      = option.WithChroot
	WithSnapshot    = option.WithSnapshot
	WithAlerter     = option.WithAlerter
	WithNullAlerter = option.WithNullAlerter
	// match the existing environ variable to minimize surprises
	WithDisableWarnings = option.WithNullAlerter
	WithDisableTools    = option.WithDisableTools
	WithPathOverrides   = option.WithPathOverrides
)
View Source 
var (
	PCI                  = pci.New
	PCIAddressFromString = pciaddress.FromString
)
View Source 
var (
	Baseboard = baseboard.New
)
View Source 
var (
	CPU = cpu.New
)
View Source 
var (
	Chassis = chassis.New
)
View Source 
var (
	GPU = gpu.New
)
View Source 
var (
	Memory = memory.New
)
View Source 
var (
	Product = product.New
)
View Source 
var (
	Topology = topology.New
)

Functions

This section is empty.

Types

type Architecture 

type Architecture = topology.Architecture

type BaseboardInfo 

type BaseboardInfo = baseboard.Info

type CPUInfo 

type CPUInfo = cpu.Info

type ChassisInfo 

type ChassisInfo = chassis.Info

type GPUInfo 

type GPUInfo = gpu.Info

type GraphicsCard 

type GraphicsCard = gpu.GraphicsCard

type HostInfo 

type HostInfo struct {
	Memory    *memory.Info    `json:"memory"`
	CPU       *cpu.Info       `json:"cpu"`
	Topology  *topology.Info  `json:"topology"`
	GPU       *gpu.Info       `json:"gpu"`
	Chassis   *chassis.Info   `json:"chassis"`
	Baseboard *baseboard.Info `json:"baseboard"`
	Product   *product.Info   `json:"product"`
	PCI       *pci.Info       `json:"pci"`
	// contains filtered or unexported fields
}

HostInfo is a wrapper struct containing information about the host system's memory, block storage, CPU, etc

func Host 

func Host(opts ...*WithOption) (*HostInfo, error)

Host returns a pointer to a HostInfo struct that contains fields with information about the host system's CPU, memory, network devices, etc

func (*HostInfo) String 

func (info *HostInfo) String() string

String returns a newline-separated output of the HostInfo's component structs' String-ified output

type MemoryArea 

type MemoryArea = memory.Area

type MemoryCacheType 

type MemoryCacheType = memory.CacheType

type MemoryInfo 

type MemoryInfo = memory.Info

type MemoryModule 

type MemoryModule = memory.Module

type PCIAddress 

type PCIAddress = pciaddress.Address

type PCIDevice 

type PCIDevice = pci.Device

type PCIInfo 

type PCIInfo = pci.Info

type PathOverrides 

type PathOverrides = option.PathOverrides

type ProductInfo 

type ProductInfo = product.Info

type SnapshotOptions 

type SnapshotOptions = option.SnapshotOptions

type TopologyInfo 

type TopologyInfo = topology.Info

type TopologyNode 

type TopologyNode = topology.Node

type WithOption 

type WithOption = option.Option

Source Files

View all Source files

Directories

Path Synopsis
pkg
baseboard
chassis
context
cpu
gpu
linuxdmi
linuxpath
memory
option
pci
pci/address
product
snapshot
topology
unitutil
util

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.