types

type CapacityError struct {
	Code    string
	Message string
	Region  string
}

type CedanaCluster struct {
	gorm.Model
	ClusterID uuid.UUID  `json:"cluster_id" gorm:"type:uuid"`
	Workers   []Instance `json:"workers" gorm:"foreignKey:CedanaID"`
}

type CedanaState struct {
	ClientInfo     ClientInfo     `json:"client_info" mapstructure:"client_info"`
	ProcessInfo    ProcessInfo    `json:"process_info" mapstructure:"process_info"`
	CheckpointType CheckpointType `json:"checkpoint_type" mapstructure:"checkpoint_type"`
	// either local or remote checkpoint path (url vs filesystem path)
	CheckpointPath string `json:"checkpoint_path" mapstructure:"checkpoint_path"`
	// process state at time of checkpoint
	CheckpointState CheckpointState `json:"checkpoint_state" mapstructure:"checkpoint_state"`
}

type CheckpointReason string

type CheckpointState string

type CheckpointType string

type ClientInfo struct {
	Id              string `json:"id" mapstructure:"id"`
	Hostname        string `json:"hostname" mapstructure:"hostname"`
	Platform        string `json:"platform" mapstructure:"platform"`
	OS              string `json:"os" mapstructure:"os"`
	Uptime          uint64 `json:"uptime" mapstructure:"uptime"`
	RemainingMemory uint64 `json:"remaining_memory" mapstructure:"remaining_memory"`
}

type Commands struct {
	C []string `mapstructure:"run"`
}

type GPU struct {
	Name         string `json:"Name"`
	Manufacturer string `json:"Manufacturer"`
	Count        int    `json:"Count"`
	MemoryInfo   struct {
		SizeInMiB int `json:"SizeInMiB"`
	} `json:"MemoryInfo"`
}

type GpuInfo struct {
	Gpus                []GPU `json:"Gpus"`
	TotalGpuMemoryInMiB int   `json:"TotalGpuMemoryInMiB"`
}

type Instance struct {
	gorm.Model
	CedanaID         string  `json:"-"`            // ignore json unmarshal. Cedana ID used for NATS messages
	AllocatedID      string  `json:"allocated_id"` // id allocated by the provider, not to be used as a key
	Provider         string  `json:"provider"`
	InstanceType     string  `json:"InstanceType"`
	AcceleratorName  string  `json:"AcceleratorName"`
	AcceleratorCount int     `json:"AcceleratorCount"`
	VCPUs            float64 `json:"vCPUs"`
	MemoryGiB        float64 `json:"MemoryGiB"`
	GPUs             string  `json:"GPU"`
	Region           string  `json:"Region"`
	AvailabilityZone string  `json:"AvailabilityZone"`
	Price            float64 `json:"Price"`
	IPAddress        string  `json:"ip_addr"`
	State            string  `json:"state"`
	Tag              string  `json:"-"` // tag instance as orch or client
}

type Job struct {
	gorm.Model
	JobID              string    `json:"job_id"`        // ignore json unmarshal
	JobFilePath        string    `json:"job_file_path"` // absolute path of job file
	Instances          string    `json:"instances"`     // serialized instances.TODO: need to figure out associations!!
	State              JobState  `json:"state"`
	Checkpointed       bool      `json:"checkpointed"`
	LastCheckpointedAt time.Time `json:"last_checkpointed_at"` // latest checkpoint
	Bucket             string    `json:"bucket"`
}

type JobFile struct {
	JobFilePath       string            `mapstructure:"job_file_path"`
	WorkDir           string            `mapstructure:"work_dir"` // TODO NR - data storage abstractions
	Containerized     bool              `mapstructure:"containerized"`
	UserInstanceSpecs UserInstanceSpecs `mapstructure:"instance_specs"`
	SetupCommands     Commands          `mapstructure:"setup"`
	Task              Commands          `mapstructure:"task"`
	RestoredTask      Commands          `mapstructure:"restored_task"`
}

type JobState string

type MetaState struct {
	Event            ProviderEvent    `json:"provider_event" mapstructure:"provider_event"`
	CheckpointReason CheckpointReason `json:"checkpoint_reason" mapstructure:"checkpoint_reason"`
}

type PricingModel interface {
	GetPrices() []Instance
}

type ProcessInfo struct {
	PID                     int32                   `json:"pid" mapstructure:"pid"`
	AttachedToHardwareAccel bool                    `json:"attached_to_hardware_accel" mapstructure:"attached_to_hardware_accel"`
	OpenFds                 []process.OpenFilesStat `json:"open_fds" mapstructure:"open_fds"` // list of open FDs
	OpenWriteOnlyFilePaths  []string                `json:"open_write_only" mapstructure:"open_write_only"`
	OpenConnections         []net.ConnectionStat    `json:"open_connections" mapstructure:"open_connections"` // open network connections
	MemoryPercent           float32                 `json:"memory_percent" mapstructure:"memory_percent"`     // % of total RAM used
	IsRunning               bool                    `json:"is_running" mapstructure:"is_running"`
	Status                  string                  `json:"status" mapstructure:"status"`
}

type Provider interface {
	// CreateInstance takes a list of "optimal" instances as input and creates them.
	// We take multiple to circumvent any capacity issues.
	Name() string
	CreateInstance(Candidate *Instance) (*Instance, error)
	DestroyInstance(i Instance) error
	// Anywhere describeInstance is called, the entry in the db should be updated with the latest information
	DescribeInstance(Instances []*Instance, filter string) error
	// should encapsulate all events or state changes on the instance. Function that is used for state polling
	// regularly, so keep efficiency in mind when designing for a provider.
	GetInstanceStatus(i Instance) (*ProviderEvent, error)
}

type ProviderEvent struct {
	InstanceID string `json:"instance_id"`
	FaultCode  string `json:"fault_code"`
	// the below fields are deriviatives of the above, we keep the fault code for any downstream processing
	MarkedForTermination bool  `json:"marked_for_termination"`
	TerminationTime      int64 `json:"termination_time"`
}

type SerializedInstance struct {
	InstanceID string `json:"instance_id"`
}

type ServerCommand struct {
	Command     string      `json:"command" mapstructure:"command"`
	Heartbeat   bool        `json:"heartbeat" mapstructure:"heartbeat"`
	CedanaState CedanaState `json:"cedana_state" mapstructure:"cedana_state"`
}

type UserCommands struct {
	SetupCommands     Commands `mapstructure:"setup"`
	PostSetupCommands Commands `mapstructure:"post_setup"`
	PreCheckpoint     Commands `mapstructure:"pre_checkpoint"`
	PostCheckpoint    Commands `mapstructure:"post_checkpoint"`
	PreRestore        Commands `mapstructure:"pre_restore"`
	PostRestore       Commands `mapstructure:"post_restore"`
}

type UserInstanceSpecs struct {
	InstanceType string  `mapstructure:"instance_type"`
	Memory       int     `mapstructure:"memory_gb"`
	VCPUs        int     `mapstructure:"cpu_cores"`
	VRAM         int     `mapstructure:"vram_gb"`
	GPU          string  `mapstructure:"gpu"`
	MaxPrice     float64 `mapstructure:"max_price_usd_hour"`
}