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

   1 /* Copyright (c) 2006-2018. 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 argsParam             The arguments of main method of the process.
 111          */
 112         public Process(Host host, String name, String[]argsParam)
 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 != argsParam)
 124                         this.args.addAll(Arrays.asList(argsParam));
 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          * @return                              The function returns the PID of the next created process.
 152          *
 153          */
 154         public static native int killAll();
 155
 156         /** Simply kills the receiving process.
 157          *
 158          * SimGrid sometimes have issues when you kill processes that are currently communicating and such. We are working on it to fix the issues.
 159          */
 160         public native void kill();
 161         public static void kill(Process p) {
 162                 p.kill();
 163         }
 164
 165         /** Suspends the process. See {@link #resume()} to resume it afterward */
 166         public native void suspend();
 167         /** Resume a process that was suspended by {@link #suspend()}. */
 168         public native void resume();
 169         /** Tests if a process is suspended.
 170          *
 171          * @see #suspend()
 172          * @see #resume()
 173          */
 174         public native boolean isSuspended();
 175
 176         /** Yield the current process. All other processes that are ready at the same timestamp will be executed first */
 177         public static native void yield();
 178
 179         /**
 180          * Specify whether the process should restart when its host restarts after a failure
 181          *
 182          * A process naturally stops when its host stops. It starts again only if autoRestart is set to true.
 183          * Otherwise, it just disappears when the host stops.
 184          */
 185         public native void setAutoRestart(boolean autoRestart);
 186         /** Restarts the process from the beginning */
 187         public native void restart();
 188         /**
 189          * Returns the name of the process
 190          */
 191         public String getName() {
 192                 return this.name;
 193         }
 194         /**
 195          * Returns the host of the process.
 196          * @return                              The host instance of the process.
 197          */
 198         public Host getHost() {
 199                 return this.host;
 200         }
 201         /**
 202          * This static method gets a process from a PID.
 203          *
 204          * @param pid                   The process identifier of the process to get.
 205          *
 206          * @return                              The process with the specified PID.
 207          */
 208         public static native Process fromPID(int pid);
 209         /**
 210          * This method returns the PID of the process.
 211          *
 212          * @return                              The PID of the process.
 213          *
 214          */
 215         public int getPID()  {
 216                 if (pid == -1) // Don't traverse the JNI barrier if you already have the answer
 217                         pid = nativeGetPID();
 218                 return pid;
 219         }
 220         // This should not be used: the PID is supposed to be initialized from the C directly when the actor is created,
 221         // but this sometimes fail, so let's play nasty but safe here.
 222         private native int nativeGetPID();
 223         /**
 224          * This method returns the PID of the parent of a process.
 225          *
 226          * @return                              The PID of the parent of the process.
 227          *
 228          */
 229         public int getPPID()  {
 230                 return ppid;
 231         }
 232         /**
 233          * Returns the value of a given process property.
 234          */
 235         public native String getProperty(String name);
 236
 237         /**
 238          * Set the kill time of the process
 239          * @param killTime the time when the process is killed
 240          */
 241         public native void setKillTime(double killTime);
 242
 243         /**
 244          * This static method returns the currently running process.
 245          *
 246          * @return                              The current process.
 247          *
 248          */
 249         public static native Process getCurrentProcess();
 250         /**
 251          * Migrates a process to another host.
 252          *
 253          * @param host                  The host where to migrate the process.
 254          *
 255          */
 256         public native void migrate(Host host);
 257         /**
 258          * Makes the current process sleep until millis milliseconds have elapsed.
 259          * You should note that unlike "waitFor" which takes seconds, this method takes milliseconds.
 260          * FIXME: Not optimal, maybe we should have two native functions.
 261          * @param millis the length of time to sleep in milliseconds.
 262          */
 263         public static void sleep(long millis) throws HostFailureException  {
 264                 sleep(millis,0);
 265         }
 266         /**
 267          * Makes the current process sleep until millis milliseconds and nanos nanoseconds
 268          * have elapsed.
 269          * Unlike {@link #waitFor(double)} which takes seconds, this method takes
 270          * milliseconds and nanoseconds.
 271          * Overloads Thread.sleep.
 272          * @param millis the length of time to sleep in milliseconds.
 273          * @param nanos additional nanoseconds to sleep.
 274          */
 275         public static native void sleep(long millis, int nanos) throws HostFailureException;
 276         /**
 277          * Makes the current process sleep until time seconds have elapsed.
 278          * @param seconds               The time the current process must sleep.
 279          */
 280         public native void waitFor(double seconds) throws HostFailureException;
 281         /**
 282          * This method actually creates and run the process.
 283          * It is a noop if the process is already launched.
 284          */
 285         public final void start() {
 286            if (bind == 0)
 287              create(host);
 288         }
 289
 290         /** This method runs the process. It calls the method function that you must overwrite. */
 291         @Override
 292         public void run() {
 293
 294                 try {
 295                         String[] argsArray = new String[this.args.size()];
 296                         this.args.toArray(argsArray);
 297
 298                         this.main(argsArray);
 299                 }
 300                 catch(MsgException e) {
 301                         e.printStackTrace();
 302                         Msg.info("Unexpected behavior. Stopping now");
 303                         System.exit(1);
 304                 }
 305                 catch(ProcessKilledError pk) {
 306                         /* The process was killed before its end. With a kill() or something. */
 307                 }
 308         }
 309
 310         /**
 311          * The main function of the process (to implement by the user).
 312          *
 313          * @param args
 314          * @throws MsgException
 315          */
 316         public abstract void main(String[]args) throws MsgException;
 317
 318         /** Stops the execution of the current actor */
 319         public void exit() {
 320                 this.kill();
 321         }
 322         /**
 323          * Class initializer, to initialize various JNI stuff
 324          */
 325         private static native void nativeInit();
 326         static {
 327                 org.simgrid.NativeLib.nativeInit();
 328                 nativeInit();
 329         }
 330         /**
 331          * This static method returns the current amount of processes running
 332          *
 333          * @return                      The count of the running processes
 334          */
 335         public static native int getCount();
 336
 337 }