ARGOBOTS  4dc37e16e1b227a480715ab67dae1dcfb4d2d4e0
Macros
Error Code

This group is for Error Code. More...

Macros

#define ABT_SUCCESS   0
 Error code: the routine returns successfully. More...
 
#define ABT_ERR_UNINITIALIZED   1
 Error code: Argobots it not initialized. More...
 
#define ABT_ERR_MEM   2
 Error code: Memory allocation failure. More...
 
#define ABT_ERR_OTHER   3
 Error code: other error. More...
 
#define ABT_ERR_INV_XSTREAM   4
 Error code: invalid execution stream. More...
 
#define ABT_ERR_INV_XSTREAM_RANK   5
 Error code: invalid execution stream rank. More...
 
#define ABT_ERR_INV_XSTREAM_BARRIER   6
 Error code: invalid execution stream barrier. More...
 
#define ABT_ERR_INV_SCHED   7
 Error code: invalid scheduler. More...
 
#define ABT_ERR_INV_SCHED_KIND   8
 Error code: invalid scheduler kind. More...
 
#define ABT_ERR_INV_SCHED_PREDEF   9
 Error code: invalid predefined scheduler type. More...
 
#define ABT_ERR_INV_SCHED_TYPE   10
 Unused error code. More...
 
#define ABT_ERR_INV_SCHED_CONFIG   11
 Error code: invalid scheduler configuration. More...
 
#define ABT_ERR_INV_POOL   12
 Error code: invalid pool. More...
 
#define ABT_ERR_INV_POOL_KIND   13
 Error code: invalid pool kind. More...
 
#define ABT_ERR_INV_POOL_ACCESS   14
 Error code: invalid pool access type. More...
 
#define ABT_ERR_INV_POOL_CONFIG   56
 Error code: invalid pool configuration. More...
 
#define ABT_ERR_INV_POOL_USER_DEF   57
 Error code: invalid pool definition. More...
 
#define ABT_ERR_INV_UNIT   15
 Error code: invalid work unit for scheduling. More...
 
#define ABT_ERR_INV_THREAD   16
 Error code: invalid work unit. More...
 
#define ABT_ERR_INV_THREAD_ATTR   17
 Error code: invalid ULT attribute. More...
 
#define ABT_ERR_INV_TASK   18
 Error code: invalid work unit. More...
 
#define ABT_ERR_INV_KEY   19
 Error code: invalid work-unit-specific data key. More...
 
#define ABT_ERR_INV_MUTEX   20
 Error code: invalid mutex. More...
 
#define ABT_ERR_INV_MUTEX_ATTR   21
 Error code: invalid mutex attribute. More...
 
#define ABT_ERR_INV_COND   22
 Error code: invalid condition variable. More...
 
#define ABT_ERR_INV_RWLOCK   23
 Error code: invalid readers-writer lock. More...
 
#define ABT_ERR_INV_EVENTUAL   24
 Error code: invalid eventual. More...
 
#define ABT_ERR_INV_FUTURE   25
 Error code: invalid future. More...
 
#define ABT_ERR_INV_BARRIER   26
 Error code: invalid barrier. More...
 
#define ABT_ERR_INV_TIMER   27
 Error code: invalid timer. More...
 
#define ABT_ERR_INV_QUERY_KIND   28
 Error code: invalid query kind. More...
 
#define ABT_ERR_INV_TOOL_CONTEXT   52
 Error code: invalid tool context. More...
 
#define ABT_ERR_INV_ARG   53
 Error code: invalid user argument. More...
 
#define ABT_ERR_XSTREAM   29
 Error code: error related to an execution stream. More...
 
#define ABT_ERR_XSTREAM_STATE   30
 Error code: error related to an execution stream state. More...
 
#define ABT_ERR_XSTREAM_BARRIER   31
 Error code: error related to an execution stream. More...
 
#define ABT_ERR_SCHED   32
 Error code: error related to a scheduler. More...
 
#define ABT_ERR_SCHED_CONFIG   33
 Error code: error related to a scheduler configuration. More...
 
#define ABT_ERR_POOL   34
 Error code: error related to a pool. More...
 
#define ABT_ERR_UNIT   35
 Error code: error related to a work unit for scheduling. More...
 
#define ABT_ERR_THREAD   36
 Error code: error related to a work unit. More...
 
