1 /* Copyright (c) 2015-2022. The SimGrid Team. All rights reserved. */
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. */
6 #ifndef SIMGRID_S4U_VM_HPP
7 #define SIMGRID_S4U_VM_HPP
9 #include <simgrid/forward.h>
10 #include <simgrid/s4u/Host.hpp>
11 #include <xbt/utility.hpp>
16 /** @brief Host extension for the VMs */
19 static xbt::Extension<s4u::Host, VmHostExt> EXTENSION_ID;
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();
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.
34 class XBT_PUBLIC VirtualMachine : public s4u::Host {
35 kernel::resource::VirtualMachineImpl* const pimpl_vm_;
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;
49 explicit VirtualMachine(const std::string& name, Host* physical_host, int core_amount, size_t ramsize = 1024);
53 VirtualMachine(VirtualMachine const&) = delete;
54 VirtualMachine& operator=(VirtualMachine const&) = delete;
57 // enum class State { ... }
58 XBT_DECLARE_ENUM_CLASS(State,
59 CREATED, /**< created, but not yet started */
61 SUSPENDED, /**< Suspend/resume does not involve disk I/O, so we assume there is no transition states. */
65 using state XBT_ATTRIB_DEPRECATED_v332("Please use VirtualMachine::State") = State;
68 kernel::resource::VirtualMachineImpl* get_vm_impl() const { return pimpl_vm_; }
73 void destroy() override;
76 VirtualMachine* set_pm(Host* pm);
77 size_t get_ramsize() const;
78 VirtualMachine* set_ramsize(size_t ramsize);
79 VirtualMachine* set_bound(double bound);
80 void start_migration() const;
81 void end_migration() const;
83 State get_state() const;
85 /* Callbacks on signals */
86 static void on_creation_cb(const std::function<void(VirtualMachine&)>& cb) { on_creation.connect(cb); }
87 static void on_start_cb(const std::function<void(VirtualMachine const&)>& cb) { on_start.connect(cb); }
88 static void on_started_cb(const std::function<void(VirtualMachine const&)>& cb) { on_started.connect(cb); }
89 static void on_shutdown_cb(const std::function<void(VirtualMachine const&)>& cb) { on_shutdown.connect(cb); }
90 static void on_suspend_cb(const std::function<void(VirtualMachine const&)>& cb) { on_suspend.connect(cb); }
91 static void on_resume_cb(const std::function<void(VirtualMachine const&)>& cb) { on_resume.connect(cb); }
92 static void on_destruction_cb(const std::function<void(VirtualMachine const&)>& cb) { on_destruction.connect(cb); }
93 static void on_migration_start_cb(const std::function<void(VirtualMachine const&)>& cb)
95 on_migration_start.connect(cb);
97 static void on_migration_end_cb(const std::function<void(VirtualMachine const&)>& cb)
99 on_migration_end.connect(cb);
103 } // namespace simgrid