domain

type AccessMode uint32

type ChownSyscallPayload struct {
	Target    string `json:"target"`
	TargetUid int    `json:"uid"`
	TargetGid int    `json:"gid"`
}

type ContainerIface interface {
	//
	// Getters
	//
	ID() string
	InitPid() uint32
	InitPidFd() libpidfd.PidFd
	Ctime() time.Time
	Data(name string, offset int64, data *[]byte) (int, error)
	UID() uint32
	GID() uint32
	UidSize() uint32
	GidSize() uint32
	ProcRoPaths() []string
	ProcMaskPaths() []string
	InitProc() ProcessIface
	ExtractInode(path string) (Inode, error)
	IsMountInfoInitialized() bool
	InitializeMountInfo() error
	IsRootMount(info *MountInfo) (bool, error)
	IsRootMountID(id int) (bool, error)
	IsImmutableMount(info *MountInfo) (bool, error)
	IsImmutableRoMount(info *MountInfo) (bool, error)
	IsImmutableMountID(id int) bool
	IsImmutableRoMountID(id int) bool
	IsImmutableBindMount(info *MountInfo) bool
	IsImmutableRoBindMount(info *MountInfo) bool
	IsImmutableMountpoint(mp string) bool
	IsImmutableRoMountpoint(mp string) bool
	IsImmutableOverlapMountpoint(mp string) bool
	IsRegistrationCompleted() bool
	//
	// Setters
	//
	SetData(name string, offset int64, data []byte) error
	SetInitProc(pid, uid, gid uint32) error
	SetRegistrationCompleted()
	//
	// Locks for read-modify-write operations on container data via the Data()
	// and SetData() methods.
	//
	Lock()
	Unlock()
}

type ContainerStateServiceIface interface {
	Setup(
		fss FuseServerServiceIface,
		prs ProcessServiceIface,
		ios IOServiceIface,
		mts MountServiceIface)

	ContainerCreate(
		id string,
		pid uint32,
		ctime time.Time,
		uidFirst uint32,
		uidSize uint32,
		gidFirst uint32,
		gidSize uint32,
		procRoPaths []string,
		procMaskPaths []string,
		service ContainerStateServiceIface) ContainerIface

	ContainerPreRegister(id, netns string) error
	ContainerRegister(c ContainerIface) error
	ContainerUpdate(c ContainerIface) error
	ContainerUnregister(c ContainerIface) error
	ContainerLookupById(id string) ContainerIface
	FuseServerService() FuseServerServiceIface
	ProcessService() ProcessServiceIface
	MountService() MountServiceIface
	ContainerDBSize() int
}

type EmuResource struct {
	Kind    EmuResourceType
	Mode    os.FileMode
	Size    int64
	Enabled bool
	Mutex   sync.Mutex
}

type EmuResourceType int

type FileInfo struct {
	Fname    string
	Fsize    int64
	Fmode    os.FileMode
	FmodTime time.Time
	FisDir   bool
	Fsys     *syscall.Stat_t
}

type FuseServerIface interface {
	Create() error
	Run() error
	Destroy() error
	MountPoint() string
	Unmount()
	InitWait() bool
	SetCntrRegComplete()
	IsCntrRegCompleted() bool
}

type FuseServerServiceIface interface {
	Setup(
		mp string,
		css ContainerStateServiceIface,
		ios IOServiceIface,
		hds HandlerServiceIface) error

	CreateFuseServer(serveCntr, stateCntr ContainerIface) error
	DestroyFuseServer(mp string) error
	DestroyFuseService()
	FuseServerCntrRegComplete(cntr ContainerIface) error
}

type GetxattrRespPayload struct {
	Val  []byte `json:"val"`
	Size int    `json:"size"`
}

type GetxattrSyscallPayload struct {
	Header  NSenterMsgHeader
	Syscall string `json:"syscall"`
	Path    string `json:"path"`
	Name    string `json:"name"`
	Size    uint64 `json:"size"`
}

type GidInfoReqPayload struct {
	Group string `json:"group"`
}

type GidInfoRespPayload struct {
	Gid string `json:"gid"`
}

type HandlerBase struct {
	// Camel-case representation of every handler path.
	Name string

	// Abs path of the resource emulated by the handler.
	Path string

	// Map of additional resources emulated by the handler (e.g., for handlers
	// emulating directories, these would list any subdirs that they emulate).
	EmuResourceMap map[string]*EmuResource

	Enabled bool

	// Pointer to the parent handler service.
	Service HandlerServiceIface
}

