types

type BasicMgr interface {
	// if there a task running in work
	Alive() int64

	// call it when a task enter
	EnterTask()

	// call it when a task leave
	LeaveTask()

	// get work settings
	Settings() *WorkSettings

	// update work settings
	SetSettings(settings *WorkSettings)

	// get work info
	Info() *WorkInfo

	// update single job stats
	UpdateJobStats(stats *dcSDK.ControllerJobStats)

	// update work stats
	UpdateWorkStats(stats *WorkStats)

	// update work heartbeat
	Heartbeat() error

	// do register work
	Register(config *WorkRegisterConfig) error

	// do apply resource
	ApplyResource(config *WorkRegisterConfig) error

	// do unregister work
	Unregister(config *WorkUnregisterConfig) error

	// start work
	Start() error

	// end work
	End(timeoutBefore time.Duration) error

	// hang until the work is working(by someone else)
	WaitUntilWorking(ctx context.Context) bool

	// get work details
	GetDetails(jobIndex int) *WorkStatsDetail

	// get analysis status
	AnalysisStatus() *WorkAnalysisStatus

	// reset stat
	ResetStat() error

	// update toolchain
	SetToolChain(toolchain *ToolChain) error

	// get toolchain files by key
	GetToolChainFiles(key string) ([]dcSDK.FileDesc, int64, error)

	// get toolchain relative files by key
	GetToolChainRelativeFiles(key string) ([]dcSDK.FileDesc, int64, error)

	// get toolchain remote path by key
	GetToolChainRemotePath(key string) (string, error)

	// get toolchain remote Relative path by key
	GetToolChainRelativeRemotePath(key string) (string, error)

	// get toolchain timestamp by key
	GetToolChainTimestamp(key string) (int64, error)

	// add registered count for batch mode
	IncRegistered()

	// minus registered count for batch mode
	DecRegistered()
}

type CB4ResChanged func() error

type CommonConfig struct {
	Configkey dcSDK.CommonConfigKey
	WorkerKey WorkerKeyConfig
	Data      []byte
	Config    interface{}
}

type FileCollectionInfo struct {
	UniqID     string           `json:"uniq_id"`
	SendStatus FileSendStatus   `json:"send_status"`
	Files      []dcSDK.FileDesc `json:"files"`
	Timestamp  int64            `json:"timestamp"`
}

type FileInfo struct {
	FullPath           string         `json:"full_path"`
	Size               int64          `json:"size"`
	LastModifyTime     int64          `json:"last_modify_time"`
	Md5                string         `json:"md5"`
	TargetRelativePath string         `json:"target_relative_path"`
	FileMode           uint32         `json:"file_mode"`
	LinkTarget         string         `json:"link_target"`
	SendStatus         FileSendStatus `json:"send_status"`
}

type FileSendStatus int

type FilesByServer struct {
	Server string
	Files  []*FileInfo
}

type FilesDetails struct {
	Servers []*dcProtocol.Host
	File    dcSDK.FileDesc
}

