Files
Ayush RanjanandgVisor bot 24f10937ab test: Discard snapshot files generated for save/resume tests.
The save/resume tests were writing the snapshot files to a bytes.Buffer, but
the contents of the buffer were never used. This was unnecessarily consuming a
lot of sandbox memory, potentially OOM-ing tests. Using io.Discard makes it
clear that the output is not needed and avoids unnecessary buffering.

PiperOrigin-RevId: 907042377
2026-04-28 10:12:40 -07:00

115 lines
3.5 KiB
Go

// Copyright 2024 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 boot
import (
"fmt"
"io"
"gvisor.dev/gvisor/pkg/fd"
"gvisor.dev/gvisor/pkg/log"
"gvisor.dev/gvisor/pkg/sentry/arch"
"gvisor.dev/gvisor/pkg/sentry/control"
"gvisor.dev/gvisor/pkg/sentry/kernel"
"gvisor.dev/gvisor/pkg/sentry/state"
"gvisor.dev/gvisor/pkg/sentry/state/stateio"
"gvisor.dev/gvisor/pkg/sentry/strace"
"gvisor.dev/gvisor/pkg/sync"
)
func getTargetForSaveResume(l *Loader) func(k *kernel.Kernel) {
return func(k *kernel.Kernel) {
// Discard the state file contents for save-resume. There is no need to
// verify the state file, we just need the sandbox to continue running
// after save.
saveOpts := state.SaveOpts{
Autosave: true,
Resume: true,
Destination: io.Discard,
}
defer saveOpts.Close()
l.saveWithOpts(&saveOpts, &control.SaveRestoreExecOpts{})
}
}
func getTargetForSaveRestore(l *Loader, files []*fd.FD) func(k *kernel.Kernel) {
if len(files) != 1 && len(files) != 3 {
panic(fmt.Sprintf("Unexpected number of files: %v", len(files)))
}
var once sync.Once
return func(k *kernel.Kernel) {
once.Do(func() {
saveOpts := state.SaveOpts{
Autosave: true,
Resume: false,
Destination: files[0],
}
if len(files) == 3 {
saveOpts.PagesMetadata = stateio.NewBufioWriteCloser(files[1])
saveOpts.PagesFile = stateio.NewPagesFileFDWriterDefault(int32(files[2].Release()))
}
defer saveOpts.Close()
l.saveWithOpts(&saveOpts, &control.SaveRestoreExecOpts{})
})
}
}
// enableAutosave enables auto save restore in syscall tests.
func enableAutosave(l *Loader, isResume bool, files []*fd.FD) error {
var target func(k *kernel.Kernel)
if isResume {
target = getTargetForSaveResume(l)
} else {
target = getTargetForSaveRestore(l, files)
}
for _, table := range kernel.SyscallTables() {
sys, ok := strace.Lookup(table.OS, table.Arch)
if !ok {
continue
}
if err := configureInitSyscall(table, sys, "init_module", kernel.ExternalAfterEnable); err != nil {
return err
}
// Set external args to our closure above.
table.External = target
}
return nil
}
// configureInitSyscall sets the trigger for the S/R syscall tests and the callback
// method to be called after the sycall is executed.
func configureInitSyscall(table *kernel.SyscallTable, sys strace.SyscallMap, initSyscall string, syscallFlag uint32) error {
sl := make(map[uintptr]bool)
sysno, ok := sys.ConvertToSysno(initSyscall)
if !ok {
return fmt.Errorf("syscall %q not found", initSyscall)
}
sl[sysno] = true
log.Infof("sysno %v name %v", sysno, initSyscall)
table.FeatureEnable.Enable(syscallFlag, sl, false)
table.ExternalFilterBefore = func(*kernel.Task, uintptr, arch.SyscallArguments) bool {
return false
}
// Sets ExternalFilterAfter to true which calls the closure assigned to
// External after the syscall is executed.
table.ExternalFilterAfter = func(*kernel.Task, uintptr, arch.SyscallArguments) bool {
return true
}
return nil
}