#define ABT_ERR_TASK   37
 Error code: error related to a work unit. More...
 
#define ABT_ERR_KEY   38
 Error code: error related to a work-unit-specific data key. More...
 
#define ABT_ERR_MUTEX   39
 Error code: error related to a mutex. More...
 
#define ABT_ERR_MUTEX_LOCKED   40
 Error code: a return value when a mutex is locked. More...
 
#define ABT_ERR_COND   41
 Error code: error related to a condition variable. More...
 
#define ABT_ERR_COND_TIMEDOUT   42
 Error code: a return value when a condition variable is timed out. More...
 
#define ABT_ERR_RWLOCK   43
 Error code: error related to a readers-writer lock. More...
 
#define ABT_ERR_EVENTUAL   44
 Error code: error related to an eventual. More...
 
#define ABT_ERR_FUTURE   45
 Error code: error related to a future. More...
 
#define ABT_ERR_BARRIER   46
 Error code: error related to a barrier. More...
 
#define ABT_ERR_TIMER   47
 Error code: error related to a timer. More...
 
#define ABT_ERR_MIGRATION_TARGET   48
 Error code: error related to a migration target. More...
 
#define ABT_ERR_MIGRATION_NA   49
 Error code: migration is not supported. More...
 
#define ABT_ERR_MISSING_JOIN   50
 Unused error code. More...
 
#define ABT_ERR_FEATURE_NA   51
 Error code: unsupported feature. More...
 
#define ABT_ERR_SYS   54
 Error code: error related to system calls and standard libraries. More...
 
#define ABT_ERR_CPUID   55
 Error code: error related to CPU ID. More...
 

Detailed Description

This group is for Error Code.

Macro Definition Documentation

◆ ABT_ERR_BARRIER

#define ABT_ERR_BARRIER   46

Error code: error related to a barrier.

Definition at line 360 of file abt.h.

◆ ABT_ERR_COND

#define ABT_ERR_COND   41

Error code: error related to a condition variable.

Definition at line 333 of file abt.h.

◆ ABT_ERR_COND_TIMEDOUT

#define ABT_ERR_COND_TIMEDOUT   42

Error code: a return value when a condition variable is timed out.

This error code is used by ABT_cond_timedwait().

Definition at line 340 of file abt.h.

◆ ABT_ERR_CPUID

#define ABT_ERR_CPUID   55

Error code: error related to CPU ID.

Definition at line 408 of file abt.h.

◆ ABT_ERR_EVENTUAL

#define ABT_ERR_EVENTUAL   44

Error code: error related to an eventual.

Definition at line 350 of file abt.h.

◆ ABT_ERR_FEATURE_NA

#define ABT_ERR_FEATURE_NA   51

Error code: unsupported feature.

Definition at line 391 of file abt.h.

◆ ABT_ERR_FUTURE

#define ABT_ERR_FUTURE   45

Error code: error related to a future.

Definition at line 355 of file abt.h.

◆ ABT_ERR_INV_ARG

#define ABT_ERR_INV_ARG   53

Error code: invalid user argument.

Definition at line 260 of file abt.h.

◆ ABT_ERR_INV_BARRIER

#define ABT_ERR_INV_BARRIER   26

Error code: invalid barrier.

Definition at line 240 of file abt.h.

◆ ABT_ERR_INV_COND

#define ABT_ERR_INV_COND   22

Error code: invalid condition variable.

Definition at line 220 of file abt.h.

◆ ABT_ERR_INV_EVENTUAL

#define ABT_ERR_INV_EVENTUAL   24

Error code: invalid eventual.

Definition at line 230 of file abt.h.

◆ ABT_ERR_INV_FUTURE

#define ABT_ERR_INV_FUTURE   25

Error code: invalid future.

Definition at line 235 of file abt.h.

◆ ABT_ERR_INV_KEY

#define ABT_ERR_INV_KEY   19

Error code: invalid work-unit-specific data key.

Definition at line 205 of file abt.h.

◆ ABT_ERR_INV_MUTEX

#define ABT_ERR_INV_MUTEX   20

Error code: invalid mutex.

Definition at line 210 of file abt.h.

◆ ABT_ERR_INV_MUTEX_ATTR

#define ABT_ERR_INV_MUTEX_ATTR   21

Error code: invalid mutex attribute.

Definition at line 215 of file abt.h.

◆ ABT_ERR_INV_POOL

