1 /* Copyright (c) 2007-2021. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
6 #ifndef SIMGRID_SIMIX_H
7 #define SIMGRID_SIMIX_H
9 #include <simgrid/forward.h>
10 #include <xbt/dynar.h>
12 #include <xbt/parmap.h>
16 #include <unordered_map>
20 /******************************* Networking ***********************************/
21 extern unsigned smx_context_stack_size;
22 extern unsigned smx_context_guard_size;
26 XBT_ATTRIB_DEPRECATED_v331("Please use sg_actor_by_pid() instead.") XBT_PUBLIC smx_actor_t
27 SIMIX_process_from_PID(aid_t pid);
30 XBT_PUBLIC int SIMIX_context_is_parallel();
31 XBT_PUBLIC int SIMIX_context_get_nthreads();
32 XBT_PUBLIC void SIMIX_context_set_nthreads(int nb_threads);
33 XBT_PUBLIC e_xbt_parmap_mode_t SIMIX_context_get_parallel_mode();
34 XBT_PUBLIC void SIMIX_context_set_parallel_mode(e_xbt_parmap_mode_t mode);
35 XBT_PUBLIC int SIMIX_is_maestro();
37 /********************************** Global ************************************/
38 /* Initialization and exit */
39 XBT_PUBLIC void SIMIX_global_init(int* argc, char** argv);
41 /* Set some code to execute in the maestro (must be used before the engine creation)
43 * If no maestro code is registered (the default), the main thread
44 * is assumed to be the maestro. */
45 XBT_PUBLIC void SIMIX_set_maestro(void (*code)(void*), void* data);
47 /* Simulation execution */
48 XBT_ATTRIB_DEPRECATED_v332("Please use EngineImpl:run()") XBT_PUBLIC void SIMIX_run();
49 XBT_ATTRIB_DEPRECATED_v332("Please use simgrid_get_clock() or Engine::get_clock()") XBT_PUBLIC double SIMIX_get_clock();
53 /********************************* Process ************************************/
55 XBT_PUBLIC smx_actor_t SIMIX_process_self();
56 XBT_PUBLIC const char* SIMIX_process_self_get_name();
59 /****************************** Communication *********************************/
61 XBT_PUBLIC void SIMIX_comm_set_copy_data_callback(void (*callback)(simgrid::kernel::activity::CommImpl*, void*,
63 XBT_PUBLIC void SIMIX_comm_copy_pointer_callback(simgrid::kernel::activity::CommImpl* comm, void* buff,
65 XBT_PUBLIC void SIMIX_comm_copy_buffer_callback(simgrid::kernel::activity::CommImpl* comm, void* buff,
69 /******************************************************************************/
71 /******************************************************************************/
72 /* These functions are a system call-like interface to the simulation kernel. */
73 /* They can also be called from maestro's context, and they are thread safe. */
74 /******************************************************************************/
76 /******************************* Host simcalls ********************************/
78 XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Exec::wait_for()") XBT_PUBLIC simgrid::kernel::activity::State
79 simcall_execution_wait(simgrid::kernel::activity::ActivityImpl* execution, double timeout);
80 XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Exec::wait_for()") XBT_PUBLIC simgrid::kernel::activity::State
81 simcall_execution_wait(const simgrid::kernel::activity::ActivityImplPtr& execution, double timeout);
82 XBT_ATTRIB_DEPRECATED_v331("Please use s4u::Exec::wait_any_for()") XBT_PUBLIC
83 unsigned int simcall_execution_waitany_for(simgrid::kernel::activity::ExecImpl* execs[], size_t count,
85 XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Exec::test()") XBT_PUBLIC
86 bool simcall_execution_test(simgrid::kernel::activity::ActivityImpl* execution);
87 XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Exec::test()") XBT_PUBLIC
88 bool simcall_execution_test(const simgrid::kernel::activity::ActivityImplPtr& execution);
92 /************************** Communication simcalls ****************************/
95 XBT_PUBLIC void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
97 bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
98 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
99 void* data, double timeout);
101 XBT_PUBLIC simgrid::kernel::activity::ActivityImplPtr
102 simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
103 size_t src_buff_size, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
104 void (*clean_fun)(void*), void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
105 void* data, bool detached);
107 XBT_PUBLIC void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
108 bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
109 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
110 void* data, double timeout, double rate);
112 XBT_PUBLIC simgrid::kernel::activity::ActivityImplPtr
113 simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
114 bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
115 void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data, double rate);
117 XBT_ATTRIB_DEPRECATED_v330("Please use Mailbox::iprobe()") XBT_PUBLIC simgrid::kernel::activity::ActivityImplPtr
118 simcall_comm_iprobe(smx_mailbox_t mbox, int type,
119 bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*), void* data);
121 XBT_ATTRIB_DEPRECATED_v330("Please use a CommImpl*[] for first parameter") XBT_PUBLIC
122 unsigned int simcall_comm_waitany(simgrid::kernel::activity::ActivityImplPtr comms[], size_t count, double timeout);
123 XBT_PUBLIC ssize_t simcall_comm_waitany(simgrid::kernel::activity::CommImpl* comms[], size_t count, double timeout);
124 XBT_PUBLIC void simcall_comm_wait(simgrid::kernel::activity::ActivityImpl* comm, double timeout);
125 XBT_PUBLIC bool simcall_comm_test(simgrid::kernel::activity::ActivityImpl* comm);
126 XBT_ATTRIB_DEPRECATED_v330("Please use a CommImpl*[] for first parameter") XBT_PUBLIC
127 int simcall_comm_testany(simgrid::kernel::activity::ActivityImplPtr comms[], size_t count);
128 XBT_PUBLIC ssize_t simcall_comm_testany(simgrid::kernel::activity::CommImpl* comms[], size_t count);
130 XBT_ATTRIB_DEPRECATED_v330("Please use an ActivityImpl* for first parameter") inline void simcall_comm_wait(
131 const simgrid::kernel::activity::ActivityImplPtr& comm, double timeout)
133 simcall_comm_wait(comm.get(), timeout);
135 XBT_ATTRIB_DEPRECATED_v330("Please use an ActivityImpl* for first parameter") inline bool simcall_comm_test(
136 const simgrid::kernel::activity::ActivityImplPtr& comm)
138 return simcall_comm_test(comm.get());
142 /************************** Synchro simcalls **********************************/
144 XBT_ATTRIB_DEPRECATED_v330("Please use sg_mutex_init()") XBT_PUBLIC smx_mutex_t simcall_mutex_init();
145 XBT_ATTRIB_DEPRECATED_v331("Please use sg_mutex_lock()") XBT_PUBLIC void simcall_mutex_lock(smx_mutex_t mutex);
146 XBT_ATTRIB_DEPRECATED_v331("Please use sg_mutex_try_lock()") XBT_PUBLIC int simcall_mutex_trylock(smx_mutex_t mutex);
147 XBT_ATTRIB_DEPRECATED_v331("Please use sg_mutex_unlock()") XBT_PUBLIC void simcall_mutex_unlock(smx_mutex_t mutex);
149 XBT_ATTRIB_DEPRECATED_v330("Please use sg_cond_init()") XBT_PUBLIC smx_cond_t simcall_cond_init();
150 XBT_ATTRIB_DEPRECATED_v331("Please use sg_cond_wait()") XBT_PUBLIC
151 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex);
152 XBT_ATTRIB_DEPRECATED_v331("Please use sg_cond_wait_for()") XBT_PUBLIC
153 int simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double max_duration);
155 XBT_ATTRIB_DEPRECATED_v331("Please use sg_sem_acquire()") XBT_PUBLIC void simcall_sem_acquire(smx_sem_t sem);
156 XBT_ATTRIB_DEPRECATED_v331("Please use sg_sem_acquire_timeout()") XBT_PUBLIC
157 int simcall_sem_acquire_timeout(smx_sem_t sem, double max_duration);
160 /***************************** Io **************************************/
162 XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Io::wait_for()") XBT_PUBLIC simgrid::kernel::activity::State
163 simcall_io_wait(simgrid::kernel::activity::ActivityImpl* io, double timeout);
164 XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Io::wait_for()") XBT_PUBLIC simgrid::kernel::activity::State
165 simcall_io_wait(const simgrid::kernel::activity::ActivityImplPtr& io, double timeout);
166 XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Io::test()") XBT_PUBLIC
167 bool simcall_io_test(simgrid::kernel::activity::ActivityImpl* io);
168 XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Io::test()") XBT_PUBLIC
169 bool simcall_io_test(const simgrid::kernel::activity::ActivityImplPtr& io);
171 /************************** MC simcalls **********************************/
173 XBT_ATTRIB_DEPRECATED_v331("Please use MC_random()") XBT_PUBLIC int simcall_mc_random(int min, int max);