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