src/msg/msg_process.cpp

   1 /* Copyright (c) 2004-2020. 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 std::string instr_pid(simgrid::s4u::Actor const& proc)
  13 {
  14   return std::string(proc.get_name()) + "-" + std::to_string(proc.get_pid());
  15 }
  16
  17 /******************************** Process ************************************/
  18 /** @brief Creates and runs a new #msg_process_t.
  19  *
  20  * Does exactly the same as #MSG_process_create_with_arguments but without providing standard arguments
  21  * (@a argc, @a argv, @a start_time, @a kill_time).
  22  */
  23 msg_process_t MSG_process_create(const char *name, xbt_main_func_t code, void *data, msg_host_t host)
  24 {
  25   return MSG_process_create_with_environment(name == nullptr ? "" : name, code, data, host, 0, nullptr, nullptr);
  26 }
  27
  28 /** @brief Creates and runs a new process.
  29
  30  * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
  31  * the corresponding thread) is created, and put in the list of ready process.
  32  * @param name a name for the object. It is for user-level information and can be nullptr.
  33  * @param code is a function describing the behavior of the process.
  34  * @param data a pointer to any data one may want to attach to the new object.  It is for user-level information and
  35  *        can be nullptr. It can be retrieved with the function MSG_process_get_data().
  36  * @param host the location where the new process is executed.
  37  * @param argc first argument passed to @a code
  38  * @param argv second argument passed to @a code
  39  */
  40
  41 msg_process_t MSG_process_create_with_arguments(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
  42                                               int argc, char **argv)
  43 {
  44   return MSG_process_create_with_environment(name, code, data, host, argc, argv, nullptr);
  45 }
  46
  47 /**
  48  * @brief Creates and runs a new #msg_process_t.
  49
  50  * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
  51  * the corresponding thread) is created, and put in the list of ready process.
  52  * @param name a name for the object. It is for user-level information and can be nullptr.
  53  * @param code is a function describing the behavior of the process.
  54  * @param data a pointer to any data one may want to attach to the new object.  It is for user-level information and
  55  *        can be nullptr. It can be retrieved with the function MSG_process_get_data().
  56  * @param host the location where the new process is executed.
  57  * @param argc first argument passed to @a code
  58  * @param argv second argument passed to @a code. WARNING, these strings are freed by the SimGrid kernel when the
  59  *             process exits, so they cannot be static nor shared between several processes.
  60  * @param properties list a properties defined for this process
  61  * @see msg_process_t
  62  * @return The new corresponding object.
  63  */
  64 msg_process_t MSG_process_create_with_environment(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
  65                                                   int argc, char **argv, xbt_dict_t properties)
  66 {
  67   xbt_assert(host != nullptr, "Invalid parameters: host param must not be nullptr");
  68   sg_actor_t actor = sg_actor_init(std::move(name), host);
  69
  70   try {
  71     if (data != nullptr) {
  72       sg_actor_data_set(actor, data);
  73       xbt_dict_cursor_t cursor = nullptr;
  74       char* key;
  75       char* value;
  76       xbt_dict_foreach (properties, cursor, key, value)
  77         actor->set_property(key, value);
  78     }
  79     sg_actor_start(actor, code, argc, argv);
  80   } catch (simgrid::HostFailureException const&) {
  81     xbt_die("Could not launch a new process on failed host %s.", host->get_cname());
  82   }
  83
  84   xbt_dict_free(&properties);
  85   for (int i = 0; i != argc; ++i)
  86     xbt_free(argv[i]);
  87   xbt_free(argv);
  88
  89   simgrid::s4u::this_actor::yield();
  90   return actor;
  91 }
  92
  93 /** @brief Sets a cleanup function to be called to free the userdata of a process when a process is destroyed.
  94  * @param data_cleanup a cleanup function for the userdata of a process, or nullptr to call no function
  95  */
  96 XBT_PUBLIC void MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup)
  97 {
  98   msg_global->process_data_cleanup = data_cleanup;
  99 }
 100
 101 /** @brief returns a list of all currently existing processes */
 102 xbt_dynar_t MSG_processes_as_dynar() {
 103   xbt_dynar_t res = xbt_dynar_new(sizeof(smx_actor_t), nullptr);
 104   for (auto const& kv : simix_global->process_list) {
 105     smx_actor_t actor = kv.second;
 106     xbt_dynar_push(res, &actor);
 107   }
 108   return res;
 109 }
 110
 111 /** @brief Add a function to the list of "on_exit" functions for the current process.
 112  *  The on_exit functions are the functions executed when your process is killed.
 113  *  You should use them to free the data used by your process.
 114  */
 115 void MSG_process_on_exit(int_f_int_pvoid_t fun, void* data)
 116 {
 117   simgrid::s4u::this_actor::on_exit([fun, data](bool failed) { fun(failed ? 1 /*FAILURE*/ : 0 /*SUCCESS*/, data); });
 118 }