This group is for the self wok unit. More...

Functions
int	ABT_self_get_xstream (ABT_xstream *xstream)
	Get an execution stream that is running the calling work unit. More...

int	ABT_self_get_xstream_rank (int *rank)
	Return a rank of an execution stream that is running the calling work unit. More...

int	ABT_self_get_thread (ABT_thread *thread)
	Get the calling work unit. More...

int	ABT_self_get_thread_id (ABT_unit_id *id)
	Get ID of the calling work unit. More...

int	ABT_self_get_task (ABT_thread *thread)
	Get the calling work unit. More...

int	ABT_self_get_task_id (ABT_unit_id *id)
	Get ID of the calling work unit. More...

int	ABT_self_set_specific (ABT_key key, void *value)
	Associate a value with a work-unit-specific data key in the calling work unit. More...

int	ABT_self_get_specific (ABT_key key, void **value)
	Get a value associated with a work-unit-specific data key in the calling work unit. More...

int	ABT_self_get_type (ABT_unit_type *type)
	Obtain a type of the caller. More...

int	ABT_self_is_primary (ABT_bool *is_primary)
	Check if the caller is the primary ULT. More...

int	ABT_self_on_primary_xstream (ABT_bool *on_primary)
	Check if the caller is running on the primary execution stream. More...

int	ABT_self_get_last_pool (ABT_pool *pool)
	Get the last pool of the calling work unit. More...

int	ABT_self_get_last_pool_id (int *pool_id)
	Get ID of the last pool of the calling work unit. More...

int	ABT_self_set_associated_pool (ABT_pool pool)
	Set an associated pool for the calling work unit. More...

int	ABT_self_get_unit (ABT_unit *unit)
	Get a unit handle of the calling work unit. More...

int	ABT_self_yield (void)
	Yield the calling ULT to its parent ULT. More...

int	ABT_self_yield_to (ABT_thread thread)
	Yield the calling ULT to another ULT. More...

int	ABT_self_resume_yield_to (ABT_thread thread)
	Yield the calling ULT to another suspended ULT. More...

int	ABT_self_suspend (void)
	Suspend the calling ULT. More...

int	ABT_self_suspend_to (ABT_thread thread)
	Suspend the calling ULT and jump to another ULT. More...

int	ABT_self_resume_suspend_to (ABT_thread thread)
	Suspend the calling ULT and jump to another suspended ULT. More...

int	ABT_self_exit (void)
	Terminate a calling ULT. More...

int	ABT_self_exit_to (ABT_thread thread)
	Terminate the calling ULT and jump to another ULT. More...

int	ABT_self_resume_exit_to (ABT_thread thread)
	Terminate the calling ULT and jump to another suspended ULT. More...

int	ABT_self_schedule (ABT_thread thread, ABT_pool pool)
	Execute a work unit on the calling ULT. More...

int	ABT_self_set_arg (void *arg)
	Set an argument for a work-unit function of the calling work unit. More...

int	ABT_self_get_arg (void **arg)
	Retrieve an argument for a work-unit function of the calling work unit. More...

int	ABT_self_get_thread_func (void(*thread_func)(void ))
	Retrieve a work-unit function of the calling work unit. More...

int	ABT_self_is_unnamed (ABT_bool *is_unnamed)
	Check if the calling work unit is unnamed. More...

Detailed Description

This group is for the self wok unit.

Function Documentation

◆ ABT_self_exit()

int ABT_self_exit ( void )

Terminate a calling ULT.

ABT_self_exit() terminates the calling ULT. This routine does not return if it succeeds.

Execution context: This routine can be called in a ULT context. Argobots must be initialized. This routine may switch the context of the calling ULT.

Errors: ABT_ERR_INV_XSTREAM is returned if the caller is an external thread.
ABT_ERR_INV_THREAD is returned if the caller is a tasklet.
ABT_ERR_INV_THREAD is returned if the caller is the primary ULT.

Undefined behavior: If Argobots is not initialized, the results are undefined.

Returns: Error code

Definition at line 934 of file self.c.

◆ ABT_self_exit_to()

int ABT_self_exit_to ( ABT_thread thread )

Terminate the calling ULT and jump to another ULT.

ABT_self_exit_to() terminates the calling ULT and schedules the ULT thread as a child thread of the calling ULT's parent. This routine does not return if it succeeds. It is the user's responsibility to pop thread from its associated pool before calling this routine.

Execution context: This routine can be called in a ULT context. Argobots must be initialized. This routine may switch the context of the calling ULT.

Errors: ABT_ERR_INV_THREAD is returned if thread is ABT_THREAD_NULL or ABT_TASK_NULL.
ABT_ERR_INV_XSTREAM is returned if the caller is an external thread.
ABT_ERR_INV_THREAD is returned if the caller is a tasklet.
ABT_ERR_INV_THREAD is returned if thread is a tasklet.
ABT_ERR_INV_THREAD is returned if the caller is the work unit of the main scheduler.
ABT_ERR_INV_THREAD is returned if thread is the work unit of the main scheduler.
ABT_ERR_INV_THREAD is returned if the caller is the primary ULT.
ABT_ERR_INV_THREAD is returned if thread is the caller.

