src/surf/HostImpl.hpp

   1 /* Copyright (c) 2004-2021. 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 #ifndef SURF_HOST_INTERFACE_HPP
   7 #define SURF_HOST_INTERFACE_HPP
   8
   9 #include "src/kernel/actor/ActorImpl.hpp"
  10 #include "src/kernel/resource/DiskImpl.hpp"
  11 #include "src/surf/cpu_interface.hpp"
  12 #include "src/surf/network_interface.hpp"
  13 #include <xbt/PropertyHolder.hpp>
  14
  15 #include <vector>
  16
  17 namespace simgrid {
  18 namespace surf {
  19
  20 /*********
  21  * Model *
  22  *********/
  23
  24 /** @ingroup SURF_host_interface
  25  * @brief SURF Host model interface class
  26  * @details A model is an object which handle the interactions between its Resources and its Actions
  27  */
  28 class XBT_PRIVATE HostModel : public kernel::resource::Model {
  29 public:
  30   using Model::Model;
  31   virtual kernel::resource::Action* execute_parallel(const std::vector<s4u::Host*>& host_list,
  32                                                      const double* flops_amount, const double* bytes_amount,
  33                                                      double rate) = 0;
  34 };
  35
  36 /************
  37  * Resource *
  38  ************/
  39 /** @ingroup SURF_host_interface
  40  * @brief SURF Host interface class
  41  * @details A host represents a machine with an aggregation of a Cpu, a RoutingEdge and Disk(s)
  42  */
  43 class XBT_PRIVATE HostImpl : public xbt::PropertyHolder {
  44   using ActorList = boost::intrusive::list<
  45       kernel::actor::ActorImpl,
  46       boost::intrusive::member_hook<kernel::actor::ActorImpl, boost::intrusive::list_member_hook<>,
  47                                     &kernel::actor::ActorImpl::host_actor_list_hook>>;
  48
  49   ActorList actor_list_;
  50   std::vector<kernel::actor::ProcessArg*> actors_at_boot_;
  51   s4u::Host piface_;
  52   std::vector<kernel::resource::DiskImpl*> disks_;
  53   xbt::string name_{"noname"};
  54   bool sealed_ = false;
  55
  56 protected:
  57   virtual ~HostImpl(); // Use destroy() instead of this destructor.
  58   HostImpl(const std::string& name, s4u::Host* piface);
  59
  60 public:
  61   friend simgrid::vm::VirtualMachineImpl;
  62   explicit HostImpl(const std::string& name);
  63
  64   void destroy(); // Must be called instead of the destructor
  65
  66   std::vector<s4u::Disk*> get_disks() const;
  67   HostImpl* set_disks(const std::vector<kernel::resource::DiskImpl*>& disks);
  68   s4u::Disk* create_disk(const std::string& name, double read_bandwidth, double write_bandwidth);
  69   void add_disk(const s4u::Disk* disk);
  70   void remove_disk(const std::string& disk_name);
  71
  72   virtual const s4u::Host* get_iface() const { return &piface_; }
  73   virtual s4u::Host* get_iface() { return &piface_; }
  74
  75   /** Retrieves the name of that host as a C++ string */
  76   xbt::string const& get_name() const { return name_; }
  77   /** Retrieves the name of that host as a C string */
  78   const char* get_cname() const { return name_.c_str(); }
  79
  80   void turn_on() const;
  81   void turn_off(const kernel::actor::ActorImpl* issuer);
  82   std::vector<s4u::ActorPtr> get_all_actors();
  83   size_t get_actor_count() const;
  84   void add_actor(kernel::actor::ActorImpl* actor) { actor_list_.push_back(*actor); }
  85   void remove_actor(kernel::actor::ActorImpl* actor) { xbt::intrusive_erase(actor_list_, *actor); }
  86   void add_actor_at_boot(kernel::actor::ProcessArg* arg) { actors_at_boot_.emplace_back(arg); }
  87
  88   void seal();
  89
  90   template <class F> void foreach_actor(F function)
  91   {
  92     for (auto& actor : actor_list_)
  93       function(actor);
  94   }
  95 };
  96 } // namespace surf
  97 } // namespace simgrid
  98
  99 #endif /* SURF_HOST_INTERFACE_HPP */