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. All rights reserved.          */
   4
   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. */
   7
   8 package org.simgrid.msg;
   9 import java.util.ArrayList;
  10
  11 public class VM extends Host {
  12         // No need to declare a new bind variable: we use the one inherited from the super class Host
  13
  14         /* Static functions */
  15
  16         private static ArrayList<VM> vms= new ArrayList<>();
  17         private Host currentHost;
  18
  19         /** Create a `basic' VM (i.e. 1GB of RAM, other values are not taken into account). */
  20         public VM(Host host, String name) {
  21                 this(host,name,1024, 0, 0);
  22         }
  23
  24         /**
  25          * Create a VM
  26          * @param host Host node
  27          * @param name name of the machine
  28          * @param ramSize size of the RAM that should be allocated (in MBytes)
  29          * @param migNetSpeed (network bandwith allocated for migrations in MB/s, if you don't know put zero ;))
  30          * @param dpIntensity (dirty page percentage according to migNetSpeed, [0-100], if you don't know put zero ;))
  31          */
  32         public VM(Host host, String name, int ramSize, int migNetSpeed, int dpIntensity){
  33                 super();
  34                 super.name = name;
  35                 this.currentHost = host;
  36                 create(host, name, ramSize, migNetSpeed, dpIntensity);
  37                 vms.add(this);
  38         }
  39
  40         public static VM[] all(){
  41                 VM[] allvms = new VM[vms.size()];
  42                 vms.toArray(allvms);
  43                 return allvms;
  44         }
  45
  46         public static VM getVMByName(String name){
  47                 for (VM vm : vms){
  48                         if (vm.getName().equals(name))
  49                                 return vm;
  50                 }
  51                 return null;
  52         }
  53
  54         /** Kills all the actors running on that VM
  55          *
  56          * Actually, this strictly equivalent to shutdown().
  57          * In C and in libvirt, the destroy function also releases the memory associated to the VM,
  58          * but this is not the way it goes in Java. The VM will only get destroyed by the garbage
  59          * collector when it is not referenced anymore by your variables. So, to see the VM really
  60          * destroyed, don't call this function but simply release any ref you have on it.
  61          */
  62         public void destroy() {
  63                 shutdown();
  64         }
  65
  66         /* Make sure that the GC also destroys the C object */
  67         protected void finalize() throws Throwable {
  68                 nativeFinalize();
  69         }
  70         public native void nativeFinalize();
  71
  72         /** Returns whether the given VM is currently suspended */
  73         public native int isCreated();
  74
  75         /** Returns whether the given VM is currently running */
  76         public native int isRunning();
  77
  78         /** Returns whether the given VM is currently running */
  79         public native int isMigrating();
  80
  81         /** Returns whether the given VM is currently suspended */
  82         public native int isSuspended();
  83
  84         /**
  85          * Natively implemented method create the VM.
  86          * @param ramSize size of the RAM that should be allocated (in MB)
  87          * @param migNetSpeed (network bandwith allocated for migrations in MB/s, if you don't know put zero ;))
  88          * @param dpIntensity (dirty page intensity, a percentage of migNetSpeed [0-100],  if you don't know put zero ;))
  89          */
  90         private native void create(Host host, String name, int ramSize, int migNetSpeed, int dpIntensity);
  91
  92
  93         /**
  94          * Set a CPU bound for a given VM.
  95          * @param bound in flops/s
  96          */
  97         public native void setBound(double bound);
  98
  99         /**  start the VM */
 100         public native void start();
 101
 102
 103         /**
 104          * Immediately kills all processes within the given VM.
 105          *
 106          * No extra delay occurs. If you want to simulate this too, you want to use a MSG_process_sleep()
 107          */
 108         public native void shutdown();
 109
 110         /** Invoke native migration routine */
 111         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);
 112
 113
 114
 115         /** Change the host on which all processes are running
 116          * (pre-copy is implemented)
 117          */
 118         public void migrate(Host destination) throws HostFailureException{
 119                 try {
 120                         this.internalmig(destination);
 121                 } catch (Exception e){
 122                   Msg.info("Migration of VM "+this.getName()+" to "+destination.getName()+" is impossible ("+e.getMessage()+")");
 123                   throw new HostFailureException();
 124                 }
 125                 // If the migration correcly returned, then we should change the currentHost value.
 126                 this.currentHost = destination;
 127         }
 128
 129         /** Immediately suspend the execution of all processes within the given VM
 130          *
 131          * No suspension cost occurs. If you want to simulate this too, you want to
 132          * use a \ref File.write() before or after, depending on the exact semantic
 133          * of VM suspend to you.
 134          */
 135         public native void suspend();
 136
 137         /** Immediately resumes the execution of all processes within the given VM
 138          *
 139          * No resume cost occurs. If you want to simulate this too, you want to
 140          * use a \ref File.read() before or after, depending on the exact semantic
 141          * of VM resume to you.
 142          */
 143         public native void resume();
 144
 145         /**  Class initializer (for JNI), don't do it yourself */
 146         public static native void nativeInit();
 147         static {
 148                 nativeInit();
 149         }
 150 }