type HandlerIface interface {
	// FS operations.
	Open(node IOnodeIface, req *HandlerRequest) (bool, error)
	Lookup(n IOnodeIface, req *HandlerRequest) (os.FileInfo, error)
	Read(node IOnodeIface, req *HandlerRequest) (int, error)
	Write(node IOnodeIface, req *HandlerRequest) (int, error)
	ReadDirAll(node IOnodeIface, req *HandlerRequest) ([]os.FileInfo, error)
	ReadLink(node IOnodeIface, req *HandlerRequest) (string, error)

	// getters/setters.
	GetName() string
	GetPath() string
	GetEnabled() bool
	SetEnabled(b bool)
	GetService() HandlerServiceIface
	SetService(hs HandlerServiceIface)
	GetResourcesList() []string
	GetResourceMutex(node IOnodeIface) *sync.Mutex
}

type HandlerRequest struct {
	ID          uint64
	Name        string
	Path        string
	Pid         uint32
	Uid         uint32
	Gid         uint32
	SkipIdRemap bool
	Offset      int64
	NoCache     bool
	Data        []byte
	Container   ContainerIface
}

type HandlerServiceIface interface {
	Setup(
		hdlrs []HandlerIface,
		ignoreErrors bool,
		css ContainerStateServiceIface,
		nss NSenterServiceIface,
		prs ProcessServiceIface,
		ios IOServiceIface)

	RegisterHandler(h HandlerIface) error
	UnregisterHandler(h HandlerIface) error
	LookupHandler(i IOnodeIface) (HandlerIface, bool)
	FindHandler(s string) (HandlerIface, bool)
	EnableHandler(path string) error
	DisableHandler(path string) error

	// getters/setters
	HandlersResourcesList() []string
	GetPassThroughHandler() PassthroughHandlerIface
	StateService() ContainerStateServiceIface
	SetStateService(css ContainerStateServiceIface)
	ProcessService() ProcessServiceIface
	NSenterService() NSenterServiceIface
	IOService() IOServiceIface
	IgnoreErrors() bool

	// Auxiliar methods.
	HostUserNsInode() Inode
	FindUserNsInode(pid uint32) (Inode, error)
	HostUuid() string
	FindHostUuid() (string, error)
	ShmSysctlUserNamespaced() bool
}

type IOServiceIface interface {
	NewIOnode(n string, p string, attr os.FileMode) IOnodeIface
	RemoveAllIOnodes() error
	GetServiceType() IOServiceType
}

type IOServiceType = int

type IOnodeIface interface {
	Open() error
	Read(p []byte) (n int, err error)
	Write(p []byte) (n int, err error)
	Close() error
	Seek(offset int64, whence int) (int64, error)
	ReadAt(p []byte, off int64) (n int, err error)
	ReadDirAll() ([]os.FileInfo, error)
	ReadFile() ([]byte, error)
	ReadLine() (string, error)
	ReadLink() (string, error)
	WriteAt(p []byte, off int64) (n int, err error)
	WriteFile(p []byte) error
	Mkdir() error
	MkdirAll() error
	Stat() (os.FileInfo, error)
	Lstat() (os.FileInfo, error)
	SeekReset() (int64, error)
	Remove() error
	RemoveAll() error
	//
	// Required getters/setters.
	//
	Name() string
	Path() string
	OpenFlags() int
	OpenMode() os.FileMode
	GetNsInode() (Inode, error)
	SetName(s string)
	SetPath(s string)
	SetOpenFlags(flags int)
	SetOpenMode(mode os.FileMode)
}

type Inode = uint64 // 0 = invalid inode

type IpcServiceIface interface {
	Setup(
		css ContainerStateServiceIface,
		prs ProcessServiceIface,
		ios IOServiceIface,
		fuseMp string)

	Init() error
}

type ListxattrRespPayload struct {
	Val  []byte `json:"val"`
	Size int    `json:"size"`
}

type ListxattrSyscallPayload struct {
	Header  NSenterMsgHeader
	Syscall string `json:"syscall"`
	Path    string `json:"path"`
	Size    uint64 `json:"size"`
}

type LookupPayload struct {
	Entry       string `json:"entry"`
	MountSysfs  bool   `json:mountSysfs`
	MountProcfs bool   `json:mountProcfs`
}

type Mount struct {
	Source string `json:"source"`
	Target string `json:"target"`
	FsType string `json:"fstype"`
	Flags  uint64 `json:"flags"`
	Data   string `json:"data"`
}

type MountHelperIface interface {
	IsNewMount(flags uint64) bool
	IsRemount(flags uint64) bool
	IsBind(flags uint64) bool
	IsMove(flags uint64) bool
	HasPropagationFlag(flags uint64) bool
	IsReadOnlyMount(flags uint64) bool
	StringToFlags(s map[string]string) uint64
	FilterFsFlags(fsOpts map[string]string) string
	ProcMounts() []string
	SysMounts() []string
}

