X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/5a15c64d854f8f8ecc35732c0534bd6cb4fb0bb8..1590bc9ec710e9849ddfd70a02b0842ca0206dbf:/src/kernel/actor/ActorImpl.hpp diff --git a/src/kernel/actor/ActorImpl.hpp b/src/kernel/actor/ActorImpl.hpp index d0c75f2c60..d6c3a36f1f 100644 --- a/src/kernel/actor/ActorImpl.hpp +++ b/src/kernel/actor/ActorImpl.hpp @@ -1,14 +1,15 @@ -/* Copyright (c) 2007-2019. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2007-2022. 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. */ -#ifndef SIMIX_ACTORIMPL_H -#define SIMIX_ACTORIMPL_H +#ifndef SIMGRID_KERNEL_ACTOR_ACTORIMPL_HPP +#define SIMGRID_KERNEL_ACTOR_ACTORIMPL_HPP +#include "Simcall.hpp" +#include "simgrid/kernel/Timer.hpp" #include "simgrid/s4u/Actor.hpp" -#include "src/simix/popping_private.hpp" -#include "src/surf/PropertyHolder.hpp" +#include "xbt/PropertyHolder.hpp" #include #include #include @@ -18,72 +19,115 @@ namespace simgrid { namespace kernel { namespace actor { +class ProcessArg; -class XBT_PUBLIC ActorImpl : public surf::PropertyHolder { - s4u::Host* host_ = nullptr; /* the host on which the actor is running */ - void* userdata_ = nullptr; /* kept for compatibility, it should be replaced with moddata */ +/*------------------------- [ ActorIDTrait ] -------------------------*/ +class XBT_PUBLIC ActorIDTrait { + xbt::string name_; aid_t pid_ = 0; aid_t ppid_ = -1; - bool daemon_ = false; /* Daemon actors are automatically killed when the last non-daemon leaves */ + +public: + explicit ActorIDTrait(std::string name, aid_t ppid); + const xbt::string& get_name() const { return name_; } + const char* get_cname() const { return name_.c_str(); } + aid_t get_pid() const { return pid_; } + aid_t get_ppid() const { return ppid_; } +}; +XBT_PUBLIC unsigned long get_maxpid(); +XBT_PUBLIC unsigned long* get_maxpid_addr(); // In MC mode, the application sends this pointers to the MC + +/*------------------------- [ ActorRestartingTrait ] -------------------------*/ +class XBT_PUBLIC ActorRestartingTrait { bool auto_restart_ = false; + int restart_count_ = 0; + + friend ActorImpl; public: - xbt::string name_; - ActorImpl(xbt::string name, s4u::Host* host); + bool has_to_auto_restart() const { return auto_restart_; } + void set_auto_restart(bool autorestart) { auto_restart_ = autorestart; } + int get_restart_count() const { return restart_count_; } +}; + +/*------------------------- [ ActorImpl ] -------------------------*/ +class XBT_PUBLIC ActorImpl : public xbt::PropertyHolder, public ActorIDTrait, public ActorRestartingTrait { + s4u::Host* host_ = nullptr; /* the host on which the actor is running */ + bool daemon_ = false; /* Daemon actors are automatically killed when the last non-daemon leaves */ + unsigned stacksize_; // set to default value in constructor + bool iwannadie_ = false; // True if we need to do some cleanups in actor mode. + bool to_be_freed_ = false; // True if cleanups in actor mode done, but cleanups in kernel mode pending + + std::vector mailboxes_; + friend activity::MailboxImpl; + +public: + ActorImpl(xbt::string name, s4u::Host* host, aid_t ppid); ActorImpl(const ActorImpl&) = delete; ActorImpl& operator=(const ActorImpl&) = delete; ~ActorImpl(); - double get_kill_time(); + /** Retrieve the actor implementation from its PID (or nullptr if non-existent) */ + static ActorImpl* by_pid(aid_t pid); + + static ActorImpl* self(); + double get_kill_time() const; void set_kill_time(double kill_time); - boost::intrusive::list_member_hook<> host_process_list_hook; /* simgrid::simix::Host::process_list */ - boost::intrusive::list_member_hook<> smx_destroy_list_hook; /* simix_global->actors_to_destroy */ + boost::intrusive::list_member_hook<> host_actor_list_hook; /* resource::HostImpl::actor_list_ */ + boost::intrusive::list_member_hook<> kernel_destroy_list_hook; /* EngineImpl actors_to_destroy */ boost::intrusive::list_member_hook<> smx_synchro_hook; /* {mutex,cond,sem}->sleeping */ - const xbt::string& get_name() const { return name_; } - const char* get_cname() const { return name_.c_str(); } + + // Life-cycle + bool wannadie() const { return iwannadie_; } + void set_wannadie(bool value = true); + bool to_be_freed() const { return to_be_freed_; } + void set_to_be_freed() { to_be_freed_ = true; } // Accessors to private fields - s4u::Host* get_host() { return host_; } + s4u::Host* get_host() const { return host_; } void set_host(s4u::Host* dest); - void* get_user_data() { return userdata_; } - void set_user_data(void* data) { userdata_ = data; } - aid_t get_pid() const { return pid_; } - aid_t get_ppid() const { return ppid_; } - void set_ppid(aid_t ppid) { ppid_ = ppid; } - bool is_daemon() { return daemon_; } /** Whether this actor has been daemonized */ - bool has_to_auto_restart() { return auto_restart_; } - void set_auto_restart(bool autorestart) { auto_restart_ = autorestart; } + bool is_maestro() const; /** Whether this actor is actually maestro (cheap call but may segfault before actor creation + / after terminaison) */ + void set_stacksize(unsigned stacksize) { stacksize_ = stacksize; } + unsigned get_stacksize() const { return stacksize_; } + + // Daemonize + bool is_daemon() const { return daemon_; } /** Whether this actor has been daemonized */ + void daemonize(); + void undaemonize(); std::unique_ptr context_; /* the context (uctx/raw/thread) that executes the user function */ std::exception_ptr exception_; - bool finished_ = false; bool suspended_ = false; - activity::ActivityImplPtr waiting_synchro = nullptr; /* the current blocking synchro if any */ - std::list comms; /* the current non-blocking communication synchros */ - s_smx_simcall simcall; - /* list of functions executed when the process dies */ + activity::ActivityImplPtr waiting_synchro_ = nullptr; /* the current blocking synchro if any */ + std::list activities_; /* the current non-blocking synchros */ + Simcall simcall_; + /* list of functions executed when the actor dies */ std::shared_ptr>> on_exit = std::make_shared>>(); - std::function code_; - simix::Timer* kill_timer = nullptr; + std::function code_; // to restart the actor on host reboot + timer::Timer* kill_timer_ = nullptr; private: /* Refcounting */ std::atomic_int_fast32_t refcount_{0}; public: - int get_refcount() { return refcount_; } + int get_refcount() const { return refcount_; } friend void intrusive_ptr_add_ref(ActorImpl* actor) { - // std::memory_order_relaxed ought to be enough here instead of std::memory_order_seq_cst - // But then, we have a threading issue when an actor commits a suicide: - // it seems that in this case, the worker thread kills the last occurrence of the actor - // while usually, the maestro does so. FIXME: we should change how actors suicide - actor->refcount_.fetch_add(1, std::memory_order_seq_cst); + // This whole memory consistency semantic drives me nuts. + // std::memory_order_relaxed proves to not be enough: There is a threading issue when actors commit suicide. + // My guess is that the maestro context wants to propagate changes to the actor's fields after the + // actor context frees that memory area or something. But I'm not 100% certain of what's going on. + // std::memory_order_seq_cst works but that's rather demanding. + // AFAIK, std::memory_order_acq_rel works on all tested platforms, so let's stick to it. + // Reducing the requirements to _relaxed would require to fix our suicide procedure, which is a messy piece of code. + actor->refcount_.fetch_add(1, std::memory_order_acq_rel); } friend void intrusive_ptr_release(ActorImpl* actor) { @@ -100,32 +144,31 @@ public: private: s4u::Actor piface_; // Our interface is part of ourselves - void undaemonize(); public: - s4u::ActorPtr iface() { return s4u::ActorPtr(&piface_); } - s4u::Actor* ciface() { return &piface_; } + s4u::ActorPtr get_iface() { return s4u::ActorPtr(&piface_); } + s4u::Actor* get_ciface() { return &piface_; } - ActorImplPtr init(const std::string& name, s4u::Host* host); - ActorImpl* start(const simix::ActorCode& code); + ActorImplPtr init(const std::string& name, s4u::Host* host) const; + ActorImpl* start(const ActorCode& code); - static ActorImplPtr create(const std::string& name, const simix::ActorCode& code, void* data, s4u::Host* host, - const std::unordered_map* properties, ActorImpl* parent_actor); - static ActorImplPtr attach(const std::string& name, void* data, s4u::Host* host, - const std::unordered_map* properties); + static ActorImplPtr create(const std::string& name, const ActorCode& code, void* data, s4u::Host* host, + const ActorImpl* parent_actor); + static ActorImplPtr create(ProcessArg* args); + static ActorImplPtr attach(const std::string& name, void* data, s4u::Host* host); static void detach(); - void cleanup(); + void cleanup_from_self(); + void cleanup_from_kernel(); void exit(); - void kill(ActorImpl* actor); - void kill_all(); + void kill(ActorImpl* actor) const; + void kill_all() const; void yield(); - void daemonize(); - bool is_suspended() { return suspended_; } + bool is_suspended() const { return suspended_; } s4u::Actor* restart(); void suspend(); void resume(); - activity::ActivityImplPtr join(ActorImpl* actor, double timeout); + activity::ActivityImplPtr join(const ActorImpl* actor, double timeout); activity::ActivityImplPtr sleep(double duration); /** Ask the actor to throw an exception right away */ void throw_exception(std::exception_ptr e); @@ -144,17 +187,20 @@ public: void* data = nullptr; s4u::Host* host = nullptr; double kill_time = 0.0; - std::shared_ptr> properties = nullptr; + const std::unordered_map properties{}; bool auto_restart = false; - bool daemon_ = false; - /* list of functions executed when the process dies */ + bool daemon_; + /* list of functions executed when the actor dies */ const std::shared_ptr>> on_exit; + int restart_count_ = 0; - ProcessArg() = default; + ProcessArg() = delete; + ProcessArg(const ProcessArg&) = delete; + ProcessArg& operator=(const ProcessArg&) = delete; explicit ProcessArg(const std::string& name, const std::function& code, void* data, s4u::Host* host, - double kill_time, std::shared_ptr> properties, - bool auto_restart) + double kill_time, const std::unordered_map& properties, + bool auto_restart, bool daemon, int restart_count) : name(name) , code(code) , data(data) @@ -162,34 +208,34 @@ public: , kill_time(kill_time) , properties(properties) , auto_restart(auto_restart) + , daemon_(daemon) + , restart_count_(restart_count) { } explicit ProcessArg(s4u::Host* host, ActorImpl* actor) : name(actor->get_name()) , code(actor->code_) - , data(actor->get_user_data()) + , data(actor->get_ciface()->get_data()) , host(host) , kill_time(actor->get_kill_time()) , auto_restart(actor->has_to_auto_restart()) , daemon_(actor->is_daemon()) , on_exit(actor->on_exit) + , restart_count_(actor->get_restart_count() + 1) { - properties.reset(actor->get_properties(), [](decltype(actor->get_properties())) {}); } }; /* Used to keep the list of actors blocked on a synchro */ -typedef boost::intrusive::list, - &ActorImpl::smx_synchro_hook>> - SynchroList; +using SynchroList = + boost::intrusive::list, + &ActorImpl::smx_synchro_hook>>; XBT_PUBLIC void create_maestro(const std::function& code); -XBT_PUBLIC int get_maxpid(); + } // namespace actor } // namespace kernel } // namespace simgrid -extern void (*SMPI_switch_data_segment)(simgrid::s4u::ActorPtr actor); - #endif