Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'master' of https://github.com/mpoquet/simgrid
[simgrid.git] / src / bindings / java / org / simgrid / msg / Task.java
index d3e2894..26dc2b0 100644 (file)
@@ -25,49 +25,46 @@ public class Task {
 
        private double messageSize;
 
-       static private Long idCpt = 0L;
-
-       private Long id;
-
        /** Default constructor (all fields to 0 or null) */
        public Task() {
                create(null, 0, 0);
                this.messageSize = 0;
-               setId(idCpt);
-               idCpt++;
        }
 
        /* *              * *
         * * Constructors * *
         * *              * */
        /**
-        * Construct an new task with the specified processing amount and amount
+        * Construct a new task with the specified processing amount and amount
         * of data needed.
         *
         * @param name  Task's name
         *
         * @param flopsAmount   A value of the processing amount (in flop) needed to process the task. 
         *                              If 0, then it cannot be executed with the execute() method.
-        *                              This value has to be >= 0.
+        *                              This value has to be ≥ 0.
         *
         * @param bytesAmount           A value of amount of data (in bytes) needed to transfert this task.
         *                              If 0, then it cannot be transfered with the get() and put() methods.
-        *                              This value has to be >= 0.
+        *                              This value has to be ≥ 0.
         */ 
        public Task(String name, double flopsAmount, double bytesAmount) {
                create(name, flopsAmount, bytesAmount);
                this.messageSize = bytesAmount;
-               setId(idCpt);
-               idCpt++;
        }
        /**
-        * Construct an new parallel task with the specified processing amount and amount for each host
+        * Construct a new parallel task with the specified processing amount and amount for each host
         * implied.
         *
         * @param name          The name of the parallel task.
         * @param hosts         The list of hosts implied by the parallel task.
-        * @param flopsAmount   The amount of operations to be performed by each host of \a hosts.
-        * @param bytesAmount   A matrix describing the amount of data to exchange between hosts.
+        * @param flopsAmount   The amount of operations to be performed by each host of hosts. 
+        *                      flopsAmount[i] is the total number of operations that have to be 
+        *                      performed on hosts[i].
+        * @param bytesAmount   A matrix describing the amount of data to exchange between hosts. The 
+        *                      length of this array must be hosts.length * hosts.length. It is actually 
+        *                      used as a matrix with the lines being the source and the columns being 
+        *                      the destination of the communications.
         */ 
        public Task(String name, Host[]hosts, double[]flopsAmount, double[]bytesAmount) {
                parallelCreate(name, hosts, flopsAmount, bytesAmount);
@@ -76,7 +73,7 @@ public class Task {
        /**
         * The natively implemented method to create a MSG task.
         *
-        * @param name            The name of th task.
+        * @param name            The name of the task.
         * @param flopsAmount    A value of the processing amount (in flop) needed 
         *                        to process the task. If 0, then it cannot be executed
         *                        with the execute() method. This value has to be >= 0.
@@ -94,7 +91,7 @@ public class Task {
         * The natively implemented method to create a MSG parallel task.
         *
         * @param name                The name of the parallel task.
-        * @param hosts                The list of hosts implied by the parallel task.
+        * @param hosts               The list of hosts implied by the parallel task.
         * @param flopsAmount         The total number of operations that have to be performed
         *                            on the hosts.
         * @param bytesAmount        An array of doubles
@@ -108,7 +105,7 @@ public class Task {
        /* *                   * *
         * * Getters / Setters * *
         * *                   * */
-       /** Gets the name of a task */
+       /** Gets the name of the task */
        public String getName() {
                return name;
        }
@@ -163,23 +160,18 @@ public class Task {
         */
        public native void execute() throws HostFailureException,TaskCancelledException;
 
-       /** Bound a computation to a certain load */
-       public native void setBound(double load); 
+       /** Changes the maximum CPU utilization of a computation task. Unit is flops/s. */
+       public native void setBound(double bound); 
 
        /** Cancels a task. */ 
        public native void cancel();
 
-       /** Deletes a task.
-        *
-        * @exception                   NativeException if the destruction failed.
-        */ 
-       protected void finalize() throws NativeException {
-               destroy();
+       /** Deletes a task once the garbage collector reclaims it */
+       protected void finalize() throws Throwable{
+               nativeFinalize();
+               bind=0; // to avoid segfaults if the impossible happens yet again making this task surviving its finalize()
        }
-       /**
-        * The natively implemented method to destroy a MSG task.
-        */
-       protected native void destroy();
+       protected native void nativeFinalize();
        /* *                       * *
         * * Communication-related * *
         * *                       * */
@@ -205,7 +197,7 @@ public class Task {
         * @throws HostFailureException 
         * @throws TransferFailureException 
         */
-       public void send(String mailbox) throws TransferFailureException, HostFailureException, TimeoutException {
+       public void send(String mailbox) throws TransferFailureException, HostFailureException, TimeoutException, NativeException {
                send(mailbox, -1);
        } 
 
@@ -219,7 +211,7 @@ public class Task {
         * @throws HostFailureException 
         * @throws TransferFailureException 
         */
-       public native void send(String mailbox, double timeout) throws TransferFailureException, HostFailureException, TimeoutException;
+       public native void send(String mailbox, double timeout) throws TransferFailureException, HostFailureException, TimeoutException, NativeException;
 
        /** Sends the task on the specified mailbox (capping the sending rate to \a maxrate) 
         *
@@ -260,12 +252,14 @@ public class Task {
        /**
         * Starts listening for receiving a task from an asynchronous communication
         * @param mailbox
+        * @return a Comm handler
         */
        public static native Comm irecv(String mailbox);
        /**
         * Retrieves next task from the mailbox identified by the specified name
         *
         * @param mailbox
+        * @return a Task
         */
 
        public static Task receive(String mailbox) throws TransferFailureException, HostFailureException, TimeoutException {
@@ -277,6 +271,7 @@ public class Task {
         *
         * @param mailbox
         * @param timeout
+        * @return a Task
         */
        public static Task receive(String mailbox, double timeout) throws  TransferFailureException, HostFailureException, TimeoutException {
                return receive(mailbox, timeout, null);
@@ -287,6 +282,7 @@ public class Task {
         *
         * @param mailbox
         * @param host
+        * @return a Task
         */
 
        public static Task receive(String mailbox, Host host) throws TransferFailureException, HostFailureException, TimeoutException {
@@ -299,18 +295,21 @@ public class Task {
         * @param mailbox
         * @param timeout 
         * @param host
+        * @return a Task
         */
-       public native static Task receive(String mailbox, double timeout, Host host) throws TransferFailureException, HostFailureException, TimeoutException;
+       public static native Task receive(String mailbox, double timeout, Host host) throws TransferFailureException, HostFailureException, TimeoutException;
 
        /**
         * Starts listening for receiving a task from an asynchronous communication with a capped rate
         * @param mailbox
+        * @return a Comm handler
         */
        public static native Comm irecvBounded(String mailbox, double rate);
        /**
         * Retrieves next task from the mailbox identified by the specified name with a capped rate
         *
         * @param mailbox
+        * @return a Task
         */
 
        public static Task receiveBounded(String mailbox, double rate) throws TransferFailureException, HostFailureException, TimeoutException {
@@ -322,6 +321,7 @@ public class Task {
         *
         * @param mailbox
         * @param timeout
+        * @return a Task
         */
        public static Task receiveBounded(String mailbox, double timeout, double rate) throws  TransferFailureException, HostFailureException, TimeoutException {
                return receiveBounded(mailbox, timeout, null, rate);
@@ -332,6 +332,7 @@ public class Task {
         *
         * @param mailbox
         * @param host
+        * @return a Task
         */
 
        public static Task receiveBounded(String mailbox, Host host, double rate) throws TransferFailureException, HostFailureException, TimeoutException {
@@ -345,43 +346,31 @@ public class Task {
         * @param mailbox
         * @param timeout 
         * @param host
+        * @return a Task
         */
-       public native static Task receiveBounded(String mailbox, double timeout, Host host, double rate) throws TransferFailureException, HostFailureException, TimeoutException;
+       public static native Task receiveBounded(String mailbox, double timeout, Host host, double rate) throws TransferFailureException, HostFailureException, TimeoutException;
 
 
 
        /**
         * Tests whether there is a pending communication on the mailbox identified by the specified alias, and who sent it
         */
-       public native static int listenFrom(String mailbox);
+       public static native int listenFrom(String mailbox);
        /**
-        * Listen whether there is a waiting task on the mailbox identified by the specified alias
+        * Listen whether there is a task waiting (either for a send or a recv) on the mailbox identified by the specified alias
         */
-       public native static boolean listen(String mailbox);
-
-       /**
-        * Counts the number of tasks waiting to be received on the \a mailbox identified by the specified alia and sended by the specified \a host.
-        */
-       public native static int listenFromHost(String alias, Host host);
+       public static native boolean listen(String mailbox);
 
        /**
         * Class initializer, to initialize various JNI stuff
         */
        public static native void nativeInit();
        static {
-               Msg.nativeInit();
+               org.simgrid.NativeLib.nativeInit();
                nativeInit();
        }
 
        public double getMessageSize() {
                return this.messageSize;
        }
-
-       public Long getId() {
-               return id;
-       }
-
-       public void setId(Long id) {
-               this.id = id;
-       }
 }