type MountInfo struct {
	// Mount identifier.
	MountID int `json:"mountid"`

	// Parent-mount identifier.
	ParentID int `json:"parentid"`

	// 'st_dev' value for files in FS.
	MajorMinorVer string `json:"majorminorver"`

	// File-system type.
	FsType string `json:"fstype"`

	// File-system specific information or "none".
	Source string `json:"source"`

	// Pathname of root of the mount within the FS.
	Root string `json:"root"`

	// Pathname of the mount point relative to the root.
	MountPoint string `json:"mountpoint"`

	// Mount-specific options.
	Options map[string]string `json:"options"`

	// Optional-fields.
	OptionalFields map[string]string `json:"optionalfields"`

	// Superblock options.
	VfsOptions map[string]string `json:"vfsoptions"`

	// FS inode corresponding to this mountpoint.
	MpInode Inode `json:"mpinode"`

	// Backpointer to mountInfoParser.
	Mip MountInfoParserIface `json:"-"`
}

type MountInfoParserIface interface {
	GetProcessID() uint32
	GetInfo(mountpoint string) *MountInfo
	GetParentMount(info *MountInfo) *MountInfo
	LookupByMountID(id int) *MountInfo
	LookupByMountpoint(mp string) *MountInfo
	IsSysboxfsBaseMount(mountpoint string) bool
	IsSysboxfsBaseRoMount(mountpoint string) bool
	IsSysboxfsSubmount(mountpoint string) bool
	IsSysboxfsRoSubmount(mountpoint string) bool
	IsSysboxfsMaskedSubmount(mountpoint string) bool
	GetSysboxfsSubMounts(basemount string) []string
	HasNonSysboxfsSubmount(basemount string) bool
	IsRecursiveBindMount(info *MountInfo) bool
	IsSelfMount(info *MountInfo) bool
	IsOverlapMount(info *MountInfo) bool
	IsRoMount(info *MountInfo) bool
	IsBindMount(info *MountInfo) bool
	IsRoBindMount(info *MountInfo) bool
	IsRootMount(info *MountInfo) (bool, error)
	IsCloneMount(info *MountInfo, readonly bool) (bool, error)
	ExtractMountInfo() ([]byte, error)
	ExtractInode(mp string) (Inode, error)
	ExtractAncestorInodes(info *MountInfo) error
}

type MountInfoRespPayload struct {
	Data []byte `json:"data"`
}

type MountInodeReqPayload struct {
	Mountpoints []string `json:"mountpoints"`
}

type MountInodeRespPayload struct {
	MpInodes []Inode `json:"mpinodes"`
}

type MountServiceIface interface {
	Setup(
		css ContainerStateServiceIface,
		hds HandlerServiceIface,
		prs ProcessServiceIface,
		nss NSenterServiceIface)

	NewMountInfoParser(
		c ContainerIface,
		process ProcessIface,
		launchParser bool,
		fetchOptions bool,
		fetchInodes bool) (MountInfoParserIface, error)

	NewMountHelper() MountHelperIface
	MountHelper() MountHelperIface
}

type MountSyscallPayload struct {
	Header NSenterMsgHeader
	Mount
}

type NSenterEventIface interface {
	SendRequest() error
	TerminateRequest() error
	ReceiveResponse() *NSenterMessage
	SetRequestMsg(m *NSenterMessage)
	GetRequestMsg() *NSenterMessage
	SetResponseMsg(m *NSenterMessage)
	GetResponseMsg() *NSenterMessage
	GetProcessID() uint32
}

type NSenterMessage struct {
	// Message type being exchanged.
	Type NSenterMsgType `json:"message"`

	// Message payload.
	Payload interface{} `json:"payload"`
}

type NSenterMsgHeader struct {
	// Note: pid, uid, and gid, and file descriptors are sent apart via socket control messages (SCM) creds/rights.
	// This way the kernel automatically translates them across process namespaces (e.g., from sysbox-fs to the nsenter
	// process namespaces for nsenter requests, or vice-versa for nsenter responses).
	Root         string    `json:"root"`
	Cwd          string    `json:"cwd"`
	Capabilities [2]uint32 `json:"capabilities"`
}

type NSenterMsgType = string

