2 * simgrid.msg.Task.java 1.00 07/05/01
4 * Copyright 2006,2007 Martin Quinson, Malek Cherier
7 * This program is free software; you can redistribute
8 * it and/or modify it under the terms of the license
9 *(GNU LGPL) which comes with this package.
12 package org.simgrid.msg;
15 * A task is either something to compute somewhere, or something to exchange between two hosts (or both).
16 * It is defined by a computing amount and a message size.
21 * This attribute represents a bind between a java task object and
22 * a native task. Even if this attribute is public you must never
23 * access to it. It is set automatically during the build of the object.
28 /** Default constructor (all fields to 0 or null) */
37 * Construct an new task with the specified processing amount and amount
40 * @param name Task's name
42 * @param computeDuration A value of the processing amount (in flop) needed to process the task.
43 * If 0, then it cannot be executed with the execute() method.
44 * This value has to be >= 0.
46 * @param messageSize A value of amount of data (in bytes) needed to transfert this task.
47 * If 0, then it cannot be transfered with the get() and put() methods.
48 * This value has to be >= 0.
50 public Task(String name, double computeDuration, double messageSize) {
51 create(name, computeDuration, messageSize);
54 * Construct an new parallel task with the specified processing amount and amount for each host
57 * @param name The name of the parallel task.
58 * @param hosts The list of hosts implied by the parallel task.
59 * @param computeDurations The amount of operations to be performed by each host of \a hosts.
60 * @param messageSizes A matrix describing the amount of data to exchange between hosts.
62 public Task(String name, Host[]hosts, double[]computeDurations, double[]messageSizes) {
63 parallelCreate(name, hosts, computeDurations, messageSizes);
67 * The natively implemented method to create a MSG task.
69 * @param name The name of th task.
70 * @param computeDuration A value of the processing amount (in flop) needed
71 * to process the task. If 0, then it cannot be executed
72 * with the execute() method. This value has to be >= 0.
73 * @param messageSize A value of amount of data (in bytes) needed to transfert
74 * this task. If 0, then it cannot be transfered this task.
75 * If 0, then it cannot be transfered with the get() and put()
76 * methods. This value has to be >= 0.
77 * @exception IllegalArgumentException if compute duration <0 or message size <0
79 final native void create(String name,
80 double computeDuration,
82 throws IllegalArgumentException;
84 * The natively implemented method to create a MSG parallel task.
86 * @param name The name of the parallel task.
87 * @param hosts The list of hosts implied by the parallel task.
88 * @param computeDurations The total number of operations that have to be performed
90 * @param messageSizes An array of doubles
93 final native void parallelCreate(String name,
95 double[]computeDurations,
97 throws NullPointerException, IllegalArgumentException;
99 * * Getters / Setters * *
101 /** Gets the name of a task
105 public native String getName();
106 /** Gets the sender of the task
107 * Returns null if the task hasn't been sent yet
109 public native Process getSender();
110 /** Gets the source of the task.
111 * Returns null if the task hasn't been sent yet.
113 public native Host getSource();
114 /** Gets the computing amount of the task
117 public native double getComputeDuration();
118 /** Gets the remaining computation of the task
120 public native double getRemainingDuration();
122 * This method sets the priority of the computation of the task.
123 * The priority doesn't affect the transfer rate. For example a
124 * priority of 2 will make the task receive two times more cpu than
127 * @param priority The new priority of the task.
129 public native void setPriority(double priority);
131 * * Communication-related * *
136 * * Computation-related * *
139 * Executes a task on the location on which the process is running.
142 * @throws HostFailureException
143 * @throws TaskCancelledException
145 public native void execute() throws HostFailureException,TaskCancelledException;
150 public native void cancel();
153 * @exception NativeException if the destruction failed.
155 protected void finalize() throws NativeException {
159 * The natively implemented method to destroy a MSG task.
161 protected native void destroy();
163 /** Send the task asynchronously on the mailbox identified by the specified name,
164 * with no way to retrieve whether the communication succeeded or not
167 public native void dsend(String mailbox);
169 * Sends the task on the mailbox identified by the specified name
172 * @throws TimeoutException
173 * @throws HostFailureException
174 * @throws TransferFailureException
176 public void send(String mailbox) throws TransferFailureException, HostFailureException, TimeoutException {
181 * Sends the task on the mailbox identified by the specified name (wait at most \a timeout seconds)
185 * @exception NativeException if the retrieval fails.
186 * @throws TimeoutException
187 * @throws HostFailureException
188 * @throws TransferFailureException
190 public native void send(String mailbox, double timeout) throws TransferFailureException, HostFailureException, TimeoutException;
192 * Sends the task on the mailbox identified by the specified alias (capping the sending rate to \a maxrate)
196 * @throws TransferFailureException
197 * @throws HostFailureException
198 * @throws TimeoutException
200 public native void sendBounded(String alias, double maxrate) throws TransferFailureException, HostFailureException, TimeoutException;
202 * Sends the task on the mailbox asynchronously
204 public native Comm isend(String mailbox);
207 * Starts listening for receiving a task from an asynchronous communication
210 public static native Comm irecv(String mailbox);
212 * Retrieves next task from the mailbox identified by the specified name
217 public static Task receive(String mailbox) throws TransferFailureException, HostFailureException, TimeoutException {
218 return receive(mailbox, -1.0, null);
222 * Retrieves next task on the mailbox identified by the specified name (wait at most \a timeout seconds)
227 public static Task receive(String mailbox, double timeout) throws TransferFailureException, HostFailureException, TimeoutException {
228 return receive(mailbox, timeout, null);
232 * Retrieves next task sent by a given host on the mailbox identified by the specified alias
238 public static Task receive(String mailbox, Host host) throws TransferFailureException, HostFailureException, TimeoutException {
239 return receive(mailbox, -1.0, host);
243 * Retrieves next task sent by a given host on the mailbox identified by the specified alias (wait at most \a timeout seconds)
249 public native static Task receive(String mailbox, double timeout, Host host) throws TransferFailureException, HostFailureException, TimeoutException;
251 * Tests whether there is a pending communication on the mailbox identified by the specified alias, and who sent it
253 public native static int listenFrom(String mailbox);
255 * Listen whether there is a waiting task on the mailbox identified by the specified alias
257 public native static boolean listen(String mailbox);
260 * 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.
262 public native static int listenFromHost(String alias, Host host);
265 * Class initializer, to initialize various JNI stuff
267 public static native void nativeInit();