state

package
v0.0.0-...-fc40e23 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 25, 2025 License: Apache-2.0, BSD-3-Clause, MIT Imports: 13 Imported by: 6

Documentation

Overview

Package state provides high-level state wrappers.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CPUTime

func CPUTime() (time.Duration, error)

CPUTime returns the CPU time usage by Sentry and app.

func NewStatefileReader

func NewStatefileReader(source io.ReadCloser, key []byte) (io.ReadCloser, map[string]string, error)

NewStatefileReader returns the statefile's metadata and a reader for it. The ownership of source is transferred to the returned reader.

Types

type SaveOpts

type SaveOpts struct {
	// Destination is the save target.
	Destination io.Writer

	// PagesMetadata is the file into which MemoryFile metadata is stored if
	// PagesMetadata is non-nil. Otherwise this content is stored in Destination.
	PagesMetadata io.WriteCloser

	// PagesFile is the file in which all MemoryFile pages are stored if
	// PagesFile is non-nil. Otherwise this content is stored in Destination.
	PagesFile stateio.AsyncWriter

	// Key is used for state integrity check.
	Key []byte

	// Metadata is save metadata.
	Metadata map[string]string

	// AppMFExcludeCommittedZeroPages is the value of
	// pgalloc.SaveOpts.ExcludeCommittedZeroPages for the application memory
	// file.
	AppMFExcludeCommittedZeroPages bool

	// Resume indicates if the statefile is used for save-resume.
	Resume bool

	// Autosave indicates if the statefile is used for autosave.
	Autosave bool
}

SaveOpts contains save-related options.

func (*SaveOpts) Close

func (opts *SaveOpts) Close() error

Close releases resources owned by opts.

func (*SaveOpts) Save

func (opts *SaveOpts) Save(ctx context.Context, k *kernel.Kernel, w *watchdog.Watchdog) error

Save saves the system state.

Directories

Path Synopsis
Package checkpointfiles defines constants used when sentry state is checkpointed to multiple files in a directory rather than to an opaque FD.
Package checkpointfiles defines constants used when sentry state is checkpointed to multiple files in a directory rather than to an opaque FD.
Package stateio defines I/O types used by sentry save/restore.
Package stateio defines I/O types used by sentry save/restore.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL