From d89616fb6483811dc5ea82fff547cb68109a9950 Mon Sep 17 00:00:00 2001 From: Brian Goff Date: Tue, 16 Jun 2015 22:36:20 -0400 Subject: [PATCH] cleanup sysinfo package Signed-off-by: Brian Goff --- sysinfo/sysinfo.go | 21 ++++-- sysinfo/sysinfo_linux.go | 136 +++++++++++++++++----------------- sysinfo/sysinfo_linux_test.go | 58 +++++++++++++++ 3 files changed, 139 insertions(+), 76 deletions(-) create mode 100644 sysinfo/sysinfo_linux_test.go diff --git a/sysinfo/sysinfo.go b/sysinfo/sysinfo.go index 0ce7257..47b84ce 100644 --- a/sysinfo/sysinfo.go +++ b/sysinfo/sysinfo.go @@ -3,13 +3,22 @@ package sysinfo // SysInfo stores information about which features a kernel supports. // TODO Windows: Factor out platform specific capabilities. type SysInfo struct { - MemoryLimit bool - SwapLimit bool - CpuCfsPeriod bool - CpuCfsQuota bool + AppArmor bool + *cgroupMemInfo + *cgroupCpuInfo IPv4ForwardingDisabled bool - AppArmor bool - OomKillDisable bool BridgeNfCallIptablesDisabled bool BridgeNfCallIp6tablesDisabled bool + CgroupDevicesEnabled bool +} + +type cgroupMemInfo struct { + MemoryLimit bool + SwapLimit bool + OomKillDisable bool +} + +type cgroupCpuInfo struct { + CpuCfsPeriod bool + CpuCfsQuota bool } diff --git a/sysinfo/sysinfo_linux.go b/sysinfo/sysinfo_linux.go index b0dd6a4..5d98d16 100644 --- a/sysinfo/sysinfo_linux.go +++ b/sysinfo/sysinfo_linux.go @@ -4,7 +4,6 @@ import ( "io/ioutil" "os" "path" - "strconv" "strings" "github.com/Sirupsen/logrus" @@ -14,81 +13,78 @@ import ( // New returns a new SysInfo, using the filesystem to detect which features the kernel supports. func New(quiet bool) *SysInfo { sysInfo := &SysInfo{} - if cgroupMemoryMountpoint, err := cgroups.FindCgroupMountpoint("memory"); err != nil { - if !quiet { - logrus.Warnf("Your kernel does not support cgroup memory limit: %v", err) - } - } else { - // If memory cgroup is mounted, MemoryLimit is always enabled. - sysInfo.MemoryLimit = true + sysInfo.cgroupMemInfo = checkCgroupMem(quiet) + sysInfo.cgroupCpuInfo = checkCgroupCpu(quiet) - _, err1 := ioutil.ReadFile(path.Join(cgroupMemoryMountpoint, "memory.memsw.limit_in_bytes")) - sysInfo.SwapLimit = err1 == nil - if !sysInfo.SwapLimit && !quiet { - logrus.Warn("Your kernel does not support swap memory limit.") - } + _, err := cgroups.FindCgroupMountpoint("devices") + sysInfo.CgroupDevicesEnabled = err == nil - _, err = ioutil.ReadFile(path.Join(cgroupMemoryMountpoint, "memory.oom_control")) - sysInfo.OomKillDisable = err == nil - if !sysInfo.OomKillDisable && !quiet { - logrus.Warnf("Your kernel does not support oom control.") - } - } - - if cgroupCpuMountpoint, err := cgroups.FindCgroupMountpoint("cpu"); err != nil { - if !quiet { - logrus.Warnf("%v", err) - } - } else { - _, err := ioutil.ReadFile(path.Join(cgroupCpuMountpoint, "cpu.cfs_period_us")) - sysInfo.CpuCfsPeriod = err == nil - if !sysInfo.CpuCfsPeriod && !quiet { - logrus.Warn("Your kernel does not support cgroup cfs period") - } - _, err = ioutil.ReadFile(path.Join(cgroupCpuMountpoint, "cpu.cfs_quota_us")) - sysInfo.CpuCfsQuota = err == nil - if !sysInfo.CpuCfsQuota && !quiet { - logrus.Warn("Your kernel does not support cgroup cfs quotas") - } - } - - // Checek if ipv4_forward is disabled. - if data, err := ioutil.ReadFile("/proc/sys/net/ipv4/ip_forward"); os.IsNotExist(err) { - sysInfo.IPv4ForwardingDisabled = true - } else { - if enabled, _ := strconv.Atoi(strings.TrimSpace(string(data))); enabled == 0 { - sysInfo.IPv4ForwardingDisabled = true - } else { - sysInfo.IPv4ForwardingDisabled = false - } - } - - // Check if bridge-nf-call-iptables is disabled. - if data, err := ioutil.ReadFile("/proc/sys/net/bridge/bridge-nf-call-iptables"); os.IsNotExist(err) { - sysInfo.BridgeNfCallIptablesDisabled = true - } else { - enabled, _ := strconv.Atoi(strings.TrimSpace(string(data))) - sysInfo.BridgeNfCallIptablesDisabled = enabled == 0 - } - // Check if bridge-nf-call-ip6tables is disabled. - if data, err := ioutil.ReadFile("/proc/sys/net/bridge/bridge-nf-call-ip6tables"); os.IsNotExist(err) { - sysInfo.BridgeNfCallIp6tablesDisabled = true - } else { - enabled, _ := strconv.Atoi(strings.TrimSpace(string(data))) - sysInfo.BridgeNfCallIp6tablesDisabled = enabled == 0 - } + sysInfo.IPv4ForwardingDisabled = !readProcBool("/proc/sys/net/ipv4/ip_forward") + sysInfo.BridgeNfCallIptablesDisabled = !readProcBool("/proc/sys/net/bridge/bridge-nf-call-iptables") + sysInfo.BridgeNfCallIp6tablesDisabled = !readProcBool("/proc/sys/net/bridge/bridge-nf-call-ip6tables") // Check if AppArmor is supported. - if _, err := os.Stat("/sys/kernel/security/apparmor"); os.IsNotExist(err) { - sysInfo.AppArmor = false - } else { + if _, err := os.Stat("/sys/kernel/security/apparmor"); !os.IsNotExist(err) { sysInfo.AppArmor = true } - // Check if Devices cgroup is mounted, it is hard requirement for container security. - if _, err := cgroups.FindCgroupMountpoint("devices"); err != nil { - logrus.Fatalf("Error mounting devices cgroup: %v", err) - } - return sysInfo } + +func checkCgroupMem(quiet bool) *cgroupMemInfo { + info := &cgroupMemInfo{} + mountPoint, err := cgroups.FindCgroupMountpoint("memory") + if err != nil { + if !quiet { + logrus.Warnf("Your kernel does not support cgroup memory limit: %v", err) + } + return nil + } + info.MemoryLimit = true + + info.SwapLimit = cgroupEnabled(mountPoint, "memory.memsw.limit_in_bytes") + if !quiet && !info.SwapLimit { + logrus.Warn("Your kernel does not support swap memory limit.") + } + info.OomKillDisable = cgroupEnabled(mountPoint, "memory.oom_control") + if !quiet && !info.OomKillDisable { + logrus.Warnf("Your kernel does not support oom control.") + } + + return info +} + +func checkCgroupCpu(quiet bool) *cgroupCpuInfo { + info := &cgroupCpuInfo{} + mountPoint, err := cgroups.FindCgroupMountpoint("cpu") + if err != nil { + if !quiet { + logrus.Warn(err) + } + return nil + } + + info.CpuCfsPeriod = cgroupEnabled(mountPoint, "cpu.cfs_period_us") + if !quiet && !info.CpuCfsPeriod { + logrus.Warn("Your kernel does not support cgroup cfs period") + } + + info.CpuCfsQuota = cgroupEnabled(mountPoint, "cpu.cfs_quota_us") + if !quiet && !info.CpuCfsQuota { + logrus.Warn("Your kernel does not support cgroup cfs quotas") + } + return info +} + +func cgroupEnabled(mountPoint, name string) bool { + _, err := os.Stat(path.Join(mountPoint, name)) + return err == nil +} + +func readProcBool(path string) bool { + val, err := ioutil.ReadFile(path) + if err != nil { + return false + } + return strings.TrimSpace(string(val)) == "1" +} diff --git a/sysinfo/sysinfo_linux_test.go b/sysinfo/sysinfo_linux_test.go new file mode 100644 index 0000000..fae0fdf --- /dev/null +++ b/sysinfo/sysinfo_linux_test.go @@ -0,0 +1,58 @@ +package sysinfo + +import ( + "io/ioutil" + "os" + "path" + "path/filepath" + "testing" +) + +func TestReadProcBool(t *testing.T) { + tmpDir, err := ioutil.TempDir("", "test-sysinfo-proc") + if err != nil { + t.Fatal(err) + } + defer os.RemoveAll(tmpDir) + + procFile := filepath.Join(tmpDir, "read-proc-bool") + if err := ioutil.WriteFile(procFile, []byte("1"), 644); err != nil { + t.Fatal(err) + } + + if !readProcBool(procFile) { + t.Fatal("expected proc bool to be true, got false") + } + + if err := ioutil.WriteFile(procFile, []byte("0"), 644); err != nil { + t.Fatal(err) + } + if readProcBool(procFile) { + t.Fatal("expected proc bool to be false, got false") + } + + if readProcBool(path.Join(tmpDir, "no-exist")) { + t.Fatal("should be false for non-existent entry") + } + +} + +func TestCgroupEnabled(t *testing.T) { + cgroupDir, err := ioutil.TempDir("", "cgroup-test") + if err != nil { + t.Fatal(err) + } + defer os.RemoveAll(cgroupDir) + + if cgroupEnabled(cgroupDir, "test") { + t.Fatal("cgroupEnabled should be false") + } + + if err := ioutil.WriteFile(path.Join(cgroupDir, "test"), []byte{}, 644); err != nil { + t.Fatal(err) + } + + if !cgroupEnabled(cgroupDir, "test") { + t.Fatal("cgroupEnabled should be true") + } +}