StarPU Handbook
starpu_sched_ctx.h
Go to the documentation of this file.
1 /* StarPU --- Runtime system for heterogeneous multicore architectures.
2  *
3  * Copyright (C) 2010,2012-2017 Inria
4  * Copyright (C) 2017 Arthur Chevalier
5  * Copyright (C) 2012-2014,2017,2019 CNRS
6  * Copyright (C) 2012,2014,2016 Université de Bordeaux
7  * Copyright (C) 2016 Uppsala University
8  *
9  * StarPU is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU Lesser General Public License as published by
11  * the Free Software Foundation; either version 2.1 of the License, or (at
12  * your option) any later version.
13  *
14  * StarPU is distributed in the hope that it will be useful, but
15  * WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
17  *
18  * See the GNU Lesser General Public License in COPYING.LGPL for more details.
19  */
20 
21 #ifndef __STARPU_SCHED_CTX_H__
22 #define __STARPU_SCHED_CTX_H__
23 
24 #include <starpu.h>
25 
26 #ifdef __cplusplus
27 extern "C"
28 {
29 #endif
30 
53 #define STARPU_SCHED_CTX_POLICY_NAME (1<<16)
54 
59 #define STARPU_SCHED_CTX_POLICY_STRUCT (2<<16)
60 
65 #define STARPU_SCHED_CTX_POLICY_MIN_PRIO (3<<16)
66 
71 #define STARPU_SCHED_CTX_POLICY_MAX_PRIO (4<<16)
72 
73 #define STARPU_SCHED_CTX_HIERARCHY_LEVEL (5<<16)
74 #define STARPU_SCHED_CTX_NESTED (6<<16)
75 
79 #define STARPU_SCHED_CTX_AWAKE_WORKERS (7<<16)
80 
85 #define STARPU_SCHED_CTX_POLICY_INIT (8<<16)
86 
91 #define STARPU_SCHED_CTX_USER_DATA (9<<16)
92 
98 #define STARPU_SCHED_CTX_CUDA_NSMS (10<<16)
99 
104 #define STARPU_SCHED_CTX_SUB_CTXS (11<<16)
105 
140 unsigned starpu_sched_ctx_create(int *workerids_ctx, int nworkers_ctx, const char *sched_ctx_name, ...);
141 
145 unsigned starpu_sched_ctx_create_inside_interval(const char *policy_name, const char *sched_ctx_name, int min_ncpus, int max_ncpus, int min_ngpus, int max_ngpus, unsigned allow_overlap);
146 
152 void starpu_sched_ctx_register_close_callback(unsigned sched_ctx_id, void (*close_callback)(unsigned sched_ctx_id, void* args), void *args);
153 
159 void starpu_sched_ctx_add_workers(int *workerids_ctx, unsigned nworkers_ctx, unsigned sched_ctx_id);
160 
166 void starpu_sched_ctx_remove_workers(int *workerids_ctx, unsigned nworkers_ctx, unsigned sched_ctx_id);
167 
172 void starpu_sched_ctx_display_workers(unsigned sched_ctx_id, FILE *f);
173 
178 void starpu_sched_ctx_delete(unsigned sched_ctx_id);
179 
185 void starpu_sched_ctx_set_inheritor(unsigned sched_ctx_id, unsigned inheritor);
186 
187 unsigned starpu_sched_ctx_get_inheritor(unsigned sched_ctx_id);
188 
189 unsigned starpu_sched_ctx_get_hierarchy_level(unsigned sched_ctx_id);
190 
195 void starpu_sched_ctx_set_context(unsigned *sched_ctx_id);
196 
202 unsigned starpu_sched_ctx_get_context(void);
203 
209 
215 void starpu_sched_ctx_finished_submit(unsigned sched_ctx_id);
216 
223 unsigned starpu_sched_ctx_get_workers_list(unsigned sched_ctx_id, int **workerids);
224 
232 unsigned starpu_sched_ctx_get_workers_list_raw(unsigned sched_ctx_id, int **workerids);
233 
239 unsigned starpu_sched_ctx_get_nworkers(unsigned sched_ctx_id);
240 
244 unsigned starpu_sched_ctx_get_nshared_workers(unsigned sched_ctx_id, unsigned sched_ctx_id2);
245 
249 unsigned starpu_sched_ctx_contains_worker(int workerid, unsigned sched_ctx_id);
250 
251 unsigned starpu_sched_ctx_contains_type_of_worker(enum starpu_worker_archtype arch, unsigned sched_ctx_id);
252 
258 unsigned starpu_sched_ctx_worker_get_id(unsigned sched_ctx_id);
259 
260 unsigned starpu_sched_ctx_get_ctx_for_task(struct starpu_task *task);
261 
265 unsigned starpu_sched_ctx_overlapping_ctxs_on_worker(int workerid);
266 
270 void *starpu_sched_ctx_get_user_data(unsigned sched_ctx_id);
271 
272 void starpu_sched_ctx_set_user_data(unsigned sched_ctx_id, void* user_data);
273 
279 void starpu_sched_ctx_set_policy_data(unsigned sched_ctx_id, void *policy_data);
280 
285 void *starpu_sched_ctx_get_policy_data(unsigned sched_ctx_id);
286 
287 struct starpu_sched_policy *starpu_sched_ctx_get_sched_policy(unsigned sched_ctx_id);
288 
293 void *starpu_sched_ctx_exec_parallel_code(void* (*func)(void*), void *param, unsigned sched_ctx_id);
294 
295 int starpu_sched_ctx_get_nready_tasks(unsigned sched_ctx_id);
296 
297 double starpu_sched_ctx_get_nready_flops(unsigned sched_ctx_id);
298 
299 void starpu_sched_ctx_list_task_counters_increment(unsigned sched_ctx_id, int workerid);
300 
301 void starpu_sched_ctx_list_task_counters_decrement(unsigned sched_ctx_id, int workerid);
302 
303 void starpu_sched_ctx_list_task_counters_reset(unsigned sched_ctx_id, int workerid);
304 
305 void starpu_sched_ctx_list_task_counters_increment_all_ctx_locked(struct starpu_task *task, unsigned sched_ctx_id);
306 
307 void starpu_sched_ctx_list_task_counters_decrement_all_ctx_locked(struct starpu_task *task, unsigned sched_ctx_id);
308 
309 void starpu_sched_ctx_list_task_counters_reset_all(struct starpu_task *task, unsigned sched_ctx_id);
310 
311 void starpu_sched_ctx_set_priority(int *workers, int nworkers, unsigned sched_ctx_id, unsigned priority);
312 
313 unsigned starpu_sched_ctx_get_priority(int worker, unsigned sched_ctx_id);
314 
315 void starpu_sched_ctx_get_available_cpuids(unsigned sched_ctx_id, int **cpuids, int *ncpuids);
316 
317 void starpu_sched_ctx_bind_current_thread_to_cpuid(unsigned cpuid);
318 
319 int starpu_sched_ctx_book_workers_for_task(unsigned sched_ctx_id, int *workerids, int nworkers);
320 
321 void starpu_sched_ctx_unbook_workers_for_task(unsigned sched_ctx_id, int master);
322 
327 unsigned starpu_sched_ctx_worker_is_master_for_child_ctx(int workerid, unsigned sched_ctx_id);
328 
333 unsigned starpu_sched_ctx_master_get_context(int masterid);
334 
335 void starpu_sched_ctx_revert_task_counters_ctx_locked(unsigned sched_ctx_id, double flops);
336 
337 void starpu_sched_ctx_move_task_to_ctx_locked(struct starpu_task *task, unsigned sched_ctx, unsigned with_repush);
338 
339 int starpu_sched_ctx_get_worker_rank(unsigned sched_ctx_id);
340 
341 void (*starpu_sched_ctx_get_sched_policy_init(unsigned sched_ctx_id))(unsigned);
342 
343 unsigned starpu_sched_ctx_has_starpu_scheduler(unsigned sched_ctx_id, unsigned *awake_workers);
344 
345 int starpu_sched_ctx_get_stream_worker(unsigned sub_ctx);
346 int starpu_sched_ctx_get_nsms(unsigned sched_ctx);
347 void starpu_sched_ctx_get_sms_interval(int stream_workerid, int *start, int *end);
348 
360 int starpu_sched_ctx_get_min_priority(unsigned sched_ctx_id);
361 
366 int starpu_sched_ctx_get_max_priority(unsigned sched_ctx_id);
367 
377 int starpu_sched_ctx_set_min_priority(unsigned sched_ctx_id, int min_prio);
378 
387 int starpu_sched_ctx_set_max_priority(unsigned sched_ctx_id, int max_prio);
388 
389 int starpu_sched_ctx_min_priority_is_set(unsigned sched_ctx_id);
390 
391 int starpu_sched_ctx_max_priority_is_set(unsigned sched_ctx_id);
392 
396 #define STARPU_MIN_PRIO (starpu_sched_get_min_priority())
397 
401 #define STARPU_MAX_PRIO (starpu_sched_get_max_priority())
402 
407 #define STARPU_DEFAULT_PRIO 0
408 
421 
425 void starpu_sched_ctx_delete_worker_collection(unsigned sched_ctx_id);
426 
431 
436 #ifdef __cplusplus
437 }
438 #endif
439 
440 #endif /* __STARPU_SCHED_CTX_H__ */
void starpu_sched_ctx_set_inheritor(unsigned sched_ctx_id, unsigned inheritor)
void starpu_sched_ctx_set_context(unsigned *sched_ctx_id)
unsigned starpu_sched_ctx_master_get_context(int masterid)
void starpu_sched_ctx_delete(unsigned sched_ctx_id)
struct starpu_worker_collection * starpu_sched_ctx_get_worker_collection(unsigned sched_ctx_id)
Definition: starpu_worker.h:103
struct starpu_worker_collection * starpu_sched_ctx_create_worker_collection(unsigned sched_ctx_id, enum starpu_worker_collection_type type) STARPU_ATTRIBUTE_MALLOC
void starpu_sched_ctx_display_workers(unsigned sched_ctx_id, FILE *f)
#define STARPU_ATTRIBUTE_MALLOC
Definition: starpu_util.h:114
void * starpu_sched_ctx_get_user_data(unsigned sched_ctx_id)
void * starpu_sched_ctx_exec_parallel_code(void *(*func)(void *), void *param, unsigned sched_ctx_id)
void starpu_sched_ctx_stop_task_submission(void)
void * starpu_sched_ctx_get_policy_data(unsigned sched_ctx_id)
int starpu_sched_ctx_set_min_priority(unsigned sched_ctx_id, int min_prio)
unsigned starpu_sched_ctx_get_nshared_workers(unsigned sched_ctx_id, unsigned sched_ctx_id2)
unsigned starpu_sched_ctx_worker_get_id(unsigned sched_ctx_id)
starpu_worker_archtype
Definition: starpu_worker.h:61
unsigned starpu_sched_ctx_get_nworkers(unsigned sched_ctx_id)
unsigned starpu_sched_ctx_get_context(void)
unsigned starpu_sched_ctx_contains_worker(int workerid, unsigned sched_ctx_id)
unsigned starpu_sched_ctx_get_workers_list_raw(unsigned sched_ctx_id, int **workerids)
unsigned starpu_sched_ctx_worker_is_master_for_child_ctx(int workerid, unsigned sched_ctx_id)
void starpu_sched_ctx_finished_submit(unsigned sched_ctx_id)
Definition: starpu_task.h:548
int starpu_sched_ctx_get_max_priority(unsigned sched_ctx_id)
unsigned starpu_sched_ctx_get_workers_list(unsigned sched_ctx_id, int **workerids)
void starpu_sched_ctx_add_workers(int *workerids_ctx, unsigned nworkers_ctx, unsigned sched_ctx_id)
unsigned starpu_sched_ctx_overlapping_ctxs_on_worker(int workerid)
int starpu_sched_ctx_set_max_priority(unsigned sched_ctx_id, int max_prio)
unsigned starpu_sched_ctx_create(int *workerids_ctx, int nworkers_ctx, const char *sched_ctx_name,...)
unsigned starpu_sched_ctx_create_inside_interval(const char *policy_name, const char *sched_ctx_name, int min_ncpus, int max_ncpus, int min_ngpus, int max_ngpus, unsigned allow_overlap)
Definition: starpu_scheduler.h:84
enum starpu_worker_collection_type type
Definition: starpu_worker.h:124
void starpu_sched_ctx_delete_worker_collection(unsigned sched_ctx_id)
starpu_worker_collection_type
Definition: starpu_worker.h:90
unsigned sched_ctx_id
Definition: starpu_sched_component.h:197
int starpu_sched_ctx_get_min_priority(unsigned sched_ctx_id)
void starpu_sched_ctx_register_close_callback(unsigned sched_ctx_id, void(*close_callback)(unsigned sched_ctx_id, void *args), void *args)
void starpu_sched_ctx_set_policy_data(unsigned sched_ctx_id, void *policy_data)
void starpu_sched_ctx_remove_workers(int *workerids_ctx, unsigned nworkers_ctx, unsigned sched_ctx_id)