From e47d613f4253d8aa37e8dac1e0a76243bc4a1787 Mon Sep 17 00:00:00 2001 From: Jay Pipes Date: Mon, 23 Sep 2024 13:03:29 -0400 Subject: [PATCH] use Go idiomatic naming for Architecture consts Updates the `ARCHITECTURE_SMP` and `ARCHITECTURE_NUMA` constants to `ArchitectureSMP` and `ArchitectureNUMA`, respectively, to align with idiomatic Go naming conventions. For backwards-compat, keeps `ARCHITECTURE_SMP` and `ARCHITECTURE_NUMA` in the aliased variables for a few releases. These will be discarded when we cut a v1.0 series. Signed-off-by: Jay Pipes --- alias.go | 8 ++++++-- pkg/gpu/gpu_linux.go | 2 +- pkg/pci/pci.go | 2 +- pkg/pci/pci_linux.go | 2 +- pkg/topology/topology.go | 23 ++++++++++++++++------- pkg/topology/topology_linux.go | 4 ++-- pkg/topology/topology_test.go | 2 +- pkg/topology/topology_windows.go | 4 ++-- 8 files changed, 30 insertions(+), 17 deletions(-) diff --git a/alias.go b/alias.go index 83157d00..ccd5e808 100644 --- a/alias.go +++ b/alias.go @@ -154,8 +154,12 @@ var ( type Architecture = topology.Architecture const ( - ARCHITECTURE_SMP = topology.ARCHITECTURE_SMP - ARCHITECTURE_NUMA = topology.ARCHITECTURE_NUMA + ArchitectureSMP = topology.ArchitectureSMP + // DEPRECATED: Please use ArchitectureSMP + ARCHITECTURE_SMP = topology.ArchitectureSMP + ArchitectureNUMA = topology.ArchitectureNUMA + // DEPRECATED: Please use ArchitectureNUMA + ARCHITECTURE_NUMA = topology.ArchitectureNUMA ) type PCIInfo = pci.Info diff --git a/pkg/gpu/gpu_linux.go b/pkg/gpu/gpu_linux.go index 611f2408..5eb9d1d7 100644 --- a/pkg/gpu/gpu_linux.go +++ b/pkg/gpu/gpu_linux.go @@ -137,7 +137,7 @@ func gpuFillNUMANodes(ctx *context.Context, cards []*GraphicsCard) { // Problem getting topology information so just set the graphics card's // node to nil for _, card := range cards { - if topo.Architecture != topology.ARCHITECTURE_NUMA { + if topo.Architecture != topology.ArchitectureNUMA { card.Node = nil } } diff --git a/pkg/pci/pci.go b/pkg/pci/pci.go index 49adde62..55cc1eac 100644 --- a/pkg/pci/pci.go +++ b/pkg/pci/pci.go @@ -135,7 +135,7 @@ func New(opts ...*option.Option) (*Info, error) { // by default we don't report NUMA information; // we will only if are sure we are running on NUMA architecture info := &Info{ - arch: topology.ARCHITECTURE_SMP, + arch: topology.ArchitectureSMP, ctx: ctx, } diff --git a/pkg/pci/pci_linux.go b/pkg/pci/pci_linux.go index 538e77f3..a9616687 100644 --- a/pkg/pci/pci_linux.go +++ b/pkg/pci/pci_linux.go @@ -325,7 +325,7 @@ func (info *Info) GetDevice(address string) *Device { device := info.getDeviceFromModaliasInfo(address, modaliasInfo) device.Revision = getDeviceRevision(info.ctx, pciAddr) - if info.arch == topology.ARCHITECTURE_NUMA { + if info.arch == topology.ArchitectureNUMA { device.Node = getDeviceNUMANode(info.ctx, pciAddr) } device.Driver = getDeviceDriver(info.ctx, pciAddr) diff --git a/pkg/topology/topology.go b/pkg/topology/topology.go index 4a269bb9..0210ab48 100644 --- a/pkg/topology/topology.go +++ b/pkg/topology/topology.go @@ -26,15 +26,24 @@ type Architecture int const ( // SMP is a Symmetric Multi-Processor system - ARCHITECTURE_SMP Architecture = iota + ArchitectureSMP Architecture = iota // NUMA is a Non-Uniform Memory Access system - ARCHITECTURE_NUMA + ArchitectureNUMA +) + +const ( + // DEPRECATED: please use ArchitectureSMP. + // TODO(jaypipes): Remove before v1.0 + ARCHITECTURE_SMP = ArchitectureSMP + // DEPRECATED: please use ArchitectureNUMA. + // TODO(jaypipes): Remove before v1.0 + ARCHITECTURE_NUMA = ArchitectureNUMA ) var ( architectureString = map[Architecture]string{ - ARCHITECTURE_SMP: "SMP", - ARCHITECTURE_NUMA: "NUMA", + ArchitectureSMP: "SMP", + ArchitectureNUMA: "NUMA", } // NOTE(fromani): the keys are all lowercase and do not match @@ -43,8 +52,8 @@ var ( // Architecture:MarshalJSON. // We use this table only in UnmarshalJSON, so it should be OK. stringArchitecture = map[string]Architecture{ - "smp": ARCHITECTURE_SMP, - "numa": ARCHITECTURE_NUMA, + "smp": ArchitectureSMP, + "numa": ArchitectureNUMA, } ) @@ -126,7 +135,7 @@ func New(opts ...*option.Option) (*Info, error) { func (i *Info) String() string { archStr := "SMP" - if i.Architecture == ARCHITECTURE_NUMA { + if i.Architecture == ArchitectureNUMA { archStr = "NUMA" } res := fmt.Sprintf( diff --git a/pkg/topology/topology_linux.go b/pkg/topology/topology_linux.go index 9d8434cb..dbd0811e 100644 --- a/pkg/topology/topology_linux.go +++ b/pkg/topology/topology_linux.go @@ -21,9 +21,9 @@ import ( func (i *Info) load() error { i.Nodes = topologyNodes(i.ctx) if len(i.Nodes) == 1 { - i.Architecture = ARCHITECTURE_SMP + i.Architecture = ArchitectureSMP } else { - i.Architecture = ARCHITECTURE_NUMA + i.Architecture = ArchitectureNUMA } return nil } diff --git a/pkg/topology/topology_test.go b/pkg/topology/topology_test.go index d06119b4..3c2b1635 100644 --- a/pkg/topology/topology_test.go +++ b/pkg/topology/topology_test.go @@ -32,7 +32,7 @@ func TestTopology(t *testing.T) { t.Fatalf("Expected >0 nodes but got 0.") } - if info.Architecture == topology.ARCHITECTURE_NUMA && len(info.Nodes) == 1 { + if info.Architecture == topology.ArchitectureNUMA && len(info.Nodes) == 1 { t.Fatalf("Got NUMA architecture but only 1 node.") } diff --git a/pkg/topology/topology_windows.go b/pkg/topology/topology_windows.go index 3141ac99..2991aaa9 100644 --- a/pkg/topology/topology_windows.go +++ b/pkg/topology/topology_windows.go @@ -31,9 +31,9 @@ func (i *Info) load() error { } i.Nodes = nodes if len(nodes) == 1 { - i.Architecture = ARCHITECTURE_SMP + i.Architecture = ArchitectureSMP } else { - i.Architecture = ARCHITECTURE_NUMA + i.Architecture = ArchitectureNUMA } return nil }