Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
3d36996497b544a43e667d4ec70d24409c9ad3bd
[simgrid.git] / src / bindings / java / org / simgrid / msg / Process.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 import java.util.Arrays;
10 import java.util.ArrayList;
11
12 /**
13  * A process may be defined as a code, with some private data, executing 
14  * in a location (host). All the process used by your simulation must be
15  * declared in the deployment file (XML format).
16  * To create your own process you must inherit your own process from this 
17  * class and override the method "main()". For example if you want to use 
18  * a process named Slave proceed as it :
19  *
20  * (1) import the class Process of the package simgrid.msg
21  * import simgrid.msg.Process;
22  * 
23  * public class Slave extends simgrid.msg.Process {
24  *
25  *  (2) Override the method function
26  * 
27  *  \verbatim
28  *      public void main(String[] args) {
29  *              System.out.println("Hello MSG");
30  *      }
31  *  \endverbatim
32  * }
33  * The name of your process must be declared in the deployment file of your simulation.
34  * For the example, for the previous process Slave this file must contains a line :
35  * <process host="Maxims" function="Slave"/>, where Maxims is the host of the process
36  * Slave. All the process of your simulation are automatically launched and managed by Msg.
37  * A process use tasks to simulate communications or computations with another process. 
38  * For more information see Task. For more information on host concept 
39  * see Host.
40  * 
41  */
42
43 public abstract class Process implements Runnable {
44         /**
45          * This attribute represents a bind between a java process object and
46          * a native process. Even if this attribute is public you must never
47          * access to it. It is set automatically during the build of the object.
48          */
49         private long bind;
50         /** Indicates if the process is started */
51         boolean started;
52         /**
53          * Even if this attribute is public you must never access to it.
54          * It is used to compute the id of an MSG process.
55          */
56         private static long nextProcessId = 0;
57
58         /**
59          * Even if this attribute is public you must never access to it.
60          * It is compute automatically during the creation of the object. 
61          * The native functions use this identifier to synchronize the process.
62          */
63         private long id;
64
65         /** Time at which the process should be created  */
66         protected double startTime = 0;
67         /** Time at which the process should be killed.
68          * 
69          * Set at creation, and used internally by SimGrid
70          */
71         private double killTime = -1;
72
73         private String name;
74         
75         private int pid = -1;
76         private int ppid = -1;
77         private Host host = null;
78
79         /** The arguments of the method function of the process. */
80         private ArrayList<String> args;
81
82
83         /**  Default constructor */
84         protected Process() {
85                 this.id = nextProcessId++;
86                 this.name = null;
87                 this.bind = 0;
88                 this.args = new ArrayList<>();
89         }
90
91
92         /**
93          * Constructs a new process from the name of a host and his name. The method
94          * function of the process doesn't have argument.
95          *
96          * @param hostname              The name of the host of the process to create.
97          * @param name                  The name of the process.
98          *
99          * @exception                   HostNotFoundException  if no host with this name exists.
100          *                      
101          *
102          */
103         public Process(String hostname, String name) throws HostNotFoundException {
104                 this(Host.getByName(hostname), name, null);
105         }
106         /**
107          * Constructs a new process from the name of a host and his name. The arguments
108          * of the method function of the process are specified by the parameter args.
109          *
110          * @param hostname              The name of the host of the process to create.
111          * @param name                  The name of the process.
112          * @param args                  The arguments of the main function of the process.
113          *
114          * @exception                   HostNotFoundException  if no host with this name exists.
115          *                      NativeException
116          * @throws NativeException
117          *
118          */ 
119         public Process(String hostname, String name, String[] args) throws HostNotFoundException, NativeException {
120                 this(Host.getByName(hostname), name, args);
121         }
122         /**
123          * Constructs a new process from a host and his name. The method function of the 
124          * process doesn't have argument.
125          *
126          * @param host                  The host of the process to create.
127          * @param name                  The name of the process.
128          *
129          */
130         public Process(Host host, String name) {
131                 this(host, name, null);
132         }
133         /**
134          * Constructs a new process from a host and his name, the arguments of here method function are
135          * specified by the parameter args.
136          *
137          * @param host                  The host of the process to create.
138          * @param name                  The name of the process.
139          * @param args                  The arguments of main method of the process.
140          */     
141         public Process(Host host, String name, String[]args) {
142                 this();
143                 this.host = host;
144                 if (host == null)
145                         throw new NullPointerException("Host cannot be NULL");
146                 if (name == null)
147                         throw new NullPointerException("Process name cannot be NULL");
148                 this.name = name;
149
150                 this.args = new ArrayList<>();
151                 if (null != args)
152                         this.args.addAll(Arrays.asList(args));
153         }
154         /**
155          * Constructs a new process from a host and his name, the arguments of here method function are
156          * specified by the parameter args.
157          *
158          * @param host                  The host of the process to create.
159          * @param name                  The name of the process.
160          * @param args                  The arguments of main method of the process.
161          * @param startTime             Start time of the process
162          * @param killTime              Kill time of the process
163          *
164          */
165         public Process(Host host, String name, String[]args, double startTime, double killTime) {
166                 this(host, name, args);
167                 this.startTime = startTime;
168                 this.killTime = killTime;
169         }
170         /**
171          * The natively implemented method to create an MSG process.
172          * @param hostName    A valid (bound) host where create the process.
173          */
174         protected native void create(String hostName) throws HostNotFoundException;
175         /**
176          * This method kills all running process of the simulation.
177          *
178          * @param resetPID              Should we reset the PID numbers. A negative number means no reset
179          *                                              and a positive number will be used to set the PID of the next newly
180          *                                              created process.
181          *
182          * @return                              The function returns the PID of the next created process.
183          *                      
184          */ 
185         public static native int killAll(int resetPID);
186
187         /** Simply kills the receiving process.
188          *
189          * SimGrid sometimes have issues when you kill processes that are currently communicating and such. We are working on it to fix the issues.
190          */
191         public native void kill();
192         
193         /** Suspends the process. See {@link #resume()} to resume it afterward */
194         public native void suspend();
195         /** Resume a process that was suspended by {@link #suspend()}. */
196         public native void resume();    
197         /** Tests if a process is suspended.
198          *
199          * @see #suspend()
200          * @see #resume()
201          */
202         public native boolean isSuspended();
203         
204         /**
205          * Specify whether the process should restart when its host restarts after a failure
206          * 
207          * A process naturally stops when its host stops. It starts again only if autoRestart is set to true.
208          * Otherwise, it just disappears when the host stops.
209          */
210         public native void setAutoRestart(boolean autoRestart);
211         /** Restarts the process from the beginning */
212         public native void restart();
213         /**
214          * Returns the name of the process
215          */
216         public String getName() {
217                 return this.name;
218         }
219         /**
220          * Returns the host of the process.
221          * @return                              The host instance of the process.
222          */ 
223         public Host getHost() {
224                 return this.host;
225         }
226         /**
227          * This static method gets a process from a PID.
228          *
229          * @param PID                   The process identifier of the process to get.
230          *
231          * @return                              The process with the specified PID.
232          *
233          * @exception                   NativeException on error in the native SimGrid code
234          */ 
235         public static native Process fromPID(int PID) throws NativeException;
236         /**
237          * This method returns the PID of the process.
238          *
239          * @return                              The PID of the process.
240          *
241          */ 
242         public int getPID()  {
243                 return pid;
244         }
245         /**
246          * This method returns the PID of the parent of a process.
247          *
248          * @return                              The PID of the parent of the process.
249          *
250          */ 
251         public int getPPID()  {
252                 return ppid;
253         }
254         /**
255          * Returns the value of a given process property. 
256          */
257         public native String getProperty(String name);
258
259         /**
260          * Set the kill time of the process
261          * @param killTime the time when the process is killed
262          */
263         public native void setKillTime(double killTime);
264
265         /**
266          * This static method returns the currently running process.
267          *
268          * @return                              The current process.
269          *
270          */ 
271         public static native Process getCurrentProcess();
272         /**
273          * Migrates a process to another host.
274          *
275          * @param host                  The host where to migrate the process.
276          *
277          */
278         public native void migrate(Host host);  
279         /**
280          * Makes the current process sleep until millis millisecondes have elapsed.
281          * You should note that unlike "waitFor" which takes seconds, this method takes milliseconds.
282          * FIXME: Not optimal, maybe we should have two native functions.
283          * @param millis the length of time to sleep in milliseconds.
284          */
285         public static void sleep(long millis) throws HostFailureException  {
286                 sleep(millis,0);
287         }
288         /**
289          * Makes the current process sleep until millis milliseconds and nanos nanoseconds 
290          * have elapsed.
291          * Unlike {@link #waitFor(double)} which takes seconds, this method takes 
292          * milliseconds and nanoseconds.
293          * Overloads Thread.sleep.
294          * @param millis the length of time to sleep in milliseconds.
295          * @param nanos additionnal nanoseconds to sleep.
296          */
297         public static native void sleep(long millis, int nanos) throws HostFailureException;
298         /**
299          * Makes the current process sleep until time seconds have elapsed.
300          * @param seconds               The time the current process must sleep.
301          */ 
302         public native void waitFor(double seconds) throws HostFailureException;    
303         /**
304          * This method actually creates and run the process.
305          * It is a noop if the process is already launched.
306          * @throws HostNotFoundException
307          */
308         public final void start() throws HostNotFoundException {
309                 if (!started) {
310                         started = true;
311                         create(host.getName());
312                 }
313         }
314
315         /** This method runs the process. Il calls the method function that you must overwrite. */
316         @Override
317         public void run() {
318
319                 String[] args = null;      /* do not fill it before the signal or this.args will be empty */
320
321                 try {
322                         args = new String[this.args.size()];
323                         if (!this.args.isEmpty()) {
324                                 this.args.toArray(args);
325                         }
326
327                         this.main(args);
328                 } catch(MsgException e) {
329                         e.printStackTrace();
330                         Msg.info("Unexpected behavior. Stopping now");
331                         System.exit(1);
332                 }
333                 catch(ProcessKilledError pk) {
334                 }       
335                 exit();
336         }
337
338         /**
339          * The main function of the process (to implement).
340          *
341          * @param args
342          * @throws MsgException
343          */
344         public abstract void main(String[]args) throws MsgException;
345
346         public native void exit();
347         /**
348          * Class initializer, to initialize various JNI stuff
349          */
350         private static native void nativeInit();
351         static {
352                 org.simgrid.NativeLib.nativeInit();
353                 nativeInit();
354         }
355         /**
356          * This static method returns the current amount of processes running
357          *
358          * @return                      The count of the running processes
359          */ 
360         public static native int getCount();
361
362 }