Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
fix https://framagit.org/simgrid/simgrid/issues/30
[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/smx_private.hpp"
11
12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg, "Logging specific to MSG (process)");
13
14 std::string instr_pid(simgrid::s4u::Actor const& proc)
15 {
16   return std::string(proc.get_name()) + "-" + std::to_string(proc.get_pid());
17 }
18
19 void MSG_process_userdata_init()
20 {
21   if (not msg_global)
22     msg_global = new MSG_Global_t();
23
24   if (not simgrid::msg::ActorUserData::EXTENSION_ID.valid())
25     simgrid::msg::ActorUserData::EXTENSION_ID = simgrid::s4u::Actor::extension_create<simgrid::msg::ActorUserData>();
26   simgrid::s4u::Actor::on_creation.connect([](simgrid::s4u::Actor& actor) {
27     XBT_DEBUG("creating the extension to store user data");
28     actor.extension_set(new simgrid::msg::ActorUserData());
29   });
30
31   simgrid::s4u::Actor::on_destruction.connect([](simgrid::s4u::Actor const& actor) {
32     // free the data if a function was provided
33     auto extension = actor.extension<simgrid::msg::ActorUserData>();
34     void* userdata = extension ? extension->get_user_data() : nullptr;
35     if (userdata && msg_global->process_data_cleanup) {
36       msg_global->process_data_cleanup(userdata);
37     }
38   });
39 }
40
41 /******************************** Process ************************************/
42 /** @brief Creates and runs a new #msg_process_t.
43  *
44  * Does exactly the same as #MSG_process_create_with_arguments but without providing standard arguments
45  * (@a argc, @a argv, @a start_time, @a kill_time).
46  */
47 msg_process_t MSG_process_create(const char *name, xbt_main_func_t code, void *data, msg_host_t host)
48 {
49   return MSG_process_create_with_environment(name == nullptr ? "" : name, code, data, host, 0, nullptr, nullptr);
50 }
51
52 /** @brief Creates and runs a new process.
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
63  */
64
65 msg_process_t MSG_process_create_with_arguments(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
66                                               int argc, char **argv)
67 {
68   return MSG_process_create_with_environment(name, code, data, host, argc, argv, nullptr);
69 }
70
71 /**
72  * @brief Creates and runs a new #msg_process_t.
73
74  * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
75  * the corresponding thread) is created, and put in the list of ready process.
76  * @param name a name for the object. It is for user-level information and can be nullptr.
77  * @param code is a function describing the behavior of the process.
78  * @param data a pointer to any data one may want to attach to the new object.  It is for user-level information and
79  *        can be nullptr. It can be retrieved with the function @ref MSG_process_get_data.
80  * @param host the location where the new process is executed.
81  * @param argc first argument passed to @a code
82  * @param argv second argument passed to @a code. WARNING, these strings are freed by the SimGrid kernel when the
83  *             process exits, so they cannot be static nor shared between several processes.
84  * @param properties list a properties defined for this process
85  * @see msg_process_t
86  * @return The new corresponding object.
87  */
88 msg_process_t MSG_process_create_with_environment(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
89                                                   int argc, char **argv, xbt_dict_t properties)
90 {
91   xbt_assert(host != nullptr, "Invalid parameters: host param must not be nullptr");
92   simgrid::simix::ActorCode function;
93   if (code)
94     function = simgrid::xbt::wrap_main(code, argc, static_cast<const char* const*>(argv));
95
96   simgrid::s4u::ActorPtr actor;
97
98   try {
99     if (data != nullptr) {
100       actor = simgrid::s4u::Actor::init(std::move(name), host);
101       actor->extension<simgrid::msg::ActorUserData>()->set_user_data(data);
102       xbt_dict_cursor_t cursor = nullptr;
103       char* key;
104       char* value;
105       xbt_dict_foreach (properties, cursor, key, value)
106         actor->set_property(key, value);
107       actor->start(std::move(function));
108     } else
109       actor = simgrid::s4u::Actor::create(std::move(name), host, std::move(function));
110   } catch (simgrid::HostFailureException const&) {
111     xbt_die("Could not launch a new process on failed host %s.", host->get_cname());
112   }
113
114   xbt_dict_free(&properties);
115   for (int i = 0; i != argc; ++i)
116     xbt_free(argv[i]);
117   xbt_free(argv);
118
119   simgrid::s4u::this_actor::yield();
120   return actor.get();
121 }
122
123 /** @brief Returns the user data of a process.
124  *
125  * This function checks whether @a process is a valid pointer and returns the user data associated to this process.
126  */
127 void* MSG_process_get_data(msg_process_t process)
128 {
129   xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
130
131   /* get from SIMIX the MSG process data, and then the user data */
132   return process->extension<simgrid::msg::ActorUserData>()->get_user_data();
133 }
134
135 /** @brief Sets the user data of a process.
136  *
137  * This function checks whether @a process is a valid pointer and sets the user data associated to this process.
138  */
139 msg_error_t MSG_process_set_data(msg_process_t process, void *data)
140 {
141   xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
142   process->extension<simgrid::msg::ActorUserData>()->set_user_data(data);
143
144   return MSG_OK;
145 }
146
147 /** @brief Sets a cleanup function to be called to free the userdata of a process when a process is destroyed.
148  * @param data_cleanup a cleanup function for the userdata of a process, or nullptr to call no function
149  */
150 XBT_PUBLIC void MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup)
151 {
152   msg_global->process_data_cleanup = data_cleanup;
153 }
154
155 /** @brief returns a list of all currently existing processes */
156 xbt_dynar_t MSG_processes_as_dynar() {
157   xbt_dynar_t res = xbt_dynar_new(sizeof(smx_actor_t), nullptr);
158   for (auto const& kv : simix_global->process_list) {
159     smx_actor_t actor = kv.second;
160     xbt_dynar_push(res, &actor);
161   }
162   return res;
163 }
164
165 /** @brief Return the current number MSG processes. */
166 int MSG_process_get_number()
167 {
168   return SIMIX_process_count();
169 }
170
171 /** @brief Add a function to the list of "on_exit" functions for the current process.
172  *  The on_exit functions are the functions executed when your process is killed.
173  *  You should use them to free the data used by your process.
174  */
175 void MSG_process_on_exit(int_f_int_pvoid_t fun, void* data)
176 {
177   simgrid::s4u::this_actor::on_exit(
178       [fun, data](bool failed) { fun(failed ? SMX_EXIT_FAILURE : SMX_EXIT_SUCCESS, data); });
179 }