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.h"
   7 #include "simgrid/s4u/Host.hpp"
   8 #include "src/simix/ActorImpl.hpp"
   9 #include "src/simix/smx_private.h"
  10
  11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg, "Logging specific to MSG (process)");
  12
  13 SG_BEGIN_DECL()
  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.c_str(), 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, smx_actor_t parent_process)
  56 {
  57   msg_process_t p = MSG_process_create_from_stdfunc(name, std::move(code), data, host, properties);
  58   return p == nullptr ? nullptr : p->getImpl();
  59 }
  60
  61 /** \ingroup m_process_management
  62  * \brief Creates and runs a new #msg_process_t.
  63  *
  64  * Does exactly the same as #MSG_process_create_with_arguments but without providing standard arguments
  65  * (\a argc, \a argv, \a start_time, \a kill_time).
  66  * \sa MSG_process_create_with_arguments
  67  */
  68 msg_process_t MSG_process_create(const char *name, xbt_main_func_t code, void *data, msg_host_t host)
  69 {
  70   return MSG_process_create_with_environment(name, code, data, host, 0, nullptr, nullptr);
  71 }
  72
  73 /** \ingroup m_process_management
  74  * \brief Creates and runs a new #msg_process_t.
  75
  76  * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
  77  * the corresponding thread) is created, and put in the list of ready process.
  78  * \param name a name for the object. It is for user-level information and can be nullptr.
  79  * \param code is a function describing the behavior of the process. It should then only use functions described
  80  * in \ref m_process_management (to create a new #msg_process_t for example),
  81    in \ref m_host_management (only the read-only functions i.e. whose name contains the word get),
  82    in \ref m_task_management (to create or destroy some #msg_task_t for example) and
  83    in \ref msg_task_usage (to handle file transfers and task processing).
  84  * \param data a pointer to any data one may want to attach to the new object.  It is for user-level information and
  85  *        can be nullptr. It can be retrieved with the function \ref MSG_process_get_data.
  86  * \param host the location where the new process is executed.
  87  * \param argc first argument passed to \a code
  88  * \param argv second argument passed to \a code
  89  * \see msg_process_t
  90  * \return The new corresponding object.
  91  */
  92
  93 msg_process_t MSG_process_create_with_arguments(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
  94                                               int argc, char **argv)
  95 {
  96   return MSG_process_create_with_environment(name, code, data, host, argc, argv, nullptr);
  97 }
  98
  99 /** \ingroup m_process_management
 100  * \brief Creates and runs a new #msg_process_t.
 101
 102  * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
 103  * the corresponding thread) is created, and put in the list of ready process.
 104  * \param name a name for the object. It is for user-level information and can be nullptr.
 105  * \param code is a function describing the behavior of the process. It should then only use functions described
 106  * in \ref m_process_management (to create a new #msg_process_t for example),
 107    in \ref m_host_management (only the read-only functions i.e. whose name contains the word get),
 108    in \ref m_task_management (to create or destroy some #msg_task_t for example) and
 109    in \ref msg_task_usage (to handle file transfers and task processing).
 110  * \param data a pointer to any data one may want to attach to the new object.  It is for user-level information and
 111  *        can be nullptr. It can be retrieved with the function \ref MSG_process_get_data.
 112  * \param host the location where the new process is executed.
 113  * \param argc first argument passed to \a code
 114  * \param argv second argument passed to \a code. WARNING, these strings are freed by the SimGrid kernel when the
 115  *             process exits, so they cannot be static nor shared between several processes.
 116  * \param properties list a properties defined for this process
 117  * \see msg_process_t
 118  * \return The new corresponding object.
 119  */
 120 msg_process_t MSG_process_create_with_environment(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
 121                                                   int argc, char **argv, xbt_dict_t properties)
 122 {
 123   std::function<void()> function;
 124   if (code)
 125     function = simgrid::xbt::wrapMain(code, argc, static_cast<const char* const*>(argv));
 126
 127   std::map<std::string, std::string> props;
 128   xbt_dict_cursor_t cursor = nullptr;
 129   char* key;
 130   char* value;
 131   xbt_dict_foreach (properties, cursor, key, value)
 132     props[key] = value;
 133   xbt_dict_free(&properties);
 134
 135   msg_process_t res = MSG_process_create_from_stdfunc(name, std::move(function), data, host, &props);
 136   for (int i = 0; i != argc; ++i)
 137     xbt_free(argv[i]);
 138   xbt_free(argv);
 139   return res;
 140 }
 141
 142 SG_END_DECL()
 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 SG_BEGIN_DECL()
 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   simcall_process_join(process->getImpl(), 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 /** \ingroup m_process_management
 280  * \brief Return the location on which a process is running.
 281  * \param process a process (nullptr means the current one)
 282  * \return the msg_host_t corresponding to the location on which \a process is running.
 283  */
 284 msg_host_t MSG_process_get_host(msg_process_t process)
 285 {
 286   if (process == nullptr) {
 287     return SIMIX_process_self()->host;
 288   } else {
 289     return process->getImpl()->host;
 290   }
 291 }
 292
 293 /** \ingroup m_process_management
 294  *
 295  * \brief Return a #msg_process_t given its PID.
 296  *
 297  * 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.
 298  * If no host is found, \c nullptr is returned.
 299    Note that the PID are uniq in the whole simulation, not only on a given host.
 300  */
 301 msg_process_t MSG_process_from_PID(int PID)
 302 {
 303   return SIMIX_process_from_PID(PID)->ciface();
 304 }
 305
 306 /** @brief returns a list of all currently existing processes */
 307 xbt_dynar_t MSG_processes_as_dynar() {
 308   xbt_dynar_t res = xbt_dynar_new(sizeof(smx_actor_t), nullptr);
 309   for (auto const& kv : simix_global->process_list) {
 310     smx_actor_t actor = kv.second;
 311     xbt_dynar_push(res, &actor);
 312   }
 313   return res;
 314 }
 315
 316 /** @brief Return the current number MSG processes. */
 317 int MSG_process_get_number()
 318 {
 319   return SIMIX_process_count();
 320 }
 321
 322 /** \ingroup m_process_management
 323  * \brief Set the kill time of a process.
 324  *
 325  * \param process a process
 326  * \param kill_time the time when the process is killed.
 327  */
 328 msg_error_t MSG_process_set_kill_time(msg_process_t process, double kill_time)
 329 {
 330   simcall_process_set_kill_time(process->getImpl(), kill_time);
 331   return MSG_OK;
 332 }
 333
 334 /** \ingroup m_process_management
 335  * \brief Returns the process ID of \a process.
 336  *
 337  * This function checks whether \a process is a valid pointer and return its PID (or 0 in case of problem).
 338  */
 339 int MSG_process_get_PID(msg_process_t process)
 340 {
 341   /* Do not raise an exception here: this function is called by the logs
 342    * and the exceptions, so it would be called back again and again */
 343   if (process == nullptr || process->getImpl() == nullptr)
 344     return 0;
 345   return process->getImpl()->pid;
 346 }
 347
 348 /** \ingroup m_process_management
 349  * \brief Returns the process ID of the parent of \a process.
 350  *
 351  * This function checks whether \a process is a valid pointer and return its PID.
 352  * Returns -1 if the process has not been created by any other process.
 353  */
 354 int MSG_process_get_PPID(msg_process_t process)
 355 {
 356   return process->getImpl()->ppid;
 357 }
 358
 359 /** \ingroup m_process_management
 360  * \brief Return the name of a process.
 361  *
 362  * This function checks whether \a process is a valid pointer and return its name.
 363  */
 364 const char *MSG_process_get_name(msg_process_t process)
 365 {
 366   return process->getCname();
 367 }
 368
 369 /** \ingroup m_process_management
 370  * \brief Returns the value of a given process property
 371  *
 372  * \param process a process
 373  * \param name a property name
 374  * \return value of a property (or nullptr if the property is not set)
 375  */
 376 const char *MSG_process_get_property_value(msg_process_t process, const char *name)
 377 {
 378   return process->getProperty(name);
 379 }
 380
 381 /** \ingroup m_process_management
 382  * \brief Return the list of properties
 383  *
 384  * This function returns all the parameters associated with a process
 385  */
 386 xbt_dict_t MSG_process_get_properties(msg_process_t process)
 387 {
 388   xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
 389   xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
 390   std::map<std::string, std::string>* props =
 391       simgrid::simix::kernelImmediate([process] { return process->getImpl()->getProperties(); });
 392   if (props == nullptr)
 393     return nullptr;
 394   for (auto const& elm : *props) {
 395     xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()), nullptr);
 396   }
 397   return as_dict;
 398 }
 399
 400 /** \ingroup m_process_management
 401  * \brief Return the PID of the current process.
 402  *
 403  * This function returns the PID of the currently running #msg_process_t.
 404  */
 405 int MSG_process_self_PID()
 406 {
 407   smx_actor_t self = SIMIX_process_self();
 408   return self == nullptr ? 0 : self->pid;
 409 }
 410
 411 /** \ingroup m_process_management
 412  * \brief Return the PPID of the current process.
 413  *
 414  * This function returns the PID of the parent of the currently running #msg_process_t.
 415  */
 416 int MSG_process_self_PPID()
 417 {
 418   return MSG_process_get_PPID(MSG_process_self());
 419 }
 420
 421 /** \ingroup m_process_management
 422  * \brief Return the name of the current process.
 423  */
 424 const char* MSG_process_self_name()
 425 {
 426   return SIMIX_process_self_get_name();
 427 }
 428
 429 /** \ingroup m_process_management
 430  * \brief Return the current process.
 431  *
 432  * This function returns the currently running #msg_process_t.
 433  */
 434 msg_process_t MSG_process_self()
 435 {
 436   return SIMIX_process_self()->ciface();
 437 }
 438
 439 /** \ingroup m_process_management
 440  * \brief Suspend the process.
 441  *
 442  * This function suspends the process by suspending the task on which it was waiting for the completion.
 443  */
 444 msg_error_t MSG_process_suspend(msg_process_t process)
 445 {
 446   xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
 447
 448   TRACE_msg_process_suspend(process);
 449   simcall_process_suspend(process->getImpl());
 450   return MSG_OK;
 451 }
 452
 453 /** \ingroup m_process_management
 454  * \brief Resume a suspended process.
 455  *
 456  * This function resumes a suspended process by resuming the task on which it was waiting for the completion.
 457  */
 458 msg_error_t MSG_process_resume(msg_process_t process)
 459 {
 460   xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
 461
 462   TRACE_msg_process_resume(process);
 463   process->resume();
 464   return MSG_OK;
 465 }
 466
 467 /** \ingroup m_process_management
 468  * \brief Returns true if the process is suspended .
 469  *
 470  * This checks whether a process is suspended or not by inspecting the task on which it was waiting for the completion.
 471  */
 472 int MSG_process_is_suspended(msg_process_t process)
 473 {
 474   return process->isSuspended();
 475 }
 476
 477 smx_context_t MSG_process_get_smx_ctx(msg_process_t process) {
 478   return process->getImpl()->context;
 479 }
 480 /**
 481  * \ingroup m_process_management
 482  * \brief Add a function to the list of "on_exit" functions for the current process.
 483  * The on_exit functions are the functions executed when your process is killed.
 484  * You should use them to free the data used by your process.
 485  */
 486 void MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void *data) {
 487   simcall_process_on_exit(SIMIX_process_self(), fun, data);
 488 }
 489 /**
 490  * \ingroup m_process_management
 491  * \brief Sets the "auto-restart" flag of the process.
 492  * If the flag is set to 1, the process will be automatically restarted when its host comes back up.
 493  */
 494 XBT_PUBLIC(void) MSG_process_auto_restart_set(msg_process_t process, int auto_restart) {
 495   process->setAutoRestart(auto_restart);
 496 }
 497 /**
 498  * \ingroup m_process_management
 499  * \brief Restarts a process from the beginning.
 500  */
 501 XBT_PUBLIC(msg_process_t) MSG_process_restart(msg_process_t process) {
 502   return process->restart();
 503 }
 504
 505 /** @ingroup m_process_management
 506  * @brief This process will be terminated automatically when the last non-daemon process finishes
 507  */
 508 XBT_PUBLIC(void) MSG_process_daemonize(msg_process_t process)
 509 {
 510   simgrid::simix::kernelImmediate([process]() { process->getImpl()->daemonize(); });
 511 }
 512
 513 /** @ingroup m_process_management
 514  * @brief Take an extra reference on that process to prevent it to be garbage-collected
 515  */
 516 XBT_PUBLIC(void) MSG_process_ref(msg_process_t process)
 517 {
 518   intrusive_ptr_add_ref(process);
 519 }
 520 /** @ingroup m_process_management
 521  * @brief Release a reference on that process so that it can get be garbage-collected
 522  */
 523 XBT_PUBLIC(void) MSG_process_unref(msg_process_t process)
 524 {
 525   intrusive_ptr_release(process);
 526 }
 527
 528 SG_END_DECL()