#define ABT_ERR_INV_POOL   12

Error code: invalid pool.

Definition at line 156 of file abt.h.

◆ ABT_ERR_INV_POOL_ACCESS

#define ABT_ERR_INV_POOL_ACCESS   14

Error code: invalid pool access type.

Definition at line 166 of file abt.h.

◆ ABT_ERR_INV_POOL_CONFIG

#define ABT_ERR_INV_POOL_CONFIG   56

Error code: invalid pool configuration.

Definition at line 171 of file abt.h.

◆ ABT_ERR_INV_POOL_KIND

#define ABT_ERR_INV_POOL_KIND   13

Error code: invalid pool kind.

Definition at line 161 of file abt.h.

◆ ABT_ERR_INV_POOL_USER_DEF

#define ABT_ERR_INV_POOL_USER_DEF   57

Error code: invalid pool definition.

Definition at line 176 of file abt.h.

◆ ABT_ERR_INV_QUERY_KIND

#define ABT_ERR_INV_QUERY_KIND   28

Error code: invalid query kind.

Definition at line 250 of file abt.h.

◆ ABT_ERR_INV_RWLOCK

#define ABT_ERR_INV_RWLOCK   23

Error code: invalid readers-writer lock.

Definition at line 225 of file abt.h.

◆ ABT_ERR_INV_SCHED

#define ABT_ERR_INV_SCHED   7

Error code: invalid scheduler.

Definition at line 129 of file abt.h.

◆ ABT_ERR_INV_SCHED_CONFIG

#define ABT_ERR_INV_SCHED_CONFIG   11

Error code: invalid scheduler configuration.

Definition at line 151 of file abt.h.

◆ ABT_ERR_INV_SCHED_KIND

#define ABT_ERR_INV_SCHED_KIND   8

Error code: invalid scheduler kind.

Definition at line 134 of file abt.h.

◆ ABT_ERR_INV_SCHED_PREDEF

#define ABT_ERR_INV_SCHED_PREDEF   9

Error code: invalid predefined scheduler type.

Definition at line 139 of file abt.h.

◆ ABT_ERR_INV_SCHED_TYPE

#define ABT_ERR_INV_SCHED_TYPE   10

Unused error code.

This error code is not used. This error code is deprecated.

Definition at line 146 of file abt.h.

◆ ABT_ERR_INV_TASK

#define ABT_ERR_INV_TASK   18

Error code: invalid work unit.

Changes from Argobots 1.x to Argobots 2.0 (planned)
[Argobots 2.0] This error code is an alias of ABT_ERR_INV_THREAD.

Definition at line 200 of file abt.h.

◆ ABT_ERR_INV_THREAD

#define ABT_ERR_INV_THREAD   16

Error code: invalid work unit.

Definition at line 186 of file abt.h.

◆ ABT_ERR_INV_THREAD_ATTR

#define ABT_ERR_INV_THREAD_ATTR   17

Error code: invalid ULT attribute.

Definition at line 191 of file abt.h.

◆ ABT_ERR_INV_TIMER

#define ABT_ERR_INV_TIMER   27

Error code: invalid timer.

Definition at line 245 of file abt.h.

◆ ABT_ERR_INV_TOOL_CONTEXT

#define ABT_ERR_INV_TOOL_CONTEXT   52

Error code: invalid tool context.

Definition at line 255 of file abt.h.

◆ ABT_ERR_INV_UNIT

#define ABT_ERR_INV_UNIT   15

Error code: invalid work unit for scheduling.

Definition at line 181 of file abt.h.

◆ ABT_ERR_INV_XSTREAM

#define ABT_ERR_INV_XSTREAM   4

Error code: invalid execution stream.

Definition at line 114 of file abt.h.

◆ ABT_ERR_INV_XSTREAM_BARRIER

#define ABT_ERR_INV_XSTREAM_BARRIER   6

Error code: invalid execution stream barrier.

Definition at line 124 of file abt.h.

◆ ABT_ERR_INV_XSTREAM_RANK

#define ABT_ERR_INV_XSTREAM_RANK   5

Error code: invalid execution stream rank.

Definition at line 119 of file abt.h.

◆ ABT_ERR_KEY

#define ABT_ERR_KEY   38

Error code: error related to a work-unit-specific data key.

Definition at line 316 of file abt.h.

◆ ABT_ERR_MEM

