StarPU Handbook
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
starpu_sched_component.h
1 /* StarPU --- Runtime system for heterogeneous multicore architectures.
2  *
3  * Copyright (C) 2013 Simon Archipoff
4  * Copyright (C) 2014 Centre National de la Recherche Scientifique
5  *
6  * StarPU is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU Lesser General Public License as published by
8  * the Free Software Foundation; either version 2.1 of the License, or (at
9  * your option) any later version.
10  *
11  * StarPU is distributed in the hope that it will be useful, but
12  * WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
14  *
15  * See the GNU Lesser General Public License in COPYING.LGPL for more details.
16  */
17 
18 #ifndef __STARPU_SCHED_COMPONENT_H__
19 #define __STARPU_SCHED_COMPONENT_H__
20 
21 #include <starpu.h>
22 
23 #ifdef __cplusplus
24 extern "C"
25 {
26 #endif
27 
28 #ifdef STARPU_HAVE_HWLOC
29 #include <hwloc.h>
30 #endif
31 
33 {
36 };
37 
38 #define STARPU_SCHED_COMPONENT_IS_HOMOGENEOUS(component) ((component)->properties & STARPU_SCHED_COMPONENT_HOMOGENEOUS)
39 #define STARPU_SCHED_COMPONENT_IS_SINGLE_MEMORY_NODE(component) ((component)->properties & STARPU_SCHED_COMPONENT_SINGLE_MEMORY_NODE)
40 
42 {
44  struct starpu_bitmap *workers;
45  struct starpu_bitmap *workers_in_ctx;
46  void *data;
47  int nchildren;
49  int nparents;
51 
52  void (*add_child)(struct starpu_sched_component *component, struct starpu_sched_component *child);
53  void (*remove_child)(struct starpu_sched_component *component, struct starpu_sched_component *child);
54  void (*add_parent)(struct starpu_sched_component *component, struct starpu_sched_component *parent);
55  void (*remove_parent)(struct starpu_sched_component *component, struct starpu_sched_component *parent);
56 
57  int (*push_task)(struct starpu_sched_component *, struct starpu_task *);
58  struct starpu_task *(*pull_task)(struct starpu_sched_component *);
59 
60  int (*can_push)(struct starpu_sched_component *component);
61  void (*can_pull)(struct starpu_sched_component *component);
62 
63  double (*estimated_load)(struct starpu_sched_component *component);
64  double (*estimated_end)(struct starpu_sched_component *component);
65 
66  void (*deinit_data)(struct starpu_sched_component *component);
67  void (*notify_change_workers)(struct starpu_sched_component *component);
69 
70 #ifdef STARPU_HAVE_HWLOC
71  hwloc_obj_t obj;
72 #else
73  void *obj;
74 #endif
75 };
76 
78 {
80  struct starpu_bitmap *workers;
81  unsigned sched_ctx_id;
83  starpu_pthread_mutex_t lock;
84 };
85 
88 struct starpu_sched_tree *starpu_sched_tree_get(unsigned sched_ctx_id);
93 void starpu_sched_tree_add_workers(unsigned sched_ctx_id, int *workerids, unsigned nworkers);
94 void starpu_sched_tree_remove_workers(unsigned sched_ctx_id, int *workerids, unsigned nworkers);
95 
100 int STARPU_WARN_UNUSED_RESULT starpu_sched_component_execute_preds(struct starpu_sched_component *component, struct starpu_task *task, double *length);
101 double starpu_sched_component_transfer_length(struct starpu_sched_component *component, struct starpu_task *task);
102 void starpu_sched_component_prefetch_on_node(struct starpu_sched_component *component, struct starpu_task *task);
103 
104 static __starpu_inline void starpu_sched_component_connect(struct starpu_sched_component *parent, struct starpu_sched_component *child)
105 {
106  parent->add_child(parent, child);
107  child->add_parent(child, parent);
108 }
109 
110 struct starpu_sched_component *starpu_sched_component_worker_get(unsigned sched_ctx, int workerid);
117 
119 {
120  unsigned ntasks_threshold;
121  double exp_len_threshold;
122 };
123 
126 
128 {
129  unsigned ntasks_threshold;
130  double exp_len_threshold;
131 };
134 
135 struct starpu_sched_component *starpu_sched_component_work_stealing_create(struct starpu_sched_tree *tree, void *arg STARPU_ATTRIBUTE_UNUSED);
138 
139 struct starpu_sched_component *starpu_sched_component_random_create(struct starpu_sched_tree *tree, void *arg STARPU_ATTRIBUTE_UNUSED);
141 
142 struct starpu_sched_component *starpu_sched_component_eager_create(struct starpu_sched_tree *tree, void *arg STARPU_ATTRIBUTE_UNUSED);
144 
145 struct starpu_sched_component *starpu_sched_component_eager_calibration_create(struct starpu_sched_tree *tree, void *arg STARPU_ATTRIBUTE_UNUSED);
147 
149 {
150  double alpha;
151  double beta;
152  double _gamma;
153  double idle_power;
154 };
157 
160 
161 struct starpu_sched_component *starpu_sched_component_best_implementation_create(struct starpu_sched_tree *tree, void *arg STARPU_ATTRIBUTE_UNUSED);
162 
164 {
165  struct starpu_sched_component *calibrator_component;
166  struct starpu_sched_component *no_perfmodel_component;
167  struct starpu_sched_component *perfmodel_component;
168 };
171 
175 void starpu_sched_component_composed_recipe_add(struct starpu_sched_component_composed_recipe *recipe, struct starpu_sched_component *(*create_component)(struct starpu_sched_tree *tree, void *arg), void *arg);
178 
179 #ifdef STARPU_HAVE_HWLOC
181 {
182  struct starpu_sched_component_composed_recipe *hwloc_machine_composed_sched_component;
183  struct starpu_sched_component_composed_recipe *hwloc_component_composed_sched_component;
184  struct starpu_sched_component_composed_recipe *hwloc_socket_composed_sched_component;
185  struct starpu_sched_component_composed_recipe *hwloc_cache_composed_sched_component;
186 
187  struct starpu_sched_component_composed_recipe *(*worker_composed_sched_component)(enum starpu_worker_archtype archtype);
188  int mix_heterogeneous_workers;
189 };
190 
192 #endif /* STARPU_HAVE_HWLOC */
193 
194 #ifdef __cplusplus
195 }
196 #endif
197 
198 #endif /* __STARPU_SCHED_COMPONENT_H__ */
int starpu_sched_component_is_mct(struct starpu_sched_component *component)
int starpu_sched_component_is_prio(struct starpu_sched_component *component)
int(* push_task)(struct starpu_sched_component *, struct starpu_task *)
Definition: starpu_sched_component.h:57
struct starpu_sched_component ** children
Definition: starpu_sched_component.h:48
void starpu_sched_component_composed_recipe_add(struct starpu_sched_component_composed_recipe *recipe, struct starpu_sched_component *(*create_component)(struct starpu_sched_tree *tree, void *arg), void *arg)
struct starpu_sched_component ** parents
Definition: starpu_sched_component.h:50
int starpu_sched_component_is_perfmodel_select(struct starpu_sched_component *component)
Definition: starpu_sched_component.h:148
void starpu_sched_tree_remove_workers(unsigned sched_ctx_id, int *workerids, unsigned nworkers)
int starpu_sched_tree_push_task(struct starpu_task *task)
void(* deinit_data)(struct starpu_sched_component *component)
Definition: starpu_sched_component.h:66
int starpu_sched_component_is_simple_worker(struct starpu_sched_component *component)
void starpu_sched_tree_update_workers(struct starpu_sched_tree *t)
void starpu_sched_component_destroy_rec(struct starpu_sched_component *component)
struct starpu_bitmap * workers_in_ctx
Definition: starpu_sched_component.h:45
void starpu_sched_tree_destroy(struct starpu_sched_tree *tree)
void(* remove_parent)(struct starpu_sched_component *component, struct starpu_sched_component *parent)
Definition: starpu_sched_component.h:55
struct starpu_sched_component * starpu_sched_component_perfmodel_select_create(struct starpu_sched_tree *tree, struct starpu_sched_component_perfmodel_select_data *perfmodel_select_data)
void(* add_child)(struct starpu_sched_component *component, struct starpu_sched_component *child)
Definition: starpu_sched_component.h:52
starpu_worker_archtype
Definition: starpu_worker.h:30
double(* estimated_load)(struct starpu_sched_component *component)
Definition: starpu_sched_component.h:63
double(* estimated_end)(struct starpu_sched_component *component)
Definition: starpu_sched_component.h:64
void(* add_parent)(struct starpu_sched_component *component, struct starpu_sched_component *parent)
Definition: starpu_sched_component.h:54
struct starpu_sched_component * worker_components[STARPU_NMAXWORKERS]
Definition: starpu_sched_component.h:82
void(* remove_child)(struct starpu_sched_component *component, struct starpu_sched_component *child)
Definition: starpu_sched_component.h:53
int nparents
Definition: starpu_sched_component.h:49
Definition: starpu_sched_component.h:34
struct starpu_sched_component * starpu_sched_component_composed_component_create(struct starpu_sched_tree *tree, struct starpu_sched_component_composed_recipe *recipe)
void starpu_sched_component_destroy(struct starpu_sched_component *component)
Definition: starpu_sched_component.h:77
struct starpu_sched_component_composed_recipe * starpu_sched_component_composed_recipe_create(void)
int starpu_sched_component_is_fifo(struct starpu_sched_component *component)
int(* can_push)(struct starpu_sched_component *component)
Definition: starpu_sched_component.h:60
int starpu_sched_component_is_heft(struct starpu_sched_component *component)
Definition: starpu_task.h:123
int nchildren
Definition: starpu_sched_component.h:47
int starpu_sched_component_is_eager(struct starpu_sched_component *)
struct starpu_sched_tree * starpu_sched_tree_create(unsigned sched_ctx_id)
struct starpu_bitmap * workers
Definition: starpu_sched_component.h:80
struct starpu_sched_tree * starpu_sched_component_make_scheduler(unsigned sched_ctx_id, struct starpu_sched_component_specs s)
Definition: starpu_sched_component.h:163
void starpu_sched_tree_update_workers_in_ctx(struct starpu_sched_tree *t)
void starpu_sched_component_composed_recipe_destroy(struct starpu_sched_component_composed_recipe *)
struct starpu_sched_component_composed_recipe * starpu_sched_component_composed_recipe_create_singleton(struct starpu_sched_component *(*create_component)(struct starpu_sched_tree *tree, void *arg), void *arg)
hwloc_obj_t obj
Definition: starpu_sched_component.h:71
struct starpu_sched_component * starpu_sched_component_create(struct starpu_sched_tree *tree)
Definition: starpu_sched_component.h:180
#define STARPU_NMAXWORKERS
Definition: starpu_config.h:90
void(* notify_change_workers)(struct starpu_sched_component *component)
Definition: starpu_sched_component.h:67
void starpu_sched_component_worker_pre_exec_hook(struct starpu_task *task)
struct starpu_task * starpu_sched_tree_pop_task()
struct starpu_sched_component * starpu_sched_component_mct_create(struct starpu_sched_tree *tree, struct starpu_sched_component_mct_data *mct_data)
int STARPU_WARN_UNUSED_RESULT starpu_sched_component_execute_preds(struct starpu_sched_component *component, struct starpu_task *task, double *length)
double starpu_sched_component_transfer_length(struct starpu_sched_component *component, struct starpu_task *task)
starpu_sched_component_properties
Definition: starpu_sched_component.h:32
void * data
Definition: starpu_sched_component.h:46
int starpu_sched_component_is_work_stealing(struct starpu_sched_component *component)
struct starpu_sched_component * starpu_sched_component_worker_get(unsigned sched_ctx, int workerid)
int properties
Definition: starpu_sched_component.h:68
int starpu_sched_component_is_eager_calibration(struct starpu_sched_component *)
void starpu_sched_component_worker_post_exec_hook(struct starpu_task *task)
#define STARPU_WARN_UNUSED_RESULT
Definition: starpu_util.h:79
struct starpu_sched_tree * tree
Definition: starpu_sched_component.h:43
int starpu_sched_component_worker_get_workerid(struct starpu_sched_component *worker_component)
int starpu_sched_tree_work_stealing_push_task(struct starpu_task *task)
struct starpu_bitmap * workers
Definition: starpu_sched_component.h:44
Definition: starpu_sched_component.h:118
starpu_pthread_mutex_t lock
Definition: starpu_sched_component.h:83
struct starpu_sched_component * starpu_sched_component_fifo_create(struct starpu_sched_tree *tree, struct starpu_sched_component_fifo_data *fifo_data)
struct starpu_sched_component * root
Definition: starpu_sched_component.h:79
#define STARPU_ATTRIBUTE_UNUSED
Definition: starpu_util.h:52
void starpu_sched_tree_add_workers(unsigned sched_ctx_id, int *workerids, unsigned nworkers)
Definition: starpu_sched_component.h:35
unsigned sched_ctx_id
Definition: starpu_sched_component.h:81
int starpu_sched_component_is_worker(struct starpu_sched_component *component)
Definition: starpu_sched_component.h:127
Definition: starpu_sched_component.h:41
struct starpu_sched_component * starpu_sched_component_prio_create(struct starpu_sched_tree *tree, struct starpu_sched_component_prio_data *prio_data)
int starpu_sched_component_is_random(struct starpu_sched_component *)
struct starpu_sched_component * starpu_sched_component_heft_create(struct starpu_sched_tree *tree, struct starpu_sched_component_mct_data *mct_data)
void(* can_pull)(struct starpu_sched_component *component)
Definition: starpu_sched_component.h:61
int starpu_sched_component_is_combined_worker(struct starpu_sched_component *component)
int starpu_sched_component_can_execute_task(struct starpu_sched_component *component, struct starpu_task *task)