type NSenterServiceIface interface {
	NewEvent(
		pid uint32,
		uid uint32,
		gid uint32,
		ns *[]NStype,
		cloneFlags uint32,
		req *NSenterMessage,
		res *NSenterMessage,
		async bool) NSenterEventIface

	Setup(prs ProcessServiceIface, mts MountServiceIface)
	SendRequestEvent(e NSenterEventIface) error
	ReceiveResponseEvent(e NSenterEventIface) *NSenterMessage
	TerminateRequestEvent(e NSenterEventIface) error
	GetEventProcessID(e NSenterEventIface) uint32
}

type NStype = string

type OpenFilePayload struct {
	File        string `json:"file"`
	Flags       string `json:"flags"`
	Mode        string `json:"mode"`
	MountSysfs  bool   `json:mountSysfs`
	MountProcfs bool   `json:mountProcfs`
}

type Openat2RespPayload struct {
	Fd int `json:"fd"`
}

type Openat2SyscallPayload struct {
	Header           NSenterMsgHeader `json:"header"`
	Path             string           `json:"path"`
	Flags            uint64           `json:"flags"`
	Mode             uint64           `json:"mode"`
	Resolve          uint64           `json:"resolve"`
	CheckForSysboxfs bool             `json:"verifyfs"`
}

type PassthroughHandlerIface interface {
	HandlerIface
	OpenWithNS(node IOnodeIface, req *HandlerRequest, namespaces []NStype) (bool, error)
	ReadWithNS(node IOnodeIface, req *HandlerRequest, namespaces []NStype) (int, error)
	WriteWithNS(node IOnodeIface, req *HandlerRequest, namespaces []NStype) (int, error)
}

type ProcessIface interface {
	Pid() uint32
	Uid() uint32
	Gid() uint32
	Cwd() string
	Root() string
	RootInode() uint64
	SGid() []uint32
	UidMap() ([]user.IDMap, error)
	GidMap() ([]user.IDMap, error)
	IsCapabilitySet(cap.CapType, cap.Cap) bool
	IsSysAdminCapabilitySet() bool
	NsInodes() (map[string]Inode, error)
	MountNsInode() (Inode, error)
	NetNsInode() (Inode, error)
	UserNsInode() (Inode, error)
	UserNsInodeParent() (Inode, error)
	UsernsRootUidGid() (uint32, uint32, error)
	CreateNsInodes(Inode) error
	PathAccess(path string, accessFlags AccessMode, followSymlink bool) (string, error)
	ResolveProcSelf(string) (string, error)
	GetEffCaps() [2]uint32
	SetEffCaps(caps [2]uint32)
	GetFd(int32) (string, error)
	AdjustPersonality(
		uid uint32,
		gid uint32,
		root string,
		cwd string,
		caps [2]uint32) error
}

type ProcessServiceIface interface {
	Setup(ios IOServiceIface)
	ProcessCreate(pid uint32, uid uint32, gid uint32) ProcessIface
}

type ReadDirPayload struct {
	Dir         string `json:"dir"`
	MountSysfs  bool   `json:mountSysfs`
	MountProcfs bool   `json:mountProcfs`
}

type ReadFilePayload struct {
	File        string `json:"file"`
	Offset      int64  `json:"offset"`
	Len         int    `json:"len"`
	MountSysfs  bool   `json:mountSysfs`
	MountProcfs bool   `json:mountProcfs`
}

type ReadLinkPayload struct {
	Link        string `json:"link"`
	MountSysfs  bool   `json:mountSysfs`
	MountProcfs bool   `json:mountProcfs`
}

type RemovexattrSyscallPayload struct {
	Syscall string `json:"syscall"`
	Path    string `json:"path"`
	Name    string `json:"name"`
}

type SetxattrSyscallPayload struct {
	Syscall string `json:"syscall"`
	Path    string `json:"path"`
	Name    string `json:"name"`
	Val     []byte `json:"val"`
	Flags   int    `json:"flags"`
}

type SleepReqPayload struct {
	Ival string `json:"attr"`
}

type SyscallMonitorServiceIface interface {
	Setup(
		nss NSenterServiceIface,
		css ContainerStateServiceIface,
		prs ProcessServiceIface,
		mts MountServiceIface,
		allowImmutableRemounts bool,
		allowImmutableUnmounts bool)
}

type UidInfoReqPayload struct {
	User string `json:"user"`
}

type UidInfoRespPayload struct {
	Uid string `json:"uid"`
}

type UmountSyscallPayload struct {
	Header NSenterMsgHeader
	Mount
}

type WriteFilePayload struct {
	File        string `json:"file"`
	Offset      int64  `json:"offset"`
	Data        []byte `json:"data"`
	MountSysfs  bool   `json:mountSysfs`
	MountProcfs bool   `json:mountProcfs`
}