Task is a wrapper over tbb::task to support policies. More...

#include <task.h>

Inheritance diagram for Task:

[legend]

Public Types
enum	State { INIT , WAIT , RUN }
	Task states. More...

enum	TbbState { TBB_INIT , TBB_ENQUEUED , TBB_EXEC , TBB_DONE }

Public Member Functions
	Task (int task_id, int task_instance)

	Task (int task_id)

virtual	~Task ()

virtual bool	Run ()=0
	Code to execute. Returns true if task is completed. Return false to reschedule the task. More...

virtual void	OnTaskCancel ()
	Called on task exit, if it is marked for cancellation. If the user wants to do any cleanup on task cancellation, then he/she can overload this function. More...

State	GetState () const

int	GetTaskId () const

int	GetTaskInstance () const

uint64_t	GetSeqno () const

bool	task_cancelled () const

virtual std::string	Description () const =0

uint64_t	enqueue_time () const

uint64_t	schedule_time () const

uint32_t	execute_delay () const

uint32_t	schedule_delay () const

Static Public Member Functions
static Task *	Running ()
	Returns a pointer to the current task the code is executing under. More...

Static Public Attributes
static const int	kTaskInstanceAny = -1

Private Member Functions
void	SetSeqNo (uint64_t seqno)

void	SetTbbState (TbbState s)

void	SetState (State s)

void	SetTaskRecycle ()

void	SetTaskComplete ()

void	StartTask (TaskScheduler *scheduler)
	Starts execution of a task. More...

	DISALLOW_COPY_AND_ASSIGN (Task)

Private Attributes
int	task_id_
	The code path executed by the task. More...

int	task_instance_
	The dataset id within a code path. More...

tbb::task *	task_impl_

State	state_

TbbState	tbb_state_

uint64_t	seqno_

bool	task_recycle_

bool	task_cancel_

uint64_t	enqueue_time_

uint64_t	schedule_time_

uint32_t	execute_delay_

uint32_t	schedule_delay_

boost::intrusive::list_member_hook	waitq_hook_

Friends
class	TaskEntry

class	TaskScheduler

class	TaskImpl

std::ostream &	operator<< (std::ostream &out, const Task &task)

Detailed Description

Task is a wrapper over tbb::task to support policies.

There are two kind of tasks,

<task-id, instance-id> specifies task with a given instance-id
<task-id> specifies task without any instance

The policies can be specified in the form of, task(tid0) => <tid1, -1> <tid2, 2> <tid3, 3> The rule implies that:

Task <tid0, *> cannot run as long as <tid1, *> is running
Task <tid0, 2> cannot run as long as task <tid2, 2> is running
Task <tid0, 3> cannot run as long as task <tid3, 3> is running

The policy rules are symmetric. That is:

Task <tid1, *> cannot run as long as <tid0, *> is running
Task <tid2, 2> cannot run as long as task <tid0, 2> is running
Task <tid3, 3> cannot run as long as task <tid0, 3> is running

If task_instance == -1, means instance is not applicable. It implies that, any number of tasks with instance -1 can run at a time

If task_instance != -1, only one task of given instnace can run at a time

When there are multiple tasks ready to run, they are scheduled in their order of enqueue

Definition at line 86 of file task.h.

Member Enumeration Documentation

◆ State

enum Task::State

Task states.

Enumerator
INIT
WAIT
RUN

Definition at line 89 of file task.h.

◆ TbbState

enum Task::TbbState

Enumerator
TBB_INIT
TBB_ENQUEUED
TBB_EXEC
TBB_DONE

Definition at line 95 of file task.h.

Constructor & Destructor Documentation

◆ Task() [1/2]

Task::Task	(	int	task_id,
		int	task_instance
	)

Definition at line 1529 of file task.cc.

◆ Task() [2/2]

Task::Task ( int task_id )

Definition at line 1535 of file task.cc.

◆ ~Task()

virtual Task::~Task ( )

inlinevirtual

Definition at line 105 of file task.h.

Member Function Documentation

◆ Description()

virtual std::string Task::Description ( ) const

pure virtual

