StarPU Handbook - StarPU Performances
Loading...
Searching...
No Matches
starpu_sched_component.h
Go to the documentation of this file.
1/* StarPU --- Runtime system for heterogeneous multicore architectures.
2 *
3 * Copyright (C) 2013-2023 Université de Bordeaux, CNRS (LaBRI UMR 5800), Inria
4 * Copyright (C) 2013 Simon Archipoff
5 * Copyright (C) 2017 Arthur Chevalier
6 *
7 * StarPU is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU Lesser General Public License as published by
9 * the Free Software Foundation; either version 2.1 of the License, or (at
10 * your option) any later version.
11 *
12 * StarPU is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
15 *
16 * See the GNU Lesser General Public License in COPYING.LGPL for more details.
17 */
18
19#ifndef __STARPU_SCHED_COMPONENT_H__
20#define __STARPU_SCHED_COMPONENT_H__
21
22#include <starpu.h>
23
24#ifdef STARPU_HAVE_HWLOC
25#include <hwloc.h>
26#endif
27
28#ifdef __cplusplus
29extern "C" {
30#endif
31
45
49#define STARPU_SCHED_COMPONENT_IS_HOMOGENEOUS(component) ((component)->properties & STARPU_SCHED_COMPONENT_HOMOGENEOUS)
50
54#define STARPU_SCHED_COMPONENT_IS_SINGLE_MEMORY_NODE(component) ((component)->properties & STARPU_SCHED_COMPONENT_SINGLE_MEMORY_NODE)
55
65{
78 void *data;
79 char *name;
81 unsigned nchildren;
85 unsigned nparents;
88
90 void (*add_child)(struct starpu_sched_component *component, struct starpu_sched_component *child);
92 void (*remove_child)(struct starpu_sched_component *component, struct starpu_sched_component *child);
93 void (*add_parent)(struct starpu_sched_component *component, struct starpu_sched_component *parent);
94 void (*remove_parent)(struct starpu_sched_component *component, struct starpu_sched_component *parent);
95
106 int (*push_task)(struct starpu_sched_component *, struct starpu_task *);
107
114 struct starpu_task *(*pull_task)(struct starpu_sched_component *from, struct starpu_sched_component *to);
115
125
136 int (*can_pull)(struct starpu_sched_component *component);
137
141 void (*do_schedule)(struct starpu_sched_component *component);
142
143 int (*notify)(struct starpu_sched_component *component, int message_ID, void *arg);
144
150 double (*estimated_load)(struct starpu_sched_component *component);
155 double (*estimated_end)(struct starpu_sched_component *component);
156
160 void (*deinit_data)(struct starpu_sched_component *component);
161
166 int properties;
167
168#ifdef STARPU_HAVE_HWLOC
175 hwloc_obj_t obj;
176#else
177 void *obj;
178#endif
179};
180
185{
197 unsigned sched_ctx_id;
202 starpu_pthread_mutex_t lock;
203};
204
249
254
259
260struct starpu_task *starpu_sched_component_pump_to(struct starpu_sched_component *component, struct starpu_sched_component *to, int *success);
261struct starpu_task *starpu_sched_component_pump_downstream(struct starpu_sched_component *component, int *success);
262int starpu_sched_component_send_can_push_to_parents(struct starpu_sched_component *component);
266void starpu_sched_tree_add_workers(unsigned sched_ctx_id, int *workerids, unsigned nworkers);
270void starpu_sched_tree_remove_workers(unsigned sched_ctx_id, int *workerids, unsigned nworkers);
271
275void starpu_sched_tree_do_schedule(unsigned sched_ctx_id);
276
281
289typedef struct starpu_sched_component *(*starpu_sched_component_create_t)(struct starpu_sched_tree *tree, void *data);
290
302
313
314void starpu_sched_component_add_child(struct starpu_sched_component *component, struct starpu_sched_component *child);
315
320
327int STARPU_WARN_UNUSED_RESULT starpu_sched_component_execute_preds(struct starpu_sched_component *component, struct starpu_task *task, double *length);
328
333
334void starpu_sched_component_prefetch_on_node(struct starpu_sched_component *component, struct starpu_task *task);
335
346struct starpu_sched_component *starpu_sched_component_worker_get(unsigned sched_ctx, int workerid);
347struct starpu_sched_component *starpu_sched_component_worker_new(unsigned sched_ctx, int workerid);
348
353
358
363
368
373
378void starpu_sched_component_worker_pre_exec_hook(struct starpu_task *task, unsigned sched_ctx_id);
379
383void starpu_sched_component_worker_post_exec_hook(struct starpu_task *task, unsigned sched_ctx_id);
384
397
402
407
412
418
423
432
437
442{
443 unsigned ntasks_threshold;
444 double exp_len_threshold;
445 int ready;
446 int exp;
447};
448
455
460
472{
473 unsigned ntasks_threshold;
474 double exp_len_threshold;
475 int ready;
476 int exp;
477};
478struct starpu_sched_component *starpu_sched_component_prio_create(struct starpu_sched_tree *tree, struct starpu_sched_component_prio_data *prio_data) STARPU_ATTRIBUTE_MALLOC;
479int starpu_sched_component_is_prio(struct starpu_sched_component *component);
480
492
497
502
514
519
527struct starpu_sched_component *starpu_sched_component_eager_create(struct starpu_sched_tree *tree, void *arg) STARPU_ATTRIBUTE_MALLOC;
528int starpu_sched_component_is_eager(struct starpu_sched_component *);
529
537struct starpu_sched_component *starpu_sched_component_eager_prio_create(struct starpu_sched_tree *tree, void *arg) STARPU_ATTRIBUTE_MALLOC;
538int starpu_sched_component_is_eager_prio(struct starpu_sched_component *);
539
547struct starpu_sched_component *starpu_sched_component_eager_calibration_create(struct starpu_sched_tree *tree, void *arg) STARPU_ATTRIBUTE_MALLOC;
548int starpu_sched_component_is_eager_calibration(struct starpu_sched_component *);
549
561{
562 double alpha;
563 double beta;
564 double _gamma;
565 double idle_power;
566};
567
574
575int starpu_sched_component_is_mct(struct starpu_sched_component *component);
576
584struct starpu_sched_component *starpu_sched_component_heft_create(struct starpu_sched_tree *tree, struct starpu_sched_component_mct_data *mct_data) STARPU_ATTRIBUTE_MALLOC;
585int starpu_sched_component_is_heft(struct starpu_sched_component *component);
586
598{
600 unsigned batch;
601};
602
603struct starpu_sched_component *starpu_sched_component_heteroprio_create(struct starpu_sched_tree *tree, struct starpu_sched_component_heteroprio_data *params) STARPU_ATTRIBUTE_MALLOC;
604int starpu_sched_component_is_heteroprio(struct starpu_sched_component *component);
605
620
632{
633 struct starpu_sched_component *calibrator_component;
634 struct starpu_sched_component *no_perfmodel_component;
635 struct starpu_sched_component *perfmodel_component;
636};
637struct starpu_sched_component *starpu_sched_component_perfmodel_select_create(struct starpu_sched_tree *tree, struct starpu_sched_component_perfmodel_select_data *perfmodel_select_data) STARPU_ATTRIBUTE_MALLOC;
638int starpu_sched_component_is_perfmodel_select(struct starpu_sched_component *component);
639
647struct starpu_sched_component *starpu_sched_component_stage_create(struct starpu_sched_tree *tree, void *arg) STARPU_ATTRIBUTE_MALLOC;
648int starpu_sched_component_is_stage(struct starpu_sched_component *component);
649
657struct starpu_sched_component *starpu_sched_component_userchoice_create(struct starpu_sched_tree *tree, void *arg) STARPU_ATTRIBUTE_MALLOC;
658int starpu_sched_component_is_userchoice(struct starpu_sched_component *component);
659
670struct starpu_sched_component_composed_recipe;
671
676struct starpu_sched_component_composed_recipe *starpu_sched_component_composed_recipe_create(void) STARPU_ATTRIBUTE_MALLOC;
677
681struct 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) STARPU_ATTRIBUTE_MALLOC;
682
686void 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);
687
691void starpu_sched_component_composed_recipe_destroy(struct starpu_sched_component_composed_recipe *);
692
698
699#ifdef STARPU_HAVE_HWLOC
705{
710 struct starpu_sched_component_composed_recipe *hwloc_machine_composed_sched_component;
714 struct starpu_sched_component_composed_recipe *hwloc_component_composed_sched_component;
718 struct starpu_sched_component_composed_recipe *hwloc_socket_composed_sched_component;
722 struct starpu_sched_component_composed_recipe *hwloc_cache_composed_sched_component;
723
728 struct starpu_sched_component_composed_recipe *(*worker_composed_sched_component)(enum starpu_worker_archtype archtype);
736};
737
742#endif /* STARPU_HAVE_HWLOC */
743
749#define STARPU_SCHED_SIMPLE_DECIDE_MASK (3 << 0)
750
754#define STARPU_SCHED_SIMPLE_DECIDE_WORKERS (1 << 0)
755
759#define STARPU_SCHED_SIMPLE_DECIDE_MEMNODES (2 << 0)
760
764#define STARPU_SCHED_SIMPLE_DECIDE_ARCHS (3 << 0)
765
769#define STARPU_SCHED_SIMPLE_DECIDE_ALWAYS (1 << 3)
770
775#define STARPU_SCHED_SIMPLE_PERFMODEL (1 << 4)
776
780#define STARPU_SCHED_SIMPLE_IMPL (1 << 5)
781
787#define STARPU_SCHED_SIMPLE_FIFO_ABOVE (1 << 6)
788
792#define STARPU_SCHED_SIMPLE_FIFO_ABOVE_PRIO (1 << 7)
793
799#define STARPU_SCHED_SIMPLE_FIFOS_BELOW (1 << 8)
800
804#define STARPU_SCHED_SIMPLE_FIFOS_BELOW_PRIO (1 << 9)
805
809#define STARPU_SCHED_SIMPLE_FIFOS_BELOW_READY (1 << 10)
810
814#define STARPU_SCHED_SIMPLE_WS_BELOW (1 << 11)
815
819#define STARPU_SCHED_SIMPLE_COMBINED_WORKERS (1 << 12)
820
824#define STARPU_SCHED_SIMPLE_FIFOS_BELOW_EXP (1 << 13)
825
831#define STARPU_SCHED_SIMPLE_PRE_DECISION (1 << 14)
832
841void starpu_sched_component_initialize_simple_scheduler(starpu_sched_component_create_t create_decision_component, void *data, unsigned flags, unsigned sched_ctx_id);
842
856
859#define STARPU_COMPONENT_MUTEX_LOCK(m) \
860 do \
861 { \
862 const int _relaxed_state = starpu_worker_get_relax_state(); \
863 if (!_relaxed_state) \
864 starpu_worker_relax_on(); \
865 STARPU_PTHREAD_MUTEX_LOCK((m)); \
866 if (!_relaxed_state) \
867 starpu_worker_relax_off(); \
868 } \
869 while (0)
870
871#define STARPU_COMPONENT_MUTEX_TRYLOCK(m) STARPU_PTHREAD_MUTEX_TRYLOCK((m))
872
873#define STARPU_COMPONENT_MUTEX_UNLOCK(m) STARPU_PTHREAD_MUTEX_UNLOCK((m))
874
877#ifdef __cplusplus
878}
879#endif
880
881#endif /* __STARPU_SCHED_COMPONENT_H__ */
unsigned sched_ctx
Definition starpu_task.h:1336
uint32_t * workerids
Definition starpu_task.h:1257
Definition starpu_task.h:688
void(* do_schedule)(struct starpu_sched_component *component)
Definition starpu_sched_component.h:141
struct starpu_bitmap workers
Definition starpu_sched_component.h:69
void * data
Definition starpu_sched_component.h:78
void(* notify_change_workers)(struct starpu_sched_component *component)
Definition starpu_sched_component.h:165
struct starpu_bitmap workers
Definition starpu_sched_component.h:193
void(* add_child)(struct starpu_sched_component *component, struct starpu_sched_component *child)
Definition starpu_sched_component.h:90
void(* deinit_data)(struct starpu_sched_component *component)
Definition starpu_sched_component.h:160
struct starpu_sched_tree * tree
Definition starpu_sched_component.h:67
int(* can_pull)(struct starpu_sched_component *component)
Definition starpu_sched_component.h:136
struct starpu_sched_component ** parents
Definition starpu_sched_component.h:87
struct starpu_sched_component_composed_recipe * hwloc_cache_composed_sched_component
Definition starpu_sched_component.h:722
struct starpu_sched_component * root
Definition starpu_sched_component.h:189
int mix_heterogeneous_workers
Definition starpu_sched_component.h:735
starpu_pthread_mutex_t lock
Definition starpu_sched_component.h:202
struct starpu_sched_component ** children
Definition starpu_sched_component.h:83
void(* remove_child)(struct starpu_sched_component *component, struct starpu_sched_component *child)
Definition starpu_sched_component.h:92
struct starpu_sched_component_composed_recipe * hwloc_socket_composed_sched_component
Definition starpu_sched_component.h:718
double(* estimated_end)(struct starpu_sched_component *component)
Definition starpu_sched_component.h:155
unsigned sched_ctx_id
Definition starpu_sched_component.h:197
double(* estimated_load)(struct starpu_sched_component *component)
Definition starpu_sched_component.h:150
unsigned nchildren
Definition starpu_sched_component.h:81
int(* push_task)(struct starpu_sched_component *, struct starpu_task *)
Definition starpu_sched_component.h:106
struct starpu_bitmap workers_in_ctx
Definition starpu_sched_component.h:76
unsigned nparents
Definition starpu_sched_component.h:85
struct starpu_sched_component_composed_recipe * hwloc_machine_composed_sched_component
Definition starpu_sched_component.h:710
int(* can_push)(struct starpu_sched_component *from, struct starpu_sched_component *to)
Definition starpu_sched_component.h:124
hwloc_obj_t obj
Definition starpu_sched_component.h:175
struct starpu_sched_component_composed_recipe * hwloc_component_composed_sched_component
Definition starpu_sched_component.h:714
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) STARPU_ATTRIBUTE_MALLOC
struct starpu_sched_component * starpu_sched_component_fifo_create(struct starpu_sched_tree *tree, struct starpu_sched_component_fifo_data *fifo_data) STARPU_ATTRIBUTE_MALLOC
double starpu_sched_component_transfer_length(struct starpu_sched_component *component, struct starpu_task *task)
double starpu_sched_component_estimated_end_average(struct starpu_sched_component *component)
struct starpu_sched_component * starpu_sched_component_worker_get(unsigned sched_ctx, int workerid)
void starpu_sched_component_destroy(struct starpu_sched_component *component)
int starpu_sched_component_worker_get_workerid(struct starpu_sched_component *worker_component)
struct starpu_sched_component * starpu_sched_component_work_stealing_create(struct starpu_sched_tree *tree, void *arg) STARPU_ATTRIBUTE_MALLOC
struct starpu_sched_component * starpu_sched_component_best_implementation_create(struct starpu_sched_tree *tree, void *arg) STARPU_ATTRIBUTE_MALLOC
struct starpu_task * starpu_sched_component_pull_task(struct starpu_sched_component *from, struct starpu_sched_component *to)
void starpu_sched_component_composed_recipe_destroy(struct starpu_sched_component_composed_recipe *)
struct starpu_sched_component * starpu_sched_component_parallel_worker_create(struct starpu_sched_tree *tree, unsigned nworkers, unsigned *workers)
void starpu_sched_tree_remove_workers(unsigned sched_ctx_id, int *workerids, unsigned nworkers)
struct starpu_sched_component_composed_recipe * starpu_sched_component_composed_recipe_create(void) STARPU_ATTRIBUTE_MALLOC
struct starpu_sched_component * starpu_sched_component_composed_component_create(struct starpu_sched_tree *tree, struct starpu_sched_component_composed_recipe *recipe) STARPU_ATTRIBUTE_MALLOC
int starpu_sched_component_can_pull_all(struct starpu_sched_component *component)
struct starpu_sched_tree * starpu_sched_tree_get(unsigned sched_ctx_id)
int starpu_sched_component_is_simple_worker(struct starpu_sched_component *component)
void starpu_sched_component_initialize_simple_schedulers(unsigned sched_ctx_id, unsigned ndecisions,...)
int starpu_sched_component_can_pull(struct starpu_sched_component *component)
int starpu_sched_tree_work_stealing_push_task(struct starpu_task *task)
void starpu_sched_component_initialize_simple_scheduler(starpu_sched_component_create_t create_decision_component, void *data, unsigned flags, unsigned sched_ctx_id)
int starpu_sched_tree_push_task(struct starpu_task *task)
void starpu_sched_tree_do_schedule(unsigned sched_ctx_id)
void starpu_sched_tree_update_workers(struct starpu_sched_tree *t)
double starpu_sched_component_estimated_end_min(struct starpu_sched_component *component)
struct starpu_task * starpu_sched_tree_pop_task(unsigned sched_ctx)
double starpu_sched_component_estimated_load(struct starpu_sched_component *component)
struct starpu_sched_tree * starpu_sched_tree_create(unsigned sched_ctx_id) STARPU_ATTRIBUTE_MALLOC
int starpu_sched_component_is_fifo(struct starpu_sched_component *component)
double starpu_sched_component_estimated_end_min_add(struct starpu_sched_component *component, double exp_len)
int starpu_sched_component_execute_preds(struct starpu_sched_component *component, struct starpu_task *task, double *length)
struct starpu_sched_component * starpu_sched_component_create(struct starpu_sched_tree *tree, const char *name) STARPU_ATTRIBUTE_MALLOC
void starpu_sched_tree_add_workers(unsigned sched_ctx_id, int *workerids, unsigned nworkers)
int starpu_sched_component_can_push(struct starpu_sched_component *component, struct starpu_sched_component *to)
void starpu_sched_tree_deinitialize(unsigned sched_ctx_id)
int starpu_sched_component_is_combined_worker(struct starpu_sched_component *component)
void starpu_sched_component_connect(struct starpu_sched_component *parent, struct starpu_sched_component *child)
struct starpu_sched_component * starpu_sched_component_random_create(struct starpu_sched_tree *tree, void *arg) STARPU_ATTRIBUTE_MALLOC
int starpu_sched_component_can_execute_task(struct starpu_sched_component *component, struct starpu_task *task)
struct starpu_sched_component * starpu_sched_component_mct_create(struct starpu_sched_tree *tree, struct starpu_sched_component_mct_data *mct_data) STARPU_ATTRIBUTE_MALLOC
void starpu_sched_component_destroy_rec(struct starpu_sched_component *component)
struct starpu_sched_tree * starpu_sched_component_make_scheduler(unsigned sched_ctx_id, struct starpu_sched_component_specs s)
starpu_sched_component_properties
Definition starpu_sched_component.h:41
void starpu_sched_tree_destroy(struct starpu_sched_tree *tree)
struct starpu_task * starpu_sched_component_parents_pull_task(struct starpu_sched_component *component, struct starpu_sched_component *to)
int starpu_sched_component_is_work_stealing(struct starpu_sched_component *component)
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)
void starpu_sched_component_worker_post_exec_hook(struct starpu_task *task, unsigned sched_ctx_id)
int starpu_sched_component_is_random(struct starpu_sched_component *)
int starpu_sched_component_is_worker(struct starpu_sched_component *component)
void starpu_sched_tree_update_workers_in_ctx(struct starpu_sched_tree *t)
int starpu_sched_component_push_task(struct starpu_sched_component *from, struct starpu_sched_component *to, struct starpu_task *task)
void starpu_sched_component_worker_pre_exec_hook(struct starpu_task *task, unsigned sched_ctx_id)
@ STARPU_SCHED_COMPONENT_HOMOGENEOUS
Definition starpu_sched_component.h:42
@ STARPU_SCHED_COMPONENT_SINGLE_MEMORY_NODE
Definition starpu_sched_component.h:43
Definition starpu_sched_component.h:65
Definition starpu_sched_component.h:442
Definition starpu_sched_component.h:598
Definition starpu_sched_component.h:561
Definition starpu_sched_component.h:632
Definition starpu_sched_component.h:472
Definition starpu_sched_component.h:705
Definition starpu_sched_component.h:185
#define STARPU_ATTRIBUTE_MALLOC
Definition starpu_util.h:129
starpu_worker_archtype
Definition starpu_worker.h:66
Definition starpu_bitmap.h:82