include/simgrid/s4u/VirtualMachine.hpp

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