src/bindings/java/jmsg_task.cpp

   1 /* Functions related to the java task instances.                            */
   2
   3 /* Copyright (c) 2007-2022. 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 "simgrid/Exception.hpp"
   9 #include "simgrid/s4u/Host.hpp"
  10 #include "src/kernel/context/Context.hpp"
  11
  12 #include "jmsg.hpp"
  13 #include "jmsg_host.h"
  14 #include "jmsg_process.h"
  15 #include "jmsg_task.h"
  16 #include "jxbt_utilities.hpp"
  17
  18 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(java);
  19
  20 static jmethodID jtask_method_Comm_constructor;
  21
  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;
  28
  29 void jtask_bind(jobject jtask, msg_task_t task, JNIEnv * env)
  30 {
  31   env->SetLongField(jtask, jtask_field_Task_bind, (intptr_t)task);
  32 }
  33
  34 msg_task_t jtask_to_native(jobject jtask, JNIEnv* env)
  35 {
  36   return (msg_task_t)(intptr_t)env->GetLongField(jtask, jtask_field_Task_bind);
  37 }
  38
  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");
  44
  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");
  55 }
  56
  57 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_create(JNIEnv * env, jobject jtask, jstring jname,
  58                                       jdouble jflopsAmount, jdouble jbytesAmount)
  59 {
  60   jstring_wrapper task_name(env, jname);
  61   msg_task_t task = MSG_task_create(task_name, jflopsAmount, jbytesAmount, jtask);
  62
  63   /* bind & store the task */
  64   jtask_bind(jtask, task, env);
  65 }
  66
  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)
  70 {
  71   int host_count = env->GetArrayLength(jhosts);
  72
  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];
  80   }
  81   env->ReleaseDoubleArrayElements(jcomputeDurations_arg, jcomputeDurations, 0);
  82
  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];
  87   }
  88   env->ReleaseDoubleArrayElements(jmessageSizes_arg, jmessageSizes, 0);
  89
  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);
  93
  94   /* associate the java task object and the native task */
  95   jtask_bind(jtask, task, env);
  96
  97   delete[] hosts;
  98   delete[] computeDurations;
  99   delete[] messageSizes;
 100 }
 101
 102 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_cancel(JNIEnv * env, jobject jtask)
 103 {
 104   msg_task_t ptask = jtask_to_native(jtask, env);
 105
 106   if (not ptask) {
 107     jxbt_throw_notbound(env, "task", jtask);
 108     return;
 109   }
 110
 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);
 113 }
 114
 115 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_execute(JNIEnv * env, jobject jtask)
 116 {
 117   msg_task_t task = jtask_to_native(jtask, env);
 118
 119   if (not task) {
 120     jxbt_throw_notbound(env, "task", jtask);
 121     return;
 122   }
 123   msg_error_t rv;
 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");
 126   }
 127
 128   if (env->ExceptionOccurred())
 129     return;
 130   if (rv != MSG_OK) {
 131     jmsg_throw_status(env, rv);
 132   }
 133 }
 134
 135 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_setBound(JNIEnv * env, jobject jtask, jdouble bound)
 136 {
 137   msg_task_t task = jtask_to_native(jtask, env);
 138
 139   if (not task) {
 140     jxbt_throw_notbound(env, "task", jtask);
 141     return;
 142   }
 143   MSG_task_set_bound(task, bound);
 144 }
 145
 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);
 148
 149   if (not task) {
 150     jxbt_throw_notbound(env, "task", jtask);
 151     return nullptr;
 152   }
 153
 154   return env->NewStringUTF(MSG_task_get_name(task));
 155 }
 156
 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);
 159
 160   if (not task) {
 161     jxbt_throw_notbound(env, "task", jtask);
 162     return nullptr;
 163   }
 164
 165   auto const* process = MSG_task_get_sender(task);
 166   if (process == nullptr) {
 167     return nullptr;
 168   }
 169   return (jobject)jprocess_from_native(process);
 170 }
 171
 172 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_getSource(JNIEnv * env, jobject jtask)
 173 {
 174   const_msg_task_t task = jtask_to_native(jtask, env);
 175
 176   if (not task) {
 177     jxbt_throw_notbound(env, "task", jtask);
 178     return nullptr;
 179   }
 180
 181   auto const* host = MSG_task_get_source(task);
 182   if (host == nullptr) {
 183     return nullptr;
 184   }
 185   if (not host->extension(JAVA_HOST_LEVEL)) {
 186     jxbt_throw_jni(env, "MSG_task_get_source() failed");
 187     return nullptr;
 188   }
 189
 190   return (jobject) host->extension(JAVA_HOST_LEVEL);
 191 }
 192
 193 JNIEXPORT jdouble JNICALL Java_org_simgrid_msg_Task_getFlopsAmount(JNIEnv * env, jobject jtask)
 194 {
 195   const_msg_task_t ptask = jtask_to_native(jtask, env);
 196
 197   if (not ptask) {
 198     jxbt_throw_notbound(env, "task", jtask);
 199     return -1;
 200   }
 201   return (jdouble)MSG_task_get_flops_amount(ptask);
 202 }
 203
 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);
 206
 207   if (not task) {
 208     jxbt_throw_notbound(env, "task", jtask);
 209     return;
 210   }
 211   jstring_wrapper name(env, static_cast<jstring>(jname));
 212
 213   env->SetObjectField(jtask, jtask_field_Task_name, jname);
 214   MSG_task_set_name(task, name);
 215 }
 216
 217 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_setPriority(JNIEnv * env, jobject jtask, jdouble priority)
 218 {
 219   msg_task_t task = jtask_to_native(jtask, env);
 220
 221   if (not task) {
 222     jxbt_throw_notbound(env, "task", jtask);
 223     return;
 224   }
 225   MSG_task_set_priority(task, priority);
 226 }
 227
 228 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_setFlopsAmount (JNIEnv *env, jobject jtask, jdouble computationAmount)
 229 {
 230   msg_task_t task = jtask_to_native(jtask, env);
 231
 232   if (not task) {
 233     jxbt_throw_notbound(env, "task", jtask);
 234     return;
 235   }
 236   MSG_task_set_flops_amount(task, computationAmount);
 237 }
 238
 239 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_setBytesAmount (JNIEnv *env, jobject jtask, jdouble dataSize)
 240 {
 241   msg_task_t task = jtask_to_native(jtask, env);
 242
 243   if (not task) {
 244     jxbt_throw_notbound(env, "task", jtask);
 245     return;
 246   }
 247   env->SetDoubleField(jtask, jtask_field_Task_messageSize, dataSize);
 248   MSG_task_set_bytes_amount(task, dataSize);
 249 }
 250
 251 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_sendBounded(JNIEnv * env,jobject jtask, jstring jalias,
 252                                                              jdouble jtimeout,jdouble maxrate)
 253 {
 254   msg_task_t task = jtask_to_native(jtask, env);
 255   if (not task) {
 256     jxbt_throw_notbound(env, "task", jtask);
 257     return;
 258   }
 259
 260   /* Add a global ref into the Ctask so that the receiver can use it */
 261   MSG_task_set_data(task, env->NewGlobalRef(jtask));
 262
 263   jstring_wrapper alias(env, jalias);
 264   msg_error_t res   = MSG_task_send_with_timeout_bounded(task, alias, jtimeout, maxrate);
 265
 266   if (res != MSG_OK)
 267     jmsg_throw_status(env, res);
 268 }
 269
 270 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_receive(JNIEnv* env, jclass cls, jstring jalias, jdouble jtimeout)
 271 {
 272   msg_task_t task = nullptr;
 273
 274   jstring_wrapper alias(env, jalias);
 275   msg_error_t rv;
 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");
 279   }
 280   if (env->ExceptionOccurred())
 281     return nullptr;
 282   if (rv != MSG_OK) {
 283     jmsg_throw_status(env, rv);
 284     return nullptr;
 285   }
 286   auto jtask_global = (jobject)MSG_task_get_data(task);
 287
 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);
 292
 293   return (jobject) jtask_local;
 294 }
 295
 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");
 298   if (not comm_class)
 299     return nullptr;
 300
 301   //pointer to store the task object pointer.
 302   auto* task = new msg_task_t(nullptr);
 303   /* There should be a cache here */
 304
 305   jobject jcomm = env->NewObject(comm_class, jtask_method_Comm_constructor);
 306   if (not jcomm) {
 307     jxbt_throw_jni(env, "Can't create a Comm object.");
 308     return nullptr;
 309   }
 310
 311   jstring_wrapper mailbox(env, jmailbox);
 312   msg_comm_t comm     = MSG_task_irecv(task, mailbox);
 313
 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);
 317
 318   return jcomm;
 319 }
 320
 321 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_receiveBounded(JNIEnv* env, jclass cls, jstring jalias,
 322                                                                    jdouble jtimeout, jdouble rate)
 323 {
 324   msg_task_t task = nullptr;
 325
 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())
 329     return nullptr;
 330   if (res != MSG_OK) {
 331     jmsg_throw_status(env, res);
 332     return nullptr;
 333   }
 334   auto jtask_global = (jobject)MSG_task_get_data(task);
 335
 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);
 340
 341   return (jobject) jtask_local;
 342 }
 343
 344 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_irecvBounded(JNIEnv * env, jclass cls, jstring jmailbox,
 345                                                                  jdouble rate)
 346 {
 347   jclass comm_class = env->FindClass("org/simgrid/msg/Comm");
 348   if (not comm_class)
 349     return nullptr;
 350
 351   // pointer to store the task object pointer.
 352   auto* task = new msg_task_t(nullptr);
 353
 354   jobject jcomm = env->NewObject(comm_class, jtask_method_Comm_constructor);
 355   if (not jcomm) {
 356     jxbt_throw_jni(env, "Can't create a Comm object.");
 357     return nullptr;
 358   }
 359
 360   jstring_wrapper mailbox(env, jmailbox);
 361   msg_comm_t comm     = MSG_task_irecv_bounded(task, mailbox, rate);
 362
 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);
 366
 367   return jcomm;
 368 }
 369
 370 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_isend(JNIEnv *env, jobject jtask, jstring jmailbox)
 371 {
 372   msg_comm_t comm;
 373
 374   jclass comm_class = env->FindClass("org/simgrid/msg/Comm");
 375
 376   if (not comm_class)
 377     return nullptr;
 378
 379   jobject jcomm       = env->NewObject(comm_class, jtask_method_Comm_constructor);
 380   jstring_wrapper mailbox(env, jmailbox);
 381
 382   msg_task_t task = jtask_to_native(jtask, env);
 383
 384   if (not task) {
 385     env->DeleteLocalRef(jcomm);
 386     jxbt_throw_notbound(env, "task", jtask);
 387         return nullptr;
 388   }
 389
 390   MSG_task_set_data(task, env->NewGlobalRef(jtask));
 391   comm = MSG_task_isend(task,mailbox);
 392
 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);
 396
 397   return jcomm;
 398 }
 399
 400 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_isendBounded(JNIEnv *env, jobject jtask, jstring jmailbox,
 401                                                                  jdouble maxrate)
 402 {
 403   msg_task_t task;
 404   jobject jcomm;
 405   msg_comm_t comm;
 406
 407   jclass comm_class = env->FindClass("org/simgrid/msg/Comm");
 408   if (not comm_class)
 409     return nullptr;
 410
 411   jcomm = env->NewObject(comm_class, jtask_method_Comm_constructor);
 412   jstring_wrapper mailbox(env, jmailbox);
 413
 414   task = jtask_to_native(jtask, env);
 415
 416   if (not task) {
 417     env->DeleteLocalRef(jcomm);
 418     jxbt_throw_notbound(env, "task", jtask);
 419         return nullptr;
 420   }
 421
 422   MSG_task_set_data(task, env->NewGlobalRef(jtask));
 423   comm = MSG_task_isend_bounded(task,mailbox,maxrate);
 424
 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);
 428
 429   return jcomm;
 430 }
 431
 432 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_nativeFinalize(JNIEnv * env, jobject jtask)
 433 {
 434   msg_task_t task = jtask_to_native(jtask, env);
 435
 436   if (not task) {
 437     jxbt_throw_notbound(env, "task", jtask);
 438     return;
 439     }
 440
 441     MSG_task_destroy(task);
 442 }
 443
 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();
 447   if (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.
 454      */
 455   }
 456   MSG_task_set_data(task, nullptr);
 457 }
 458
 459 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_dsend(JNIEnv * env, jobject jtask, jstring jalias)
 460 {
 461   jstring_wrapper alias(env, jalias);
 462
 463   msg_task_t task = jtask_to_native(jtask, env);
 464
 465   if (not task) {
 466     jxbt_throw_notbound(env, "task", jtask);
 467     return;
 468   }
 469
 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);
 473 }
 474
 475 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_dsendBounded(JNIEnv * env, jobject jtask, jstring jalias,
 476                                                               jdouble maxrate)
 477 {
 478   jstring_wrapper alias(env, jalias);
 479
 480   msg_task_t task = jtask_to_native(jtask, env);
 481
 482   if (not task) {
 483     jxbt_throw_notbound(env, "task", jtask);
 484     return;
 485   }
 486
 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);
 490 }
 491
 492 JNIEXPORT jboolean JNICALL Java_org_simgrid_msg_Task_listen(JNIEnv * env, jclass cls, jstring jalias)
 493 {
 494   jstring_wrapper alias(env, jalias);
 495   return (jboolean)MSG_task_listen(alias);
 496 }
 497
 498 JNIEXPORT jint JNICALL Java_org_simgrid_msg_Task_listenFrom(JNIEnv * env, jclass cls, jstring jalias)
 499 {
 500   jstring_wrapper alias(env, jalias);
 501   return (jint)MSG_task_listen_from(alias);
 502 }