StarPU Handbook
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
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 INRIA
4  *
5  * StarPU is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU Lesser General Public License as published by
7  * the Free Software Foundation; either version 2.1 of the License, or (at
8  * your option) any later version.
9  *
10  * StarPU is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
13  *
14  * See the GNU Lesser General Public License in COPYING.LGPL for more details.
15  */
16 
17 #ifndef __STARPU_SCHED_CTX_H__
18 #define __STARPU_SCHED_CTX_H__
19 
20 #include <starpu.h>
21 
22 #ifdef __cplusplus
23 extern "C"
24 {
25 #endif
26 
27 #define STARPU_SCHED_CTX_POLICY_NAME (1<<16)
28 #define STARPU_SCHED_CTX_POLICY_STRUCT (2<<16)
29 #define STARPU_SCHED_CTX_POLICY_MIN_PRIO (3<<16)
30 #define STARPU_SCHED_CTX_POLICY_MAX_PRIO (4<<16)
31 #define STARPU_SCHED_CTX_HIERARCHY_LEVEL (5<<16)
32 #define STARPU_SCHED_CTX_NESTED (6<<16)
33 #define STARPU_SCHED_CTX_AWAKE_WORKERS (7<<16)
34 
35 unsigned starpu_sched_ctx_create(int *workerids_ctx, int nworkers_ctx, const char *sched_ctx_name, ...);
36 
37 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);
38 
39 void starpu_sched_ctx_register_close_callback(unsigned sched_ctx_id, void (*close_callback)(unsigned sched_ctx_id, void* args), void *args);
40 
41 void starpu_sched_ctx_add_workers(int *workerids_ctx, int nworkers_ctx, unsigned sched_ctx_id);
42 
43 void starpu_sched_ctx_remove_workers(int *workerids_ctx, int nworkers_ctx, unsigned sched_ctx_id);
44 
45 void starpu_sched_ctx_display_workers(unsigned sched_ctx_id, FILE *f);
46 
47 void starpu_sched_ctx_delete(unsigned sched_ctx_id);
48 
49 void starpu_sched_ctx_set_inheritor(unsigned sched_ctx_id, unsigned inheritor);
50 
51 unsigned starpu_sched_ctx_get_inheritor(unsigned sched_ctx_id);
52 
53 unsigned starpu_sched_ctx_get_hierarchy_level(unsigned sched_ctx_id);
54 
55 void starpu_sched_ctx_set_context(unsigned *sched_ctx_id);
56 
57 unsigned starpu_sched_ctx_get_context(void);
58 
60 
61 void starpu_sched_ctx_finished_submit(unsigned sched_ctx_id);
62 
63 unsigned starpu_sched_ctx_get_workers_list(unsigned sched_ctx_id, int **workerids);
64 
65 unsigned starpu_sched_ctx_get_nworkers(unsigned sched_ctx_id);
66 
67 unsigned starpu_sched_ctx_get_nshared_workers(unsigned sched_ctx_id, unsigned sched_ctx_id2);
68 
69 unsigned starpu_sched_ctx_contains_worker(int workerid, unsigned sched_ctx_id);
70 
71 unsigned starpu_sched_ctx_contains_type_of_worker(enum starpu_worker_archtype arch, unsigned sched_ctx_id);
72 
73 unsigned starpu_sched_ctx_worker_get_id(unsigned sched_ctx_id);
74 
75 unsigned starpu_sched_ctx_overlapping_ctxs_on_worker(int workerid);
76 
78 
80 
81 int starpu_sched_set_min_priority(int min_prio);
82 
83 int starpu_sched_set_max_priority(int max_prio);
84 
85 int starpu_sched_ctx_get_min_priority(unsigned sched_ctx_id);
86 
87 int starpu_sched_ctx_get_max_priority(unsigned sched_ctx_id);
88 
89 int starpu_sched_ctx_set_min_priority(unsigned sched_ctx_id, int min_prio);
90 
91 int starpu_sched_ctx_set_max_priority(unsigned sched_ctx_id, int max_prio);
92 
93 int starpu_sched_ctx_min_priority_is_set(unsigned sched_ctx_id);
94 
95 int starpu_sched_ctx_max_priority_is_set(unsigned sched_ctx_id);
96 
97 #define STARPU_MIN_PRIO (starpu_sched_get_min_priority())
98 #define STARPU_MAX_PRIO (starpu_sched_get_max_priority())
99 
100 #define STARPU_DEFAULT_PRIO 0
101 
103 
104 void starpu_sched_ctx_delete_worker_collection(unsigned sched_ctx_id);
105 
107 
108 void starpu_sched_ctx_set_policy_data(unsigned sched_ctx_id, void *policy_data);
109 
110 void *starpu_sched_ctx_get_policy_data(unsigned sched_ctx_id);
111 
112 void *starpu_sched_ctx_exec_parallel_code(void* (*func)(void*), void *param, unsigned sched_ctx_id);
113 
114 int starpu_sched_ctx_get_nready_tasks(unsigned sched_ctx_id);
115 
116 double starpu_sched_ctx_get_nready_flops(unsigned sched_ctx_id);
117 
118 void starpu_sched_ctx_set_priority(int *workers, int nworkers, unsigned sched_ctx_id, unsigned priority);
119 
120 void starpu_sched_ctx_set_priority_on_level(int* workers_to_add, unsigned nworkers_to_add, unsigned sched_ctx, unsigned priority);
121 
122 unsigned starpu_sched_ctx_get_priority(int worker, unsigned sched_ctx_id);
123 
124 void starpu_sched_ctx_get_available_cpuids(unsigned sched_ctx_id, int **cpuids, int *ncpuids);
125 
126 void starpu_sched_ctx_bind_current_thread_to_cpuid(unsigned cpuid);
127 
128 int starpu_sched_ctx_book_workers_for_task(unsigned sched_ctx_id, int *workerids, int nworkers);
129 
130 void starpu_sched_ctx_unbook_workers_for_task(unsigned sched_ctx_id, int master);
131 
132 /* return the first context (child of sched_ctx_id) where the workerid is master */
133 unsigned starpu_sched_ctx_worker_is_master_for_child_ctx(int workerid, unsigned sched_ctx_id);
134 
135 void starpu_sched_ctx_revert_task_counters(unsigned sched_ctx_id, double flops);
136 
137 void starpu_sched_ctx_move_task_to_ctx(struct starpu_task *task, unsigned sched_ctx);
138 
139 int starpu_sched_ctx_get_worker_rank(unsigned sched_ctx_id);
140 
141 #ifdef STARPU_USE_SC_HYPERVISOR
142 void starpu_sched_ctx_call_pushed_task_cb(int workerid, unsigned sched_ctx_id);
143 #endif /* STARPU_USE_SC_HYPERVISOR */
144 
145 #ifdef __cplusplus
146 }
147 #endif
148 
149 #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)
void starpu_sched_ctx_delete(unsigned sched_ctx_id)
Definition: starpu_worker.h:54
void starpu_sched_ctx_remove_workers(int *workerids_ctx, int nworkers_ctx, unsigned sched_ctx_id)
void starpu_sched_ctx_display_workers(unsigned sched_ctx_id, FILE *f)
struct starpu_worker_collection * starpu_sched_ctx_get_worker_collection(unsigned sched_ctx_id)
void starpu_sched_ctx_stop_task_submission(void)
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:30
int starpu_sched_ctx_max_priority_is_set(unsigned sched_ctx_id)
void * starpu_sched_ctx_exec_parallel_code(void *(*func)(void *), void *param, unsigned sched_ctx_id)
unsigned starpu_sched_ctx_get_nworkers(unsigned sched_ctx_id)
void starpu_sched_ctx_add_workers(int *workerids_ctx, int nworkers_ctx, unsigned sched_ctx_id)
unsigned starpu_sched_ctx_get_context(void)
unsigned starpu_sched_ctx_contains_worker(int workerid, unsigned sched_ctx_id)
void starpu_sched_ctx_finished_submit(unsigned sched_ctx_id)
struct starpu_worker_collection * starpu_sched_ctx_create_worker_collection(unsigned sched_ctx_id, enum starpu_worker_collection_type type)
int starpu_sched_ctx_get_nready_tasks(unsigned sched_ctx_id)
Definition: starpu_task.h:123
int starpu_sched_ctx_get_max_priority(unsigned sched_ctx_id)
int starpu_sched_ctx_min_priority_is_set(unsigned sched_ctx_id)
unsigned starpu_sched_ctx_get_workers_list(unsigned sched_ctx_id, int **workerids)
void starpu_sched_ctx_call_pushed_task_cb(int workerid, unsigned sched_ctx_id)
unsigned starpu_sched_ctx_overlapping_ctxs_on_worker(int workerid)
void * starpu_sched_ctx_get_policy_data(unsigned sched_ctx_id)
int starpu_sched_set_max_priority(int max_prio)
int starpu_sched_ctx_set_max_priority(unsigned sched_ctx_id, int max_prio)
unsigned nworkers
Definition: starpu_worker.h:57
int starpu_sched_get_max_priority(void)
int starpu_sched_get_min_priority(void)
void * workerids
Definition: starpu_worker.h:56
unsigned starpu_sched_ctx_create(int *workerids_ctx, int nworkers_ctx, const char *sched_ctx_name,...)
double starpu_sched_ctx_get_nready_flops(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)
enum starpu_worker_collection_type type
Definition: starpu_worker.h:62
void starpu_sched_ctx_delete_worker_collection(unsigned sched_ctx_id)
starpu_worker_collection_type
Definition: starpu_worker.h:48
unsigned sched_ctx_id
Definition: starpu_sched_component.h:81
int starpu_sched_set_min_priority(int min_prio)
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)