src/bindings/java/jmsg.cpp

   1 /* Java Wrappers to the MSG API.                                            */
   2
   3 /* Copyright (c) 2007-2017. 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 <locale.h>
   9
  10 #include <simgrid/msg.h>
  11 #include <simgrid/simix.h>
  12 #include <simgrid/plugins/energy.h>
  13
  14 #include <simgrid/s4u/host.hpp>
  15
  16 #include <src/simix/smx_private.h>
  17
  18 #include "jmsg_process.h"
  19 #include "jmsg_as.h"
  20 #include "jmsg_host.h"
  21 #include "jmsg_storage.h"
  22 #include "jmsg_task.h"
  23 #include "jxbt_utilities.h"
  24 #include "jmsg.h"
  25
  26 #include "JavaContext.hpp"
  27
  28 #include <xbt/ex.hpp>
  29
  30 /* Shut up some errors in eclipse online compiler. I wish such a pimple wouldn't be needed */
  31 #ifndef JNIEXPORT
  32 #define JNIEXPORT
  33 #endif
  34 #ifndef JNICALL
  35 #define JNICALL
  36 #endif
  37 /* end of eclipse-mandated pimple */
  38
  39 SG_BEGIN_DECL()
  40
  41 int JAVA_HOST_LEVEL = -1;
  42 int JAVA_STORAGE_LEVEL = -1;
  43
  44 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(jmsg);
  45
  46 JavaVM *__java_vm = nullptr;
  47
  48 JavaVM *get_java_VM()
  49 {
  50   return __java_vm;
  51 }
  52
  53 JNIEnv *get_current_thread_env()
  54 {
  55   JNIEnv *env;
  56
  57   __java_vm->AttachCurrentThread((void **) &env, nullptr);
  58   return env;
  59 }
  60
  61 void jmsg_throw_status(JNIEnv *env, msg_error_t status) {
  62   switch (status) {
  63     case MSG_TIMEOUT:
  64         jxbt_throw_time_out_failure(env,nullptr);
  65     break;
  66     case MSG_TRANSFER_FAILURE:
  67         jxbt_throw_transfer_failure(env,nullptr);
  68     break;
  69     case MSG_HOST_FAILURE:
  70         jxbt_throw_host_failure(env,nullptr);
  71     break;
  72     case MSG_TASK_CANCELED:
  73         jxbt_throw_task_cancelled(env,nullptr);
  74     break;
  75     default:
  76       xbt_die("undefined message failed (please see jmsg_throw_status function in jmsg.cpp)");
  77   }
  78 }
  79
  80 /***************************************************************************************
  81  * Unsortable functions                                                        *
  82  ***************************************************************************************/
  83
  84 JNIEXPORT jdouble JNICALL Java_org_simgrid_msg_Msg_getClock(JNIEnv * env, jclass cls)
  85 {
  86   return (jdouble) MSG_get_clock();
  87 }
  88
  89 static void __JAVA_host_priv_free(void *host)
  90 {
  91 }
  92
  93 static void __JAVA_storage_priv_free(void *storage)
  94 {
  95 }
  96
  97 JNIEXPORT void JNICALL Java_org_simgrid_msg_Msg_init(JNIEnv * env, jclass cls, jobjectArray jargs)
  98 {
  99   char **argv = nullptr;
 100   int index;
 101   int argc = 0;
 102   jstring jval;
 103   const char *tmp;
 104
 105   XBT_LOG_CONNECT(jmsg);
 106   XBT_LOG_CONNECT(jtrace);
 107
 108   env->GetJavaVM(&__java_vm);
 109
 110   simgrid::kernel::context::factory_initializer = &simgrid::kernel::context::java_factory;
 111   jthrowable exc = env->ExceptionOccurred();
 112   if (exc) {
 113     env->ExceptionClear();
 114   }
 115
 116   setlocale(LC_NUMERIC,"C");
 117
 118   if (jargs)
 119     argc = (int) env->GetArrayLength(jargs);
 120
 121   argc++;
 122   argv = xbt_new(char *, argc + 1);
 123   argv[0] = xbt_strdup("java");
 124
 125   for (index = 0; index < argc - 1; index++) {
 126     jval = (jstring) env->GetObjectArrayElement(jargs, index);
 127     tmp = env->GetStringUTFChars(jval, 0);
 128     argv[index + 1] = xbt_strdup(tmp);
 129     env->ReleaseStringUTFChars(jval, tmp);
 130   }
 131   argv[argc] = nullptr;
 132
 133   MSG_init(&argc, argv);
 134
 135   JAVA_HOST_LEVEL = simgrid::s4u::Host::extension_create(__JAVA_host_priv_free);
 136   JAVA_STORAGE_LEVEL = xbt_lib_add_level(storage_lib, __JAVA_storage_priv_free);
 137
 138   for (index = 0; index < argc; index++)
 139     free(argv[index]);
 140
 141   free(argv);
 142 }
 143
 144 JNIEXPORT void JNICALL JNICALL Java_org_simgrid_msg_Msg_run(JNIEnv * env, jclass cls)
 145 {
 146   /* Run everything */
 147   XBT_DEBUG("Ready to run MSG_MAIN");
 148   msg_error_t rv = MSG_main();
 149   XBT_DEBUG("Done running MSG_MAIN");
 150   jxbt_check_res("MSG_main()", rv, MSG_OK,
 151                  xbt_strdup("unexpected error : MSG_main() failed .. please report this bug "));
 152
 153   XBT_INFO("MSG_main finished; Cleaning up the simulation...");
 154   /* Cleanup java hosts */
 155   xbt_dynar_t hosts = MSG_hosts_as_dynar();
 156   for (unsigned long index = 0; index < xbt_dynar_length(hosts) - 1; index++) {
 157     msg_host_t msg_host = xbt_dynar_get_as(hosts,index,msg_host_t);
 158     jobject jhost = (jobject) msg_host->extension(JAVA_HOST_LEVEL);
 159     if (jhost)
 160       jhost_unref(env, jhost);
 161
 162   }
 163   xbt_dynar_free(&hosts);
 164
 165   /* Cleanup java storages */
 166   xbt_dynar_t storages = MSG_storages_as_dynar();
 167   if(!xbt_dynar_is_empty(storages)){
 168     for (unsigned long index = 0; index < xbt_dynar_length(storages) - 1; index++) {
 169       jobject jstorage = (jobject) xbt_lib_get_level(xbt_dynar_get_as(storages,index,msg_storage_t), JAVA_STORAGE_LEVEL);
 170       if (jstorage)
 171         jstorage_unref(env, jstorage);
 172     }
 173   }
 174   xbt_dynar_free(&storages);
 175 }
 176
 177 JNIEXPORT void JNICALL Java_org_simgrid_msg_Msg_createEnvironment(JNIEnv * env, jclass cls, jstring jplatformFile)
 178 {
 179   const char *platformFile = env->GetStringUTFChars(jplatformFile, 0);
 180
 181   MSG_create_environment(platformFile);
 182
 183   env->ReleaseStringUTFChars(jplatformFile, platformFile);
 184 }
 185
 186 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Msg_environmentGetRoutingRoot(JNIEnv * env, jclass cls)
 187 {
 188   msg_netzone_t as = MSG_environment_get_routing_root();
 189   jobject jas      = jnetzone_new_instance(env);
 190   if (!jas) {
 191     jxbt_throw_jni(env, "java As instantiation failed");
 192     return nullptr;
 193   }
 194   jas = jnetzone_ref(env, jas);
 195   if (!jas) {
 196     jxbt_throw_jni(env, "new global ref allocation failed");
 197     return nullptr;
 198   }
 199   jnetzone_bind(jas, as, env);
 200
 201   return (jobject) jas;
 202 }
 203
 204 JNIEXPORT void JNICALL Java_org_simgrid_msg_Msg_debug(JNIEnv * env, jclass cls, jstring js)
 205 {
 206   const char *s = env->GetStringUTFChars(js, 0);
 207   XBT_DEBUG("%s", s);
 208   env->ReleaseStringUTFChars(js, s);
 209 }
 210
 211 JNIEXPORT void JNICALL Java_org_simgrid_msg_Msg_verb(JNIEnv * env, jclass cls, jstring js)
 212 {
 213   const char *s = env->GetStringUTFChars(js, 0);
 214   XBT_VERB("%s", s);
 215   env->ReleaseStringUTFChars(js, s);
 216 }
 217
 218 JNIEXPORT void JNICALL Java_org_simgrid_msg_Msg_info(JNIEnv * env, jclass cls, jstring js)
 219 {
 220   const char *s = env->GetStringUTFChars(js, 0);
 221   XBT_INFO("%s", s);
 222   env->ReleaseStringUTFChars(js, s);
 223 }
 224
 225 JNIEXPORT void JNICALL Java_org_simgrid_msg_Msg_warn(JNIEnv * env, jclass cls, jstring js)
 226 {
 227   const char *s = env->GetStringUTFChars(js, 0);
 228   XBT_WARN("%s", s);
 229   env->ReleaseStringUTFChars(js, s);
 230 }
 231
 232 JNIEXPORT void JNICALL Java_org_simgrid_msg_Msg_error(JNIEnv * env, jclass cls, jstring js)
 233 {
 234   const char *s = env->GetStringUTFChars(js, 0);
 235   XBT_ERROR("%s", s);
 236   env->ReleaseStringUTFChars(js, s);
 237 }
 238
 239 JNIEXPORT void JNICALL Java_org_simgrid_msg_Msg_critical(JNIEnv * env, jclass cls, jstring js)
 240 {
 241   const char *s = env->GetStringUTFChars(js, 0);
 242   XBT_CRITICAL("%s", s);
 243   env->ReleaseStringUTFChars(js, s);
 244 }
 245
 246 static int java_main(int argc, char *argv[]);
 247
 248 JNIEXPORT void JNICALL
 249 Java_org_simgrid_msg_Msg_deployApplication(JNIEnv * env, jclass cls, jstring jdeploymentFile)
 250 {
 251   const char *deploymentFile = env->GetStringUTFChars(jdeploymentFile, 0);
 252
 253   SIMIX_function_register_default(java_main);
 254   MSG_launch_application(deploymentFile);
 255 }
 256
 257 JNIEXPORT void JNICALL Java_org_simgrid_msg_Msg_energyInit() {
 258   sg_host_energy_plugin_init();
 259 }
 260
 261 SG_END_DECL()
 262
 263 /** Run a Java org.simgrid.msg.Process
 264  *
 265  *  If needed, this waits for the process starting time.
 266  *  Then it calls the Process.run() method.
 267  */
 268 static void run_jprocess(JNIEnv *env, jobject jprocess)
 269 {
 270   // wait for the process's start time
 271   jfieldID jprocess_field_Process_startTime = jxbt_get_sfield(env, "org/simgrid/msg/Process", "startTime", "D");
 272   jdouble startTime = env->GetDoubleField(jprocess, jprocess_field_Process_startTime);
 273   if (startTime > MSG_get_clock())
 274     MSG_process_sleep(startTime - MSG_get_clock());
 275   //Execution of the "run" method.
 276   jmethodID id = jxbt_get_smethod(env, "org/simgrid/msg/Process", "run", "()V");
 277   xbt_assert((id != nullptr), "Method run() not found...");
 278   env->CallVoidMethod(jprocess, id);
 279 }
 280
 281 /** Create a Java org.simgrid.msg.Process with the arguments and run it */
 282 static int java_main(int argc, char *argv[])
 283 {
 284   JNIEnv *env = get_current_thread_env();
 285   simgrid::kernel::context::JavaContext* context = static_cast<simgrid::kernel::context::JavaContext*>(SIMIX_context_self());
 286
 287   //Change the "." in class name for "/".
 288   xbt_str_subst(argv[0],'.','/',0);
 289   jclass class_Process = env->FindClass(argv[0]);
 290   xbt_str_subst(argv[0],'/','.',0);
 291   //Retrieve the methodID for the constructor
 292   xbt_assert((class_Process != nullptr), "Class not found (%s). The deployment file must use the fully qualified class name, including the package. The case is important.", argv[0]);
 293   jmethodID constructor_Process = env->GetMethodID(class_Process, "<init>", "(Lorg/simgrid/msg/Host;Ljava/lang/String;[Ljava/lang/String;)V");
 294   xbt_assert((constructor_Process != nullptr), "Constructor not found for class %s. Is there a (Host, String ,String[]) constructor in your class ?", argv[0]);
 295
 296   //Retrieve the name of the process.
 297   jstring jname = env->NewStringUTF(argv[0]);
 298   //Build the arguments
 299   jobjectArray args = static_cast<jobjectArray>(env->NewObjectArray(argc - 1, env->FindClass("java/lang/String"),
 300                                                                     env->NewStringUTF("")));
 301   for (int i = 1; i < argc; i++)
 302       env->SetObjectArrayElement(args,i - 1, env->NewStringUTF(argv[i]));
 303   //Retrieve the host for the process.
 304   jstring jhostName = env->NewStringUTF(MSG_host_self()->cname());
 305   jobject jhost = Java_org_simgrid_msg_Host_getByName(env, nullptr, jhostName);
 306   //creates the process
 307   jobject jprocess = env->NewObject(class_Process, constructor_Process, jhost, jname, args);
 308   xbt_assert((jprocess != nullptr), "Process allocation failed.");
 309   jprocess = env->NewGlobalRef(jprocess);
 310   //bind the process to the context
 311   msg_process_t process = MSG_process_self();
 312
 313   context->jprocess = jprocess;
 314   /* sets the PID and the PPID of the process */
 315   env->SetIntField(jprocess, jprocess_field_Process_pid, static_cast<jint>(MSG_process_get_PID(process)));
 316   env->SetIntField(jprocess, jprocess_field_Process_ppid, static_cast<jint>(MSG_process_get_PPID(process)));
 317   jprocess_bind(jprocess, process, env);
 318
 319   run_jprocess(env, context->jprocess);
 320   return 0;
 321 }
 322
 323 namespace simgrid {
 324 namespace kernel {
 325 namespace context {
 326
 327 /** Run the Java org.simgrid.msg.Process */
 328 void java_main_jprocess(jobject jprocess)
 329 {
 330   JNIEnv *env = get_current_thread_env();
 331   simgrid::kernel::context::JavaContext* context = static_cast<simgrid::kernel::context::JavaContext*>(SIMIX_context_self());
 332   context->jprocess = jprocess;
 333   smx_actor_t process = SIMIX_process_self();
 334   jprocess_bind(context->jprocess, process, env);
 335
 336   // Adrien, ugly path, just to bypass creation of context at low levels (i.e such as for the VM migration for instance)
 337   if (context->jprocess != nullptr)
 338     run_jprocess(env, context->jprocess);
 339 }
 340 }}}