Merge pull request #255 from kzys/cgroup1

Add cgroup1/ to make cgroup1 and cgroup2 symmmetric

Author: Kazuyoshi Kato

Makefile

@@ -23,4 +23,4 @@ cgutil:
 proto:
 	protobuild --quiet ${PACKAGES}
 	# Keep them Go-idiomatic and backward-compatible with the gogo/protobuf era.
-	go-fix-acronym -w -a '(Cpu|Tcp|Rss)' $(shell find stats/v1/ cgroup2/stats/ -name '*.pb.go')
+	go-fix-acronym -w -a '(Cpu|Tcp|Rss)' $(shell find cgroup1/stats/ cgroup2/stats/ -name '*.pb.go')

Protobuild.toml

@@ -15,8 +15,8 @@ generators = ["go"]
 
 # Aggregrate the API descriptors to lock down API changes.
 [[descriptors]]
-prefix = "github.com/containerd/cgroups/stats/v1"
-target = "stats/v1/metrics.pb.txt"
+prefix = "github.com/containerd/cgroups/cgroup1/stats"
+target = "cgroup1/stats/metrics.pb.txt"
 ignore_files = [
 	"google/protobuf/descriptor.proto",
 ]

README.md

@@ -25,7 +25,7 @@ uses the v1 implementation of cgroups.
 
 ```go
 shares := uint64(100)
-control, err := cgroups.New(cgroups.V1, cgroups.StaticPath("/test"), &specs.LinuxResources{
+control, err := cgroup1.New(cgroup1.Default, cgroup1.StaticPath("/test"), &specs.LinuxResources{
     CPU: &specs.LinuxCPU{
         Shares: &shares,
     },
@@ -37,7 +37,7 @@ defer control.Delete()
 
 
 ```go