#define ABT_ERR_MEM   2

Error code: Memory allocation failure.

ABT_ERR_MEM is returned if memory allocation fails.

Definition at line 104 of file abt.h.

◆ ABT_ERR_MIGRATION_NA

#define ABT_ERR_MIGRATION_NA   49

Error code: migration is not supported.

Changes from Argobots 1.x to Argobots 2.0 (planned)
[Argobots 2.0] This error code is an alias of ABT_ERR_FEATURE_NA.

Definition at line 379 of file abt.h.

◆ ABT_ERR_MIGRATION_TARGET

#define ABT_ERR_MIGRATION_TARGET   48

Error code: error related to a migration target.

Definition at line 370 of file abt.h.

◆ ABT_ERR_MISSING_JOIN

#define ABT_ERR_MISSING_JOIN   50

Unused error code.

This error code is not used. This error code is deprecated.

Definition at line 386 of file abt.h.

◆ ABT_ERR_MUTEX

#define ABT_ERR_MUTEX   39

Error code: error related to a mutex.

Definition at line 321 of file abt.h.

◆ ABT_ERR_MUTEX_LOCKED

#define ABT_ERR_MUTEX_LOCKED   40

Error code: a return value when a mutex is locked.

This error code is used by ABT_mutex_trylock().

Definition at line 328 of file abt.h.

◆ ABT_ERR_OTHER

#define ABT_ERR_OTHER   3

Error code: other error.

Definition at line 109 of file abt.h.

◆ ABT_ERR_POOL

#define ABT_ERR_POOL   34

Error code: error related to a pool.

Definition at line 292 of file abt.h.

◆ ABT_ERR_RWLOCK

#define ABT_ERR_RWLOCK   43

Error code: error related to a readers-writer lock.

Definition at line 345 of file abt.h.

◆ ABT_ERR_SCHED

#define ABT_ERR_SCHED   32

Error code: error related to a scheduler.

Definition at line 282 of file abt.h.

◆ ABT_ERR_SCHED_CONFIG

#define ABT_ERR_SCHED_CONFIG   33

Error code: error related to a scheduler configuration.

Definition at line 287 of file abt.h.

◆ ABT_ERR_SYS

#define ABT_ERR_SYS   54

Error code: error related to system calls and standard libraries.

ABT_ERR_SYS represents a general error that happens in libraries used by Argobots. For example, this error is returned when system calls such as futex() and open() or functions provided by external libraries such as pthread_create() and unw_init_local() fail. Note that ABT_ERR_MEM is returned if a memory allocation function such as malloc() or mmap() fails.

Definition at line 403 of file abt.h.

◆ ABT_ERR_TASK

#define ABT_ERR_TASK   37

Error code: error related to a work unit.

Changes from Argobots 1.x to Argobots 2.0 (planned)
[Argobots 2.0] This error code is an alias of ABT_ERR_THREAD.

Definition at line 311 of file abt.h.

◆ ABT_ERR_THREAD

#define ABT_ERR_THREAD   36

Error code: error related to a work unit.

Definition at line 302 of file abt.h.

◆ ABT_ERR_TIMER

#define ABT_ERR_TIMER   47

Error code: error related to a timer.

Definition at line 365 of file abt.h.

◆ ABT_ERR_UNINITIALIZED

#define ABT_ERR_UNINITIALIZED   1

Error code: Argobots it not initialized.

Definition at line 97 of file abt.h.

◆ ABT_ERR_UNIT

#define ABT_ERR_UNIT   35

Error code: error related to a work unit for scheduling.

Definition at line 297 of file abt.h.

◆ ABT_ERR_XSTREAM

#define ABT_ERR_XSTREAM   29

Error code: error related to an execution stream.

Definition at line 265 of file abt.h.

◆ ABT_ERR_XSTREAM_BARRIER

#define ABT_ERR_XSTREAM_BARRIER   31

Error code: error related to an execution stream.

Definition at line 277 of file abt.h.

◆ ABT_ERR_XSTREAM_STATE

#define ABT_ERR_XSTREAM_STATE   30

Error code: error related to an execution stream state.

This error code is deprecated.

Definition at line 272 of file abt.h.

◆ ABT_SUCCESS

#define ABT_SUCCESS   0

Error code: the routine returns successfully.

ABT_SUCCESS is guaranteed to be 0.

Definition at line 92 of file abt.h.