src/bindings/java/jmsg_host.cpp

   1 /* Functions related to the java host instances.                            */
   2
   3 /* Copyright (c) 2007-2022. The SimGrid Team. All rights reserved.          */
   4
   5 /* This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the license (GNU LGPL) which comes with this package. */
   7
   8 #include "simgrid/Exception.hpp"
   9 #include "simgrid/plugins/energy.h"
  10 #include "simgrid/plugins/load.h"
  11 #include "simgrid/s4u/Host.hpp"
  12
  13 #include "JavaContext.hpp"
  14 #include "jmsg.hpp"
  15 #include "jmsg_host.h"
  16 #include "jxbt_utilities.hpp"
  17
  18 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(java);
  19
  20 static jmethodID jhost_method_Host_constructor;
  21 static jfieldID jhost_field_Host_bind;
  22 static jfieldID jhost_field_Host_name;
  23
  24 jobject jhost_new_instance(JNIEnv * env) {
  25   jclass cls = jxbt_get_class(env, "org/simgrid/msg/Host");
  26   return env->NewObject(cls, jhost_method_Host_constructor);
  27 }
  28
  29 jobject jhost_ref(JNIEnv * env, jobject jhost) {
  30   return env->NewGlobalRef(jhost);
  31 }
  32
  33 void jhost_unref(JNIEnv * env, jobject jhost) {
  34   env->DeleteGlobalRef(jhost);
  35 }
  36
  37 void jhost_bind(jobject jhost, msg_host_t host, JNIEnv * env) {
  38   env->SetLongField(jhost, jhost_field_Host_bind, (jlong) (uintptr_t) (host));
  39 }
  40
  41 msg_host_t jhost_get_native(JNIEnv * env, jobject jhost) {
  42   return (msg_host_t) (uintptr_t) env->GetLongField(jhost, jhost_field_Host_bind);
  43 }
  44
  45 JNIEXPORT void JNICALL Java_org_simgrid_msg_Host_nativeInit(JNIEnv *env, jclass cls) {
  46   jclass class_Host = env->FindClass("org/simgrid/msg/Host");
  47   jhost_method_Host_constructor = env->GetMethodID(class_Host, "<init>", "()V");
  48   jhost_field_Host_bind = jxbt_get_jfield(env,class_Host, "bind", "J");
  49   jhost_field_Host_name = jxbt_get_jfield(env, class_Host, "name", "Ljava/lang/String;");
  50   xbt_assert(class_Host && jhost_field_Host_name && jhost_method_Host_constructor && jhost_field_Host_bind,
  51              "Native initialization of msg/Host failed. Please report that bug");
  52 }
  53
  54 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Host_getByName(JNIEnv* env, jclass cls, jstring jname)
  55 {
  56   /* get the C string from the java string */
  57   if (jname == nullptr) {
  58     jxbt_throw_null(env, "No host can have a null name");
  59     return nullptr;
  60   }
  61   jstring_wrapper name(env, jname);
  62   /* get the host by name       (the hosts are created during the grid resolution) */
  63   sg_host_t host = sg_host_by_name(name);
  64
  65   if (not host) { /* invalid name */
  66     jxbt_throw_host_not_found(env, name);
  67     return nullptr;
  68   }
  69
  70   if (not host->extension(JAVA_HOST_LEVEL)) { /* native host not associated yet with java host */
  71     /* Instantiate a new java host */
  72     jobject jhost = jhost_new_instance(env);
  73
  74     if (not jhost) {
  75       jxbt_throw_jni(env, "java host instantiation failed");
  76       return nullptr;
  77     }
  78
  79     /* get a global reference to the newly created host */
  80     jhost = jhost_ref(env, jhost);
  81
  82     if (not jhost) {
  83       jxbt_throw_jni(env, "new global ref allocation failed");
  84       return nullptr;
  85     }
  86     /* Sets the java host name */
  87     env->SetObjectField(jhost, jhost_field_Host_name, jname);
  88     /* bind the java host and the native host */
  89     jhost_bind(jhost, host, env);
  90
  91     /* the native host data field is set with the global reference to the java host returned by this function */
  92     host->extension_set(JAVA_HOST_LEVEL, jhost);
  93   }
  94
  95   /* return the global reference to the java host instance */
  96   return (jobject) host->extension(JAVA_HOST_LEVEL);
  97 }
  98
  99 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Host_currentHost(JNIEnv * env, jclass cls) {
 100   jobject jhost;
 101
 102   sg_host_t host = sg_host_self();
 103
 104   if (not host->extension(JAVA_HOST_LEVEL)) {
 105     /* the native host not yet associated with the java host instance */
 106
 107     /* instantiate a new java host instance */
 108     jhost = jhost_new_instance(env);
 109
 110     if (not jhost) {
 111       jxbt_throw_jni(env, "java host instantiation failed");
 112       return nullptr;
 113     }
 114
 115     /* get a global reference to the newly created host */
 116     jhost = jhost_ref(env, jhost);
 117
 118     if (not jhost) {
 119       jxbt_throw_jni(env, "global ref allocation failed");
 120       return nullptr;
 121     }
 122     /* Sets the host name */
 123     jobject jname = env->NewStringUTF(host->get_cname());
 124     env->SetObjectField(jhost, jhost_field_Host_name, jname);
 125     /* Bind & store it */
 126     jhost_bind(jhost, host, env);
 127     host->extension_set(JAVA_HOST_LEVEL, jhost);
 128   } else {
 129     jhost = (jobject) host->extension(JAVA_HOST_LEVEL);
 130   }
 131
 132   return jhost;
 133 }
 134
 135 JNIEXPORT void JNICALL Java_org_simgrid_msg_Host_on(JNIEnv *env, jobject jhost) {
 136   sg_host_t host = jhost_get_native(env, jhost);
 137   sg_host_turn_on(host);
 138 }
 139
 140 JNIEXPORT void JNICALL Java_org_simgrid_msg_Host_off(JNIEnv *env, jobject jhost) {
 141   sg_host_t host = jhost_get_native(env, jhost);
 142   if (not simgrid::ForcefulKillException::try_n_catch([host]() { sg_host_turn_off(host); }))
 143     jxbt_throw_by_name(env, "org/simgrid/msg/ProcessKilledError", "Host turned off");
 144 }
 145
 146 JNIEXPORT jint JNICALL Java_org_simgrid_msg_Host_getCount(JNIEnv * env, jclass cls) {
 147   return (jint)sg_host_count();
 148 }
 149
 150 JNIEXPORT jdouble JNICALL Java_org_simgrid_msg_Host_getSpeed(JNIEnv * env, jobject jhost) {
 151   const_sg_host_t host = jhost_get_native(env, jhost);
 152
 153   if (not host) {
 154     jxbt_throw_notbound(env, "host", jhost);
 155     return -1;
 156   }
 157
 158   return (jdouble)sg_host_get_speed(host);
 159 }
 160
 161 JNIEXPORT jdouble JNICALL Java_org_simgrid_msg_Host_getCoreNumber(JNIEnv * env, jobject jhost) {
 162   const_sg_host_t host = jhost_get_native(env, jhost);
 163
 164   if (not host) {
 165     jxbt_throw_notbound(env, "host", jhost);
 166     return -1;
 167   }
 168
 169   return (jdouble)sg_host_core_count(host);
 170 }
 171
 172 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Host_getProperty(JNIEnv *env, jobject jhost, jobject jname) {
 173   const_sg_host_t host = jhost_get_native(env, jhost);
 174
 175   if (not host) {
 176     jxbt_throw_notbound(env, "host", jhost);
 177     return nullptr;
 178   }
 179   jstring_wrapper name(env, (jstring)jname);
 180
 181   const char* property = sg_host_get_property_value(host, name);
 182   if (not property) {
 183     return nullptr;
 184   }
 185
 186   jobject jproperty = env->NewStringUTF(property);
 187
 188   return jproperty;
 189 }
 190
 191 JNIEXPORT void JNICALL
 192 Java_org_simgrid_msg_Host_setProperty(JNIEnv *env, jobject jhost, jobject jname, jobject jvalue) {
 193   sg_host_t host = jhost_get_native(env, jhost);
 194
 195   if (not host) {
 196     jxbt_throw_notbound(env, "host", jhost);
 197     return;
 198   }
 199   jstring_wrapper name(env, (jstring)jname);
 200   jstring_wrapper value_java(env, (jstring)jvalue);
 201   const char* value      = xbt_strdup(value_java);
 202
 203   sg_host_set_property_value(host, name, value);
 204 }
 205
 206 JNIEXPORT jboolean JNICALL Java_org_simgrid_msg_Host_isOn(JNIEnv * env, jobject jhost)
 207 {
 208   const_sg_host_t host = jhost_get_native(env, jhost);
 209
 210   if (not host) {
 211     jxbt_throw_notbound(env, "host", jhost);
 212     return 0;
 213   }
 214
 215   return (jboolean)sg_host_is_on(host);
 216 }
 217
 218 JNIEXPORT jobjectArray JNICALL Java_org_simgrid_msg_Host_all(JNIEnv * env, jclass cls_arg)
 219 {
 220   sg_host_t* table = sg_host_list();
 221   int count        = sg_host_count();
 222
 223   jclass cls = jxbt_get_class(env, "org/simgrid/msg/Host");
 224   if (not cls)
 225     return nullptr;
 226
 227   jobjectArray jtable = env->NewObjectArray((jsize)count, cls, nullptr);
 228
 229   if (not jtable) {
 230     jxbt_throw_jni(env, "Hosts table allocation failed");
 231     return nullptr;
 232   }
 233
 234   for (int index = 0; index < count; index++) {
 235     auto jhost = static_cast<jobject>(table[index]->extension(JAVA_HOST_LEVEL));
 236
 237     if (not jhost) {
 238       jstring jname = env->NewStringUTF(table[index]->get_cname());
 239       jhost         = Java_org_simgrid_msg_Host_getByName(env, cls_arg, jname);
 240     }
 241
 242     env->SetObjectArrayElement(jtable, index, jhost);
 243   }
 244   xbt_free(table);
 245   return jtable;
 246 }
 247
 248 JNIEXPORT void JNICALL Java_org_simgrid_msg_Host_setAsyncMailbox(JNIEnv * env, jclass cls_arg, jobject jname)
 249 {
 250   jstring_wrapper name(env, (jstring)jname);
 251   sg_mailbox_set_receiver(name);
 252 }
 253
 254 JNIEXPORT void JNICALL Java_org_simgrid_msg_Host_updateAllEnergyConsumptions(JNIEnv* env, jclass cls)
 255 {
 256   sg_host_energy_update_all();
 257 }
 258
 259 JNIEXPORT jdouble JNICALL Java_org_simgrid_msg_Host_getConsumedEnergy (JNIEnv *env, jobject jhost)
 260 {
 261   const_sg_host_t host = jhost_get_native(env, jhost);
 262
 263   if (not host) {
 264     jxbt_throw_notbound(env, "host", jhost);
 265     return 0;
 266   }
 267
 268   return sg_host_get_consumed_energy(host);
 269 }
 270
 271 JNIEXPORT void JNICALL Java_org_simgrid_msg_Host_setPstate(JNIEnv* env, jobject jhost, jint pstate)
 272 {
 273   sg_host_t host = jhost_get_native(env, jhost);
 274   sg_host_set_pstate(host, pstate);
 275 }
 276 JNIEXPORT jint JNICALL Java_org_simgrid_msg_Host_getPstate(JNIEnv* env, jobject jhost)
 277 {
 278   const_sg_host_t host = jhost_get_native(env, jhost);
 279   return sg_host_get_pstate(host);
 280 }
 281 JNIEXPORT jint JNICALL Java_org_simgrid_msg_Host_getPstatesCount(JNIEnv* env, jobject jhost)
 282 {
 283   const_sg_host_t host = jhost_get_native(env, jhost);
 284   return sg_host_get_nb_pstates(host);
 285 }
 286 JNIEXPORT jdouble JNICALL Java_org_simgrid_msg_Host_getCurrentPowerPeak(JNIEnv* env, jobject jhost)
 287 {
 288   const_sg_host_t host = jhost_get_native(env, jhost);
 289   return sg_host_get_speed(host);
 290 }
 291 JNIEXPORT jdouble JNICALL Java_org_simgrid_msg_Host_getPowerPeakAt(JNIEnv* env, jobject jhost, jint pstate)
 292 {
 293   const_sg_host_t host = jhost_get_native(env, jhost);
 294   return sg_host_get_pstate_speed(host, pstate);
 295 }
 296
 297 JNIEXPORT jdouble JNICALL Java_org_simgrid_msg_Host_getLoad(JNIEnv* env, jobject jhost)
 298 {
 299   const_sg_host_t host = jhost_get_native(env, jhost);
 300   return sg_host_get_load(host);
 301 }
 302
 303 JNIEXPORT jdouble JNICALL Java_org_simgrid_msg_Host_getCurrentLoad (JNIEnv *env, jobject jhost)
 304 {
 305   const_sg_host_t host = jhost_get_native(env, jhost);
 306
 307   if (not host) {
 308     jxbt_throw_notbound(env, "host", jhost);
 309     return 0;
 310   }
 311
 312   return sg_host_get_current_load(host);
 313 }
 314
 315 JNIEXPORT jdouble JNICALL Java_org_simgrid_msg_Host_getComputedFlops (JNIEnv *env, jobject jhost)
 316 {
 317   const_sg_host_t host = jhost_get_native(env, jhost);
 318
 319   if (not host) {
 320     jxbt_throw_notbound(env, "host", jhost);
 321     return 0;
 322   }
 323
 324   return sg_host_get_computed_flops(host);
 325 }
 326
 327 JNIEXPORT jdouble JNICALL Java_org_simgrid_msg_Host_getAvgLoad (JNIEnv *env, jobject jhost)
 328 {
 329   const_sg_host_t host = jhost_get_native(env, jhost);
 330
 331   if (not host) {
 332     jxbt_throw_notbound(env, "host", jhost);
 333     return 0;
 334   }
 335
 336   return sg_host_get_avg_load(host);
 337 }