Rename cgroupNamespaceSupported, add details

mook-as · mook-as · commit f9ccb09ef9fb · 2023-10-04T14:28:12.000-07:00
This responds to review feedback from #4308 (review) Signed-off-by: Mark Yen <mark.yen@suse.com>
diff --git a/executor/oci/spec.go b/executor/oci/spec.go
@@ -138,7 +138,7 @@ func GenerateSpec(ctx context.Context, meta executor.Meta, mounts []executor.Mou
 		return nil, nil, err
 	}
 
-	if cgroupNamespaceSupported() {
+	if cgroupV2NamespaceSupported() {
 		s.Linux.Namespaces = append(s.Linux.Namespaces, specs.LinuxNamespace{
 			Type: specs.CgroupNamespace,
 		})
diff --git a/executor/oci/spec_freebsd.go b/executor/oci/spec_freebsd.go
@@ -56,6 +56,6 @@ func getTracingSocket() string {
 	return ""
 }
 
-func cgroupNamespaceSupported() bool {
+func cgroupV2NamespaceSupported() bool {
 	return false
 }
diff --git a/executor/oci/spec_linux.go b/executor/oci/spec_linux.go
@@ -148,7 +148,11 @@ func getTracingSocket() string {
 	return fmt.Sprintf("unix://%s", tracingSocketPath)
 }
 
-func cgroupNamespaceSupported() bool {
+func cgroupV2NamespaceSupported() bool {
+	// Check if cgroups v2 namespaces are supported.  Trying to do cgroup
+	// namespaces with cgroups v1 results in EINVAL when we encounter a
+	// non-standard hierarchy.
+	// See https://github.com/moby/buildkit/issues/4108
 	cgroupNSOnce.Do(func() {
 		if _, err := os.Stat("/proc/self/ns/cgroup"); os.IsNotExist(err) {
 			return
diff --git a/executor/oci/spec_windows.go b/executor/oci/spec_windows.go
@@ -97,6 +97,6 @@ func getTracingSocket() string {
 	return fmt.Sprintf("npipe://%s", filepath.ToSlash(tracingSocketPath))
 }
 
-func cgroupNamespaceSupported() bool {
+func cgroupV2NamespaceSupported() bool {
 	return false
 }

Original file line number	Diff line number	Diff line change
`@@ -138,7 +138,7 @@ func GenerateSpec(ctx context.Context, meta executor.Meta, mounts []executor.Mou`
`138`	`138`	`return nil, nil, err`
`139`	`139`	`}`
`140`	`140`
`141`		`- if cgroupNamespaceSupported() {`
	`141`	`+ if cgroupV2NamespaceSupported() {`
`142`	`142`	`s.Linux.Namespaces = append(s.Linux.Namespaces, specs.LinuxNamespace{`
`143`	`143`	`Type: specs.CgroupNamespace,`
`144`	`144`	`})`
Original file line number	Diff line number	Diff line change
`@@ -56,6 +56,6 @@ func getTracingSocket() string {`
`56`	`56`	`return ""`
`57`	`57`	`}`
`58`	`58`
`59`		`-func cgroupNamespaceSupported() bool {`
	`59`	`+func cgroupV2NamespaceSupported() bool {`
`60`	`60`	`return false`
`61`	`61`	`}`
Original file line number	Diff line number	Diff line change
`@@ -97,6 +97,6 @@ func getTracingSocket() string {`
`97`	`97`	`return fmt.Sprintf("npipe://%s", filepath.ToSlash(tracingSocketPath))`
`98`	`98`	`}`
`99`	`99`
`100`		`-func cgroupNamespaceSupported() bool {`
	`100`	`+func cgroupV2NamespaceSupported() bool {`
`101`	`101`	`return false`
`102`	`102`	`}`