Implemented in RequestPipeline::StageWorker, UdpServer::Reader, TcpSession::Reader, SslSession::SslReader, HttpSession::RequestHandler, cass::cql::impl::WorkerTask, ConfigEtcdClient::EtcdWatcher, ConfigAmqpClient::RabbitMQReader, PipelineWorker, Timer::TimerTask, TaskTrigger::WorkerTask, ConcurrencyScope::ScopeTask, QueueTaskRunner< QueueEntryT, QueueT >, QueueTaskRunner< QueueEntryT, WorkQueue< QueueEntryT > >, SessionStatsCollector::SessionTask, FlowStatsCollector::AgeingTask, MockGenerator::SendSessionTask, MockGenerator::SendMessageTask, RestServerGetVmCfgTask, SandeshVmVnToVmiTask, SandeshVmiToVmVnTask, SandeshVmVnPortSubscribeTask, SandeshVmiPortSubscribeTask, PktSandeshFlow, PhysicalSwitchSandeshTask, OVSDB::OvsdbSandeshTask, OvsdbClientSandesTask, OVSDB::LogicalSwitchEntry::ProcessDeleteOvsReqTask, OVSDB::LogicalSwitchTable::ProcessDeleteTableReqTask, VxLanConfigSandeshTask, ConfigPhysicalDeviceVnSandesh, MacLearningSandeshResp, FlowKState, KSyncTxQueueTask, KSyncSockUdsReadTask, KSyncSockTcpReadTask, ChannelEventProcTask, IFMapUpdateSender::SendTask, IFMapServer::IFMapVmSubscribe, IFMapServer::IFMapStaleEntriesCleaner, IFMapAgentStaleCleaner::IFMapAgentStaleCleanerWorker, DBTableWalker::Worker, DBTable::WalkWorker, DBPartition::QueueRunner, and BgpSenderPartition::Worker.

◆ DISALLOW_COPY_AND_ASSIGN()

Task::DISALLOW_COPY_AND_ASSIGN ( Task )

private

◆ enqueue_time()

uint64_t Task::enqueue_time ( ) const

inline

Definition at line 130 of file task.h.

◆ execute_delay()

uint32_t Task::execute_delay ( ) const

inline

Definition at line 132 of file task.h.

◆ GetSeqno()

uint64_t Task::GetSeqno ( ) const

inline

Definition at line 120 of file task.h.

◆ GetState()

State Task::GetState ( ) const

inline

Definition at line 117 of file task.h.

◆ GetTaskId()

int Task::GetTaskId ( ) const

inline

Definition at line 118 of file task.h.

◆ GetTaskInstance()

int Task::GetTaskInstance ( ) const

inline

Definition at line 119 of file task.h.

◆ OnTaskCancel()

virtual void Task::OnTaskCancel ( )

inlinevirtual

Called on task exit, if it is marked for cancellation. If the user wants to do any cleanup on task cancellation, then he/she can overload this function.

Reimplemented in Timer::TimerTask.

Definition at line 114 of file task.h.

◆ Run()

virtual bool Task::Run ( )

pure virtual

Code to execute. Returns true if task is completed. Return false to reschedule the task.

Implemented in RequestPipeline::StageWorker, UdpServer::Reader, TcpSession::Reader, SslSession::SslReader, HttpSession::RequestHandler, cass::cql::impl::WorkerTask, ConfigEtcdClient::EtcdWatcher, ConfigAmqpClient::RabbitMQReader, PipelineWorker, Timer::TimerTask, TaskTrigger::WorkerTask, ConcurrencyScope::ScopeTask, QueueTaskRunner< QueueEntryT, QueueT >, QueueTaskRunner< QueueEntryT, WorkQueue< QueueEntryT > >, SessionStatsCollector::SessionTask, FlowStatsCollector::AgeingTask, MockGenerator::SendSessionTask, MockGenerator::SendMessageTask, RestServerGetVmCfgTask, SandeshVmVnToVmiTask, SandeshVmiToVmVnTask, SandeshVmVnPortSubscribeTask, SandeshVmiPortSubscribeTask, PktSandeshFlowStats, PktSandeshFlow, PhysicalSwitchSandeshTask, OVSDB::OvsdbSandeshTask, OvsdbClientSandesTask, OVSDB::LogicalSwitchEntry::ProcessDeleteOvsReqTask, OVSDB::LogicalSwitchTable::ProcessDeleteTableReqTask, VxLanConfigSandeshTask, ConfigPhysicalDeviceVnSandesh, MacLearningSandeshResp, FlowKState, KSyncTxQueueTask, KSyncSockUdsReadTask, KSyncSockTcpReadTask, ChannelEventProcTask, IFMapUpdateSender::SendTask, IFMapServer::IFMapVmSubscribe, IFMapServer::IFMapStaleEntriesCleaner, IFMapAgentStaleCleaner::IFMapAgentStaleCleanerWorker, DBTableWalker::Worker, DBTable::WalkWorker, DBPartition::QueueRunner, and BgpSenderPartition::Worker.

