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 public:
  38   explicit VirtualMachine(const std::string& name, Host* physical_host, int core_amount);
  39   explicit VirtualMachine(const std::string& name, Host* physical_host, int core_amount, size_t ramsize);
  40
  41 #ifndef DOXYGEN
  42   // No copy/move
  43   VirtualMachine(VirtualMachine const&) = delete;
  44   VirtualMachine& operator=(VirtualMachine const&) = delete;
  45 #endif
  46
  47   // enum class State { ... }
  48   XBT_DECLARE_ENUM_CLASS(State,
  49     CREATED, /**< created, but not yet started */
  50     RUNNING,
  51     SUSPENDED, /**< Suspend/resume does not involve disk I/O, so we assume there is no transition states. */
  52     DESTROYED
  53   );
  54 #ifndef DOXYGEN
  55   using state XBT_ATTRIB_DEPRECATED_v332("Please use VirtualMachine::State") = State;
  56 #endif
  57
  58   kernel::resource::VirtualMachineImpl* get_vm_impl() const { return pimpl_vm_; }
  59   void start();
  60   void suspend();
  61   void resume();
  62   void shutdown();
  63   void destroy() override;
  64
  65   Host* get_pm() const;
  66   VirtualMachine* set_pm(Host* pm);
  67   size_t get_ramsize() const;
  68   VirtualMachine* set_ramsize(size_t ramsize);
  69   VirtualMachine* set_bound(double bound);
  70
  71   State get_state() const;
  72   static void on_creation_cb(const std::function<void(VirtualMachine&)>& cb) { on_creation.connect(cb); }
  73   static void on_start_cb(const std::function<void(VirtualMachine const&)>& cb) { on_start.connect(cb); }
  74   static void on_started_cb(const std::function<void(VirtualMachine const&)>& cb) { on_started.connect(cb); }
  75   static void on_shutdown_cb(const std::function<void(VirtualMachine const&)>& cb) { on_shutdown.connect(cb); }
  76   static void on_suspend_cb(const std::function<void(VirtualMachine const&)>& cb) { on_suspend.connect(cb); }
  77   static void on_resume_cb(const std::function<void(VirtualMachine const&)>& cb) { on_resume.connect(cb); }
  78   static void on_destruction_cb(const std::function<void(VirtualMachine const&)>& cb) { on_destruction.connect(cb); }
  79   static void on_migration_start_cb(const std::function<void(VirtualMachine const&)>& cb)
  80   {
  81     on_migration_start.connect(cb);
  82   }
  83   static void on_migration_end_cb(const std::function<void(VirtualMachine const&)>& cb)
  84   {
  85     on_migration_end.connect(cb);
  86   }
  87 #ifndef DOXYGEN
  88   /* FIXME the signals should be private */
  89   static xbt::signal<void(VirtualMachine const&)> on_migration_start;
  90   static xbt::signal<void(VirtualMachine const&)> on_migration_end;
  91   static xbt::signal<void(VirtualMachine const&)> on_destruction;
  92 #endif
  93
  94 private:
  95   static xbt::signal<void(VirtualMachine&)> on_creation;
  96   static xbt::signal<void(VirtualMachine const&)> on_start;
  97   static xbt::signal<void(VirtualMachine const&)> on_started;
  98   static xbt::signal<void(VirtualMachine const&)> on_shutdown;
  99   static xbt::signal<void(VirtualMachine const&)> on_suspend;
 100   static xbt::signal<void(VirtualMachine const&)> on_resume;
 101 };
 102 } // namespace s4u
 103 } // namespace simgrid
 104
 105 #endif