1 /* Java Wrappers to the MSG API. */
3 /* Copyright (c) 2007-2019. The SimGrid Team. All rights reserved. */
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. */
14 #include "simgrid/Exception.hpp"
15 #include "simgrid/msg.h"
16 #include "simgrid/plugins/energy.h"
17 #include "simgrid/plugins/file_system.h"
18 #include "simgrid/plugins/live_migration.h"
19 #include "simgrid/plugins/load.h"
20 #include "simgrid/simix.h"
22 #include "simgrid/s4u/Host.hpp"
24 #include "src/simix/smx_private.hpp"
27 #include "jmsg_as.hpp"
28 #include "jmsg_host.h"
29 #include "jmsg_process.h"
30 #include "jmsg_storage.h"
31 #include "jmsg_task.h"
32 #include "jxbt_utilities.hpp"
34 #include "JavaContext.hpp"
37 /* Shut up some errors in eclipse online compiler. I wish such a pimple wouldn't be needed */
44 /* end of eclipse-mandated pimple */
46 int JAVA_HOST_LEVEL = -1;
48 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(java);
50 JavaVM *__java_vm = nullptr;
52 JNIEnv *get_current_thread_env()
54 using simgrid::kernel::context::JavaContext;
55 JavaContext* ctx = static_cast<JavaContext*>(simgrid::kernel::context::Context::self());
62 void jmsg_throw_status(JNIEnv *env, msg_error_t status) {
65 jxbt_throw_time_out_failure(env, "");
67 case MSG_TRANSFER_FAILURE:
68 jxbt_throw_transfer_failure(env, "");
70 case MSG_HOST_FAILURE:
71 jxbt_throw_host_failure(env, "");
73 case MSG_TASK_CANCELED:
74 jxbt_throw_task_cancelled(env, "");
77 xbt_die("undefined message failed (please see jmsg_throw_status function in jmsg.cpp)");
81 /***************************************************************************************
82 * Unsortable functions *
83 ***************************************************************************************/
85 JNIEXPORT jdouble JNICALL Java_org_simgrid_msg_Msg_getClock(JNIEnv * env, jclass cls)
87 return (jdouble) MSG_get_clock();
90 JNIEXPORT void JNICALL Java_org_simgrid_msg_Msg_init(JNIEnv * env, jclass cls, jobjectArray jargs)
92 env->GetJavaVM(&__java_vm);
94 simgrid::kernel::context::factory_initializer = &simgrid::kernel::context::java_factory;
95 jthrowable exc = env->ExceptionOccurred();
97 env->ExceptionClear();
100 setlocale(LC_NUMERIC,"C");
104 argc += static_cast<int>(env->GetArrayLength(jargs));
105 xbt_assert(argc > 0);
107 // Need a static storage because the XBT layer saves the arguments in xbt_binary_name and xbt_cmdline.
108 static std::vector<std::string> args;
111 args.emplace_back("java");
112 for (int index = 1; index < argc; index++) {
113 jstring jval = (jstring)env->GetObjectArrayElement(jargs, index - 1);
114 const char* tmp = env->GetStringUTFChars(jval, 0);
115 args.emplace_back(tmp);
116 env->ReleaseStringUTFChars(jval, tmp);
119 std::unique_ptr<char* []> argv(new char*[argc + 1]);
120 std::transform(begin(args), end(args), argv.get(), [](std::string& s) { return &s.front(); });
121 argv[argc] = nullptr;
124 MSG_init(&argc2, argv.get());
125 xbt_assert(argc2 <= argc);
127 for (int index = 1; index < argc2; index++)
128 env->SetObjectArrayElement(jargs, index - 1, (jstring)env->NewStringUTF(argv[index]));
130 sg_vm_live_migration_plugin_init();
131 JAVA_HOST_LEVEL = simgrid::s4u::Host::extension_create(nullptr);
134 JNIEXPORT void JNICALL JNICALL Java_org_simgrid_msg_Msg_run(JNIEnv * env, jclass cls)
137 XBT_DEBUG("Ready to run MSG_MAIN");
138 msg_error_t rv = MSG_main();
139 XBT_DEBUG("Done running MSG_MAIN");
140 jxbt_check_res("MSG_main()", rv, MSG_OK,
141 xbt_strdup("unexpected error : MSG_main() failed .. please report this bug "));
143 XBT_INFO("MSG_main finished; Terminating the simulation...");
144 /* Cleanup java hosts */
145 xbt_dynar_t hosts = MSG_hosts_as_dynar();
146 for (unsigned long index = 0; index < xbt_dynar_length(hosts) - 1; index++) {
147 msg_host_t msg_host = xbt_dynar_get_as(hosts,index,msg_host_t);
148 jobject jhost = (jobject) msg_host->extension(JAVA_HOST_LEVEL);
150 jhost_unref(env, jhost);
152 xbt_dynar_free(&hosts);
154 /* Cleanup java storages */
155 for (auto const& elm : java_storage_map)
156 jstorage_unref(env, elm.second);
158 /* Display the status of remaining threads. None should survive, but who knows */
159 jclass clsProcess = jxbt_get_class(env, "org/simgrid/msg/Process");
160 jmethodID idDebug = jxbt_get_static_jmethod(env, clsProcess, "debugAllThreads", "()V");
161 xbt_assert(idDebug != nullptr, "Method Process.debugAllThreads() not found...");
162 env->CallStaticVoidMethod(clsProcess, idDebug);
165 JNIEXPORT void JNICALL Java_org_simgrid_msg_Msg_createEnvironment(JNIEnv * env, jclass cls, jstring jplatformFile)
167 const char *platformFile = env->GetStringUTFChars(jplatformFile, 0);
169 MSG_create_environment(platformFile);
171 env->ReleaseStringUTFChars(jplatformFile, platformFile);
174 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Msg_environmentGetRoutingRoot(JNIEnv * env, jclass cls)
176 msg_netzone_t as = MSG_zone_get_root();
177 jobject jas = jnetzone_new_instance(env);
179 jxbt_throw_jni(env, "java As instantiation failed");
182 jas = jnetzone_ref(env, jas);
184 jxbt_throw_jni(env, "new global ref allocation failed");
187 jnetzone_bind(jas, as, env);
189 return (jobject) jas;
192 JNIEXPORT void JNICALL Java_org_simgrid_msg_Msg_debug(JNIEnv * env, jclass cls, jstring js)
194 const char *s = env->GetStringUTFChars(js, 0);
196 env->ReleaseStringUTFChars(js, s);
199 JNIEXPORT void JNICALL Java_org_simgrid_msg_Msg_verb(JNIEnv * env, jclass cls, jstring js)
201 const char *s = env->GetStringUTFChars(js, 0);
203 env->ReleaseStringUTFChars(js, s);
206 JNIEXPORT void JNICALL Java_org_simgrid_msg_Msg_info(JNIEnv * env, jclass cls, jstring js)
208 const char *s = env->GetStringUTFChars(js, 0);
210 env->ReleaseStringUTFChars(js, s);
213 JNIEXPORT void JNICALL Java_org_simgrid_msg_Msg_warn(JNIEnv * env, jclass cls, jstring js)
215 const char *s = env->GetStringUTFChars(js, 0);
217 env->ReleaseStringUTFChars(js, s);
220 JNIEXPORT void JNICALL Java_org_simgrid_msg_Msg_error(JNIEnv * env, jclass cls, jstring js)
222 const char *s = env->GetStringUTFChars(js, 0);
224 env->ReleaseStringUTFChars(js, s);
227 JNIEXPORT void JNICALL Java_org_simgrid_msg_Msg_critical(JNIEnv * env, jclass cls, jstring js)
229 const char *s = env->GetStringUTFChars(js, 0);
230 XBT_CRITICAL("%s", s);
231 env->ReleaseStringUTFChars(js, s);
234 static int java_main(int argc, char *argv[]);
236 JNIEXPORT void JNICALL
237 Java_org_simgrid_msg_Msg_deployApplication(JNIEnv * env, jclass cls, jstring jdeploymentFile)
239 const char *deploymentFile = env->GetStringUTFChars(jdeploymentFile, 0);
241 SIMIX_function_register_default(java_main);
242 MSG_launch_application(deploymentFile);
245 JNIEXPORT void JNICALL Java_org_simgrid_msg_Msg_energyInit() {
246 sg_host_energy_plugin_init();
249 JNIEXPORT void JNICALL Java_org_simgrid_msg_Msg_fileSystemInit()
251 sg_storage_file_system_init();
254 JNIEXPORT void JNICALL Java_org_simgrid_msg_Msg_loadInit() {
255 sg_host_load_plugin_init();
257 /** Run a Java org.simgrid.msg.Process
259 * If needed, this waits for the process starting time.
260 * Then it calls the Process.run() method.
262 static void run_jprocess(JNIEnv *env, jobject jprocess)
264 // wait for the process's start time
265 jfieldID jprocess_field_Process_startTime = jxbt_get_sfield(env, "org/simgrid/msg/Process", "startTime", "D");
266 jdouble startTime = env->GetDoubleField(jprocess, jprocess_field_Process_startTime);
267 if (startTime > MSG_get_clock())
268 MSG_process_sleep(startTime - MSG_get_clock());
270 //Execution of the "run" method.
271 jmethodID id = jxbt_get_smethod(env, "org/simgrid/msg/Process", "run", "()V");
272 xbt_assert((id != nullptr), "Method Process.run() not found...");
274 env->CallVoidMethod(jprocess, id);
275 if (env->ExceptionOccurred()) {
276 XBT_DEBUG("Something went wrong in this Java actor, forget about it.");
277 env->ExceptionClear();
278 XBT_ATTRIB_UNUSED jint error = __java_vm->DetachCurrentThread();
279 xbt_assert(error == JNI_OK, "Cannot detach failing thread");
280 simgrid::ForcefulKillException::do_throw();
284 /** Create a Java org.simgrid.msg.Process with the arguments and run it */
285 static int java_main(int argc, char *argv[])
287 JNIEnv *env = get_current_thread_env();
288 simgrid::kernel::context::JavaContext* context =
289 static_cast<simgrid::kernel::context::JavaContext*>(simgrid::kernel::context::Context::self());
291 //Change the "." in class name for "/".
292 std::string arg0 = argv[0];
293 std::replace(begin(arg0), end(arg0), '.', '/');
294 jclass class_Process = env->FindClass(arg0.c_str());
295 //Retrieve the methodID for the constructor
296 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]);
297 jmethodID constructor_Process = env->GetMethodID(class_Process, "<init>", "(Lorg/simgrid/msg/Host;Ljava/lang/String;[Ljava/lang/String;)V");
298 xbt_assert((constructor_Process != nullptr), "Constructor not found for class %s. Is there a (Host, String ,String[]) constructor in your class ?", argv[0]);
300 //Retrieve the name of the process.
301 jstring jname = env->NewStringUTF(argv[0]);
302 //Build the arguments
303 jobjectArray args = static_cast<jobjectArray>(env->NewObjectArray(argc - 1, env->FindClass("java/lang/String"),
304 env->NewStringUTF("")));
305 for (int i = 1; i < argc; i++)
306 env->SetObjectArrayElement(args,i - 1, env->NewStringUTF(argv[i]));
307 //Retrieve the host for the process.
308 jstring jhostName = env->NewStringUTF(MSG_host_self()->get_cname());
309 jobject jhost = Java_org_simgrid_msg_Host_getByName(env, nullptr, jhostName);
310 //creates the process
311 jobject jprocess = env->NewObject(class_Process, constructor_Process, jhost, jname, args);
312 xbt_assert((jprocess != nullptr), "Process allocation failed.");
313 jprocess = env->NewGlobalRef(jprocess);
314 //bind the process to the context
315 msg_process_t process = MSG_process_self();
317 context->jprocess_ = jprocess;
318 /* sets the PID and the PPID of the process */
319 env->SetIntField(jprocess, jprocess_field_Process_pid, static_cast<jint>(MSG_process_get_PID(process)));
320 env->SetIntField(jprocess, jprocess_field_Process_ppid, static_cast<jint>(MSG_process_get_PPID(process)));
321 jprocess_bind(jprocess, process, env);
323 run_jprocess(env, context->jprocess_);
331 /** Run the Java org.simgrid.msg.Process */
332 void java_main_jprocess(jobject jprocess)
334 JNIEnv *env = get_current_thread_env();
335 simgrid::kernel::context::JavaContext* context =
336 static_cast<simgrid::kernel::context::JavaContext*>(simgrid::kernel::context::Context::self());
337 context->jprocess_ = jprocess;
338 jprocess_bind(context->jprocess_, MSG_process_self(), env);
340 run_jprocess(env, context->jprocess_);