src/surf/virtual_machine.hpp

   1 /* Copyright (c) 2004-2015. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #include <deque>
   8 #include <boost/intrusive/list.hpp>
   9
  10 #include <xbt/base.h>
  11
  12 #include "src/surf/HostImpl.hpp"
  13
  14 #ifndef VM_INTERFACE_HPP_
  15 #define VM_INTERFACE_HPP_
  16
  17 #define GUESTOS_NOISE 100 // This value corresponds to the cost of the global action associated to the VM
  18                           // It corresponds to the cost of a VM running no tasks.
  19
  20 namespace simgrid {
  21 namespace surf {
  22
  23 /***********
  24  * Classes *
  25  ***********/
  26
  27 class XBT_PRIVATE VMModel;
  28 class XBT_PRIVATE VirtualMachine;
  29
  30 /*************
  31  * Callbacks *
  32  *************/
  33
  34 /** @ingroup SURF_callbacks
  35  * @brief Callbacks fired after VM creation. Signature: `void(VirtualMachine*)`
  36  */
  37 extern XBT_PRIVATE simgrid::xbt::signal<void(simgrid::surf::VirtualMachine*)> onVmCreation;
  38
  39 /** @ingroup SURF_callbacks
  40  * @brief Callbacks fired after VM destruction. Signature: `void(VirtualMachine*)`
  41  */
  42 extern XBT_PRIVATE simgrid::xbt::signal<void(simgrid::surf::VirtualMachine*)> onVmDestruction;
  43
  44 /** @ingroup SURF_callbacks
  45  * @brief Callbacks after VM State changes. Signature: `void(VirtualMachine*)`
  46  */
  47 extern XBT_PRIVATE simgrid::xbt::signal<void(simgrid::surf::VirtualMachine*)> onVmStateChange;
  48
  49 /************
  50  * Resource *
  51  ************/
  52
  53 /** @ingroup SURF_vm_interface
  54  * @brief SURF VM interface class
  55  * @details A VM represent a virtual machine
  56  */
  57 class VirtualMachine : public HostImpl {
  58 public:
  59   VirtualMachine(simgrid::surf::HostModel *model, const char *name, simgrid::s4u::Host *host);
  60   ~VirtualMachine();
  61
  62   /** @brief Suspend the VM */
  63   virtual void suspend();
  64
  65   /** @brief Resume the VM */
  66   virtual void resume();
  67
  68   /** @brief Save the VM (Not yet implemented) */
  69   virtual void save();
  70
  71   /** @brief Restore the VM (Not yet implemented) */
  72   virtual void restore();
  73
  74   /** @brief Migrate the VM to the destination host */
  75   virtual void migrate(sg_host_t dest_PM);
  76
  77   /** @brief Get the physical machine hosting the VM */
  78   sg_host_t getPm();
  79
  80   virtual void setBound(double bound);
  81
  82   /* The vm object of the lower layer */
  83   CpuAction *action_ = nullptr;
  84 protected:
  85   simgrid::s4u::Host *hostPM_;
  86
  87 public:
  88   void turnOn() override;
  89   void turnOff() override;
  90
  91   e_surf_vm_state_t getState();
  92   void setState(e_surf_vm_state_t state);
  93   static std::deque<VirtualMachine*> allVms_;
  94
  95 protected:
  96   e_surf_vm_state_t vmState_ = SURF_VM_STATE_CREATED;
  97 };
  98
  99 /*********
 100  * Model *
 101  *********/
 102 /** @ingroup SURF_vm_interface
 103  * @brief SURF VM model interface class
 104  * @details A model is an object which handle the interactions between its Resources and its Actions
 105  */
 106 class VMModel : public HostModel {
 107 public:
 108   VMModel() :HostModel() {}
 109   ~VMModel() = default;
 110
 111   /**
 112    * @brief Create a new VM
 113    *
 114    * @param name The name of the new VM
 115    * @param host_PM The real machine hosting the VM
 116    */
 117   s4u::Host *createVM(const char *name, sg_host_t host_PM);
 118   void adjustWeightOfDummyCpuActions() override {};
 119
 120   double nextOccuringEvent(double now) override;
 121   void updateActionsState(double /*now*/, double /*delta*/) override {};
 122
 123 };
 124
 125 }
 126 }
 127
 128 #endif /* VM_INTERFACE_HPP_ */