Undefined behavior: If Argobots is not initialized, the results are undefined.
If thread is accessed concurrently, the results are undefined.
If thread, the pool associated with thread is in a pool, the results are undefined.
If thread is not ready, the results are undefined.

Parameters

[in] thread handle to the target thread

Returns: Error code

Definition at line 980 of file self.c.

◆ ABT_self_get_arg()

int ABT_self_get_arg ( void ** arg )

Retrieve an argument for a work-unit function of the calling work unit.

ABT_self_get_arg() returns the argument that is passed to the caller's work-unit function through arg.

Changes from Argobots 1.x to Argobots 2.0 (planned)

[Argobots 1.x] This routine returns ABT_ERR_UNINITIALIZED if Argobots is not initialized.
[Argobots 2.0] The results of this routine are undefined if Argobots is not initialized.

Rationale: From Argobots 2.0, Argobots routines do not check if Argobots is initialized unless otherwise noted. This omission can reduce the branches that are unnecessary in most cases.

[Argobots 1.x] arg is set to NULL if an error occurs.
[Argobots 2.0] arg is not updated if an error occurs.

Rationale: To ensure the atomicity of the API, Argobots 2.0 guarantees that the routine has no effect when an error is returned unless otherwise noted. Argobots 2.0 does not update arg when an error occurs.

Execution context: This routine can be called in a ULT context or a tasklet context. Argobots must be initialized. This routine does not switch the context of the calling ULT unless any user-defined function that is involved in this routine switch the context of the calling ULT.

Errors: ABT_SUCCESS is returned if this routine succeeds.
ABT_ERR_INV_XSTREAM is returned if the caller is an external thread.
[Argobots 1.x] ABT_ERR_UNINITIALIZED is returned if the Argobots runtime is not initialized.

Undefined behavior: If arg is NULL, the results are undefined.
[Argobots 2.0] If Argobots is not initialized, the results are undefined.

Parameters

[out] arg argument for the caller's function

Returns: Error code

Definition at line 1182 of file self.c.

◆ ABT_self_get_last_pool()

int ABT_self_get_last_pool ( ABT_pool * pool )

Get the last pool of the calling work unit.

ABT_self_get_last_pool() returns the last pool associated with the calling work unit through pool.

Execution context: This routine can be called in a ULT context or a tasklet context. Argobots must be initialized. This routine does not switch the context of the calling ULT unless any user-defined function that is involved in this routine switch the context of the calling ULT.

Errors: ABT_SUCCESS is returned if this routine succeeds.
ABT_ERR_INV_XSTREAM is returned if the caller is an external thread.

Undefined behavior: If Argobots is not initialized, the results are undefined.
If pool is NULL, the results are undefined.

Parameters

[out] pool pool handle

Returns: Error code

Definition at line 468 of file self.c.

◆ ABT_self_get_last_pool_id()

int ABT_self_get_last_pool_id ( int * pool_id )

Get ID of the last pool of the calling work unit.

ABT_self_get_last_pool_id() returns the last pool's ID of the calling work unit through pool_id.

Changes from Argobots 1.x to Argobots 2.0 (planned)

[Argobots 1.x] This routine returns ABT_ERR_UNINITIALIZED if Argobots is not initialized.
[Argobots 2.0] The results of this routine are undefined if Argobots is not initialized.

Rationale: From Argobots 2.0, Argobots routines do not check if Argobots is initialized unless otherwise noted. This omission can reduce the branches that are unnecessary in most cases.

[Argobots 1.x] pool_id is set to -1 if an error occurs.
[Argobots 2.0] pool_id is not updated if an error occurs.

Rationale: To ensure the atomicity of the API, Argobots 2.0 guarantees that the routine has no effect when an error is returned unless otherwise noted. Argobots 2.0 does not update pool_id when an error occurs.

Execution context: This routine can be called in a ULT context or a tasklet context. Argobots must be initialized. This routine does not switch the context of the calling ULT unless any user-defined function that is involved in this routine switch the context of the calling ULT.

Errors: ABT_SUCCESS is returned if this routine succeeds.
ABT_ERR_INV_XSTREAM is returned if the caller is an external thread.
[Argobots 1.x] ABT_ERR_UNINITIALIZED is returned if the Argobots runtime is not initialized.

Undefined behavior: If pool_id is NULL, the results are undefined.
[Argobots 2.0] If Argobots is not initialized, the results are undefined.

Parameters

[out] pool_id pool ID

Returns: Error code

Definition at line 509 of file self.c.

◆ ABT_self_get_specific()

int ABT_self_get_specific	(	ABT_key	key,
		void **	value
	)

Get a value associated with a work-unit-specific data key in the calling work unit.

ABT_self_get_specific() returns the value in the caller associated with the work-unit-specific data key key in the calling work unit through value. If the caller has never set a value for key, this routine sets value to NULL.

Work-unit-specific values associated with a work-unit-specific data key are read and updated atomically.

