1 /* Functions related to the java task instances. */
3 /* Copyright (c) 2007-2022. 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 jstring_wrapper task_name(env, jname);
61 msg_task_t task = MSG_task_create(task_name, jflopsAmount, jbytesAmount, jtask);
63 /* bind & store the task */
64 jtask_bind(jtask, task, env);
67 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_parallelCreate(JNIEnv * env, jobject jtask, jstring jname,
68 jobjectArray jhosts, jdoubleArray jcomputeDurations_arg,
69 jdoubleArray jmessageSizes_arg)
71 int host_count = env->GetArrayLength(jhosts);
73 jdouble* jcomputeDurations = env->GetDoubleArrayElements(jcomputeDurations_arg, nullptr);
74 auto* hosts = new msg_host_t[host_count];
75 auto* computeDurations = new double[host_count];
76 for (int index = 0; index < host_count; index++) {
77 jobject jhost = env->GetObjectArrayElement(jhosts, index);
78 hosts[index] = jhost_get_native(env, jhost);
79 computeDurations[index] = jcomputeDurations[index];
81 env->ReleaseDoubleArrayElements(jcomputeDurations_arg, jcomputeDurations, 0);
83 jdouble* jmessageSizes = env->GetDoubleArrayElements(jmessageSizes_arg, nullptr);
84 auto* messageSizes = new double[host_count * host_count];
85 for (int index = 0; index < host_count * host_count; index++) {
86 messageSizes[index] = jmessageSizes[index];
88 env->ReleaseDoubleArrayElements(jmessageSizes_arg, jmessageSizes, 0);
90 /* get the C string from the java string */
91 jstring_wrapper name(env, jname);
92 msg_task_t task = MSG_parallel_task_create(name, host_count, hosts, computeDurations, messageSizes, jtask);
94 /* associate the java task object and the native task */
95 jtask_bind(jtask, task, env);
98 delete[] computeDurations;
99 delete[] messageSizes;
102 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_cancel(JNIEnv * env, jobject jtask)
104 msg_task_t ptask = jtask_to_native(jtask, env);
107 jxbt_throw_notbound(env, "task", jtask);
111 msg_error_t rv = MSG_task_cancel(ptask);
112 xbt_assert(rv == MSG_OK, "MSG_task_cancel() unexpectedly failed with error code %d. Please report this bug", rv);
115 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_execute(JNIEnv * env, jobject jtask)
117 msg_task_t task = jtask_to_native(jtask, env);
120 jxbt_throw_notbound(env, "task", jtask);
124 if (not simgrid::ForcefulKillException::try_n_catch([&rv, &task]() { rv = MSG_task_execute(task); })) {
125 jxbt_throw_by_name(env, "org/simgrid/msg/ProcessKilledError", "Process killed");
128 if (env->ExceptionOccurred())
131 jmsg_throw_status(env, rv);
135 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_setBound(JNIEnv * env, jobject jtask, jdouble bound)
137 msg_task_t task = jtask_to_native(jtask, env);
140 jxbt_throw_notbound(env, "task", jtask);
143 MSG_task_set_bound(task, bound);
146 JNIEXPORT jstring JNICALL Java_org_simgrid_msg_Task_getName(JNIEnv * env, jobject jtask) {
147 const_msg_task_t task = jtask_to_native(jtask, env);
150 jxbt_throw_notbound(env, "task", jtask);
154 return env->NewStringUTF(MSG_task_get_name(task));
157 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_getSender(JNIEnv * env, jobject jtask) {
158 const_msg_task_t task = jtask_to_native(jtask, env);
161 jxbt_throw_notbound(env, "task", jtask);
165 auto const* process = MSG_task_get_sender(task);
166 if (process == nullptr) {
169 return (jobject)jprocess_from_native(process);
172 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_getSource(JNIEnv * env, jobject jtask)
174 const_msg_task_t task = jtask_to_native(jtask, env);
177 jxbt_throw_notbound(env, "task", jtask);
181 auto const* host = MSG_task_get_source(task);
182 if (host == nullptr) {
185 if (not host->extension(JAVA_HOST_LEVEL)) {
186 jxbt_throw_jni(env, "MSG_task_get_source() failed");
190 return (jobject) host->extension(JAVA_HOST_LEVEL);
193 JNIEXPORT jdouble JNICALL Java_org_simgrid_msg_Task_getFlopsAmount(JNIEnv * env, jobject jtask)
195 const_msg_task_t ptask = jtask_to_native(jtask, env);
198 jxbt_throw_notbound(env, "task", jtask);
201 return (jdouble)MSG_task_get_flops_amount(ptask);
204 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_setName(JNIEnv *env, jobject jtask, jobject jname) {
205 msg_task_t task = jtask_to_native(jtask, env);
208 jxbt_throw_notbound(env, "task", jtask);
211 jstring_wrapper name(env, static_cast<jstring>(jname));
213 env->SetObjectField(jtask, jtask_field_Task_name, jname);
214 MSG_task_set_name(task, name);
217 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_setPriority(JNIEnv * env, jobject jtask, jdouble priority)
219 msg_task_t task = jtask_to_native(jtask, env);
222 jxbt_throw_notbound(env, "task", jtask);
225 MSG_task_set_priority(task, priority);
228 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_setFlopsAmount (JNIEnv *env, jobject jtask, jdouble computationAmount)
230 msg_task_t task = jtask_to_native(jtask, env);
233 jxbt_throw_notbound(env, "task", jtask);
236 MSG_task_set_flops_amount(task, computationAmount);
239 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_setBytesAmount (JNIEnv *env, jobject jtask, jdouble dataSize)
241 msg_task_t task = jtask_to_native(jtask, env);
244 jxbt_throw_notbound(env, "task", jtask);
247 env->SetDoubleField(jtask, jtask_field_Task_messageSize, dataSize);
248 MSG_task_set_bytes_amount(task, dataSize);
251 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_sendBounded(JNIEnv * env,jobject jtask, jstring jalias,
252 jdouble jtimeout,jdouble maxrate)
254 msg_task_t task = jtask_to_native(jtask, env);
256 jxbt_throw_notbound(env, "task", jtask);
260 /* Add a global ref into the Ctask so that the receiver can use it */
261 MSG_task_set_data(task, env->NewGlobalRef(jtask));
263 jstring_wrapper alias(env, jalias);
264 msg_error_t res = MSG_task_send_with_timeout_bounded(task, alias, jtimeout, maxrate);
267 jmsg_throw_status(env, res);
270 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_receive(JNIEnv* env, jclass cls, jstring jalias, jdouble jtimeout)
272 msg_task_t task = nullptr;
274 jstring_wrapper alias(env, jalias);
276 if (not simgrid::ForcefulKillException::try_n_catch(
277 [&rv, &task, &alias, &jtimeout]() { rv = MSG_task_receive_with_timeout(&task, alias, (double)jtimeout); })) {
278 jxbt_throw_by_name(env, "org/simgrid/msg/ProcessKilledError", "Process killed");
280 if (env->ExceptionOccurred())
283 jmsg_throw_status(env, rv);
286 auto jtask_global = (jobject)MSG_task_get_data(task);
288 /* Convert the global ref into a local ref so that the JVM can free the stuff */
289 jobject jtask_local = env->NewLocalRef(jtask_global);
290 env->DeleteGlobalRef(jtask_global);
291 MSG_task_set_data(task, nullptr);
293 return (jobject) jtask_local;
296 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_irecv(JNIEnv * env, jclass cls, jstring jmailbox) {
297 jclass comm_class = env->FindClass("org/simgrid/msg/Comm");
301 //pointer to store the task object pointer.
302 auto* task = new msg_task_t(nullptr);
303 /* There should be a cache here */
305 jobject jcomm = env->NewObject(comm_class, jtask_method_Comm_constructor);
307 jxbt_throw_jni(env, "Can't create a Comm object.");
311 jstring_wrapper mailbox(env, jmailbox);
312 msg_comm_t comm = MSG_task_irecv(task, mailbox);
314 env->SetLongField(jcomm, jtask_field_Comm_bind, (jlong) (uintptr_t)(comm));
315 env->SetLongField(jcomm, jtask_field_Comm_taskBind, (jlong) (uintptr_t)(task));
316 env->SetBooleanField(jcomm, jtask_field_Comm_receiving, JNI_TRUE);
321 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_receiveBounded(JNIEnv* env, jclass cls, jstring jalias,
322 jdouble jtimeout, jdouble rate)
324 msg_task_t task = nullptr;
326 jstring_wrapper alias(env, jalias);
327 msg_error_t res = MSG_task_receive_with_timeout_bounded(&task, alias, jtimeout, rate);
328 if (env->ExceptionOccurred())
331 jmsg_throw_status(env, res);
334 auto jtask_global = (jobject)MSG_task_get_data(task);
336 /* Convert the global ref into a local ref so that the JVM can free the stuff */
337 jobject jtask_local = env->NewLocalRef(jtask_global);
338 env->DeleteGlobalRef(jtask_global);
339 MSG_task_set_data(task, nullptr);
341 return (jobject) jtask_local;
344 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_irecvBounded(JNIEnv * env, jclass cls, jstring jmailbox,
347 jclass comm_class = env->FindClass("org/simgrid/msg/Comm");
351 // pointer to store the task object pointer.
352 auto* task = new msg_task_t(nullptr);
354 jobject jcomm = env->NewObject(comm_class, jtask_method_Comm_constructor);
356 jxbt_throw_jni(env, "Can't create a Comm object.");
360 jstring_wrapper mailbox(env, jmailbox);
361 msg_comm_t comm = MSG_task_irecv_bounded(task, mailbox, rate);
363 env->SetLongField(jcomm, jtask_field_Comm_bind, (jlong) (uintptr_t)(comm));
364 env->SetLongField(jcomm, jtask_field_Comm_taskBind, (jlong) (uintptr_t)(task));
365 env->SetBooleanField(jcomm, jtask_field_Comm_receiving, JNI_TRUE);
370 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_isend(JNIEnv *env, jobject jtask, jstring jmailbox)
374 jclass comm_class = env->FindClass("org/simgrid/msg/Comm");
379 jobject jcomm = env->NewObject(comm_class, jtask_method_Comm_constructor);
380 jstring_wrapper mailbox(env, jmailbox);
382 msg_task_t task = jtask_to_native(jtask, env);
385 env->DeleteLocalRef(jcomm);
386 jxbt_throw_notbound(env, "task", jtask);
390 MSG_task_set_data(task, env->NewGlobalRef(jtask));
391 comm = MSG_task_isend(task,mailbox);
393 env->SetLongField(jcomm, jtask_field_Comm_bind, (jlong) (uintptr_t)(comm));
394 env->SetLongField(jcomm, jtask_field_Comm_taskBind, (jlong) (uintptr_t)(nullptr));
395 env->SetBooleanField(jcomm, jtask_field_Comm_receiving, JNI_FALSE);
400 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_isendBounded(JNIEnv *env, jobject jtask, jstring jmailbox,
407 jclass comm_class = env->FindClass("org/simgrid/msg/Comm");
411 jcomm = env->NewObject(comm_class, jtask_method_Comm_constructor);
412 jstring_wrapper mailbox(env, jmailbox);
414 task = jtask_to_native(jtask, env);
417 env->DeleteLocalRef(jcomm);
418 jxbt_throw_notbound(env, "task", jtask);
422 MSG_task_set_data(task, env->NewGlobalRef(jtask));
423 comm = MSG_task_isend_bounded(task,mailbox,maxrate);
425 env->SetLongField(jcomm, jtask_field_Comm_bind, (jlong) (uintptr_t)(comm));
426 env->SetLongField(jcomm, jtask_field_Comm_taskBind, (jlong) (uintptr_t)(nullptr));
427 env->SetBooleanField(jcomm, jtask_field_Comm_receiving, JNI_FALSE);
432 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_nativeFinalize(JNIEnv * env, jobject jtask)
434 msg_task_t task = jtask_to_native(jtask, env);
437 jxbt_throw_notbound(env, "task", jtask);
441 MSG_task_destroy(task);
444 static void msg_task_cancel_on_failed_dsend(void*t) {
445 auto task = (msg_task_t)t;
446 JNIEnv* env = get_current_thread_env();
448 auto jtask_global = (jobject)MSG_task_get_data(task);
449 /* Destroy the global ref so that the JVM can free the stuff */
450 env->DeleteGlobalRef(jtask_global);
451 /* Don't free the C data here, to avoid a race condition with the GC also sometimes doing so.
452 * A rare memleak is seen as preferable to a rare "free(): invalid pointer" failure that
453 * proves really hard to debug.
456 MSG_task_set_data(task, nullptr);
459 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_dsend(JNIEnv * env, jobject jtask, jstring jalias)
461 jstring_wrapper alias(env, jalias);
463 msg_task_t task = jtask_to_native(jtask, env);
466 jxbt_throw_notbound(env, "task", jtask);
470 /* Pass a global ref to the Jtask into the Ctask so that the receiver can use it */
471 MSG_task_set_data(task, env->NewGlobalRef(jtask));
472 MSG_task_dsend(task, alias, msg_task_cancel_on_failed_dsend);
475 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_dsendBounded(JNIEnv * env, jobject jtask, jstring jalias,
478 jstring_wrapper alias(env, jalias);
480 msg_task_t task = jtask_to_native(jtask, env);
483 jxbt_throw_notbound(env, "task", jtask);
487 /* Pass a global ref to the Jtask into the Ctask so that the receiver can use it */
488 MSG_task_set_data(task, env->NewGlobalRef(jtask));
489 MSG_task_dsend_bounded(task, alias, msg_task_cancel_on_failed_dsend, maxrate);
492 JNIEXPORT jboolean JNICALL Java_org_simgrid_msg_Task_listen(JNIEnv * env, jclass cls, jstring jalias)
494 jstring_wrapper alias(env, jalias);
495 return (jboolean)MSG_task_listen(alias);
498 JNIEXPORT jint JNICALL Java_org_simgrid_msg_Task_listenFrom(JNIEnv * env, jclass cls, jstring jalias)
500 jstring_wrapper alias(env, jalias);
501 return (jint)MSG_task_listen_from(alias);