Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
16311deb6325a306971392e5d2464ab4f9319f1b
[simgrid.git] / src / msg / msg_process.cpp
1 /* Copyright (c) 2004-2018. The SimGrid Team. All rights reserved.          */
2
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. */
5
6 #include "msg_private.hpp"
7 #include "simgrid/s4u/Host.hpp"
8 #include "src/instr/instr_private.hpp"
9 #include "src/simix/ActorImpl.hpp"
10 #include "src/simix/smx_private.hpp"
11
12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg, "Logging specific to MSG (process)");
13
14 std::string instr_pid(msg_process_t proc)
15 {
16   return std::string(proc->get_cname()) + "-" + std::to_string(proc->get_pid());
17 }
18
19 /** @addtogroup m_process_management
20  *
21  *  Processes (#msg_process_t) are independent agents that can do stuff on their own. They are in charge of executing
22  *  your code interacting with the simulated world.
23  *  A process may be defined as a <em>code</em> with some <em>private data</em>.
24  *  Processes must be located on <em>hosts</em> (#msg_host_t), and they exchange data by sending tasks (#msg_task_t)
25  *  that are similar to envelops containing data.
26  */
27
28 /******************************** Process ************************************/
29 /**
30  * @brief Cleans the MSG data of an actor
31  * @param smx_actor a SIMIX actor
32  */
33 void MSG_process_cleanup_from_SIMIX(smx_actor_t smx_actor)
34 {
35   if (TRACE_actor_is_enabled())
36     simgrid::instr::Container::by_name(instr_pid(smx_actor->ciface()))->remove_from_parent();
37
38   // free the data if a function was provided
39   void* userdata = smx_actor->get_user_data();
40   if (userdata && msg_global->process_data_cleanup) {
41     msg_global->process_data_cleanup(userdata);
42   }
43
44   SIMIX_process_cleanup(smx_actor);
45 }
46
47 /* This function creates a MSG process. It has the prototype enforced by SIMIX_function_register_process_create */
48 smx_actor_t MSG_process_create_from_SIMIX(std::string name, simgrid::simix::ActorCode code, void* data, sg_host_t host,
49                                           std::unordered_map<std::string, std::string>* properties,
50                                           smx_actor_t /*parent_process*/)
51 {
52   msg_process_t p = MSG_process_create_from_stdfunc(name, std::move(code), data, host, properties);
53   return p == nullptr ? nullptr : p->get_impl();
54 }
55
56 /** @ingroup m_process_management
57  * @brief Creates and runs a new #msg_process_t.
58  *
59  * Does exactly the same as #MSG_process_create_with_arguments but without providing standard arguments
60  * (@a argc, @a argv, @a start_time, @a kill_time).
61  * @sa MSG_process_create_with_arguments
62  */
63 msg_process_t MSG_process_create(const char *name, xbt_main_func_t code, void *data, msg_host_t host)
64 {
65   return MSG_process_create_with_environment(name == nullptr ? "" : name, code, data, host, 0, nullptr, nullptr);
66 }
67
68 /** @ingroup m_process_management
69  * @brief Creates and runs a new #msg_process_t.
70
71  * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
72  * the corresponding thread) is created, and put in the list of ready process.
73  * @param name a name for the object. It is for user-level information and can be nullptr.
74  * @param code is a function describing the behavior of the process. It should then only use functions described
75  * in @ref m_process_management (to create a new #msg_process_t for example),
76    in @ref m_host_management (only the read-only functions i.e. whose name contains the word get),
77    in @ref m_task_management (to create or destroy some #msg_task_t for example) and
78    in @ref msg_task_usage (to handle file transfers and task processing).
79  * @param data a pointer to any data one may want to attach to the new object.  It is for user-level information and
80  *        can be nullptr. It can be retrieved with the function @ref MSG_process_get_data.
81  * @param host the location where the new process is executed.
82  * @param argc first argument passed to @a code
83  * @param argv second argument passed to @a code
84  * @see msg_process_t
85  * @return The new corresponding object.
86  */
87
88 msg_process_t MSG_process_create_with_arguments(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
89                                               int argc, char **argv)
90 {
91   return MSG_process_create_with_environment(name, code, data, host, argc, argv, nullptr);
92 }
93
94 /** @ingroup m_process_management
95  * @brief Creates and runs a new #msg_process_t.
96
97  * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
98  * the corresponding thread) is created, and put in the list of ready process.
99  * @param name a name for the object. It is for user-level information and can be nullptr.
100  * @param code is a function describing the behavior of the process. It should then only use functions described
101  * in @ref m_process_management (to create a new #msg_process_t for example),
102    in @ref m_host_management (only the read-only functions i.e. whose name contains the word get),
103    in @ref m_task_management (to create or destroy some #msg_task_t for example) and
104    in @ref msg_task_usage (to handle file transfers and task processing).
105  * @param data a pointer to any data one may want to attach to the new object.  It is for user-level information and
106  *        can be nullptr. It can be retrieved with the function @ref MSG_process_get_data.
107  * @param host the location where the new process is executed.
108  * @param argc first argument passed to @a code
109  * @param argv second argument passed to @a code. WARNING, these strings are freed by the SimGrid kernel when the
110  *             process exits, so they cannot be static nor shared between several processes.
111  * @param properties list a properties defined for this process
112  * @see msg_process_t
113  * @return The new corresponding object.
114  */
115 msg_process_t MSG_process_create_with_environment(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
116                                                   int argc, char **argv, xbt_dict_t properties)
117 {
118   simgrid::simix::ActorCode function;
119   if (code)
120     function = simgrid::xbt::wrap_main(code, argc, static_cast<const char* const*>(argv));
121
122   std::unordered_map<std::string, std::string> props;
123   xbt_dict_cursor_t cursor = nullptr;
124   char* key;
125   char* value;
126   xbt_dict_foreach (properties, cursor, key, value)
127     props[key] = value;
128   xbt_dict_free(&properties);
129
130   msg_process_t res = MSG_process_create_from_stdfunc(name, std::move(function), data, host, &props);
131   for (int i = 0; i != argc; ++i)
132     xbt_free(argv[i]);
133   xbt_free(argv);
134   return res;
135 }
136
137 msg_process_t MSG_process_create_from_stdfunc(std::string name, simgrid::simix::ActorCode code, void* data,
138                                               msg_host_t host, std::unordered_map<std::string, std::string>* properties)
139 {
140   xbt_assert(code != nullptr && host != nullptr, "Invalid parameters: host and code params must not be nullptr");
141
142   smx_actor_t process = simcall_process_create(name, std::move(code), data, host, properties);
143
144   if (process == nullptr)
145     return nullptr;
146
147   MSG_process_yield();
148   return process->ciface();
149 }
150
151 /* Become a process in the simulation
152  *
153  * Currently this can only be called by the main thread (once) and only work with some thread factories
154  * (currently ThreadContextFactory).
155  *
156  * In the future, it might be extended in order to attach other threads created by a third party library.
157  */
158 msg_process_t MSG_process_attach(const char *name, void *data, msg_host_t host, xbt_dict_t properties)
159 {
160   xbt_assert(host != nullptr, "Invalid parameters: host and code params must not be nullptr");
161   std::unordered_map<std::string, std::string> props;
162   xbt_dict_cursor_t cursor = nullptr;
163   char* key;
164   char* value;
165   xbt_dict_foreach (properties, cursor, key, value)
166     props[key] = value;
167   xbt_dict_free(&properties);
168
169   /* Let's create the process: SIMIX may decide to start it right now, even before returning the flow control to us */
170   smx_actor_t process = SIMIX_process_attach(name, data, host->get_cname(), &props, nullptr);
171   if (not process)
172     xbt_die("Could not attach");
173   MSG_process_yield();
174   return process->ciface();
175 }
176
177 /** Detach a process attached with `MSG_process_attach()`
178  *
179  *  This is called when the current process has finished its job.
180  *  Used in the main thread, it waits for the simulation to finish before  returning. When it returns, the other
181  *  simulated processes and the maestro are destroyed.
182  */
183 void MSG_process_detach()
184 {
185   SIMIX_process_detach();
186 }
187
188 /** @ingroup m_process_management
189  * @brief Returns the user data of a process.
190  *
191  * This function checks whether @a process is a valid pointer and returns the user data associated to this process.
192  */
193 void* MSG_process_get_data(msg_process_t process)
194 {
195   xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
196
197   /* get from SIMIX the MSG process data, and then the user data */
198   return process->get_impl()->get_user_data();
199 }
200
201 /** @ingroup m_process_management
202  * @brief Sets the user data of a process.
203  *
204  * This function checks whether @a process is a valid pointer and sets the user data associated to this process.
205  */
206 msg_error_t MSG_process_set_data(msg_process_t process, void *data)
207 {
208   xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
209
210   process->get_impl()->set_user_data(data);
211
212   return MSG_OK;
213 }
214
215 /** @ingroup m_process_management
216  * @brief Sets a cleanup function to be called to free the userdata of a process when a process is destroyed.
217  * @param data_cleanup a cleanup function for the userdata of a process, or nullptr to call no function
218  */
219 XBT_PUBLIC void MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup)
220 {
221   msg_global->process_data_cleanup = data_cleanup;
222 }
223
224 /** @brief returns a list of all currently existing processes */
225 xbt_dynar_t MSG_processes_as_dynar() {
226   xbt_dynar_t res = xbt_dynar_new(sizeof(smx_actor_t), nullptr);
227   for (auto const& kv : simix_global->process_list) {
228     smx_actor_t actor = kv.second;
229     xbt_dynar_push(res, &actor);
230   }
231   return res;
232 }
233
234 /** @brief Return the current number MSG processes. */
235 int MSG_process_get_number()
236 {
237   return SIMIX_process_count();
238 }
239
240 /** @ingroup m_process_management
241  * @brief Return the PID of the current process.
242  *
243  * This function returns the PID of the currently running #msg_process_t.
244  */
245 int MSG_process_self_PID()
246 {
247   smx_actor_t self = SIMIX_process_self();
248   return self == nullptr ? 0 : self->pid_;
249 }
250
251 /** @ingroup m_process_management
252  * @brief Return the PPID of the current process.
253  *
254  * This function returns the PID of the parent of the currently running #msg_process_t.
255  */
256 int MSG_process_self_PPID()
257 {
258   return MSG_process_get_PPID(MSG_process_self());
259 }
260
261 /** @ingroup m_process_management
262  * @brief Return the name of the current process.
263  */
264 const char* MSG_process_self_name()
265 {
266   return SIMIX_process_self_get_name();
267 }
268
269 /** @ingroup m_process_management
270  * @brief Return the current process.
271  *
272  * This function returns the currently running #msg_process_t.
273  */
274 msg_process_t MSG_process_self()
275 {
276   return SIMIX_process_self()->ciface();
277 }
278
279 smx_context_t MSG_process_get_smx_ctx(msg_process_t process) { // deprecated -- smx_context_t should die afterward
280   return process->get_impl()->context_;
281 }
282 /**
283  * @ingroup m_process_management
284  * @brief Add a function to the list of "on_exit" functions for the current process.
285  * The on_exit functions are the functions executed when your process is killed.
286  * You should use them to free the data used by your process.
287  */
288 void MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void *data) {
289   simgrid::s4u::this_actor::on_exit([fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
290 }
291
292 /** @ingroup m_process_management
293  * @brief Take an extra reference on that process to prevent it to be garbage-collected
294  */
295 XBT_PUBLIC void MSG_process_ref(msg_process_t process)
296 {
297   intrusive_ptr_add_ref(process);
298 }
299 /** @ingroup m_process_management
300  * @brief Release a reference on that process so that it can get be garbage-collected
301  */
302 XBT_PUBLIC void MSG_process_unref(msg_process_t process)
303 {
304   intrusive_ptr_release(process);
305 }