1 /* Functions related to the java task instances. */
3 /* Copyright (c) 2007-2020. 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. */
8 #include "simgrid/Exception.hpp"
9 #include "simgrid/s4u/Host.hpp"
10 #include "src/kernel/context/Context.hpp"
13 #include "jmsg_host.h"
14 #include "jmsg_process.h"
15 #include "jmsg_task.h"
16 #include "jxbt_utilities.hpp"
18 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(java);
20 static jmethodID jtask_method_Comm_constructor;
22 static jfieldID jtask_field_Task_bind;
23 static jfieldID jtask_field_Task_name;
24 static jfieldID jtask_field_Task_messageSize;
25 static jfieldID jtask_field_Comm_bind;
26 static jfieldID jtask_field_Comm_taskBind;
27 static jfieldID jtask_field_Comm_receiving;
29 void jtask_bind(jobject jtask, msg_task_t task, JNIEnv * env)
31 env->SetLongField(jtask, jtask_field_Task_bind, (intptr_t)task);
34 msg_task_t jtask_to_native(jobject jtask, JNIEnv* env)
36 return (msg_task_t)(intptr_t)env->GetLongField(jtask, jtask_field_Task_bind);
39 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_nativeInit(JNIEnv *env, jclass cls) {
40 jclass jtask_class_Comm = env->FindClass("org/simgrid/msg/Comm");
41 jclass jtask_class_Task = env->FindClass("org/simgrid/msg/Task");
42 xbt_assert(jtask_class_Comm && jtask_class_Task,
43 "Native initialization of msg/Comm or msg/Task failed. Please report that bug");
45 jtask_method_Comm_constructor = env->GetMethodID(jtask_class_Comm, "<init>", "()V");
46 jtask_field_Task_bind = jxbt_get_jfield(env, jtask_class_Task, "bind", "J");
47 jtask_field_Task_name = jxbt_get_jfield(env, jtask_class_Task, "name", "Ljava/lang/String;");
48 jtask_field_Task_messageSize = jxbt_get_jfield(env, jtask_class_Task, "messageSize", "D");
49 jtask_field_Comm_bind = jxbt_get_jfield(env, jtask_class_Comm, "bind", "J");
50 jtask_field_Comm_taskBind = jxbt_get_jfield(env, jtask_class_Comm, "taskBind", "J");
51 jtask_field_Comm_receiving = jxbt_get_jfield(env, jtask_class_Comm, "receiving", "Z");
52 xbt_assert(jtask_field_Task_bind && jtask_field_Comm_bind && jtask_field_Comm_taskBind &&
53 jtask_field_Comm_receiving && jtask_method_Comm_constructor,
54 "Native initialization of msg/Task failed. Please report that bug");
57 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_create(JNIEnv * env, jobject jtask, jstring jname,
58 jdouble jflopsAmount, jdouble jbytesAmount)
60 const char *name = nullptr; /* the name of the task */
63 name = env->GetStringUTFChars(jname, 0);
64 msg_task_t task = MSG_task_create(name, jflopsAmount, jbytesAmount, jtask);
66 env->ReleaseStringUTFChars(jname, name);
68 /* bind & store the task */
69 jtask_bind(jtask, task, env);
72 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_parallelCreate(JNIEnv * env, jobject jtask, jstring jname,
73 jobjectArray jhosts, jdoubleArray jcomputeDurations_arg,
74 jdoubleArray jmessageSizes_arg)
76 int host_count = env->GetArrayLength(jhosts);
78 jdouble* jcomputeDurations = env->GetDoubleArrayElements(jcomputeDurations_arg, 0);
79 msg_host_t* hosts = new msg_host_t[host_count];
80 double* computeDurations = new double[host_count];
81 for (int index = 0; index < host_count; index++) {
82 jobject jhost = env->GetObjectArrayElement(jhosts, index);
83 hosts[index] = jhost_get_native(env, jhost);
84 computeDurations[index] = jcomputeDurations[index];
86 env->ReleaseDoubleArrayElements(jcomputeDurations_arg, jcomputeDurations, 0);
88 jdouble* jmessageSizes = env->GetDoubleArrayElements(jmessageSizes_arg, 0);
89 double* messageSizes = new double[host_count * host_count];
90 for (int index = 0; index < host_count * host_count; index++) {
91 messageSizes[index] = jmessageSizes[index];
93 env->ReleaseDoubleArrayElements(jmessageSizes_arg, jmessageSizes, 0);
95 /* get the C string from the java string */
96 const char* name = env->GetStringUTFChars(jname, 0);
97 msg_task_t task = MSG_parallel_task_create(name, host_count, hosts, computeDurations, messageSizes, jtask);
98 env->ReleaseStringUTFChars(jname, name);
100 /* associate the java task object and the native task */
101 jtask_bind(jtask, task, env);
104 delete[] computeDurations;
105 delete[] messageSizes;
108 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_cancel(JNIEnv * env, jobject jtask)
110 msg_task_t ptask = jtask_to_native(jtask, env);
113 jxbt_throw_notbound(env, "task", jtask);
117 msg_error_t rv = MSG_task_cancel(ptask);
119 jxbt_check_res("MSG_task_cancel()", rv, MSG_OK, "unexpected error , please report this bug");
122 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_execute(JNIEnv * env, jobject jtask)
124 msg_task_t task = jtask_to_native(jtask, env);
127 jxbt_throw_notbound(env, "task", jtask);
131 if (not simgrid::ForcefulKillException::try_n_catch([&rv, &task]() { rv = MSG_task_execute(task); })) {
132 jxbt_throw_by_name(env, "org/simgrid/msg/ProcessKilledError", "Process killed");
135 if (env->ExceptionOccurred())
138 jmsg_throw_status(env, rv);
142 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_setBound(JNIEnv * env, jobject jtask, jdouble bound)
144 msg_task_t task = jtask_to_native(jtask, env);
147 jxbt_throw_notbound(env, "task", jtask);
150 MSG_task_set_bound(task, bound);
153 JNIEXPORT jstring JNICALL Java_org_simgrid_msg_Task_getName(JNIEnv * env, jobject jtask) {
154 const_msg_task_t task = jtask_to_native(jtask, env);
157 jxbt_throw_notbound(env, "task", jtask);
161 return env->NewStringUTF(MSG_task_get_name(task));
164 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_getSender(JNIEnv * env, jobject jtask) {
165 const_msg_task_t task = jtask_to_native(jtask, env);
168 jxbt_throw_notbound(env, "task", jtask);
172 auto const* process = MSG_task_get_sender(task);
173 if (process == nullptr) {
176 return (jobject)jprocess_from_native(process);
179 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_getSource(JNIEnv * env, jobject jtask)
181 const_msg_task_t task = jtask_to_native(jtask, env);
184 jxbt_throw_notbound(env, "task", jtask);
188 auto const* host = MSG_task_get_source(task);
189 if (host == nullptr) {
192 if (not host->extension(JAVA_HOST_LEVEL)) {
193 jxbt_throw_jni(env, "MSG_task_get_source() failed");
197 return (jobject) host->extension(JAVA_HOST_LEVEL);
200 JNIEXPORT jdouble JNICALL Java_org_simgrid_msg_Task_getFlopsAmount(JNIEnv * env, jobject jtask)
202 const_msg_task_t ptask = jtask_to_native(jtask, env);
205 jxbt_throw_notbound(env, "task", jtask);
208 return (jdouble)MSG_task_get_flops_amount(ptask);
211 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_setName(JNIEnv *env, jobject jtask, jobject jname) {
212 msg_task_t task = jtask_to_native(jtask, env);
215 jxbt_throw_notbound(env, "task", jtask);
218 const char *name = env->GetStringUTFChars((jstring) jname, 0);
220 env->SetObjectField(jtask, jtask_field_Task_name, jname);
221 MSG_task_set_name(task, name);
223 env->ReleaseStringUTFChars((jstring) jname, name);
226 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_setPriority(JNIEnv * env, jobject jtask, jdouble priority)
228 msg_task_t task = jtask_to_native(jtask, env);
231 jxbt_throw_notbound(env, "task", jtask);
234 MSG_task_set_priority(task, priority);
237 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_setFlopsAmount (JNIEnv *env, jobject jtask, jdouble computationAmount)
239 msg_task_t task = jtask_to_native(jtask, env);
242 jxbt_throw_notbound(env, "task", jtask);
245 MSG_task_set_flops_amount(task, computationAmount);
248 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_setBytesAmount (JNIEnv *env, jobject jtask, jdouble dataSize)
250 msg_task_t task = jtask_to_native(jtask, env);
253 jxbt_throw_notbound(env, "task", jtask);
256 env->SetDoubleField(jtask, jtask_field_Task_messageSize, dataSize);
257 MSG_task_set_bytes_amount(task, dataSize);
260 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_sendBounded(JNIEnv * env,jobject jtask, jstring jalias,
261 jdouble jtimeout,jdouble maxrate)
263 msg_task_t task = jtask_to_native(jtask, env);
265 jxbt_throw_notbound(env, "task", jtask);
269 /* Add a global ref into the Ctask so that the receiver can use it */
270 MSG_task_set_data(task, (void *) env->NewGlobalRef(jtask));
272 const char* alias = env->GetStringUTFChars(jalias, 0);
273 msg_error_t res = MSG_task_send_with_timeout_bounded(task, alias, jtimeout, maxrate);
274 env->ReleaseStringUTFChars(jalias, alias);
277 jmsg_throw_status(env, res);
280 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_receive(JNIEnv* env, jclass cls, jstring jalias, jdouble jtimeout)
282 msg_task_t task = nullptr;
284 const char *alias = env->GetStringUTFChars(jalias, 0);
286 if (not simgrid::ForcefulKillException::try_n_catch(
287 [&rv, &task, &alias, &jtimeout]() { rv = MSG_task_receive_with_timeout(&task, alias, (double)jtimeout); })) {
288 jxbt_throw_by_name(env, "org/simgrid/msg/ProcessKilledError", "Process killed");
290 env->ReleaseStringUTFChars(jalias, alias);
291 if (env->ExceptionOccurred())
294 jmsg_throw_status(env, rv);
297 jobject jtask_global = (jobject) MSG_task_get_data(task);
299 /* Convert the global ref into a local ref so that the JVM can free the stuff */
300 jobject jtask_local = env->NewLocalRef(jtask_global);
301 env->DeleteGlobalRef(jtask_global);
302 MSG_task_set_data(task, nullptr);
304 return (jobject) jtask_local;
307 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_irecv(JNIEnv * env, jclass cls, jstring jmailbox) {
308 jclass comm_class = env->FindClass("org/simgrid/msg/Comm");
312 //pointer to store the task object pointer.
313 msg_task_t* task = new msg_task_t(nullptr);
314 /* There should be a cache here */
316 jobject jcomm = env->NewObject(comm_class, jtask_method_Comm_constructor);
318 jxbt_throw_jni(env, "Can't create a Comm object.");
322 const char* mailbox = env->GetStringUTFChars(jmailbox, 0);
323 msg_comm_t comm = MSG_task_irecv(task, mailbox);
324 env->ReleaseStringUTFChars(jmailbox, mailbox);
326 env->SetLongField(jcomm, jtask_field_Comm_bind, (jlong) (uintptr_t)(comm));
327 env->SetLongField(jcomm, jtask_field_Comm_taskBind, (jlong) (uintptr_t)(task));
328 env->SetBooleanField(jcomm, jtask_field_Comm_receiving, JNI_TRUE);
333 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_receiveBounded(JNIEnv* env, jclass cls, jstring jalias,
334 jdouble jtimeout, jdouble rate)
336 msg_task_t task = nullptr;
338 const char *alias = env->GetStringUTFChars(jalias, 0);
339 msg_error_t res = MSG_task_receive_with_timeout_bounded(&task, alias, jtimeout, rate);
340 if (env->ExceptionOccurred())
343 jmsg_throw_status(env, res);
346 jobject jtask_global = (jobject)MSG_task_get_data(task);
348 /* Convert the global ref into a local ref so that the JVM can free the stuff */
349 jobject jtask_local = env->NewLocalRef(jtask_global);
350 env->DeleteGlobalRef(jtask_global);
351 MSG_task_set_data(task, nullptr);
353 env->ReleaseStringUTFChars(jalias, alias);
355 return (jobject) jtask_local;
358 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_irecvBounded(JNIEnv * env, jclass cls, jstring jmailbox,
361 jclass comm_class = env->FindClass("org/simgrid/msg/Comm");
365 // pointer to store the task object pointer.
366 msg_task_t* task = new msg_task_t(nullptr);
368 jobject jcomm = env->NewObject(comm_class, jtask_method_Comm_constructor);
370 jxbt_throw_jni(env, "Can't create a Comm object.");
374 const char* mailbox = env->GetStringUTFChars(jmailbox, 0);
375 msg_comm_t comm = MSG_task_irecv_bounded(task, mailbox, rate);
376 env->ReleaseStringUTFChars(jmailbox, mailbox);
378 env->SetLongField(jcomm, jtask_field_Comm_bind, (jlong) (uintptr_t)(comm));
379 env->SetLongField(jcomm, jtask_field_Comm_taskBind, (jlong) (uintptr_t)(task));
380 env->SetBooleanField(jcomm, jtask_field_Comm_receiving, JNI_TRUE);
385 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_isend(JNIEnv *env, jobject jtask, jstring jmailbox)
389 jclass comm_class = env->FindClass("org/simgrid/msg/Comm");
394 jobject jcomm = env->NewObject(comm_class, jtask_method_Comm_constructor);
395 const char* mailbox = env->GetStringUTFChars(jmailbox, 0);
397 msg_task_t task = jtask_to_native(jtask, env);
400 env->ReleaseStringUTFChars(jmailbox, mailbox);
401 env->DeleteLocalRef(jcomm);
402 jxbt_throw_notbound(env, "task", jtask);
406 MSG_task_set_data(task, (void *) env->NewGlobalRef(jtask));
407 comm = MSG_task_isend(task,mailbox);
409 env->SetLongField(jcomm, jtask_field_Comm_bind, (jlong) (uintptr_t)(comm));
410 env->SetLongField(jcomm, jtask_field_Comm_taskBind, (jlong) (uintptr_t)(nullptr));
411 env->SetBooleanField(jcomm, jtask_field_Comm_receiving, JNI_FALSE);
413 env->ReleaseStringUTFChars(jmailbox, mailbox);
418 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_isendBounded(JNIEnv *env, jobject jtask, jstring jmailbox,
426 jclass comm_class = env->FindClass("org/simgrid/msg/Comm");
430 jcomm = env->NewObject(comm_class, jtask_method_Comm_constructor);
431 mailbox = env->GetStringUTFChars(jmailbox, 0);
433 task = jtask_to_native(jtask, env);
436 env->ReleaseStringUTFChars(jmailbox, mailbox);
437 env->DeleteLocalRef(jcomm);
438 jxbt_throw_notbound(env, "task", jtask);
442 MSG_task_set_data(task, (void *) env->NewGlobalRef(jtask));
443 comm = MSG_task_isend_bounded(task,mailbox,maxrate);
445 env->SetLongField(jcomm, jtask_field_Comm_bind, (jlong) (uintptr_t)(comm));
446 env->SetLongField(jcomm, jtask_field_Comm_taskBind, (jlong) (uintptr_t)(nullptr));
447 env->SetBooleanField(jcomm, jtask_field_Comm_receiving, JNI_FALSE);
449 env->ReleaseStringUTFChars(jmailbox, mailbox);
454 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_nativeFinalize(JNIEnv * env, jobject jtask)
456 msg_task_t task = jtask_to_native(jtask, env);
459 jxbt_throw_notbound(env, "task", jtask);
463 MSG_task_destroy(task);
466 static void msg_task_cancel_on_failed_dsend(void*t) {
467 msg_task_t task = (msg_task_t) t;
468 JNIEnv* env = get_current_thread_env();
470 jobject jtask_global = (jobject)MSG_task_get_data(task);
471 /* Destroy the global ref so that the JVM can free the stuff */
472 env->DeleteGlobalRef(jtask_global);
473 /* Don't free the C data here, to avoid a race condition with the GC also sometimes doing so.
474 * A rare memleak is seen as preferable to a rare "free(): invalid pointer" failure that
475 * proves really hard to debug.
478 MSG_task_set_data(task, nullptr);
481 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_dsend(JNIEnv * env, jobject jtask, jstring jalias)
483 const char *alias = env->GetStringUTFChars(jalias, 0);
485 msg_task_t task = jtask_to_native(jtask, env);
488 env->ReleaseStringUTFChars(jalias, alias);
489 jxbt_throw_notbound(env, "task", jtask);
493 /* Pass a global ref to the Jtask into the Ctask so that the receiver can use it */
494 MSG_task_set_data(task, (void *) env->NewGlobalRef(jtask));
495 MSG_task_dsend(task, alias, msg_task_cancel_on_failed_dsend);
497 env->ReleaseStringUTFChars(jalias, alias);
500 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_dsendBounded(JNIEnv * env, jobject jtask, jstring jalias,
503 const char *alias = env->GetStringUTFChars(jalias, 0);
505 msg_task_t task = jtask_to_native(jtask, env);
508 env->ReleaseStringUTFChars(jalias, alias);
509 jxbt_throw_notbound(env, "task", jtask);
513 /* Pass a global ref to the Jtask into the Ctask so that the receiver can use it */
514 MSG_task_set_data(task, (void *) env->NewGlobalRef(jtask));
515 MSG_task_dsend_bounded(task, alias, msg_task_cancel_on_failed_dsend, maxrate);
517 env->ReleaseStringUTFChars(jalias, alias);
520 JNIEXPORT jboolean JNICALL Java_org_simgrid_msg_Task_listen(JNIEnv * env, jclass cls, jstring jalias)
522 const char *alias = env->GetStringUTFChars(jalias, 0);
523 int rv = MSG_task_listen(alias);
524 env->ReleaseStringUTFChars(jalias, alias);
526 return (jboolean) rv;
529 JNIEXPORT jint JNICALL Java_org_simgrid_msg_Task_listenFrom(JNIEnv * env, jclass cls, jstring jalias)
531 const char *alias = env->GetStringUTFChars(jalias, 0);
532 int rv = MSG_task_listen_from(alias);
533 env->ReleaseStringUTFChars(jalias, alias);