1 /* Copyright (c) 2006-2015. The SimGrid Team.
2 * All rights reserved. */
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. */
7 package org.simgrid.msg;
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.
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.
20 private long bind = 0;
24 protected String name;
26 private double messageSize;
28 /** Default constructor (all fields to 0 or null) */
38 * Construct an new task with the specified processing amount and amount
41 * @param name Task's name
43 * @param flopsAmount A value of the processing amount (in flop) needed to process the task.
44 * If 0, then it cannot be executed with the execute() method.
45 * This value has to be >= 0.
47 * @param bytesAmount A value of amount of data (in bytes) needed to transfert this task.
48 * If 0, then it cannot be transfered with the get() and put() methods.
49 * This value has to be >= 0.
51 public Task(String name, double flopsAmount, double bytesAmount) {
52 create(name, flopsAmount, bytesAmount);
53 this.messageSize = bytesAmount;
56 * Construct an new parallel task with the specified processing amount and amount for each host
59 * @param name The name of the parallel task.
60 * @param hosts The list of hosts implied by the parallel task.
61 * @param flopsAmount The amount of operations to be performed by each host of \a hosts.
62 * @param bytesAmount A matrix describing the amount of data to exchange between hosts.
64 public Task(String name, Host[]hosts, double[]flopsAmount, double[]bytesAmount) {
65 parallelCreate(name, hosts, flopsAmount, bytesAmount);
69 * The natively implemented method to create a MSG task.
71 * @param name The name of th task.
72 * @param flopsAmount A value of the processing amount (in flop) needed
73 * to process the task. If 0, then it cannot be executed
74 * with the execute() method. This value has to be >= 0.
75 * @param bytesAmount A value of amount of data (in bytes) needed to transfert
76 * this task. If 0, then it cannot be transfered this task.
77 * If 0, then it cannot be transfered with the get() and put()
78 * methods. This value has to be >= 0.
79 * @exception IllegalArgumentException if compute duration <0 or message size <0
81 private final native void create(String name,
84 throws IllegalArgumentException;
86 * The natively implemented method to create a MSG parallel task.
88 * @param name The name of the parallel task.
89 * @param hosts The list of hosts implied by the parallel task.
90 * @param flopsAmount The total number of operations that have to be performed
92 * @param bytesAmount An array of doubles
95 private final native void parallelCreate(String name,
99 throws NullPointerException, IllegalArgumentException;
101 * * Getters / Setters * *
103 /** Gets the name of a task */
104 public String getName() {
108 /** Gets the sender of the task (or null if not sent yet) */
109 public native Process getSender();
111 /** Gets the source of the task (or null if not sent yet). */
112 public native Host getSource();
114 /** Gets the remaining amount of flops to execute in this task
116 * If it's ongoing, you get the exact amount at the present time. If it's already done, it's 0.
118 public native double getFlopsAmount();
120 * Sets the name of the task
121 * @param name the new task name
123 public native void setName(String name);
125 * This method sets the priority of the computation of the task.
126 * The priority doesn't affect the transfer rate. For example a
127 * priority of 2 will make the task receive two times more cpu than
130 * @param priority The new priority of the task.
132 public native void setPriority(double priority);
134 /** Set the computation amount needed to process the task
136 * Warning if the execution is already started and ongoing, this call does nothing.
137 * @param flopsAmount the amount of computation needed to process the task
139 public native void setFlopsAmount(double flopsAmount);
141 * Set the amount of bytes to exchange the task
143 * Warning if the communication is already started and ongoing, this call does nothing.
144 * @param bytesAmount the size of the task
146 public native void setBytesAmount(double bytesAmount);
148 * * Computation-related * *
151 * Executes a task on the location on which the current process is running.
153 * @throws HostFailureException
154 * @throws TaskCancelledException
156 public native void execute() throws HostFailureException,TaskCancelledException;
158 /** Bound a computation to a certain load */
159 public native void setBound(double load);
161 /** Cancels a task. */
162 public native void cancel();
164 /** Deletes a task once the garbage collector reclaims it */
166 protected void finalize() {
168 // Exceptions in finalizers lead to bad situations:
169 // http://stackoverflow.com/questions/7644556/troubleshooting-a-java-memory-leak-finalization
171 bind=0; // to avoid segfaults if the impossible happens yet again making this task surviving its finalize()
172 } catch (Throwable e) {
176 protected native void nativeFinalize();
178 * * Communication-related * *
181 /** Send the task asynchronously on the specified mailbox,
182 * with no way to retrieve whether the communication succeeded or not
185 public native void dsendBounded(String mailbox, double maxrate);
188 /** Send the task asynchronously on the specified mailbox,
189 * with no way to retrieve whether the communication succeeded or not
192 public native void dsend(String mailbox);
195 * Sends the task on the specified mailbox
197 * @param mailbox where to send the message
198 * @throws TimeoutException
199 * @throws HostFailureException
200 * @throws TransferFailureException
202 public void send(String mailbox) throws TransferFailureException, HostFailureException, TimeoutException {
207 * Sends the task on the specified mailbox (wait at most \a timeout seconds)
209 * @param mailbox where to send the message
211 * @exception NativeException if the retrieval fails.
212 * @throws TimeoutException
213 * @throws HostFailureException
214 * @throws TransferFailureException
216 public native void send(String mailbox, double timeout) throws TransferFailureException, HostFailureException, TimeoutException;
218 /** Sends the task on the specified mailbox (capping the sending rate to \a maxrate)
220 * @param mailbox where to send the message
222 * @throws TransferFailureException
223 * @throws HostFailureException
224 * @throws TimeoutException
226 public void sendBounded(String mailbox, double maxrate) throws TransferFailureException, HostFailureException, TimeoutException {
227 sendBounded(mailbox,-1,maxrate);
231 /** Sends the task on the specified mailbox (capping the sending rate to \a maxrate) with a timeout
233 * @param mailbox where to send the message
236 * @throws TransferFailureException
237 * @throws HostFailureException
238 * @throws TimeoutException
240 public native void sendBounded(String mailbox, double timeout, double maxrate) throws TransferFailureException, HostFailureException, TimeoutException;
244 * Sends the task on the mailbox asynchronously
246 public native Comm isend(String mailbox);
249 * Sends the task on the mailbox asynchronously (capping the sending rate to \a maxrate)
251 public native Comm isendBounded(String mailbox, double maxrate);
255 * Starts listening for receiving a task from an asynchronous communication
258 public static native Comm irecv(String mailbox);
260 * Retrieves next task from the mailbox identified by the specified name
265 public static Task receive(String mailbox) throws TransferFailureException, HostFailureException, TimeoutException {
266 return receive(mailbox, -1.0, null);
270 * Retrieves next task on the mailbox identified by the specified name (wait at most \a timeout seconds)
275 public static Task receive(String mailbox, double timeout) throws TransferFailureException, HostFailureException, TimeoutException {
276 return receive(mailbox, timeout, null);
280 * Retrieves next task sent by a given host on the mailbox identified by the specified alias
286 public static Task receive(String mailbox, Host host) throws TransferFailureException, HostFailureException, TimeoutException {
287 return receive(mailbox, -1.0, host);
291 * Retrieves next task sent by a given host on the mailbox identified by the specified alias (wait at most \a timeout seconds)
297 public native static Task receive(String mailbox, double timeout, Host host) throws TransferFailureException, HostFailureException, TimeoutException;
300 * Starts listening for receiving a task from an asynchronous communication with a capped rate
303 public static native Comm irecvBounded(String mailbox, double rate);
305 * Retrieves next task from the mailbox identified by the specified name with a capped rate
310 public static Task receiveBounded(String mailbox, double rate) throws TransferFailureException, HostFailureException, TimeoutException {
311 return receiveBounded(mailbox, -1.0, null, rate);
315 * Retrieves next task on the mailbox identified by the specified name (wait at most \a timeout seconds) with a capped rate
320 public static Task receiveBounded(String mailbox, double timeout, double rate) throws TransferFailureException, HostFailureException, TimeoutException {
321 return receiveBounded(mailbox, timeout, null, rate);
325 * Retrieves next task sent by a given host on the mailbox identified by the specified alias with a capped rate
331 public static Task receiveBounded(String mailbox, Host host, double rate) throws TransferFailureException, HostFailureException, TimeoutException {
332 return receiveBounded(mailbox, -1.0, host, rate);
336 * Retrieves next task sent by a given host on the mailbox identified by the specified alias (wait at most \a timeout seconds)
343 public native static Task receiveBounded(String mailbox, double timeout, Host host, double rate) throws TransferFailureException, HostFailureException, TimeoutException;
348 * Tests whether there is a pending communication on the mailbox identified by the specified alias, and who sent it
350 public native static int listenFrom(String mailbox);
352 * Listen whether there is a waiting task on the mailbox identified by the specified alias
354 public native static boolean listen(String mailbox);
357 * 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.
359 public native static int listenFromHost(String alias, Host host);
362 * Class initializer, to initialize various JNI stuff
364 public static native void nativeInit();
370 public double getMessageSize() {
371 return this.messageSize;