1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945
|
// Copyright 2018 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 cgroup provides an interface to read and write configuration to
// cgroup.
package cgroup
import (
"bufio"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"io/ioutil"
"os"
"path/filepath"
"strconv"
"strings"
"time"
"github.com/cenkalti/backoff"
specs "github.com/opencontainers/runtime-spec/specs-go"
"golang.org/x/sync/errgroup"
"golang.org/x/sys/unix"
"gvisor.dev/gvisor/pkg/cleanup"
"gvisor.dev/gvisor/pkg/log"
)
const (
cgroupv1FsName = "cgroup"
cgroupv2FsName = "cgroup2"
// procRoot is the procfs root this module uses.
procRoot = "/proc"
// cgroupRoot is the cgroupfs root this module uses.
cgroupRoot = "/sys/fs/cgroup"
)
var controllers = map[string]controller{
"blkio": &blockIO{},
"cpu": &cpu{},
"cpuset": &cpuSet{},
"hugetlb": &hugeTLB{},
"memory": &memory{},
"net_cls": &networkClass{},
"net_prio": &networkPrio{},
"pids": &pids{},
// These controllers either don't have anything in the OCI spec or is
// irrelevant for a sandbox.
"cpuacct": &noop{},
"devices": &noop{},
"freezer": &noop{},
"perf_event": &noop{},
"rdma": &noop{},
"systemd": &noop{},
}
// IsOnlyV2 checks whether cgroups V2 is enabled and V1 is not.
func IsOnlyV2() bool {
var stat unix.Statfs_t
if err := unix.Statfs(cgroupRoot, &stat); err != nil {
// It's not used for anything important, assume not V2 on failure.
return false
}
return stat.Type == unix.CGROUP2_SUPER_MAGIC
}
func setOptionalValueInt(path, name string, val *int64) error {
if val == nil || *val == 0 {
return nil
}
str := strconv.FormatInt(*val, 10)
return setValue(path, name, str)
}
func setOptionalValueUint(path, name string, val *uint64) error {
if val == nil || *val == 0 {
return nil
}
str := strconv.FormatUint(*val, 10)
return setValue(path, name, str)
}
func setOptionalValueUint32(path, name string, val *uint32) error {
if val == nil || *val == 0 {
return nil
}
str := strconv.FormatUint(uint64(*val), 10)
return setValue(path, name, str)
}
func setOptionalValueUint16(path, name string, val *uint16) error {
if val == nil || *val == 0 {
return nil
}
str := strconv.FormatUint(uint64(*val), 10)
return setValue(path, name, str)
}
func setValue(path, name, data string) error {
fullpath := filepath.Join(path, name)
log.Debugf("Setting %q to %q", fullpath, data)
return writeFile(fullpath, []byte(data), 0700)
}
// writeFile is similar to ioutil.WriteFile() but doesn't create the file if it
// doesn't exist.
func writeFile(path string, data []byte, perm os.FileMode) error {
f, err := os.OpenFile(path, os.O_WRONLY|os.O_TRUNC, perm)
if err != nil {
return err
}
defer f.Close()
_, err = f.Write(data)
return err
}
func getValue(path, name string) (string, error) {
fullpath := filepath.Join(path, name)
out, err := ioutil.ReadFile(fullpath)
if err != nil {
return "", err
}
return string(out), nil
}
func getInt(path, name string) (int, error) {
s, err := getValue(path, name)
if err != nil {
return 0, err
}
return strconv.Atoi(strings.TrimSpace(s))
}
// fillFromAncestor sets the value of a cgroup file from the first ancestor
// that has content. It does nothing if the file in 'path' has already been set.
func fillFromAncestor(path string) (string, error) {
out, err := ioutil.ReadFile(path)
if err != nil {
return "", err
}
val := strings.TrimSpace(string(out))
if val != "" {
// File is set, stop here.
return val, nil
}
// File is not set, recurse to parent and then set here.
name := filepath.Base(path)
parent := filepath.Dir(filepath.Dir(path))
val, err = fillFromAncestor(filepath.Join(parent, name))
if err != nil {
return "", err
}
if err := writeFile(path, []byte(val), 0700); err != nil {
return "", nil
}
return val, nil
}
// countCpuset returns the number of CPU in a string formatted like:
//
// "0-2,7,12-14 # bits 0, 1, 2, 7, 12, 13, and 14 set" - man 7 cpuset
func countCpuset(cpuset string) (int, error) {
var count int
for _, p := range strings.Split(cpuset, ",") {
interval := strings.Split(p, "-")
switch len(interval) {
case 1:
if _, err := strconv.Atoi(interval[0]); err != nil {
return 0, err
}
count++
case 2:
start, err := strconv.Atoi(interval[0])
if err != nil {
return 0, err
}
end, err := strconv.Atoi(interval[1])
if err != nil {
return 0, err
}
if start < 0 || end < 0 || start > end {
return 0, fmt.Errorf("invalid cpuset: %q", p)
}
count += end - start + 1
default:
return 0, fmt.Errorf("invalid cpuset: %q", p)
}
}
return count, nil
}
// loadPaths loads cgroup paths for given 'pid', may be set to 'self'.
func loadPaths(pid string) (map[string]string, error) {
procCgroup, err := os.Open(filepath.Join(procRoot, pid, "cgroup"))
if err != nil {
return nil, err
}
defer procCgroup.Close()
// Load mountinfo for the current process, because it's where cgroups is
// being accessed from.
mountinfo, err := os.Open(filepath.Join(procRoot, "self/mountinfo"))
if err != nil {
return nil, err
}
defer mountinfo.Close()
return loadPathsHelper(procCgroup, mountinfo, IsOnlyV2())
}
func loadPathsHelper(cgroup, mountinfo io.Reader, unified bool) (map[string]string, error) {
paths := make(map[string]string)
scanner := bufio.NewScanner(cgroup)
for scanner.Scan() {
// Format: ID:[name=]controller1,controller2:path
// Example: 2:cpu,cpuacct:/user.slice
tokens := strings.Split(scanner.Text(), ":")
if len(tokens) != 3 {
return nil, fmt.Errorf("invalid cgroups file, line: %q", scanner.Text())
}
if len(tokens[1]) == 0 && unified {
paths[cgroup2Key] = tokens[2]
continue
}
if len(tokens[1]) == 0 {
continue
}
for _, ctrlr := range strings.Split(tokens[1], ",") {
// Remove prefix for cgroups with no controller, eg. systemd.
ctrlr = strings.TrimPrefix(ctrlr, "name=")
// Discard unknown controllers.
if _, ok := controllers[ctrlr]; ok {
paths[ctrlr] = tokens[2]
}
}
}
if err := scanner.Err(); err != nil {
return nil, err
}
// For nested containers, in /proc/[pid]/cgroup we see paths from host,
// which don't exist in container, so recover the container paths here by
// double-checking with /proc/[pid]/mountinfo
mountScanner := bufio.NewScanner(mountinfo)
haveCg2Path := false
for mountScanner.Scan() {
// Format: ID parent major:minor root mount-point options opt-fields - fs-type source super-options
// Example: 39 32 0:34 / /sys/fs/cgroup/devices rw,noexec shared:18 - cgroup cgroup rw,devices
fields := strings.Fields(mountScanner.Text())
if len(fields) < 9 {
// Skip mounts that are not cgroup mounts.
continue
}
switch fields[len(fields)-3] {
case cgroupv1FsName:
// Cgroup controller type is in the super-options field.
superOptions := strings.Split(fields[len(fields)-1], ",")
for _, opt := range superOptions {
// Remove prefix for cgroups with no controller, eg. systemd.
opt = strings.TrimPrefix(opt, "name=")
// Only considers cgroup controllers that are registered, and skip other
// irrelevant options, e.g. rw.
if cgroupPath, ok := paths[opt]; ok {
rootDir := fields[3]
if rootDir != "/" {
// When cgroup is in submount, remove repeated path components from
// cgroup path to avoid duplicating them.
relCgroupPath, err := filepath.Rel(rootDir, cgroupPath)
if err != nil {
return nil, err
}
paths[opt] = relCgroupPath
}
}
}
case cgroupv2FsName:
if cgroupPath, ok := paths[cgroup2Key]; !haveCg2Path && ok {
root := fields[3]
relCgroupPath, err := filepath.Rel(root, cgroupPath)
if err != nil {
return nil, err
}
haveCg2Path = true
paths[cgroup2Key] = relCgroupPath
}
}
}
if err := mountScanner.Err(); err != nil {
return nil, err
}
return paths, nil
}
// Cgroup represents a cgroup configuration.
type Cgroup interface {
Install(res *specs.LinuxResources) error
Uninstall() error
Join() (func(), error)
CPUQuota() (float64, error)
CPUUsage() (uint64, error)
NumCPU() (int, error)
MemoryLimit() (uint64, error)
MakePath(controllerName string) string
}
// cgroupV1 represents a group inside all controllers. For example:
//
// Name='/foo/bar' maps to /sys/fs/cgroup/<controller>/foo/bar on
// all controllers.
//
// If Name is relative, it uses the parent cgroup path to determine the
// location. For example:
//
// Name='foo/bar' and Parent[ctrl]="/user.slice", then it will map to
// /sys/fs/cgroup/<ctrl>/user.slice/foo/bar
type cgroupV1 struct {
Name string `json:"name"`
Parents map[string]string `json:"parents"`
Own map[string]bool `json:"own"`
}
// NewFromSpec creates a new Cgroup instance if the spec includes a cgroup path.
// Returns nil otherwise. Cgroup paths are loaded based on the current process.
// If useSystemd is true, the Cgroup will be created and managed with
// systemd. This requires systemd (>=v244) to be running on the host and the
// cgroup path to be in the form `slice:prefix:name`.
func NewFromSpec(spec *specs.Spec, useSystemd bool) (Cgroup, error) {
if spec.Linux == nil || spec.Linux.CgroupsPath == "" {
return nil, nil
}
return NewFromPath(spec.Linux.CgroupsPath, useSystemd)
}
// NewFromPath creates a new Cgroup instance from the specified relative path.
// Cgroup paths are loaded based on the current process.
// If useSystemd is true, the Cgroup will be created and managed with
// systemd. This requires systemd (>=v244) to be running on the host and the
// cgroup path to be in the form `slice:prefix:name`.
func NewFromPath(cgroupsPath string, useSystemd bool) (Cgroup, error) {
return new("self", cgroupsPath, useSystemd)
}
// NewFromPid loads cgroup for the given process.
// If useSystemd is true, the Cgroup will be created and managed with
// systemd. This requires systemd (>=v244) to be running on the host and the
// cgroup path to be in the form `slice:prefix:name`.
func NewFromPid(pid int, useSystemd bool) (Cgroup, error) {
return new(strconv.Itoa(pid), "", useSystemd)
}
func new(pid, cgroupsPath string, useSystemd bool) (Cgroup, error) {
var (
parents map[string]string
err error
cg Cgroup
)
// If path is relative, load cgroup paths for the process to build the
// relative paths.
if !filepath.IsAbs(cgroupsPath) {
parents, err = loadPaths(pid)
if err != nil {
return nil, fmt.Errorf("finding current cgroups: %w", err)
}
}
if IsOnlyV2() {
// The cgroupsPath is in a special `slice:prefix:name` format for systemd
// that should not be modified.
if p, ok := parents[cgroup2Key]; ok && !useSystemd {
// The cgroup of current pid will have tasks in it and we can't use
// that, instead, use the its parent which should not have tasks in it.
cgroupsPath = filepath.Join(filepath.Dir(p), cgroupsPath)
}
// Assume that for v2, cgroup is always mounted at cgroupRoot.
cg, err = newCgroupV2(cgroupRoot, cgroupsPath, useSystemd)
if err != nil {
return nil, err
}
} else {
cg = &cgroupV1{
Name: cgroupsPath,
Parents: parents,
Own: make(map[string]bool),
}
}
log.Debugf("New cgroup for pid: %s, %T: %+v", pid, cg, cg)
return cg, nil
}
// CgroupJSON is a wrapper for Cgroup that can be encoded to JSON.
type CgroupJSON struct {
Cgroup Cgroup
}
type cgroupJSONv1 struct {
Cgroup *cgroupV1 `json:"cgroupv1"`
}
type cgroupJSONv2 struct {
Cgroup *cgroupV2 `json:"cgroupv2"`
}
type cgroupJSONSystemd struct {
Cgroup *cgroupSystemd `json:"cgroupsystemd"`
}
type cgroupJSONUnknown struct {
Cgroup any `json:"cgroupunknown"`
}
// UnmarshalJSON implements json.Unmarshaler.UnmarshalJSON
func (c *CgroupJSON) UnmarshalJSON(data []byte) error {
m := map[string]json.RawMessage{}
if err := json.Unmarshal(data, &m); err != nil {
return err
}
var cg Cgroup
if rm, ok := m["cgroupv1"]; ok {
cg = &cgroupV1{}
if err := json.Unmarshal(rm, cg); err != nil {
return err
}
} else if rm, ok := m["cgroupv2"]; ok {
cg = &cgroupV2{}
if err := json.Unmarshal(rm, cg); err != nil {
return err
}
} else if rm, ok := m["cgroupsystemd"]; ok {
cg = &cgroupSystemd{}
if err := json.Unmarshal(rm, cg); err != nil {
return err
}
}
c.Cgroup = cg
return nil
}
// MarshalJSON implements json.Marshaler.MarshalJSON
func (c *CgroupJSON) MarshalJSON() ([]byte, error) {
if c.Cgroup == nil {
return json.Marshal(cgroupJSONUnknown{})
}
switch c.Cgroup.(type) {
case *cgroupV1:
return json.Marshal(cgroupJSONv1{Cgroup: c.Cgroup.(*cgroupV1)})
case *cgroupV2:
return json.Marshal(cgroupJSONv2{Cgroup: c.Cgroup.(*cgroupV2)})
case *cgroupSystemd:
return json.Marshal(cgroupJSONSystemd{Cgroup: c.Cgroup.(*cgroupSystemd)})
}
return nil, nil
}
// Install creates and configures cgroups according to 'res'. If cgroup path
// already exists, it means that the caller has already provided a
// pre-configured cgroups, and 'res' is ignored.
func (c *cgroupV1) Install(res *specs.LinuxResources) error {
log.Debugf("Installing cgroup path %q", c.Name)
// Clean up partially created cgroups on error. Errors during cleanup itself
// are ignored.
clean := cleanup.Make(func() { _ = c.Uninstall() })
defer clean.Clean()
// Controllers can be symlinks to a group of controllers (e.g. cpu,cpuacct).
// So first check what directories need to be created. Otherwise, when
// the directory for one of the controllers in a group is created, it will
// make it seem like the directory already existed and it's not owned by the
// other controllers in the group.
var missing []string
for key := range controllers {
path := c.MakePath(key)
if _, err := os.Stat(path); err != nil {
missing = append(missing, key)
} else {
log.Debugf("Using pre-created cgroup %q: %q", key, path)
}
}
for _, key := range missing {
ctrlr := controllers[key]
if skip, err := createController(c, key); skip && ctrlr.optional() {
if err := ctrlr.skip(res); err != nil {
return err
}
log.Infof("Skipping cgroup %q, err: %v", key, err)
continue
} else if err != nil {
return err
}
// Only set controllers that were created by me.
c.Own[key] = true
path := c.MakePath(key)
if err := ctrlr.set(res, path); err != nil {
return err
}
}
clean.Release()
return nil
}
// createController creates the controller directory, checking that the
// controller is enabled in the system. It returns a boolean indicating whether
// the controller should be skipped (e.g. controller is disabled). In case it
// should be skipped, it also returns the error it got.
func createController(c Cgroup, name string) (bool, error) {
ctrlrPath := filepath.Join(cgroupRoot, name)
if _, err := os.Stat(ctrlrPath); err != nil {
return os.IsNotExist(err), err
}
path := c.MakePath(name)
log.Debugf("Creating cgroup %q: %q", name, path)
if err := os.MkdirAll(path, 0755); err != nil {
return errors.Is(err, unix.EROFS), err
}
return false, nil
}
// Uninstall removes the settings done in Install(). If cgroup path already
// existed when Install() was called, Uninstall is a noop.
func (c *cgroupV1) Uninstall() error {
log.Debugf("Deleting cgroup %q", c.Name)
g, ctx := errgroup.WithContext(context.Background())
for key := range controllers {
if !c.Own[key] {
// cgroup is managed by caller, don't touch it.
continue
}
path := c.MakePath(key)
log.Debugf("Removing cgroup controller for key=%q path=%q", key, path)
// If we try to remove the cgroup too soon after killing the sandbox we
// might get EBUSY, so we retry for a few seconds until it succeeds.
ctx, cancel := context.WithTimeout(ctx, 5*time.Second)
defer cancel()
b := backoff.WithContext(backoff.NewConstantBackOff(100*time.Millisecond), ctx)
fn := func() error {
err := unix.Rmdir(path)
if os.IsNotExist(err) {
return nil
}
return err
}
// Run deletions in parallel to remove all directories even if there are
// failures/timeouts in other directories.
g.Go(func() error {
if err := backoff.Retry(fn, b); err != nil {
return fmt.Errorf("removing cgroup path %q: %w", path, err)
}
return nil
})
}
return g.Wait()
}
// Join adds the current process to the all controllers. Returns function that
// restores cgroup to the original state.
func (c *cgroupV1) Join() (func(), error) {
// First save the current state so it can be restored.
paths, err := loadPaths("self")
if err != nil {
return nil, err
}
var undoPaths []string
for ctrlr, path := range paths {
// Skip controllers we don't handle.
if _, ok := controllers[ctrlr]; ok {
fullPath := filepath.Join(cgroupRoot, ctrlr, path)
undoPaths = append(undoPaths, fullPath)
}
}
cu := cleanup.Make(func() {
for _, path := range undoPaths {
log.Debugf("Restoring cgroup %q", path)
// Writing the value 0 to a cgroup.procs file causes
// the writing process to be moved to the corresponding
// cgroup. - cgroups(7).
if err := setValue(path, "cgroup.procs", "0"); err != nil {
log.Warningf("Error restoring cgroup %q: %v", path, err)
}
}
})
defer cu.Clean()
// Now join the cgroups.
for key, ctrlr := range controllers {
path := c.MakePath(key)
log.Debugf("Joining cgroup %q", path)
// Writing the value 0 to a cgroup.procs file causes the writing process to
// be moved to the corresponding cgroup - cgroups(7).
if err := setValue(path, "cgroup.procs", "0"); err != nil {
if ctrlr.optional() && os.IsNotExist(err) {
continue
}
return nil, err
}
}
return cu.Release(), nil
}
// CPUQuota returns the CFS CPU quota.
func (c *cgroupV1) CPUQuota() (float64, error) {
path := c.MakePath("cpu")
quota, err := getInt(path, "cpu.cfs_quota_us")
if err != nil {
return -1, err
}
period, err := getInt(path, "cpu.cfs_period_us")
if err != nil {
return -1, err
}
if quota <= 0 || period <= 0 {
return -1, err
}
return float64(quota) / float64(period), nil
}
// CPUUsage returns the total CPU usage of the cgroup.
func (c *cgroupV1) CPUUsage() (uint64, error) {
path := c.MakePath("cpuacct")
usage, err := getValue(path, "cpuacct.usage")
if err != nil {
return 0, err
}
return strconv.ParseUint(strings.TrimSpace(usage), 10, 64)
}
// NumCPU returns the number of CPUs configured in 'cpuset/cpuset.cpus'.
func (c *cgroupV1) NumCPU() (int, error) {
path := c.MakePath("cpuset")
cpuset, err := getValue(path, "cpuset.cpus")
if err != nil {
return 0, err
}
return countCpuset(strings.TrimSpace(cpuset))
}
// MemoryLimit returns the memory limit.
func (c *cgroupV1) MemoryLimit() (uint64, error) {
path := c.MakePath("memory")
limStr, err := getValue(path, "memory.limit_in_bytes")
if err != nil {
return 0, err
}
return strconv.ParseUint(strings.TrimSpace(limStr), 10, 64)
}
// MakePath builds a path to the given controller.
func (c *cgroupV1) MakePath(controllerName string) string {
path := c.Name
if parent, ok := c.Parents[controllerName]; ok {
path = filepath.Join(parent, c.Name)
}
return filepath.Join(cgroupRoot, controllerName, path)
}
type controller interface {
// optional controllers don't fail if not found.
optional() bool
// set applies resource limits to controller.
set(*specs.LinuxResources, string) error
// skip is called when controller is not found to check if it can be safely
// skipped or not based on the spec.
skip(*specs.LinuxResources) error
}
type noop struct{}
func (n *noop) optional() bool {
return true
}
func (*noop) set(*specs.LinuxResources, string) error {
return nil
}
func (n *noop) skip(*specs.LinuxResources) error {
return nil
}
type mandatory struct{}
func (*mandatory) optional() bool {
return false
}
func (*mandatory) skip(*specs.LinuxResources) error {
panic("cgroup controller is not optional")
}
type memory struct {
mandatory
}
func (*memory) set(spec *specs.LinuxResources, path string) error {
if spec == nil || spec.Memory == nil {
return nil
}
if err := setOptionalValueInt(path, "memory.limit_in_bytes", spec.Memory.Limit); err != nil {
return err
}
if err := setOptionalValueInt(path, "memory.soft_limit_in_bytes", spec.Memory.Reservation); err != nil {
return err
}
if err := setOptionalValueInt(path, "memory.memsw.limit_in_bytes", spec.Memory.Swap); err != nil {
return err
}
if err := setOptionalValueInt(path, "memory.kmem.limit_in_bytes", spec.Memory.Kernel); err != nil {
return err
}
if err := setOptionalValueInt(path, "memory.kmem.tcp.limit_in_bytes", spec.Memory.KernelTCP); err != nil {
return err
}
if err := setOptionalValueUint(path, "memory.swappiness", spec.Memory.Swappiness); err != nil {
return err
}
if spec.Memory.DisableOOMKiller != nil && *spec.Memory.DisableOOMKiller {
if err := setValue(path, "memory.oom_control", "1"); err != nil {
return err
}
}
return nil
}
type cpu struct {
mandatory
}
func (*cpu) set(spec *specs.LinuxResources, path string) error {
if spec == nil || spec.CPU == nil {
return nil
}
if err := setOptionalValueUint(path, "cpu.shares", spec.CPU.Shares); err != nil {
return err
}
if err := setOptionalValueInt(path, "cpu.cfs_quota_us", spec.CPU.Quota); err != nil {
return err
}
if err := setOptionalValueUint(path, "cpu.cfs_period_us", spec.CPU.Period); err != nil {
return err
}
if err := setOptionalValueUint(path, "cpu.rt_period_us", spec.CPU.RealtimePeriod); err != nil {
return err
}
return setOptionalValueInt(path, "cpu.rt_runtime_us", spec.CPU.RealtimeRuntime)
}
type cpuSet struct {
mandatory
}
func (*cpuSet) set(spec *specs.LinuxResources, path string) error {
// cpuset.cpus and mems are required fields, but are not set on a new cgroup.
// If not set in the spec, get it from one of the ancestors cgroup.
if spec == nil || spec.CPU == nil || spec.CPU.Cpus == "" {
if _, err := fillFromAncestor(filepath.Join(path, "cpuset.cpus")); err != nil {
return err
}
} else {
if err := setValue(path, "cpuset.cpus", spec.CPU.Cpus); err != nil {
return err
}
}
if spec == nil || spec.CPU == nil || spec.CPU.Mems == "" {
_, err := fillFromAncestor(filepath.Join(path, "cpuset.mems"))
return err
}
return setValue(path, "cpuset.mems", spec.CPU.Mems)
}
type blockIO struct {
mandatory
}
func (*blockIO) set(spec *specs.LinuxResources, path string) error {
if spec == nil || spec.BlockIO == nil {
return nil
}
if err := setOptionalValueUint16(path, "blkio.weight", spec.BlockIO.Weight); err != nil {
return err
}
if err := setOptionalValueUint16(path, "blkio.leaf_weight", spec.BlockIO.LeafWeight); err != nil {
return err
}
for _, dev := range spec.BlockIO.WeightDevice {
if dev.Weight != nil {
val := fmt.Sprintf("%d:%d %d", dev.Major, dev.Minor, *dev.Weight)
if err := setValue(path, "blkio.weight_device", val); err != nil {
return err
}
}
if dev.LeafWeight != nil {
val := fmt.Sprintf("%d:%d %d", dev.Major, dev.Minor, *dev.LeafWeight)
if err := setValue(path, "blkio.leaf_weight_device", val); err != nil {
return err
}
}
}
if err := setThrottle(path, "blkio.throttle.read_bps_device", spec.BlockIO.ThrottleReadBpsDevice); err != nil {
return err
}
if err := setThrottle(path, "blkio.throttle.write_bps_device", spec.BlockIO.ThrottleWriteBpsDevice); err != nil {
return err
}
if err := setThrottle(path, "blkio.throttle.read_iops_device", spec.BlockIO.ThrottleReadIOPSDevice); err != nil {
return err
}
return setThrottle(path, "blkio.throttle.write_iops_device", spec.BlockIO.ThrottleWriteIOPSDevice)
}
func setThrottle(path, name string, devs []specs.LinuxThrottleDevice) error {
for _, dev := range devs {
val := fmt.Sprintf("%d:%d %d", dev.Major, dev.Minor, dev.Rate)
if err := setValue(path, name, val); err != nil {
return err
}
}
return nil
}
type networkClass struct{}
func (*networkClass) optional() bool {
return true
}
func (*networkClass) set(spec *specs.LinuxResources, path string) error {
if spec == nil || spec.Network == nil {
return nil
}
return setOptionalValueUint32(path, "net_cls.classid", spec.Network.ClassID)
}
func (*networkClass) skip(spec *specs.LinuxResources) error {
if spec != nil && spec.Network != nil && spec.Network.ClassID != nil {
return fmt.Errorf("Network.ClassID set but net_cls cgroup controller not found")
}
return nil
}
type networkPrio struct{}
func (*networkPrio) optional() bool {
return true
}
func (*networkPrio) set(spec *specs.LinuxResources, path string) error {
if spec == nil || spec.Network == nil {
return nil
}
for _, prio := range spec.Network.Priorities {
val := fmt.Sprintf("%s %d", prio.Name, prio.Priority)
if err := setValue(path, "net_prio.ifpriomap", val); err != nil {
return err
}
}
return nil
}
func (*networkPrio) skip(spec *specs.LinuxResources) error {
if spec != nil && spec.Network != nil && len(spec.Network.Priorities) > 0 {
return fmt.Errorf("Network.Priorities set but net_prio cgroup controller not found")
}
return nil
}
type pids struct{}
func (*pids) optional() bool {
return true
}
func (*pids) skip(spec *specs.LinuxResources) error {
if spec != nil && spec.Pids != nil && spec.Pids.Limit > 0 {
return fmt.Errorf("Pids.Limit set but pids cgroup controller not found")
}
return nil
}
func (*pids) set(spec *specs.LinuxResources, path string) error {
if spec == nil || spec.Pids == nil || spec.Pids.Limit <= 0 {
return nil
}
val := strconv.FormatInt(spec.Pids.Limit, 10)
return setValue(path, "pids.max", val)
}
type hugeTLB struct{}
func (*hugeTLB) optional() bool {
return true
}
func (*hugeTLB) skip(spec *specs.LinuxResources) error {
if spec != nil && len(spec.HugepageLimits) > 0 {
return fmt.Errorf("HugepageLimits set but hugetlb cgroup controller not found")
}
return nil
}
func (*hugeTLB) set(spec *specs.LinuxResources, path string) error {
if spec == nil {
return nil
}
for _, limit := range spec.HugepageLimits {
name := fmt.Sprintf("hugetlb.%s.limit_in_bytes", limit.Pagesize)
val := strconv.FormatUint(limit.Limit, 10)
if err := setValue(path, name, val); err != nil {
return err
}
}
return nil
}
|