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

   1 /* Bindings to the MSG hosts */
   2
   3 /* Copyright (c) 2006-2014. The SimGrid Team.
   4  * All rights reserved.                                                     */
   5
   6 /* This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the license (GNU LGPL) which comes with this package. */
   8
   9 package org.simgrid.msg;
  10
  11 import org.simgrid.msg.Storage;
  12
  13 /**
  14  * A host object represents a location (any possible place) where a process may run.
  15  * Thus it is represented as a physical resource with computing capabilities, some
  16  * mailboxes to enable running process to communicate with remote ones, and some private
  17  * data that can be only accessed by local process. An instance of this class is always
  18  * bound with the corresponding native host. All the native hosts are automatically created
  19  * during the call of the method Msg.createEnvironment(). This method take as parameter a
  20  * platform file which describes all elements of the platform (host, link, root..).
  21  * You cannot create a host yourself.
  22  *
  23  * The best way to get an host instance is to call the static method
  24  * Host.getByName().
  25  *
  26  * For example to get the instance of the host. If your platform
  27  * file description contains an host named "Jacquelin" :
  28  *
  29  * \verbatim
  30 Host jacquelin;
  31
  32 try {
  33         jacquelin = Host.getByName("Jacquelin");
  34 } catch(HostNotFoundException e) {
  35         System.err.println(e.toString());
  36 }
  37 ...
  38 \endverbatim
  39  *
  40  */
  41 public class Host {
  42
  43         /**
  44          * This attribute represents a bind between a java host object and
  45          * a native host. Even if this attribute is public you must never
  46          * access to it. It is set automatically during the call of the
  47          * static method Host.getByName().
  48          *
  49          * @see                         Host.getByName().
  50          */
  51         private long bind;
  52         protected String name;
  53
  54         /** User data. */
  55         private Object data;
  56         protected Host() {
  57                 this.bind = 0;
  58                 this.data = null;
  59         };
  60
  61         @Override
  62         public String toString (){
  63                 return this.name;
  64
  65         }
  66
  67         /**
  68          * This static method gets an host instance associated with a native
  69          * host of your platform. This is the best way to get a java host object.
  70          *
  71          * @param name          The name of the host to get.
  72          *
  73          * @return              The host object with the given name.
  74          * @exception           HostNotFoundException if the name of the host is not valid.
  75          *                                      NativeException if the native version of this method failed.
  76          */
  77         public native static Host getByName(String name)
  78                         throws HostNotFoundException, NullPointerException;
  79         /** Counts the installed hosts. */
  80         public native static int getCount();
  81
  82         /** Returns the host of the current process. */
  83         public native static Host currentHost();
  84
  85         /** Returns all hosts of the installed platform. */
  86         public native static Host[] all();
  87
  88         /**
  89          * This static method sets a mailbox to receive in asynchronous mode.
  90          *
  91          * All messages sent to this mailbox will be transferred to
  92          * the receiver without waiting for the receive call.
  93          * The receive call will still be necessary to use the received data.
  94          * If there is a need to receive some messages asynchronously, and some not,
  95          * two different mailboxes should be used.
  96          *
  97          * @param mailboxName The name of the mailbox
  98          */
  99         public static native void setAsyncMailbox(String mailboxName);
 100
 101
 102         /** Returns the name of an host. */
 103         public String getName() {
 104                 return name;
 105         }
 106
 107         /** Sets the user data of the host. */
 108         public void setData(Object data) {
 109                 this.data = data;
 110         }
 111         /** Gets the user data of the host. */
 112         public Object getData() {
 113                 return this.data;
 114         }
 115         /** Returns true if the host has an associated data object. */
 116         public boolean hasData() {
 117                 return null != this.data;
 118         }
 119
 120         /** Starts the host if it is off */
 121         public native void on();
 122         /** Stops the host if it is on */
 123         public native void off();
 124
 125
 126         /**
 127          * This method returns the speed of the processor of a host (in flops),
 128          * regardless of the current load of the machine.
 129          */
 130         public native double getSpeed();
 131         /** Returns the number of core of a host. */
 132         public native double getCoreNumber();
 133
 134         /** Returns the value of a given host property. */
 135         public native String getProperty(String name);
 136         /** Changes the value of a given host property. */
 137         public native void setProperty(String name, String value);
 138         /** Tests if an host is up and running. */
 139         public native boolean isOn();
 140
 141         /** Returns the list of mount point names on an host */
 142         public native Storage[] getMountedStorage();
 143         /** This methods returns the list of storages (names) attached to an host */
 144         public native String[] getAttachedStorage();
 145
 146         /** Returns the amount of Joules consumed by that host so far */
 147         public native double getConsumedEnergy();
 148
 149         /** Class initializer, to initialize various JNI stuff */
 150         public static native void nativeInit();
 151         static {
 152                 nativeInit();
 153         }
 154 }