Files
visor/runsc/cmd/read_control.go
Shailend ChandandgVisor bot 8d0941cd22 Support cgroup2 queries from outside the sandbox
Much like how cgroup v1 control files are already queryable. "runsc events"
now consults cgroup2 control files when --mount-cgroup-v2 is true, for cpu
and memory usage stats.

Currently runsc does not place each in-sandbox container is its own cgroup2
node like it does with cgroup v1, hence we just test queries against the root
cgroup2 node for now.

PiperOrigin-RevId: 950984770
2026-07-20 12:24:23 -07:00

101 lines
3.1 KiB
Go

// Copyright 2022 The gVisor Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package cmd
import (
"context"
"fmt"
"github.com/google/subcommands"
specs "github.com/opencontainers/runtime-spec/specs-go"
"gvisor.dev/gvisor/pkg/sentry/control"
"gvisor.dev/gvisor/runsc/cmd/util"
"gvisor.dev/gvisor/runsc/config"
"gvisor.dev/gvisor/runsc/container"
"gvisor.dev/gvisor/runsc/flag"
)
// ReadControl implements subcommands.Command for the "read-control" command.
type ReadControl struct {
containerLoader
}
// Name implements subcommands.Command.Name.
func (*ReadControl) Name() string {
return "read-control"
}
// Synopsis implements subcommands.Command.Synopsis.
func (*ReadControl) Synopsis() string {
return "read a cgroups control value inside the container"
}
// Usage implements subcommands.Command.Usage.
func (*ReadControl) Usage() string {
return `read-control <container-id> <controller> <cgroup-path> <control-value-name>
Where "<container-id>" is the name for the instance of the container,
"<controller>" is the name of an active cgroup controller (used for cgroup v1
hierarchies; ignored for cgroup v2 unified hierarchy), <cgroup-path> is the path
to the cgroup to read and <control-value-name> is the name of the control file
to read.
EXAMPLE:
# cgroup v1:
# runsc read-control <container-id> cpuacct / cpuacct.usage
# cgroup v2:
# runsc read-control <container-id> memory / memory.current
# runsc read-control <container-id> cpu / cpu.stat
`
}
// SetFlags implements subcommands.Command.SetFlags.
func (r *ReadControl) SetFlags(f *flag.FlagSet) {}
// FetchSpec implements util.SubCommand.FetchSpec.
func (r *ReadControl) FetchSpec(conf *config.Config, f *flag.FlagSet) (string, *specs.Spec, error) {
c, err := r.loadContainer(conf, f, container.LoadOpts{SkipCheck: true})
if err != nil {
return "", nil, fmt.Errorf("loading container: %w", err)
}
return c.ID, c.Spec, nil
}
// Execute implements subcommands.Command.Execute.
func (r *ReadControl) Execute(_ context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus {
if f.NArg() != 4 {
f.Usage()
return subcommands.ExitUsageError
}
conf := args[0].(*config.Config)
c, err := r.loadContainer(conf, f, container.LoadOpts{SkipCheck: true})
if err != nil {
util.Fatalf("loading container: %v", err)
}
out, err := c.Sandbox.CgroupsReadControlFile(control.CgroupControlFile{
Controller: f.Arg(1),
Path: f.Arg(2),
Name: f.Arg(3),
})
if err != nil {
fmt.Printf("ERROR: %s\n", err)
return subcommands.ExitFailure
}
fmt.Printf("%s\n", out)
return subcommands.ExitSuccess
}