1 /* Copyright (c) 2004-2019. 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/Exception.hpp"
8 #include "simgrid/s4u/Host.hpp"
9 #include "src/instr/instr_private.hpp"
10 #include "src/simix/ActorImpl.hpp"
11 #include "src/simix/smx_private.hpp"
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg, "Logging specific to MSG (process)");
15 std::string instr_pid(msg_process_t proc)
17 return std::string(proc->get_name()) + "-" + std::to_string(proc->get_pid());
20 /******************************** Process ************************************/
22 /** @brief Creates and runs a new #msg_process_t.
24 * Does exactly the same as #MSG_process_create_with_arguments but without providing standard arguments
25 * (@a argc, @a argv, @a start_time, @a kill_time).
27 msg_process_t MSG_process_create(const char *name, xbt_main_func_t code, void *data, msg_host_t host)
29 return MSG_process_create_with_environment(name == nullptr ? "" : name, code, data, host, 0, nullptr, nullptr);
32 /** @brief Creates and runs a new process.
34 * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
35 * the corresponding thread) is created, and put in the list of ready process.
36 * @param name a name for the object. It is for user-level information and can be nullptr.
37 * @param code is a function describing the behavior of the process.
38 * @param data a pointer to any data one may want to attach to the new object. It is for user-level information and
39 * can be nullptr. It can be retrieved with the function @ref MSG_process_get_data.
40 * @param host the location where the new process is executed.
41 * @param argc first argument passed to @a code
42 * @param argv second argument passed to @a code
45 msg_process_t MSG_process_create_with_arguments(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
46 int argc, char **argv)
48 return MSG_process_create_with_environment(name, code, data, host, argc, argv, nullptr);
52 * @brief Creates and runs a new #msg_process_t.
54 * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
55 * the corresponding thread) is created, and put in the list of ready process.
56 * @param name a name for the object. It is for user-level information and can be nullptr.
57 * @param code is a function describing the behavior of the process.
58 * @param data a pointer to any data one may want to attach to the new object. It is for user-level information and
59 * can be nullptr. It can be retrieved with the function @ref MSG_process_get_data.
60 * @param host the location where the new process is executed.
61 * @param argc first argument passed to @a code
62 * @param argv second argument passed to @a code. WARNING, these strings are freed by the SimGrid kernel when the
63 * process exits, so they cannot be static nor shared between several processes.
64 * @param properties list a properties defined for this process
66 * @return The new corresponding object.
68 msg_process_t MSG_process_create_with_environment(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
69 int argc, char **argv, xbt_dict_t properties)
71 xbt_assert(host != nullptr, "Invalid parameters: host param must not be nullptr");
73 simgrid::simix::ActorCode function;
75 function = simgrid::xbt::wrap_main(code, argc, static_cast<const char* const*>(argv));
77 std::unordered_map<std::string, std::string> props;
78 xbt_dict_cursor_t cursor = nullptr;
81 xbt_dict_foreach (properties, cursor, key, value)
83 xbt_dict_free(&properties);
85 smx_actor_t self = SIMIX_process_self();
86 smx_actor_t actor = nullptr;
88 actor = simgrid::simix::simcall([name, function, data, host, &props, self] {
89 return simgrid::kernel::actor::ActorImpl::create(std::move(name), std::move(function), data, host, &props, self)
92 } catch (simgrid::HostFailureException const&) {
93 xbt_die("Could not create a new process on failed host %s.", host->get_cname());
96 for (int i = 0; i != argc; ++i)
100 if (actor == nullptr)
104 return actor->ciface();
107 /** @brief Returns the user data of a process.
109 * This function checks whether @a process is a valid pointer and returns the user data associated to this process.
111 void* MSG_process_get_data(msg_process_t process)
113 xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
115 /* get from SIMIX the MSG process data, and then the user data */
116 return process->get_impl()->get_user_data();
119 /** @brief Sets the user data of a process.
121 * This function checks whether @a process is a valid pointer and sets the user data associated to this process.
123 msg_error_t MSG_process_set_data(msg_process_t process, void *data)
125 xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
127 process->get_impl()->set_user_data(data);
132 /** @brief Sets a cleanup function to be called to free the userdata of a process when a process is destroyed.
133 * @param data_cleanup a cleanup function for the userdata of a process, or nullptr to call no function
135 XBT_PUBLIC void MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup)
137 msg_global->process_data_cleanup = data_cleanup;
140 /** @brief returns a list of all currently existing processes */
141 xbt_dynar_t MSG_processes_as_dynar() {
142 xbt_dynar_t res = xbt_dynar_new(sizeof(smx_actor_t), nullptr);
143 for (auto const& kv : simix_global->process_list) {
144 smx_actor_t actor = kv.second;
145 xbt_dynar_push(res, &actor);
150 /** @brief Return the current number MSG processes. */
151 int MSG_process_get_number()
153 return SIMIX_process_count();
156 /** @brief Return the PID of the current process.
158 * This function returns the PID of the currently running #msg_process_t.
160 int MSG_process_self_PID()
162 smx_actor_t self = SIMIX_process_self();
163 return self == nullptr ? 0 : self->get_pid();
166 /** @brief Return the PPID of the current process.
168 * This function returns the PID of the parent of the currently running #msg_process_t.
170 int MSG_process_self_PPID()
172 return MSG_process_get_PPID(MSG_process_self());
175 /** @brief Return the name of the current process. */
176 const char* MSG_process_self_name()
178 return SIMIX_process_self_get_name();
181 /** @brief Return the current process.
183 * This function returns the currently running #msg_process_t.
185 msg_process_t MSG_process_self()
187 return SIMIX_process_self()->ciface();
190 smx_context_t MSG_process_get_smx_ctx(msg_process_t process) { // deprecated -- smx_context_t should die afterward
191 return process->get_impl()->context_;
193 /** @brief Add a function to the list of "on_exit" functions for the current process.
194 * The on_exit functions are the functions executed when your process is killed.
195 * You should use them to free the data used by your process.
197 void MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void *data) {
198 simgrid::s4u::this_actor::on_exit([fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
201 /** @brief Take an extra reference on that process to prevent it to be garbage-collected */
202 XBT_PUBLIC void MSG_process_ref(msg_process_t process)
204 intrusive_ptr_add_ref(process);
206 /** @brief Release a reference on that process so that it can get be garbage-collected */
207 XBT_PUBLIC void MSG_process_unref(msg_process_t process)
209 intrusive_ptr_release(process);