1 /* Copyright (c) 2004-2019. The SimGrid Team. All rights reserved. */
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. */
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"
12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg, "Logging specific to MSG (process)");
14 std::string instr_pid(simgrid::s4u::Actor const& proc)
16 return std::string(proc.get_name()) + "-" + std::to_string(proc.get_pid());
19 /******************************** Process ************************************/
20 /** @brief Creates and runs a new #msg_process_t.
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).
25 msg_process_t MSG_process_create(const char *name, xbt_main_func_t code, void *data, msg_host_t host)
27 return MSG_process_create_with_environment(name == nullptr ? "" : name, code, data, host, 0, nullptr, nullptr);
30 /** @brief Creates and runs a new process.
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
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)
46 return MSG_process_create_with_environment(name, code, data, host, argc, argv, nullptr);
50 * @brief Creates and runs a new #msg_process_t.
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
64 * @return The new corresponding object.
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)
69 xbt_assert(host != nullptr, "Invalid parameters: host param must not be nullptr");
70 sg_actor_t actor = sg_actor_init(std::move(name), host);
73 if (data != nullptr) {
74 sg_actor_data_set(actor, data);
75 xbt_dict_cursor_t cursor = nullptr;
78 xbt_dict_foreach (properties, cursor, key, value)
79 actor->set_property(key, value);
81 sg_actor_start(actor, code, argc, argv);
82 } catch (simgrid::HostFailureException const&) {
83 xbt_die("Could not launch a new process on failed host %s.", host->get_cname());
86 xbt_dict_free(&properties);
87 for (int i = 0; i != argc; ++i)
91 simgrid::s4u::this_actor::yield();
95 /** @brief Sets a cleanup function to be called to free the userdata of a process when a process is destroyed.
96 * @param data_cleanup a cleanup function for the userdata of a process, or nullptr to call no function
98 XBT_PUBLIC void MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup)
100 msg_global->process_data_cleanup = data_cleanup;
103 /** @brief returns a list of all currently existing processes */
104 xbt_dynar_t MSG_processes_as_dynar() {
105 xbt_dynar_t res = xbt_dynar_new(sizeof(smx_actor_t), nullptr);
106 for (auto const& kv : simix_global->process_list) {
107 smx_actor_t actor = kv.second;
108 xbt_dynar_push(res, &actor);
113 /** @brief Add a function to the list of "on_exit" functions for the current process.
114 * The on_exit functions are the functions executed when your process is killed.
115 * You should use them to free the data used by your process.
117 void MSG_process_on_exit(int_f_int_pvoid_t fun, void* data)
119 simgrid::s4u::this_actor::on_exit([fun, data](bool failed) { fun(failed ? 1 /*FAILURE*/ : 0 /*SUCCESS*/, data); });