memory_cache.go

//
// Use and distribution licensed under the Apache license version 2.
//
// See the COPYING file in the root project directory for full text.
//

package ghw

import (
	"fmt"
	"strconv"
	"strings"
)

type MemoryCacheType int

const (
	MEMORY_CACHE_TYPE_UNIFIED MemoryCacheType = iota
	MEMORY_CACHE_TYPE_INSTRUCTION
	MEMORY_CACHE_TYPE_DATA
)

var (
	memoryCacheTypeString = map[MemoryCacheType]string{
		MEMORY_CACHE_TYPE_UNIFIED:     "Unified",
		MEMORY_CACHE_TYPE_INSTRUCTION: "Instruction",
		MEMORY_CACHE_TYPE_DATA:        "Data",
	}
)

func (a MemoryCacheType) String() string {
	return memoryCacheTypeString[a]
}

// NOTE(jaypipes): since serialized output is as "official" as we're going to
// get, let's lowercase the string output when serializing, in order to
// "normalize" the expected serialized output
func (a MemoryCacheType) MarshalJSON() ([]byte, error) {
	return []byte("\"" + strings.ToLower(a.String()) + "\""), nil
}

type SortByMemoryCacheLevelTypeFirstProcessor []*MemoryCache

func (a SortByMemoryCacheLevelTypeFirstProcessor) Len() int      { return len(a) }
func (a SortByMemoryCacheLevelTypeFirstProcessor) Swap(i, j int) { a[i], a[j] = a[j], a[i] }
func (a SortByMemoryCacheLevelTypeFirstProcessor) Less(i, j int) bool {
	if a[i].Level < a[j].Level {
		return true
	} else if a[i].Level == a[j].Level {
		if a[i].Type < a[j].Type {
			return true
		} else if a[i].Type == a[j].Type {
			// NOTE(jaypipes): len(LogicalProcessors) is always >0 and is always
			// sorted lowest LP ID to highest LP ID
			return a[i].LogicalProcessors[0] < a[j].LogicalProcessors[0]
		}
	}
	return false
}

type SortByLogicalProcessorId []uint32

func (a SortByLogicalProcessorId) Len() int           { return len(a) }
func (a SortByLogicalProcessorId) Swap(i, j int)      { a[i], a[j] = a[j], a[i] }
func (a SortByLogicalProcessorId) Less(i, j int) bool { return a[i] < a[j] }

type MemoryCache struct {
	Level     uint8           `json:"level"`
	Type      MemoryCacheType `json:"type"`
	SizeBytes uint64          `json:"size_bytes"`
	// The set of logical processors (hardware threads) that have access to the
	// cache
	LogicalProcessors []uint32 `json:"logical_processors"`
}

func (c *MemoryCache) String() string {
	sizeKb := c.SizeBytes / uint64(KB)
	typeStr := ""
	if c.Type == MEMORY_CACHE_TYPE_INSTRUCTION {
		typeStr = "i"
	} else if c.Type == MEMORY_CACHE_TYPE_DATA {
		typeStr = "d"
	}
	cacheIdStr := fmt.Sprintf("L%d%s", c.Level, typeStr)
	processorMapStr := ""
	if c.LogicalProcessors != nil {
		lpStrings := make([]string, len(c.LogicalProcessors))
		for x, lpid := range c.LogicalProcessors {
			lpStrings[x] = strconv.Itoa(int(lpid))
		}
		processorMapStr = " shared with logical processors: " + strings.Join(lpStrings, ",")
	}
	return fmt.Sprintf(
		"%s cache (%d KB)%s",
		cacheIdStr,
		sizeKb,
		processorMapStr,
	)
}