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   /**
  57    * @brief Constructor
  58    *
  59    * @param model VMModel associated to this VM
  60    * @param name The name of the VM
  61    * @param props Dictionary of properties associated to this VM
  62    * @param host The host
  63    */
  64   VirtualMachine(simgrid::surf::HostModel *model, const char *name, xbt_dict_t props, simgrid::s4u::Host *host);
  65
  66   /** @brief Destructor */
  67   ~VirtualMachine();
  68
  69   /** @brief Suspend the VM */
  70   virtual void suspend()=0;
  71
  72   /** @brief Resume the VM */
  73   virtual void resume()=0;
  74
  75   /** @brief Save the VM (Not yet implemented) */
  76   virtual void save()=0;
  77
  78   /** @brief Restore the VM (Not yet implemented) */
  79   virtual void restore()=0;
  80
  81   /** @brief Migrate the VM to the destination host */
  82   virtual void migrate(sg_host_t dest_PM)=0;
  83
  84   /** @brief Get the physical machine hosting the VM */
  85   sg_host_t getPm();
  86
  87   virtual void setBound(double bound)=0;
  88   virtual void setAffinity(Cpu *cpu, unsigned long mask)=0;
  89
  90   /* The vm object of the lower layer */
  91   CpuAction *p_action;
  92   simgrid::s4u::Host *p_hostPM;
  93
  94   void turnOn() override;
  95   void turnOff() override;
  96
  97 public:
  98   e_surf_vm_state_t getState();
  99   void setState(e_surf_vm_state_t state);
 100 protected:
 101   e_surf_vm_state_t p_vm_state = SURF_VM_STATE_CREATED;
 102
 103 public:
 104   boost::intrusive::list_member_hook<> vm_hook;
 105 };
 106
 107 /*********
 108  * Model *
 109  *********/
 110 /** @ingroup SURF_vm_interface
 111  * @brief SURF VM model interface class
 112  * @details A model is an object which handle the interactions between its Resources and its Actions
 113  */
 114 class VMModel : public HostModel {
 115 public:
 116   VMModel() :HostModel(){}
 117   ~VMModel(){};
 118
 119   /**
 120    * @brief Create a new VM
 121    *
 122    * @param name The name of the new VM
 123    * @param host_PM The real machine hosting the VM
 124    */
 125   virtual VirtualMachine *createVM(const char *name, sg_host_t host_PM)=0;
 126   void adjustWeightOfDummyCpuActions() {};
 127
 128   typedef boost::intrusive::member_hook<
 129     VirtualMachine, boost::intrusive::list_member_hook<>, &VirtualMachine::vm_hook> VmOptions;
 130   typedef boost::intrusive::list<VirtualMachine, VmOptions, boost::intrusive::constant_time_size<false> > vm_list_t;
 131   static vm_list_t ws_vms;
 132 };
 133
 134 }
 135 }
 136
 137 #endif /* VM_INTERFACE_HPP_ */