-control, err := cgroups.New(cgroups.Systemd, cgroups.Slice("system.slice", "runc-test"), &specs.LinuxResources{
+control, err := cgroup1.New(cgroup1.Systemd, cgroup1.Slice("system.slice", "runc-test"), &specs.LinuxResources{
     CPU: &specs.CPU{
         Shares: &shares,
     },
@@ -48,13 +48,13 @@ control, err := cgroups.New(cgroups.Systemd, cgroups.Slice("system.slice", "runc
 ### Load an existing cgroup
 
 ```go
-control, err = cgroups.Load(cgroups.V1, cgroups.StaticPath("/test"))
+control, err = cgroup1.Load(cgroup1.Default, cgroups.StaticPath("/test"))
 ```
 
 ### Add a process to the cgroup
 
 ```go
-if err := control.Add(cgroups.Process{Pid:1234}); err != nil {
+if err := control.Add(cgroup1.Process{Pid:1234}); err != nil {
 }
 ```
 
@@ -84,7 +84,7 @@ if err := control.Thaw(); err != nil {
 ### List all processes in the cgroup or recursively
 
 ```go
-processes, err := control.Processes(cgroups.Devices, recursive)
+processes, err := control.Processes(cgroup1.Devices, recursive)
 ```
 
 ### Get Stats on the cgroup
@@ -95,7 +95,7 @@ stats, err := control.Stat()
 
 By adding `cgroups.IgnoreNotExist` all non-existent files will be ignored, e.g. swap memory stats without swap enabled
 ```go
-stats, err := control.Stat(cgroups.IgnoreNotExist)
+stats, err := control.Stat(cgroup1.IgnoreNotExist)
 ```
 
 ### Move process across cgroups
@@ -117,19 +117,19 @@ subCgroup, err := control.New("child", resources)
 This allows you to get notified by an eventfd for v1 memory cgroups events.
 
 ```go
-event := cgroups.MemoryThresholdEvent(50 * 1024 * 1024, false)
+event := cgroup1.MemoryThresholdEvent(50 * 1024 * 1024, false)
 efd, err := control.RegisterMemoryEvent(event)
 ```
 
 ```go
-event := cgroups.MemoryPressureEvent(cgroups.MediumPressure, cgroups.DefaultMode)
+event := cgroup1.MemoryPressureEvent(cgroup1.MediumPressure, cgroup1.DefaultMode)
 efd, err := control.RegisterMemoryEvent(event)
 ```
 
 ```go
 efd, err := control.OOMEventFD()
 // or by using RegisterMemoryEvent
-event := cgroups.OOMEvent()
+event := cgroup1.OOMEvent()
 efd, err := control.RegisterMemoryEvent(event)
 ```
 
@@ -153,14 +153,14 @@ so the resulting slice would be located here on disk:
 
 ```go
 import (
-    cgroupsv2 "github.com/containerd/cgroups/v2"
+    "github.com/containerd/cgroups/v2/cgroup2"
     specs "github.com/opencontainers/runtime-spec/specs-go"
 )
 
-res := cgroupsv2.Resources{}
+res := cgroup2.Resources{}
 // dummy PID of -1 is used for creating a "general slice" to be used as a parent cgroup.
 // see https://github.com/containerd/cgroups/blob/1df78138f1e1e6ee593db155c6b369466f577651/v2/manager.go#L732-L735
-m, err := cgroupsv2.NewSystemd("/", "my-cgroup-abc.slice", -1, &res)
+m, err := cgroup2.NewSystemd("/", "my-cgroup-abc.slice", -1, &res)
 if err != nil {
 	return err
 }
@@ -169,7 +169,7 @@ if err != nil {
 ### Load an existing cgroup
 
 ```go
-m, err := cgroupsv2.LoadSystemd("/", "my-cgroup-abc.slice")
+m, err := cgroup2.LoadSystemd("/", "my-cgroup-abc.slice")
 if err != nil {
 	return err
 }
@@ -178,7 +178,7 @@ if err != nil {
 ### Delete a cgroup
 
 ```go
-m, err := cgroupsv2.LoadSystemd("/", "my-cgroup-abc.slice")
+m, err := cgroup2.LoadSystemd("/", "my-cgroup-abc.slice")
 if err != nil {
 	return err
 }

blkio.go cgroup1/blkio.goblkio.go renamed to cgroup1/blkio.go

@@ -14,7 +14,7 @@
    limitations under the License.
 */
 
-package cgroups
+package cgroup1
 
 import (
 	"bufio"
@@ -25,7 +25,8 @@ import (
 	"strconv"
 	"strings"
 
-	v1 "github.com/containerd/cgroups/v2/stats/v1"
+	v1 "github.com/containerd/cgroups/v2/cgroup1/stats"
+
 	specs "github.com/opencontainers/runtime-spec/specs-go"
 )
 

blkio_test.go cgroup1/blkio_test.goblkio_test.go renamed to cgroup1/blkio_test.go

@@ -14,14 +14,14 @@
    limitations under the License.
 */
 
-package cgroups
+package cgroup1
 
 import (
 	"os"
 	"strings"
 	"testing"
 
-	v1 "github.com/containerd/cgroups/v2/stats/v1"
+	v1 "github.com/containerd/cgroups/v2/cgroup1/stats"
 )
 
 const data = `major minor  #blocks  name

cgroup.go cgroup1/cgroup.gocgroup.go renamed to cgroup1/cgroup.go

@@ -14,7 +14,7 @@
    limitations under the License.
 */
 
-package cgroups
+package cgroup1
 
 import (
 	"errors"
@@ -28,7 +28,7 @@ import (
 	"syscall"
 	"time"
 
-	v1 "github.com/containerd/cgroups/v2/stats/v1"
+	v1 "github.com/containerd/cgroups/v2/cgroup1/stats"
 
 	"github.com/opencontainers/runtime-spec/specs-go"
 )

cgroup_test.go cgroup1/cgroup_test.gocgroup_test.go renamed to cgroup1/cgroup_test.go

@@ -14,7 +14,7 @@
    limitations under the License.
 */
 
-package cgroups
+package cgroup1
 
 import (
 	"fmt"

control.go cgroup1/control.gocontrol.go renamed to cgroup1/control.go

@@ -14,12 +14,12 @@
    limitations under the License.
 */
 
-package cgroups
+package cgroup1
 
 import (
 	"os"
 
-	v1 "github.com/containerd/cgroups/v2/stats/v1"
+	v1 "github.com/containerd/cgroups/v2/cgroup1/stats"
 	specs "github.com/opencontainers/runtime-spec/specs-go"
 )
 

cpu.go cgroup1/cpu.gocpu.go renamed to cgroup1/cpu.go

@@ -14,15 +14,15 @@
    limitations under the License.
 */
 
-package cgroups
+package cgroup1
 
 import (
 	"bufio"
 	"os"
 	"path/filepath"
 	"strconv"
 
-	v1 "github.com/containerd/cgroups/v2/stats/v1"
+	v1 "github.com/containerd/cgroups/v2/cgroup1/stats"
 	specs "github.com/opencontainers/runtime-spec/specs-go"
 )
 

cpuacct.go cgroup1/cpuacct.gocpuacct.go renamed to cgroup1/cpuacct.go

@@ -14,7 +14,7 @@
    limitations under the License.
 */
 
-package cgroups
+package cgroup1
 
 import (
 	"bufio"
@@ -24,7 +24,7 @@ import (
 	"strconv"
 	"strings"
 
-	v1 "github.com/containerd/cgroups/v2/stats/v1"
+	v1 "github.com/containerd/cgroups/v2/cgroup1/stats"
 )
 
 const nanosecondsInSecond = 1000000000