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 <xbt/base.h>
   8
   9 #include "src/surf/HostImpl.hpp"
  10
  11 #ifndef VM_INTERFACE_HPP_
  12 #define VM_INTERFACE_HPP_
  13
  14 #define GUESTOS_NOISE 100 // This value corresponds to the cost of the global action associated to the VM
  15                           // It corresponds to the cost of a VM running no tasks.
  16
  17 namespace simgrid {
  18 namespace surf {
  19
  20 /***********
  21  * Classes *
  22  ***********/
  23
  24 class XBT_PRIVATE VMModel;
  25 class XBT_PRIVATE VirtualMachine;
  26
  27 /*************
  28  * Callbacks *
  29  *************/
  30
  31 /** @ingroup SURF_callbacks
  32  * @brief Callbacks fired after VM creation. Signature: `void(VirtualMachine*)`
  33  */
  34 extern XBT_PRIVATE simgrid::xbt::signal<void(simgrid::surf::VirtualMachine*)> VMCreatedCallbacks;
  35
  36 /** @ingroup SURF_callbacks
  37  * @brief Callbacks fired after VM destruction. Signature: `void(VirtualMachine*)`
  38  */
  39 extern XBT_PRIVATE simgrid::xbt::signal<void(simgrid::surf::VirtualMachine*)> VMDestructedCallbacks;
  40
  41 /** @ingroup SURF_callbacks
  42  * @brief Callbacks after VM State changes. Signature: `void(VirtualMachine*)`
  43  */
  44 extern XBT_PRIVATE simgrid::xbt::signal<void(simgrid::surf::VirtualMachine*)> VMStateChangedCallbacks;
  45
  46 /************
  47  * Resource *
  48  ************/
  49
  50 /** @ingroup SURF_vm_interface
  51  * @brief SURF VM interface class
  52  * @details A VM represent a virtual machine
  53  */
  54 class VirtualMachine : public HostImpl {
  55 public:
  56   VirtualMachine(simgrid::surf::HostModel *model, const char *name, simgrid::s4u::Host *host);
  57   ~VirtualMachine();
  58
  59   /** @brief Suspend the VM */
  60   virtual void suspend()=0;
  61
  62   /** @brief Resume the VM */
  63   virtual void resume()=0;
  64
  65   /** @brief Save the VM (Not yet implemented) */
  66   virtual void save()=0;
  67
  68   /** @brief Restore the VM (Not yet implemented) */
  69   virtual void restore()=0;
  70
  71   /** @brief Migrate the VM to the destination host */
  72   virtual void migrate(sg_host_t dest_PM)=0;
  73
  74   /** @brief Get the physical machine hosting the VM */
  75   sg_host_t getPm();
  76
  77   virtual void setBound(double bound)=0;
  78   virtual void setAffinity(Cpu *cpu, unsigned long mask)=0;
  79
  80   /* The vm object of the lower layer */
  81   CpuAction *action_;
  82 protected:
  83   simgrid::s4u::Host *hostPM_;
  84
  85 public:
  86   void turnOn() override;
  87   void turnOff() override;
  88
  89   e_surf_vm_state_t getState();
  90   void setState(e_surf_vm_state_t state);
  91 protected:
  92   e_surf_vm_state_t p_vm_state = SURF_VM_STATE_CREATED;
  93
  94 public:
  95   boost::intrusive::list_member_hook<> vm_hook;
  96 };
  97
  98 /*********
  99  * Model *
 100  *********/
 101 /** @ingroup SURF_vm_interface
 102  * @brief SURF VM model interface class
 103  * @details A model is an object which handle the interactions between its Resources and its Actions
 104  */
 105 class VMModel : public HostModel {
 106 public:
 107   VMModel() :HostModel(){}
 108   ~VMModel(){};
 109
 110   /**
 111    * @brief Create a new VM
 112    *
 113    * @param name The name of the new VM
 114    * @param host_PM The real machine hosting the VM
 115    */
 116   virtual VirtualMachine *createVM(const char *name, sg_host_t host_PM)=0;
 117   void adjustWeightOfDummyCpuActions() {};
 118
 119   typedef boost::intrusive::member_hook<
 120     VirtualMachine, boost::intrusive::list_member_hook<>, &VirtualMachine::vm_hook> VmOptions;
 121   typedef boost::intrusive::list<VirtualMachine, VmOptions, boost::intrusive::constant_time_size<false> > vm_list_t;
 122   static vm_list_t ws_vms;
 123 };
 124
 125 }
 126 }
 127
 128 #endif /* VM_INTERFACE_HPP_ */