visor/pkg/hostos/hostos.go

// Copyright 2022 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 hostos contains utility functions for getting information about the host OS.
package hostos

import (
	"bufio"
	"fmt"
	"io"
	"os"
	"regexp"
	"strconv"
	"strings"
	"sync"

	"golang.org/x/mod/semver"
	"golang.org/x/sys/unix"
)

// Version represents a semantic version of the form "%d.%d[.%d]".
type Version struct {
	version string
}

// AtLeast returns whether vr is at least version major.minor.
func (vr Version) AtLeast(major, minor int) bool {
	return semver.Compare(vr.version, fmt.Sprintf("v%d.%d", major, minor)) >= 0
}

// LessThan returns whether vr is less than version major.minor.
func (vr Version) LessThan(major, minor int) bool {
	return !vr.AtLeast(major, minor)
}

// String implements fmt.Stringer.
func (vr Version) String() string {
	if vr.version == "" {
		return "unknown"
	}
	// Omit the "v" prefix required by semver.
	return vr.version[1:]
}

// These values are effectively local to KernelVersion, but kept here so as to
// work with sync.Once.
var (
	semVersion Version
	unameErr   error
	once       sync.Once
)

// KernelVersion returns the version of the kernel using uname().
func KernelVersion() (Version, error) {
	once.Do(func() {
		var utsname unix.Utsname
		if err := unix.Uname(&utsname); err != nil {
			unameErr = err
			return
		}

		var sb strings.Builder
		for _, b := range utsname.Release {
			if b == 0 {
				break
			}
			sb.WriteByte(byte(b))
		}

		versionRegexp := regexp.MustCompile(`[0-9]+\.[0-9]+(\.[0-9]+)?`)
		version := "v" + string(versionRegexp.Find([]byte(sb.String())))
		if !semver.IsValid(version) {
			unameErr = fmt.Errorf("invalid version found in release %q", sb.String())
			return
		}
		semVersion.version = version
	})

	return semVersion, unameErr
}

// TotalSystemMemory extracts "MemTotal" from "/proc/meminfo".
func TotalSystemMemory() (uint64, error) {
	f, err := os.Open("/proc/meminfo")
	if err != nil {
		return 0, err
	}
	defer f.Close()
	return parseTotalSystemMemory(f)
}

func parseTotalSystemMemory(r io.Reader) (uint64, error) {
	for scanner := bufio.NewScanner(r); scanner.Scan(); {
		line := scanner.Text()
		totalStr := strings.TrimPrefix(line, "MemTotal:")
		if len(totalStr) < len(line) {
			fields := strings.Fields(totalStr)
			if len(fields) == 0 || len(fields) > 2 {
				return 0, fmt.Errorf(`malformed "MemTotal": %q`, line)
			}
			totalStr = fields[0]
			unit := ""
			if len(fields) == 2 {
				unit = fields[1]
			}
			mem, err := strconv.ParseUint(totalStr, 10, 64)
			if err != nil {
				return 0, err
			}
			switch unit {
			case "":
				// do nothing.
			case "kB":
				memKb := mem
				mem = memKb * 1024
				if mem < memKb {
					return 0, fmt.Errorf(`"MemTotal" too large: %d`, memKb)
				}
			default:
				return 0, fmt.Errorf("unknown unit %q: %q", unit, line)
			}
			return mem, nil
		}
	}
	return 0, fmt.Errorf(`malformed "/proc/meminfo": "MemTotal" not found`)
}