Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Update copyright headers.
[simgrid.git] / src / bindings / java / org / simgrid / msg / VM.java
index 68c92a4..8a9b108 100644 (file)
-/*
- * JNI interface to virtual machine in Simgrid
- * 
- * Copyright 2006-2012 The SimGrid Team.           
- * All right reserved. 
- *
- * This program is free software; you can redistribute 
- * it and/or modify it under the terms of the license 
- * (GNU LGPL) which comes with this package.
- */
-package org.simgrid.msg;
+/* Java bindings of the s4u::VirtualMachine */
 
-import org.simgrid.msg.Host;
-import org.simgrid.msg.Process;
+/* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved.          */
 
-public class VM extends Host{
-       // Please note that we are not declaring a new bind variable 
-       //(the bind variable has been inherited from the super class Host)
-       
-       /* Static functions */ 
-       // GetByName is inherited from the super class Host
-       
+/* This program is free software; you can redistribute it and/or modify it
+ * under the terms of the license (GNU LGPL) which comes with this package. */
 
-        private static VM[] vms=null;    
-    private Host currentHost; 
+package org.simgrid.msg;
 
-       /* Constructors / destructors */
-    /**
-        * Create a `basic' VM (i.e. 1 core, 1GB of RAM, other values are not taken into account).
-        */
+public class VM extends Host {
+       // No need to declare a new bind variable: we use the one inherited from the super class Host
+
+       private Host currentHost;
+       private int coreAmount = 1;
+
+       /**
+        * Create a `basic' VM : 1 core and 1GB of RAM.
+        * @param host Host node
+        * @param name name of the machine
+        */     
        public VM(Host host, String name) {
-               this(host,name,1,1024, -1, null, -1,0 , 0);
+               this(host,name, /*coreAmount*/1, 1024, 0, 0);
        }
 
        /**
-        * Create a  VM
-        * @param host, Host node
-        * @param name, name of the machine
-        * @param nCore, number of core
-        * @param ramSize, size of the RAM that should be allocated (in MBytes) 
-        * @param netCap (not used for the moment)
-        * @param diskPath (not used for the moment)
-        * @param diskSize (not used for the moment)
+        * Create a VM without useless values (for humans)
+        * @param host Host node
+        * @param name name of the machine
+        * @param coreAmount the amount of cores of the VM
+        */     
+       public VM(Host host, String name, int coreAmount) {
+               this(host,name, coreAmount, 1024, 0, 0);
+       }
+
+       /**
+        * Create a VM with 1 core
+        * @param host Host node
+        * @param name name of the machine
+        * @param ramSize size of the RAM that should be allocated (in MBytes)
+        * @param migNetSpeed (network bandwith allocated for migrations in MB/s, if you don't know put zero ;))
+        * @param dpIntensity (dirty page percentage according to migNetSpeed, [0-100], if you don't know put zero ;))
+        */     
+       public VM(Host host, String name, int ramSize, int migNetSpeed, int dpIntensity){
+               this(host, name, /*coreAmount*/1, ramSize, migNetSpeed, dpIntensity);
+       }
+
+       /**
+        * Create a VM
+        * @param host Host node
+        * @param name name of the machine
+        * @param coreAmount the amount of cores of the VM
+        * @param ramSize size of the RAM that should be allocated (in MBytes)
         * @param migNetSpeed (network bandwith allocated for migrations in MB/s, if you don't know put zero ;))
         * @param dpIntensity (dirty page percentage according to migNetSpeed, [0-100], if you don't know put zero ;))
         */
-       
-       public VM(Host host, String name, int nCore,  int ramSize, 
-                       int netCap, String diskPath, int diskSize, int migNetSpeed, int dpIntensity){
+       public VM(Host host, String name, int coreAmount, int ramSize, int migNetSpeed, int dpIntensity){
                super();
-               super.name = name; 
-               this.currentHost = host; 
-               create(host, name, nCore, ramSize, netCap, diskPath, diskSize, migNetSpeed, dpIntensity);
-               VM.addVM(this);
+               super.name = name;
+               this.currentHost = host;
+               this.coreAmount = coreAmount;
+               create(host, name, coreAmount, ramSize, migNetSpeed, dpIntensity);
        }
 
-       private static void addVM(VM vm){
-               VM[] vmsN=null; 
-               int i=0;
-               if(VM.vms == null)
-                       vmsN = new VM[1]; 
-               else
-                       vmsN = new VM[vms.length+1]; 
-               
-               for (i=0; i<vmsN.length-1 ; i ++){
-                       vmsN[i]=vms[i]; 
-               } 
-               vmsN[i]=vm;
-               vms=vmsN;
-       }
-   public static VM[] all(){
-               return vms;
-       }
-       public static VM getVMByName(String name){
-               for (int i=0 ; i < vms.length ; i++){
-                         if (vms[i].getName().equals(name))
-                                       return vms[i];          
-               }
-               return null; 
-       }
-       protected void finalize() {
-               destroy();
-       }
-       
+       /** Retrieve the list of all existing VMs */
+       public static native VM[] all();
 
-       /* JNI / Native code */
+       /** Retrieve a VM from its name */
+       public static native VM getVMByName(String name);
 
-       /* get/set property methods are inherited from the Host class. */
-       
-       /** Returns whether the given VM is currently suspended
-        */     
+       /* Make sure that the GC also destroys the C object */
+       protected void finalize() throws Throwable {
+               nativeFinalize();
+       }
+       private native void nativeFinalize();
+
+       /** Returns whether the given VM is currently suspended */      
        public native int isCreated();
-       
-       /** Returns whether the given VM is currently running
-        */
+
+       /** Returns whether the given VM is currently running */
        public native int isRunning();
 
-       /** Returns whether the given VM is currently running
-        */
+       /** Returns whether the given VM is currently running */
        public native int isMigrating();
-       
-       /** Returns whether the given VM is currently suspended
-        */     
+
+       /** Returns whether the given VM is currently suspended */      
        public native int isSuspended();
-               
-       /** Returns whether the given VM is currently saving
-        */
-       public native int isSaving();
-       
-       /** Returns whether the given VM is currently saved
-        */
-       public native int isSaved();
 
-       /** Returns whether the given VM is currently restoring its state
-        */
-       public native boolean isRestoring();
+       /** Returns the amount of virtual CPUs provided */
+       public int getCoreAmount() {
+               return coreAmount;
+       }
        
        /**
         * Natively implemented method create the VM.
-        * @param nCore, number of core
-        * @param ramSize, size of the RAM that should be allocated (in MB) 
-        * @param netCap (not used for the moment)
-        * @param diskPath (not used for the moment)
-        * @param diskSize (not used for the moment)
+        * @param ramSize size of the RAM that should be allocated (in MB)
         * @param migNetSpeed (network bandwith allocated for migrations in MB/s, if you don't know put zero ;))
         * @param dpIntensity (dirty page intensity, a percentage of migNetSpeed [0-100],  if you don't know put zero ;))
         */
-       private native void create(Host host, String name, int nCore, int ramSize, 
-                        int netCap, String diskPath, int diskSize, int migNetSpeed, int dpIntensity);
-
+       private native void create(Host host, String name, int coreAmount, int ramSize, int migNetSpeed, int dpIntensity);
 
        /**
-        * Bound the VM to a certain % of its vcpu capability (e.g. 75% of vm.getSpeed())
-        * @param load, percentage (between [0,100]
+        * Set a CPU bound for a given VM.
+        * @param bound in flops/s
         */
-       public native void setBound(int load);
+       public native void setBound(double bound);
 
-       /**
-        * start the VM
-        */
+       /**  start the VM */
        public native void start();
 
-       
        /**
-        * Immediately kills all processes within the given VM. Any memory that they allocated will be leaked.
-        * No extra delay occurs. If you want to simulate this too, you want to use a MSG_process_sleep() or something
+        * Immediately kills all processes within the given VM.
+        *
+        * No extra delay occurs. If you want to simulate this too, you want to use a MSG_process_sleep()
         */
        public native void shutdown();
-       
-       /**  
-        * Invoke native migration routine
-       */
-       public native void internalmig(Host destination);
 
-       
+       /** Shutdown and unref the VM. */
+       public native void destroy();
+
        /** Change the host on which all processes are running
         * (pre-copy is implemented)
         */     
-       public void migrate(Host destination){
-               this.internalmig(destination);
-               this.currentHost = destination; 
+       public void migrate(Host destination) throws HostFailureException{
+               try {
+                       this.nativeMigration(destination);
+               } catch (Exception e){
+                 Msg.info("Migration of VM "+this.getName()+" to "+destination.getName()+" is impossible ("+e.getMessage()+")");
+                 throw new HostFailureException();
+               }
+               // If the migration correcly returned, then we should change the currentHost value.
+               this.currentHost = destination;
        }
-       
+       private native void nativeMigration(Host destination) throws MsgException;
+
        /** Immediately suspend the execution of all processes within the given VM
         *
-        * No suspension cost occurs. If you want to simulate this too, you want to
-        * use a \ref File.write() before or after, depending on the exact semantic
-        * of VM suspend to you.
+        * No suspension cost occurs. If you want to simulate this too, you want to use a \ref File.write() before or
+        * after, depending on the exact semantic of VM suspend to you.
         */     
        public native void suspend();
-       
+
        /** Immediately resumes the execution of all processes within the given VM
         *
-        * No resume cost occurs. If you want to simulate this too, you want to
-        * use a \ref File.read() before or after, depending on the exact semantic
-        * of VM resume to you.
+        * No resume cost occurs. If you want to simulate this too, you want to use a \ref File.read() before or after,
+        * depending on the exact semantic of VM resume to you.
         */
        public native void resume();
-       
-       /** Immediately suspend the execution of all processes within the given VM 
-        *  and save its state on the persistent HDD
-        *  Not yet implemented (for the moment it behaves like suspend)
-        *  No suspension cost occurs. If you want to simulate this too, you want to
-        *  use a \ref File.write() before or after, depending on the exact semantic
-        *  of VM suspend to you.
-        */     
-       public native void save();
-       
-       /** Immediately resumes the execution of all processes previously saved 
-        * within the given VM
-        *  Not yet implemented (for the moment it behaves like resume)
-        *
-        * No resume cost occurs. If you want to simulate this too, you want to
-        * use a \ref File.read() before or after, depending on the exact semantic
-        * of VM resume to you.
-        */
-       public native void restore();
-       
 
-       /**
-        * Destroy the VM
-        */
-       public native void destroy();
-
-       
-
-       /**
-        * Class initializer, to initialize various JNI stuff
-        */
-       public static native void nativeInit();
+       /**  Class initializer (for JNI), don't do it yourself */
+       private static native void nativeInit();
        static {
                nativeInit();
        }