cgroup

Documentation

Overview

Package cgroup holds cgroup related files

Index

• type Event
• type Resolver
  • func NewResolver() (*Resolver, error)
  • func (cr *Resolver) AddPID(process *model.ProcessCacheEntry)
  • func (cr *Resolver) DelPID(pid uint32)
  • func (cr *Resolver) DelPIDWithID(id containerutils.ContainerID, pid uint32)
  • func (cr *Resolver) GetCGroupContext(cgroupPath model.PathKey) (*model.CGroupContext, bool)
  • func (cr *Resolver) GetWorkload(id containerutils.ContainerID) (*cgroupModel.CacheEntry, bool)
  • func (cr *Resolver) Len() int
  • func (cr *Resolver) Start(_ context.Context)
• type ResolverInterface

Types

type Event

type Event int

Event defines the cgroup event type

const (
	// CGroupDeleted is used to notify that a cgroup was deleted
	CGroupDeleted Event = iota + 1
	// CGroupCreated new croup created
	CGroupCreated
	// CGroupMaxEvent is used cap the event ID
	CGroupMaxEvent
)

type Resolver

type Resolver struct {
	*utils.Notifier[Event, *cgroupModel.CacheEntry]
	sync.Mutex
	// contains filtered or unexported fields
}

Resolver defines a cgroup monitor

func NewResolver

func NewResolver() (*Resolver, error)

NewResolver returns a new cgroups monitor

func (*Resolver) AddPID

func (cr *Resolver) AddPID(process *model.ProcessCacheEntry)

AddPID associates a container id and a pid which is expected to be the pid 1

func (*Resolver) DelPID

func (cr *Resolver) DelPID(pid uint32)

DelPID removes a PID from the cgroup resolver

func (*Resolver) DelPIDWithID

func (cr *Resolver) DelPIDWithID(id containerutils.ContainerID, pid uint32)

DelPIDWithID removes a PID from the cgroup cache entry referenced by the provided ID

func (*Resolver) GetCGroupContext

func (cr *Resolver) GetCGroupContext(cgroupPath model.PathKey) (*model.CGroupContext, bool)

GetCGroupContext returns the cgroup context with the specified path key

func (*Resolver) GetWorkload

func (cr *Resolver) GetWorkload(id containerutils.ContainerID) (*cgroupModel.CacheEntry, bool)

GetWorkload returns the workload referenced by the provided ID

func (*Resolver) Len

func (cr *Resolver) Len() int

Len return the number of entries

func (*Resolver) Start

func (cr *Resolver) Start(_ context.Context)

Start starts the goroutine of the SBOM resolver

type ResolverInterface

type ResolverInterface interface {
	Start(context.Context)
	AddPID(*model.ProcessCacheEntry)
	GetWorkload(containerutils.ContainerID) (*cgroupModel.CacheEntry, bool)
	DelPID(uint32)
	DelPIDWithID(containerutils.ContainerID, uint32)
	Len() int
	RegisterListener(Event, utils.Listener[*cgroupModel.CacheEntry]) error
}

ResolverInterface defines the interface implemented by a cgroup resolver