StarPU Handbook - StarPU FAQs
starpu_sched_ctx.h
Go to the documentation of this file.
1 /* StarPU --- Runtime system for heterogeneous multicore architectures.
2  *
3  * Copyright (C) 2010-2021 Université de Bordeaux, CNRS (LaBRI UMR 5800), Inria
4  * Copyright (C) 2016 Uppsala University
5  * Copyright (C) 2017 Arthur Chevalier
6  *
7  * StarPU is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU Lesser General Public License as published by
9  * the Free Software Foundation; either version 2.1 of the License, or (at
10  * your option) any later version.
11  *
12  * StarPU is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
15  *
16  * See the GNU Lesser General Public License in COPYING.LGPL for more details.
17  */
18 
19 #ifndef __STARPU_SCHED_CTX_H__
20 #define __STARPU_SCHED_CTX_H__
21 
22 #include <starpu.h>
23 
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27 
50 #define STARPU_SCHED_CTX_POLICY_NAME (1 << 16)
51 
56 #define STARPU_SCHED_CTX_POLICY_STRUCT (2 << 16)
57 
62 #define STARPU_SCHED_CTX_POLICY_MIN_PRIO (3 << 16)
63 
68 #define STARPU_SCHED_CTX_POLICY_MAX_PRIO (4 << 16)
69 
70 #define STARPU_SCHED_CTX_HIERARCHY_LEVEL (5 << 16)
71 #define STARPU_SCHED_CTX_NESTED (6 << 16)
72 
76 #define STARPU_SCHED_CTX_AWAKE_WORKERS (7 << 16)
77 
82 #define STARPU_SCHED_CTX_POLICY_INIT (8 << 16)
83 
88 #define STARPU_SCHED_CTX_USER_DATA (9 << 16)
89 
95 #define STARPU_SCHED_CTX_CUDA_NSMS (10 << 16)
96 
101 #define STARPU_SCHED_CTX_SUB_CTXS (11 << 16)
102 
138 unsigned starpu_sched_ctx_create(int *workerids_ctx, int nworkers_ctx, const char *sched_ctx_name, ...);
139 
143 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);
144 
150 void starpu_sched_ctx_register_close_callback(unsigned sched_ctx_id, void (*close_callback)(unsigned sched_ctx_id, void *args), void *args);
151 
158 void starpu_sched_ctx_add_workers(int *workerids_ctx, unsigned nworkers_ctx, unsigned sched_ctx_id);
159 
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 
179 void starpu_sched_ctx_delete(unsigned sched_ctx_id);
180 
187 void starpu_sched_ctx_set_inheritor(unsigned sched_ctx_id, unsigned inheritor);
188 
189 unsigned starpu_sched_ctx_get_inheritor(unsigned sched_ctx_id);
190 
191 unsigned starpu_sched_ctx_get_hierarchy_level(unsigned sched_ctx_id);
192 
198 void starpu_sched_ctx_set_context(unsigned *sched_ctx_id);
199 
206 
213 
220 void starpu_sched_ctx_finished_submit(unsigned sched_ctx_id);
221 
228 unsigned starpu_sched_ctx_get_workers_list(unsigned sched_ctx_id, int **workerids);
229 
237 unsigned starpu_sched_ctx_get_workers_list_raw(unsigned sched_ctx_id, int **workerids);
238 
244 unsigned starpu_sched_ctx_get_nworkers(unsigned sched_ctx_id);
245 
249 unsigned starpu_sched_ctx_get_nshared_workers(unsigned sched_ctx_id, unsigned sched_ctx_id2);
250 
254 unsigned starpu_sched_ctx_contains_worker(int workerid, unsigned sched_ctx_id);
255 
256 unsigned starpu_sched_ctx_contains_type_of_worker(enum starpu_worker_archtype arch, unsigned sched_ctx_id);
257 
263 unsigned starpu_sched_ctx_worker_get_id(unsigned sched_ctx_id);
264 
265 unsigned starpu_sched_ctx_get_ctx_for_task(struct starpu_task *task);
266 
267 unsigned starpu_worker_get_sched_ctx_id_stream(unsigned stream_workerid);
268 
273 
277 void *starpu_sched_ctx_get_user_data(unsigned sched_ctx_id);
278 
279 void starpu_sched_ctx_set_user_data(unsigned sched_ctx_id, void *user_data);
280 
287 void starpu_sched_ctx_set_policy_data(unsigned sched_ctx_id, void *policy_data);
288 
294 void *starpu_sched_ctx_get_policy_data(unsigned sched_ctx_id);
295 
296 struct starpu_sched_policy *starpu_sched_ctx_get_sched_policy(unsigned sched_ctx_id);
297 
302 void *starpu_sched_ctx_exec_parallel_code(void *(*func)(void *), void *param, unsigned sched_ctx_id);
303 
304 int starpu_sched_ctx_get_nready_tasks(unsigned sched_ctx_id);
305 
306 double starpu_sched_ctx_get_nready_flops(unsigned sched_ctx_id);
307 
308 void starpu_sched_ctx_list_task_counters_increment(unsigned sched_ctx_id, int workerid);
309 
310 void starpu_sched_ctx_list_task_counters_decrement(unsigned sched_ctx_id, int workerid);
311 
312 void starpu_sched_ctx_list_task_counters_reset(unsigned sched_ctx_id, int workerid);
313 
314 void starpu_sched_ctx_list_task_counters_increment_all_ctx_locked(struct starpu_task *task, unsigned sched_ctx_id);
315 
316 void starpu_sched_ctx_list_task_counters_decrement_all_ctx_locked(struct starpu_task *task, unsigned sched_ctx_id);
317 
318 void starpu_sched_ctx_list_task_counters_reset_all(struct starpu_task *task, unsigned sched_ctx_id);
319 
320 void starpu_sched_ctx_set_priority(int *workers, int nworkers, unsigned sched_ctx_id, unsigned priority);
321 
322 unsigned starpu_sched_ctx_get_priority(int worker, unsigned sched_ctx_id);
323 
324 void starpu_sched_ctx_get_available_cpuids(unsigned sched_ctx_id, int **cpuids, int *ncpuids);
325 
326 void starpu_sched_ctx_bind_current_thread_to_cpuid(unsigned cpuid);
327 
328 int starpu_sched_ctx_book_workers_for_task(unsigned sched_ctx_id, int *workerids, int nworkers);
329 
330 void starpu_sched_ctx_unbook_workers_for_task(unsigned sched_ctx_id, int master);
331 
336 unsigned starpu_sched_ctx_worker_is_master_for_child_ctx(int workerid, unsigned sched_ctx_id);
337 
342 unsigned starpu_sched_ctx_master_get_context(int masterid);
343 
344 void starpu_sched_ctx_revert_task_counters_ctx_locked(unsigned sched_ctx_id, double flops);
345 
346 void starpu_sched_ctx_move_task_to_ctx_locked(struct starpu_task *task, unsigned sched_ctx, unsigned with_repush);
347 
348 int starpu_sched_ctx_get_worker_rank(unsigned sched_ctx_id);
349 
355 void (*starpu_sched_ctx_get_sched_policy_callback(unsigned sched_ctx_id))(unsigned);
356 
357 unsigned starpu_sched_ctx_has_starpu_scheduler(unsigned sched_ctx_id, unsigned *awake_workers);
358 
359 int starpu_sched_ctx_get_stream_worker(unsigned sub_ctx);
360 int starpu_sched_ctx_get_nsms(unsigned sched_ctx);
361 void starpu_sched_ctx_get_sms_interval(int stream_workerid, int *start, int *end);
362 
374 int starpu_sched_ctx_get_min_priority(unsigned sched_ctx_id);
375 
380 int starpu_sched_ctx_get_max_priority(unsigned sched_ctx_id);
381 
391 int starpu_sched_ctx_set_min_priority(unsigned sched_ctx_id, int min_prio);
392 
401 int starpu_sched_ctx_set_max_priority(unsigned sched_ctx_id, int max_prio);
402 
403 int starpu_sched_ctx_min_priority_is_set(unsigned sched_ctx_id);
404 
405 int starpu_sched_ctx_max_priority_is_set(unsigned sched_ctx_id);
406 
410 #define STARPU_MIN_PRIO (starpu_sched_get_min_priority())
411 
415 #define STARPU_MAX_PRIO (starpu_sched_get_max_priority())
416 
421 #define STARPU_DEFAULT_PRIO 0
422 
435 
439 void starpu_sched_ctx_delete_worker_collection(unsigned sched_ctx_id);
440 
445 
450 #ifdef __cplusplus
451 }
452 #endif
453 
454 #endif /* __STARPU_SCHED_CTX_H__ */
Definition: starpu_task.h:662
void starpu_sched_ctx_display_workers(unsigned sched_ctx_id, FILE *f)
void(*)(unsigned) starpu_sched_ctx_get_sched_policy_callback(unsigned sched_ctx_id)
Definition: starpu_sched_ctx.h:355
unsigned starpu_sched_ctx_contains_worker(int workerid, unsigned sched_ctx_id)
void starpu_sched_ctx_delete(unsigned sched_ctx_id)
void starpu_sched_ctx_finished_submit(unsigned sched_ctx_id)
unsigned starpu_sched_ctx_get_workers_list(unsigned sched_ctx_id, int **workerids)
unsigned starpu_sched_ctx_get_nworkers(unsigned sched_ctx_id)
int starpu_sched_ctx_set_max_priority(unsigned sched_ctx_id, int max_prio)
int starpu_sched_ctx_get_max_priority(unsigned sched_ctx_id)
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)
void starpu_sched_ctx_set_policy_data(unsigned sched_ctx_id, void *policy_data)
struct starpu_worker_collection * starpu_sched_ctx_create_worker_collection(unsigned sched_ctx_id, enum starpu_worker_collection_type type) STARPU_ATTRIBUTE_MALLOC
unsigned starpu_sched_ctx_worker_is_master_for_child_ctx(int workerid, unsigned sched_ctx_id)
void starpu_sched_ctx_remove_workers(int *workerids_ctx, unsigned nworkers_ctx, unsigned sched_ctx_id)
unsigned starpu_sched_ctx_master_get_context(int masterid)
void starpu_sched_ctx_set_context(unsigned *sched_ctx_id)
unsigned starpu_sched_ctx_create(int *workerids_ctx, int nworkers_ctx, const char *sched_ctx_name,...)
void * starpu_sched_ctx_get_policy_data(unsigned sched_ctx_id)
void starpu_sched_ctx_delete_worker_collection(unsigned sched_ctx_id)
unsigned starpu_sched_ctx_overlapping_ctxs_on_worker(int workerid)
int starpu_sched_ctx_get_min_priority(unsigned sched_ctx_id)
int starpu_sched_ctx_set_min_priority(unsigned sched_ctx_id, int min_prio)
struct starpu_worker_collection * starpu_sched_ctx_get_worker_collection(unsigned sched_ctx_id)
unsigned starpu_sched_ctx_worker_get_id(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_add_workers(int *workerids_ctx, unsigned nworkers_ctx, unsigned sched_ctx_id)
void * starpu_sched_ctx_exec_parallel_code(void *(*func)(void *), void *param, unsigned sched_ctx_id)
void starpu_sched_ctx_set_inheritor(unsigned sched_ctx_id, unsigned inheritor)
unsigned starpu_sched_ctx_get_nshared_workers(unsigned sched_ctx_id, unsigned sched_ctx_id2)
unsigned starpu_sched_ctx_get_workers_list_raw(unsigned sched_ctx_id, int **workerids)
unsigned starpu_sched_ctx_get_context(void)
void * starpu_sched_ctx_get_user_data(unsigned sched_ctx_id)
void starpu_sched_ctx_stop_task_submission(void)
Definition: starpu_scheduler.h:82
#define STARPU_ATTRIBUTE_MALLOC
Definition: starpu_util.h:129
enum starpu_worker_collection_type type
Definition: starpu_worker.h:133
starpu_worker_archtype
Definition: starpu_worker.h:66
starpu_worker_collection_type
Definition: starpu_worker.h:100
Definition: starpu_worker.h:113