1 /* Copyright (c) 2007-2010, 2012-2015. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
13 #include "xbt/function_types.h"
14 #include "xbt/parmap.h"
16 #include "simgrid/datatypes.h"
17 #include "simgrid/host.h"
25 /** @brief Process datatype
26 @ingroup simix_process_management
28 A process may be defined as a <em>code</em>, with some <em>private
29 data</em>, executing in a <em>location</em>.
30 \see m_process_management
39 typedef simgrid::simix::Context *smx_context_t;
40 typedef simgrid::simix::Process *smx_process_t;
43 * \ingroup simix_synchro_management
45 typedef simgrid::simix::Mutex *smx_mutex_t;
49 typedef struct s_smx_context *smx_context_t;
50 typedef struct s_smx_process *smx_process_t;
51 typedef struct s_smx_mutex *smx_mutex_t;
55 /**************************** Scalar Values **********************************/
57 typedef union u_smx_scalar u_smx_scalar_t;
59 /* ******************************** Host ************************************ */
60 /** @brief Host datatype
61 @ingroup simix_host_management
63 A <em>location</em> (or <em>host</em>) is any possible place where
64 a process may run. Thus it is represented as a <em>physical
65 resource with computing capabilities</em>, some <em>mailboxes</em>
66 to enable running process to communicate with remote ones, and
67 some <em>private data</em> that can be only accessed by local
70 \see m_host_management
79 SIMIX_SRC_HOST_FAILURE,
80 SIMIX_DST_HOST_FAILURE,
87 /* ******************************** Synchro ************************************ */
90 * \ingroup simix_synchro_management
92 typedef struct s_smx_cond *smx_cond_t;
94 * \ingroup simix_synchro_management
96 typedef struct s_smx_sem *smx_sem_t;
98 /********************************** File *************************************/
99 typedef struct s_smx_file *smx_file_t;
101 /********************************** Storage *************************************/
102 typedef xbt_dictelm_t smx_storage_t;
103 typedef struct s_smx_storage_priv *smx_storage_priv_t;
105 /* ****************************** Process *********************************** */
108 SMX_EXIT_SUCCESS = 0,
110 } smx_process_exit_status_t;
113 /******************************* Networking ***********************************/
115 * \ingroup simix_mbox_management
117 typedef struct s_smx_mailbox *smx_mailbox_t;
119 /* Process creation/destruction callbacks */
120 typedef void (*void_pfn_smxprocess_t) (smx_process_t);
121 /* for auto-restart function */
122 typedef void (*void_pfn_sghost_t) (sg_host_t);
124 extern int smx_context_stack_size;
125 extern int smx_context_stack_size_was_set;
126 extern int smx_context_guard_size;
127 extern int smx_context_guard_size_was_set;
131 XBT_PUBLIC(xbt_dynar_t) SIMIX_process_get_runnable(void);
132 XBT_PUBLIC(smx_process_t) SIMIX_process_from_PID(int PID);
133 XBT_PUBLIC(xbt_dynar_t) SIMIX_processes_as_dynar(void);
136 XBT_PUBLIC(int) SIMIX_context_is_parallel(void);
137 XBT_PUBLIC(int) SIMIX_context_get_nthreads(void);
138 XBT_PUBLIC(void) SIMIX_context_set_nthreads(int nb_threads);
139 XBT_PUBLIC(int) SIMIX_context_get_parallel_threshold(void);
140 XBT_PUBLIC(void) SIMIX_context_set_parallel_threshold(int threshold);
141 XBT_PUBLIC(e_xbt_parmap_mode_t) SIMIX_context_get_parallel_mode(void);
142 XBT_PUBLIC(void) SIMIX_context_set_parallel_mode(e_xbt_parmap_mode_t mode);
143 XBT_PUBLIC(int) SIMIX_is_maestro();
146 /********************************** Global ************************************/
147 /* Initialization and exit */
148 XBT_PUBLIC(void) SIMIX_global_init(int *argc, char **argv);
150 /* Set to execute in the maestro
152 * If no maestro code is registered (the default), the main thread
153 * is assumed to be the maestro. */
154 XBT_PUBLIC(void) SIMIX_set_maestro(void (*code)(void*), void* data);
156 XBT_PUBLIC(void) SIMIX_function_register_process_cleanup(void_pfn_smxprocess_t function);
157 XBT_PUBLIC(void) SIMIX_function_register_process_kill(void_pfn_smxprocess_t function);
159 /* Simulation execution */
160 XBT_PUBLIC(void) SIMIX_run(void);
161 XBT_PUBLIC(double) SIMIX_get_clock(void);
163 /* Timer functions FIXME: should these be public? */
164 typedef struct s_smx_timer* smx_timer_t;
166 XBT_PUBLIC(smx_timer_t) SIMIX_timer_set(double date, void (*function)(void*), void *arg);
167 XBT_PUBLIC(void) SIMIX_timer_remove(smx_timer_t timer);
168 XBT_PUBLIC(double) SIMIX_timer_next(void);
169 XBT_PUBLIC(double) SIMIX_timer_get_date(smx_timer_t timer);
171 XBT_PUBLIC(void) SIMIX_display_process_status(void);
173 /******************************* Environment **********************************/
174 XBT_PUBLIC(void) SIMIX_create_environment(const char *file);
176 /******************************** Deployment **********************************/
178 XBT_PUBLIC(void) SIMIX_function_register(const char *name, xbt_main_func_t code);
179 XBT_PUBLIC(void) SIMIX_function_register_default(xbt_main_func_t code);
180 XBT_PUBLIC(xbt_main_func_t) SIMIX_get_registered_function(const char *name);
181 XBT_PUBLIC(void) SIMIX_init_application(void);
182 XBT_PUBLIC(void) SIMIX_launch_application(const char *file);
184 XBT_PUBLIC(void) SIMIX_process_set_function(const char* process_host,
185 const char *process_function,
186 xbt_dynar_t arguments,
187 double process_start_time,
188 double process_kill_time);
190 /*********************************** Host *************************************/
191 /* Functions for running a process in main()
193 * 1. create the maestro process
194 * 2. attach (create a context and wait for maestro to give control back to you)
195 * 3. do you process job
196 * 4. detach (this waits for the simulation to terminate)
199 XBT_PUBLIC(void) SIMIX_maestro_create(void (*code)(void*), void* data);
200 XBT_PUBLIC(smx_process_t) SIMIX_process_attach(
203 const char* hostname,
204 xbt_dict_t properties,
205 smx_process_t parent_process);
206 XBT_PUBLIC(void) SIMIX_process_detach(void);
208 /*********************************** Host *************************************/
209 XBT_PUBLIC(sg_host_t) SIMIX_host_self(void);
210 XBT_PUBLIC(const char*) SIMIX_host_self_get_name(void);
211 XBT_PUBLIC(void) SIMIX_host_on(sg_host_t host);
212 XBT_PUBLIC(void) SIMIX_host_off(sg_host_t host, smx_process_t issuer);
213 XBT_PUBLIC(void) SIMIX_host_self_set_data(void *data);
214 XBT_PUBLIC(void*) SIMIX_host_self_get_data(void);
216 /********************************* Process ************************************/
217 XBT_PUBLIC(smx_process_t) SIMIX_process_ref(smx_process_t process);
218 XBT_PUBLIC(void) SIMIX_process_unref(smx_process_t process);
219 XBT_PUBLIC(int) SIMIX_process_count(void);
220 XBT_PUBLIC(smx_process_t) SIMIX_process_self(void);
221 XBT_PUBLIC(const char*) SIMIX_process_self_get_name(void);
222 XBT_PUBLIC(void) SIMIX_process_self_set_data(void *data);
223 XBT_PUBLIC(void*) SIMIX_process_self_get_data(void);
224 XBT_PUBLIC(smx_context_t) SIMIX_process_get_context(smx_process_t);
225 XBT_PUBLIC(void) SIMIX_process_set_context(smx_process_t p,smx_context_t c);
226 XBT_PUBLIC(int) SIMIX_process_has_pending_comms(smx_process_t process);
227 XBT_PUBLIC(void) SIMIX_process_on_exit_runall(smx_process_t process);
228 XBT_PUBLIC(void) SIMIX_process_on_exit(smx_process_t process, int_f_pvoid_pvoid_t fun, void *data);
230 /****************************** Communication *********************************/
231 XBT_PUBLIC(void) SIMIX_comm_set_copy_data_callback(void (*callback) (smx_synchro_t, void*, size_t));
232 XBT_PUBLIC(void) SIMIX_comm_copy_pointer_callback(smx_synchro_t comm, void* buff, size_t buff_size);
233 XBT_PUBLIC(void) SIMIX_comm_copy_buffer_callback(smx_synchro_t comm, void* buff, size_t buff_size);
235 XBT_PUBLIC(smx_synchro_t) SIMIX_comm_get_send_match(smx_mailbox_t mbox, int (*match_fun)(void*, void*), void* data);
236 XBT_PUBLIC(int) SIMIX_comm_has_send_match(smx_mailbox_t mbox, int (*match_fun)(void*, void*), void* data);
237 XBT_PUBLIC(int) SIMIX_comm_has_recv_match(smx_mailbox_t mbox, int (*match_fun)(void*, void*), void* data);
238 XBT_PUBLIC(void) SIMIX_comm_finish(smx_synchro_t synchro);
240 /******************************************************************************/
242 /******************************************************************************/
243 /* These functions are a system call-like interface to the simulation kernel. */
244 /* They can also be called from maestro's context, and they are thread safe. */
245 /******************************************************************************/
247 XBT_PUBLIC(void) simcall_call(smx_process_t process);
249 /******************************* Host simcalls ********************************/
250 XBT_PUBLIC(void) simcall_host_set_data(sg_host_t host, void *data);
252 XBT_PUBLIC(smx_synchro_t) simcall_execution_start(const char *name,
254 double priority, double bound, unsigned long affinity_mask);
255 XBT_PUBLIC(smx_synchro_t) simcall_execution_parallel_start(const char *name,
257 sg_host_t *host_list,
258 double *flops_amount,
259 double *bytes_amount,
262 XBT_PUBLIC(void) simcall_execution_cancel(smx_synchro_t execution);
263 XBT_PUBLIC(void) simcall_execution_set_priority(smx_synchro_t execution, double priority);
264 XBT_PUBLIC(void) simcall_execution_set_bound(smx_synchro_t execution, double bound);
265 XBT_PUBLIC(void) simcall_execution_set_affinity(smx_synchro_t execution, sg_host_t host, unsigned long mask);
266 XBT_PUBLIC(e_smx_state_t) simcall_execution_wait(smx_synchro_t execution);
268 /******************************* VM simcalls ********************************/
269 // Create the vm_workstation at the SURF level
270 XBT_PUBLIC(void*) simcall_vm_create(const char *name, sg_host_t host);
271 XBT_PUBLIC(int) simcall_vm_get_state(sg_host_t vm);
272 XBT_PUBLIC(void) simcall_vm_start(sg_host_t vm);
273 XBT_PUBLIC(void) simcall_vm_migrate(sg_host_t vm, sg_host_t dst_pm);
274 XBT_PUBLIC(void *) simcall_vm_get_pm(sg_host_t vm);
275 XBT_PUBLIC(void) simcall_vm_set_bound(sg_host_t vm, double bound);
276 XBT_PUBLIC(void) simcall_vm_set_affinity(sg_host_t vm, sg_host_t pm, unsigned long mask);
277 XBT_PUBLIC(void) simcall_vm_resume(sg_host_t vm);
278 XBT_PUBLIC(void) simcall_vm_migratefrom_resumeto(sg_host_t vm, sg_host_t src_pm, sg_host_t dst_pm);
279 XBT_PUBLIC(void) simcall_vm_save(sg_host_t vm);
280 XBT_PUBLIC(void) simcall_vm_restore(sg_host_t vm);
281 XBT_PUBLIC(void) simcall_vm_suspend(sg_host_t vm);
282 XBT_PUBLIC(void) simcall_vm_destroy(sg_host_t vm);
283 XBT_PUBLIC(void) simcall_vm_shutdown(sg_host_t vm);
285 /**************************** Process simcalls ********************************/
286 /* Constructor and Destructor */
287 XBT_PUBLIC(smx_process_t) simcall_process_create(const char *name,
288 xbt_main_func_t code,
290 const char *hostname,
292 int argc, char **argv,
293 xbt_dict_t properties,
296 XBT_PUBLIC(void) simcall_process_kill(smx_process_t process);
297 XBT_PUBLIC(void) simcall_process_killall(int reset_pid);
298 XBT_PUBLIC(void) SIMIX_process_throw(smx_process_t process, xbt_errcat_t cat, int value, const char *msg);
301 /* Process handling */
302 XBT_PUBLIC(void) simcall_process_cleanup(smx_process_t process);
303 XBT_PUBLIC(void) simcall_process_suspend(smx_process_t process);
304 XBT_PUBLIC(void) simcall_process_resume(smx_process_t process);
306 /* Getters and Setters */
307 XBT_PUBLIC(int) simcall_process_count(void);
308 XBT_PUBLIC(void *) simcall_process_get_data(smx_process_t process);
309 XBT_PUBLIC(void) simcall_process_set_data(smx_process_t process, void *data);
310 XBT_PUBLIC(void) simcall_process_set_host(smx_process_t process, sg_host_t dest);
311 XBT_PUBLIC(sg_host_t) simcall_process_get_host(smx_process_t process);
312 XBT_PUBLIC(const char *) simcall_process_get_name(smx_process_t process);
313 XBT_PUBLIC(int) simcall_process_get_PID(smx_process_t process);
314 XBT_PUBLIC(int) simcall_process_get_PPID(smx_process_t process);
315 XBT_PUBLIC(int) simcall_process_is_suspended(smx_process_t process);
316 XBT_PUBLIC(xbt_dict_t) simcall_process_get_properties(smx_process_t host);
317 XBT_PUBLIC(void) simcall_process_set_kill_time(smx_process_t process, double kill_time);
318 XBT_PUBLIC(double) simcall_process_get_kill_time(smx_process_t process);
319 XBT_PUBLIC(void) simcall_process_on_exit(smx_process_t process, int_f_pvoid_pvoid_t fun, void *data);
320 XBT_PUBLIC(void) simcall_process_auto_restart_set(smx_process_t process, int auto_restart);
321 XBT_PUBLIC(smx_process_t) simcall_process_restart(smx_process_t process);
322 XBT_PUBLIC(void) simcall_process_join(smx_process_t process, double timeout);
324 XBT_PUBLIC(e_smx_state_t) simcall_process_sleep(double duration);
326 /************************** Comunication simcalls *****************************/
327 /***** Rendez-vous points *****/
329 XBT_PUBLIC(smx_mailbox_t) simcall_mbox_create(const char *name);
330 XBT_PUBLIC(smx_mailbox_t) simcall_mbox_get_by_name(const char *name);
331 XBT_PUBLIC(smx_synchro_t) simcall_mbox_front(smx_mailbox_t mbox);
332 XBT_PUBLIC(void) simcall_mbox_set_receiver(smx_mailbox_t mbox , smx_process_t process);
334 /***** Communication simcalls *****/
336 XBT_PUBLIC(void) simcall_comm_send(smx_process_t sender, smx_mailbox_t mbox, double task_size,
337 double rate, void *src_buff,
338 size_t src_buff_size,
339 int (*match_fun)(void *, void *, smx_synchro_t),
340 void (*copy_data_fun)(smx_synchro_t, void*, size_t),
341 void *data, double timeout);
343 XBT_PUBLIC(smx_synchro_t) simcall_comm_isend(smx_process_t sender, smx_mailbox_t mbox,
345 double rate, void *src_buff,
346 size_t src_buff_size,
347 int (*match_fun)(void *, void *, smx_synchro_t),
348 void (*clean_fun)(void *),
349 void (*copy_data_fun)(smx_synchro_t, void*, size_t),
350 void *data, int detached);
352 XBT_PUBLIC(void) simcall_comm_recv(smx_process_t receiver, smx_mailbox_t mbox, void *dst_buff,
353 size_t * dst_buff_size,
354 int (*match_fun)(void *, void *, smx_synchro_t),
355 void (*copy_data_fun)(smx_synchro_t, void*, size_t),
356 void *data, double timeout, double rate);
358 XBT_PUBLIC(smx_synchro_t) simcall_comm_irecv(smx_process_t receiver, smx_mailbox_t mbox, void *dst_buff,
359 size_t * dst_buff_size,
360 int (*match_fun)(void *, void *, smx_synchro_t),
361 void (*copy_data_fun)(smx_synchro_t, void*, size_t),
362 void *data, double rate);
364 XBT_PUBLIC(smx_synchro_t) simcall_comm_iprobe(smx_mailbox_t mbox, int type, int src, int tag,
365 int (*match_fun)(void *, void *, smx_synchro_t), void *data);
366 XBT_PUBLIC(void) simcall_comm_cancel(smx_synchro_t comm);
368 /* FIXME: waitany is going to be a vararg function, and should take a timeout */
369 XBT_PUBLIC(unsigned int) simcall_comm_waitany(xbt_dynar_t comms);
370 XBT_PUBLIC(void) simcall_comm_wait(smx_synchro_t comm, double timeout);
371 XBT_PUBLIC(int) simcall_comm_test(smx_synchro_t comm);
372 XBT_PUBLIC(int) simcall_comm_testany(xbt_dynar_t comms);
374 /************************** Tracing handling **********************************/
375 XBT_PUBLIC(void) simcall_set_category(smx_synchro_t synchro, const char *category);
377 /************************** Synchro simcalls **********************************/
378 XBT_PUBLIC(smx_mutex_t) simcall_mutex_init(void);
379 XBT_PUBLIC(smx_mutex_t) SIMIX_mutex_ref(smx_mutex_t mutex);
380 XBT_PUBLIC(void) SIMIX_mutex_unref(smx_mutex_t mutex);
381 XBT_PUBLIC(void) simcall_mutex_lock(smx_mutex_t mutex);
382 XBT_PUBLIC(int) simcall_mutex_trylock(smx_mutex_t mutex);
383 XBT_PUBLIC(void) simcall_mutex_unlock(smx_mutex_t mutex);
385 XBT_PUBLIC(smx_cond_t) simcall_cond_init(void);
386 XBT_PUBLIC(void) SIMIX_cond_unref(smx_cond_t cond);
387 XBT_PUBLIC(smx_cond_t) SIMIX_cond_ref(smx_cond_t cond);
388 XBT_PUBLIC(void) simcall_cond_signal(smx_cond_t cond);
389 XBT_PUBLIC(void) simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex);
390 XBT_PUBLIC(void) simcall_cond_wait_timeout(smx_cond_t cond,
392 double max_duration);
393 XBT_PUBLIC(void) simcall_cond_broadcast(smx_cond_t cond);
395 XBT_PUBLIC(smx_sem_t) simcall_sem_init(int capacity);
396 XBT_PUBLIC(void) SIMIX_sem_destroy(smx_sem_t sem);
397 XBT_PUBLIC(void) simcall_sem_release(smx_sem_t sem);
398 XBT_PUBLIC(int) simcall_sem_would_block(smx_sem_t sem);
399 XBT_PUBLIC(void) simcall_sem_acquire(smx_sem_t sem);
400 XBT_PUBLIC(void) simcall_sem_acquire_timeout(smx_sem_t sem,
401 double max_duration);
402 XBT_PUBLIC(int) simcall_sem_get_capacity(smx_sem_t sem);
404 /***************************** File **********************************/
405 XBT_PUBLIC(void *) simcall_file_get_data(smx_file_t fd);
406 XBT_PUBLIC(void) simcall_file_set_data(smx_file_t fd, void *data);
407 XBT_PUBLIC(sg_size_t) simcall_file_read(smx_file_t fd, sg_size_t size, sg_host_t host);
408 XBT_PUBLIC(sg_size_t) simcall_file_write(smx_file_t fd, sg_size_t size, sg_host_t host);
409 XBT_PUBLIC(smx_file_t) simcall_file_open(const char* fullpath, sg_host_t host);
410 XBT_PUBLIC(int) simcall_file_close(smx_file_t fd, sg_host_t host);
411 XBT_PUBLIC(int) simcall_file_unlink(smx_file_t fd, sg_host_t host);
412 XBT_PUBLIC(sg_size_t) simcall_file_get_size(smx_file_t fd);
413 XBT_PUBLIC(xbt_dynar_t) simcall_file_get_info(smx_file_t fd);
414 XBT_PUBLIC(sg_size_t) simcall_file_tell(smx_file_t fd);
415 XBT_PUBLIC(int) simcall_file_seek(smx_file_t fd, sg_offset_t offset, int origin);
416 XBT_PUBLIC(int) simcall_file_move(smx_file_t fd, const char* fullpath);
417 /***************************** Storage **********************************/
418 XBT_PUBLIC(sg_size_t) simcall_storage_get_free_size (smx_storage_t storage);
419 XBT_PUBLIC(sg_size_t) simcall_storage_get_used_size (smx_storage_t storage);
420 XBT_PUBLIC(xbt_dict_t) simcall_storage_get_properties(smx_storage_t storage);
421 XBT_PUBLIC(void*) SIMIX_storage_get_data(smx_storage_t storage);
422 XBT_PUBLIC(void) SIMIX_storage_set_data(smx_storage_t storage, void *data);
423 XBT_PUBLIC(xbt_dict_t) SIMIX_storage_get_content(smx_storage_t storage);
424 XBT_PUBLIC(xbt_dict_t) simcall_storage_get_content(smx_storage_t storage);
425 XBT_PUBLIC(const char*) SIMIX_storage_get_name(smx_storage_t storage);
426 XBT_PUBLIC(sg_size_t) SIMIX_storage_get_size(smx_storage_t storage);
427 XBT_PUBLIC(const char*) SIMIX_storage_get_host(smx_storage_t storage);
428 /************************** AS router **********************************/
429 XBT_PUBLIC(xbt_dict_t) SIMIX_asr_get_properties(const char *name);
430 /************************** AS router simcalls ***************************/
431 XBT_PUBLIC(xbt_dict_t) simcall_asr_get_properties(const char *name);
433 /************************** MC simcalls **********************************/
434 XBT_PUBLIC(int) simcall_mc_random(int min, int max);
437 #endif /* _SIMIX_SIMIX_H */