type JobStats struct {
	Pid         int    `json:"pid"`
	WorkID      string `json:"work_id"`
	TaskID      string `json:"task_id"`
	BoosterType string `json:"booster_type"`

	Success           bool `json:"success"`
	PreWorkSuccess    bool `json:"pre_work_success"`
	RemoteWorkSuccess bool `json:"remote_work_success"`
	PostWorkSuccess   bool `json:"post_work_success"`
	FinalWorkSuccess  bool `json:"final_work_success"`
	LocalWorkSuccess  bool `json:"local_work_success"`

	OriginArgs []string `json:"origin_args"`

	EnterTime int64 `json:"enter_time"`
	LeaveTime int64 `json:"leave_time"`

	PreWorkEnterTime  int64 `json:"pre_work_enter_time"`
	PreWorkLeaveTime  int64 `json:"pre_work_leave_time"`
	PreWorkLockTime   int64 `json:"pre_work_lock_time"`
	PreWorkUnlockTime int64 `json:"pre_work_unlock_time"`
	PreWorkStartTime  int64 `json:"pre_work_start_time"`
	PreWorkEndTime    int64 `json:"pre_work_end_time"`

	PostWorkEnterTime  int64 `json:"post_work_enter_time"`
	PostWorkLeaveTime  int64 `json:"post_work_leave_time"`
	PostWorkLockTime   int64 `json:"post_work_lock_time"`
	PostWorkUnlockTime int64 `json:"post_work_unlock_time"`
	PostWorkStartTime  int64 `json:"post_work_start_time"`
	PostWorkEndTime    int64 `json:"post_work_end_time"`

	FinalWorkStartTime int64 `json:"final_work_start_time"`
	FinalWorkEndTime   int64 `json:"final_work_end_time"`

	RemoteWorkEnterTime           int64 `json:"remote_work_enter_time"`
	RemoteWorkLeaveTime           int64 `json:"remote_work_leave_time"`
	RemoteWorkLockTime            int64 `json:"remote_work_lock_time"`
	RemoteWorkUnlockTime          int64 `json:"remote_work_unlock_time"`
	RemoteWorkStartTime           int64 `json:"remote_work_start_time"`
	RemoteWorkEndTime             int64 `json:"remote_work_end_time"`
	RemoteWorkPackStartTime       int64 `json:"remote_work_pack_start_time"`
	RemoteWorkPackEndTime         int64 `json:"remote_work_pack_end_time"`
	RemoteWorkSendStartTime       int64 `json:"remote_work_send_start_time"`
	RemoteWorkSendEndTime         int64 `json:"remote_work_send_end_time"`
	RemoteWorkPackCommonStartTime int64 `json:"remote_work_pack_common_start_time"`
	RemoteWorkPackCommonEndTime   int64 `json:"remote_work_pack_common_end_time"`
	RemoteWorkSendCommonStartTime int64 `json:"remote_work_send_common_start_time"`
	RemoteWorkSendCommonEndTime   int64 `json:"remote_work_send_common_end_time"`
	RemoteWorkProcessStartTime    int64 `json:"remote_work_process_start_time"`
	RemoteWorkProcessEndTime      int64 `json:"remote_work_process_end_time"`
	RemoteWorkReceiveStartTime    int64 `json:"remote_work_receive_start_time"`
	RemoteWorkReceiveEndTime      int64 `json:"remote_work_receive_end_time"`
	RemoteWorkUnpackStartTime     int64 `json:"remote_work_unpack_start_time"`
	RemoteWorkUnpackEndTime       int64 `json:"remote_work_unpack_end_time"`

	LocalWorkEnterTime  int64 `json:"local_work_enter_time"`
	LocalWorkLeaveTime  int64 `json:"local_work_leave_time"`
	LocalWorkLockTime   int64 `json:"local_work_lock_time"`
	LocalWorkUnlockTime int64 `json:"local_work_unlock_time"`
	LocalWorkStartTime  int64 `json:"local_work_start_time"`
	LocalWorkEndTime    int64 `json:"local_work_end_time"`
}

type LocalMgr interface {
	// init handler
	Init()

	Start()

	// lock local slot
	LockSlots(usage dcSDK.JobUsage, weight int32) bool

	// unlock local slot
	UnlockSlots(usage dcSDK.JobUsage, weight int32)

	// do task execution
	ExecuteTask(req *LocalTaskExecuteRequest,
		globalWork *Work,
		withlocalresource bool) (*LocalTaskExecuteResult, error)

	// get caches in pump mode
	GetPumpCache() (*analyser.FileCache, *analyser.RootCache)

	// get local slots info
	Slots() (int, int)
}

type LocalSlotsFreeConfig struct {
	Usage  dcSDK.JobUsage
	Weight int32 `json:"weight"`
}

type LocalSlotsOccupyConfig struct {
	Usage  dcSDK.JobUsage
	Weight int32 `json:"weight"`
}

