StarPU Internal Handbook
simgrid.h
Go to the documentation of this file.
1 /* StarPU --- Runtime system for heterogeneous multicore architectures.
2  *
3  * Copyright (C) 2012-2022 Université de Bordeaux, CNRS (LaBRI UMR 5800), Inria
4  * Copyright (C) 2013 Thibaut Lambert
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 __SIMGRID_H__
19 #define __SIMGRID_H__
20 
23 /* Note: when changing something here, update the include list in configure.ac
24  * in the part that tries to enable stdc++11 */
25 #ifdef STARPU_SIMGRID
26 #ifdef STARPU_HAVE_SIMGRID_MSG_H
27 #include <simgrid/msg.h>
28 #elif defined(STARPU_HAVE_MSG_MSG_H)
29 #include <msg/msg.h>
30 #endif
31 
32 #ifdef STARPU_HAVE_XBT_BASE_H
33 #include <xbt/base.h>
34 #endif
35 #ifdef STARPU_HAVE_SIMGRID_VERSION_H
36 #include <simgrid/version.h>
37 #endif
38 #ifdef STARPU_HAVE_SIMGRID_ZONE_H
39 #include <simgrid/zone.h>
40 #endif
41 #ifdef STARPU_HAVE_SIMGRID_HOST_H
42 #include <simgrid/host.h>
43 #endif
44 #if defined(HAVE_SIMGRID_SIMDAG_H) && (SIMGRID_VERSION >= 31300)
45 #include <simgrid/simdag.h>
46 #endif
47 
48 #include <xbt/xbt_os_time.h>
49 #endif
50 
51 #ifdef __cplusplus
52 extern "C"
53 {
54 #endif
55 
56 #ifdef STARPU_SIMGRID
57 #pragma GCC visibility push(hidden)
58 
60 {
61  void *(*f)(void*);
62  void *arg;
63 };
64 
65 #if (SIMGRID_VERSION >= 32600)
66 typedef void _starpu_simgrid_main_ret;
67 #define _STARPU_SIMGRID_MAIN_RETURN do { } while (0)
68 #else
69 typedef int _starpu_simgrid_main_ret;
70 #define _STARPU_SIMGRID_MAIN_RETURN return 0
71 #endif
72 #if (SIMGRID_VERSION >= 31500) && (SIMGRID_VERSION != 31559)
73 typedef sg_link_t starpu_sg_link_t;
74 #else
75 typedef SD_link_t starpu_sg_link_t;
76 #endif
77 _starpu_simgrid_main_ret
78 _starpu_simgrid_thread_start(int argc, char *argv[]);
79 
80 #define MAX_TSD 16
81 
82 #define STARPU_MPI_AS_PREFIX "StarPU-MPI"
83 #define _starpu_simgrid_running_smpi() (getenv("SMPI_GLOBAL_SIZE") != NULL)
84 
85 void _starpu_start_simgrid(int *argc, char **argv);
86 
87 void _starpu_simgrid_init_early(int *argc, char ***argv);
88 void _starpu_simgrid_init(void);
89 void _starpu_simgrid_cpp_init(void);
90 void _starpu_simgrid_deinit(void);
91 void _starpu_simgrid_deinit_late(void);
92 void _starpu_simgrid_actor_setup(void);
93 void _starpu_simgrid_wait_tasks(int workerid);
94 struct _starpu_job;
95 void _starpu_simgrid_submit_job(int workerid, int sched_ctx_id, struct _starpu_job *job, struct starpu_perfmodel_arch* perf_arch, double length, double energy, unsigned *finished);
96 struct _starpu_data_request;
97 int _starpu_simgrid_transfer(size_t size, unsigned src_node, unsigned dst_node, struct _starpu_data_request *req);
98 int _starpu_simgrid_wait_transfer_event(void *event);
99 int _starpu_simgrid_test_transfer_event(void *event);
100 void _starpu_simgrid_sync_gpus(void);
102 int _starpu_simgrid_get_nbhosts(const char *prefix);
103 unsigned long long _starpu_simgrid_get_memsize(const char *prefix, unsigned devid);
104 const char *_starpu_simgrid_get_devname(const char *prefix, unsigned devid);
105 starpu_sg_host_t _starpu_simgrid_get_host_by_name(const char *name);
106 starpu_sg_host_t _starpu_simgrid_get_memnode_host(unsigned node);
107 struct _starpu_worker;
108 starpu_sg_host_t _starpu_simgrid_get_host_by_worker(struct _starpu_worker *worker);
109 void _starpu_simgrid_get_platform_path(int version, char *path, size_t maxlen);
110 #if defined(HAVE_SG_ZONE_GET_BY_NAME) || defined(sg_zone_get_by_name)
111 sg_netzone_t _starpu_simgrid_get_as_by_name(const char *name);
112 #else
113 msg_as_t _starpu_simgrid_get_as_by_name(const char *name);
114 #endif
115 #pragma weak starpu_mpi_world_rank
116 extern int starpu_mpi_world_rank(void);
117 #pragma weak _starpu_mpi_simgrid_init
118 int _starpu_mpi_simgrid_init(int argc, char *argv[]);
119 
120 extern starpu_pthread_queue_t _starpu_simgrid_transfer_queue[STARPU_MAXNODES];
121 extern starpu_pthread_queue_t _starpu_simgrid_task_queue[STARPU_NMAXWORKERS];
122 
123 #ifdef STARPU_HAVE_S4U_ON_TIME_ADVANCE_CB
124 extern starpu_pthread_mutex_t _starpu_simgrid_time_advance_mutex;
125 extern starpu_pthread_cond_t _starpu_simgrid_time_advance_cond;
126 #endif
127 
128 #define _starpu_simgrid_cuda_malloc_cost() starpu_getenv_number_default("STARPU_SIMGRID_CUDA_MALLOC_COST", 1)
129 #define _starpu_simgrid_cuda_queue_cost() starpu_getenv_number_default("STARPU_SIMGRID_CUDA_QUEUE_COST", 1)
130 #define _starpu_simgrid_task_submit_cost() starpu_getenv_number_default("STARPU_SIMGRID_TASK_SUBMIT_COST", 1)
131 #define _starpu_simgrid_task_push_cost() starpu_getenv_number_default("STARPU_SIMGRID_TASK_PUSH_COST", 1)
132 #define _starpu_simgrid_fetching_input_cost() starpu_getenv_number_default("STARPU_SIMGRID_FETCHING_INPUT_COST", 1)
133 #define _starpu_simgrid_sched_cost() starpu_getenv_number_default("STARPU_SIMGRID_SCHED_COST", 0)
134 
138 
139 extern size_t _starpu_default_stack_size;
140 void _starpu_simgrid_set_stack_size(size_t stack_size);
141 void _starpu_simgrid_xbt_thread_create(const char *name, starpu_pthread_attr_t *attr, void_f_pvoid_t code,
142  void *param);
143 
144 #define _SIMGRID_TIMER_BEGIN(cond) \
145  { \
146  xbt_os_timer_t __timer = NULL; \
147  if (cond) { \
148  __timer = xbt_os_timer_new(); \
149  xbt_os_threadtimer_start(__timer); \
150  }
151 #define _SIMGRID_TIMER_END \
152  if (__timer) { \
153  xbt_os_threadtimer_stop(__timer); \
154  starpu_sleep(xbt_os_timer_elapsed(__timer));\
155  xbt_os_timer_free(__timer); \
156  } \
157  }
158 
159 #pragma GCC visibility pop
160 
161 #else // !STARPU_SIMGRID
162 #define _SIMGRID_TIMER_BEGIN(cond) {
163 #define _SIMGRID_TIMER_END }
164 #endif
165 
167 /* disk <-> MAIN_RAM only */
168 #if defined(STARPU_SIMGRID) && 0
169 void _starpu_simgrid_data_new(size_t size);
170 void _starpu_simgrid_data_increase(size_t size);
171 void _starpu_simgrid_data_alloc(size_t size);
172 void _starpu_simgrid_data_free(size_t size);
173 void _starpu_simgrid_data_transfer(size_t size, unsigned src_node, unsigned dst_node);
174 #else
175 #define _starpu_simgrid_data_new(size) (void)0
176 #define _starpu_simgrid_data_increase(size) (void)0
177 #define _starpu_simgrid_data_alloc(size) (void)0
178 #define _starpu_simgrid_data_free(size) (void)0
179 #define _starpu_simgrid_data_transfer(size, src_node, dst_node) (void)0
180 #endif
181 
182 #ifdef __cplusplus
183 }
184 #endif
185 
186 #endif // __SIMGRID_H__
#define STARPU_MAXNODES
Definition: starpu_config.h:217
#define STARPU_NMAXWORKERS
Definition: starpu_config.h:284
void _starpu_simgrid_count_ngpus(void)
#define _starpu_simgrid_data_new(size)
Definition: simgrid.h:175
int _starpu_simgrid_get_nbhosts(const char *prefix)
Definition: jobs.h:74
int workerid
Definition: jobs.h:190
Definition: simgrid.h:60
Definition: workers.h:155