StarPU Internal Handbook
sched_policy.h
Go to the documentation of this file.
1 /* StarPU --- Runtime system for heterogeneous multicore architectures.
2  *
3  * Copyright (C) 2008-2023 Université de Bordeaux, CNRS (LaBRI UMR 5800), Inria
4  * Copyright (C) 2013 Simon Archipoff
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 __SCHED_POLICY_H__
19 #define __SCHED_POLICY_H__
20 
23 #include <starpu.h>
24 #include <signal.h>
25 #include <core/workers.h>
26 #include <core/sched_ctx.h>
27 #include <starpu_scheduler.h>
28 
29 #include <core/simgrid.h>
30 
31 #pragma GCC visibility push(hidden)
32 
33 #define _STARPU_SCHED_BEGIN \
34  _STARPU_TRACE_WORKER_SCHEDULING_PUSH; \
35  _SIMGRID_TIMER_BEGIN(_starpu_simgrid_sched_cost())
36 #define _STARPU_SCHED_END \
37  _SIMGRID_TIMER_END; \
38  _STARPU_TRACE_WORKER_SCHEDULING_POP
39 
40 void _starpu_sched_init(void);
41 
42 struct starpu_machine_config;
43 struct starpu_sched_policy *_starpu_get_sched_policy(struct _starpu_sched_ctx *sched_ctx);
44 
45 void _starpu_init_sched_policy(struct _starpu_machine_config *config,
46  struct _starpu_sched_ctx *sched_ctx, struct starpu_sched_policy *policy);
47 
48 void _starpu_deinit_sched_policy(struct _starpu_sched_ctx *sched_ctx);
49 
50 struct starpu_sched_policy *_starpu_select_sched_policy(struct _starpu_machine_config *config, const char *required_policy);
51 
52 void _starpu_sched_task_submit(struct starpu_task *task);
53 void _starpu_sched_do_schedule(unsigned sched_ctx_id);
54 
55 int _starpu_push_task(struct _starpu_job *task);
56 int _starpu_repush_task(struct _starpu_job *task);
57 
59 int _starpu_push_task_to_workers(struct starpu_task *task);
60 
62 struct starpu_task *_starpu_pop_task(struct _starpu_worker *worker);
63 void _starpu_sched_post_exec_hook(struct starpu_task *task);
64 int _starpu_pop_task_end(struct starpu_task *task);
65 
66 struct starpu_task *_starpu_create_conversion_task(starpu_data_handle_t handle,
67  unsigned int node) STARPU_ATTRIBUTE_MALLOC;
68 
69 struct starpu_task *_starpu_create_conversion_task_for_arch(starpu_data_handle_t handle,
70  enum starpu_node_kind node_kind) STARPU_ATTRIBUTE_MALLOC;
71 
72 void _starpu_sched_pre_exec_hook(struct starpu_task *task);
73 
74 void _starpu_print_idle_time();
75 /*
76  * Predefined policies
77  */
78 extern struct starpu_sched_policy _starpu_sched_lws_policy;
79 extern struct starpu_sched_policy _starpu_sched_ws_policy;
80 extern struct starpu_sched_policy _starpu_sched_prio_policy;
81 extern struct starpu_sched_policy _starpu_sched_random_policy;
82 extern struct starpu_sched_policy _starpu_sched_dm_policy;
83 extern struct starpu_sched_policy _starpu_sched_dmda_policy STARPU_ATTRIBUTE_VISIBILITY_DEFAULT;
84 extern struct starpu_sched_policy _starpu_sched_dmda_prio_policy;
85 extern struct starpu_sched_policy _starpu_sched_dmda_ready_policy;
86 extern struct starpu_sched_policy _starpu_sched_dmda_sorted_policy;
87 extern struct starpu_sched_policy _starpu_sched_dmda_sorted_decision_policy;
88 extern struct starpu_sched_policy _starpu_sched_eager_policy;
89 extern struct starpu_sched_policy _starpu_sched_parallel_heft_policy STARPU_ATTRIBUTE_VISIBILITY_DEFAULT;
90 extern struct starpu_sched_policy _starpu_sched_peager_policy;
91 extern struct starpu_sched_policy _starpu_sched_heteroprio_policy;
92 extern struct starpu_sched_policy _starpu_sched_modular_eager_policy;
93 extern struct starpu_sched_policy _starpu_sched_modular_eager_prefetching_policy;
94 extern struct starpu_sched_policy _starpu_sched_modular_eager_prio_policy;
95 extern struct starpu_sched_policy _starpu_sched_modular_gemm_policy;
96 extern struct starpu_sched_policy _starpu_sched_modular_prio_policy;
97 extern struct starpu_sched_policy _starpu_sched_modular_prio_prefetching_policy;
98 extern struct starpu_sched_policy _starpu_sched_modular_random_policy;
99 extern struct starpu_sched_policy _starpu_sched_modular_random_prio_policy;
100 extern struct starpu_sched_policy _starpu_sched_modular_random_prefetching_policy;
101 extern struct starpu_sched_policy _starpu_sched_modular_random_prio_prefetching_policy;
102 extern struct starpu_sched_policy _starpu_sched_modular_parallel_random_policy;
103 extern struct starpu_sched_policy _starpu_sched_modular_parallel_random_prio_policy;
104 extern struct starpu_sched_policy _starpu_sched_modular_ws_policy;
105 extern struct starpu_sched_policy _starpu_sched_modular_heft_policy;
106 extern struct starpu_sched_policy _starpu_sched_modular_heft_prio_policy;
107 extern struct starpu_sched_policy _starpu_sched_modular_heft2_policy;
108 extern struct starpu_sched_policy _starpu_sched_modular_heteroprio_policy;
109 extern struct starpu_sched_policy _starpu_sched_modular_heteroprio_heft_policy;
110 extern struct starpu_sched_policy _starpu_sched_modular_parallel_heft_policy;
111 extern struct starpu_sched_policy _starpu_sched_graph_test_policy;
112 extern struct starpu_sched_policy _starpu_sched_tree_heft_hierarchical_policy;
113 
114 extern long _starpu_task_break_on_push;
115 extern long _starpu_task_break_on_sched;
116 extern long _starpu_task_break_on_pop;
117 extern long _starpu_task_break_on_exec;
118 
119 #ifdef SIGTRAP
120 #define _STARPU_TASK_BREAK_ON(task, what) do { \
121  if (_starpu_get_job_associated_to_task(task)->job_id == (unsigned long) _starpu_task_break_on_##what) \
122  raise(SIGTRAP); \
123 } while(0)
124 #else
125 #define _STARPU_TASK_BREAK_ON(task, what) ((void) 0)
126 #endif
127 
128 #pragma GCC visibility pop
129 
130 #endif // __SCHED_POLICY_H__
starpu_node_kind
Definition: starpu_worker.h:44
struct starpu_task * _starpu_pop_task(struct _starpu_worker *worker)
int _starpu_push_task_to_workers(struct starpu_task *task)
Definition: jobs.h:74
Definition: workers.h:441
Definition: sched_ctx.h:48
Definition: workers.h:155