Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
01f94b664a8cd94903c9960226d6e4726737cee8
[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 = 0;
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 = null;
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 = new ArrayList<>();
81
82
83         /**  Default constructor */
84         protected Process() {
85                 this.id = nextProcessId++;
86         }
87
88         /**
89          * Constructs a new process from the name of a host and his name. The method
90          * function of the process doesn't have argument.
91          *
92          * @param hostname              The name of the host of the process to create.
93          * @param name                  The name of the process.
94          *
95          * @exception                   HostNotFoundException  if no host with this name exists.
96          *                      
97          *
98          */
99         public Process(String hostname, String name) throws HostNotFoundException {
100                 this(Host.getByName(hostname), name, null);
101         }
102         /**
103          * Constructs a new process from the name of a host and his name. The arguments
104          * of the method function of the process are specified by the parameter args.
105          *
106          * @param hostname              The name of the host of the process to create.
107          * @param name                  The name of the process.
108          * @param args                  The arguments of the main function of the process.
109          *
110          * @exception                   HostNotFoundException  if no host with this name exists.
111          *                      NativeException
112          * @throws NativeException
113          *
114          */ 
115         public Process(String hostname, String name, String[] args) throws HostNotFoundException, NativeException {
116                 this(Host.getByName(hostname), name, args);
117         }
118         /**
119          * Constructs a new process from a host and his name. The method function of the 
120          * process doesn't have argument.
121          *
122          * @param host                  The host of the process to create.
123          * @param name                  The name of the process.
124          *
125          */
126         public Process(Host host, String name) {
127                 this(host, name, null);
128         }
129         /**
130          * Constructs a new process from a host and his name, the arguments of here method function are
131          * specified by the parameter args.
132          *
133          * @param host                  The host of the process to create.
134          * @param name                  The name of the process.
135          * @param args                  The arguments of main method of the process.
136          */     
137         public Process(Host host, String name, String[]args) {
138                 this();
139                 this.host = host;
140                 if (host == null)
141                         throw new NullPointerException("Host cannot be NULL");
142                 if (name == null)
143                         throw new NullPointerException("Process name cannot be NULL");
144                 this.name = name;
145
146                 this.args = new ArrayList<>();
147                 if (null != args)
148                         this.args.addAll(Arrays.asList(args));
149         }
150         /**
151          * Constructs a new process from a host and his name, the arguments of here method function are
152          * specified by the parameter args.
153          *
154          * @param host                  The host of the process to create.
155          * @param name                  The name of the process.
156          * @param args                  The arguments of main method of the process.
157          * @param startTime             Start time of the process
158          * @param killTime              Kill time of the process
159          *
160          */
161         public Process(Host host, String name, String[]args, double startTime, double killTime) {
162                 this(host, name, args);
163                 this.startTime = startTime;
164                 this.killTime = killTime;
165         }
166         /**
167          * The natively implemented method to create an MSG process.
168          * @param hostName    A valid (bound) host where create the process.
169          */
170         protected native void create(String hostName) throws HostNotFoundException;
171         /**
172          * This method kills all running process of the simulation.
173          *
174          * @param resetPID              Should we reset the PID numbers. A negative number means no reset
175          *                                              and a positive number will be used to set the PID of the next newly
176          *                                              created process.
177          *
178          * @return                              The function returns the PID of the next created process.
179          *                      
180          */ 
181         public static native int killAll(int resetPID);
182
183         /** Simply kills the receiving process.
184          *
185          * SimGrid sometimes have issues when you kill processes that are currently communicating and such. We are working on it to fix the issues.
186          */
187         public native void kill();
188         public static void kill(Process p) {
189                 p.kill();
190         }
191         
192         /** Suspends the process. See {@link #resume()} to resume it afterward */
193         public native void suspend();
194         /** Resume a process that was suspended by {@link #suspend()}. */
195         public native void resume();    
196         /** Tests if a process is suspended.
197          *
198          * @see #suspend()
199          * @see #resume()
200          */
201         public native boolean isSuspended();
202         
203         /**
204          * Specify whether the process should restart when its host restarts after a failure
205          * 
206          * A process naturally stops when its host stops. It starts again only if autoRestart is set to true.
207          * Otherwise, it just disappears when the host stops.
208          */
209         public native void setAutoRestart(boolean autoRestart);
210         /** Restarts the process from the beginning */
211         public native void restart();
212         /**
213          * Returns the name of the process
214          */
215         public String getName() {
216                 return this.name;
217         }
218         /**
219          * Returns the host of the process.
220          * @return                              The host instance of the process.
221          */ 
222         public Host getHost() {
223                 return this.host;
224         }
225         /**
226          * This static method gets a process from a PID.
227          *
228          * @param PID                   The process identifier of the process to get.
229          *
230          * @return                              The process with the specified PID.
231          *
232          * @exception                   NativeException on error in the native SimGrid code
233          */ 
234         public static native Process fromPID(int PID) throws NativeException;
235         /**
236          * This method returns the PID of the process.
237          *
238          * @return                              The PID of the process.
239          *
240          */ 
241         public int getPID()  {
242                 return pid;
243         }
244         /**
245          * This method returns the PID of the parent of a process.
246          *
247          * @return                              The PID of the parent of the process.
248          *
249          */ 
250         public int getPPID()  {
251                 return ppid;
252         }
253         /**
254          * Returns the value of a given process property. 
255          */
256         public native String getProperty(String name);
257
258         /**
259          * Set the kill time of the process
260          * @param killTime the time when the process is killed
261          */
262         public native void setKillTime(double killTime);
263
264         /**
265          * This static method returns the currently running process.
266          *
267          * @return                              The current process.
268          *
269          */ 
270         public static native Process getCurrentProcess();
271         /**
272          * Migrates a process to another host.
273          *
274          * @param host                  The host where to migrate the process.
275          *
276          */
277         public native void migrate(Host host);  
278         /**
279          * Makes the current process sleep until millis milliseconds have elapsed.
280          * You should note that unlike "waitFor" which takes seconds, this method takes milliseconds.
281          * FIXME: Not optimal, maybe we should have two native functions.
282          * @param millis the length of time to sleep in milliseconds.
283          */
284         public static void sleep(long millis) throws HostFailureException  {
285                 sleep(millis,0);
286         }
287         /**
288          * Makes the current process sleep until millis milliseconds and nanos nanoseconds 
289          * have elapsed.
290          * Unlike {@link #waitFor(double)} which takes seconds, this method takes 
291          * milliseconds and nanoseconds.
292          * Overloads Thread.sleep.
293          * @param millis the length of time to sleep in milliseconds.
294          * @param nanos additional nanoseconds to sleep.
295          */
296         public static native void sleep(long millis, int nanos) throws HostFailureException;
297         /**
298          * Makes the current process sleep until time seconds have elapsed.
299          * @param seconds               The time the current process must sleep.
300          */ 
301         public native void waitFor(double seconds) throws HostFailureException;    
302         /**
303          * This method actually creates and run the process.
304          * It is a noop if the process is already launched.
305          * @throws HostNotFoundException
306          */
307         public final void start() throws HostNotFoundException {
308                 if (!started) {
309                         started = true;
310                         create(host.getName());
311                 }
312         }
313
314         /** This method runs the process. Il calls the method function that you must overwrite. */
315         @Override
316         public void run() {
317
318                 String[] args = null;      /* do not fill it before the signal or this.args will be empty */
319
320                 try {
321                         args = new String[this.args.size()];
322                         if (!this.args.isEmpty()) {
323                                 this.args.toArray(args);
324                         }
325
326                         this.main(args);
327                 }
328                 catch(MsgException e) {
329                         e.printStackTrace();
330                         Msg.info("Unexpected behavior. Stopping now");
331                         System.exit(1);
332                 }
333                 catch(ProcessKilledError pk) {
334                         /* The process was killed before its end. With a kill() or something. */
335                 }       
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         /** Stops the execution of the current actor */
347         public void exit() {
348                 this.kill();
349         }
350         /**
351          * Class initializer, to initialize various JNI stuff
352          */
353         private static native void nativeInit();
354         static {
355                 org.simgrid.NativeLib.nativeInit();
356                 nativeInit();
357         }
358         /**
359          * This static method returns the current amount of processes running
360          *
361          * @return                      The count of the running processes
362          */ 
363         public static native int getCount();
364
365 }