StarPU Handbook
sc_hypervisor.h
Go to the documentation of this file.
1 /* StarPU --- Runtime system for heterogeneous multicore architectures.
2  *
3  * Copyright (C) 2011-2015 Inria
4  * Copyright (C) 2012,2013,2017,2019 CNRS
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 SC_HYPERVISOR_H
19 #define SC_HYPERVISOR_H
20 
21 #include <starpu.h>
23 #include <sc_hypervisor_config.h>
25 #include <math.h>
26 
27 #ifdef __cplusplus
28 extern "C"
29 {
30 #endif
31 
63 extern starpu_pthread_mutex_t act_hypervisor_mutex;
64 
70 {
76  const char* name;
77 
81  unsigned custom;
82 
87  void (*size_ctxs)(unsigned *sched_ctxs, int nsched_ctxs , int *workers, int nworkers);
88 
92  void (*resize_ctxs)(unsigned *sched_ctxs, int nsched_ctxs , int *workers, int nworkers);
93 
98  void (*handle_idle_cycle)(unsigned sched_ctx, int worker);
99 
104  void (*handle_pushed_task)(unsigned sched_ctx, int worker);
105 
110  void (*handle_poped_task)(unsigned sched_ctx, int worker,struct starpu_task *task, uint32_t footprint);
111 
116  void (*handle_idle_end)(unsigned sched_ctx, int worker);
117 
122  void (*handle_post_exec_hook)(unsigned sched_ctx, int task_tag);
123 
128  void (*handle_submitted_job)(struct starpu_codelet *cl, unsigned sched_ctx, uint32_t footprint, size_t data_size);
129 
134  void (*end_ctx)(unsigned sched_ctx);
135 
140  void (*start_ctx)(unsigned sched_ctx);
141 
145  void (*init_worker)(int workerid, unsigned sched_ctx);
146 };
147 
151 void* sc_hypervisor_init(struct sc_hypervisor_policy *policy);
152 
160 void sc_hypervisor_shutdown(void);
161 
166 void sc_hypervisor_register_ctx(unsigned sched_ctx, double total_flops);
167 
172 void sc_hypervisor_unregister_ctx(unsigned sched_ctx);
173 
178 void sc_hypervisor_post_resize_request(unsigned sched_ctx, int task_tag);
179 
185 void sc_hypervisor_resize_ctxs(unsigned *sched_ctxs, int nsched_ctxs , int *workers, int nworkers);
186 
190 void sc_hypervisor_stop_resize(unsigned sched_ctx);
191 
195 void sc_hypervisor_start_resize(unsigned sched_ctx);
196 
200 const char *sc_hypervisor_get_policy();
201 
205 void sc_hypervisor_add_workers_to_sched_ctx(int* workers_to_add, unsigned nworkers_to_add, unsigned sched_ctx);
206 
210 void sc_hypervisor_remove_workers_from_sched_ctx(int* workers_to_remove, unsigned nworkers_to_remove, unsigned sched_ctx, unsigned now);
211 
215 void sc_hypervisor_move_workers(unsigned sender_sched_ctx, unsigned receiver_sched_ctx, int *workers_to_move, unsigned nworkers_to_move, unsigned now);
216 
221 void sc_hypervisor_size_ctxs(unsigned *sched_ctxs, int nsched_ctxs, int *workers, int nworkers);
222 
226 unsigned sc_hypervisor_get_size_req(unsigned **sched_ctxs, int* nsched_ctxs, int **workers, int *nworkers);
227 
231 void sc_hypervisor_save_size_req(unsigned *sched_ctxs, int nsched_ctxs, int *workers, int nworkers);
232 
236 void sc_hypervisor_free_size_req(void);
237 
241 unsigned sc_hypervisor_can_resize(unsigned sched_ctx);
242 
247 void sc_hypervisor_set_type_of_task(struct starpu_codelet *cl, unsigned sched_ctx, uint32_t footprint, size_t data_size);
248 
253 void sc_hypervisor_update_diff_total_flops(unsigned sched_ctx, double diff_total_flops);
254 
259 void sc_hypervisor_update_diff_elapsed_flops(unsigned sched_ctx, double diff_task_flops);
260 
264 void sc_hypervisor_update_resize_interval(unsigned *sched_ctxs, int nsched_ctxs, int max_nworkers);
265 
270 void sc_hypervisor_get_ctxs_on_level(unsigned **sched_ctxs, int *nsched_ctxs, unsigned hierarchy_level, unsigned father_sched_ctx_id);
271 
276 
280 void sc_hypervisor_get_leaves(unsigned *sched_ctxs, int nsched_ctxs, unsigned *leaves, int *nleaves);
281 
286 
287 void sc_hypervisor_print_overhead();
288 
289 void sc_hypervisor_init_worker(int workerid, unsigned sched_ctx);
290 
293 #ifdef __cplusplus
294 }
295 #endif
296 
297 #endif
sc_hypervisor_get_size_req
unsigned sc_hypervisor_get_size_req(unsigned **sched_ctxs, int *nsched_ctxs, int **workers, int *nworkers)
sc_hypervisor_post_resize_request
void sc_hypervisor_post_resize_request(unsigned sched_ctx, int task_tag)
sc_hypervisor_unregister_ctx
void sc_hypervisor_unregister_ctx(unsigned sched_ctx)
starpu_task::sched_ctx
unsigned sched_ctx
Definition: starpu_task.h:1061
sc_hypervisor_policy::handle_idle_cycle
void(* handle_idle_cycle)(unsigned sched_ctx, int worker)
Definition: sc_hypervisor.h:98
sc_hypervisor_stop_resize
void sc_hypervisor_stop_resize(unsigned sched_ctx)
sc_hypervisor_policy::custom
unsigned custom
Definition: sc_hypervisor.h:81
sc_hypervisor_set_type_of_task
void sc_hypervisor_set_type_of_task(struct starpu_codelet *cl, unsigned sched_ctx, uint32_t footprint, size_t data_size)
sc_hypervisor_shutdown
void sc_hypervisor_shutdown(void)
sc_hypervisor_policy::handle_post_exec_hook
void(* handle_post_exec_hook)(unsigned sched_ctx, int task_tag)
Definition: sc_hypervisor.h:122
sc_hypervisor_size_ctxs
void sc_hypervisor_size_ctxs(unsigned *sched_ctxs, int nsched_ctxs, int *workers, int nworkers)
sc_hypervisor_get_ctxs_on_level
void sc_hypervisor_get_ctxs_on_level(unsigned **sched_ctxs, int *nsched_ctxs, unsigned hierarchy_level, unsigned father_sched_ctx_id)
starpu_codelet
Definition: starpu_task.h:250
sc_hypervisor_update_diff_total_flops
void sc_hypervisor_update_diff_total_flops(unsigned sched_ctx, double diff_total_flops)
sc_hypervisor_get_nready_flops_of_all_sons_of_sched_ctx
double sc_hypervisor_get_nready_flops_of_all_sons_of_sched_ctx(unsigned sched_ctx)
sc_hypervisor_policy::handle_pushed_task
void(* handle_pushed_task)(unsigned sched_ctx, int worker)
Definition: sc_hypervisor.h:104
act_hypervisor_mutex
starpu_pthread_mutex_t act_hypervisor_mutex
sc_hypervisor_policy::size_ctxs
void(* size_ctxs)(unsigned *sched_ctxs, int nsched_ctxs, int *workers, int nworkers)
Definition: sc_hypervisor.h:87
sc_hypervisor_policy
Definition: sc_hypervisor.h:69
sc_hypervisor_move_workers
void sc_hypervisor_move_workers(unsigned sender_sched_ctx, unsigned receiver_sched_ctx, int *workers_to_move, unsigned nworkers_to_move, unsigned now)
sc_hypervisor_policy::resize_ctxs
void(* resize_ctxs)(unsigned *sched_ctxs, int nsched_ctxs, int *workers, int nworkers)
Definition: sc_hypervisor.h:92
starpu.h
sc_hypervisor_policy::handle_poped_task
void(* handle_poped_task)(unsigned sched_ctx, int worker, struct starpu_task *task, uint32_t footprint)
Definition: sc_hypervisor.h:110
starpu_task
Definition: starpu_task.h:548
sc_hypervisor_policy::handle_idle_end
void(* handle_idle_end)(unsigned sched_ctx, int worker)
Definition: sc_hypervisor.h:116
sc_hypervisor_resize_ctxs
void sc_hypervisor_resize_ctxs(unsigned *sched_ctxs, int nsched_ctxs, int *workers, int nworkers)
sc_hypervisor_remove_workers_from_sched_ctx
void sc_hypervisor_remove_workers_from_sched_ctx(int *workers_to_remove, unsigned nworkers_to_remove, unsigned sched_ctx, unsigned now)
sc_hypervisor_policy::name
const char * name
Definition: sc_hypervisor.h:76
sc_hypervisor_config.h
sc_hypervisor_save_size_req
void sc_hypervisor_save_size_req(unsigned *sched_ctxs, int nsched_ctxs, int *workers, int nworkers)
sc_hypervisor_policy::handle_submitted_job
void(* handle_submitted_job)(struct starpu_codelet *cl, unsigned sched_ctx, uint32_t footprint, size_t data_size)
Definition: sc_hypervisor.h:128
sc_hypervisor_policy::start_ctx
void(* start_ctx)(unsigned sched_ctx)
Definition: sc_hypervisor.h:140
sc_hypervisor_add_workers_to_sched_ctx
void sc_hypervisor_add_workers_to_sched_ctx(int *workers_to_add, unsigned nworkers_to_add, unsigned sched_ctx)
sc_hypervisor_get_policy
const char * sc_hypervisor_get_policy()
sc_hypervisor_policy::init_worker
void(* init_worker)(int workerid, unsigned sched_ctx)
Definition: sc_hypervisor.h:145
sc_hypervisor_get_nhierarchy_levels
unsigned sc_hypervisor_get_nhierarchy_levels(void)
sc_hypervisor_update_resize_interval
void sc_hypervisor_update_resize_interval(unsigned *sched_ctxs, int nsched_ctxs, int max_nworkers)
sc_hypervisor_init
void * sc_hypervisor_init(struct sc_hypervisor_policy *policy)
sc_hypervisor_update_diff_elapsed_flops
void sc_hypervisor_update_diff_elapsed_flops(unsigned sched_ctx, double diff_task_flops)
sc_hypervisor_register_ctx
void sc_hypervisor_register_ctx(unsigned sched_ctx, double total_flops)
sc_hypervisor_start_resize
void sc_hypervisor_start_resize(unsigned sched_ctx)
sc_hypervisor_policy::end_ctx
void(* end_ctx)(unsigned sched_ctx)
Definition: sc_hypervisor.h:134
sc_hypervisor_get_leaves
void sc_hypervisor_get_leaves(unsigned *sched_ctxs, int nsched_ctxs, unsigned *leaves, int *nleaves)
sc_hypervisor_free_size_req
void sc_hypervisor_free_size_req(void)
starpu_sched_ctx_hypervisor.h
sc_hypervisor_monitoring.h
sc_hypervisor_can_resize
unsigned sc_hypervisor_can_resize(unsigned sched_ctx)