StarPU Handbook - StarPU Performances
starpu_worker.h
Go to the documentation of this file.
1/* StarPU --- Runtime system for heterogeneous multicore architectures.
2 *
3 * Copyright (C) 2009-2023 Université de Bordeaux, CNRS (LaBRI UMR 5800), Inria
4 * Copyright (C) 2013 Thibaut Lambert
5 * Copyright (C) 2016 Uppsala University
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_WORKER_H__
20#define __STARPU_WORKER_H__
21
22#include <stdlib.h>
23#include <starpu_config.h>
24#include <starpu_thread.h>
25#include <starpu_task.h>
26
27#ifdef STARPU_HAVE_HWLOC
28#include <hwloc.h>
29#endif
30
31#ifdef __cplusplus
32extern "C" {
33#endif
34
44{
45 STARPU_UNUSED = 0,
56};
57
66{
76};
77
78#define STARPU_UNKNOWN_WORKER ((enum starpu_worker_archtype)-1)
84{
89 int cursor;
90 void *value;
91 void *possible_value;
92 char visited[STARPU_NMAXWORKERS];
93 int possibly_parallel;
94};
95
100{
104
113{
118 void *collection_private;
122 unsigned nworkers;
123 void *unblocked_workers;
124 unsigned nunblocked_workers;
125 void *masters;
126 unsigned nmasters;
127 char present[STARPU_NMAXWORKERS];
128 char is_unblocked[STARPU_NMAXWORKERS];
129 char is_master[STARPU_NMAXWORKERS];
137 unsigned (*has_next)(struct starpu_worker_collection *workers, struct starpu_sched_ctx_iterator *it);
145 int (*add)(struct starpu_worker_collection *workers, int worker);
149 int (*remove)(struct starpu_worker_collection *workers, int worker);
153 void (*init)(struct starpu_worker_collection *workers);
157 void (*deinit)(struct starpu_worker_collection *workers);
162 void (*init_iterator_for_parallel_tasks)(struct starpu_worker_collection *workers, struct starpu_sched_ctx_iterator *it, struct starpu_task *task);
163};
164
165extern struct starpu_worker_collection starpu_worker_list;
166extern struct starpu_worker_collection starpu_worker_tree;
167
176
182
188
196
203
210
217
224
230
236
246
247unsigned _starpu_worker_get_id_check(const char *f, int l);
248
255unsigned starpu_worker_get_id_check(void);
256
257#define starpu_worker_get_id_check() _starpu_worker_get_id_check(__FILE__, __LINE__)
258
262int starpu_worker_get_bindid(int workerid);
263
268
280
288
303
310
319
324unsigned starpu_worker_type_can_execute_task(enum starpu_worker_archtype worker_type, const struct starpu_task *task);
325
336void starpu_worker_get_name(int id, char *dst, size_t maxlen);
337
342void starpu_worker_display_all(FILE *output);
343
350
356
369
374
379
384
388unsigned starpu_worker_get_sched_ctx_list(int worker, unsigned **sched_ctx);
389
398void starpu_worker_get_current_task_exp_end(unsigned workerid, struct timespec *date);
399
405
409unsigned starpu_worker_is_slave_somewhere(int workerid);
410
416
423
429
433int starpu_bindid_get_workerids(int bindid, int **workerids);
434
438int starpu_worker_get_devids(enum starpu_worker_archtype type, int *devids, int num);
439
443int starpu_worker_get_stream_workerids(unsigned devid, int *workerids, enum starpu_worker_archtype type);
444
445#ifdef STARPU_HAVE_HWLOC
453hwloc_cpuset_t starpu_worker_get_hwloc_cpuset(int workerid);
459hwloc_obj_t starpu_worker_get_hwloc_obj(int workerid);
460#endif
461
466
472
478unsigned starpu_worker_get_memory_node(unsigned workerid);
479
485
491
505unsigned starpu_memory_node_get_ids_by_type(enum starpu_node_kind kind, unsigned *memory_nodes_ids, unsigned maxsize);
506
512int starpu_memory_node_get_name(unsigned node, char *name, size_t size);
513
519
526
533
542
548
554
565
579
590
597
604void starpu_worker_lock(int workerid);
605
614int starpu_worker_trylock(int workerid);
615
621void starpu_worker_unlock(int workerid);
622
628
634
635#ifdef STARPU_WORKER_CALLBACKS
642void starpu_worker_set_going_to_sleep_callback(void (*callback)(unsigned workerid));
643
650void starpu_worker_set_waking_up_callback(void (*callback)(unsigned workerid));
651#endif
652
671
677
686
694
699int starpu_combined_worker_assign_workerid(int nworkers, int workerid_array[]);
700
705int starpu_combined_worker_get_description(int workerid, int *worker_size, int **combined_workerid);
706
712int starpu_combined_worker_can_execute_task(unsigned workerid, struct starpu_task *task, unsigned nimpl);
713
719void starpu_parallel_task_barrier_init(struct starpu_task *task, int workerid);
720
727void starpu_parallel_task_barrier_init_n(struct starpu_task *task, int worker_size);
728
731#ifdef __cplusplus
732}
733#endif
734
735#endif /* __STARPU_WORKER_H__ */
Definition: starpu_task.h:679
int starpu_combined_worker_assign_workerid(int nworkers, int workerid_array[])
void starpu_parallel_task_barrier_init(struct starpu_task *task, int workerid)
unsigned starpu_combined_worker_get_count(void)
int starpu_combined_worker_get_rank(void)
int starpu_combined_worker_get_size(void)
unsigned starpu_worker_is_combined_worker(int id)
int starpu_combined_worker_get_description(int workerid, int *worker_size, int **combined_workerid)
int starpu_combined_worker_can_execute_task(unsigned workerid, struct starpu_task *task, unsigned nimpl)
int starpu_combined_worker_get_id(void)
void starpu_parallel_task_barrier_init_n(struct starpu_task *task, int worker_size)
Definition: starpu_tree.h:31
int * workerids
Definition: starpu_worker.h:117
unsigned nworkers
Definition: starpu_worker.h:122
int(* remove)(struct starpu_worker_collection *workers, int worker)
Definition: starpu_worker.h:149
void(* deinit)(struct starpu_worker_collection *workers)
Definition: starpu_worker.h:157
int cursor
Definition: starpu_worker.h:89
unsigned(* has_next)(struct starpu_worker_collection *workers, struct starpu_sched_ctx_iterator *it)
Definition: starpu_worker.h:137
int(* get_next)(struct starpu_worker_collection *workers, struct starpu_sched_ctx_iterator *it)
Definition: starpu_worker.h:141
enum starpu_worker_collection_type type
Definition: starpu_worker.h:133
void(* init)(struct starpu_worker_collection *workers)
Definition: starpu_worker.h:153
int(* add)(struct starpu_worker_collection *workers, int worker)
Definition: starpu_worker.h:145
void(* init_iterator)(struct starpu_worker_collection *workers, struct starpu_sched_ctx_iterator *it)
Definition: starpu_worker.h:161
int starpu_worker_get_devids(enum starpu_worker_archtype type, int *devids, int num)
int starpu_worker_get_devid(int id)
unsigned starpu_opencl_worker_get_count(void)
void starpu_worker_lock(int workerid)
int starpu_memory_node_get_devid(unsigned node)
enum starpu_worker_archtype starpu_worker_get_type_from_string(const char *type)
starpu_worker_archtype
Definition: starpu_worker.h:66
#define starpu_worker_get_id_check()
Definition: starpu_worker.h:257
unsigned starpu_hip_worker_get_count(void)
void starpu_sched_find_all_worker_combinations(void)
unsigned starpu_memory_nodes_get_count_by_kind(enum starpu_node_kind kind)
int starpu_memory_nodes_numa_id_to_devid(int osid)
void starpu_worker_display_all(FILE *output)
enum starpu_worker_archtype starpu_arch_mask_to_worker_archtype(unsigned mask)
int starpu_worker_get_relax_state(void)
int starpu_worker_trylock(int workerid)
hwloc_obj_t starpu_worker_get_hwloc_obj(int workerid)
void starpu_worker_unlock(int workerid)
int starpu_bindid_get_workerids(int bindid, int **workerids)
void starpu_worker_display_names(FILE *output, enum starpu_worker_archtype type)
int starpu_worker_get_bindid(int workerid)
void starpu_worker_get_current_task_exp_end(unsigned workerid, struct timespec *date)
unsigned starpu_worker_get_sched_ctx_list(int worker, unsigned **sched_ctx)
int starpu_worker_sched_op_pending(void)
unsigned starpu_worker_get_local_memory_node(void)
enum starpu_worker_archtype starpu_worker_get_type(int id)
unsigned starpu_memory_nodes_get_count(void)
int starpu_worker_get_stream_workerids(unsigned devid, int *workerids, enum starpu_worker_archtype type)
int starpu_memory_nodes_numa_devid_to_id(unsigned id)
struct starpu_tree * starpu_workers_get_tree(void)
int starpu_worker_get_count_by_type(enum starpu_worker_archtype type)
unsigned starpu_worker_get_count(void)
void starpu_worker_wait_for_initialisation(void)
starpu_node_kind
Definition: starpu_worker.h:44
void starpu_worker_unlock_self(void)
void starpu_worker_display_count(FILE *output, enum starpu_worker_archtype type)
unsigned starpu_worker_get_memory_node(unsigned workerid)
starpu_worker_collection_type
Definition: starpu_worker.h:100
unsigned starpu_memory_node_get_ids_by_type(enum starpu_node_kind kind, unsigned *memory_nodes_ids, unsigned maxsize)
unsigned starpu_worker_is_slave_somewhere(int workerid)
unsigned starpu_cpu_worker_get_count(void)
void starpu_worker_lock_self(void)
unsigned starpu_worker_type_can_execute_task(enum starpu_worker_archtype worker_type, const struct starpu_task *task)
int starpu_worker_get_devnum(int id)
enum starpu_node_kind starpu_node_get_kind(unsigned node)
unsigned starpu_mpi_ms_worker_get_count(void)
int starpu_worker_get_by_type(enum starpu_worker_archtype type, int num)
unsigned starpu_worker_archtype_is_valid(enum starpu_worker_archtype type)
void starpu_worker_relax_off(void)
enum starpu_worker_archtype starpu_memory_node_get_worker_archtype(enum starpu_node_kind node_kind)
unsigned starpu_memory_nodes_get_numa_count(void)
unsigned starpu_worker_is_blocked_in_parallel(int workerid)
int starpu_worker_get_id(void)
unsigned starpu_cuda_worker_get_count(void)
enum starpu_node_kind starpu_worker_get_memory_node_kind(enum starpu_worker_archtype type)
void starpu_worker_set_waking_up_callback(void(*callback)(unsigned workerid))
void starpu_worker_relax_on(void)
int starpu_worker_get_subworkerid(int id)
#define STARPU_NMAXWORKERS
Definition: starpu_config.h:296
unsigned starpu_worker_get_ids_by_type(enum starpu_worker_archtype type, int *workerids, unsigned maxsize)
void starpu_worker_set_going_to_sleep_callback(void(*callback)(unsigned workerid))
void starpu_worker_get_name(int id, char *dst, size_t maxlen)
const char * starpu_worker_get_type_as_env_var(enum starpu_worker_archtype type)
int starpu_worker_get_by_devid(enum starpu_worker_archtype type, int devid)
unsigned starpu_tcpip_ms_worker_get_count(void)
int starpu_memory_node_get_name(unsigned node, char *name, size_t size)
const char * starpu_worker_get_type_as_string(enum starpu_worker_archtype type)
hwloc_cpuset_t starpu_worker_get_hwloc_cpuset(int workerid)
@ STARPU_CUDA_WORKER
Definition: starpu_worker.h:68
@ STARPU_MPI_MS_WORKER
Definition: starpu_worker.h:71
@ STARPU_HIP_WORKER
Definition: starpu_worker.h:73
@ STARPU_CPU_WORKER
Definition: starpu_worker.h:67
@ STARPU_MAX_FPGA_WORKER
Definition: starpu_worker.h:70
@ STARPU_OPENCL_WORKER
Definition: starpu_worker.h:69
@ STARPU_ANY_WORKER
Definition: starpu_worker.h:75
@ STARPU_NARCH
Definition: starpu_worker.h:74
@ STARPU_TCPIP_MS_WORKER
Definition: starpu_worker.h:72
@ STARPU_MAX_RAM
Definition: starpu_worker.h:54
@ STARPU_HIP_RAM
Definition: starpu_worker.h:53
@ STARPU_TCPIP_MS_RAM
Definition: starpu_worker.h:52
@ STARPU_MAX_FPGA_RAM
Definition: starpu_worker.h:49
@ STARPU_CUDA_RAM
Definition: starpu_worker.h:47
@ STARPU_DISK_RAM
Definition: starpu_worker.h:50
@ STARPU_MPI_MS_RAM
Definition: starpu_worker.h:51
@ STARPU_NRAM
Definition: starpu_worker.h:55
@ STARPU_CPU_RAM
Definition: starpu_worker.h:46
@ STARPU_OPENCL_RAM
Definition: starpu_worker.h:48
@ STARPU_WORKER_TREE
Definition: starpu_worker.h:101
@ STARPU_WORKER_LIST
Definition: starpu_worker.h:102
Definition: starpu_worker.h:84
Definition: starpu_worker.h:113