Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
further doxygen cleanups
[simgrid.git] / src / surf / vm_interface.hpp
1 /* Copyright (c) 2004-2014. The SimGrid Team.
2  * All rights reserved.                                                     */
3
4 /* This program is free software; you can redistribute it and/or modify it
5  * under the terms of the license (GNU LGPL) which comes with this package. */
6
7 #include "host_interface.hpp"
8
9 #ifndef VM_INTERFACE_HPP_
10 #define VM_INTERFACE_HPP_
11
12 #define GUESTOS_NOISE 100 // This value corresponds to the cost of the global action associated to the VM
13                           // It corresponds to the cost of a VM running no tasks.
14
15 /***********
16  * Classes *
17  ***********/
18
19 class VMModel;
20 class VM;
21
22 /*************
23  * Callbacks *
24  *************/
25
26 /** @ingroup SURF_callbacks
27  * @brief Callbacks fired after VM creation. Signature: `void(VM*)`
28  */
29 extern surf_callback(void, VM*) VMCreatedCallbacks;
30
31 /** @ingroup SURF_callbacks
32  * @brief Callbacks fired after VM destruction. Signature: `void(VM*)`
33  */
34 extern surf_callback(void, VM*) VMDestructedCallbacks;
35
36 /** @ingroup SURF_callbacks
37  * @brief Callbacks after VM State changes. Signature: `void(VMAction*)`
38  */
39 extern surf_callback(void, VM*) VMStateChangedCallbacks;
40
41 /*********
42  * Model *
43  *********/
44 /** @ingroup SURF_vm_interface
45  * @brief SURF VM model interface class
46  * @details A model is an object which handle the interactions between its Resources and its Actions
47  */
48 class VMModel : public HostModel {
49 public:
50   VMModel() :HostModel(){}
51   ~VMModel(){};
52
53   Host *createHost(const char *name){DIE_IMPOSSIBLE;}
54
55   /**
56    * @brief Create a new VM
57    *
58    * @param name The name of the new VM
59    * @param host_PM The real machine hosting the VM
60    *
61    */
62   virtual VM *createVM(const char *name, surf_resource_t host_PM)=0;
63   void adjustWeightOfDummyCpuActions() {};
64
65   typedef boost::intrusive::list<VM, boost::intrusive::constant_time_size<false> > vm_list_t;
66   static vm_list_t ws_vms;
67 };
68
69 /************
70  * Resource *
71  ************/
72
73 /** @ingroup SURF_vm_interface
74  * @brief SURF VM interface class
75  * @details A VM represent a virtual machine
76  */
77 class VM : public Host,
78            public boost::intrusive::list_base_hook<> {
79 public:
80   /**
81    * @brief Constructor
82    *
83    * @param model VMModel associated to this VM
84    * @param name The name of the VM
85    * @param props Dictionary of properties associated to this VM
86    * @param netElm The RoutingEdge associated to this VM
87    * @param cpu The Cpu associated to this VM
88    */
89   VM(Model *model, const char *name, xbt_dict_t props,
90                         RoutingEdge *netElm, Cpu *cpu);
91
92   /** @brief Destructor */
93   ~VM();
94
95   void setState(e_surf_resource_state_t state);
96
97   /** @brief Suspend the VM */
98   virtual void suspend()=0;
99
100   /** @brief Resume the VM */
101   virtual void resume()=0;
102
103   /** @brief Save the VM (Not yet implemented) */
104   virtual void save()=0;
105
106   /** @brief Restore the VM (Not yet implemented) */
107   virtual void restore()=0;
108
109   /** @brief Migrate the VM to the destination host */
110   virtual void migrate(surf_resource_t dest_PM)=0;
111
112   /** @brief Get the physical machine hosting the VM */
113   virtual surf_resource_t getPm()=0;
114
115   virtual void setBound(double bound)=0;
116   virtual void setAffinity(Cpu *cpu, unsigned long mask)=0;
117
118   /* The vm object of the lower layer */
119   CpuAction *p_action;
120   Host *p_subWs;  // Pointer to the ''host'' OS
121   e_surf_vm_state_t p_currentState;
122 };
123
124 /**********
125  * Action *
126  **********/
127
128 #endif /* VM_INTERFACE_HPP_ */