src/msg/msg_process.cpp

   1 /* Copyright (c) 2004-2017. 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/simix/ActorImpl.hpp"
   9 #include "src/simix/smx_private.hpp"
  10
  11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg, "Logging specific to MSG (process)");
  12
  13 extern "C" {
  14
  15 /** @addtogroup m_process_management
  16  *
  17  *  Processes (#msg_process_t) are independent agents that can do stuff on their own. They are in charge of executing
  18  *  your code interacting with the simulated world.
  19  *  A process may be defined as a <em>code</em> with some <em>private data</em>.
  20  *  Processes must be located on <em>hosts</em> (#msg_host_t), and they exchange data by sending tasks (#msg_task_t)
  21  *  that are similar to envelops containing data.
  22  */
  23
  24 /******************************** Process ************************************/
  25 /**
  26  * \brief Cleans the MSG data of an actor
  27  * \param smx_actor a SIMIX actor
  28  */
  29 void MSG_process_cleanup_from_SIMIX(smx_actor_t smx_actor)
  30 {
  31   simgrid::msg::ActorExt* msg_actor;
  32
  33   // get the MSG process from the SIMIX process
  34   if (smx_actor == SIMIX_process_self()) {
  35     /* avoid a SIMIX request if this function is called by the process itself */
  36     msg_actor = (simgrid::msg::ActorExt*)SIMIX_process_self_get_data();
  37     SIMIX_process_self_set_data(nullptr);
  38   } else {
  39     msg_actor = (simgrid::msg::ActorExt*)smx_actor->userdata;
  40     simcall_process_set_data(smx_actor, nullptr);
  41   }
  42
  43   TRACE_msg_process_destroy(smx_actor->name, smx_actor->pid);
  44   // free the data if a function was provided
  45   if (msg_actor && msg_actor->data && msg_global->process_data_cleanup) {
  46     msg_global->process_data_cleanup(msg_actor->data);
  47   }
  48
  49   delete msg_actor;
  50   SIMIX_process_cleanup(smx_actor);
  51 }
  52
  53 /* This function creates a MSG process. It has the prototype enforced by SIMIX_function_register_process_create */
  54 smx_actor_t MSG_process_create_from_SIMIX(const char* name, std::function<void()> code, void* data, sg_host_t host,
  55                                           std::map<std::string, std::string>* properties,
  56                                           smx_actor_t /*parent_process*/)
  57 {
  58   msg_process_t p = MSG_process_create_from_stdfunc(name, std::move(code), data, host, properties);
  59   return p == nullptr ? nullptr : p->getImpl();
  60 }
  61
  62 /** \ingroup m_process_management
  63  * \brief Creates and runs a new #msg_process_t.
  64  *
  65  * Does exactly the same as #MSG_process_create_with_arguments but without providing standard arguments
  66  * (\a argc, \a argv, \a start_time, \a kill_time).
  67  * \sa MSG_process_create_with_arguments
  68  */
  69 msg_process_t MSG_process_create(const char *name, xbt_main_func_t code, void *data, msg_host_t host)
  70 {
  71   return MSG_process_create_with_environment(name, code, data, host, 0, nullptr, nullptr);
  72 }
  73
  74 /** \ingroup m_process_management
  75  * \brief Creates and runs a new #msg_process_t.
  76
  77  * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
  78  * the corresponding thread) is created, and put in the list of ready process.
  79  * \param name a name for the object. It is for user-level information and can be nullptr.
  80  * \param code is a function describing the behavior of the process. It should then only use functions described
  81  * in \ref m_process_management (to create a new #msg_process_t for example),
  82    in \ref m_host_management (only the read-only functions i.e. whose name contains the word get),
  83    in \ref m_task_management (to create or destroy some #msg_task_t for example) and
  84    in \ref msg_task_usage (to handle file transfers and task processing).
  85  * \param data a pointer to any data one may want to attach to the new object.  It is for user-level information and
  86  *        can be nullptr. It can be retrieved with the function \ref MSG_process_get_data.
  87  * \param host the location where the new process is executed.
  88  * \param argc first argument passed to \a code
  89  * \param argv second argument passed to \a code
  90  * \see msg_process_t
  91  * \return The new corresponding object.
  92  */
  93
  94 msg_process_t MSG_process_create_with_arguments(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
  95                                               int argc, char **argv)
  96 {
  97   return MSG_process_create_with_environment(name, code, data, host, argc, argv, nullptr);
  98 }
  99
 100 /** \ingroup m_process_management
 101  * \brief Creates and runs a new #msg_process_t.
 102
 103  * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
 104  * the corresponding thread) is created, and put in the list of ready process.
 105  * \param name a name for the object. It is for user-level information and can be nullptr.
 106  * \param code is a function describing the behavior of the process. It should then only use functions described
 107  * in \ref m_process_management (to create a new #msg_process_t for example),
 108    in \ref m_host_management (only the read-only functions i.e. whose name contains the word get),
 109    in \ref m_task_management (to create or destroy some #msg_task_t for example) and
 110    in \ref msg_task_usage (to handle file transfers and task processing).
 111  * \param data a pointer to any data one may want to attach to the new object.  It is for user-level information and
 112  *        can be nullptr. It can be retrieved with the function \ref MSG_process_get_data.
 113  * \param host the location where the new process is executed.
 114  * \param argc first argument passed to \a code
 115  * \param argv second argument passed to \a code. WARNING, these strings are freed by the SimGrid kernel when the
 116  *             process exits, so they cannot be static nor shared between several processes.
 117  * \param properties list a properties defined for this process
 118  * \see msg_process_t
 119  * \return The new corresponding object.
 120  */
 121 msg_process_t MSG_process_create_with_environment(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
 122                                                   int argc, char **argv, xbt_dict_t properties)
 123 {
 124   std::function<void()> function;
 125   if (code)
 126     function = simgrid::xbt::wrapMain(code, argc, static_cast<const char* const*>(argv));
 127
 128   std::map<std::string, std::string> props;
 129   xbt_dict_cursor_t cursor = nullptr;
 130   char* key;
 131   char* value;
 132   xbt_dict_foreach (properties, cursor, key, value)
 133     props[key] = value;
 134   xbt_dict_free(&properties);
 135
 136   msg_process_t res = MSG_process_create_from_stdfunc(name, std::move(function), data, host, &props);
 137   for (int i = 0; i != argc; ++i)
 138     xbt_free(argv[i]);
 139   xbt_free(argv);
 140   return res;
 141 }
 142 }
 143
 144 msg_process_t MSG_process_create_from_stdfunc(const char* name, std::function<void()> code, void* data, msg_host_t host,
 145                                               std::map<std::string, std::string>* properties)
 146 {
 147   xbt_assert(code != nullptr && host != nullptr, "Invalid parameters: host and code params must not be nullptr");
 148   simgrid::msg::ActorExt* msgExt = new simgrid::msg::ActorExt(data);
 149
 150   smx_actor_t process = simcall_process_create(name, std::move(code), msgExt, host, properties);
 151
 152   if (not process) { /* Undo everything */
 153     delete msgExt;
 154     return nullptr;
 155   }
 156
 157   simcall_process_on_exit(process, (int_f_pvoid_pvoid_t)TRACE_msg_process_kill, process);
 158   return process->ciface();
 159 }
 160
 161 extern "C" {
 162
 163 /* Become a process in the simulation
 164  *
 165  * Currently this can only be called by the main thread (once) and only work with some thread factories
 166  * (currently ThreadContextFactory).
 167  *
 168  * In the future, it might be extended in order to attach other threads created by a third party library.
 169  */
 170 msg_process_t MSG_process_attach(const char *name, void *data, msg_host_t host, xbt_dict_t properties)
 171 {
 172   xbt_assert(host != nullptr, "Invalid parameters: host and code params must not be nullptr");
 173   std::map<std::string, std::string> props;
 174   xbt_dict_cursor_t cursor = nullptr;
 175   char* key;
 176   char* value;
 177   xbt_dict_foreach (properties, cursor, key, value)
 178     props[key] = value;
 179   xbt_dict_free(&properties);
 180
 181   /* Let's create the process: SIMIX may decide to start it right now, even before returning the flow control to us */
 182   smx_actor_t process = SIMIX_process_attach(name, new simgrid::msg::ActorExt(data), host->getCname(), &props, nullptr);
 183   if (not process)
 184     xbt_die("Could not attach");
 185   simcall_process_on_exit(process,(int_f_pvoid_pvoid_t)TRACE_msg_process_kill,process);
 186   return process->ciface();
 187 }
 188
 189 /** Detach a process attached with `MSG_process_attach()`
 190  *
 191  *  This is called when the current process has finished its job.
 192  *  Used in the main thread, it waits for the simulation to finish before  returning. When it returns, the other
 193  *  simulated processes and the maestro are destroyed.
 194  */
 195 void MSG_process_detach()
 196 {
 197   SIMIX_process_detach();
 198 }
 199
 200 /** \ingroup m_process_management
 201  * \param process poor victim
 202  *
 203  * This function simply kills a \a process... scary isn't it ? :)
 204  */
 205 void MSG_process_kill(msg_process_t process)
 206 {
 207   process->kill();
 208 }
 209
 210 /**
 211 * \brief Wait for the completion of a #msg_process_t.
 212 *
 213 * \param process the process to wait for
 214 * \param timeout wait until the process is over, or the timeout occurs
 215 */
 216 msg_error_t MSG_process_join(msg_process_t process, double timeout){
 217   process->join(timeout);
 218   return MSG_OK;
 219 }
 220
 221 /** \ingroup m_process_management
 222  * \brief Migrates a process to another location.
 223  *
 224  * This function checks whether \a process and \a host are valid pointers and change the value of the #msg_host_t on
 225  * which \a process is running.
 226  */
 227 msg_error_t MSG_process_migrate(msg_process_t process, msg_host_t host)
 228 {
 229   TRACE_msg_process_change_host(process, host);
 230   process->migrate(host);
 231   return MSG_OK;
 232 }
 233
 234 /** Yield the current actor; let the other actors execute first */
 235 void MSG_process_yield()
 236 {
 237   simgrid::simix::kernelImmediate([] { /* do nothing*/ });
 238 }
 239
 240 /** \ingroup m_process_management
 241  * \brief Returns the user data of a process.
 242  *
 243  * This function checks whether \a process is a valid pointer and returns the user data associated to this process.
 244  */
 245 void* MSG_process_get_data(msg_process_t process)
 246 {
 247   xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
 248
 249   /* get from SIMIX the MSG process data, and then the user data */
 250   simgrid::msg::ActorExt* msgExt = (simgrid::msg::ActorExt*)process->getImpl()->userdata;
 251   if (msgExt)
 252     return msgExt->data;
 253   else
 254     return nullptr;
 255 }
 256
 257 /** \ingroup m_process_management
 258  * \brief Sets the user data of a process.
 259  *
 260  * This function checks whether \a process is a valid pointer and sets the user data associated to this process.
 261  */
 262 msg_error_t MSG_process_set_data(msg_process_t process, void *data)
 263 {
 264   xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
 265
 266   static_cast<simgrid::msg::ActorExt*>(process->getImpl()->userdata)->data = data;
 267
 268   return MSG_OK;
 269 }
 270
 271 /** \ingroup m_process_management
 272  * \brief Sets a cleanup function to be called to free the userdata of a process when a process is destroyed.
 273  * \param data_cleanup a cleanup function for the userdata of a process, or nullptr to call no function
 274  */
 275 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup) {
 276   msg_global->process_data_cleanup = data_cleanup;
 277 }
 278
 279 msg_host_t MSG_process_get_host(msg_process_t process)
 280 {
 281   if (process == nullptr) {
 282     return SIMIX_process_self()->host;
 283   } else {
 284     return process->getHost();
 285   }
 286 }
 287
 288 /** \ingroup m_process_management
 289  *
 290  * \brief Return a #msg_process_t given its PID.
 291  *
 292  * This function search in the list of all the created msg_process_t for a msg_process_t  whose PID is equal to \a PID.
 293  * If no host is found, \c nullptr is returned.
 294    Note that the PID are uniq in the whole simulation, not only on a given host.
 295  */
 296 msg_process_t MSG_process_from_PID(int PID)
 297 {
 298   return SIMIX_process_from_PID(PID)->ciface();
 299 }
 300
 301 /** @brief returns a list of all currently existing processes */
 302 xbt_dynar_t MSG_processes_as_dynar() {
 303   xbt_dynar_t res = xbt_dynar_new(sizeof(smx_actor_t), nullptr);
 304   for (auto const& kv : simix_global->process_list) {
 305     smx_actor_t actor = kv.second;
 306     xbt_dynar_push(res, &actor);
 307   }
 308   return res;
 309 }
 310
 311 /** @brief Return the current number MSG processes. */
 312 int MSG_process_get_number()
 313 {
 314   return SIMIX_process_count();
 315 }
 316
 317 /** \ingroup m_process_management
 318  * \brief Set the kill time of a process.
 319  *
 320  * \param process a process
 321  * \param kill_time the time when the process is killed.
 322  */
 323 msg_error_t MSG_process_set_kill_time(msg_process_t process, double kill_time)
 324 {
 325   process->setKillTime(kill_time);
 326   return MSG_OK;
 327 }
 328
 329 /** \ingroup m_process_management
 330  * \brief Returns the process ID of \a process.
 331  *
 332  * This function checks whether \a process is a valid pointer and return its PID (or 0 in case of problem).
 333  */
 334 int MSG_process_get_PID(msg_process_t process)
 335 {
 336   /* Do not raise an exception here: this function is called by the logs
 337    * and the exceptions, so it would be called back again and again */
 338   if (process == nullptr || process->getImpl() == nullptr)
 339     return 0;
 340   return process->getPid();
 341 }
 342
 343 /** \ingroup m_process_management
 344  * \brief Returns the process ID of the parent of \a process.
 345  *
 346  * This function checks whether \a process is a valid pointer and return its PID.
 347  * Returns -1 if the process has not been created by any other process.
 348  */
 349 int MSG_process_get_PPID(msg_process_t process)
 350 {
 351   return process->getPpid();
 352 }
 353
 354 /** \ingroup m_process_management
 355  * \brief Return the name of a process.
 356  *
 357  * This function checks whether \a process is a valid pointer and return its name.
 358  */
 359 const char *MSG_process_get_name(msg_process_t process)
 360 {
 361   return process->getCname();
 362 }
 363
 364 /** \ingroup m_process_management
 365  * \brief Returns the value of a given process property
 366  *
 367  * \param process a process
 368  * \param name a property name
 369  * \return value of a property (or nullptr if the property is not set)
 370  */
 371 const char *MSG_process_get_property_value(msg_process_t process, const char *name)
 372 {
 373   return process->getProperty(name);
 374 }
 375
 376 /** \ingroup m_process_management
 377  * \brief Return the list of properties
 378  *
 379  * This function returns all the parameters associated with a process
 380  */
 381 xbt_dict_t MSG_process_get_properties(msg_process_t process)
 382 {
 383   xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
 384   xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
 385   std::map<std::string, std::string>* props = process->getProperties();
 386   if (props == nullptr)
 387     return nullptr;
 388   for (auto const& elm : *props) {
 389     xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()), nullptr);
 390   }
 391   return as_dict;
 392 }
 393
 394 /** \ingroup m_process_management
 395  * \brief Return the PID of the current process.
 396  *
 397  * This function returns the PID of the currently running #msg_process_t.
 398  */
 399 int MSG_process_self_PID()
 400 {
 401   smx_actor_t self = SIMIX_process_self();
 402   return self == nullptr ? 0 : self->pid;
 403 }
 404
 405 /** \ingroup m_process_management
 406  * \brief Return the PPID of the current process.
 407  *
 408  * This function returns the PID of the parent of the currently running #msg_process_t.
 409  */
 410 int MSG_process_self_PPID()
 411 {
 412   return MSG_process_get_PPID(MSG_process_self());
 413 }
 414
 415 /** \ingroup m_process_management
 416  * \brief Return the name of the current process.
 417  */
 418 const char* MSG_process_self_name()
 419 {
 420   return SIMIX_process_self_get_name();
 421 }
 422
 423 /** \ingroup m_process_management
 424  * \brief Return the current process.
 425  *
 426  * This function returns the currently running #msg_process_t.
 427  */
 428 msg_process_t MSG_process_self()
 429 {
 430   return SIMIX_process_self()->ciface();
 431 }
 432
 433 /** \ingroup m_process_management
 434  * \brief Suspend the process.
 435  *
 436  * This function suspends the process by suspending the task on which it was waiting for the completion.
 437  */
 438 msg_error_t MSG_process_suspend(msg_process_t process)
 439 {
 440   xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
 441   process->suspend();
 442   return MSG_OK;
 443 }
 444
 445 /** \ingroup m_process_management
 446  * \brief Resume a suspended process.
 447  *
 448  * This function resumes a suspended process by resuming the task on which it was waiting for the completion.
 449  */
 450 msg_error_t MSG_process_resume(msg_process_t process)
 451 {
 452   xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
 453   process->resume();
 454   return MSG_OK;
 455 }
 456
 457 /** \ingroup m_process_management
 458  * \brief Returns true if the process is suspended .
 459  *
 460  * This checks whether a process is suspended or not by inspecting the task on which it was waiting for the completion.
 461  */
 462 int MSG_process_is_suspended(msg_process_t process)
 463 {
 464   return process->isSuspended();
 465 }
 466
 467 smx_context_t MSG_process_get_smx_ctx(msg_process_t process) {
 468   return process->getImpl()->context;
 469 }
 470 /**
 471  * \ingroup m_process_management
 472  * \brief Add a function to the list of "on_exit" functions for the current process.
 473  * The on_exit functions are the functions executed when your process is killed.
 474  * You should use them to free the data used by your process.
 475  */
 476 void MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void *data) {
 477   simcall_process_on_exit(SIMIX_process_self(), fun, data);
 478 }
 479 /**
 480  * \ingroup m_process_management
 481  * \brief Sets the "auto-restart" flag of the process.
 482  * If the flag is set to 1, the process will be automatically restarted when its host comes back up.
 483  */
 484 XBT_PUBLIC(void) MSG_process_auto_restart_set(msg_process_t process, int auto_restart) {
 485   process->setAutoRestart(auto_restart);
 486 }
 487 /**
 488  * \ingroup m_process_management
 489  * \brief Restarts a process from the beginning.
 490  */
 491 XBT_PUBLIC(msg_process_t) MSG_process_restart(msg_process_t process) {
 492   return process->restart();
 493 }
 494
 495 /** @ingroup m_process_management
 496  * @brief This process will be terminated automatically when the last non-daemon process finishes
 497  */
 498 XBT_PUBLIC(void) MSG_process_daemonize(msg_process_t process)
 499 {
 500   process->daemonize();
 501 }
 502
 503 /** @ingroup m_process_management
 504  * @brief Take an extra reference on that process to prevent it to be garbage-collected
 505  */
 506 XBT_PUBLIC(void) MSG_process_ref(msg_process_t process)
 507 {
 508   intrusive_ptr_add_ref(process);
 509 }
 510 /** @ingroup m_process_management
 511  * @brief Release a reference on that process so that it can get be garbage-collected
 512  */
 513 XBT_PUBLIC(void) MSG_process_unref(msg_process_t process)
 514 {
 515   intrusive_ptr_release(process);
 516 }
 517 }