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