StarPU Handbook
starpu_scheduler.h
Go to the documentation of this file.
1 /* StarPU --- Runtime system for heterogeneous multicore architectures.
2  *
3  * Copyright (C) 2010-2015 Université de Bordeaux
4  * Copyright (C) 2011 Télécom-SudParis
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_SCHEDULER_H__
19 #define __STARPU_SCHEDULER_H__
20 
21 #include <starpu.h>
22 
23 #ifdef __cplusplus
24 extern "C"
25 {
26 #endif
27 
28 struct starpu_task;
29 
31 {
32  void (*init_sched)(unsigned sched_ctx_id);
33  void (*deinit_sched)(unsigned sched_ctx_id);
34 
35  int (*push_task)(struct starpu_task *);
36  double (*simulate_push_task)(struct starpu_task *);
37  void (*push_task_notify)(struct starpu_task *, int workerid, int perf_workerid, unsigned sched_ctx_id);
38  struct starpu_task *(*pop_task)(unsigned sched_ctx_id);
39  struct starpu_task *(*pop_every_task)(unsigned sched_ctx_id);
40 
41  void (*pre_exec_hook)(struct starpu_task *);
42  void (*post_exec_hook)(struct starpu_task *);
43 
44  void (*add_workers)(unsigned sched_ctx_id, int *workerids, unsigned nworkers);
45  void (*remove_workers)(unsigned sched_ctx_id, int *workerids, unsigned nworkers);
46 
47  const char *policy_name;
48  const char *policy_description;
49 };
50 
52 
53 void starpu_worker_get_sched_condition(int workerid, starpu_pthread_mutex_t **sched_mutex, starpu_pthread_cond_t **sched_cond);
54 
55 /* This function must be called to wake up a worker that is sleeping on the cond.
56  * It returns 0 whenever the worker is not in a sleeping state */
57 int starpu_wake_worker(int workerid);
58 int starpu_wakeup_worker(int workerid, starpu_pthread_cond_t *cond, starpu_pthread_mutex_t *mutex);
59 
60 int starpu_worker_can_execute_task(unsigned workerid, struct starpu_task *task, unsigned nimpl);
61 int starpu_worker_can_execute_task_impl(unsigned workerid, struct starpu_task *task, unsigned *impl_mask);
62 int starpu_worker_can_execute_task_first_impl(unsigned workerid, struct starpu_task *task, unsigned *nimpl);
63 
64 int starpu_push_local_task(int workerid, struct starpu_task *task, int back);
65 
66 int starpu_push_task_end(struct starpu_task *task);
67 
68 int starpu_combined_worker_assign_workerid(int nworkers, int workerid_array[]);
69 int starpu_combined_worker_get_description(int workerid, int *worker_size, int **combined_workerid);
70 int starpu_combined_worker_can_execute_task(unsigned workerid, struct starpu_task *task, unsigned nimpl);
71 
72 int starpu_get_prefetch_flag(void);
73 int starpu_prefetch_task_input_on_node(struct starpu_task *task, unsigned node);
74 int starpu_idle_prefetch_task_input_on_node(struct starpu_task *task, unsigned node);
75 
76 uint32_t starpu_task_footprint(struct starpu_perfmodel *model, struct starpu_task *task, struct starpu_perfmodel_arch *arch, unsigned nimpl);
77 uint32_t starpu_task_data_footprint(struct starpu_task *task);
78 double starpu_task_expected_length(struct starpu_task *task, struct starpu_perfmodel_arch *arch, unsigned nimpl);
80 double starpu_task_expected_data_transfer_time(unsigned memory_node, struct starpu_task *task);
81 double starpu_data_expected_transfer_time(starpu_data_handle_t handle, unsigned memory_node, enum starpu_data_access_mode mode);
82 double starpu_task_expected_power(struct starpu_task *task, struct starpu_perfmodel_arch *arch, unsigned nimpl);
83 double starpu_task_expected_conversion_time(struct starpu_task *task, struct starpu_perfmodel_arch *arch, unsigned nimpl);
84 
85 double starpu_task_bundle_expected_length(starpu_task_bundle_t bundle, struct starpu_perfmodel_arch *arch, unsigned nimpl);
86 double starpu_task_bundle_expected_data_transfer_time(starpu_task_bundle_t bundle, unsigned memory_node);
87 double starpu_task_bundle_expected_power(starpu_task_bundle_t bundle, struct starpu_perfmodel_arch *arch, unsigned nimpl);
88 
89 void starpu_sched_ctx_worker_shares_tasks_lists(int workerid, int sched_ctx_id);
90 #ifdef __cplusplus
91 }
92 #endif
93 
94 #endif /* __STARPU_SCHEDULER_H__ */
double starpu_task_expected_data_transfer_time(unsigned memory_node, struct starpu_task *task)
double starpu_task_bundle_expected_data_transfer_time(starpu_task_bundle_t bundle, unsigned memory_node)
uint32_t starpu_task_data_footprint(struct starpu_task *task)
int starpu_combined_worker_get_description(int workerid, int *worker_size, int **combined_workerid)
double starpu_task_bundle_expected_power(starpu_task_bundle_t bundle, struct starpu_perfmodel_arch *arch, unsigned nimpl)
int starpu_push_local_task(int workerid, struct starpu_task *task, int back)
void starpu_worker_get_sched_condition(int workerid, starpu_pthread_mutex_t **sched_mutex, starpu_pthread_cond_t **sched_cond)
int starpu_combined_worker_can_execute_task(unsigned workerid, struct starpu_task *task, unsigned nimpl)
const char * policy_description
Definition: starpu_scheduler.h:48
unsigned workerid
Definition: starpu_task.h:170
int starpu_get_prefetch_flag(void)
double starpu_worker_get_relative_speedup(struct starpu_perfmodel_arch *perf_arch)
void(* deinit_sched)(unsigned sched_ctx_id)
Definition: starpu_scheduler.h:33
void(* post_exec_hook)(struct starpu_task *)
Definition: starpu_scheduler.h:42
double starpu_task_expected_length(struct starpu_task *task, struct starpu_perfmodel_arch *arch, unsigned nimpl)
double starpu_task_bundle_expected_length(starpu_task_bundle_t bundle, struct starpu_perfmodel_arch *arch, unsigned nimpl)
int(* push_task)(struct starpu_task *)
Definition: starpu_scheduler.h:35
int starpu_worker_can_execute_task_first_impl(unsigned workerid, struct starpu_task *task, unsigned *nimpl)
double starpu_task_expected_power(struct starpu_task *task, struct starpu_perfmodel_arch *arch, unsigned nimpl)
struct _starpu_task_bundle * starpu_task_bundle_t
Definition: starpu_task_bundle.h:29
void(* remove_workers)(unsigned sched_ctx_id, int *workerids, unsigned nworkers)
Definition: starpu_scheduler.h:45
Definition: starpu_task.h:123
void(* push_task_notify)(struct starpu_task *, int workerid, int perf_workerid, unsigned sched_ctx_id)
Definition: starpu_scheduler.h:37
Definition: starpu_perfmodel.h:45
const char * policy_name
Definition: starpu_scheduler.h:47
double starpu_data_expected_transfer_time(starpu_data_handle_t handle, unsigned memory_node, enum starpu_data_access_mode mode)
int starpu_worker_can_execute_task(unsigned workerid, struct starpu_task *task, unsigned nimpl)
double starpu_task_expected_conversion_time(struct starpu_task *task, struct starpu_perfmodel_arch *arch, unsigned nimpl)
void starpu_sched_ctx_worker_shares_tasks_lists(int workerid, int sched_ctx_id)
void(* init_sched)(unsigned sched_ctx_id)
Definition: starpu_scheduler.h:32
Definition: starpu_perfmodel.h:125
int starpu_idle_prefetch_task_input_on_node(struct starpu_task *task, unsigned node)
struct starpu_sched_policy ** starpu_sched_get_predefined_policies()
Definition: starpu_scheduler.h:30
int starpu_prefetch_task_input_on_node(struct starpu_task *task, unsigned node)
int starpu_combined_worker_assign_workerid(int nworkers, int workerid_array[])
starpu_data_access_mode
Definition: starpu_data.h:31
struct _starpu_data_state * starpu_data_handle_t
Definition: starpu_data.h:29
void(* pre_exec_hook)(struct starpu_task *)
Definition: starpu_scheduler.h:41
int starpu_push_task_end(struct starpu_task *task)
uint32_t starpu_task_footprint(struct starpu_perfmodel *model, struct starpu_task *task, struct starpu_perfmodel_arch *arch, unsigned nimpl)
void(* add_workers)(unsigned sched_ctx_id, int *workerids, unsigned nworkers)
Definition: starpu_scheduler.h:44
int starpu_worker_can_execute_task_impl(unsigned workerid, struct starpu_task *task, unsigned *impl_mask)