Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Objectify MSG task send
[simgrid.git] / src / msg / msg_process.cpp
1 /* Copyright (c) 2004-2019. 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/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"
12
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg, "Logging specific to MSG (process)");
14
15 std::string instr_pid(msg_process_t proc)
16 {
17   return std::string(proc->get_name()) + "-" + std::to_string(proc->get_pid());
18 }
19
20 /******************************** Process ************************************/
21
22 /** @brief Creates and runs a new #msg_process_t.
23  *
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).
26  */
27 msg_process_t MSG_process_create(const char *name, xbt_main_func_t code, void *data, msg_host_t host)
28 {
29   return MSG_process_create_with_environment(name == nullptr ? "" : name, code, data, host, 0, nullptr, nullptr);
30 }
31
32 /** @brief Creates and runs a new process.
33
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
43  */
44
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)
47 {
48   return MSG_process_create_with_environment(name, code, data, host, argc, argv, nullptr);
49 }
50
51 /**
52  * @brief Creates and runs a new #msg_process_t.
53
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
65  * @see msg_process_t
66  * @return The new corresponding object.
67  */
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)
70 {
71   xbt_assert(host != nullptr, "Invalid parameters: host param must not be nullptr");
72
73   simgrid::simix::ActorCode function;
74   if (code)
75     function = simgrid::xbt::wrap_main(code, argc, static_cast<const char* const*>(argv));
76
77   std::unordered_map<std::string, std::string> props;
78   xbt_dict_cursor_t cursor = nullptr;
79   char* key;
80   char* value;
81   xbt_dict_foreach (properties, cursor, key, value)
82     props[key] = value;
83   xbt_dict_free(&properties);
84
85   smx_actor_t self    = SIMIX_process_self();
86   smx_actor_t actor   = nullptr;
87   try {
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)
90           .get();
91     });
92   } catch (simgrid::HostFailureException const&) {
93     xbt_die("Could not create a new process on failed host %s.", host->get_cname());
94   }
95
96   for (int i = 0; i != argc; ++i)
97     xbt_free(argv[i]);
98   xbt_free(argv);
99
100   if (actor == nullptr)
101     return nullptr;
102
103   MSG_process_yield();
104   return actor->ciface();
105 }
106
107 /** @brief Returns the user data of a process.
108  *
109  * This function checks whether @a process is a valid pointer and returns the user data associated to this process.
110  */
111 void* MSG_process_get_data(msg_process_t process)
112 {
113   xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
114
115   /* get from SIMIX the MSG process data, and then the user data */
116   return process->get_impl()->get_user_data();
117 }
118
119 /** @brief Sets the user data of a process.
120  *
121  * This function checks whether @a process is a valid pointer and sets the user data associated to this process.
122  */
123 msg_error_t MSG_process_set_data(msg_process_t process, void *data)
124 {
125   xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
126
127   process->get_impl()->set_user_data(data);
128
129   return MSG_OK;
130 }
131
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
134  */
135 XBT_PUBLIC void MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup)
136 {
137   msg_global->process_data_cleanup = data_cleanup;
138 }
139
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);
146   }
147   return res;
148 }
149
150 /** @brief Return the current number MSG processes. */
151 int MSG_process_get_number()
152 {
153   return SIMIX_process_count();
154 }
155
156 /** @brief Return the PID of the current process.
157  *
158  * This function returns the PID of the currently running #msg_process_t.
159  */
160 int MSG_process_self_PID()
161 {
162   smx_actor_t self = SIMIX_process_self();
163   return self == nullptr ? 0 : self->get_pid();
164 }
165
166 /** @brief Return the PPID of the current process.
167  *
168  * This function returns the PID of the parent of the currently running #msg_process_t.
169  */
170 int MSG_process_self_PPID()
171 {
172   return MSG_process_get_PPID(MSG_process_self());
173 }
174
175 /** @brief Return the name of the current process. */
176 const char* MSG_process_self_name()
177 {
178   return SIMIX_process_self_get_name();
179 }
180
181 /** @brief Return the current process.
182  *
183  * This function returns the currently running #msg_process_t.
184  */
185 msg_process_t MSG_process_self()
186 {
187   return SIMIX_process_self()->ciface();
188 }
189
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_;
192 }
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.
196  */
197 void MSG_process_on_exit(int_f_int_pvoid_t fun, void* data)
198 {
199   simgrid::s4u::this_actor::on_exit(
200       [fun, data](bool failed) { fun(failed ? SMX_EXIT_FAILURE : SMX_EXIT_SUCCESS, data); });
201 }
202
203 /** @brief Take an extra reference on that process to prevent it to be garbage-collected */
204 XBT_PUBLIC void MSG_process_ref(msg_process_t process)
205 {
206   intrusive_ptr_add_ref(process);
207 }
208 /** @brief Release a reference on that process so that it can get be garbage-collected */
209 XBT_PUBLIC void MSG_process_unref(msg_process_t process)
210 {
211   intrusive_ptr_release(process);
212 }