Skip to content

Refactor: cleanup XDGRuntime #3850

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
merged 1 commit into from
Feb 23, 2025
Merged

Refactor: cleanup XDGRuntime #3850

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
4 changes: 2 additions & 2 deletions pkg/buildkitutil/buildkitutil_freebsd.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

package buildkitutil

func getRuntimeVariableDataDir() string {
func getRuntimeVariableDataDir() (string, error) {
// Per hier(7) dated July 6, 2023.
return "/var/run"
return "/var/run", nil
}
13 changes: 7 additions & 6 deletions pkg/buildkitutil/buildkitutil_linux.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,23 +18,24 @@ package buildkitutil

import (
"fmt"

"github.com/containerd/log"
"os"

"github.com/containerd/nerdctl/v2/pkg/rootlessutil"
)

func getRuntimeVariableDataDir() string {
func getRuntimeVariableDataDir() (string, error) {
// Per Linux Foundation "Filesystem Hierarchy Standard" version 3.0 section 3.15.
// Under version 2.3, this was "/var/run".
run := "/run"
if rootlessutil.IsRootless() {
var err error
run, err = rootlessutil.XDGRuntimeDir()
if err != nil {
log.L.Warn(err)
run = fmt.Sprintf("/run/user/%d", rootlessutil.ParentEUID())
if rootlessutil.IsRootlessChild() {
return "", err
}
Copy link
Member

@AkihiroSuda AkihiroSuda Feb 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Warn should be still printed here?

Copy link
Contributor Author

@apostasie apostasie Feb 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it is necessary, since err will be bubbled up and printed out as an error anyhow.

Copy link
Contributor Author

@apostasie apostasie Feb 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

eg: if we leave the warn, we will just print the error twice (once as a warn, and then as an error)

run = fmt.Sprintf("/run/user/%d", os.Geteuid())
}
}
return run
return run, nil
}
5 changes: 4 additions & 1 deletion pkg/buildkitutil/buildkitutil_unix.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,10 @@ func getBuildkitHostCandidates(namespace string) ([]string, error) {
return []string{}, fmt.Errorf("namespace must be specified")
}
// Try candidate locations of the current containerd namespace.
run := getRuntimeVariableDataDir()
run, err := getRuntimeVariableDataDir()
if err != nil {
return []string{}, err
}
var candidates []string
if namespace != "default" {
candidates = append(candidates, "unix://"+filepath.Join(run, fmt.Sprintf("buildkit-%s/buildkitd.sock", namespace)))
Expand Down
17 changes: 5 additions & 12 deletions pkg/bypass4netnsutil/bypass4netnsutil.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ package bypass4netnsutil

import (
"context"
"fmt"
"os"
"path/filepath"
"strconv"
Expand All @@ -30,6 +29,7 @@ import (
"github.com/containerd/containerd/v2/pkg/oci"

"github.com/containerd/nerdctl/v2/pkg/annotations"
"github.com/containerd/nerdctl/v2/pkg/rootlessutil"
)

func generateSecurityOpt(listenerPath string) (oci.SpecOpts, error) {
Expand Down Expand Up @@ -83,15 +83,8 @@ func GenerateBypass4netnsOpts(securityOptsMaps map[string]string, annotationsMap
return opts, nil
}

func getXDGRuntimeDir() (string, error) {
if xrd := os.Getenv("XDG_RUNTIME_DIR"); xrd != "" {
return xrd, nil
}
return "", fmt.Errorf("environment variable XDG_RUNTIME_DIR is not set")
}

func CreateSocketDir() error {
xdgRuntimeDir, err := getXDGRuntimeDir()
xdgRuntimeDir, err := rootlessutil.XDGRuntimeDir()
if err != nil {
return err
}
Expand All @@ -107,7 +100,7 @@ func CreateSocketDir() error {
}

func GetBypass4NetnsdDefaultSocketPath() (string, error) {
xdgRuntimeDir, err := getXDGRuntimeDir()
xdgRuntimeDir, err := rootlessutil.XDGRuntimeDir()
if err != nil {
return "", err
}
Expand All @@ -116,7 +109,7 @@ func GetBypass4NetnsdDefaultSocketPath() (string, error) {
}

func GetSocketPathByID(id string) (string, error) {
xdgRuntimeDir, err := getXDGRuntimeDir()
xdgRuntimeDir, err := rootlessutil.XDGRuntimeDir()
if err != nil {
return "", err
}
Expand All @@ -126,7 +119,7 @@ func GetSocketPathByID(id string) (string, error) {
}

func GetPidFilePathByID(id string) (string, error) {
xdgRuntimeDir, err := getXDGRuntimeDir()
xdgRuntimeDir, err := rootlessutil.XDGRuntimeDir()
if err != nil {
return "", err
}
Expand Down
4 changes: 2 additions & 2 deletions pkg/defaults/defaults_freebsd.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ func CNINetConfPath() string {
return cni.DefaultNetDir
}

func CNIRuntimeDir() string {
return "/run/cni"
func CNIRuntimeDir() (string, error) {
return "/run/cni", nil
}

func CgroupManager() string {
Expand Down
13 changes: 7 additions & 6 deletions pkg/defaults/defaults_linux.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ import (

"github.com/containerd/containerd/v2/plugins"
"github.com/containerd/go-cni"
"github.com/containerd/log"

"github.com/containerd/nerdctl/v2/pkg/rootlessutil"
)
Expand Down Expand Up @@ -88,16 +87,18 @@ func CNINetConfPath() string {
return filepath.Join(xch, "cni/net.d")
}

func CNIRuntimeDir() string {
func CNIRuntimeDir() (string, error) {
if !rootlessutil.IsRootless() {
return "/run/cni"
return "/run/cni", nil
}
xdr, err := rootlessutil.XDGRuntimeDir()
if err != nil {
log.L.Warn(err)
xdr = fmt.Sprintf("/run/user/%d", rootlessutil.ParentEUID())
if rootlessutil.IsRootlessChild() {
return "", err
}
xdr = fmt.Sprintf("/run/user/%d", os.Geteuid())
}
return fmt.Sprintf("%s/cni", xdr)
return filepath.Join(xdr, "cni"), nil
}

func NerdctlTOML() string {
Expand Down
4 changes: 2 additions & 2 deletions pkg/defaults/defaults_windows.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ func CNINetConfPath() string {
return filepath.Join(os.Getenv("ProgramFiles"), "containerd", "cni", "conf")
}

func CNIRuntimeDir() string {
return ""
func CNIRuntimeDir() (string, error) {
return "", nil
}

func IsSystemdAvailable() bool {
Expand Down
6 changes: 5 additions & 1 deletion pkg/netutil/netutil_unix.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,11 @@ func (e *CNIEnv) generateIPAM(driver string, subnets []string, gatewayStr, ipRan
ipamConfig = ipamConf
case "dhcp":
ipamConf := newDHCPIPAMConfig()
ipamConf.DaemonSocketPath = filepath.Join(defaults.CNIRuntimeDir(), "dhcp.sock")
crd, err := defaults.CNIRuntimeDir()
if err != nil {
return nil, err
}
ipamConf.DaemonSocketPath = filepath.Join(crd, "dhcp.sock")
if err := systemutil.IsSocketAccessible(ipamConf.DaemonSocketPath); err != nil {
log.L.Warnf("cannot access dhcp socket %q (hint: try running with `dhcp daemon --socketpath=%s &` in CNI_PATH to launch the dhcp daemon)", ipamConf.DaemonSocketPath, ipamConf.DaemonSocketPath)
}
Expand Down
9 changes: 7 additions & 2 deletions pkg/rootlessutil/xdg_linux.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,10 @@ package rootlessutil

import (
"errors"
"fmt"
"os"
"path/filepath"
"strconv"
)

func XDGRuntimeDir() (string, error) {
Expand All @@ -28,8 +30,11 @@ func XDGRuntimeDir() (string, error) {
}
// Fall back to "/run/user/<euid>".
// Note that We cannot rely on os.Geteuid() because we might be inside UserNS.
if euid := os.Getenv("ROOTLESSKIT_PARENT_EUID"); euid != "" {
return "/run/user/" + euid, nil
if parentEuid, ok := os.LookupEnv("ROOTLESSKIT_PARENT_EUID"); ok {
if _, err := strconv.Atoi(parentEuid); err != nil {
return "", fmt.Errorf("invalid ROOTLESSKIT_PARENT_EUID environment variable value %q: %w", parentEuid, err)
}
return "/run/user/" + parentEuid, nil
}
return "", errors.New("environment variable XDG_RUNTIME_DIR is not set, see https://rootlesscontaine.rs/getting-started/common/login/")
}
Expand Down
Loading