X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/ee63a4fbf0d79259eb0e1e7c5b7053f4b99c7a75..4b41294c49f838248cf4b8e6883ddd94dfdf72d9:/src/msg/msg_process.cpp diff --git a/src/msg/msg_process.cpp b/src/msg/msg_process.cpp index 5ce8704be2..17b20f9f10 100644 --- a/src/msg/msg_process.cpp +++ b/src/msg/msg_process.cpp @@ -1,19 +1,17 @@ -/* Copyright (c) 2004-2015. The SimGrid Team. - * All rights reserved. */ +/* Copyright (c) 2004-2017. The SimGrid Team. All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ #include "msg_private.h" -#include "xbt/sysdep.h" -#include "xbt/log.h" -#include "src/simix/smx_process_private.h" -#include "src/simix/smx_private.h" +#include "simgrid/s4u/Host.hpp" +#include "src/simix/ActorImpl.hpp" XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg, "Logging specific to MSG (process)"); +SG_BEGIN_DECL() + /** @addtogroup m_process_management - * \htmlonly \endhtmlonly * * Processes (#msg_process_t) are independent agents that can do stuff on their own. They are in charge of executing * your code interacting with the simulated world. @@ -24,46 +22,39 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg, "Logging specific to MSG (proc /******************************** Process ************************************/ /** - * \brief Cleans the MSG data of a process. - * \param smx_proc a SIMIX process + * \brief Cleans the MSG data of an actor + * \param smx_actor a SIMIX actor */ -void MSG_process_cleanup_from_SIMIX(smx_process_t smx_proc) +void MSG_process_cleanup_from_SIMIX(smx_actor_t smx_actor) { - simdata_process_t msg_proc; + simgrid::msg::ActorExt* msg_actor; // get the MSG process from the SIMIX process - if (smx_proc == SIMIX_process_self()) { + if (smx_actor == SIMIX_process_self()) { /* avoid a SIMIX request if this function is called by the process itself */ - msg_proc = (simdata_process_t) SIMIX_process_self_get_data(smx_proc); - SIMIX_process_self_set_data(smx_proc, NULL); + msg_actor = (simgrid::msg::ActorExt*)SIMIX_process_self_get_data(); + SIMIX_process_self_set_data(nullptr); } else { - msg_proc = (simdata_process_t) simcall_process_get_data(smx_proc); - simcall_process_set_data(smx_proc, NULL); + msg_actor = (simgrid::msg::ActorExt*)smx_actor->userdata; + simcall_process_set_data(smx_actor, nullptr); } - TRACE_msg_process_destroy(smx_proc->name, smx_proc->pid); + TRACE_msg_process_destroy(smx_actor->name.c_str(), smx_actor->pid); // free the data if a function was provided - if (msg_proc && msg_proc->data && msg_global->process_data_cleanup) { - msg_global->process_data_cleanup(msg_proc->data); + if (msg_actor && msg_actor->data && msg_global->process_data_cleanup) { + msg_global->process_data_cleanup(msg_actor->data); } - // free the MSG process - xbt_free(msg_proc); - SIMIX_process_cleanup(smx_proc); + delete msg_actor; + SIMIX_process_cleanup(smx_actor); } /* This function creates a MSG process. It has the prototype enforced by SIMIX_function_register_process_create */ -smx_process_t MSG_process_create_from_SIMIX(const char *name, xbt_main_func_t code, void *data, const char *hostname, - double kill_time, int argc, char **argv, xbt_dict_t properties, - int auto_restart, smx_process_t parent_process) -{ - msg_host_t host = MSG_host_by_name(hostname); - msg_process_t p = MSG_process_create_with_environment(name, code, data, host, argc, argv, properties); - if (p) { - MSG_process_set_kill_time(p,kill_time); - MSG_process_auto_restart_set(p,auto_restart); - } - return p; +smx_actor_t MSG_process_create_from_SIMIX(const char* name, std::function code, void* data, sg_host_t host, + xbt_dict_t properties, smx_actor_t parent_process) +{ + msg_process_t p = MSG_process_create_from_stdfunc(name, std::move(code), data, host, properties); + return p == nullptr ? nullptr : p->getImpl(); } /** \ingroup m_process_management @@ -75,7 +66,7 @@ smx_process_t MSG_process_create_from_SIMIX(const char *name, xbt_main_func_t co */ msg_process_t MSG_process_create(const char *name, xbt_main_func_t code, void *data, msg_host_t host) { - return MSG_process_create_with_environment(name, code, data, host, 0, NULL, NULL); + return MSG_process_create_with_environment(name, code, data, host, 0, nullptr, nullptr); } /** \ingroup m_process_management @@ -83,14 +74,14 @@ msg_process_t MSG_process_create(const char *name, xbt_main_func_t code, void *d * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and * the corresponding thread) is created, and put in the list of ready process. - * \param name a name for the object. It is for user-level information and can be NULL. + * \param name a name for the object. It is for user-level information and can be nullptr. * \param code is a function describing the behavior of the process. It should then only use functions described * in \ref m_process_management (to create a new #msg_process_t for example), in \ref m_host_management (only the read-only functions i.e. whose name contains the word get), in \ref m_task_management (to create or destroy some #msg_task_t for example) and in \ref msg_task_usage (to handle file transfers and task processing). * \param data a pointer to any data one may want to attach to the new object. It is for user-level information and - * can be NULL. It can be retrieved with the function \ref MSG_process_get_data. + * can be nullptr. It can be retrieved with the function \ref MSG_process_get_data. * \param host the location where the new process is executed. * \param argc first argument passed to \a code * \param argv second argument passed to \a code @@ -101,7 +92,7 @@ msg_process_t MSG_process_create(const char *name, xbt_main_func_t code, void *d msg_process_t MSG_process_create_with_arguments(const char *name, xbt_main_func_t code, void *data, msg_host_t host, int argc, char **argv) { - return MSG_process_create_with_environment(name, code, data, host, argc, argv, NULL); + return MSG_process_create_with_environment(name, code, data, host, argc, argv, nullptr); } /** \ingroup m_process_management @@ -109,14 +100,14 @@ msg_process_t MSG_process_create_with_arguments(const char *name, xbt_main_func_ * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and * the corresponding thread) is created, and put in the list of ready process. - * \param name a name for the object. It is for user-level information and can be NULL. + * \param name a name for the object. It is for user-level information and can be nullptr. * \param code is a function describing the behavior of the process. It should then only use functions described * in \ref m_process_management (to create a new #msg_process_t for example), in \ref m_host_management (only the read-only functions i.e. whose name contains the word get), in \ref m_task_management (to create or destroy some #msg_task_t for example) and in \ref msg_task_usage (to handle file transfers and task processing). * \param data a pointer to any data one may want to attach to the new object. It is for user-level information and - * can be NULL. It can be retrieved with the function \ref MSG_process_get_data. + * can be nullptr. It can be retrieved with the function \ref MSG_process_get_data. * \param host the location where the new process is executed. * \param argc first argument passed to \a code * \param argv second argument passed to \a code. WARNING, these strings are freed by the SimGrid kernel when the @@ -126,42 +117,40 @@ msg_process_t MSG_process_create_with_arguments(const char *name, xbt_main_func_ * \return The new corresponding object. */ msg_process_t MSG_process_create_with_environment(const char *name, xbt_main_func_t code, void *data, msg_host_t host, - int argc, char **argv, xbt_dict_t properties) -{ - xbt_assert(code != NULL && host != NULL, "Invalid parameters: host and code params must not be NULL"); - simdata_process_t simdata = xbt_new0(s_simdata_process_t, 1); - msg_process_t process; - - /* Simulator data for MSG */ - simdata->waiting_action = NULL; - simdata->waiting_task = NULL; - simdata->m_host = host; - simdata->argc = argc; - simdata->argv = argv; - simdata->data = data; - simdata->last_errno = MSG_OK; - - /* Let's create the process: SIMIX may decide to start it right now, - * even before returning the flow control to us */ - process = simcall_process_create(name, code, simdata, sg_host_get_name(host), -1, argc, argv, properties,0); - - if (!process) { - /* Undo everything we have just changed */ - xbt_free(simdata); - return NULL; - } - else { - simcall_process_on_exit(process,(int_f_pvoid_pvoid_t)TRACE_msg_process_kill,process); - } - return process; + int argc, char **argv, xbt_dict_t properties) +{ + std::function function; + if (code) + function = simgrid::xbt::wrapMain(code, argc, static_cast(argv)); + + msg_process_t res = MSG_process_create_from_stdfunc(name, std::move(function), data, host, properties); + for (int i = 0; i != argc; ++i) + xbt_free(argv[i]); + xbt_free(argv); + return res; } -static int MSG_maestro(int argc, char** argv) +SG_END_DECL() + +msg_process_t MSG_process_create_from_stdfunc(const char* name, std::function code, void* data, msg_host_t host, + xbt_dict_t properties) { - int res = MSG_main(); - return res; + xbt_assert(code != nullptr && host != nullptr, "Invalid parameters: host and code params must not be nullptr"); + simgrid::msg::ActorExt* msgExt = new simgrid::msg::ActorExt(data); + + smx_actor_t process = simcall_process_create(name, std::move(code), msgExt, host, properties); + + if (not process) { /* Undo everything */ + delete msgExt; + return nullptr; + } + + simcall_process_on_exit(process, (int_f_pvoid_pvoid_t)TRACE_msg_process_kill, process); + return process->ciface(); } +SG_BEGIN_DECL() + /* Become a process in the simulation * * Currently this can only be called by the main thread (once) and only work with some thread factories @@ -171,25 +160,15 @@ static int MSG_maestro(int argc, char** argv) */ msg_process_t MSG_process_attach(const char *name, void *data, msg_host_t host, xbt_dict_t properties) { - xbt_assert(host != NULL, "Invalid parameters: host and code params must not be NULL"); - simdata_process_t simdata = xbt_new0(s_simdata_process_t, 1); - msg_process_t process; - - /* Simulator data for MSG */ - simdata->waiting_action = NULL; - simdata->waiting_task = NULL; - simdata->m_host = host; - simdata->argc = 0; - simdata->argv = NULL; - simdata->data = data; - simdata->last_errno = MSG_OK; + xbt_assert(host != nullptr, "Invalid parameters: host and code params must not be nullptr"); /* Let's create the process: SIMIX may decide to start it right now, even before returning the flow control to us */ - process = SIMIX_process_attach(name, simdata, sg_host_get_name(host), properties, NULL); - if (!process) + smx_actor_t process = + SIMIX_process_attach(name, new simgrid::msg::ActorExt(data), host->getCname(), properties, nullptr); + if (not process) xbt_die("Could not attach"); simcall_process_on_exit(process,(int_f_pvoid_pvoid_t)TRACE_msg_process_kill,process); - return process; + return process->ciface(); } /** Detach a process attached with `MSG_process_attach()` @@ -198,7 +177,7 @@ msg_process_t MSG_process_attach(const char *name, void *data, msg_host_t host, * Used in the main thread, it waits for the simulation to finish before returning. When it returns, the other * simulated processes and the maestro are destroyed. */ -void MSG_process_detach(void) +void MSG_process_detach() { SIMIX_process_detach(); } @@ -210,12 +189,7 @@ void MSG_process_detach(void) */ void MSG_process_kill(msg_process_t process) { -// /* FIXME: why do we only cancel communication actions? is this useful? */ -// simdata_process_t p_simdata = simcall_process_get_data(process); -// if (p_simdata->waiting_task && p_simdata->waiting_task->simdata->comm) { -// simcall_comm_cancel(p_simdata->waiting_task->simdata->comm); -// } - simcall_process_kill(process); + process->kill(); } /** @@ -225,7 +199,7 @@ void MSG_process_kill(msg_process_t process) * \param timeout wait until the process is over, or the timeout occurs */ msg_error_t MSG_process_join(msg_process_t process, double timeout){ - simcall_process_join(process, timeout); + simcall_process_join(process->getImpl(), timeout); return MSG_OK; } @@ -237,14 +211,17 @@ msg_error_t MSG_process_join(msg_process_t process, double timeout){ */ msg_error_t MSG_process_migrate(msg_process_t process, msg_host_t host) { - simdata_process_t simdata = (simdata_process_t) simcall_process_get_data(process); - simdata->m_host = host; - msg_host_t now = simdata->m_host; - TRACE_msg_process_change_host(process, now, host); - simcall_process_set_host(process, host); + TRACE_msg_process_change_host(process, MSG_process_get_host(process), host); + process->migrate(host); return MSG_OK; } +/** Yield the current actor; let the other actors execute first */ +void MSG_process_yield() +{ + simgrid::simix::kernelImmediate([] { /* do nothing*/ }); +} + /** \ingroup m_process_management * \brief Returns the user data of a process. * @@ -252,14 +229,14 @@ msg_error_t MSG_process_migrate(msg_process_t process, msg_host_t host) */ void* MSG_process_get_data(msg_process_t process) { - xbt_assert(process != NULL, "Invalid parameter: first parameter must not be NULL!"); + xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!"); /* get from SIMIX the MSG process data, and then the user data */ - simdata_process_t simdata = (simdata_process_t) simcall_process_get_data(process); - if (simdata) - return simdata->data; + simgrid::msg::ActorExt* msgExt = (simgrid::msg::ActorExt*)process->getImpl()->userdata; + if (msgExt) + return msgExt->data; else - return NULL; + return nullptr; } /** \ingroup m_process_management @@ -269,17 +246,16 @@ void* MSG_process_get_data(msg_process_t process) */ msg_error_t MSG_process_set_data(msg_process_t process, void *data) { - xbt_assert(process != NULL, "Invalid parameter: first parameter must not be NULL!"); + xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!"); - simdata_process_t simdata = (simdata_process_t) simcall_process_get_data(process); - simdata->data = data; + static_cast(process->getImpl()->userdata)->data = data; return MSG_OK; } /** \ingroup m_process_management * \brief Sets a cleanup function to be called to free the userdata of a process when a process is destroyed. - * \param data_cleanup a cleanup function for the userdata of a process, or NULL to call no function + * \param data_cleanup a cleanup function for the userdata of a process, or nullptr to call no function */ XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup) { msg_global->process_data_cleanup = data_cleanup; @@ -287,19 +263,16 @@ XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup) { /** \ingroup m_process_management * \brief Return the location on which a process is running. - * \param process a process (NULL means the current one) + * \param process a process (nullptr means the current one) * \return the msg_host_t corresponding to the location on which \a process is running. */ msg_host_t MSG_process_get_host(msg_process_t process) { - simdata_process_t simdata; - if (process == NULL) { - simdata = (simdata_process_t) SIMIX_process_self_get_data(SIMIX_process_self()); - } - else { - simdata = (simdata_process_t) simcall_process_get_data(process); + if (process == nullptr) { + return SIMIX_process_self()->host; + } else { + return process->getImpl()->host; } - return simdata ? simdata->m_host : NULL; } /** \ingroup m_process_management @@ -307,21 +280,21 @@ msg_host_t MSG_process_get_host(msg_process_t process) * \brief Return a #msg_process_t given its PID. * * 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. - * If no host is found, \c NULL is returned. + * If no host is found, \c nullptr is returned. Note that the PID are uniq in the whole simulation, not only on a given host. */ msg_process_t MSG_process_from_PID(int PID) { - return SIMIX_process_from_PID(PID); + return SIMIX_process_from_PID(PID)->ciface(); } /** @brief returns a list of all currently existing processes */ -xbt_dynar_t MSG_processes_as_dynar(void) { +xbt_dynar_t MSG_processes_as_dynar() { return SIMIX_processes_as_dynar(); } /** @brief Return the current number MSG processes. */ -int MSG_process_get_number(void) +int MSG_process_get_number() { return SIMIX_process_count(); } @@ -334,7 +307,7 @@ int MSG_process_get_number(void) */ msg_error_t MSG_process_set_kill_time(msg_process_t process, double kill_time) { - simcall_process_set_kill_time(process,kill_time); + simcall_process_set_kill_time(process->getImpl(), kill_time); return MSG_OK; } @@ -347,10 +320,9 @@ int MSG_process_get_PID(msg_process_t process) { /* Do not raise an exception here: this function is called by the logs * and the exceptions, so it would be called back again and again */ - if (process == NULL) { + if (process == nullptr || process->getImpl() == nullptr) return 0; - } - return simcall_process_get_PID(process); + return process->getImpl()->pid; } /** \ingroup m_process_management @@ -361,8 +333,7 @@ int MSG_process_get_PID(msg_process_t process) */ int MSG_process_get_PPID(msg_process_t process) { - xbt_assert(process != NULL, "Invalid parameter: First argument must not be NULL"); - return simcall_process_get_PPID(process); + return process->getImpl()->ppid; } /** \ingroup m_process_management @@ -372,8 +343,7 @@ int MSG_process_get_PPID(msg_process_t process) */ const char *MSG_process_get_name(msg_process_t process) { - xbt_assert(process != NULL, "Invalid parameter: First argument must not be NULL"); - return simcall_process_get_name(process); + return process->getCname(); } /** \ingroup m_process_management @@ -381,7 +351,7 @@ const char *MSG_process_get_name(msg_process_t process) * * \param process a process * \param name a property name - * \return value of a property (or NULL if the property is not set) + * \return value of a property (or nullptr if the property is not set) */ const char *MSG_process_get_property_value(msg_process_t process, const char *name) { @@ -395,8 +365,8 @@ const char *MSG_process_get_property_value(msg_process_t process, const char *na */ xbt_dict_t MSG_process_get_properties(msg_process_t process) { - xbt_assert(process != NULL, "Invalid parameter: First argument must not be NULL"); - return simcall_process_get_properties(process); + xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr"); + return simcall_process_get_properties(process->getImpl()); } /** \ingroup m_process_management @@ -404,9 +374,10 @@ xbt_dict_t MSG_process_get_properties(msg_process_t process) * * This function returns the PID of the currently running #msg_process_t. */ -int MSG_process_self_PID(void) +int MSG_process_self_PID() { - return MSG_process_get_PID(MSG_process_self()); + smx_actor_t self = SIMIX_process_self(); + return self == nullptr ? 0 : self->pid; } /** \ingroup m_process_management @@ -414,19 +385,27 @@ int MSG_process_self_PID(void) * * This function returns the PID of the parent of the currently running #msg_process_t. */ -int MSG_process_self_PPID(void) +int MSG_process_self_PPID() { return MSG_process_get_PPID(MSG_process_self()); } +/** \ingroup m_process_management + * \brief Return the name of the current process. + */ +const char* MSG_process_self_name() +{ + return SIMIX_process_self_get_name(); +} + /** \ingroup m_process_management * \brief Return the current process. * * This function returns the currently running #msg_process_t. */ -msg_process_t MSG_process_self(void) +msg_process_t MSG_process_self() { - return SIMIX_process_self(); + return SIMIX_process_self()->ciface(); } /** \ingroup m_process_management @@ -436,11 +415,11 @@ msg_process_t MSG_process_self(void) */ msg_error_t MSG_process_suspend(msg_process_t process) { - xbt_assert(process != NULL, "Invalid parameter: First argument must not be NULL"); + xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr"); TRACE_msg_process_suspend(process); - simcall_process_suspend(process); - MSG_RETURN(MSG_OK); + simcall_process_suspend(process->getImpl()); + return MSG_OK; } /** \ingroup m_process_management @@ -450,11 +429,11 @@ msg_error_t MSG_process_suspend(msg_process_t process) */ msg_error_t MSG_process_resume(msg_process_t process) { - xbt_assert(process != NULL, "Invalid parameter: First argument must not be NULL"); + xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr"); TRACE_msg_process_resume(process); - simcall_process_resume(process); - MSG_RETURN(MSG_OK); + process->resume(); + return MSG_OK; } /** \ingroup m_process_management @@ -464,12 +443,11 @@ msg_error_t MSG_process_resume(msg_process_t process) */ int MSG_process_is_suspended(msg_process_t process) { - xbt_assert(process != NULL, "Invalid parameter: First argument must not be NULL"); - return simcall_process_is_suspended(process); + return process->isSuspended(); } smx_context_t MSG_process_get_smx_ctx(msg_process_t process) { - return SIMIX_process_get_context(process); + return process->getImpl()->context; } /** * \ingroup m_process_management @@ -478,7 +456,7 @@ smx_context_t MSG_process_get_smx_ctx(msg_process_t process) { * You should use them to free the data used by your process. */ void MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void *data) { - simcall_process_on_exit(MSG_process_self(),fun,data); + simcall_process_on_exit(SIMIX_process_self(), fun, data); } /** * \ingroup m_process_management @@ -486,12 +464,37 @@ void MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void *data) { * If the flag is set to 1, the process will be automatically restarted when its host comes back up. */ XBT_PUBLIC(void) MSG_process_auto_restart_set(msg_process_t process, int auto_restart) { - simcall_process_auto_restart_set(process,auto_restart); + process->setAutoRestart(auto_restart); } -/* +/** * \ingroup m_process_management * \brief Restarts a process from the beginning. */ XBT_PUBLIC(msg_process_t) MSG_process_restart(msg_process_t process) { - return simcall_process_restart(process); + return process->restart(); +} + +/** @ingroup m_process_management + * @brief This process will be terminated automatically when the last non-daemon process finishes + */ +XBT_PUBLIC(void) MSG_process_daemonize(msg_process_t process) +{ + simgrid::simix::kernelImmediate([process]() { process->getImpl()->daemonize(); }); +} + +/** @ingroup m_process_management + * @brief Take an extra reference on that process to prevent it to be garbage-collected + */ +XBT_PUBLIC(void) MSG_process_ref(msg_process_t process) +{ + intrusive_ptr_add_ref(process); } +/** @ingroup m_process_management + * @brief Release a reference on that process so that it can get be garbage-collected + */ +XBT_PUBLIC(void) MSG_process_unref(msg_process_t process) +{ + intrusive_ptr_release(process); +} + +SG_END_DECL()