type LocalTaskExecuteRequest struct {
	Pid          int
	Dir          string
	User         user.User
	Commands     []string
	Environments []string
	Stats        *dcSDK.ControllerJobStats
}

type LocalTaskExecuteResult struct {
	Result *dcSDK.LocalTaskResult
}

type Mgr interface {
	// brings up the handler
	Run()

	// register work with config, return the work information,
	// and tell the caller if he is a leader in batch mode(always true in normal mode)
	RegisterWork(config *WorkRegisterConfig) (*WorkInfo, bool, error)

	// unregister specific work
	UnregisterWork(workID string, config *WorkUnregisterConfig) error

	// update heartbeat to work
	Heartbeat(workID string) error

	// start the work
	StartWork(workID string) error

	// end the work
	EndWork(workID string) error

	// update work settings
	SetWorkSettings(workID string, settings *WorkSettings) error

	// get work settings
	GetWorkSettings(workID string) (*WorkSettings, error)

	// get work status
	GetWorkStatus(workID string) (*dcSDK.WorkStatusDetail, error)

	// lock a local slot
	LockLocalSlots(workID string, usage dcSDK.JobUsage, weight int32) error

	// unlock a local slot
	UnlockLocalSlots(workID string, usage dcSDK.JobUsage, weight int32) error

	// do task
	ExecuteLocalTask(workID string, req *LocalTaskExecuteRequest) (*LocalTaskExecuteResult, error)

	// do remote task directly
	ExecuteRemoteTask(workID string, req *RemoteTaskExecuteRequest) (*RemoteTaskExecuteResult, error)

	// send files to remote worker
	SendRemoteFile(workID string, req *RemoteTaskSendFileRequest) error

	// update single job stats
	UpdateJobStats(workID string, stats *dcSDK.ControllerJobStats) error

	// update work stats
	UpdateWorkStats(workID string, stats *WorkStats) error

	// get work list
	GetWorkDetailList() WorkStatsDetailList

	// get work detail
	GetWorkDetail(workID string, index int) (*WorkStatsDetail, error)

	// update common controller config
	SetCommonConfig(config *CommonConfig) error

	// get caches in pump mode
	GetPumpCache(workID string) (*analyser.FileCache, *analyser.RootCache, error)

	// Get first workid
	GetFirstWorkID() (string, error)

	// Get first bazelNoLauncher workid
	GetFirstBazelNoLauncherWorkID() (string, error)
}

type MgrSet struct {
	Basic    func(context.Context, *Work) BasicMgr
	Local    func(context.Context, *Work) LocalMgr
	Remote   func(context.Context, *Work) RemoteMgr
	Resource func(context.Context, *Work) ResourceMgr
}

type RemoteMgr interface {
	// init handler
	Init()

	Start()

	// run task in remote worker
	ExecuteTask(req *RemoteTaskExecuteRequest) (*RemoteTaskExecuteResult, error)

	// send files to remote worker
	SendFiles(req *RemoteTaskSendFileRequest) ([]string, error)

	// get total remote worker slots
	TotalSlots() int

	// inc remote jobs
	IncRemoteJobs()

	// dec remote jobs
	DecRemoteJobs()
}

type RemoteTaskExecuteRequest struct {
	Pid           int
	Server        *dcProtocol.Host
	Req           *dcSDK.BKDistCommand
	Stats         *dcSDK.ControllerJobStats
	Sandbox       *dcSyscall.Sandbox
	IOTimeout     int
	BanWorkerList []*dcProtocol.Host
}

type RemoteTaskExecuteResult struct {
	Result *dcSDK.BKDistResult
}

type RemoteTaskSendFileRequest struct {
	Pid     int
	Server  *dcProtocol.Host
	Req     []dcSDK.FileDesc
	Sandbox *dcSyscall.Sandbox
	Stats   *dcSDK.ControllerJobStats
}

