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