include/simgrid/s4u/VirtualMachine.hpp

   1 /* Copyright (c) 2015-2023. 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/forward.h>
  10 #include <simgrid/s4u/Host.hpp>
  11 #include <xbt/utility.hpp>
  12
  13 namespace simgrid::s4u {
  14
  15 /** @brief Host extension for the VMs */
  16 class VmHostExt {
  17 public:
  18   static xbt::Extension<s4u::Host, VmHostExt> EXTENSION_ID;
  19
  20   sg_size_t ramsize = 0;    /* available ramsize (0= not taken into account) */
  21   bool overcommit   = true; /* Whether the host allows overcommiting more VM than the avail ramsize allows */
  22   static void ensureVmExtInstalled();
  23 };
  24
  25 /** @ingroup s4u_api
  26  *
  27  * @tableofcontents
  28  *
  29  * A VM represents a virtual machine (or a container) that hosts actors.
  30  * The total computing power that the contained actors can get is constrained to the virtual machine size.
  31  *
  32  */
  33 class XBT_PUBLIC VirtualMachine : public s4u::Host {
  34   kernel::resource::VirtualMachineImpl* const pimpl_vm_;
  35
  36   /* Signals about the life cycle of the VM */
  37   static xbt::signal<void(VirtualMachine&)> on_vm_creation;
  38   static xbt::signal<void(VirtualMachine const&)> on_start;
  39   static xbt::signal<void(VirtualMachine const&)> on_started;
  40   static xbt::signal<void(VirtualMachine const&)> on_shutdown;
  41   static xbt::signal<void(VirtualMachine const&)> on_suspend;
  42   static xbt::signal<void(VirtualMachine const&)> on_resume;
  43   static xbt::signal<void(VirtualMachine const&)> on_migration_start;
  44   static xbt::signal<void(VirtualMachine const&)> on_migration_end;
  45   static xbt::signal<void(VirtualMachine const&)> on_vm_destruction;
  46
  47 #ifndef DOXYGEN
  48   friend kernel::resource::VirtualMachineImpl; // calls signals from Impl
  49   friend kernel::resource::HostImpl;           // call private constructor
  50   explicit VirtualMachine(kernel::resource::VirtualMachineImpl* impl);
  51 #endif
  52
  53 public:
  54   XBT_ATTRIB_DEPRECATED_v336("Please use s4u::Host::create_vm") explicit VirtualMachine(const std::string& name,
  55                                                                                         Host* physical_host,
  56                                                                                         int core_amount,
  57                                                                                         size_t ramsize = 1024);
  58
  59 #ifndef DOXYGEN
  60   // No copy/move
  61   VirtualMachine(VirtualMachine const&) = delete;
  62   VirtualMachine& operator=(VirtualMachine const&) = delete;
  63 #endif
  64
  65   // enum class State { ... }
  66   XBT_DECLARE_ENUM_CLASS(State,
  67     CREATED, /**< created, but not yet started */
  68     RUNNING,
  69     SUSPENDED, /**< Suspend/resume does not involve disk I/O, so we assume there is no transition states. */
  70     DESTROYED
  71   );
  72
  73   kernel::resource::VirtualMachineImpl* get_vm_impl() const { return pimpl_vm_; }
  74   void start();
  75   void suspend();
  76   void resume();
  77   void shutdown();
  78   void destroy() override;
  79
  80   Host* get_pm() const;
  81   VirtualMachine* set_pm(Host* pm);
  82   size_t get_ramsize() const;
  83   VirtualMachine* set_ramsize(size_t ramsize);
  84   VirtualMachine* set_bound(double bound);
  85   void start_migration() const;
  86   void end_migration() const;
  87
  88   State get_state() const;
  89
  90   /* Callbacks on signals */
  91   static void on_creation_cb(const std::function<void(VirtualMachine&)>& cb) { on_vm_creation.connect(cb); }
  92   static void on_start_cb(const std::function<void(VirtualMachine const&)>& cb) { on_start.connect(cb); }
  93   static void on_started_cb(const std::function<void(VirtualMachine const&)>& cb) { on_started.connect(cb); }
  94   static void on_shutdown_cb(const std::function<void(VirtualMachine const&)>& cb) { on_shutdown.connect(cb); }
  95   static void on_suspend_cb(const std::function<void(VirtualMachine const&)>& cb) { on_suspend.connect(cb); }
  96   static void on_resume_cb(const std::function<void(VirtualMachine const&)>& cb) { on_resume.connect(cb); }
  97   static void on_destruction_cb(const std::function<void(VirtualMachine const&)>& cb) { on_vm_destruction.connect(cb); }
  98   static void on_migration_start_cb(const std::function<void(VirtualMachine const&)>& cb)
  99   {
 100     on_migration_start.connect(cb);
 101   }
 102   static void on_migration_end_cb(const std::function<void(VirtualMachine const&)>& cb)
 103   {
 104     on_migration_end.connect(cb);
 105   }
 106 };
 107 } // namespace simgrid::s4u
 108
 109 #endif