Execution context: This routine can be called in a ULT context or a tasklet context. Argobots must be initialized. This routine does not switch the context of the calling ULT unless any user-defined function that is involved in this routine switch the context of the calling ULT.

Errors: ABT_SUCCESS is returned if this routine succeeds.
ABT_ERR_INV_XSTREAM is returned if the caller is an external thread.
ABT_ERR_INV_KEY is returned if key is ABT_KEY_NULL.

Undefined behavior: If value is NULL, the results are undefined.
If Argobots is not initialized, the results are undefined.

Parameters

[in]	key	work-unit-specific data key handle
[out]	value	value associated with `key`

Returns: Error code

Definition at line 240 of file self.c.

◆ ABT_self_get_task()

int ABT_self_get_task ( ABT_thread * thread )

Get the calling work unit.

The functionality of this routine is the same as ABT_self_get_thread().

◆ ABT_self_get_task_id()

int ABT_self_get_task_id ( ABT_unit_id * id )

Get ID of the calling work unit.

The functionality of this routine is the same as ABT_self_get_thread_id().

◆ ABT_self_get_thread()

int ABT_self_get_thread ( ABT_thread * thread )

Get the calling work unit.

ABT_self_get_thread() returns the handle of the calling work unit through thread.

Execution context: This routine can be called in a ULT context or a tasklet context. Argobots must be initialized. This routine does not switch the context of the calling ULT unless any user-defined function that is involved in this routine switch the context of the calling ULT.

Errors: ABT_SUCCESS is returned if this routine succeeds.
ABT_ERR_INV_XSTREAM is returned if the caller is an external thread.

Undefined behavior: If thread is NULL, the results are undefined.
If Argobots is not initialized, the results are undefined.

Parameters

[out] thread work unit handle

Returns: Error code

Definition at line 101 of file self.c.

◆ ABT_self_get_thread_func()

int ABT_self_get_thread_func ( void(**)(void *) thread_func )

Retrieve a work-unit function of the calling work unit.

ABT_self_get_thread_func() returns the work-unit function of the calling work unit through thread_func.

Execution context: This routine can be called in a ULT context or a tasklet context. Argobots must be initialized. This routine does not switch the context of the calling ULT unless any user-defined function that is involved in this routine switch the context of the calling ULT.

Errors: ABT_SUCCESS is returned if this routine succeeds.
ABT_ERR_INV_XSTREAM is returned if the caller is an external thread.

Undefined behavior: If Argobots is not initialized, the results are undefined.
If thread_func is NULL, the results are undefined.

Parameters

[out] thread_func the caller's function

Returns: Error code

Definition at line 1220 of file self.c.

◆ ABT_self_get_thread_id()

int ABT_self_get_thread_id ( ABT_unit_id * id )

Get ID of the calling work unit.

ABT_self_get_thread_id() returns the ID of the calling work unit through id.

Execution context: This routine can be called in a ULT context or a tasklet context. Argobots must be initialized. This routine does not switch the context of the calling ULT unless any user-defined function that is involved in this routine switch the context of the calling ULT.

Errors: ABT_SUCCESS is returned if this routine succeeds.
ABT_ERR_INV_XSTREAM is returned if the caller is an external thread.

Undefined behavior: If id is NULL, the results are undefined.
If Argobots is not initialized, the results are undefined.

Parameters

[out] id ID of the calling work unit

Returns: Error code

Definition at line 133 of file self.c.

◆ ABT_self_get_type()

int ABT_self_get_type ( ABT_unit_type * type )

Obtain a type of the caller.

ABT_self_get_type() returns a type of the calling work unit through type. If the caller is a ULT, type is set to ABT_UNIT_TYPE_THREAD. If the caller is a tasklet, type is set to ABT_UNIT_TYPE_TASK. Otherwise (i.e., if the caller is an external thread), type is set to ABT_UNIT_TYPE_EXT.

Changes from Argobots 1.x to Argobots 2.0 (planned)

[Argobots 1.x] If an external thread calls this routine, ABT_ERR_INV_XSTREAM is returned.
[Argobots 2.0] An external thread may call this routine.

Rationale: Argobots 2.0 allows an external thread where possible unless it is semantically inappropriate.

[Argobots 1.x] This routine returns ABT_ERR_UNINITIALIZED if Argobots is not initialized.
[Argobots 2.0] The results of this routine are undefined if Argobots is not initialized.

Rationale: From Argobots 2.0, Argobots routines do not check if Argobots is initialized unless otherwise noted. This omission can reduce the branches that are unnecessary in most cases.

[Argobots 1.x] type is set to ABT_UNIT_TYPE_EXT if an error occurs.
[Argobots 2.0] type is not updated if an error occurs.

Rationale: To ensure the atomicity of the API, Argobots 2.0 guarantees that the routine has no effect when an error is returned unless otherwise noted. Argobots 2.0 does not update type when an error occurs.

