src/plugins/vm/VirtualMachineImpl.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 #include "simgrid/s4u/VirtualMachine.hpp"
   7 #include "src/kernel/actor/ActorImpl.hpp"
   8 #include "src/surf/HostImpl.hpp"
   9 #include <algorithm>
  10 #include <deque>
  11 #include <unordered_map>
  12
  13 #ifndef VM_INTERFACE_HPP_
  14 #define VM_INTERFACE_HPP_
  15
  16 namespace simgrid {
  17
  18 extern template class XBT_PUBLIC xbt::Extendable<vm::VirtualMachineImpl>;
  19
  20 namespace vm {
  21
  22 /************
  23  * Resource *
  24  ************/
  25
  26 /** @ingroup SURF_vm_interface
  27  * @brief SURF VM interface class
  28  * @details A VM represent a virtual machine
  29  */
  30 class XBT_PUBLIC VirtualMachineImpl : public surf::HostImpl, public simgrid::xbt::Extendable<VirtualMachineImpl> {
  31   friend simgrid::s4u::VirtualMachine;
  32
  33 public:
  34   /** @brief Callbacks fired after VM creation. Signature: `void(VirtualMachineImpl&)` */
  35   static xbt::signal<void(simgrid::vm::VirtualMachineImpl&)> on_creation;
  36   /** @brief Callbacks fired after VM destruction. Signature: `void(VirtualMachineImpl const&)` */
  37   static xbt::signal<void(simgrid::vm::VirtualMachineImpl const&)> on_destruction;
  38
  39   static std::deque<s4u::VirtualMachine*> allVms_;
  40
  41   explicit VirtualMachineImpl(const std::string& name, s4u::VirtualMachine* piface, s4u::Host* host, int core_amount,
  42                               size_t ramsize);
  43   ~VirtualMachineImpl() override;
  44
  45   void suspend(kernel::actor::ActorImpl* issuer);
  46   void resume();
  47   void shutdown(kernel::actor::ActorImpl* issuer);
  48
  49   /** @brief Change the physical host on which the given VM is running */
  50   void set_physical_host(s4u::Host* dest);
  51   /** @brief Get the physical host on which the given VM is running */
  52   s4u::Host* get_physical_host() const { return physical_host_; }
  53
  54   sg_size_t get_ramsize() const { return ramsize_; }
  55   void set_ramsize(sg_size_t ramsize) { ramsize_ = ramsize; }
  56
  57   s4u::VirtualMachine::State get_state() const { return vm_state_; }
  58   void set_state(s4u::VirtualMachine::State state) { vm_state_ = state; }
  59
  60   unsigned int get_core_amount() const { return core_amount_; }
  61   kernel::resource::Action* get_action() const { return action_; }
  62
  63   const s4u::VirtualMachine* get_iface() const override { return piface_; }
  64   s4u::VirtualMachine* get_iface() override { return piface_; }
  65
  66   void set_bound(double bound);
  67
  68   void update_action_weight();
  69
  70   void add_active_exec() { active_execs_++; }
  71   void remove_active_exec() { active_execs_--; }
  72
  73   void start_migration() { is_migrating_ = true; }
  74   void end_migration() { is_migrating_ = false; }
  75   bool is_migrating() const { return is_migrating_; }
  76
  77 private:
  78   s4u::VirtualMachine* piface_;
  79   kernel::resource::Action* action_ = nullptr;
  80   unsigned int active_execs_        = 0;
  81   s4u::Host* physical_host_;
  82   unsigned int core_amount_;
  83   double user_bound_                   = std::numeric_limits<double>::max();
  84   size_t ramsize_                      = 0;
  85   s4u::VirtualMachine::State vm_state_ = s4u::VirtualMachine::State::CREATED;
  86   bool is_migrating_                   = false;
  87 };
  88
  89 /*********
  90  * Model *
  91  *********/
  92 /** @ingroup SURF_vm_interface
  93  * @brief SURF VM model interface class
  94  * @details A model is an object which handle the interactions between its Resources and its Actions
  95  */
  96 class XBT_PRIVATE VMModel : public surf::HostModel {
  97 public:
  98   explicit VMModel(const std::string& name);
  99
 100   double next_occurring_event(double now) override;
 101   void update_actions_state(double /*now*/, double /*delta*/) override{};
 102   kernel::resource::Action* execute_parallel(const std::vector<s4u::Host*>& host_list, const double* flops_amount,
 103                                              const double* bytes_amount, double rate) override
 104   {
 105     return nullptr;
 106   };
 107 };
 108 } // namespace vm
 109 } // namespace simgrid
 110
 111 #endif /* VM_INTERFACE_HPP_ */