ARGOBOTS  4dc37e16e1b227a480715ab67dae1dcfb4d2d4e0
basic.c
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 #include "abti.h"
7 
8 static int sched_init(ABT_sched sched, ABT_sched_config config);
9 static void sched_run(ABT_sched sched);
10 static int sched_free(ABT_sched);
11 static void sched_sort_pools(int num_pools, ABT_pool *pools);
12 
15  .init = sched_init,
16  .run = sched_run,
17  .free = sched_free,
18  .get_migr_pool = NULL,
19 };
20 
21 typedef struct {
22  uint32_t event_freq;
23  int num_pools;
25 #ifdef ABT_CONFIG_USE_SCHED_SLEEP
26  struct timespec sleep_time;
27 #endif
28 } sched_data;
29 
31 {
32  return &sched_basic_def;
33 }
34 
35 static inline sched_data *sched_data_get_ptr(void *data)
36 {
37  return (sched_data *)data;
38 }
39 
40 static int sched_init(ABT_sched sched, ABT_sched_config config)
41 {
42  int abt_errno;
43  int num_pools;
44  ABTI_global *p_global = ABTI_global_get_global();
45 
46  ABTI_sched *p_sched = ABTI_sched_get_ptr(sched);
48  ABTI_sched_config *p_config = ABTI_sched_config_get_ptr(config);
49 
50  /* Default settings */
51  sched_data *p_data;
52  abt_errno = ABTU_malloc(sizeof(sched_data), (void **)&p_data);
53  ABTI_CHECK_ERROR(abt_errno);
54 
55 #ifdef ABT_CONFIG_USE_SCHED_SLEEP
56  p_data->sleep_time.tv_sec = 0;
57  p_data->sleep_time.tv_nsec = p_global->sched_sleep_nsec;
58 #endif
59 
60  /* Set the default value by default. */
61  p_data->event_freq = p_global->sched_event_freq;
62  if (p_config) {
63  int event_freq;
64  /* Set the variables from config */
65  abt_errno = ABTI_sched_config_read(p_config, ABT_sched_basic_freq.idx,
66  &event_freq);
67  if (abt_errno == ABT_SUCCESS) {
68  p_data->event_freq = event_freq;
69  }
70  }
71 
72  /* Save the list of pools */
73  num_pools = p_sched->num_pools;
74  p_data->num_pools = num_pools;
75  abt_errno =
76  ABTU_malloc(num_pools * sizeof(ABT_pool), (void **)&p_data->pools);
77  if (ABTI_IS_ERROR_CHECK_ENABLED && abt_errno != ABT_SUCCESS) {
78  ABTU_free(p_data);
79  ABTI_CHECK_ERROR(abt_errno);
80  }
81  memcpy(p_data->pools, p_sched->pools, sizeof(ABT_pool) * num_pools);
82 
83  /* Sort pools according to their access mode so the scheduler can execute
84  work units from the private pools. */
85  if (num_pools > 1) {
86  sched_sort_pools(num_pools, p_data->pools);
87  }
88 
89  p_sched->data = p_data;
90  return ABT_SUCCESS;
91 }
92 
93 static void sched_run(ABT_sched sched)
94 {
95  ABTI_global *p_global = ABTI_global_get_global();
96  ABTI_xstream *p_local_xstream =
98  ABT_thread thread = ABT_THREAD_NULL;
99  uint32_t pop_count = 0;
100  sched_data *p_data;
101  uint32_t event_freq;
102  int num_pools;
103  ABT_pool *pools;
104  int i;
105 
106  ABTI_sched *p_sched = ABTI_sched_get_ptr(sched);
107  ABTI_ASSERT(p_sched);
108 
109  p_data = sched_data_get_ptr(p_sched->data);
110  event_freq = p_data->event_freq;
111  num_pools = p_data->num_pools;
112  pools = p_data->pools;
113 
114  while (1) {
115  for (i = 0; i < num_pools; i++) {
116  ABTI_pool *p_pool = ABTI_pool_get_ptr(pools[i]);
117  ++pop_count;
119  if (thread != ABT_THREAD_NULL) {
120  ABTI_thread *p_thread = ABTI_thread_get_ptr(thread);
121  ABTI_ythread_schedule(p_global, &p_local_xstream, p_thread);
122  break;
123  }
124  }
125  /* if we attempted event_freq pops, check for events */
126  if (pop_count >= event_freq) {
127  ABTI_xstream_check_events(p_local_xstream, p_sched);
128  if (ABTI_sched_has_to_stop(p_sched) == ABT_TRUE)
129  break;
130  SCHED_SLEEP(thread != ABT_THREAD_NULL, p_data->sleep_time);
131  pop_count = 0;
132  }
133  }
134 }
135 
136 static int sched_free(ABT_sched sched)
137 {
138  ABTI_sched *p_sched = ABTI_sched_get_ptr(sched);
139  ABTI_ASSERT(p_sched);
140 
141  sched_data *p_data = sched_data_get_ptr(p_sched->data);
142  ABTU_free(p_data->pools);
143  ABTU_free(p_data);
144  return ABT_SUCCESS;
145 }
146 
147 static int pool_get_access_num(ABT_pool *p_pool)
148 {
149  ABT_pool_access access;
150  int num = 0;
151 
152  access = ABTI_pool_get_ptr(*p_pool)->access;
153  switch (access) {
155  num = 0;
156  break;
159  num = 1;
160  break;
163  num = 2;
164  break;
165  default:
166  ABTI_ASSERT(0);
168  }
169 
170  return num;
171 }
172 
173 static int sched_cmp_pools(const void *p1, const void *p2)
174 {
175  int p1_access, p2_access;
176 
177  p1_access = pool_get_access_num((ABT_pool *)p1);
178  p2_access = pool_get_access_num((ABT_pool *)p2);
179 
180  if (p1_access > p2_access) {
181  return 1;
182  } else if (p1_access < p2_access) {
183  return -1;
184  } else {
185  return 0;
186  }
187 }
188 
189 static void sched_sort_pools(int num_pools, ABT_pool *pools)
190 {
191  qsort(pools, num_pools, sizeof(ABT_pool), sched_cmp_pools);
192 }
ABTI_CHECK_NULL_SCHED_PTR
#define ABTI_CHECK_NULL_SCHED_PTR(p)
Definition: abti_error.h:211
ABTI_sched::data
void * data
Definition: abti.h:331
ABTI_sched_get_ptr
static ABTI_sched * ABTI_sched_get_ptr(ABT_sched sched)
Definition: abti_sched.h:11
ABTI_global::sched_sleep_nsec
uint64_t sched_sleep_nsec
Definition: abti.h:240
sched_data::event_freq
uint32_t event_freq
Definition: basic.c:22
ABTI_sched_has_to_stop
ABT_bool ABTI_sched_has_to_stop(ABTI_sched *p_sched)
Definition: sched.c:925
ABT_sched_def::type
ABT_sched_type type
Unused value.
Definition: abt.h:1418
ABT_thread
struct ABT_thread_opaque * ABT_thread
Work unit handle type.
Definition: abt.h:932
ABT_POOL_CONTEXT_OP_POOL_OTHER
#define ABT_POOL_CONTEXT_OP_POOL_OTHER
A flag that hints an unspecified pool operation.
Definition: abt.h:1660
ABTI_global_get_global
static ABTI_global * ABTI_global_get_global(void)
Definition: abti_global.h:9
ABTI_CHECK_ERROR
#define ABTI_CHECK_ERROR(abt_errno)
Definition: abti_error.h:136
data
Definition: fifo.c:45
ABTI_sched::num_pools
size_t num_pools
Definition: abti.h:329
sched_data
Definition: basic.c:21
ABT_POOL_ACCESS_MPMC
@ ABT_POOL_ACCESS_MPMC
Definition: abt.h:575
ABT_sched_config
struct ABT_sched_config_opaque * ABT_sched_config
Scheduler configuration handle type.
Definition: abt.h:852
sched_data::num_pools
int num_pools
Definition: basic.c:23
ABT_THREAD_NULL
#define ABT_THREAD_NULL
Definition: abt.h:1105
sched_init
static int sched_init(ABT_sched sched, ABT_sched_config config)
Definition: basic.c:40
ABTI_thread
Definition: abti.h:422
ABTI_IS_ERROR_CHECK_ENABLED
#define ABTI_IS_ERROR_CHECK_ENABLED
Definition: abti.h:20
ABTI_xstream
Definition: abti.h:294
sched_sort_pools
static void sched_sort_pools(int num_pools, ABT_pool *pools)
Definition: basic.c:189
ABTI_sched_config
Definition: abti.h:344
ABT_pool
struct ABT_pool_opaque * ABT_pool
Pool handle type.
Definition: abt.h:878
ABT_POOL_ACCESS_MPSC
@ ABT_POOL_ACCESS_MPSC
Definition: abt.h:569
ABTI_pool_pop
static ABT_thread ABTI_pool_pop(ABTI_pool *p_pool, ABT_pool_context context)
Definition: abti_pool.h:93
ABTU_unreachable
#define ABTU_unreachable()
Definition: abtu.h:133
ABT_POOL_ACCESS_PRIV
@ ABT_POOL_ACCESS_PRIV
Definition: abt.h:560
ABT_sched
struct ABT_sched_opaque * ABT_sched
Scheduler handle type.
Definition: abt.h:845
ABT_SCHED_TYPE_ULT
@ ABT_SCHED_TYPE_ULT
Definition: abt.h:502
ABTI_pool
Definition: abti.h:389
sched_basic_def
static ABT_sched_def sched_basic_def
Definition: basic.c:13
abti.h
ABTU_malloc
static ABTU_ret_err int ABTU_malloc(size_t size, void **p_ptr)
Definition: abtu.h:235
ABTI_sched_get_basic_def
ABT_sched_def * ABTI_sched_get_basic_def(void)
Definition: basic.c:30
ABTI_global::sched_event_freq
uint32_t sched_event_freq
Definition: abti.h:239
sched_data::pools
ABT_pool * pools
Definition: basic.c:24
ABTI_sched_config_read
ABTU_ret_err int ABTI_sched_config_read(const ABTI_sched_config *p_config, int idx, void *p_val)
Definition: sched_config.c:415
sched_data_get_ptr
static sched_data * sched_data_get_ptr(void *data)
Definition: basic.c:35
ABTI_ASSERT
#define ABTI_ASSERT(cond)
Definition: abti_error.h:12
ABTI_sched::pools
ABT_pool * pools
Definition: abti.h:328
ABTI_local_get_local
static ABTI_local * ABTI_local_get_local(void)
Definition: abti_local.h:41
sched_free
static int sched_free(ABT_sched)
Definition: basic.c:136
ABT_SUCCESS
#define ABT_SUCCESS
Error code: the routine returns successfully.
Definition: abt.h:92
pool_get_access_num
static int pool_get_access_num(ABT_pool *p_pool)
Definition: basic.c:147
ABTI_xstream_check_events
void ABTI_xstream_check_events(ABTI_xstream *p_xstream, ABTI_sched *p_sched)
Definition: stream.c:1624
ABTI_ythread_schedule
static void ABTI_ythread_schedule(ABTI_global *p_global, ABTI_xstream **pp_local_xstream, ABTI_thread *p_thread)
Definition: abti_ythread.h:650
ABT_TRUE
#define ABT_TRUE
True constant for ABT_bool.
Definition: abt.h:784
ABTI_pool_get_ptr
static ABTI_pool * ABTI_pool_get_ptr(ABT_pool pool)
Definition: abti_pool.h:11
ABT_POOL_ACCESS_SPMC
@ ABT_POOL_ACCESS_SPMC
Definition: abt.h:573
ABTI_sched
Definition: abti.h:319
ABTI_pool::access
ABT_pool_access access
Definition: abti.h:390
sched_run
static void sched_run(ABT_sched sched)
Definition: basic.c:93
ABT_POOL_ACCESS_SPSC
@ ABT_POOL_ACCESS_SPSC
Definition: abt.h:565
ABTU_free
static void ABTU_free(void *ptr)
Definition: abtu.h:228
ABT_sched_def
A struct that defines a scheduler.
Definition: abt.h:1411
ABTI_global
Definition: abti.h:223
SCHED_SLEEP
#define SCHED_SLEEP(c, t)
Definition: abti_sched.h:81
ABT_sched_basic_freq
ABT_sched_config_var ABT_sched_basic_freq
Predefined ABT_sched_config_var to configure the frequency for checking events of the basic scheduler...
Definition: sched_config.c:51
ABTI_local_get_xstream
static ABTI_xstream * ABTI_local_get_xstream(ABTI_local *p_local)
Definition: abti_local.h:86
sched_cmp_pools
static int sched_cmp_pools(const void *p1, const void *p2)
Definition: basic.c:173
ABTI_thread_get_ptr
static ABTI_thread * ABTI_thread_get_ptr(ABT_thread thread)
Definition: abti_thread.h:9
ABTI_sched_config_get_ptr
static ABTI_sched_config * ABTI_sched_config_get_ptr(ABT_sched_config config)
Definition: abti_sched_config.h:12
ABT_sched_config_var::idx
int idx
Definition: abt.h:1351
ABT_pool_access
ABT_pool_access
Pool access type.
Definition: abt.h:556