Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
1406898e2acbee11dba57f474a82fc6bee8b329c
[simgrid.git] / src / bindings / java / org / simgrid / msg / VM.java
1 /* JNI interface to virtual machine in Simgrid */
2
3 /* Copyright (c) 2006-2014. The SimGrid Team.
4  * All rights reserved.                                                     */
5
6 /* This program is free software; you can redistribute it and/or modify it
7  * under the terms of the license (GNU LGPL) which comes with this package. */
8
9 package org.simgrid.msg;
10
11
12 public class VM extends Host{
13         // Please note that we are not declaring a new bind variable 
14         //(the bind variable has been inherited from the super class Host)
15
16         /* Static functions */ 
17         // GetByName is inherited from the super class Host
18
19
20         private static VM[] vms=null;     
21         private Host currentHost; 
22
23         /* Constructors / destructors */
24         /**
25          * Create a `basic' VM (i.e. 1 core, 1GB of RAM, other values are not taken into account).
26          */
27         public VM(Host host, String name) {
28                 this(host,name,1,1024, -1, null, -1,0 , 0);
29         }
30
31         /**
32          * Create a  VM
33          * @param host  Host node
34          * @param name name of the machine
35          * @param nCore number of core
36          * @param ramSize size of the RAM that should be allocated (in MBytes)
37          * @param netCap (not used for the moment)
38          * @param diskPath (not used for the moment)
39          * @param diskSize (not used for the moment)
40          * @param migNetSpeed (network bandwith allocated for migrations in MB/s, if you don't know put zero ;))
41          * @param dpIntensity (dirty page percentage according to migNetSpeed, [0-100], if you don't know put zero ;))
42          */
43         public VM(Host host, String name, int nCore,  int ramSize, 
44                         int netCap, String diskPath, int diskSize, int migNetSpeed, int dpIntensity){
45                 super();
46                 super.name = name; 
47                 this.currentHost = host; 
48                 create(host, name, nCore, ramSize, netCap, diskPath, diskSize, migNetSpeed, dpIntensity);
49                 VM.addVM(this);
50         }
51
52         private static void addVM(VM vm){
53                 VM[] vmsN=null; 
54                 int i=0;
55                 if(VM.vms == null)
56                         vmsN = new VM[1]; 
57                 else
58                         vmsN = new VM[vms.length+1]; 
59
60                 for (i=0; i<vmsN.length-1 ; i ++){
61                         vmsN[i]=vms[i]; 
62                 } 
63                 vmsN[i]=vm;
64                 vms=vmsN;
65         }
66         public static VM[] all(){
67                 return vms;
68         }
69         public static VM getVMByName(String name){
70                 for (int i=0 ; i < vms.length ; i++){
71                         if (vms[i].getName().equals(name))
72                                 return vms[i];          
73                 }
74                 return null; 
75         }
76         @Override
77         protected void finalize() {
78                 try {
79                         nativeFinalize();
80                 } catch (Throwable e) {
81                         e.printStackTrace();
82                 }
83         }
84
85
86         /* JNI / Native code */
87
88         /* get/set property methods are inherited from the Host class. */
89
90         /** Returns whether the given VM is currently suspended
91          */     
92         public native int isCreated();
93
94         /** Returns whether the given VM is currently running
95          */
96         public native int isRunning();
97
98         /** Returns whether the given VM is currently running
99          */
100         public native int isMigrating();
101
102         /** Returns whether the given VM is currently suspended
103          */     
104         public native int isSuspended();
105
106         /** Returns whether the given VM is currently saving
107          */
108         public native int isSaving();
109
110         /** Returns whether the given VM is currently saved
111          */
112         public native int isSaved();
113
114         /** Returns whether the given VM is currently restoring its state
115          */
116         public native boolean isRestoring();
117
118         /**
119          * Natively implemented method create the VM.
120          * @param nCore number of core
121          * @param ramSize size of the RAM that should be allocated (in MB)
122          * @param netCap (not used for the moment)
123          * @param diskPath (not used for the moment)
124          * @param diskSize (not used for the moment)
125          * @param migNetSpeed (network bandwith allocated for migrations in MB/s, if you don't know put zero ;))
126          * @param dpIntensity (dirty page intensity, a percentage of migNetSpeed [0-100],  if you don't know put zero ;))
127          */
128         private native void create(Host host, String name, int nCore, int ramSize, 
129                         int netCap, String diskPath, int diskSize, int migNetSpeed, int dpIntensity);
130
131
132         /**
133          * Bound the VM to a certain % of its vcpu capability (e.g. 75% of vm.getSpeed())
134          * @param load percentage (between [0,100]
135          */
136         public native void setBound(int load);
137
138         /**
139          * start the VM
140          */
141         public native void start();
142
143
144         /**
145          * Immediately kills all processes within the given VM. Any memory that they allocated will be leaked.
146          * No extra delay occurs. If you want to simulate this too, you want to use a MSG_process_sleep() or something
147          */
148         public native void shutdown();
149
150         /**  
151          * Invoke native migration routine
152          */
153         public native void internalmig(Host destination) throws Exception; // TODO add throws DoubleMigrationException (i.e. when you call migrate on a VM that is already migrating);
154
155
156
157         /** Change the host on which all processes are running
158          * (pre-copy is implemented)
159          */     
160         public void migrate(Host destination) throws HostFailureException{
161                 try {
162                         this.internalmig(destination);
163                 } catch (Exception e){
164                   Msg.info("Migration of VM "+this.getName()+" to "+destination.getName()+" is impossible ("+e.getMessage()+")");
165                   throw new HostFailureException();
166                 }
167                 // If the migration correcly returned, then we should change the currentHost value. 
168                 this.currentHost = destination; 
169         }
170
171         /** Immediately suspend the execution of all processes within the given VM
172          *
173          * No suspension cost occurs. If you want to simulate this too, you want to
174          * use a \ref File.write() before or after, depending on the exact semantic
175          * of VM suspend to you.
176          */     
177         public native void suspend();
178
179         /** Immediately resumes the execution of all processes within the given VM
180          *
181          * No resume cost occurs. If you want to simulate this too, you want to
182          * use a \ref File.read() before or after, depending on the exact semantic
183          * of VM resume to you.
184          */
185         public native void resume();
186
187         /** Immediately suspend the execution of all processes within the given VM 
188          *  and save its state on the persistent HDD
189          *  Not yet implemented (for the moment it behaves like suspend)
190          *  No suspension cost occurs. If you want to simulate this too, you want to
191          *  use a \ref File.write() before or after, depending on the exact semantic
192          *  of VM suspend to you.
193          */     
194         public native void save();
195
196         /** Immediately resumes the execution of all processes previously saved 
197          * within the given VM
198          *  Not yet implemented (for the moment it behaves like resume)
199          *
200          * No resume cost occurs. If you want to simulate this too, you want to
201          * use a \ref File.read() before or after, depending on the exact semantic
202          * of VM resume to you.
203          */
204         public native void restore();
205
206
207         private native void nativeFinalize();
208
209
210
211         /**
212          * Class initializer, to initialize various JNI stuff
213          */
214         public static native void nativeInit();
215         static {
216                 nativeInit();
217         }
218 }