src/bindings/java/jmsg.cpp

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