Execution context: [Argobots 1.x] This routine can be called in a ULT context or a tasklet context. Argobots must be initialized. This routine does not switch the context of the calling ULT unless any user-defined function that is involved in this routine switch the context of the calling ULT.
[Argobots 2.0] This routine can be called in any execution context. Argobots must be initialized. This routine does not switch the context of the calling ULT unless any user-defined function that is involved in this routine switch the context of the calling ULT.

Errors: ABT_SUCCESS is returned if this routine succeeds.
[Argobots 1.x] ABT_ERR_UNINITIALIZED is returned if the Argobots runtime is not initialized.
[Argobots 1.x] ABT_ERR_INV_XSTREAM is returned if the caller is an external thread.

Undefined behavior: If type is NULL, the results are undefined.
[Argobots 2.0] If Argobots is not initialized, the results are undefined.

Parameters

[out] type work unit type

Returns: Error code

Definition at line 291 of file self.c.

◆ ABT_self_get_unit()

int ABT_self_get_unit ( ABT_unit * unit )

Get a unit handle of the calling work unit.

ABT_self_get_unit() returns the ABT_unit handle associated with the calling work unit through unit.

Execution context: This routine can be called in a ULT context or a tasklet context. Argobots must be initialized. This routine does not switch the context of the calling ULT unless any user-defined function that is involved in this routine switch the context of the calling ULT.

Errors: ABT_SUCCESS is returned if this routine succeeds.
ABT_ERR_INV_XSTREAM is returned if the caller is an external thread.

Undefined behavior: If Argobots is not initialized, the results are undefined.
If unit is NULL, the results are undefined.

Parameters

[out] unit work unit handle

Returns: Error code

Definition at line 593 of file self.c.

◆ ABT_self_get_xstream()

int ABT_self_get_xstream ( ABT_xstream * xstream )

Get an execution stream that is running the calling work unit.

ABT_self_get_xstream() returns the handle of the execution stream that is running the calling work unit through xstream.

Execution context: This routine can be called in a ULT context or a tasklet context. Argobots must be initialized. This routine does not switch the context of the calling ULT unless any user-defined function that is involved in this routine switch the context of the calling ULT.

Errors: ABT_SUCCESS is returned if this routine succeeds.
ABT_ERR_INV_XSTREAM is returned if the caller is an external thread.

Undefined behavior: If xstream is NULL, the results are undefined.
If Argobots is not initialized, the results are undefined.

Parameters

[out] xstream execution stream handle

Returns: Error code

Definition at line 33 of file self.c.

◆ ABT_self_get_xstream_rank()

int ABT_self_get_xstream_rank ( int * rank )

Return a rank of an execution stream that is running the calling work unit.

ABT_self_get_xstream_rank() returns the rank of the execution stream that is running the calling work unit through rank.

Execution context: This routine can be called in a ULT context or a tasklet context. Argobots must be initialized. This routine does not switch the context of the calling ULT unless any user-defined function that is involved in this routine switch the context of the calling ULT.

Errors: ABT_SUCCESS is returned if this routine succeeds.
ABT_ERR_INV_XSTREAM is returned if the caller is an external thread.

Undefined behavior: If rank is NULL, the results are undefined.
If Argobots is not initialized, the results are undefined.

Parameters

[out] rank execution stream rank

Returns: Error code

Definition at line 68 of file self.c.

◆ ABT_self_is_primary()

int ABT_self_is_primary ( ABT_bool * is_primary )

Check if the caller is the primary ULT.

ABT_self_is_primary() checks whether the caller is the primary ULT and returns the result through is_primary. If the caller is the primary ULT, is_primary is set to ABT_TRUE. Otherwise, is_primary is set to ABT_FALSE.

Changes from Argobots 1.x to Argobots 2.0 (planned)

[Argobots 1.x] If a tasklet calls this routine, ABT_ERR_INV_THREAD is returned.
[Argobots 2.0] A tasklet may call this routine.

Rationale: Argobots 2.0 integrates a ULT and a tasklet into a single thread concept to make the API more general.

[Argobots 1.x] If an external thread calls this routine, ABT_ERR_INV_XSTREAM is returned.
[Argobots 2.0] An external thread may call this routine.

Rationale: Argobots 2.0 allows an external thread where possible unless it is semantically inappropriate.

[Argobots 1.x] This routine returns ABT_ERR_UNINITIALIZED if Argobots is not initialized.
[Argobots 2.0] The results of this routine are undefined if Argobots is not initialized.

Rationale: From Argobots 2.0, Argobots routines do not check if Argobots is initialized unless otherwise noted. This omission can reduce the branches that are unnecessary in most cases.

[Argobots 1.x] is_primary is set to ABT_FALSE if an error occurs.
[Argobots 2.0] is_primary is not updated if an error occurs.

Rationale: To ensure the atomicity of the API, Argobots 2.0 guarantees that the routine has no effect when an error is returned unless otherwise noted. Argobots 2.0 does not update is_primary when an error occurs.

