gvisor/pkg/shim/v1/utils/utils.go

// Copyright 2018 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
//
//     https://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 utils container miscellaneous utility function used by the shim.
package utils

import (
	"encoding/json"
	"os"
	"path/filepath"

	specs "github.com/opencontainers/runtime-spec/specs-go"
)

const configFilename = "config.json"

// ReadSpec reads OCI spec from the bundle directory.
func ReadSpec(bundle string) (*specs.Spec, error) {
	b, err := os.ReadFile(filepath.Join(bundle, configFilename))
	if err != nil {
		return nil, err
	}
	var spec specs.Spec
	if err := json.Unmarshal(b, &spec); err != nil {
		return nil, err
	}
	return &spec, nil
}

// WriteSpec writes OCI spec to the bundle directory.
func WriteSpec(bundle string, spec *specs.Spec) error {
	b, err := json.Marshal(spec)
	if err != nil {
		return err
	}
	return os.WriteFile(filepath.Join(bundle, configFilename), b, 0666)
}

// IsSandbox checks whether a container is a sandbox container.
func IsSandbox(spec *specs.Spec) bool {
	t, ok := spec.Annotations[ContainerTypeAnnotation]
	return !ok || t == containerTypeSandbox
}

// UserLogPath gets user log path from OCI annotation.
func UserLogPath(spec *specs.Spec) string {
	sandboxLogDir := spec.Annotations[sandboxLogDirAnnotation]
	if sandboxLogDir == "" {
		return ""
	}
	return filepath.Join(sandboxLogDir, "gvisor.log")
}

// PanicLogPath gets the panic log path from OCI annotation.
func PanicLogPath(spec *specs.Spec) string {
	if spec == nil {
		return ""
	}
	sandboxLogDir := spec.Annotations[sandboxLogDirAnnotation]
	if sandboxLogDir == "" {
		return ""
	}
	return filepath.Join(sandboxLogDir, "gvisor_panic.log")
}