src/bindings/java/org/simgrid/msg/Process.java

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