ARGOBOTS  4dc37e16e1b227a480715ab67dae1dcfb4d2d4e0
abti.h
Go to the documentation of this file.
1 /* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil ; -*- */
2 /*
3  * See COPYRIGHT in top-level directory.
4  */
5 
6 #ifndef ABTI_H_INCLUDED
7 #define ABTI_H_INCLUDED
8 
9 #include <stdio.h>
10 #include <stdlib.h>
11 #include <stdint.h>
12 #include <inttypes.h>
13 #include <string.h>
14 #include <limits.h>
15 
16 #include "abt_config.h"
17 #include "abt.h"
18 
19 #ifndef ABT_CONFIG_DISABLE_ERROR_CHECK
20 #define ABTI_IS_ERROR_CHECK_ENABLED 1
21 #else
22 #define ABTI_IS_ERROR_CHECK_ENABLED 0
23 #endif
24 
25 #ifdef ABT_CONFIG_DISABLE_EXT_THREAD
26 #define ABTI_IS_EXT_THREAD_ENABLED 0
27 #else
28 #define ABTI_IS_EXT_THREAD_ENABLED 1
29 #endif
30 
31 #ifdef ABT_CONFIG_DISABLE_UB_ASSERT
32 #define ABTI_IS_UB_ASSERT_ENABLED 0
33 #else
34 #define ABTI_IS_UB_ASSERT_ENABLED 1
35 #endif
36 
37 #include "abtu.h"
38 #include "abti_error.h"
39 #include "abti_valgrind.h"
40 
41 /* Constants */
42 #define ABTI_SCHED_NUM_PRIO 3
43 
44 #define ABTI_SCHED_REQ_FINISH (1 << 0)
45 #define ABTI_SCHED_REQ_EXIT (1 << 1)
46 #define ABTI_SCHED_REQ_REPLACE (1 << 2)
47 
48 #define ABTI_THREAD_REQ_JOIN (1 << 0)
49 #define ABTI_THREAD_REQ_CANCEL (1 << 1)
50 #define ABTI_THREAD_REQ_MIGRATE (1 << 2)
51 
52 #define ABTI_THREAD_INIT_ID 0xFFFFFFFFFFFFFFFF
53 #define ABTI_TASK_INIT_ID 0xFFFFFFFFFFFFFFFF
54 
55 #define ABTI_INDENT 4
56 
57 #define ABTI_UNIT_HASH_TABLE_SIZE_EXP 8 /* N -> 2^N table entries */
58 #define ABTI_UNIT_HASH_TABLE_SIZE ((size_t)(1 << ABTI_UNIT_HASH_TABLE_SIZE_EXP))
59 
60 #define ABTI_STACK_CHECK_TYPE_NONE 0
61 #define ABTI_STACK_CHECK_TYPE_CANARY 1
62 #define ABTI_STACK_CHECK_TYPE_MPROTECT 2
63 #define ABTI_STACK_CHECK_TYPE_MPROTECT_STRICT 3
64 
65 enum ABTI_xstream_type {
66  ABTI_XSTREAM_TYPE_PRIMARY,
67  ABTI_XSTREAM_TYPE_SECONDARY
68 };
69 
70 enum ABTI_sched_used {
71  ABTI_SCHED_NOT_USED,
72  ABTI_SCHED_MAIN,
73  ABTI_SCHED_IN_POOL
74 };
75 
76 enum ABTI_stack_guard {
77  ABTI_STACK_GUARD_NONE = 0,
78  ABTI_STACK_GUARD_MPROTECT,
79  ABTI_STACK_GUARD_MPROTECT_STRICT,
80 };
81 
82 #define ABTI_THREAD_TYPE_EXT ((ABTI_thread_type)0)
83 #define ABTI_THREAD_TYPE_THREAD ((ABTI_thread_type)(0x1 << 0))
84 #define ABTI_THREAD_TYPE_ROOT ((ABTI_thread_type)(0x1 << 1))
85 #define ABTI_THREAD_TYPE_PRIMARY ((ABTI_thread_type)(0x1 << 2))
86 #define ABTI_THREAD_TYPE_MAIN_SCHED ((ABTI_thread_type)(0x1 << 3))
87 #define ABTI_THREAD_TYPE_YIELDABLE ((ABTI_thread_type)(0x1 << 4))
88 #define ABTI_THREAD_TYPE_NAMED ((ABTI_thread_type)(0x1 << 5))
89 #define ABTI_THREAD_TYPE_MIGRATABLE ((ABTI_thread_type)(0x1 << 6))
90 
91 /* Memory management. Only one flag must be set. */
92 /* Only a thread descriptor is allocated. It is from a memory pool.
93  * This thread does not have a ULT stack allocated by the Argobots runtime. */
94 #define ABTI_THREAD_TYPE_MEM_MEMPOOL_DESC ((ABTI_thread_type)(0x1 << 7))
95 /* Only a thread descriptor is allocated. It is allocated by malloc().
96  * This thread does not have a ULT stack allocated by the Argobots runtime. */
97 #define ABTI_THREAD_TYPE_MEM_MALLOC_DESC ((ABTI_thread_type)(0x1 << 8))
98 /* Both a thread descriptor and a ULT stack are allocated together from a memory
99  * pool. */
100 #define ABTI_THREAD_TYPE_MEM_MEMPOOL_DESC_STACK ((ABTI_thread_type)(0x1 << 9))
101 /* Both a thread descriptor and a ULT stack are allocated together by malloc().
102  */
103 #define ABTI_THREAD_TYPE_MEM_MALLOC_DESC_STACK ((ABTI_thread_type)(0x1 << 10))
104 /* Both a thread descriptor and a ULT stack are allocated separately. A memory
105  * pool is used for a descriptor. A ULT stack is lazily allocated from a
106  * memory pool (so p_stack can be NULL). */
107 #define ABTI_THREAD_TYPE_MEM_MEMPOOL_DESC_MEMPOOL_LAZY_STACK \
108  ((ABTI_thread_type)(0x1 << 11))
109 /* Both a thread descriptor and a ULT stack are allocated separately. A memory
110  * pool is used for a descriptor. A ULT stack is lazily allocated from a
111  * memory pool (so p_stack can be NULL). */
112 #define ABTI_THREAD_TYPE_MEM_MALLOC_DESC_MEMPOOL_LAZY_STACK \
113  ((ABTI_thread_type)(0x1 << 12))
114 
115 #define ABTI_THREAD_TYPES_MEM \
116  (ABTI_THREAD_TYPE_MEM_MEMPOOL_DESC | ABTI_THREAD_TYPE_MEM_MALLOC_DESC | \
117  ABTI_THREAD_TYPE_MEM_MEMPOOL_DESC_STACK | \
118  ABTI_THREAD_TYPE_MEM_MALLOC_DESC_STACK | \
119  ABTI_THREAD_TYPE_MEM_MEMPOOL_DESC_MEMPOOL_LAZY_STACK | \
120  ABTI_THREAD_TYPE_MEM_MALLOC_DESC_MEMPOOL_LAZY_STACK)
121 
122 /* ABTI_MUTEX_ATTR_NONE must be 0. See ABT_MUTEX_INITIALIZER. */
123 #define ABTI_MUTEX_ATTR_NONE 0
124 /* ABTI_MUTEX_ATTR_RECURSIVE must be 1. See ABT_RECURSIVE_MUTEX_INITIALIZER. */
125 #define ABTI_MUTEX_ATTR_RECURSIVE 1
126 
127 /* Macro functions */
128 #define ABTI_UNUSED(a) (void)(a)
129 
130 /* Data Types */
131 typedef struct ABTI_global ABTI_global;
132 typedef struct ABTI_local ABTI_local;
133 typedef struct ABTI_local_func ABTI_local_func;
134 typedef struct ABTI_xstream ABTI_xstream;
135 typedef enum ABTI_xstream_type ABTI_xstream_type;
136 typedef struct ABTI_sched ABTI_sched;
137 typedef struct ABTI_sched_config ABTI_sched_config;
138 typedef enum ABTI_sched_used ABTI_sched_used;
139 typedef void *ABTI_sched_id; /* Scheduler id */
140 typedef uintptr_t ABTI_sched_kind; /* Scheduler kind */
141 typedef struct ABTI_pool ABTI_pool;
142 typedef struct ABTI_pool_required_def ABTI_pool_required_def;
143 typedef struct ABTI_pool_optional_def ABTI_pool_optional_def;
144 typedef struct ABTI_pool_deprecated_def ABTI_pool_deprecated_def;
145 typedef struct ABTI_pool_old_def ABTI_pool_old_def;
146 typedef struct ABTI_pool_user_def ABTI_pool_user_def;
147 typedef struct ABTI_pool_config ABTI_pool_config;
148 typedef struct ABTI_thread ABTI_thread;
149 typedef struct ABTI_thread_attr ABTI_thread_attr;
150 typedef struct ABTI_ythread ABTI_ythread;
151 typedef struct ABTI_thread_mig_data ABTI_thread_mig_data;
152 typedef uint32_t ABTI_thread_type;
153 typedef struct ABTI_key ABTI_key;
154 typedef struct ABTI_ktelem ABTI_ktelem;
155 typedef struct ABTI_ktable ABTI_ktable;
156 typedef struct ABTI_waitlist ABTI_waitlist;
157 typedef struct ABTI_mutex_attr ABTI_mutex_attr;
158 typedef struct ABTI_mutex ABTI_mutex;
159 typedef struct ABTI_cond ABTI_cond;
160 typedef struct ABTI_rwlock ABTI_rwlock;
161 typedef struct ABTI_eventual ABTI_eventual;
162 typedef struct ABTI_future ABTI_future;
163 typedef struct ABTI_barrier ABTI_barrier;
164 typedef struct ABTI_xstream_barrier ABTI_xstream_barrier;
165 typedef struct ABTI_timer ABTI_timer;
166 #ifndef ABT_CONFIG_DISABLE_TOOL_INTERFACE
167 typedef struct ABTI_tool_context ABTI_tool_context;
168 #endif
169 /* ID associated with native thread (e.g, Pthreads), which can distinguish
170  * execution streams and external threads */
171 struct ABTI_native_thread_id_opaque;
172 typedef struct ABTI_native_thread_id_opaque *ABTI_native_thread_id;
173 /* ID associated with thread (i.e., ULTs, tasklets, and external threads) */
174 struct ABTI_thread_id_opaque;
175 typedef struct ABTI_thread_id_opaque *ABTI_thread_id;
176 /* Unit-to-thread hash table. */
177 typedef struct ABTI_atomic_unit_to_thread ABTI_atomic_unit_to_thread;
178 typedef struct ABTI_unit_to_thread_entry ABTI_unit_to_thread_entry;
179 typedef enum ABTI_stack_guard ABTI_stack_guard;
180 
181 /* Architecture-Dependent Definitions */
182 #include "abtd.h"
183 
184 /* Basic data structure and memory pool. */
185 #include "abti_sync_lifo.h"
186 #include "abti_mem_pool.h"
187 
188 /* Definitions */
189 struct ABTI_waitlist {
190 #ifndef ABT_CONFIG_ACTIVE_WAIT_POLICY
191  ABTD_futex_multiple futex;
192 #endif
193  ABTI_thread *p_head;
194  ABTI_thread *p_tail;
195 };
196 
197 struct ABTI_mutex_attr {
198  int attrs; /* bit-or'ed attributes */
199 };
200 
201 struct ABTI_mutex {
202  int attrs; /* attributes copied from ABTI_mutex_attr. Check
203  * ABT_(RECURSIVE_)MUTEX_INITIALIZER to see how
204  * this variable can be initialized. */
205  ABTD_spinlock lock; /* lock */
206  int nesting_cnt; /* nesting count (if recursive) */
207  ABTI_thread_id owner_id; /* owner's ID (if recursive) */
208 #ifndef ABT_CONFIG_USE_SIMPLE_MUTEX
209  ABTD_spinlock waiter_lock; /* lock */
210  ABTI_waitlist waitlist; /* waiting list */
211 #endif
212 };
213 
214 struct ABTI_atomic_unit_to_thread {
215  ABTD_atomic_ptr val;
216 };
217 
218 struct ABTI_unit_to_thread_entry {
219  ABTI_atomic_unit_to_thread list;
220  ABTD_spinlock lock; /* Protecting any list update. */
221 };
222 
223 struct ABTI_global {
224  int max_xstreams; /* Largest rank used in Argobots. */
225  int num_xstreams; /* Current # of ESs */
226  ABTI_xstream *p_xstream_head; /* List of ESs (head). The list is sorted. */
227  ABTD_spinlock
228  xstream_list_lock; /* Spinlock protecting ES list. Any read and
229  * write to this list requires a lock.*/
230 
231  int num_cores; /* Number of CPU cores */
232  ABT_bool set_affinity; /* Whether CPU affinity is used */
233  ABT_bool use_logging; /* Whether logging is used */
234  ABT_bool use_debug; /* Whether debug output is used */
235  ABT_bool print_raw_stack; /* Print raw stack or not. */
236  uint32_t key_table_size; /* Default key table size */
237  size_t thread_stacksize; /* Default stack size for ULT (in bytes) */
238  size_t sched_stacksize; /* Default stack size for sched (in bytes) */
239  uint32_t sched_event_freq; /* Default check frequency for sched */
240  uint64_t sched_sleep_nsec; /* Default nanoseconds for scheduler sleep */
241  ABTI_ythread *p_primary_ythread; /* Primary ULT */
242 
243  uint32_t
244  mutex_max_handovers; /* Default max. # of local handovers (unused) */
245  uint32_t mutex_max_wakeups; /* Default max. # of wakeups (unused) */
246  size_t sys_page_size; /* System page size (typically, 4KB) */
247  size_t huge_page_size; /* Huge page size */
248 #ifdef ABT_CONFIG_USE_MEM_POOL
249  size_t mem_page_size; /* Page size for memory allocation */
250  size_t mem_sp_size; /* Stack page size */
251  uint32_t mem_max_stacks; /* Max. # of stacks kept in each ES */
252  uint32_t mem_max_descs; /* Max. # of descriptors kept in each ES */
253  int mem_lp_alloc; /* How to allocate large pages */
254 
255  ABTI_mem_pool_global_pool mem_pool_stack; /* Pool of stack (default size) */
256  ABTI_mem_pool_global_pool mem_pool_desc; /* Pool of descriptors that can
257  * store ABTI_task. */
258 #ifndef ABT_CONFIG_DISABLE_EXT_THREAD
259  /* They are used for external threads. */
260  ABTD_spinlock mem_pool_stack_lock;
261  ABTI_mem_pool_local_pool mem_pool_stack_ext;
262  ABTD_spinlock mem_pool_desc_lock;
263  ABTI_mem_pool_local_pool mem_pool_desc_ext;
264 #endif
265 #endif
266  ABTI_stack_guard stack_guard_kind; /* Stack guard type. */
267 
268  ABT_bool print_config; /* Whether to print config on ABT_init */
269 
270 #ifndef ABT_CONFIG_DISABLE_TOOL_INTERFACE
271  ABTD_spinlock tool_writer_lock;
272 
273  ABT_tool_thread_callback_fn tool_thread_cb_f;
274  void *tool_thread_user_arg;
275  ABTD_atomic_uint64 tool_thread_event_mask_tagged;
276 #endif
277 
278  ABTI_unit_to_thread_entry
279  unit_to_thread_entires[ABTI_UNIT_HASH_TABLE_SIZE]; /* Hash table that
280  maps ABT_unit to
281  ABTI_thread */
282 };
283 
284 struct ABTI_local; /* Empty. */
285 
286 struct ABTI_local_func {
287  char padding1[ABT_CONFIG_STATIC_CACHELINE_SIZE];
288  ABTI_local *(*get_local_f)(void);
289  void (*set_local_xstream_f)(ABTI_xstream *);
290  void *(*get_local_ptr_f)(void);
291  char padding2[ABT_CONFIG_STATIC_CACHELINE_SIZE];
292 };
293 
294 struct ABTI_xstream {
295  /* Linked list to manage all execution streams. */
296  ABTI_xstream *p_prev;
297  ABTI_xstream *p_next;
298 
299  int rank; /* Rank */
300  ABTI_xstream_type type; /* Type */
301  ABTD_atomic_int state; /* State (ABT_xstream_state) */
302  ABTI_sched *p_main_sched; /* Main scheduler, which is the bottom of the
303  * linked list of schedulers */
304  ABTD_xstream_context ctx; /* ES context */
305 
306  ABTI_ythread
307  *p_root_ythread; /* Root thread that schedulers the main scheduler. */
308  ABTI_pool *p_root_pool; /* Root pool that stores the main scheduler. */
309 
311  ABTI_thread *p_thread; /* Current running ULT/tasklet */
312 
313 #ifdef ABT_CONFIG_USE_MEM_POOL
314  ABTI_mem_pool_local_pool mem_pool_stack;
315  ABTI_mem_pool_local_pool mem_pool_desc;
316 #endif
317 };
318 
319 struct ABTI_sched {
320  ABTI_sched_used used; /* To know if it is used and how */
321  ABT_bool automatic; /* To know if automatic data free */
322  ABTI_sched_kind kind; /* Kind of the scheduler */
323  ABT_sched_type type; /* Can yield or not (ULT or task) */
324  ABTI_sched *p_replace_sched; /* Main scheduler that should replace this.
325  * ABTI_SCHED_REQ_REPLACE should be set. */
326  ABTI_ythread *p_replace_waiter; /* Thread waiting for replacement. */
327  ABTD_atomic_uint32 request; /* Request */
328  ABT_pool *pools; /* Thread pools */
329  size_t num_pools; /* Number of thread pools */
330  ABTI_ythread *p_ythread; /* Associated ULT */
331  void *data; /* Data for a specific scheduler */
332 
333  /* Scheduler functions */
334  ABT_sched_init_fn init;
335  ABT_sched_run_fn run;
336  ABT_sched_free_fn free;
337  ABT_sched_get_migr_pool_fn get_migr_pool;
338 
339 #ifdef ABT_CONFIG_USE_DEBUG_LOG
340  uint64_t id; /* ID */
341 #endif
342 };
343 
344 struct ABTI_sched_config {
345  ABTU_hashtable *p_table;
346 };
347 
348 struct ABTI_pool_required_def {
349  /* Required pool operations */
350  ABT_pool_user_create_unit_fn p_create_unit;
351  ABT_pool_user_free_unit_fn p_free_unit;
352  ABT_pool_user_is_empty_fn p_is_empty;
353  ABT_pool_user_pop_fn p_pop;
354  ABT_pool_user_push_fn p_push;
355 };
356 
357 struct ABTI_pool_optional_def {
358  /* Optional pool operations */
359  ABT_pool_user_init_fn p_init;
360  ABT_pool_user_free_fn p_free;
361  ABT_pool_user_get_size_fn p_get_size;
362  ABT_pool_user_pop_wait_fn p_pop_wait;
363  ABT_pool_user_pop_many_fn p_pop_many;
364  ABT_pool_user_push_many_fn p_push_many;
365  ABT_pool_user_print_all_fn p_print_all;
366 };
367 
368 struct ABTI_pool_deprecated_def {
369  /* Pool operations that might be directly called even now, but
370  * deprecated. All operations are optional. */
371  ABT_unit_is_in_pool_fn u_is_in_pool;
372  ABT_pool_pop_timedwait_fn p_pop_timedwait;
373  ABT_pool_remove_fn p_remove;
374 };
375 
376 struct ABTI_pool_old_def {
377  /* Pool operations that are not directly called now. */
378  ABT_unit_create_from_thread_fn u_create_from_thread;
379  ABT_unit_free_fn u_free;
380  ABT_pool_init_fn p_init;
381  ABT_pool_get_size_fn p_get_size;
382  ABT_pool_push_fn p_push;
383  ABT_pool_pop_fn p_pop;
384  ABT_pool_pop_wait_fn p_pop_wait;
385  ABT_pool_free_fn p_free;
386  ABT_pool_print_all_fn p_print_all;
387 };
388 
389 struct ABTI_pool {
390  ABT_pool_access access; /* Access mode */
391  ABT_bool automatic; /* To know if automatic data free */
392  ABT_bool is_builtin; /* Built-in pool. */
393  /* NOTE: int32_t to check if still positive */
394  ABTD_atomic_int32 num_scheds; /* Number of associated schedulers */
395  ABTD_atomic_int32 num_blocked; /* Number of blocked ULTs */
396  void *data; /* Specific data */
397  uint64_t id; /* ID */
398 
399  ABTI_pool_required_def required_def;
400  ABTI_pool_optional_def optional_def;
401  ABTI_pool_deprecated_def deprecated_def;
402  ABTI_pool_old_def old_def;
403 };
404 
405 struct ABTI_pool_user_def {
406  ABT_pool_access dummy_access;
407  ABT_unit_get_type_fn dummy_fn1;
408  ABT_unit_get_thread_fn dummy_fn2;
409  ABT_unit_get_task_fn dummy_fn3;
410  ABT_unit_is_in_pool_fn dummy_fn4;
412  symbol; /* This value is to check if ABT_pool_user_def points to
413  ABTI_pool_user_def or ABT_pool_def. */
414  ABTI_pool_required_def required_def;
415  ABTI_pool_optional_def optional_def;
416 };
417 
418 struct ABTI_pool_config {
419  ABTU_hashtable *p_table;
420 };
421 
422 struct ABTI_thread {
423  ABTI_thread *p_prev;
424  ABTI_thread *p_next;
425  ABTD_atomic_int is_in_pool; /* Whether this thread is in a pool. */
426  ABTI_thread_type type; /* Thread type */
427  ABT_unit unit; /* Unit enclosing this thread */
428  ABTI_xstream *p_last_xstream; /* Last ES where it ran */
429  ABTI_thread *p_parent; /* Parent thread */
430  void (*f_thread)(void *); /* Thread function */
431  void *p_arg; /* Thread function argument */
432  ABTD_atomic_int state; /* State (ABT_thread_state) */
433  ABTD_atomic_uint32 request; /* Request */
434  ABTI_pool *p_pool; /* Associated pool */
435  ABTD_atomic_ptr p_keytable; /* Thread-specific data (ABTI_ktable *) */
436  ABT_unit_id id; /* ID */
437 };
438 
439 struct ABTI_thread_attr {
440  void *p_stack; /* Stack address */
441  size_t stacksize; /* Stack size (in bytes) */
442 #ifndef ABT_CONFIG_DISABLE_MIGRATION
443  ABT_bool migratable; /* Migratability */
444  void (*f_cb)(ABT_thread, void *); /* Callback function */
445  void *p_cb_arg; /* Callback function argument */
446 #endif
447 };
448 
449 struct ABTI_thread_mig_data {
450  void (*f_migration_cb)(ABT_thread, void *); /* Callback function */
451  void *p_migration_cb_arg; /* Callback function argument */
452  ABTD_atomic_ptr
453  p_migration_pool; /* Destination of migration (ABTI_pool *) */
454 };
455 
456 struct ABTI_ythread {
457  ABTI_thread thread; /* Common thread definition */
458  ABTD_ythread_context ctx; /* Context */
459 };
460 
461 struct ABTI_key {
462  void (*f_destructor)(void *value);
463  uint32_t id;
464 };
465 
466 struct ABTI_ktelem {
467  /* information of ABTI_key */
468  void (*f_destructor)(void *value);
469  uint32_t key_id;
470  void *value;
471  ABTD_atomic_ptr p_next; /* Next element (ABTI_ktelem *) */
472 };
473 
474 struct ABTI_ktable {
475  int size; /* size of the table */
476  ABTD_spinlock lock; /* Protects any new entry creation. */
477  void *p_used_mem;
478  void *p_extra_mem;
479  size_t extra_mem_size;
480  ABTD_atomic_ptr p_elems[1]; /* element array (ABTI_ktelem *) */
481 };
482 
483 struct ABTI_cond {
484  ABTD_spinlock lock;
485  ABTI_mutex *p_waiter_mutex;
486  ABTI_waitlist waitlist;
487 };
488 
489 struct ABTI_rwlock {
490  ABTI_mutex mutex;
491  ABTI_cond cond;
492  size_t reader_count;
493  int write_flag;
494 };
495 
496 struct ABTI_eventual {
497  ABTD_spinlock lock;
498  ABT_bool ready;
499  void *value;
500  size_t nbytes;
501  ABTI_waitlist waitlist;
502 };
503 
504 struct ABTI_future {
505  ABTD_spinlock lock;
506  ABTD_atomic_size counter;
507  size_t num_compartments;
508  void **array;
509  void (*p_callback)(void **arg);
510  ABTI_waitlist waitlist;
511 };
512 
513 struct ABTI_barrier {
514  size_t num_waiters;
515  volatile size_t counter;
516  ABTD_spinlock lock;
517  ABTI_waitlist waitlist;
518 };
519 
520 struct ABTI_xstream_barrier {
521  uint32_t num_waiters;
522 #ifdef HAVE_PTHREAD_BARRIER_INIT
523  ABTD_xstream_barrier bar;
524 #else
525  ABTD_spinlock lock;
526  uint32_t counter;
527  ABTD_atomic_uint64 tag;
528 #endif
529 };
530 
531 struct ABTI_timer {
532  ABTD_time start;
533  ABTD_time end;
534 };
535 
536 #ifndef ABT_CONFIG_DISABLE_TOOL_INTERFACE
537 struct ABTI_tool_context {
538  ABTI_thread *p_caller;
539  ABTI_pool *p_pool;
540  ABTI_thread
541  *p_parent; /* Parent of the target thread. Used to get the depth */
542  ABT_sync_event_type sync_event_type;
543  void *p_sync_object; /* ABTI type */
544 };
545 #endif
546 
547 /* Global Data */
548 extern ABTI_global *gp_ABTI_global;
549 extern ABTI_local_func gp_ABTI_local_func;
550 
551 /* ES Local Data */
552 extern ABTD_XSTREAM_LOCAL ABTI_local *lp_ABTI_local;
553 
554 /* Global information */
555 ABT_bool ABTI_initialized(void);
556 
557 /* Execution Stream (ES) */
558 ABTU_ret_err int ABTI_xstream_create_primary(ABTI_global *p_global,
559  ABTI_xstream **pp_xstream);
560 void ABTI_xstream_start_primary(ABTI_global *p_global,
561  ABTI_xstream **pp_local_xstream,
562  ABTI_xstream *p_xstream,
563  ABTI_ythread *p_ythread);
564 void ABTI_xstream_free(ABTI_global *p_global, ABTI_local *p_local,
565  ABTI_xstream *p_xstream, ABT_bool force_free);
566 void ABTI_xstream_schedule(void *p_arg);
567 void ABTI_xstream_check_events(ABTI_xstream *p_xstream, ABTI_sched *p_sched);
568 void ABTI_xstream_print(ABTI_xstream *p_xstream, FILE *p_os, int indent,
569  ABT_bool print_sub);
570 
571 /* Scheduler */
572 ABT_sched_def *ABTI_sched_get_basic_def(void);
573 ABT_sched_def *ABTI_sched_get_basic_wait_def(void);
574 ABT_sched_def *ABTI_sched_get_prio_def(void);
575 ABT_sched_def *ABTI_sched_get_randws_def(void);
576 void ABTI_sched_finish(ABTI_sched *p_sched);
577 void ABTI_sched_exit(ABTI_sched *p_sched);
578 ABTU_ret_err int ABTI_sched_create_basic(ABT_sched_predef predef, int num_pools,
579  ABT_pool *pools,
580  ABTI_sched_config *p_config,
581  ABTI_sched **pp_newsched);
582 void ABTI_sched_free(ABTI_global *p_global, ABTI_local *p_local,
583  ABTI_sched *p_sched, ABT_bool force_free);
584 ABTU_ret_err int ABTI_sched_get_migration_pool(ABTI_sched *, ABTI_pool *,
585  ABTI_pool **);
586 ABT_bool ABTI_sched_has_to_stop(ABTI_sched *p_sched);
587 ABT_bool ABTI_sched_has_unit(ABTI_sched *p_sched);
588 void ABTI_sched_print(ABTI_sched *p_sched, FILE *p_os, int indent,
589  ABT_bool print_sub);
590 void ABTI_sched_reset_id(void);
591 
592 /* Scheduler config */
593 ABTU_ret_err int ABTI_sched_config_read(const ABTI_sched_config *p_config,
594  int idx, void *p_val);
595 
596 /* Pool */
597 ABTU_ret_err int ABTI_pool_create_basic(ABT_pool_kind kind,
598  ABT_pool_access access,
599  ABT_bool automatic,
600  ABTI_pool **pp_newpool);
601 void ABTI_pool_free(ABTI_pool *p_pool);
602 ABTU_ret_err int
603 ABTI_pool_get_fifo_def(ABT_pool_access access,
604  ABTI_pool_required_def *p_required_def,
605  ABTI_pool_optional_def *p_optional_def,
606  ABTI_pool_deprecated_def *p_deprecated_def);
607 ABTU_ret_err int
608 ABTI_pool_get_fifo_wait_def(ABT_pool_access access,
609  ABTI_pool_required_def *p_required_def,
610  ABTI_pool_optional_def *p_optional_def,
611  ABTI_pool_deprecated_def *p_deprecated_def);
612 ABTU_ret_err int
613 ABTI_pool_get_randws_def(ABT_pool_access access,
614  ABTI_pool_required_def *p_required_def,
615  ABTI_pool_optional_def *p_optional_def,
616  ABTI_pool_deprecated_def *p_deprecated_def);
617 void ABTI_pool_print(ABTI_pool *p_pool, FILE *p_os, int indent);
618 void ABTI_pool_reset_id(void);
619 
620 /* Pool config */
621 ABTU_ret_err int ABTI_pool_config_read(const ABTI_pool_config *p_config,
622  int key, void *p_val);
623 
624 /* Pool definition */
625 ABT_bool ABTI_pool_user_def_is_new(const ABT_pool_user_def def);
626 
627 /* Work Unit */
628 void ABTI_unit_init_hash_table(ABTI_global *p_global);
629 void ABTI_unit_finalize_hash_table(ABTI_global *p_global);
630 ABTU_ret_err int ABTI_unit_map_thread(ABTI_global *p_global, ABT_unit unit,
631  ABTI_thread *p_thread);
632 void ABTI_unit_unmap_thread(ABTI_global *p_global, ABT_unit unit);
633 ABTI_thread *ABTI_unit_get_thread_from_user_defined_unit(ABTI_global *p_global,
634  ABT_unit unit);
635 /* Threads */
636 ABTU_ret_err int ABTI_thread_get_mig_data(ABTI_global *p_global,
637  ABTI_local *p_local,
638  ABTI_thread *p_thread,
639  ABTI_thread_mig_data **pp_mig_data);
640 ABTU_ret_err int ABTI_thread_revive(ABTI_global *p_global, ABTI_local *p_local,
641  ABTI_pool *p_pool,
642  void (*thread_func)(void *), void *arg,
643  ABTI_thread *p_thread);
644 void ABTI_thread_join(ABTI_local **pp_local, ABTI_thread *p_thread);
645 void ABTI_thread_free(ABTI_global *p_global, ABTI_local *p_local,
646  ABTI_thread *p_thread);
647 void ABTI_thread_handle_request_cancel(ABTI_global *p_global,
648  ABTI_xstream *p_local_xstream,
649  ABTI_thread *p_thread);
650 ABTU_ret_err int ABTI_thread_handle_request_migrate(ABTI_global *p_global,
651  ABTI_local *p_local,
652  ABTI_thread *p_thread);
653 void ABTI_thread_print(ABTI_thread *p_thread, FILE *p_os, int indent);
654 void ABTI_thread_reset_id(void);
655 ABT_unit_id ABTI_thread_get_id(ABTI_thread *p_thread);
656 
657 /* Yieldable threads */
658 ABTU_ret_err int ABTI_ythread_create_root(ABTI_global *p_global,
659  ABTI_local *p_local,
660  ABTI_xstream *p_xstream,
661  ABTI_ythread **pp_root_ythread);
662 ABTU_ret_err int ABTI_ythread_create_primary(ABTI_global *p_global,
663  ABTI_local *p_local,
664  ABTI_xstream *p_xstream,
665  ABTI_ythread **p_ythread);
666 ABTU_ret_err int ABTI_ythread_create_main_sched(ABTI_global *p_global,
667  ABTI_local *p_local,
668  ABTI_xstream *p_xstream,
669  ABTI_sched *p_sched);
670 ABTU_ret_err int ABTI_ythread_create_sched(ABTI_global *p_global,
671  ABTI_local *p_local,
672  ABTI_pool *p_pool,
673  ABTI_sched *p_sched);
674 void ABTI_ythread_free_primary(ABTI_global *p_global, ABTI_local *p_local,
675  ABTI_ythread *p_ythread);
676 void ABTI_ythread_free_root(ABTI_global *p_global, ABTI_local *p_local,
677  ABTI_ythread *p_ythread);
678 void ABTI_ythread_print_stack(ABTI_global *p_global, ABTI_ythread *p_ythread,
679  FILE *p_os);
680 
681 /* Thread attributes */
682 void ABTI_thread_attr_print(ABTI_thread_attr *p_attr, FILE *p_os, int indent);
683 ABTU_ret_err int
684 ABTI_thread_attr_dup(const ABTI_thread_attr *p_attr,
685  ABTI_thread_attr **pp_dup_attr) ABTU_ret_err;
686 
687 /* Key */
688 void ABTI_ktable_free(ABTI_global *p_global, ABTI_local *p_local,
689  ABTI_ktable *p_ktable);
690 
691 /* Information */
692 void ABTI_info_print_config(ABTI_global *p_global, FILE *fp);
693 void ABTI_info_check_print_all_thread_stacks(void);
694 
695 #include "abti_timer.h"
696 #include "abti_log.h"
697 #include "abti_local.h"
698 #include "abti_global.h"
699 #include "abti_self.h"
700 #include "abti_pool.h"
701 #include "abti_pool_config.h"
702 #include "abti_pool_user_def.h"
703 #include "abti_sched.h"
704 #include "abti_sched_config.h"
705 #include "abti_stream.h"
706 #include "abti_thread.h"
707 #include "abti_unit.h"
708 #include "abti_tool.h"
709 #include "abti_event.h"
710 #include "abti_ythread.h"
711 #include "abti_thread_attr.h"
712 #include "abti_waitlist.h"
713 #include "abti_mutex.h"
714 #include "abti_mutex_attr.h"
715 #include "abti_cond.h"
716 #include "abti_rwlock.h"
717 #include "abti_eventual.h"
718 #include "abti_future.h"
719 #include "abti_barrier.h"
720 #include "abti_stream_barrier.h"
721 #include "abti_mem.h"
722 #include "abti_key.h"
723 
724 #endif /* ABTI_H_INCLUDED */
ABT_pool_pop_fn
ABT_unit(* ABT_pool_pop_fn)(ABT_pool)
Definition: abt.h:2037
ABT_unit_get_task_fn
ABT_task(* ABT_unit_get_task_fn)(ABT_unit)
Definition: abt.h:2029
gp_ABTI_local_func
ABTI_local_func gp_ABTI_local_func
Definition: local.c:23
ABT_sched_predef
ABT_sched_predef
Predefined scheduler type.
Definition: abt.h:475
abti_global.h
abti_ythread.h
ABT_bool
int ABT_bool
Boolean type.
Definition: abt.h:1043
abti_pool_user_def.h
abti_thread_attr.h
abti_key.h
ABT_unit_is_in_pool_fn
ABT_bool(* ABT_unit_is_in_pool_fn)(ABT_unit)
Definition: abt.h:2030
abti_rwlock.h
abti_sched.h
ABT_sched_run_fn
void(* ABT_sched_run_fn)(ABT_sched)
Definition: abt.h:1402
abti_cond.h
ABT_thread
struct ABT_thread_opaque * ABT_thread
Work unit handle type.
Definition: abt.h:932
abti_thread.h
ABT_unit_get_type_fn
ABT_unit_type(* ABT_unit_get_type_fn)(ABT_unit)
Definition: abt.h:2027
ABT_pool_user_print_all_fn
void(* ABT_pool_user_print_all_fn)(ABT_pool, void *arg, void(*)(void *, ABT_thread))
Function that applies a user-given function to all work units in a pool.
Definition: abt.h:2023
abti_log.h
ABT_pool_user_create_unit_fn
ABT_unit(* ABT_pool_user_create_unit_fn)(ABT_pool, ABT_thread)
Function that creates an ABT_unit handle that is associated with an ABT_thread handle.
Definition: abt.h:1807
abti_stream.h
ABT_pool_pop_wait_fn
ABT_unit(* ABT_pool_pop_wait_fn)(ABT_pool, double)
Definition: abt.h:2038
gp_ABTI_global
ABTI_global * gp_ABTI_global
Definition: global.c:19
abti_timer.h
abti_barrier.h
abti_sched_config.h
abtd.h
ABT_pool_pop_timedwait_fn
ABT_unit(* ABT_pool_pop_timedwait_fn)(ABT_pool, double)
Definition: abt.h:2039
ABT_sched_type
ABT_sched_type
Scheduler's work unit type.
Definition: abt.h:500
ABT_pool_print_all_fn
int(* ABT_pool_print_all_fn)(ABT_pool, void *arg, void(*)(void *, ABT_unit))
Definition: abt.h:2042
abti_future.h
ABT_pool_user_push_many_fn
void(* ABT_pool_user_push_many_fn)(ABT_pool, const ABT_unit *, size_t, ABT_pool_context)
Function that pushes work units to a pool.
Definition: abt.h:2003
ABT_pool
struct ABT_pool_opaque * ABT_pool
Pool handle type.
Definition: abt.h:878
ABT_pool_user_get_size_fn
size_t(* ABT_pool_user_get_size_fn)(ABT_pool)
Function that returns the number of work units in a pool.
Definition: abt.h:1927
ABT_pool_user_push_fn
void(* ABT_pool_user_push_fn)(ABT_pool, ABT_unit, ABT_pool_context)
Function that pushes a work unit to a pool.
Definition: abt.h:1879
ABT_unit_free_fn
void(* ABT_unit_free_fn)(ABT_unit *)
Definition: abt.h:2033
abti_pool.h
ABT_sync_event_type
ABT_sync_event_type
Type of synchronization event.
Definition: abt.h:696
ABT_unit_id
uint64_t ABT_unit_id
Work unit ID type.
Definition: abt.h:921
ABT_pool_def
A struct that defines a pool.
Definition: abt.h:2049
ABT_pool_remove_fn
int(* ABT_pool_remove_fn)(ABT_pool, ABT_unit)
Definition: abt.h:2040
ABT_pool_init_fn
int(* ABT_pool_init_fn)(ABT_pool, ABT_pool_config)
Definition: abt.h:2034
abti_stream_barrier.h
abti_unit.h
ABT_sched_init_fn
int(* ABT_sched_init_fn)(ABT_sched, ABT_sched_config)
Definition: abt.h:1401
abti_mem.h
ABT_unit
struct ABT_unit_opaque * ABT_unit
Work unit handle type for scheduling.
Definition: abt.h:911
ABT_pool_user_pop_many_fn
void(* ABT_pool_user_pop_many_fn)(ABT_pool, ABT_thread *, size_t, size_t *, ABT_pool_context)
Function that pops work units from a pool.
Definition: abt.h:1978
abt_config.h
ABT_CONFIG_STATIC_CACHELINE_SIZE
#define ABT_CONFIG_STATIC_CACHELINE_SIZE
Definition: abt_config.h:81
ABT_pool_user_pop_wait_fn
ABT_thread(* ABT_pool_user_pop_wait_fn)(ABT_pool, double, ABT_pool_context)
Function that pops a work unit from a pool with wait.
Definition: abt.h:1950
abti_valgrind.h
ABTU_ret_err
#define ABTU_ret_err
Definition: abtu.h:155
ABT_pool_user_free_fn
void(* ABT_pool_user_free_fn)(ABT_pool)
Function that frees a pool.
Definition: abt.h:1911
abt.h
ABT_unit_get_thread_fn
ABT_thread(* ABT_unit_get_thread_fn)(ABT_unit)
Definition: abt.h:2028
abti_pool_config.h
ABT_pool_push_fn
void(* ABT_pool_push_fn)(ABT_pool, ABT_unit)
Definition: abt.h:2036
abti_waitlist.h
abti_sync_lifo.h
ABT_pool_user_free_unit_fn
void(* ABT_pool_user_free_unit_fn)(ABT_pool, ABT_unit)
Function that frees an ABT_unit handle.
Definition: abt.h:1824
abti_mem_pool.h
abti_tool.h
ABT_pool_user_is_empty_fn
ABT_bool(* ABT_pool_user_is_empty_fn)(ABT_pool)
Function that returns if a pool is empty.
Definition: abt.h:1840
abti_eventual.h
ABT_sched_def
A struct that defines a scheduler.
Definition: abt.h:1411
lp_ABTI_local
ABTD_XSTREAM_LOCAL ABTI_local * lp_ABTI_local
Definition: local.c:29
ABT_pool_user_pop_fn
ABT_thread(* ABT_pool_user_pop_fn)(ABT_pool, ABT_pool_context)
Function that pops a work unit from a pool.
Definition: abt.h:1859
abti_event.h
ABT_sched_get_migr_pool_fn
ABT_pool(* ABT_sched_get_migr_pool_fn)(ABT_sched)
Definition: abt.h:1405
ABT_pool_get_size_fn
size_t(* ABT_pool_get_size_fn)(ABT_pool)
Definition: abt.h:2035
ABT_pool_free_fn
int(* ABT_pool_free_fn)(ABT_pool)
Definition: abt.h:2041
ABTU_align_member_var
#define ABTU_align_member_var(size)
Definition: abtu.h:170
ABT_pool_user_init_fn
int(* ABT_pool_user_init_fn)(ABT_pool, ABT_pool_config)
Function that creates a pool.
Definition: abt.h:1896
abti_mutex_attr.h
abtu.h
ABT_tool_thread_callback_fn
void(* ABT_tool_thread_callback_fn)(ABT_thread, ABT_xstream, uint64_t event, ABT_tool_context context, void *user_arg)
Definition: abt.h:2307
abti_error.h
ABT_sched_free_fn
int(* ABT_sched_free_fn)(ABT_sched)
Definition: abt.h:1403
ABT_pool_kind
ABT_pool_kind
Predefined pool type.
Definition: abt.h:514
abti_self.h
abti_local.h
ABTU_hashtable
Definition: abtu.h:347
ABT_unit_create_from_thread_fn
ABT_unit(* ABT_unit_create_from_thread_fn)(ABT_thread)
Definition: abt.h:2031
ABT_pool_access
ABT_pool_access
Pool access type.
Definition: abt.h:556
abti_mutex.h