ARGOBOTS  4dc37e16e1b227a480715ab67dae1dcfb4d2d4e0
abti_unit.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_UNIT_H_INCLUDED
7 #define ABTI_UNIT_H_INCLUDED
8 
9 /* A hash table is heavy. It should be avoided as much as possible. */
10 #define ABTI_UNIT_BUILTIN_POOL_BIT ((uintptr_t)0x1)
11 
13 {
14  if (((uintptr_t)unit) & ABTI_UNIT_BUILTIN_POOL_BIT) {
15  /* This must happen only when unit is associated with a built-in pool.
16  * See ABT_pool_def's u_create_from_thread() for details. */
17  return ABT_TRUE;
18  } else {
19  return ABT_FALSE;
20  }
21 }
22 
24 {
25  ABTI_ASSERT(!(((uintptr_t)p_thread) & ABTI_UNIT_BUILTIN_POOL_BIT));
26  return (ABT_unit)(((uintptr_t)p_thread) | ABTI_UNIT_BUILTIN_POOL_BIT);
27 }
28 
29 static inline void ABTI_unit_init_builtin(ABTI_thread *p_thread)
30 {
31  p_thread->p_prev = NULL;
32  p_thread->p_next = NULL;
34  p_thread->unit = ABTI_unit_get_builtin_unit(p_thread);
35 }
36 
38 {
40  return (ABTI_thread *)(((uintptr_t)unit) & (~ABTI_UNIT_BUILTIN_POOL_BIT));
41 }
42 
43 static inline ABTI_thread *ABTI_unit_get_thread(ABTI_global *p_global,
44  ABT_unit unit)
45 {
46  if (ABTU_likely(ABTI_unit_is_builtin(unit))) {
47  /* This unit is associated with a built-in pool. */
49  } else {
50  return ABTI_unit_get_thread_from_user_defined_unit(p_global, unit);
51  }
52 }
53 
54 ABTU_ret_err static inline int
56  ABTI_pool *p_pool, ABTI_thread **pp_thread)
57 {
58  if (ABTU_likely(ABTI_unit_is_builtin(unit))) {
60  if (ABTU_likely(p_pool->is_builtin)) {
61  /* Do nothing since built-in pools share the implementation of
62  * ABT_unit. */
63  p_thread->p_pool = p_pool;
64  *pp_thread = p_thread;
65  return ABT_SUCCESS;
66  } else {
67  /* The new pool is a user-defined pool. */
68  ABT_pool pool = ABTI_pool_get_handle(p_pool);
69  ABT_unit new_unit =
71  p_thread));
72  if (new_unit == ABT_UNIT_NULL)
73  return ABT_ERR_OTHER;
74  int ret = ABTI_unit_map_thread(p_global, new_unit, p_thread);
75  if (ret != ABT_SUCCESS) {
76  p_pool->required_def.p_free_unit(pool, new_unit);
77  return ret;
78  }
79  p_thread->unit = new_unit;
80  p_thread->p_pool = p_pool;
81  *pp_thread = p_thread;
82  return ABT_SUCCESS;
83  }
84  } else {
85  /* Currently, unit is associated with a user-defined pool. */
86  ABTI_thread *p_thread =
88  if (p_pool->is_builtin) {
89  /* The old unit is associated with a custom pool. Remove the
90  * existing mapping. */
91  ABTI_unit_unmap_thread(p_global, unit);
92  ABT_pool old_pool = ABTI_pool_get_handle(p_thread->p_pool);
93  p_thread->p_pool->required_def.p_free_unit(old_pool, unit);
94  ABTI_unit_init_builtin(p_thread);
95  p_thread->p_pool = p_pool;
96  *pp_thread = p_thread;
97  return ABT_SUCCESS;
98  } else if (p_thread->p_pool == p_pool) {
99  /* Both are associated with the same custom pool. */
100  *pp_thread = p_thread;
101  return ABT_SUCCESS;
102  } else {
103  /* Both are associated with different custom pools. */
104  ABT_pool pool = ABTI_pool_get_handle(p_pool);
105  ABT_unit new_unit =
107  p_thread));
108  if (new_unit == ABT_UNIT_NULL)
109  return ABT_ERR_OTHER;
110  int ret = ABTI_unit_map_thread(p_global, new_unit, p_thread);
111  if (ret != ABT_SUCCESS) {
112  p_pool->required_def.p_free_unit(pool, new_unit);
113  return ret;
114  }
115  ABTI_unit_unmap_thread(p_global, unit);
116  ABT_pool old_pool = ABTI_pool_get_handle(p_thread->p_pool);
117  p_thread->p_pool->required_def.p_free_unit(old_pool, unit);
118  p_thread->unit = new_unit;
119  p_thread->p_pool = p_pool;
120  *pp_thread = p_thread;
121  return ABT_SUCCESS;
122  }
123  }
124 }
125 
126 /* The following functions have ABTI_thread prefix, but they mainly manage
127  * thread-unit mapping, so they are placed in this header file so far. */
128 ABTU_ret_err static inline int ABTI_thread_init_pool(ABTI_global *p_global,
129  ABTI_thread *p_thread,
130  ABTI_pool *p_pool)
131 {
132  if (ABTU_likely(p_pool->is_builtin)) {
133  ABTI_unit_init_builtin(p_thread);
134  p_thread->p_pool = p_pool;
135  return ABT_SUCCESS;
136  } else {
137  ABT_pool pool = ABTI_pool_get_handle(p_pool);
138  ABT_unit new_unit =
140  p_thread));
141  if (new_unit == ABT_UNIT_NULL)
142  return ABT_ERR_OTHER;
143  int ret = ABTI_unit_map_thread(p_global, new_unit, p_thread);
144  if (ret != ABT_SUCCESS) {
145  p_pool->required_def.p_free_unit(pool, new_unit);
146  return ret;
147  }
148  p_thread->unit = new_unit;
149  p_thread->p_pool = p_pool;
150  return ABT_SUCCESS;
151  }
152 }
153 
154 ABTU_ret_err static inline int
156  ABTI_pool *p_pool)
157 {
158  ABT_unit unit = p_thread->unit;
159  if (ABTU_likely(ABTI_unit_is_builtin(unit) && p_pool->is_builtin)) {
160  /* Do nothing since built-in pools share the implementation of
161  * ABT_unit. */
162  p_thread->p_pool = p_pool;
163  return ABT_SUCCESS;
164  } else if (ABTI_unit_is_builtin(unit)) {
165  /* The new unit is associated with a custom pool. Add a new mapping. */
166  ABT_pool pool = ABTI_pool_get_handle(p_pool);
167  ABT_unit new_unit =
169  p_thread));
170  if (new_unit == ABT_UNIT_NULL)
171  return ABT_ERR_OTHER;
172  int ret = ABTI_unit_map_thread(p_global, new_unit, p_thread);
173  if (ret != ABT_SUCCESS) {
174  p_pool->required_def.p_free_unit(pool, new_unit);
175  return ret;
176  }
177  p_thread->unit = new_unit;
178  p_thread->p_pool = p_pool;
179  return ABT_SUCCESS;
180  } else if (p_pool->is_builtin) {
181  /* The old unit is associated with a custom pool. Remove the existing
182  * mapping. */
183  ABTI_unit_unmap_thread(p_global, unit);
184  ABT_pool old_pool = ABTI_pool_get_handle(p_thread->p_pool);
185  p_thread->p_pool->required_def.p_free_unit(old_pool, unit);
186  ABTI_unit_init_builtin(p_thread);
187  p_thread->p_pool = p_pool;
188  return ABT_SUCCESS;
189  } else if (p_thread->p_pool == p_pool) {
190  /* Both are associated with the same custom pool. */
191  return ABT_SUCCESS;
192  } else {
193  /* Both are associated with different custom pools. */
194  ABT_pool pool = ABTI_pool_get_handle(p_pool);
195  ABT_unit new_unit =
197  p_thread));
198  if (new_unit == ABT_UNIT_NULL)
199  return ABT_ERR_OTHER;
200  int ret = ABTI_unit_map_thread(p_global, new_unit, p_thread);
201  if (ret != ABT_SUCCESS) {
202  p_pool->required_def.p_free_unit(pool, new_unit);
203  return ret;
204  }
205  ABTI_unit_unmap_thread(p_global, unit);
206  ABT_pool old_pool = ABTI_pool_get_handle(p_thread->p_pool);
207  p_thread->p_pool->required_def.p_free_unit(old_pool, unit);
208  p_thread->unit = new_unit;
209  p_thread->p_pool = p_pool;
210  return ABT_SUCCESS;
211  }
212 }
213 
214 static inline void ABTI_thread_unset_associated_pool(ABTI_global *p_global,
215  ABTI_thread *p_thread)
216 {
217  ABT_unit unit = p_thread->unit;
218  if (ABTU_unlikely(!ABTI_unit_is_builtin(unit))) {
219  ABTI_unit_unmap_thread(p_global, unit);
220  ABT_pool old_pool = ABTI_pool_get_handle(p_thread->p_pool);
221  p_thread->p_pool->required_def.p_free_unit(old_pool, unit);
222  }
223 #if ABTI_IS_ERROR_CHECK_ENABLED
224  p_thread->unit = ABT_UNIT_NULL;
225  p_thread->p_pool = NULL;
226 #endif
227 }
228 
229 #endif /* ABTI_UNIT_H_INCLUDED */
ABTI_unit_is_builtin
static ABT_bool ABTI_unit_is_builtin(ABT_unit unit)
Definition: abti_unit.h:12
ABT_bool
int ABT_bool
Boolean type.
Definition: abt.h:1043
ABTI_unit_set_associated_pool
static ABTU_ret_err int ABTI_unit_set_associated_pool(ABTI_global *p_global, ABT_unit unit, ABTI_pool *p_pool, ABTI_thread **pp_thread)
Definition: abti_unit.h:55
ABTI_unit_get_builtin_unit
static ABT_unit ABTI_unit_get_builtin_unit(ABTI_thread *p_thread)
Definition: abti_unit.h:23
ABTI_thread::p_next
ABTI_thread * p_next
Definition: abti.h:424
ABTI_thread::unit
ABT_unit unit
Definition: abti.h:427
ABTI_unit_get_thread_from_builtin_unit
static ABTI_thread * ABTI_unit_get_thread_from_builtin_unit(ABT_unit unit)
Definition: abti_unit.h:37
ABTI_thread_get_handle
static ABT_thread ABTI_thread_get_handle(ABTI_thread *p_thread)
Definition: abti_thread.h:24
ABTI_thread_set_associated_pool
static ABTU_ret_err int ABTI_thread_set_associated_pool(ABTI_global *p_global, ABTI_thread *p_thread, ABTI_pool *p_pool)
Definition: abti_unit.h:155
ABTI_unit_unmap_thread
void ABTI_unit_unmap_thread(ABTI_global *p_global, ABT_unit unit)
Definition: unit.c:112
ABTI_thread
Definition: abti.h:422
ABTI_UNIT_BUILTIN_POOL_BIT
#define ABTI_UNIT_BUILTIN_POOL_BIT
Definition: abti_unit.h:10
ABTI_pool_required_def::p_free_unit
ABT_pool_user_free_unit_fn p_free_unit
Definition: abti.h:351
ABT_pool
struct ABT_pool_opaque * ABT_pool
Pool handle type.
Definition: abt.h:878
ABTU_likely
#define ABTU_likely(cond)
Definition: abtu.h:119
ABTI_pool
Definition: abti.h:389
ABTI_pool::is_builtin
ABT_bool is_builtin
Definition: abti.h:392
ABTI_unit_init_builtin
static void ABTI_unit_init_builtin(ABTI_thread *p_thread)
Definition: abti_unit.h:29
ABTD_atomic_relaxed_store_int
static void ABTD_atomic_relaxed_store_int(ABTD_atomic_int *ptr, int val)
Definition: abtd_atomic.h:996
ABT_unit
struct ABT_unit_opaque * ABT_unit
Work unit handle type for scheduling.
Definition: abt.h:911
ABTI_ASSERT
#define ABTI_ASSERT(cond)
Definition: abti_error.h:12
ABTI_thread::is_in_pool
ABTD_atomic_int is_in_pool
Definition: abti.h:425
ABTI_unit_get_thread_from_user_defined_unit
ABTI_thread * ABTI_unit_get_thread_from_user_defined_unit(ABTI_global *p_global, ABT_unit unit)
Definition: unit.c:117
ABT_SUCCESS
#define ABT_SUCCESS
Error code: the routine returns successfully.
Definition: abt.h:92
ABTU_ret_err
#define ABTU_ret_err
Definition: abtu.h:155
ABTI_pool::required_def
ABTI_pool_required_def required_def
Definition: abti.h:399
ABTU_unlikely
#define ABTU_unlikely(cond)
Definition: abtu.h:120
ABT_TRUE
#define ABT_TRUE
True constant for ABT_bool.
Definition: abt.h:784
ABT_FALSE
#define ABT_FALSE
False constant for ABT_bool.
Definition: abt.h:786
ABTI_unit_get_thread
static ABTI_thread * ABTI_unit_get_thread(ABTI_global *p_global, ABT_unit unit)
Definition: abti_unit.h:43
ABT_ERR_OTHER
#define ABT_ERR_OTHER
Error code: other error.
Definition: abt.h:109
ABTI_thread::p_prev
ABTI_thread * p_prev
Definition: abti.h:423
ABTI_thread_unset_associated_pool
static void ABTI_thread_unset_associated_pool(ABTI_global *p_global, ABTI_thread *p_thread)
Definition: abti_unit.h:214
ABTI_global
Definition: abti.h:223
ABTI_thread::p_pool
ABTI_pool * p_pool
Definition: abti.h:434
ABT_UNIT_NULL
#define ABT_UNIT_NULL
Definition: abt.h:1104
ABTI_unit_map_thread
ABTU_ret_err int ABTI_unit_map_thread(ABTI_global *p_global, ABT_unit unit, ABTI_thread *p_thread)
Definition: unit.c:106
ABTI_thread_init_pool
static ABTU_ret_err int ABTI_thread_init_pool(ABTI_global *p_global, ABTI_thread *p_thread, ABTI_pool *p_pool)
Definition: abti_unit.h:128
ABTI_pool_get_handle
static ABT_pool ABTI_pool_get_handle(ABTI_pool *p_pool)
Definition: abti_pool.h:26
ABTI_pool_required_def::p_create_unit
ABT_pool_user_create_unit_fn p_create_unit
Definition: abti.h:350