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