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