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