src/surf/HostImpl.hpp

   1 /* Copyright (c) 2004-2022. 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/CpuImpl.hpp"
  11 #include "src/kernel/resource/DiskImpl.hpp"
  12 #include <xbt/PropertyHolder.hpp>
  13
  14 #include <vector>
  15
  16 namespace simgrid {
  17 namespace kernel {
  18 namespace resource {
  19 /*********
  20  * Model *
  21  *********/
  22
  23 /** @ingroup SURF_host_interface
  24  * @brief SURF Host model interface class
  25  * @details A model is an object which handle the interactions between its Resources and its Actions
  26  */
  27 class XBT_PRIVATE HostModel : public Model {
  28 public:
  29   using Model::Model;
  30   virtual Action* execute_thread(const s4u::Host* host, double flops_amount, int thread_count) = 0;
  31
  32   virtual Action* execute_parallel(const std::vector<s4u::Host*>& host_list, const double* flops_amount,
  33                                    const double* bytes_amount, 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 =
  45       boost::intrusive::list<actor::ActorImpl,
  46                              boost::intrusive::member_hook<actor::ActorImpl, boost::intrusive::list_member_hook<>,
  47                                                            &actor::ActorImpl::host_actor_list_hook>>;
  48
  49   ActorList actor_list_;
  50   std::vector<actor::ProcessArg*> actors_at_boot_;
  51   s4u::Host piface_;
  52   std::map<std::string, DiskImpl*, std::less<>> disks_;
  53   xbt::string name_{"noname"};
  54   routing::NetZoneImpl* englobing_zone_ = nullptr;
  55   bool sealed_ = false;
  56
  57 protected:
  58   virtual ~HostImpl(); // Use destroy() instead of this destructor.
  59   HostImpl(const std::string& name, s4u::Host* piface);
  60
  61 public:
  62   friend VirtualMachineImpl;
  63   explicit HostImpl(const std::string& name);
  64
  65   void destroy(); // Must be called instead of the destructor
  66
  67   std::vector<s4u::Disk*> get_disks() const;
  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& 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   routing::NetZoneImpl* get_englobing_zone() const { return englobing_zone_; }
  81   /** @brief Set the NetZone in which this Host is included */
  82   HostImpl* set_englobing_zone(routing::NetZoneImpl* netzone_p);
  83
  84   void turn_on() const;
  85   void turn_off(const actor::ActorImpl* issuer);
  86   std::vector<s4u::ActorPtr> get_all_actors();
  87   size_t get_actor_count() const;
  88   void add_actor(actor::ActorImpl* actor) { actor_list_.push_back(*actor); }
  89   void remove_actor(actor::ActorImpl* actor) { xbt::intrusive_erase(actor_list_, *actor); }
  90   void add_actor_at_boot(actor::ProcessArg* arg) { actors_at_boot_.emplace_back(arg); }
  91
  92   void seal();
  93
  94   template <class F> void foreach_actor(F function)
  95   {
  96     for (auto& actor : actor_list_)
  97       function(actor);
  98   }
  99 };
 100 } // namespace resource
 101 } // namespace kernel
 102 } // namespace simgrid
 103
 104 #endif /* HOST_INTERFACE_HPP */