Skip to content

refactor: rename CGroup to Cgroup #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DanielleMaywood merged 1 commit into from
Oct 13, 2025
Merged

refactor: rename CGroup to Cgroup #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions cgroup.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ type cgroupStatter interface {
memory(p Prefix) (*Result, error)
}

func (s *Statter) getCGroupStatter() (cgroupStatter, error) {
func (s *Statter) getCgroupStatter() (cgroupStatter, error) {
isContainerized, err := s.IsContainerized()
if err != nil {
return nil, err
Expand All @@ -44,7 +44,7 @@ func (s *Statter) getCGroupStatter() (cgroupStatter, error) {
return nil, errNotContainerized
}

if s.isCGroupV2() {
if s.isCgroupV2() {
cgroupPath, err := currentProcCgroup(s.fs)
if err != nil {
return nil, xerrors.Errorf("get current cgroup: %w", err)
Expand Down Expand Up @@ -105,7 +105,7 @@ func (s *Statter) ContainerCPU() (*Result, error) {
return r, nil
}

func (s *Statter) isCGroupV2() bool {
func (s *Statter) isCgroupV2() bool {
return s.cgroupV2Detector(s.fs)
}

Expand Down
2 changes: 1 addition & 1 deletion cgroup_linux.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import (
"syscall"
)

func isCGroupV2(path string) bool {
func isCgroupV2(path string) bool {
var stat syscall.Statfs_t
if err := syscall.Statfs(path, &stat); err != nil {
return false
Expand Down
2 changes: 1 addition & 1 deletion cgroup_other.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

package clistat

func isCGroupV2(path string) bool {
func isCgroupV2(_ string) bool {
return false
}
2 changes: 1 addition & 1 deletion cgroupv1.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import (
"tailscale.com/types/ptr"
)

// Paths for CGroupV1.
// Paths for CgroupV1.
// Ref: https://www.kernel.org/doc/Documentation/cgroup-v1/cpuacct.txt
const (
// CPU usage of all tasks in cgroup in nanoseconds.
Expand Down
2 changes: 1 addition & 1 deletion cgroupv2.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import (
"tailscale.com/types/ptr"
)

// Paths for CGroupV2.
// Paths for CgroupV2.
// Ref: https://docs.kernel.org/admin-guide/cgroup-v2.html
const (
// Contains quota and period in microseconds separated by a space.
Expand Down
4 changes: 2 additions & 2 deletions stat.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ func New(opts ...Option) (*Statter, error) {
<-time.After(d)
},
cgroupV2Detector: func(_ afero.Fs) bool {
return isCGroupV2(cgroupRootPath)
return isCgroupV2(cgroupRootPath)
},
}
for _, opt := range opts {
Expand All @@ -202,7 +202,7 @@ func New(opts ...Option) (*Statter, error) {

s.nproc = s.numCPU()

statter, err := s.getCGroupStatter()
statter, err := s.getCgroupStatter()
if err != nil && !errors.Is(err, errNotContainerized) {
return nil, xerrors.Errorf("get cgroup statter: %v", err)
}
Expand Down
46 changes: 23 additions & 23 deletions stat_internal_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ func TestStatter(t *testing.T) {
}
}

withIsCGroupV2 := func(state bool) Option {
withIsCgroupV2 := func(state bool) Option {
return func(s *Statter) {
s.cgroupV2Detector = func(_ afero.Fs) bool {
return state
Expand All @@ -143,7 +143,7 @@ func TestStatter(t *testing.T) {
// For container-specific measurements, everything we need
// can be read from the filesystem. We control the FS, so
// we control the data.
t.Run("CGroupV1", func(t *testing.T) {
t.Run("CgroupV1", func(t *testing.T) {
t.Parallel()

t.Run("ContainerCPU/Limit", func(t *testing.T) {
Expand All @@ -154,7 +154,7 @@ func TestStatter(t *testing.T) {
// Fake 1 second in ns of usage
mungeFS(t, fs, cgroupV1CPUAcctUsage, "100000000")
}
s, err := New(WithFS(fs), withWait(fakeWait), withIsCGroupV2(false))
s, err := New(WithFS(fs), withWait(fakeWait), withIsCgroupV2(false))
require.NoError(t, err)

cpu, err := s.ContainerCPU()
Expand All @@ -175,7 +175,7 @@ func TestStatter(t *testing.T) {
// Fake 1 second in ns of usage
mungeFS(t, fs, cgroupV1CPUAcctUsage, "100000000")
}
s, err := New(WithFS(fs), withNproc(2), withWait(fakeWait), withIsCGroupV2(false))
s, err := New(WithFS(fs), withNproc(2), withWait(fakeWait), withIsCgroupV2(false))
require.NoError(t, err)

cpu, err := s.ContainerCPU()
Expand All @@ -195,7 +195,7 @@ func TestStatter(t *testing.T) {
// Fake 1 second in ns of usage
mungeFS(t, fs, "/sys/fs/cgroup/cpuacct/cpuacct.usage", "100000000")
}
s, err := New(WithFS(fs), withNproc(2), withWait(fakeWait), withIsCGroupV2(false))
s, err := New(WithFS(fs), withNproc(2), withWait(fakeWait), withIsCgroupV2(false))
require.NoError(t, err)

cpu, err := s.ContainerCPU()
Expand All @@ -212,7 +212,7 @@ func TestStatter(t *testing.T) {
t.Parallel()

fs := initFS(t, fsContainerCgroupV1)
s, err := New(WithFS(fs), withNoWait, withIsCGroupV2(false))
s, err := New(WithFS(fs), withNoWait, withIsCgroupV2(false))
require.NoError(t, err)

mem, err := s.ContainerMemory(PrefixDefault)
Expand All @@ -229,7 +229,7 @@ func TestStatter(t *testing.T) {
t.Parallel()

fs := initFS(t, fsContainerCgroupV1NoLimit)
s, err := New(WithFS(fs), withNoWait, withIsCGroupV2(false))
s, err := New(WithFS(fs), withNoWait, withIsCgroupV2(false))
require.NoError(t, err)

mem, err := s.ContainerMemory(PrefixDefault)
Expand All @@ -245,7 +245,7 @@ func TestStatter(t *testing.T) {
t.Parallel()

fs := initFS(t, fsContainerCgroupV1DockerNoMemoryLimit)
s, err := New(WithFS(fs), withNoWait, withIsCGroupV2(false))
s, err := New(WithFS(fs), withNoWait, withIsCgroupV2(false))
require.NoError(t, err)

mem, err := s.ContainerMemory(PrefixDefault)
Expand All @@ -258,7 +258,7 @@ func TestStatter(t *testing.T) {
})
})

t.Run("CGroupV2", func(t *testing.T) {
t.Run("CgroupV2", func(t *testing.T) {
t.Parallel()

t.Run("ContainerCPU/Limit", func(t *testing.T) {
Expand All @@ -268,7 +268,7 @@ func TestStatter(t *testing.T) {
fakeWait := func(time.Duration) {
mungeFS(t, fs, filepath.Join(cgroupRootPath, cgroupV2Path, cgroupV2CPUStat), "usage_usec 100000")
}
s, err := New(WithFS(fs), withWait(fakeWait), withIsCGroupV2(true))
s, err := New(WithFS(fs), withWait(fakeWait), withIsCgroupV2(true))

require.NoError(t, err)
cpu, err := s.ContainerCPU()
Expand All @@ -288,7 +288,7 @@ func TestStatter(t *testing.T) {
fakeWait := func(time.Duration) {
mungeFS(t, fs, filepath.Join(cgroupRootPath, cgroupV2Path, cgroupV2CPUStat), "usage_usec 100000")
}
s, err := New(WithFS(fs), withNproc(2), withWait(fakeWait), withIsCGroupV2(true))
s, err := New(WithFS(fs), withNproc(2), withWait(fakeWait), withIsCgroupV2(true))
require.NoError(t, err)

cpu, err := s.ContainerCPU()
Expand All @@ -304,7 +304,7 @@ func TestStatter(t *testing.T) {
t.Parallel()

fs := initFS(t, fsContainerCgroupV2)
s, err := New(WithFS(fs), withNoWait, withIsCGroupV2(true))
s, err := New(WithFS(fs), withNoWait, withIsCgroupV2(true))
require.NoError(t, err)

mem, err := s.ContainerMemory(PrefixDefault)
Expand All @@ -321,7 +321,7 @@ func TestStatter(t *testing.T) {
t.Parallel()

fs := initFS(t, fsContainerCgroupV2NoLimit)
s, err := New(WithFS(fs), withNoWait, withIsCGroupV2(true))
s, err := New(WithFS(fs), withNoWait, withIsCgroupV2(true))
require.NoError(t, err)

mem, err := s.ContainerMemory(PrefixDefault)
Expand All @@ -343,7 +343,7 @@ func TestStatter(t *testing.T) {
fakeWait := func(time.Duration) {
mungeFS(t, fs, filepath.Join(cgroupRootPath, fsContainerCgroupV2KubernetesPath, cgroupV2CPUStat), "usage_usec 100000")
}
s, err := New(WithFS(fs), withWait(fakeWait), withIsCGroupV2(true))
s, err := New(WithFS(fs), withWait(fakeWait), withIsCgroupV2(true))
require.NoError(t, err)

cpu, err := s.ContainerCPU()
Expand All @@ -364,7 +364,7 @@ func TestStatter(t *testing.T) {
fakeWait := func(time.Duration) {
mungeFS(t, fs, filepath.Join(cgroupRootPath, fsContainerCgroupV2KubernetesPath, cgroupV2CPUStat), "usage_usec 100000")
}
s, err := New(WithFS(fs), withWait(fakeWait), withIsCGroupV2(true))
s, err := New(WithFS(fs), withWait(fakeWait), withIsCgroupV2(true))
require.NoError(t, err)

cpu, err := s.ContainerCPU()
Expand All @@ -384,7 +384,7 @@ func TestStatter(t *testing.T) {
fakeWait := func(time.Duration) {
mungeFS(t, fs, filepath.Join(cgroupRootPath, fsContainerCgroupV2KubernetesPath, cgroupV2CPUStat), "usage_usec 100000")
}
s, err := New(WithFS(fs), withWait(fakeWait), withIsCGroupV2(true))
s, err := New(WithFS(fs), withWait(fakeWait), withIsCgroupV2(true))
require.NoError(t, err)

cpu, err := s.ContainerCPU()
Expand All @@ -400,7 +400,7 @@ func TestStatter(t *testing.T) {
t.Parallel()

fs := initFS(t, fsContainerCgroupV2KubernetesWithLimits)
s, err := New(WithFS(fs), withNoWait, withIsCGroupV2(true))
s, err := New(WithFS(fs), withNoWait, withIsCgroupV2(true))
require.NoError(t, err)

mem, err := s.ContainerMemory(PrefixDefault)
Expand All @@ -419,7 +419,7 @@ func TestStatter(t *testing.T) {
fs := initFS(t, fsContainerCgroupV2Kubernetes)
mungeFS(t, fs, filepath.Join(cgroupRootPath, cgroupV2MemoryMaxBytes), "1073741824")

s, err := New(WithFS(fs), withNoWait, withIsCGroupV2(true))
s, err := New(WithFS(fs), withNoWait, withIsCgroupV2(true))
require.NoError(t, err)

mem, err := s.ContainerMemory(PrefixDefault)
Expand All @@ -436,7 +436,7 @@ func TestStatter(t *testing.T) {
t.Parallel()

fs := initFS(t, fsContainerCgroupV2Kubernetes)
s, err := New(WithFS(fs), withNoWait, withIsCGroupV2(true))
s, err := New(WithFS(fs), withNoWait, withIsCgroupV2(true))
require.NoError(t, err)

mem, err := s.ContainerMemory(PrefixDefault)
Expand All @@ -451,10 +451,10 @@ func TestStatter(t *testing.T) {
})
}

func TestCGroupV2Detection(t *testing.T) {
func TestCgroupV2Detection(t *testing.T) {
t.Parallel()

hostISCGroupV2 := os.Getenv("CLISTAT_IS_CGROUPV2") == "yes"
hostIsCgroupV2 := os.Getenv("CLISTAT_IS_CGROUPV2") == "yes"

tests := []struct {
name string
Expand All @@ -477,8 +477,8 @@ func TestCGroupV2Detection(t *testing.T) {
s, err := New(WithFS(tt.fs))
require.NoError(t, err)

isCGroupV2 := s.cgroupV2Detector(s.fs)
assert.Equal(t, hostISCGroupV2, isCGroupV2)
isCgroupV2 := s.cgroupV2Detector(s.fs)
assert.Equal(t, hostIsCgroupV2, isCgroupV2)
})
}
}
Expand Down
Loading