include/simgrid/s4u/VirtualMachine.hpp

   1 /* Copyright (c) 2015-2018. 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 #ifndef SIMGRID_S4U_VM_HPP
   7 #define SIMGRID_S4U_VM_HPP
   8
   9 #include <simgrid/s4u/Host.hpp>
  10
  11 enum e_surf_vm_state_t {
  12   SURF_VM_STATE_CREATED, /**< created, but not yet started */
  13   SURF_VM_STATE_RUNNING,
  14   SURF_VM_STATE_SUSPENDED, /**< Suspend/resume does not involve disk I/O, so we assume there is no transition states. */
  15   SURF_VM_STATE_DESTROYED
  16 };
  17
  18 namespace simgrid {
  19 namespace s4u {
  20
  21 /** @ingroup s4u_api
  22  *
  23  * @tableofcontents
  24  *
  25  * A VM represents a virtual machine (or a container) that hosts actors.
  26  * The total computing power that the contained actors can get is constrained to the virtual machine size.
  27  *
  28  */
  29 class XBT_PUBLIC VirtualMachine : public s4u::Host {
  30   simgrid::vm::VirtualMachineImpl* pimpl_vm_ = nullptr;
  31   virtual ~VirtualMachine();
  32
  33 public:
  34   explicit VirtualMachine(const char* name, s4u::Host* physical_host, int core_amount);
  35   explicit VirtualMachine(const char* name, s4u::Host* physical_host, int core_amount, size_t ramsize);
  36
  37   // No copy/move
  38   VirtualMachine(VirtualMachine const&) = delete;
  39   VirtualMachine& operator=(VirtualMachine const&) = delete;
  40
  41   simgrid::vm::VirtualMachineImpl* get_impl() { return pimpl_vm_; }
  42   void start();
  43   void suspend();
  44   void resume();
  45   void shutdown();
  46   void destroy();
  47
  48   simgrid::s4u::Host* get_pm();
  49   void set_pm(simgrid::s4u::Host* pm);
  50   size_t get_ramsize();
  51   void set_ramsize(size_t ramsize);
  52   void set_bound(double bound);
  53
  54   e_surf_vm_state_t getState();
  55   static simgrid::xbt::signal<void(VirtualMachine&)> on_start;
  56   static simgrid::xbt::signal<void(VirtualMachine&)> on_started;
  57   static simgrid::xbt::signal<void(VirtualMachine&)> on_shutdown;
  58   static simgrid::xbt::signal<void(VirtualMachine&)> on_suspend;
  59   static simgrid::xbt::signal<void(VirtualMachine&)> on_resume;
  60
  61   // Deprecated methods
  62   XBT_ATTRIB_DEPRECATED_v323("Please use VirtualMachine::get_impl()") simgrid::vm::VirtualMachineImpl* getImpl()
  63   {
  64     return pimpl_vm_;
  65   }
  66   XBT_ATTRIB_DEPRECATED_v323("Please use VirtualMachine::get_pm()") simgrid::s4u::Host* getPm() { return get_pm(); }
  67   XBT_ATTRIB_DEPRECATED_v323("Please use VirtualMachine::set_pm()") void setPm(simgrid::s4u::Host* pm) { set_pm(pm); }
  68   XBT_ATTRIB_DEPRECATED_v323("Please use VirtualMachine::get_ramsize()") size_t getRamsize() { return get_ramsize(); }
  69   XBT_ATTRIB_DEPRECATED_v323("Please use VirtualMachine::set_ramsize()") void setRamsize(size_t ramsize)
  70   {
  71     set_ramsize(ramsize);
  72   }
  73   XBT_ATTRIB_DEPRECATED_v323("Please use VirtualMachine::set_bound()") void setBound(double bound) { set_bound(bound); }
  74 };
  75 }
  76 } // namespace simgrid::s4u
  77
  78 #endif