Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Update copyright headers.
[simgrid.git] / src / bindings / java / org / simgrid / msg / VM.java
index 525ea39..8a9b108 100644 (file)
-/*
- * JNI interface to Cloud interface 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.
- */
+/* Java bindings of the s4u::VirtualMachine */
+
+/* Copyright (c) 2006-2018. The SimGrid Team. All rights 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;
 
-import org.simgrid.msg.Host;
-import org.simgrid.msg.Process;
+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;
 
-public class VM {
        /**
-        * This attribute represents a bind between a java task object and
-        * a native task. Even if this attribute is public you must never
-        * access to it. It is set automatically during the build of the object.
-        */
-       private long bind = 0;
-       
-       private int coreAmount;
+        * 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, /*coreAmount*/1, 1024, 0, 0);
+       }
 
-        private String name;
        /**
-        * @brief Create a new empty VM.
-        * @bug it is expected that in the future, the coreAmount parameter will be used
-        * to add extra constraints on the execution, but the argument is ignored for now.
-        */
+        * 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.coreAmount = coreAmount;
-               this.name = name;
-               start(host,name,coreAmount);
+               this(host,name, coreAmount, 1024, 0, 0);
        }
-       protected void finalize() {
-               destroy();
+
+       /**
+        * 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);
        }
+
        /**
-        * Destroy the VM
+        * 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 ;))
         */
-       protected native void destroy();
+       public VM(Host host, String name, int coreAmount, int ramSize, int migNetSpeed, int dpIntensity){
+               super();
+               super.name = name;
+               this.currentHost = host;
+               this.coreAmount = coreAmount;
+               create(host, name, coreAmount, ramSize, migNetSpeed, dpIntensity);
+       }
+
+       /** Retrieve the list of all existing VMs */
+       public static native VM[] all();
+
+       /** Retrieve a VM from its name */
+       public static native VM getVMByName(String name);
+
+       /* 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 */
+       public native int isRunning();
+
+       /** Returns whether the given VM is currently running */
+       public native int isMigrating();
+
+       /** Returns whether the given VM is currently suspended */      
+       public native int isSuspended();
+
+       /** Returns the amount of virtual CPUs provided */
+       public int getCoreAmount() {
+               return coreAmount;
+       }
+       
        /**
-        * Natively implemented method starting the VM.
-        * @param coreAmount
+        * Natively implemented method create the VM.
+        * @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 start(Host host, String name, int coreAmount);
-               
-       /** @brief Returns whether the given VM is currently suspended
-        */     
-       public native boolean isSuspended();
-       /** @brief Returns whether the given VM is currently running
+       private native void create(Host host, String name, int coreAmount, int ramSize, int migNetSpeed, int dpIntensity);
+
+       /**
+        * Set a CPU bound for a given VM.
+        * @param bound in flops/s
         */
-       public native boolean isRunning();
-       /** @brief Add the given process into the VM.
-        * Afterward, when the VM is migrated or suspended or whatever, the process will have the corresponding handling, too.
-        */     
-       public native void bind(Process process);
-       /** @brief Removes the given process from the given VM, and kill it
-        *  Will raise a ProcessNotFound exception if the process were not binded to that VM
-        */     
-       public native void unbind(Process process);
-       /** @brief Immediately change the host on which all processes are running
+       public native void setBound(double bound);
+
+       /**  start the VM */
+       public native void start();
+
+       /**
+        * Immediately kills all processes within the given VM.
         *
-        * No migration cost occurs. If you want to simulate this too, you want to use a
-        * Task.send() before or after, depending on whether you want to do cold or hot
-        * migration.
+        * No extra delay occurs. If you want to simulate this too, you want to use a MSG_process_sleep()
+        */
+       public native void shutdown();
+
+       /** Shutdown and unref the VM. */
+       public native void destroy();
+
+       /** Change the host on which all processes are running
+        * (pre-copy is implemented)
         */     
-       public native void migrate(Host destination);
-       /** @brief Immediately suspend the execution of all processes within the given VM
+       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();
-       /** @brief Immediately resumes the execution of all processes within the given VM
+
+       /** 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();
-       /**
-        * @brief 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
-        */
-       public native void shutdown();
-       /**
-        * @brief Reboot the VM, restarting all the processes in it.
-        */
-       public native void reboot();
 
-       public String getName() {
-               return name;
-       }               
+       /**  Class initializer (for JNI), don't do it yourself */
+       private static native void nativeInit();
+       static {
+               nativeInit();
+       }
 }