◆ Running()

Task * Task::Running ( )

static

Returns a pointer to the current task the code is executing under.

Definition at line 1562 of file task.cc.

◆ schedule_delay()

uint32_t Task::schedule_delay ( ) const

inline

Definition at line 133 of file task.h.

◆ schedule_time()

uint64_t Task::schedule_time ( ) const

inline

Definition at line 131 of file task.h.

◆ SetSeqNo()

void Task::SetSeqNo ( uint64_t seqno )

inlineprivate

Definition at line 139 of file task.h.

◆ SetState()

void Task::SetState ( State s )

inlineprivate

Definition at line 141 of file task.h.

◆ SetTaskComplete()

void Task::SetTaskComplete ( )

inlineprivate

Definition at line 143 of file task.h.

◆ SetTaskRecycle()

void Task::SetTaskRecycle ( )

inlineprivate

Definition at line 142 of file task.h.

◆ SetTbbState()

void Task::SetTbbState ( TbbState s )

inlineprivate

Definition at line 140 of file task.h.

◆ StartTask()

void Task::StartTask ( TaskScheduler * scheduler )

private

Starts execution of a task.

Definition at line 1542 of file task.cc.

Here is the call graph for this function:

◆ task_cancelled()

bool Task::task_cancelled ( ) const

inline

Definition at line 127 of file task.h.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<<	(	std::ostream &	out,
		const Task &	task
	)

friend

◆ TaskEntry

friend class TaskEntry

friend

Definition at line 136 of file task.h.

◆ TaskImpl

friend class TaskImpl

friend

Definition at line 138 of file task.h.

◆ TaskScheduler

friend class TaskScheduler

friend

Definition at line 137 of file task.h.

Member Data Documentation

◆ enqueue_time_

uint64_t Task::enqueue_time_

private

Definition at line 159 of file task.h.

◆ execute_delay_

uint32_t Task::execute_delay_

private

Definition at line 161 of file task.h.

◆ kTaskInstanceAny

const int Task::kTaskInstanceAny = -1

static

Definition at line 102 of file task.h.

◆ schedule_delay_

uint32_t Task::schedule_delay_

private

Definition at line 162 of file task.h.

◆ schedule_time_

uint64_t Task::schedule_time_

private

Definition at line 160 of file task.h.

◆ seqno_

uint64_t Task::seqno_

private

Definition at line 156 of file task.h.

◆ state_

State Task::state_

private

Definition at line 154 of file task.h.

◆ task_cancel_

bool Task::task_cancel_

private

Definition at line 158 of file task.h.

◆ task_id_

int Task::task_id_

private

The code path executed by the task.

Definition at line 149 of file task.h.

◆ task_impl_

tbb::task* Task::task_impl_

private

Definition at line 153 of file task.h.

◆ task_instance_

int Task::task_instance_

private

The dataset id within a code path.

Definition at line 152 of file task.h.

◆ task_recycle_

bool Task::task_recycle_

private

Definition at line 157 of file task.h.

◆ tbb_state_

TbbState Task::tbb_state_

private

Definition at line 155 of file task.h.

◆ waitq_hook_

boost::intrusive::list_member_hook Task::waitq_hook_

private

Definition at line 164 of file task.h.

The documentation for this class was generated from the following files:

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ State

◆ TbbState

Constructor & Destructor Documentation

◆ Task() [1/2]

◆ Task() [2/2]

◆ ~Task()

Member Function Documentation

◆ Description()

◆ DISALLOW_COPY_AND_ASSIGN()

◆ enqueue_time()

◆ execute_delay()

◆ GetSeqno()

◆ GetState()

◆ GetTaskId()

◆ GetTaskInstance()

◆ OnTaskCancel()

◆ Run()

◆ Running()

◆ schedule_delay()

◆ schedule_time()

◆ SetSeqNo()

◆ SetState()

◆ SetTaskComplete()

◆ SetTaskRecycle()

◆ SetTbbState()

◆ StartTask()

◆ task_cancelled()

Friends And Related Function Documentation

◆ operator<<

◆ TaskEntry

◆ TaskImpl

◆ TaskScheduler

Member Data Documentation

◆ enqueue_time_

◆ execute_delay_

◆ kTaskInstanceAny

◆ schedule_delay_

◆ schedule_time_

◆ seqno_

◆ state_

◆ task_cancel_

◆ task_id_

◆ task_impl_

◆ task_instance_

◆ task_recycle_

◆ tbb_state_

◆ waitq_hook_