1 /* Functions related to the java task instances. */
3 /* Copyright (c) 2007-2021. 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, nullptr);
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, nullptr);
79 auto* hosts = new msg_host_t[host_count];
80 auto* 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, nullptr);
89 auto* 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, nullptr);
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);
118 xbt_assert(rv == MSG_OK, "MSG_task_cancel() unexpectedly failed with error code %d. Please report this bug", rv);
121 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_execute(JNIEnv * env, jobject jtask)
123 msg_task_t task = jtask_to_native(jtask, env);
126 jxbt_throw_notbound(env, "task", jtask);
130 if (not simgrid::ForcefulKillException::try_n_catch([&rv, &task]() { rv = MSG_task_execute(task); })) {
131 jxbt_throw_by_name(env, "org/simgrid/msg/ProcessKilledError", "Process killed");
134 if (env->ExceptionOccurred())
137 jmsg_throw_status(env, rv);
141 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_setBound(JNIEnv * env, jobject jtask, jdouble bound)
143 msg_task_t task = jtask_to_native(jtask, env);
146 jxbt_throw_notbound(env, "task", jtask);
149 MSG_task_set_bound(task, bound);
152 JNIEXPORT jstring JNICALL Java_org_simgrid_msg_Task_getName(JNIEnv * env, jobject jtask) {
153 const_msg_task_t task = jtask_to_native(jtask, env);
156 jxbt_throw_notbound(env, "task", jtask);
160 return env->NewStringUTF(MSG_task_get_name(task));
163 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_getSender(JNIEnv * env, jobject jtask) {
164 const_msg_task_t task = jtask_to_native(jtask, env);
167 jxbt_throw_notbound(env, "task", jtask);
171 auto const* process = MSG_task_get_sender(task);
172 if (process == nullptr) {
175 return (jobject)jprocess_from_native(process);
178 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_getSource(JNIEnv * env, jobject jtask)
180 const_msg_task_t task = jtask_to_native(jtask, env);
183 jxbt_throw_notbound(env, "task", jtask);
187 auto const* host = MSG_task_get_source(task);
188 if (host == nullptr) {
191 if (not host->extension(JAVA_HOST_LEVEL)) {
192 jxbt_throw_jni(env, "MSG_task_get_source() failed");
196 return (jobject) host->extension(JAVA_HOST_LEVEL);
199 JNIEXPORT jdouble JNICALL Java_org_simgrid_msg_Task_getFlopsAmount(JNIEnv * env, jobject jtask)
201 const_msg_task_t ptask = jtask_to_native(jtask, env);
204 jxbt_throw_notbound(env, "task", jtask);
207 return (jdouble)MSG_task_get_flops_amount(ptask);
210 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_setName(JNIEnv *env, jobject jtask, jobject jname) {
211 msg_task_t task = jtask_to_native(jtask, env);
214 jxbt_throw_notbound(env, "task", jtask);
217 const char* name = env->GetStringUTFChars((jstring)jname, nullptr);
219 env->SetObjectField(jtask, jtask_field_Task_name, jname);
220 MSG_task_set_name(task, name);
222 env->ReleaseStringUTFChars((jstring) jname, name);
225 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_setPriority(JNIEnv * env, jobject jtask, jdouble priority)
227 msg_task_t task = jtask_to_native(jtask, env);
230 jxbt_throw_notbound(env, "task", jtask);
233 MSG_task_set_priority(task, priority);
236 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_setFlopsAmount (JNIEnv *env, jobject jtask, jdouble computationAmount)
238 msg_task_t task = jtask_to_native(jtask, env);
241 jxbt_throw_notbound(env, "task", jtask);
244 MSG_task_set_flops_amount(task, computationAmount);
247 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_setBytesAmount (JNIEnv *env, jobject jtask, jdouble dataSize)
249 msg_task_t task = jtask_to_native(jtask, env);
252 jxbt_throw_notbound(env, "task", jtask);
255 env->SetDoubleField(jtask, jtask_field_Task_messageSize, dataSize);
256 MSG_task_set_bytes_amount(task, dataSize);
259 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_sendBounded(JNIEnv * env,jobject jtask, jstring jalias,
260 jdouble jtimeout,jdouble maxrate)
262 msg_task_t task = jtask_to_native(jtask, env);
264 jxbt_throw_notbound(env, "task", jtask);
268 /* Add a global ref into the Ctask so that the receiver can use it */
269 MSG_task_set_data(task, env->NewGlobalRef(jtask));
271 const char* alias = env->GetStringUTFChars(jalias, nullptr);
272 msg_error_t res = MSG_task_send_with_timeout_bounded(task, alias, jtimeout, maxrate);
273 env->ReleaseStringUTFChars(jalias, alias);
276 jmsg_throw_status(env, res);
279 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_receive(JNIEnv* env, jclass cls, jstring jalias, jdouble jtimeout)
281 msg_task_t task = nullptr;
283 const char* alias = env->GetStringUTFChars(jalias, nullptr);
285 if (not simgrid::ForcefulKillException::try_n_catch(
286 [&rv, &task, &alias, &jtimeout]() { rv = MSG_task_receive_with_timeout(&task, alias, (double)jtimeout); })) {
287 jxbt_throw_by_name(env, "org/simgrid/msg/ProcessKilledError", "Process killed");
289 env->ReleaseStringUTFChars(jalias, alias);
290 if (env->ExceptionOccurred())
293 jmsg_throw_status(env, rv);
296 auto jtask_global = (jobject)MSG_task_get_data(task);
298 /* Convert the global ref into a local ref so that the JVM can free the stuff */
299 jobject jtask_local = env->NewLocalRef(jtask_global);
300 env->DeleteGlobalRef(jtask_global);
301 MSG_task_set_data(task, nullptr);
303 return (jobject) jtask_local;
306 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_irecv(JNIEnv * env, jclass cls, jstring jmailbox) {
307 jclass comm_class = env->FindClass("org/simgrid/msg/Comm");
311 //pointer to store the task object pointer.
312 auto* task = new msg_task_t(nullptr);
313 /* There should be a cache here */
315 jobject jcomm = env->NewObject(comm_class, jtask_method_Comm_constructor);
317 jxbt_throw_jni(env, "Can't create a Comm object.");
321 const char* mailbox = env->GetStringUTFChars(jmailbox, nullptr);
322 msg_comm_t comm = MSG_task_irecv(task, mailbox);
323 env->ReleaseStringUTFChars(jmailbox, mailbox);
325 env->SetLongField(jcomm, jtask_field_Comm_bind, (jlong) (uintptr_t)(comm));
326 env->SetLongField(jcomm, jtask_field_Comm_taskBind, (jlong) (uintptr_t)(task));
327 env->SetBooleanField(jcomm, jtask_field_Comm_receiving, JNI_TRUE);
332 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_receiveBounded(JNIEnv* env, jclass cls, jstring jalias,
333 jdouble jtimeout, jdouble rate)
335 msg_task_t task = nullptr;
337 const char* alias = env->GetStringUTFChars(jalias, nullptr);
338 msg_error_t res = MSG_task_receive_with_timeout_bounded(&task, alias, jtimeout, rate);
339 if (env->ExceptionOccurred())
342 jmsg_throw_status(env, res);
345 auto jtask_global = (jobject)MSG_task_get_data(task);
347 /* Convert the global ref into a local ref so that the JVM can free the stuff */
348 jobject jtask_local = env->NewLocalRef(jtask_global);
349 env->DeleteGlobalRef(jtask_global);
350 MSG_task_set_data(task, nullptr);
352 env->ReleaseStringUTFChars(jalias, alias);
354 return (jobject) jtask_local;
357 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_irecvBounded(JNIEnv * env, jclass cls, jstring jmailbox,
360 jclass comm_class = env->FindClass("org/simgrid/msg/Comm");
364 // pointer to store the task object pointer.
365 auto* task = new msg_task_t(nullptr);
367 jobject jcomm = env->NewObject(comm_class, jtask_method_Comm_constructor);
369 jxbt_throw_jni(env, "Can't create a Comm object.");
373 const char* mailbox = env->GetStringUTFChars(jmailbox, nullptr);
374 msg_comm_t comm = MSG_task_irecv_bounded(task, mailbox, rate);
375 env->ReleaseStringUTFChars(jmailbox, mailbox);
377 env->SetLongField(jcomm, jtask_field_Comm_bind, (jlong) (uintptr_t)(comm));
378 env->SetLongField(jcomm, jtask_field_Comm_taskBind, (jlong) (uintptr_t)(task));
379 env->SetBooleanField(jcomm, jtask_field_Comm_receiving, JNI_TRUE);
384 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_isend(JNIEnv *env, jobject jtask, jstring jmailbox)
388 jclass comm_class = env->FindClass("org/simgrid/msg/Comm");
393 jobject jcomm = env->NewObject(comm_class, jtask_method_Comm_constructor);
394 const char* mailbox = env->GetStringUTFChars(jmailbox, nullptr);
396 msg_task_t task = jtask_to_native(jtask, env);
399 env->ReleaseStringUTFChars(jmailbox, mailbox);
400 env->DeleteLocalRef(jcomm);
401 jxbt_throw_notbound(env, "task", jtask);
405 MSG_task_set_data(task, env->NewGlobalRef(jtask));
406 comm = MSG_task_isend(task,mailbox);
408 env->SetLongField(jcomm, jtask_field_Comm_bind, (jlong) (uintptr_t)(comm));
409 env->SetLongField(jcomm, jtask_field_Comm_taskBind, (jlong) (uintptr_t)(nullptr));
410 env->SetBooleanField(jcomm, jtask_field_Comm_receiving, JNI_FALSE);
412 env->ReleaseStringUTFChars(jmailbox, mailbox);
417 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_isendBounded(JNIEnv *env, jobject jtask, jstring jmailbox,
425 jclass comm_class = env->FindClass("org/simgrid/msg/Comm");
429 jcomm = env->NewObject(comm_class, jtask_method_Comm_constructor);
430 mailbox = env->GetStringUTFChars(jmailbox, nullptr);
432 task = jtask_to_native(jtask, env);
435 env->ReleaseStringUTFChars(jmailbox, mailbox);
436 env->DeleteLocalRef(jcomm);
437 jxbt_throw_notbound(env, "task", jtask);
441 MSG_task_set_data(task, env->NewGlobalRef(jtask));
442 comm = MSG_task_isend_bounded(task,mailbox,maxrate);
444 env->SetLongField(jcomm, jtask_field_Comm_bind, (jlong) (uintptr_t)(comm));
445 env->SetLongField(jcomm, jtask_field_Comm_taskBind, (jlong) (uintptr_t)(nullptr));
446 env->SetBooleanField(jcomm, jtask_field_Comm_receiving, JNI_FALSE);
448 env->ReleaseStringUTFChars(jmailbox, mailbox);
453 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_nativeFinalize(JNIEnv * env, jobject jtask)
455 msg_task_t task = jtask_to_native(jtask, env);
458 jxbt_throw_notbound(env, "task", jtask);
462 MSG_task_destroy(task);
465 static void msg_task_cancel_on_failed_dsend(void*t) {
466 auto task = (msg_task_t)t;
467 JNIEnv* env = get_current_thread_env();
469 auto jtask_global = (jobject)MSG_task_get_data(task);
470 /* Destroy the global ref so that the JVM can free the stuff */
471 env->DeleteGlobalRef(jtask_global);
472 /* Don't free the C data here, to avoid a race condition with the GC also sometimes doing so.
473 * A rare memleak is seen as preferable to a rare "free(): invalid pointer" failure that
474 * proves really hard to debug.
477 MSG_task_set_data(task, nullptr);
480 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_dsend(JNIEnv * env, jobject jtask, jstring jalias)
482 const char* alias = env->GetStringUTFChars(jalias, nullptr);
484 msg_task_t task = jtask_to_native(jtask, env);
487 env->ReleaseStringUTFChars(jalias, alias);
488 jxbt_throw_notbound(env, "task", jtask);
492 /* Pass a global ref to the Jtask into the Ctask so that the receiver can use it */
493 MSG_task_set_data(task, env->NewGlobalRef(jtask));
494 MSG_task_dsend(task, alias, msg_task_cancel_on_failed_dsend);
496 env->ReleaseStringUTFChars(jalias, alias);
499 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_dsendBounded(JNIEnv * env, jobject jtask, jstring jalias,
502 const char* alias = env->GetStringUTFChars(jalias, nullptr);
504 msg_task_t task = jtask_to_native(jtask, env);
507 env->ReleaseStringUTFChars(jalias, alias);
508 jxbt_throw_notbound(env, "task", jtask);
512 /* Pass a global ref to the Jtask into the Ctask so that the receiver can use it */
513 MSG_task_set_data(task, env->NewGlobalRef(jtask));
514 MSG_task_dsend_bounded(task, alias, msg_task_cancel_on_failed_dsend, maxrate);
516 env->ReleaseStringUTFChars(jalias, alias);
519 JNIEXPORT jboolean JNICALL Java_org_simgrid_msg_Task_listen(JNIEnv * env, jclass cls, jstring jalias)
521 const char* alias = env->GetStringUTFChars(jalias, nullptr);
522 int rv = MSG_task_listen(alias);
523 env->ReleaseStringUTFChars(jalias, alias);
525 return (jboolean) rv;
528 JNIEXPORT jint JNICALL Java_org_simgrid_msg_Task_listenFrom(JNIEnv * env, jclass cls, jstring jalias)
530 const char* alias = env->GetStringUTFChars(jalias, nullptr);
531 int rv = MSG_task_listen_from(alias);
532 env->ReleaseStringUTFChars(jalias, alias);