src/msg/msg_process.cpp

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