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