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         public void finalize() {
  78                 try {
  79                         nativeFinalize();
  80                 } catch (Throwable e) {
  81                         e.printStackTrace();
  82                 }
  83         }
  84         private native void nativeFinalize();
  85
  86
  87         /* JNI / Native code */
  88
  89         /* get/set property methods are inherited from the Host class. */
  90
  91         /** Returns whether the given VM is currently suspended
  92          */
  93         public native int isCreated();
  94
  95         /** Returns whether the given VM is currently running
  96          */
  97         public native int isRunning();
  98
  99         /** Returns whether the given VM is currently running
 100          */
 101         public native int isMigrating();
 102
 103         /** Returns whether the given VM is currently suspended
 104          */
 105         public native int isSuspended();
 106
 107         /** Returns whether the given VM is currently saving
 108          */
 109         public native int isSaving();
 110
 111         /** Returns whether the given VM is currently saved
 112          */
 113         public native int isSaved();
 114
 115         /** Returns whether the given VM is currently restoring its state
 116          */
 117         public native boolean isRestoring();
 118
 119         /**
 120          * Natively implemented method create the VM.
 121          * @param nCore number of core
 122          * @param ramSize size of the RAM that should be allocated (in MB)
 123          * @param netCap (not used for the moment)
 124          * @param diskPath (not used for the moment)
 125          * @param diskSize (not used for the moment)
 126          * @param migNetSpeed (network bandwith allocated for migrations in MB/s, if you don't know put zero ;))
 127          * @param dpIntensity (dirty page intensity, a percentage of migNetSpeed [0-100],  if you don't know put zero ;))
 128          */
 129         private native void create(Host host, String name, int nCore, int ramSize,
 130                         int netCap, String diskPath, int diskSize, int migNetSpeed, int dpIntensity);
 131
 132
 133         /**
 134          * Bound the VM to a certain % of its vcpu capability (e.g. 75% of vm.getSpeed())
 135          * @param load percentage (between [0,100]
 136          */
 137         public native void setBound(int load);
 138
 139         /**
 140          * start the VM
 141          */
 142         public native void start();
 143
 144
 145         /**
 146          * Immediately kills all processes within the given VM. Any memory that they allocated will be leaked.
 147          * No extra delay occurs. If you want to simulate this too, you want to use a MSG_process_sleep() or something
 148          */
 149         public native void shutdown();
 150
 151         /**
 152          * Invoke native migration routine
 153          */
 154         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);
 155
 156
 157
 158         /** Change the host on which all processes are running
 159          * (pre-copy is implemented)
 160          */
 161         public void migrate(Host destination) throws HostFailureException{
 162                 try {
 163                         this.internalmig(destination);
 164                 } catch (Exception e){
 165                   Msg.info("Migration of VM "+this.getName()+" to "+destination.getName()+" is impossible ("+e.getMessage()+")");
 166                   throw new HostFailureException();
 167                 }
 168                 // If the migration correcly returned, then we should change the currentHost value.
 169                 this.currentHost = destination;
 170         }
 171
 172         /** Immediately suspend the execution of all processes within the given VM
 173          *
 174          * No suspension cost occurs. If you want to simulate this too, you want to
 175          * use a \ref File.write() before or after, depending on the exact semantic
 176          * of VM suspend to you.
 177          */
 178         public native void suspend();
 179
 180         /** Immediately resumes the execution of all processes within the given VM
 181          *
 182          * No resume cost occurs. If you want to simulate this too, you want to
 183          * use a \ref File.read() before or after, depending on the exact semantic
 184          * of VM resume to you.
 185          */
 186         public native void resume();
 187
 188         /** Immediately suspend the execution of all processes within the given VM
 189          *  and save its state on the persistent HDD
 190          *  Not yet implemented (for the moment it behaves like suspend)
 191          *  No suspension cost occurs. If you want to simulate this too, you want to
 192          *  use a \ref File.write() before or after, depending on the exact semantic
 193          *  of VM suspend to you.
 194          */
 195         public native void save();
 196
 197         /** Immediately resumes the execution of all processes previously saved
 198          * within the given VM
 199          *  Not yet implemented (for the moment it behaves like resume)
 200          *
 201          * No resume cost occurs. If you want to simulate this too, you want to
 202          * use a \ref File.read() before or after, depending on the exact semantic
 203          * of VM resume to you.
 204          */
 205         public native void restore();
 206
 207
 208         /**
 209          * Class initializer, to initialize various JNI stuff
 210          */
 211         public static native void nativeInit();
 212         static {
 213                 nativeInit();
 214         }
 215 }