1 /* Java bindings of the s4u::VirtualMachine */
3 /* Copyright (c) 2006-2017. The SimGrid Team. All rights reserved. */
5 /* This program is free software; you can redistribute it and/or modify it
6 * under the terms of the license (GNU LGPL) which comes with this package. */
8 package org.simgrid.msg;
10 public class VM extends Host {
11 // No need to declare a new bind variable: we use the one inherited from the super class Host
13 private Host currentHost;
14 private int coreAmount = 1;
16 /** Create a `basic' VM (i.e. 1GB of RAM, other values are not taken into account). */
17 public VM(Host host, String name) {
18 this(host,name, /*coreAmount*/1, 1024, 0, 0);
21 public VM(Host host, String name, int coreAmount) {
22 this(host,name, coreAmount, 1024, 0, 0);
24 public VM(Host host, String name, int ramSize, int migNetSpeed, int dpIntensity){
25 this(host, name, /*coreAmount*/1, ramSize, migNetSpeed, dpIntensity);
30 * @param host Host node
31 * @param name name of the machine
32 * @param ramSize size of the RAM that should be allocated (in MBytes)
33 * @param migNetSpeed (network bandwith allocated for migrations in MB/s, if you don't know put zero ;))
34 * @param dpIntensity (dirty page percentage according to migNetSpeed, [0-100], if you don't know put zero ;))
36 public VM(Host host, String name, int coreAmount, int ramSize, int migNetSpeed, int dpIntensity){
39 this.currentHost = host;
40 this.coreAmount = coreAmount;
41 create(host, name, coreAmount, ramSize, migNetSpeed, dpIntensity);
44 /** Retrieve the list of all existing VMs */
45 public static native VM[] all();
47 /** Retrieve a VM from its name */
48 public static native VM getVMByName(String name);
50 /** Shutdown and unref the VM.
52 * Actually, this strictly equivalent to shutdown().
53 * In C and in libvirt, the destroy function also releases the memory associated to the VM,
54 * but this is not the way it goes in Java. The VM will only get destroyed by the garbage
55 * collector when it is not referenced anymore by your variables. So, to see the VM really
56 * destroyed, don't call this function but simply release any ref you have on it.
58 public void destroy() {
62 /* Make sure that the GC also destroys the C object */
63 protected void finalize() throws Throwable {
66 private native void nativeFinalize();
68 /** Returns whether the given VM is currently suspended */
69 public native int isCreated();
71 /** Returns whether the given VM is currently running */
72 public native int isRunning();
74 /** Returns whether the given VM is currently running */
75 public native int isMigrating();
77 /** Returns whether the given VM is currently suspended */
78 public native int isSuspended();
80 /** Returns the amount of virtual CPUs provided */
81 public int getCoreAmount() {
86 * Natively implemented method create the VM.
87 * @param ramSize size of the RAM that should be allocated (in MB)
88 * @param migNetSpeed (network bandwith allocated for migrations in MB/s, if you don't know put zero ;))
89 * @param dpIntensity (dirty page intensity, a percentage of migNetSpeed [0-100], if you don't know put zero ;))
91 private native void create(Host host, String name, int coreAmount, int ramSize, int migNetSpeed, int dpIntensity);
95 * Set a CPU bound for a given VM.
96 * @param bound in flops/s
98 public native void setBound(double bound);
101 public native void start();
105 * Immediately kills all processes within the given VM.
107 * No extra delay occurs. If you want to simulate this too, you want to use a MSG_process_sleep()
109 public native void shutdown();
111 /** Change the host on which all processes are running
112 * (pre-copy is implemented)
114 public void migrate(Host destination) throws HostFailureException{
116 this.nativeMigration(destination);
117 } catch (Exception e){
118 Msg.info("Migration of VM "+this.getName()+" to "+destination.getName()+" is impossible ("+e.getMessage()+")");
119 throw new HostFailureException();
121 // If the migration correcly returned, then we should change the currentHost value.
122 this.currentHost = destination;
124 private native void nativeMigration(Host destination) throws MsgException;
126 /** Immediately suspend the execution of all processes within the given VM
128 * No suspension cost occurs. If you want to simulate this too, you want to
129 * use a \ref File.write() before or after, depending on the exact semantic
130 * of VM suspend to you.
132 public native void suspend();
134 /** Immediately resumes the execution of all processes within the given VM
136 * No resume cost occurs. If you want to simulate this too, you want to
137 * use a \ref File.read() before or after, depending on the exact semantic
138 * of VM resume to you.
140 public native void resume();
142 /** Class initializer (for JNI), don't do it yourself */
143 private static native void nativeInit();