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 /** @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   xbt_assert(host != nullptr, "Invalid parameters: host param must not be nullptr");
  71   simgrid::simix::ActorCode function;
  72   if (code)
  73     function = simgrid::xbt::wrap_main(code, argc, static_cast<const char* const*>(argv));
  74
  75   std::unordered_map<std::string, std::string> props;
  76   xbt_dict_cursor_t cursor = nullptr;
  77   char* key;
  78   char* value;
  79   xbt_dict_foreach (properties, cursor, key, value)
  80     props[key] = value;
  81   xbt_dict_free(&properties);
  82
  83   simgrid::s4u::ActorPtr actor = nullptr;
  84   try {
  85     actor = simgrid::s4u::Actor::init(std::move(name), host);
  86     actor->extension<simgrid::msg::ActorUserData>()->set_user_data(data);
  87     actor->start(std::move(function));
  88   } catch (simgrid::HostFailureException const&) {
  89     xbt_die("Could not create a new process on failed host %s.", host->get_cname());
  90   }
  91
  92   for (int i = 0; i != argc; ++i)
  93     xbt_free(argv[i]);
  94   xbt_free(argv);
  95
  96   if (actor == nullptr)
  97     return nullptr;
  98
  99   MSG_process_yield();
 100   return actor.get();
 101 }
 102
 103 /** @brief Returns the user data of a process.
 104  *
 105  * This function checks whether @a process is a valid pointer and returns the user data associated to this process.
 106  */
 107 void* MSG_process_get_data(msg_process_t process)
 108 {
 109   xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
 110
 111   /* get from SIMIX the MSG process data, and then the user data */
 112   return process->extension<simgrid::msg::ActorUserData>()->get_user_data();
 113 }
 114
 115 /** @brief Sets the user data of a process.
 116  *
 117  * This function checks whether @a process is a valid pointer and sets the user data associated to this process.
 118  */
 119 msg_error_t MSG_process_set_data(msg_process_t process, void *data)
 120 {
 121   xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
 122   process->extension<simgrid::msg::ActorUserData>()->set_user_data(data);
 123
 124   return MSG_OK;
 125 }
 126
 127 /** @brief Sets a cleanup function to be called to free the userdata of a process when a process is destroyed.
 128  * @param data_cleanup a cleanup function for the userdata of a process, or nullptr to call no function
 129  */
 130 XBT_PUBLIC void MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup)
 131 {
 132   msg_global->process_data_cleanup = data_cleanup;
 133 }
 134
 135 /** @brief returns a list of all currently existing processes */
 136 xbt_dynar_t MSG_processes_as_dynar() {
 137   xbt_dynar_t res = xbt_dynar_new(sizeof(smx_actor_t), nullptr);
 138   for (auto const& kv : simix_global->process_list) {
 139     smx_actor_t actor = kv.second;
 140     xbt_dynar_push(res, &actor);
 141   }
 142   return res;
 143 }
 144
 145 /** @brief Return the current number MSG processes. */
 146 int MSG_process_get_number()
 147 {
 148   return SIMIX_process_count();
 149 }
 150
 151 /** @brief Return the PID of the current process.
 152  *
 153  * This function returns the PID of the currently running #msg_process_t.
 154  */
 155 int MSG_process_self_PID()
 156 {
 157   smx_actor_t self = SIMIX_process_self();
 158   return self == nullptr ? 0 : self->get_pid();
 159 }
 160
 161 /** @brief Return the PPID of the current process.
 162  *
 163  * This function returns the PID of the parent of the currently running #msg_process_t.
 164  */
 165 int MSG_process_self_PPID()
 166 {
 167   return MSG_process_get_PPID(MSG_process_self());
 168 }
 169
 170 /** @brief Return the name of the current process. */
 171 const char* MSG_process_self_name()
 172 {
 173   return SIMIX_process_self_get_name();
 174 }
 175
 176 /** @brief Return the current process.
 177  *
 178  * This function returns the currently running #msg_process_t.
 179  */
 180 msg_process_t MSG_process_self()
 181 {
 182   return SIMIX_process_self()->ciface();
 183 }
 184
 185 smx_context_t MSG_process_get_smx_ctx(msg_process_t process) { // deprecated -- smx_context_t should die afterward
 186   return process->get_impl()->context_;
 187 }
 188 /** @brief Add a function to the list of "on_exit" functions for the current process.
 189  *  The on_exit functions are the functions executed when your process is killed.
 190  *  You should use them to free the data used by your process.
 191  */
 192 void MSG_process_on_exit(int_f_int_pvoid_t fun, void* data)
 193 {
 194   simgrid::s4u::this_actor::on_exit(
 195       [fun, data](bool failed) { fun(failed ? SMX_EXIT_FAILURE : SMX_EXIT_SUCCESS, data); });
 196 }
 197
 198 /** @brief Take an extra reference on that process to prevent it to be garbage-collected */
 199 XBT_PUBLIC void MSG_process_ref(msg_process_t process)
 200 {
 201   intrusive_ptr_add_ref(process);
 202 }
 203 /** @brief Release a reference on that process so that it can get be garbage-collected */
 204 XBT_PUBLIC void MSG_process_unref(msg_process_t process)
 205 {
 206   intrusive_ptr_release(process);
 207 }