Execution context: [Argobots 1.x] This routine can be called in a ULT context. Argobots must be initialized. This routine does not switch the context of the calling ULT unless any user-defined function that is involved in this routine switch the context of the calling ULT.
[Argobots 2.0] This routine can be called in any execution context. Argobots must be initialized. This routine does not switch the context of the calling ULT unless any user-defined function that is involved in this routine switch the context of the calling ULT.

Errors: ABT_SUCCESS is returned if this routine succeeds.
[Argobots 1.x] ABT_ERR_UNINITIALIZED is returned if the Argobots runtime is not initialized.
[Argobots 1.x] ABT_ERR_INV_XSTREAM is returned if the caller is an external thread.
[Argobots 1.x] ABT_ERR_INV_THREAD is returned if the caller is a tasklet.

Undefined behavior: If is_primary is NULL, the results are undefined.
[Argobots 2.0] If Argobots is not initialized, the results are undefined.

Parameters

[out] is_primary result (ABT_TRUE: primary ULT, ABT_FALSE: not)

Returns: Error code

Definition at line 357 of file self.c.

◆ ABT_self_is_unnamed()

int ABT_self_is_unnamed ( ABT_bool * is_unnamed )

Check if the calling work unit is unnamed.

ABT_self_is_unnamed() checks if the calling work unit is unnamed and returns the result through is_unnamed. is_unnamed is set to ABT_TRUE if the calling work unit is unnamed. Otherwise, is_unnamed is set to ABT_FALSE.

Execution context: This routine can be called in a ULT context or a tasklet context. Argobots must be initialized. This routine does not switch the context of the calling ULT unless any user-defined function that is involved in this routine switch the context of the calling ULT.

Errors: ABT_SUCCESS is returned if this routine succeeds.
ABT_ERR_INV_XSTREAM is returned if the caller is an external thread.

Undefined behavior: If Argobots is not initialized, the results are undefined.
If is_unnamed is NULL, the results are undefined.

Parameters

[out] is_unnamed result (ABT_TRUE: unnamed, ABT_FALSE: not)

Returns: Error code

Definition at line 1255 of file self.c.

◆ ABT_self_on_primary_xstream()

int ABT_self_on_primary_xstream ( ABT_bool * on_primary )

Check if the caller is running on the primary execution stream.

ABT_self_on_primary_xstream() checks whether the caller is running on the primary execution stream and returns the result through on_primary. If the caller is a work unit running on the primary execution stream, on_primary is set to ABT_TRUE. Otherwise, on_primary is set to ABT_FALSE.

Changes from Argobots 1.x to Argobots 2.0 (planned)

[Argobots 1.x] If an external thread calls this routine, ABT_ERR_INV_XSTREAM is returned.
[Argobots 2.0] An external thread may call this routine.

Rationale: Argobots 2.0 allows an external thread where possible unless it is semantically inappropriate.

[Argobots 1.x] This routine returns ABT_ERR_UNINITIALIZED if Argobots is not initialized.
[Argobots 2.0] The results of this routine are undefined if Argobots is not initialized.

Rationale: From Argobots 2.0, Argobots routines do not check if Argobots is initialized unless otherwise noted. This omission can reduce the branches that are unnecessary in most cases.

[Argobots 1.x] on_primary is set to ABT_FALSE if an error occurs.
[Argobots 2.0] on_primary is not updated if an error occurs.

Rationale: To ensure the atomicity of the API, Argobots 2.0 guarantees that the routine has no effect when an error is returned unless otherwise noted. Argobots 2.0 does not update on_primary when an error occurs.

Execution context: [Argobots 1.x] This routine can be called in a ULT context or a tasklet context. Argobots must be initialized. This routine does not switch the context of the calling ULT unless any user-defined function that is involved in this routine switch the context of the calling ULT.
[Argobots 2.0] This routine can be called in any execution context. Argobots must be initialized. This routine does not switch the context of the calling ULT unless any user-defined function that is involved in this routine switch the context of the calling ULT.

Errors: ABT_SUCCESS is returned if this routine succeeds.
[Argobots 1.x] ABT_ERR_UNINITIALIZED is returned if the Argobots runtime is not initialized.
[Argobots 1.x] ABT_ERR_INV_XSTREAM is returned if the caller is an external thread.

Undefined behavior: If on_primary is NULL, the results are undefined.
[Argobots 2.0] If Argobots is not initialized, the results are undefined.

Parameters

[out] on_primary result (ABT_TRUE: primary execution stream, ABT_FALSE: not)

Returns: Error code

Definition at line 420 of file self.c.

◆ ABT_self_resume_exit_to()

int ABT_self_resume_exit_to ( ABT_thread thread )

Terminate the calling ULT and jump to another suspended ULT.

ABT_self_resume_exit_to() terminates the calling ULT, resumes the ULT thread, and schedules thread as a child thread of the calling ULT's parent. This routine does not return if it succeeds.

Execution context: This routine can be called in a ULT context. Argobots must be initialized. This routine may switch the context of the calling ULT.

