1 /* Copyright (c) 2004-2018. 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 #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"
12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg, "Logging specific to MSG (process)");
14 std::string instr_pid(msg_process_t proc)
16 return std::string(proc->get_cname()) + "-" + std::to_string(proc->get_pid());
19 /******************************** Process ************************************/
21 /** @brief Creates and runs a new #msg_process_t.
23 * Does exactly the same as #MSG_process_create_with_arguments but without providing standard arguments
24 * (@a argc, @a argv, @a start_time, @a kill_time).
26 msg_process_t MSG_process_create(const char *name, xbt_main_func_t code, void *data, msg_host_t host)
28 return MSG_process_create_with_environment(name == nullptr ? "" : name, code, data, host, 0, nullptr, nullptr);
31 /** @brief Creates and runs a new process.
33 * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
34 * the corresponding thread) is created, and put in the list of ready process.
35 * @param name a name for the object. It is for user-level information and can be nullptr.
36 * @param code is a function describing the behavior of the process.
37 * @param data a pointer to any data one may want to attach to the new object. It is for user-level information and
38 * can be nullptr. It can be retrieved with the function @ref MSG_process_get_data.
39 * @param host the location where the new process is executed.
40 * @param argc first argument passed to @a code
41 * @param argv second argument passed to @a code
44 msg_process_t MSG_process_create_with_arguments(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
45 int argc, char **argv)
47 return MSG_process_create_with_environment(name, code, data, host, argc, argv, nullptr);
51 * @brief Creates and runs a new #msg_process_t.
53 * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
54 * the corresponding thread) is created, and put in the list of ready process.
55 * @param name a name for the object. It is for user-level information and can be nullptr.
56 * @param code is a function describing the behavior of the process.
57 * @param data a pointer to any data one may want to attach to the new object. It is for user-level information and
58 * can be nullptr. It can be retrieved with the function @ref MSG_process_get_data.
59 * @param host the location where the new process is executed.
60 * @param argc first argument passed to @a code
61 * @param argv second argument passed to @a code. WARNING, these strings are freed by the SimGrid kernel when the
62 * process exits, so they cannot be static nor shared between several processes.
63 * @param properties list a properties defined for this process
65 * @return The new corresponding object.
67 msg_process_t MSG_process_create_with_environment(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
68 int argc, char **argv, xbt_dict_t properties)
70 xbt_assert(host != nullptr, "Invalid parameters: host param must not be nullptr");
72 simgrid::simix::ActorCode function;
74 function = simgrid::xbt::wrap_main(code, argc, static_cast<const char* const*>(argv));
76 std::unordered_map<std::string, std::string> props;
77 xbt_dict_cursor_t cursor = nullptr;
80 xbt_dict_foreach (properties, cursor, key, value)
82 xbt_dict_free(&properties);
84 smx_actor_t process = simcall_process_create(name, std::move(function), data, host, &props);
85 for (int i = 0; i != argc; ++i)
89 if (process == nullptr)
93 return process->ciface();
96 /* Become a process in the simulation
98 * Currently this can only be called by the main thread (once) and only work with some thread factories
99 * (currently ThreadContextFactory).
101 * In the future, it might be extended in order to attach other threads created by a third party library.
103 msg_process_t MSG_process_attach(const char *name, void *data, msg_host_t host, xbt_dict_t properties)
105 xbt_assert(host != nullptr, "Invalid parameters: host and code params must not be nullptr");
106 std::unordered_map<std::string, std::string> props;
107 xbt_dict_cursor_t cursor = nullptr;
110 xbt_dict_foreach (properties, cursor, key, value)
112 xbt_dict_free(&properties);
114 /* Let's create the process: SIMIX may decide to start it right now, even before returning the flow control to us */
115 smx_actor_t process = SIMIX_process_attach(name, data, host->get_cname(), &props, nullptr);
117 xbt_die("Could not attach");
119 return process->ciface();
122 /** @brief Detach a process attached with `MSG_process_attach()`
124 * This is called when the current process has finished its job.
125 * Used in the main thread, it waits for the simulation to finish before returning. When it returns, the other
126 * simulated processes and the maestro are destroyed.
128 void MSG_process_detach()
130 SIMIX_process_detach();
133 /** @brief Returns the user data of a process.
135 * This function checks whether @a process is a valid pointer and returns the user data associated to this process.
137 void* MSG_process_get_data(msg_process_t process)
139 xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
141 /* get from SIMIX the MSG process data, and then the user data */
142 return process->get_impl()->get_user_data();
145 /** @brief Sets the user data of a process.
147 * This function checks whether @a process is a valid pointer and sets the user data associated to this process.
149 msg_error_t MSG_process_set_data(msg_process_t process, void *data)
151 xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
153 process->get_impl()->set_user_data(data);
158 /** @brief Sets a cleanup function to be called to free the userdata of a process when a process is destroyed.
159 * @param data_cleanup a cleanup function for the userdata of a process, or nullptr to call no function
161 XBT_PUBLIC void MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup)
163 msg_global->process_data_cleanup = data_cleanup;
166 /** @brief returns a list of all currently existing processes */
167 xbt_dynar_t MSG_processes_as_dynar() {
168 xbt_dynar_t res = xbt_dynar_new(sizeof(smx_actor_t), nullptr);
169 for (auto const& kv : simix_global->process_list) {
170 smx_actor_t actor = kv.second;
171 xbt_dynar_push(res, &actor);
176 /** @brief Return the current number MSG processes. */
177 int MSG_process_get_number()
179 return SIMIX_process_count();
182 /** @brief Return the PID of the current process.
184 * This function returns the PID of the currently running #msg_process_t.
186 int MSG_process_self_PID()
188 smx_actor_t self = SIMIX_process_self();
189 return self == nullptr ? 0 : self->pid_;
192 /** @brief Return the PPID of the current process.
194 * This function returns the PID of the parent of the currently running #msg_process_t.
196 int MSG_process_self_PPID()
198 return MSG_process_get_PPID(MSG_process_self());
201 /** @brief Return the name of the current process. */
202 const char* MSG_process_self_name()
204 return SIMIX_process_self_get_name();
207 /** @brief Return the current process.
209 * This function returns the currently running #msg_process_t.
211 msg_process_t MSG_process_self()
213 return SIMIX_process_self()->ciface();
216 smx_context_t MSG_process_get_smx_ctx(msg_process_t process) { // deprecated -- smx_context_t should die afterward
217 return process->get_impl()->context_;
219 /** @brief Add a function to the list of "on_exit" functions for the current process.
220 * The on_exit functions are the functions executed when your process is killed.
221 * You should use them to free the data used by your process.
223 void MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void *data) {
224 simgrid::s4u::this_actor::on_exit([fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
227 /** @brief Take an extra reference on that process to prevent it to be garbage-collected */
228 XBT_PUBLIC void MSG_process_ref(msg_process_t process)
230 intrusive_ptr_add_ref(process);
232 /** @brief Release a reference on that process so that it can get be garbage-collected */
233 XBT_PUBLIC void MSG_process_unref(msg_process_t process)
235 intrusive_ptr_release(process);