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