src/bindings/java/org/simgrid/msg/Task.java

   1 /* Copyright (c) 2006-2014. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 package org.simgrid.msg;
   8
   9 /**
  10  * A task is either something to compute somewhere, or something to exchange between two hosts (or both).
  11  * It is defined by a computing amount and a message size.
  12  *
  13  */
  14 public class Task {
  15         /**
  16          * This attribute represents a bind between a java task object and
  17          * a native task. Even if this attribute is public you must never
  18          * access to it. It is set automatically during the build of the object.
  19          */
  20         private long bind = 0;
  21         /**
  22          * Task name
  23          */
  24         protected String name;
  25
  26         private double messageSize;
  27
  28         static private Long idCpt = 0L;
  29
  30         private Long id;
  31
  32         /** Default constructor (all fields to 0 or null) */
  33         public Task() {
  34                 create(null, 0, 0);
  35                 this.messageSize = 0;
  36                 setId(idCpt);
  37                 idCpt++;
  38         }
  39
  40         /* *              * *
  41          * * Constructors * *
  42          * *              * */
  43         /**
  44          * Construct an new task with the specified processing amount and amount
  45          * of data needed.
  46          *
  47          * @param name  Task's name
  48          *
  49          * @param flopsAmount   A value of the processing amount (in flop) needed to process the task.
  50          *                              If 0, then it cannot be executed with the execute() method.
  51          *                              This value has to be >= 0.
  52          *
  53          * @param bytesAmount           A value of amount of data (in bytes) needed to transfert this task.
  54          *                              If 0, then it cannot be transfered with the get() and put() methods.
  55          *                              This value has to be >= 0.
  56          */
  57         public Task(String name, double flopsAmount, double bytesAmount) {
  58                 create(name, flopsAmount, bytesAmount);
  59                 this.messageSize = bytesAmount;
  60                 setId(idCpt);
  61                 idCpt++;
  62         }
  63         /**
  64          * Construct an new parallel task with the specified processing amount and amount for each host
  65          * implied.
  66          *
  67          * @param name          The name of the parallel task.
  68          * @param hosts         The list of hosts implied by the parallel task.
  69          * @param flopsAmount   The amount of operations to be performed by each host of \a hosts.
  70          * @param bytesAmount   A matrix describing the amount of data to exchange between hosts.
  71          */
  72         public Task(String name, Host[]hosts, double[]flopsAmount, double[]bytesAmount) {
  73                 parallelCreate(name, hosts, flopsAmount, bytesAmount);
  74         }
  75
  76         /**
  77          * The natively implemented method to create a MSG task.
  78          *
  79          * @param name            The name of th task.
  80          * @param flopsAmount    A value of the processing amount (in flop) needed
  81          *                        to process the task. If 0, then it cannot be executed
  82          *                        with the execute() method. This value has to be >= 0.
  83          * @param bytesAmount        A value of amount of data (in bytes) needed to transfert
  84          *                        this task. If 0, then it cannot be transfered this task.
  85          *                        If 0, then it cannot be transfered with the get() and put()
  86          *                        methods. This value has to be >= 0.
  87          * @exception             IllegalArgumentException if compute duration <0 or message size <0
  88          */
  89         private final native void create(String name,
  90                         double flopsAmount,
  91                         double bytesAmount)
  92         throws IllegalArgumentException;
  93         /**
  94          * The natively implemented method to create a MSG parallel task.
  95          *
  96          * @param name                The name of the parallel task.
  97          * @param hosts                The list of hosts implied by the parallel task.
  98          * @param flopsAmount         The total number of operations that have to be performed
  99          *                            on the hosts.
 100          * @param bytesAmount        An array of doubles
 101          *
 102          */
 103         private final native void parallelCreate(String name,
 104                         Host[]hosts,
 105                         double[]flopsAmount,
 106                         double[]bytesAmount)
 107         throws NullPointerException, IllegalArgumentException;
 108         /* *                   * *
 109          * * Getters / Setters * *
 110          * *                   * */
 111     /**
 112      * Gets the name of a task
 113      */
 114         public String getName() {
 115                 return name;
 116         }
 117         /**
 118          * Gets the sender of the task
 119          * Returns null if the task hasn't been sent yet
 120          */
 121         public native Process getSender();
 122         /** Gets the source of the task.
 123          * Returns null if the task hasn't been sent yet.
 124      */
 125         public native Host getSource();
 126
 127         /** Gets the remaining amount of flops to execute in this task
 128          *
 129          * If it's ongoing, you get the exact amount at the present time. If it's already done, it's 0.
 130          */
 131         public native double getFlopsAmount();
 132         /**
 133          * Sets the name of the task
 134          * @param name the new task name.c
 135          */
 136         public native void setName(String name);
 137         /**
 138          * This method sets the priority of the computation of the task.
 139          * The priority doesn't affect the transfer rate. For example a
 140          * priority of 2 will make the task receive two times more cpu than
 141          * the other ones.
 142          *
 143          * @param priority      The new priority of the task.
 144          */
 145         public native void setPriority(double priority);
 146         /**
 147          * Set the computation amount needed to process the task
 148          * @param computationAmount the amount of computation needed to process the task
 149          */
 150         public native void setComputeDuration(double computationAmount);
 151         /**
 152          * Set the data size of the task
 153          * @param dataSize the size of the task
 154          */
 155         public native void setDataSize(double dataSize);
 156         /* *                     * *
 157          * * Computation-related * *
 158          * *                     * */
 159         /**
 160          * Executes a task on the location on which the process is running.
 161          *
 162      *
 163      * @throws HostFailureException
 164      * @throws TaskCancelledException
 165      */
 166         public native void execute() throws HostFailureException,TaskCancelledException;
 167         /**
 168          * Bound a computation to a certain load
 169          *
 170          */
 171         public native void setBound(double load);
 172         /**
 173          * Cancels a task.
 174          *
 175          */
 176         public native void cancel();
 177         /** Deletes a task.
 178          *
 179          * @exception                   NativeException if the destruction failed.
 180          */
 181         protected void finalize() throws NativeException {
 182                 destroy();
 183         }
 184         /**
 185          * The natively implemented method to destroy a MSG task.
 186          */
 187         protected native void destroy();
 188         /* *                       * *
 189          * * Communication-related * *
 190          * *                       * */
 191
 192         /** Send the task asynchronously on the mailbox identified by the specified name,
 193          *  with no way to retrieve whether the communication succeeded or not
 194          *
 195          */
 196         public native void dsendBounded(String mailbox, double maxrate);
 197
 198
 199         /** Send the task asynchronously on the mailbox identified by the specified name,
 200          *  with no way to retrieve whether the communication succeeded or not
 201          *
 202          */
 203         public native void dsend(String mailbox);
 204
 205         /**
 206          * Sends the task on the mailbox identified by the specified name
 207          *
 208      * @param mailbox
 209      * @throws TimeoutException
 210          * @throws HostFailureException
 211          * @throws TransferFailureException
 212          */
 213         public void send(String mailbox) throws TransferFailureException, HostFailureException, TimeoutException {
 214                 send(mailbox, -1);
 215         }
 216
 217         /**
 218          * Sends the task on the mailbox identified by the specified name (wait at most \a timeout seconds)
 219          *
 220      * @param mailbox
 221      * @param timeout
 222      * @exception  NativeException if the retrieval fails.
 223          * @throws TimeoutException
 224          * @throws HostFailureException
 225          * @throws TransferFailureException
 226          */
 227         public native void send(String mailbox, double timeout) throws TransferFailureException, HostFailureException, TimeoutException;
 228         /**
 229          * Sends the task on the mailbox identified by the specified alias  (capping the sending rate to \a maxrate)
 230          *
 231      * @param alias
 232      * @param maxrate
 233      * @throws TransferFailureException
 234      * @throws HostFailureException
 235      * @throws TimeoutException
 236          */
 237         public void sendBounded(String alias, double maxrate) throws TransferFailureException, HostFailureException, TimeoutException {
 238               sendBounded(alias,-1,maxrate);
 239         }
 240
 241
 242 /**
 243          * Sends the task on the mailbox identified by the specified alias  (capping the sending rate to \a maxrate) with a timeout
 244          *
 245      * @param alias
 246      * @param timeout
 247      * @param maxrate
 248      * @throws TransferFailureException
 249      * @throws HostFailureException
 250      * @throws TimeoutException
 251          */
 252         public native void sendBounded(String alias, double timeout, double maxrate) throws TransferFailureException, HostFailureException, TimeoutException;
 253
 254
 255         /**
 256          * Sends the task on the mailbox asynchronously
 257          */
 258         public native Comm isend(String mailbox);
 259
 260         /**
 261          * Sends the task on the mailbox asynchronously (capping the sending rate to \a maxrate)
 262          */
 263         public native Comm isendBounded(String mailbox, double maxrate);
 264
 265
 266         /**
 267          * Starts listening for receiving a task from an asynchronous communication
 268          * @param mailbox
 269          */
 270         public static native Comm irecv(String mailbox);
 271         /**
 272          * Retrieves next task from the mailbox identified by the specified name
 273          *
 274      * @param mailbox
 275          */
 276
 277         public static Task receive(String mailbox) throws TransferFailureException, HostFailureException, TimeoutException {
 278                 return receive(mailbox, -1.0, null);
 279         }
 280
 281         /**
 282          * Retrieves next task on the mailbox identified by the specified name (wait at most \a timeout seconds)
 283          *
 284      * @param mailbox
 285      * @param timeout
 286          */
 287         public static Task receive(String mailbox, double timeout) throws  TransferFailureException, HostFailureException, TimeoutException {
 288                 return receive(mailbox, timeout, null);
 289         }
 290
 291         /**
 292          * Retrieves next task sent by a given host on the mailbox identified by the specified alias
 293          *
 294      * @param mailbox
 295      * @param host
 296          */
 297
 298         public static Task receive(String mailbox, Host host) throws TransferFailureException, HostFailureException, TimeoutException {
 299                 return receive(mailbox, -1.0, host);
 300         }
 301
 302         /**
 303          * Retrieves next task sent by a given host on the mailbox identified by the specified alias (wait at most \a timeout seconds)
 304          *
 305      * @param mailbox
 306      * @param timeout
 307      * @param host
 308          */
 309         public native static Task receive(String mailbox, double timeout, Host host) throws TransferFailureException, HostFailureException, TimeoutException;
 310
 311         /**
 312          * Starts listening for receiving a task from an asynchronous communication with a capped rate
 313          * @param mailbox
 314          */
 315         public static native Comm irecvBounded(String mailbox, double rate);
 316         /**
 317          * Retrieves next task from the mailbox identified by the specified name with a capped rate
 318          *
 319      * @param mailbox
 320          */
 321
 322         public static Task receiveBounded(String mailbox, double rate) throws TransferFailureException, HostFailureException, TimeoutException {
 323                 return receiveBounded(mailbox, -1.0, null, rate);
 324         }
 325
 326         /**
 327          * Retrieves next task on the mailbox identified by the specified name (wait at most \a timeout seconds) with a capped rate
 328          *
 329      * @param mailbox
 330      * @param timeout
 331          */
 332         public static Task receiveBounded(String mailbox, double timeout, double rate) throws  TransferFailureException, HostFailureException, TimeoutException {
 333                 return receiveBounded(mailbox, timeout, null, rate);
 334         }
 335
 336         /**
 337          * Retrieves next task sent by a given host on the mailbox identified by the specified alias with a capped rate
 338          *
 339      * @param mailbox
 340      * @param host
 341          */
 342
 343         public static Task receiveBounded(String mailbox, Host host, double rate) throws TransferFailureException, HostFailureException, TimeoutException {
 344                 return receiveBounded(mailbox, -1.0, host, rate);
 345         }
 346
 347         /**
 348          * Retrieves next task sent by a given host on the mailbox identified by the specified alias (wait at most \a timeout seconds)
 349          * with a capped rate
 350          *
 351      * @param mailbox
 352      * @param timeout
 353      * @param host
 354          */
 355         public native static Task receiveBounded(String mailbox, double timeout, Host host, double rate) throws TransferFailureException, HostFailureException, TimeoutException;
 356
 357
 358
 359         /**
 360          * Tests whether there is a pending communication on the mailbox identified by the specified alias, and who sent it
 361      */
 362         public native static int listenFrom(String mailbox);
 363         /**
 364          * Listen whether there is a waiting task on the mailbox identified by the specified alias
 365      */
 366         public native static boolean listen(String mailbox);
 367
 368         /**
 369          * 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.
 370      */
 371         public native static int listenFromHost(String alias, Host host);
 372
 373         /**
 374          * Class initializer, to initialize various JNI stuff
 375          */
 376         public static native void nativeInit();
 377         static {
 378                 Msg.nativeInit();
 379                 nativeInit();
 380         }
 381
 382         public double getMessageSize() {
 383                 return this.messageSize;
 384         }
 385
 386         public Long getId() {
 387                 return id;
 388         }
 389
 390         public void setId(Long id) {
 391                 this.id = id;
 392         }
 393 }