sched

type AllocStats struct {
	sync.Mutex `json:"-"`
	AllocStatsData
}

type AllocStatsData struct {
	// Resources is the currently available resources.
	reflow.Resources
	// Dead indicates if this alloc is dead.
	Dead bool
	// TaskIDs is the list of tasks running in this alloc.
	TaskIDs map[string]int
}

type Cluster interface {
	// Allocate returns an alloc with at least req.Min resources, or an
	// error. The requirement's width is used as a hint to size allocs
	// efficiently.
	Allocate(ctx context.Context, req reflow.Requirements, labels pool.Labels) (pool.Alloc, error)

	// CanAllocate returns whether this cluster can allocate the given amount of resources.
	CanAllocate(reflow.Resources) (bool, error)
}

type OverallStats struct {
	// TotalAllocs is the total number of allocs in the system (live or dead).
	TotalAllocs int64
	// TotalTasks is the total number of tasks (pending, running or completed).
	TotalTasks int64
}

type Scheduler struct {
	// Transferer is used to manage data movement between
	// allocs and the scheduler's repository.
	Transferer reflow.Transferer
	// Mux is used to manage direct data transfers between blob stores (if supported)
	Mux blob.Mux
	// Cluster provides dynamic allocation of allocs.
	Cluster Cluster
	// Log logs scheduler actions.
	Log *log.Logger
	// TaskDB is the task reporting db.
	TaskDB taskdb.TaskDB

	// MaxPendingAllocs is the maximum number outstanding
	// alloc requests.
	MaxPendingAllocs int
	// MaxAllocIdleTime is the time after which an idle alloc is
	// collected.
	MaxAllocIdleTime time.Duration

	// DrainTimeout is the duration to wait to see if more tasks have been submitted
	// so that we can combine the requirements of those tasks together to make larger allocs.
	DrainTimeout time.Duration

	// MinAlloc is the smallest resource allocation that is made by
	// the scheduler.
	MinAlloc reflow.Resources

	// Labels is the set of labels applied to newly created allocs.
	Labels pool.Labels

	// Stats is the scheduler stats.
	Stats *Stats
	// contains filtered or unexported fields
}

type Stats struct {
	// Mutex protects all the data members.
	sync.Mutex `json:"-"`
	// OverallStats has the overall scheduler stats.
	OverallStats
	// Allocs has all the alloc stats, including dead ones.
	Allocs map[string]*AllocStats
	// Tasks has all the task state and stats, including completed/error tasks.
	Tasks map[string]*TaskStats
}

type StatsData struct {
	// OverallStats has the overall scheduler stats.
	OverallStats
	// Allocs has all the alloc stats, including dead ones.
	Allocs map[string]AllocStatsData
	// Tasks has all the task state and stats, including completed/error tasks.
	Tasks map[string]TaskStatsData
}

type Task struct {
	// Config is the task's exec config, which is passed on to the
	// alloc after scheduling.
	Config reflow.ExecConfig
	// Repository to use for this task.
	// Repository is the repository from which dependent objects are
	// downloaded and to which result objects are uploaded.
	Repository reflow.Repository
	// Log receives any status log messages during task scheduling
	// and execution.
	Log *log.Logger

	// Err stores any task scheduling error. If Err != nil while the
	// task is TaskDone, then the task failed to run.
	Err error
	// Result stores the Reflow result returned by a successful
	// execution.
	Result reflow.Result

	// RunInfo stores log/inspect information from the exec.
	RunInfo reflow.ExecRunInfo

	// Exec is the exec which is running (or ran) the task. Exec is
	// set by the scheduler before the task enters TaskRunning state.
	Exec reflow.Exec

	// Priority is the task priority. Lower numbers indicate higher priority.
	// Higher priority tasks will get scheduler before any lower priority tasks.
	Priority int

	// PostUseChecksum indicates whether input filesets are checksummed after use.
	PostUseChecksum bool

	// ExpectedDuration is the duration the task is expected to take used only as a hint
	// by the scheduler for better scheduling.
	ExpectedDuration time.Duration

	// RunID that created this task.
	RunID taskdb.RunID
	// FlowID is the digest (flow.Digest) of the flow for which this task was created.
	FlowID digest.Digest

	// TaskDB is where the task row for this task is recorded and is set by the scheduler only after the task was attempted.
	TaskDB taskdb.TaskDB
	// contains filtered or unexported fields
}

type TaskSet map[*Task]bool

type TaskState int

type TaskStats struct {
	// Mutex protects TaskStatsData.
	sync.Mutex `json:"-"`
	// TaskStatsData are the task stats.
	TaskStatsData
}

type TaskStatsData struct {
	// Ident is the exec identifier of this task.
	Ident string
	// Type is the type of exec.
	Type string
	// State is the current state of the task.
	State int
	// Error if not nil, is the task error.
	Error error
	// RunID is the run the task belongs to.
	RunID string
	// FlowID is the flow corresponding to this task.
	FlowID string
}