type RemoteTaskSendFileResult struct {
	Result *dcSDK.BKSendFileResult
}

type ResourceMgr interface {
	// check if there are ready-to-work workers
	HasAvailableWorkers() bool

	// update tbs-server target
	SetServerHost(serverHost string)

	// update specific worker list
	SetSpecificHosts(hostList []string)

	// send stats, if brief true, then will not send the job stats
	SendStats(brief bool) error

	// send stats and reset after sent, if brief true, then will not send the job stats
	// !! this will call m.work.Lock() , to avoid dead lock
	SendAndResetStats(brief bool, resapplytimes []int64) error

	// get resource status
	GetStatus() *v2.RespTaskInfo

	// get worker list
	GetHosts() []*dcProtocol.Host

	// apply resource
	Apply(req *v2.ParamApply, force bool) (*v2.RespTaskInfo, error)

	// release resource
	Release(req *v2.ParamRelease) error

	// register call back function
	RegisterCallback(f CB4ResChanged) error

	// check whether apply finished
	IsApplyFinished() bool

	// TODO : check whether support abs path
	SupportAbsPath() bool
}

type ToolChain struct {
	ToolKey                string
	ToolName               string
	ToolLocalFullPath      string
	ToolRemoteRelativePath string
	Files                  []dcSDK.ToolFile
	Timestamp              int64
}

type Work struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

type WorkAnalysisStatus struct {
	// contains filtered or unexported fields
}

type WorkCommonStatus struct {
	Status                  dcSDK.WorkStatus
	Message                 string
	LastStatusChangeTime    time.Time
	InitTime                time.Time
	StartTime               time.Time
	EndTime                 time.Time
	RegisteredTime          time.Time
	UnregisteredTime        time.Time
	ResourceApplyingTime    time.Time
	ResourceAppliedTime     time.Time
	ResourceApplyFailedTime time.Time
	RemovableTime           time.Time
}

type WorkInfo struct {
	// contains filtered or unexported fields
}

type WorkRegisterConfig struct {
	BatchMode        bool           `json:"batch_mode"`
	ServerHost       string         `json:"server_host"`
	SpecificHostList []string       `json:"specific_host_list"`
	NeedApply        bool           `json:"need_apply"`
	Apply            *v2.ParamApply `json:"apply"`
}

type WorkSettings struct {
	TaskID          string
	ProjectID       string
	Scene           string
	UsageLimit      map[dcSDK.JobUsage]int
	LocalTotalLimit int
	Preload         *dcSDK.PreloadConfig
	FilterRules     dcSDK.FilterRules
	Degraded        bool
	GlobalSlots     bool
}

type WorkStats struct {
	Success bool `json:"success"`
}

type WorkStatsDetail struct {
	CurrentTime      int64                       `json:"current_time"`
	WorkID           string                      `json:"work_id"`
	TaskID           string                      `json:"task_id"`
	Scene            string                      `json:"scene"`
	Status           string                      `json:"status"`
	Success          bool                        `json:"success"`
	RegisteredTime   int64                       `json:"registered_time"`
	UnregisteredTime int64                       `json:"unregistered_time"`
	StartTime        int64                       `json:"start_time"`
	EndTime          int64                       `json:"end_time"`
	JobRemoteOK      int                         `json:"job_remote_ok"`
	JobRemoteError   int                         `json:"job_remote_error"`
	JobLocalOK       int                         `json:"job_local_ok"`
	JobLocalError    int                         `json:"job_local_error"`
	Jobs             []*dcSDK.ControllerJobStats `json:"jobs"`
}

type WorkStatsDetailList []*WorkStatsDetail

type WorkUnregisterConfig struct {
	Force         bool             `json:"force"`
	TimeoutBefore time.Duration    `json:"timeout_before"`
	Release       *v2.ParamRelease `json:"release"`
}

type WorkerKeyConfig struct {
	BatchMode bool
	ProjectID string
	Scene     string
}