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