Errors: ABT_ERR_INV_THREAD is returned if thread is ABT_THREAD_NULL or ABT_TASK_NULL.
ABT_ERR_INV_XSTREAM is returned if the caller is an external thread.
ABT_ERR_INV_THREAD is returned if the caller is a tasklet.
ABT_ERR_INV_THREAD is returned if thread is a tasklet.
ABT_ERR_INV_THREAD is returned if the caller is the work unit of the main scheduler.
ABT_ERR_INV_THREAD is returned if thread is the work unit of the main scheduler.
ABT_ERR_INV_THREAD is returned if the caller is the primary ULT.

Undefined behavior: If Argobots is not initialized, the results are undefined.
If the caller is accessed concurrently, the results are undefined.
If thread is accessed concurrently, the results are undefined.
If thread is not suspended, the results are undefined.

Parameters

[in] thread handle to the target ULT

Returns: Error code

Definition at line 1033 of file self.c.

◆ ABT_self_resume_suspend_to()

int ABT_self_resume_suspend_to ( ABT_thread thread )

Suspend the calling ULT and jump to another suspended ULT.

ABT_self_resume_suspend_to() suspends the execution of the calling ULT, resumes the ULT thread, and schedules thread as a child thread of the calling ULT's parent. The calling ULT is not pushed to its associated pool and its state becomes blocked. ABT_thread_resume() awakens the suspended ULT and pushes it back to its associated pool.

Execution context: This routine can be called in a ULT context. Argobots must be initialized. This routine may switch the context of the calling ULT.

Errors: ABT_SUCCESS is returned if this routine succeeds.
ABT_ERR_INV_THREAD is returned if thread is ABT_THREAD_NULL or ABT_TASK_NULL.
ABT_ERR_INV_XSTREAM is returned if the caller is an external thread.
ABT_ERR_INV_THREAD is returned if the caller is a tasklet.
ABT_ERR_INV_THREAD is returned if thread is a tasklet.
ABT_ERR_INV_THREAD is returned if the caller is the work unit of the main scheduler.
ABT_ERR_INV_THREAD is returned if thread is the work unit of the main scheduler.

Undefined behavior: If Argobots is not initialized, the results are undefined.
If the caller is accessed concurrently, the results are undefined.
If thread is accessed concurrently, the results are undefined.
If thread is not suspended, the results are undefined.

Parameters

[in] thread handle to the target ULT

Returns: Error code

Definition at line 887 of file self.c.

◆ ABT_self_resume_yield_to()

int ABT_self_resume_yield_to ( ABT_thread thread )

Yield the calling ULT to another suspended ULT.

ABT_self_resume_yield_to() yields the calling ULT, resumes the ULT thread, and schedules thread as a child thread of the calling ULT's parent. The calling ULT is pushed to its associated pool.

Execution context: This routine can be called in a ULT context. Argobots must be initialized. This routine may switch the context of the calling ULT.

Errors: ABT_SUCCESS is returned if this routine succeeds.
ABT_ERR_INV_THREAD is returned if thread is ABT_THREAD_NULL or ABT_TASK_NULL.
ABT_ERR_INV_XSTREAM is returned if the caller is an external thread.
ABT_ERR_INV_THREAD is returned if the caller is a tasklet.
ABT_ERR_INV_THREAD is returned if thread is a tasklet.
ABT_ERR_INV_THREAD is returned if the caller is the work unit of the main scheduler.
ABT_ERR_INV_THREAD is returned if thread is the work unit of the main scheduler.

Undefined behavior: If Argobots is not initialized, the results are undefined.
If the caller is accessed concurrently, the results are undefined.
If thread is accessed concurrently, the results are undefined.
If thread is not suspended, the results are undefined.

Parameters

[in] thread handle to the target ULT

Returns: Error code

Definition at line 727 of file self.c.

◆ ABT_self_schedule()

int ABT_self_schedule	(	ABT_thread	thread,
		ABT_pool	pool
	)

Execute a work unit on the calling ULT.

ABT_self_schedule() runs the work unit thread as a child work unit on the calling ULT, which becomes a parent ULT. If pool is not ABT_POOL_NULL, this routine associates thread with the pool pool before thread is scheduled. The calling ULT will be resumed when a child work unit finishes or yields.

Execution context: This routine can be called in a ULT context. Argobots must be initialized. This routine may switch the context of the calling ULT.

Errors: ABT_SUCCESS is returned if this routine succeeds.
ABT_ERR_INV_XSTREAM is returned if the caller is an external thread.
ABT_ERR_INV_THREAD is returned if the caller is a tasklet.
ABT_ERR_INV_THREAD is returned if thread is ABT_THREAD_NULL or ABT_TASK_NULL.
ABT_ERR_MEM is returned if memory allocation fails.
ABT_ERR_SYS is returned if an error related to system calls and standard libraries occurs.
ABT_ERR_UNIT is returned if u_create_from_thread() fails.

Undefined behavior: If Argobots is not initialized, the results are undefined.
If thread is not ready, the results are undefined.

Parameters

[in]	thread	work unit handle
[in]	pool	pool handle

Returns: Error code

Definition at line 1088 of file self.c.

◆ ABT_self_set_arg()

int ABT_self_set_arg ( void * arg )

Set an argument for a work-unit function of the calling work unit.

ABT_self_set_arg() sets the argument arg for the caller's work-unit function.

Note: The new argument will be used if the calling work unit is revived.

Changes from Argobots 1.x to Argobots 2.0 (planned)

[Argobots 1.x] This routine returns ABT_ERR_UNINITIALIZED if Argobots is not initialized.
[Argobots 2.0] The results of this routine are undefined if Argobots is not initialized.

Rationale: From Argobots 2.0, Argobots routines do not check if Argobots is initialized unless otherwise noted. This omission can reduce the branches that are unnecessary in most cases.

Execution context: This routine can be called in a ULT context or a tasklet context. Argobots must be initialized. This routine does not switch the context of the calling ULT unless any user-defined function that is involved in this routine switch the context of the calling ULT.

Errors: ABT_SUCCESS is returned if this routine succeeds.
ABT_ERR_INV_XSTREAM is returned if the caller is an external thread.
[Argobots 1.x] ABT_ERR_UNINITIALIZED is returned if the Argobots runtime is not initialized.

Undefined behavior: If the caller is accessed concurrently, the results are undefined.
[Argobots 2.0] If Argobots is not initialized, the results are undefined.

Parameters

[in] arg argument a work-unit function of the calling work unit

Returns: Error code

Definition at line 1139 of file self.c.

◆ ABT_self_set_associated_pool()

int ABT_self_set_associated_pool ( ABT_pool pool )

Set an associated pool for the calling work unit.

ABT_self_set_associated_pool() changes the associated pool of the work unit thread to the pool pool. This routine does not yield the calling work unit.

Execution context: This routine can be called in a ULT context or a tasklet context. Argobots must be initialized. This routine does not switch the context of the calling ULT unless any user-defined function that is involved in this routine switch the context of the calling ULT.

Errors: ABT_SUCCESS is returned if this routine succeeds.
ABT_ERR_INV_XSTREAM is returned if the caller is an external thread.
ABT_ERR_INV_POOL is returned if pool is ABT_POOL_NULL.
ABT_ERR_MEM is returned if memory allocation fails.
ABT_ERR_SYS is returned if an error related to system calls and standard libraries occurs.
ABT_ERR_UNIT is returned if u_create_from_thread() fails.

Undefined behavior: If Argobots is not initialized, the results are undefined.
If the caller is accessed concurrently, the results are undefined.

Parameters

[in] pool pool handle

Returns: Error code

Definition at line 556 of file self.c.

◆ ABT_self_set_specific()

int ABT_self_set_specific	(	ABT_key	key,
		void *	value
	)

Associate a value with a work-unit-specific data key in the calling work unit.

ABT_self_set_specific() associates a value value with the work-unit-specific data key key in the calling work unit. Different work units may bind different values to the same key.

Work-unit-specific values associated with a work-unit-specific data key are read and updated atomically.

Execution context: This routine can be called in a ULT context or a tasklet context. Argobots must be initialized. This routine does not switch the context of the calling ULT unless any user-defined function that is involved in this routine switch the context of the calling ULT.

Errors: ABT_SUCCESS is returned if this routine succeeds.
ABT_ERR_INV_XSTREAM is returned if the caller is an external thread.
ABT_ERR_INV_KEY is returned if key is ABT_KEY_NULL.
ABT_ERR_MEM is returned if memory allocation fails.
ABT_ERR_SYS is returned if an error related to system calls and standard libraries occurs.

Undefined behavior: If Argobots is not initialized, the results are undefined.

Parameters

[in]	key	work-unit-specific data key handle
[in]	value	value associated with `key`

Returns: Error code

Definition at line 191 of file self.c.

◆ ABT_self_suspend()

int ABT_self_suspend ( void )

Suspend the calling ULT.

ABT_self_suspend() suspends the execution of the calling ULT and switches to its parent ULT. The calling ULT is not pushed to its associated pool and its state becomes blocked. ABT_thread_resume() awakens the suspended ULT and pushes it back to its associated pool.

Changes from Argobots 1.0 to Argobots 1.1

[Argobots 1.0] ABT_ERR_INV_THREAD is returned if this routine is called by an external thread.
[Argobots 1.1] ABT_ERR_INV_XSTREAM is returned if this routine is called by an external thread.

Rationale: Argobots 1.0 returned a wrong error code. Argobots 1.1 fixes the error code for consistent behavior with other Argobots routines.

Execution context: This routine can be called in a ULT context. Argobots must be initialized. This routine may switch the context of the calling ULT.

Errors: ABT_SUCCESS is returned if this routine succeeds.
ABT_ERR_INV_XSTREAM is returned if the caller is an external thread.
ABT_ERR_INV_THREAD is returned if the caller is a tasklet.

Undefined behavior: If Argobots is not initialized, the results are undefined.
If the caller is accessed concurrently, the results are undefined.

Returns: Error code

Definition at line 784 of file self.c.

◆ ABT_self_suspend_to()

int ABT_self_suspend_to ( ABT_thread thread )

Suspend the calling ULT and jump to another ULT.

ABT_self_suspend_to() suspends the execution of the calling ULT and schedules the ULT thread as a child thread of the calling ULT's parent. The calling ULT is not pushed to its associated pool and its state becomes blocked. ABT_thread_resume() awakens the suspended ULT and pushes it back to its associated pool. It is the user's responsibility to pop thread from its associated pool before calling this routine.

Execution context: This routine can be called in a ULT context. Argobots must be initialized. This routine may switch the context of the calling ULT.

Errors: ABT_SUCCESS is returned if this routine succeeds.
ABT_ERR_INV_THREAD is returned if thread is ABT_THREAD_NULL or ABT_TASK_NULL.
ABT_ERR_INV_XSTREAM is returned if the caller is an external thread.
ABT_ERR_INV_THREAD is returned if the caller is a tasklet.
ABT_ERR_INV_THREAD is returned if thread is a tasklet.
ABT_ERR_INV_THREAD is returned if the caller is the work unit of the main scheduler.
ABT_ERR_INV_THREAD is returned if thread is the work unit of the main scheduler.
ABT_ERR_INV_THREAD is returned if thread is the caller.

Undefined behavior: If Argobots is not initialized, the results are undefined.
If the caller is accessed concurrently, the results are undefined.
If thread is accessed concurrently, the results are undefined.
If thread, the pool associated with thread is in a pool, the results are undefined.
If thread is not ready, the results are undefined.

Parameters

[in] thread handle to the target thread

Returns: Error code

Definition at line 832 of file self.c.

◆ ABT_self_yield()

int ABT_self_yield ( void )

Yield the calling ULT to its parent ULT.

ABT_self_yield() yields the calling ULT and pushes the calling ULT to its associated pool. Its parent ULT will be resumed.

Execution context: This routine can be called in a ULT context. Argobots must be initialized. This routine may switch the context of the calling ULT.

Errors: ABT_SUCCESS is returned if this routine succeeds.
ABT_ERR_INV_THREAD is returned if the caller is a tasklet.
ABT_ERR_INV_XSTREAM is returned if the caller is an external thread.

Undefined behavior: If Argobots is not initialized, the results are undefined.
If the caller is accessed concurrently, the results are undefined.

Returns: Error code

Definition at line 626 of file self.c.

◆ ABT_self_yield_to()

int ABT_self_yield_to ( ABT_thread thread )

Yield the calling ULT to another ULT.

ABT_self_yield_to() yields the calling ULT and schedules the ULT thread as a child thread of the calling ULT's parent. The calling ULT is pushed to its associated pool. It is the user's responsibility to pop thread from its associated pool before calling this routine.

Execution context: This routine can be called in a ULT context. Argobots must be initialized. This routine may switch the context of the calling ULT.

Errors: ABT_SUCCESS is returned if this routine succeeds.
ABT_ERR_INV_THREAD is returned if thread is ABT_THREAD_NULL or ABT_TASK_NULL.
ABT_ERR_INV_XSTREAM is returned if the caller is an external thread.
ABT_ERR_INV_THREAD is returned if the caller is a tasklet.
ABT_ERR_INV_THREAD is returned if thread is a tasklet.
ABT_ERR_INV_THREAD is returned if the caller is the work unit of the main scheduler.
ABT_ERR_INV_THREAD is returned if thread is the work unit of the main scheduler.
ABT_ERR_INV_THREAD is returned if thread is the caller.

Undefined behavior: If Argobots is not initialized, the results are undefined.
If the caller is accessed concurrently, the results are undefined.
If thread is accessed concurrently, the results are undefined.
If thread, the pool associated with thread is in a pool, the results are undefined.
If thread is not ready, the results are undefined.

Parameters

[in] thread handle to the target thread

Returns: Error code

Definition at line 673 of file self.c.

Functions

Detailed Description

Function Documentation

◆ ABT_self_exit()

◆ ABT_self_exit_to()

◆ ABT_self_get_arg()

◆ ABT_self_get_last_pool()

◆ ABT_self_get_last_pool_id()

◆ ABT_self_get_specific()

◆ ABT_self_get_task()

◆ ABT_self_get_task_id()

◆ ABT_self_get_thread()

◆ ABT_self_get_thread_func()

◆ ABT_self_get_thread_id()

◆ ABT_self_get_type()

◆ ABT_self_get_unit()

◆ ABT_self_get_xstream()

◆ ABT_self_get_xstream_rank()

◆ ABT_self_is_primary()

◆ ABT_self_is_unnamed()

◆ ABT_self_on_primary_xstream()

◆ ABT_self_resume_exit_to()

◆ ABT_self_resume_suspend_to()

◆ ABT_self_resume_yield_to()

◆ ABT_self_schedule()

◆ ABT_self_set_arg()

◆ ABT_self_set_associated_pool()

◆ ABT_self_set_specific()

◆ ABT_self_suspend()

◆ ABT_self_suspend_to()

◆ ABT_self_yield()

◆ ABT_self_yield_to()