src/bindings/java/jmsg_task.cpp

   1 /* Functions related to the java task instances.                            */
   2
   3 /* Copyright (c) 2007-2019. 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   const char *name = nullptr;      /* the name of the task                                 */
  61
  62   if (jname)
  63     name = env->GetStringUTFChars(jname, 0);
  64   msg_task_t task = MSG_task_create(name, jflopsAmount, jbytesAmount, jtask);
  65   if (jname)
  66     env->ReleaseStringUTFChars(jname, name);
  67
  68   /* bind & store the task */
  69   jtask_bind(jtask, task, env);
  70 }
  71
  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)
  75 {
  76   int host_count = env->GetArrayLength(jhosts);
  77
  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];
  85   }
  86   env->ReleaseDoubleArrayElements(jcomputeDurations_arg, jcomputeDurations, 0);
  87
  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];
  92   }
  93   env->ReleaseDoubleArrayElements(jmessageSizes_arg, jmessageSizes, 0);
  94
  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);
  99
 100   /* associate the java task object and the native task */
 101   jtask_bind(jtask, task, env);
 102
 103   delete[] hosts;
 104   delete[] computeDurations;
 105   delete[] messageSizes;
 106 }
 107
 108 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_cancel(JNIEnv * env, jobject jtask)
 109 {
 110   msg_task_t ptask = jtask_to_native(jtask, env);
 111
 112   if (not ptask) {
 113     jxbt_throw_notbound(env, "task", jtask);
 114     return;
 115   }
 116
 117   msg_error_t rv = MSG_task_cancel(ptask);
 118
 119   jxbt_check_res("MSG_task_cancel()", rv, MSG_OK, "unexpected error , please report this bug");
 120 }
 121
 122 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_execute(JNIEnv * env, jobject jtask)
 123 {
 124   msg_task_t task = jtask_to_native(jtask, env);
 125
 126   if (not task) {
 127     jxbt_throw_notbound(env, "task", jtask);
 128     return;
 129   }
 130   msg_error_t rv;
 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");
 133   }
 134
 135   if (env->ExceptionOccurred())
 136     return;
 137   if (rv != MSG_OK) {
 138     jmsg_throw_status(env, rv);
 139   }
 140 }
 141
 142 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_setBound(JNIEnv * env, jobject jtask, jdouble bound)
 143 {
 144   msg_task_t task = jtask_to_native(jtask, env);
 145
 146   if (not task) {
 147     jxbt_throw_notbound(env, "task", jtask);
 148     return;
 149   }
 150   MSG_task_set_bound(task, bound);
 151 }
 152
 153 JNIEXPORT jstring JNICALL Java_org_simgrid_msg_Task_getName(JNIEnv * env, jobject jtask) {
 154   msg_task_t task = jtask_to_native(jtask, env);
 155
 156   if (not task) {
 157     jxbt_throw_notbound(env, "task", jtask);
 158     return nullptr;
 159   }
 160
 161   return env->NewStringUTF(MSG_task_get_name(task));
 162 }
 163
 164 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_getSender(JNIEnv * env, jobject jtask) {
 165   msg_process_t process;
 166
 167   msg_task_t task = jtask_to_native(jtask, env);
 168
 169   if (not task) {
 170     jxbt_throw_notbound(env, "task", jtask);
 171     return nullptr;
 172   }
 173
 174   process = MSG_task_get_sender(task);
 175   if (process == nullptr) {
 176     return nullptr;
 177   }
 178   return (jobject)jprocess_from_native(process);
 179 }
 180
 181 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_getSource(JNIEnv * env, jobject jtask)
 182 {
 183   msg_task_t task = jtask_to_native(jtask, env);
 184
 185   if (not task) {
 186     jxbt_throw_notbound(env, "task", jtask);
 187     return nullptr;
 188   }
 189
 190   auto const* host = MSG_task_get_source(task);
 191   if (host == nullptr) {
 192     return nullptr;
 193   }
 194   if (not host->extension(JAVA_HOST_LEVEL)) {
 195     jxbt_throw_jni(env, "MSG_task_get_source() failed");
 196     return nullptr;
 197   }
 198
 199   return (jobject) host->extension(JAVA_HOST_LEVEL);
 200 }
 201
 202 JNIEXPORT jdouble JNICALL Java_org_simgrid_msg_Task_getFlopsAmount(JNIEnv * env, jobject jtask)
 203 {
 204   msg_task_t ptask = jtask_to_native(jtask, env);
 205
 206   if (not ptask) {
 207     jxbt_throw_notbound(env, "task", jtask);
 208     return -1;
 209   }
 210   return (jdouble)MSG_task_get_flops_amount(ptask);
 211 }
 212
 213 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_setName(JNIEnv *env, jobject jtask, jobject jname) {
 214   msg_task_t task = jtask_to_native(jtask, env);
 215
 216   if (not task) {
 217     jxbt_throw_notbound(env, "task", jtask);
 218     return;
 219   }
 220   const char *name = env->GetStringUTFChars((jstring) jname, 0);
 221
 222   env->SetObjectField(jtask, jtask_field_Task_name, jname);
 223   MSG_task_set_name(task, name);
 224
 225   env->ReleaseStringUTFChars((jstring) jname, name);
 226 }
 227
 228 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_setPriority(JNIEnv * env, jobject jtask, jdouble priority)
 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_priority(task, priority);
 237 }
 238
 239 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_setFlopsAmount (JNIEnv *env, jobject jtask, jdouble computationAmount)
 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   MSG_task_set_flops_amount(task, computationAmount);
 248 }
 249
 250 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_setBytesAmount (JNIEnv *env, jobject jtask, jdouble dataSize)
 251 {
 252   msg_task_t task = jtask_to_native(jtask, env);
 253
 254   if (not task) {
 255     jxbt_throw_notbound(env, "task", jtask);
 256     return;
 257   }
 258   env->SetDoubleField(jtask, jtask_field_Task_messageSize, dataSize);
 259   MSG_task_set_bytes_amount(task, dataSize);
 260 }
 261
 262 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_sendBounded(JNIEnv * env,jobject jtask, jstring jalias,
 263                                                              jdouble jtimeout,jdouble maxrate)
 264 {
 265   msg_task_t task = jtask_to_native(jtask, env);
 266   if (not task) {
 267     jxbt_throw_notbound(env, "task", jtask);
 268     return;
 269   }
 270
 271   /* Add a global ref into the Ctask so that the receiver can use it */
 272   MSG_task_set_data(task, (void *) env->NewGlobalRef(jtask));
 273
 274   const char* alias = env->GetStringUTFChars(jalias, 0);
 275   msg_error_t res   = MSG_task_send_with_timeout_bounded(task, alias, jtimeout, maxrate);
 276   env->ReleaseStringUTFChars(jalias, alias);
 277
 278   if (res != MSG_OK)
 279     jmsg_throw_status(env, res);
 280 }
 281
 282 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_receive(JNIEnv* env, jclass cls, jstring jalias, jdouble jtimeout)
 283 {
 284   msg_task_t task = nullptr;
 285
 286   const char *alias = env->GetStringUTFChars(jalias, 0);
 287   msg_error_t rv;
 288   if (not simgrid::ForcefulKillException::try_n_catch(
 289           [&rv, &task, &alias, &jtimeout]() { rv = MSG_task_receive_with_timeout(&task, alias, (double)jtimeout); })) {
 290     jxbt_throw_by_name(env, "org/simgrid/msg/ProcessKilledError", "Process killed");
 291   }
 292   env->ReleaseStringUTFChars(jalias, alias);
 293   if (env->ExceptionOccurred())
 294     return nullptr;
 295   if (rv != MSG_OK) {
 296     jmsg_throw_status(env, rv);
 297     return nullptr;
 298   }
 299   jobject jtask_global = (jobject) MSG_task_get_data(task);
 300
 301   /* Convert the global ref into a local ref so that the JVM can free the stuff */
 302   jobject jtask_local = env->NewLocalRef(jtask_global);
 303   env->DeleteGlobalRef(jtask_global);
 304   MSG_task_set_data(task, nullptr);
 305
 306   return (jobject) jtask_local;
 307 }
 308
 309 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_irecv(JNIEnv * env, jclass cls, jstring jmailbox) {
 310   jclass comm_class = env->FindClass("org/simgrid/msg/Comm");
 311   if (not comm_class)
 312     return nullptr;
 313
 314   //pointer to store the task object pointer.
 315   msg_task_t* task = new msg_task_t(nullptr);
 316   /* There should be a cache here */
 317
 318   jobject jcomm = env->NewObject(comm_class, jtask_method_Comm_constructor);
 319   if (not jcomm) {
 320     jxbt_throw_jni(env, "Can't create a Comm object.");
 321     return nullptr;
 322   }
 323
 324   const char* mailbox = env->GetStringUTFChars(jmailbox, 0);
 325   msg_comm_t comm     = MSG_task_irecv(task, mailbox);
 326   env->ReleaseStringUTFChars(jmailbox, mailbox);
 327
 328   env->SetLongField(jcomm, jtask_field_Comm_bind, (jlong) (uintptr_t)(comm));
 329   env->SetLongField(jcomm, jtask_field_Comm_taskBind, (jlong) (uintptr_t)(task));
 330   env->SetBooleanField(jcomm, jtask_field_Comm_receiving, JNI_TRUE);
 331
 332   return jcomm;
 333 }
 334
 335 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_receiveBounded(JNIEnv* env, jclass cls, jstring jalias,
 336                                                                    jdouble jtimeout, jdouble rate)
 337 {
 338   msg_task_t task = nullptr;
 339
 340   const char *alias = env->GetStringUTFChars(jalias, 0);
 341   msg_error_t res   = MSG_task_receive_with_timeout_bounded(&task, alias, jtimeout, rate);
 342   if (env->ExceptionOccurred())
 343     return nullptr;
 344   if (res != MSG_OK) {
 345     jmsg_throw_status(env, res);
 346     return nullptr;
 347   }
 348   jobject jtask_global = (jobject)MSG_task_get_data(task);
 349
 350   /* Convert the global ref into a local ref so that the JVM can free the stuff */
 351   jobject jtask_local = env->NewLocalRef(jtask_global);
 352   env->DeleteGlobalRef(jtask_global);
 353   MSG_task_set_data(task, nullptr);
 354
 355   env->ReleaseStringUTFChars(jalias, alias);
 356
 357   return (jobject) jtask_local;
 358 }
 359
 360 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_irecvBounded(JNIEnv * env, jclass cls, jstring jmailbox,
 361                                                                  jdouble rate)
 362 {
 363   jclass comm_class = env->FindClass("org/simgrid/msg/Comm");
 364   if (not comm_class)
 365     return nullptr;
 366
 367   // pointer to store the task object pointer.
 368   msg_task_t* task = new msg_task_t(nullptr);
 369
 370   jobject jcomm = env->NewObject(comm_class, jtask_method_Comm_constructor);
 371   if (not jcomm) {
 372     jxbt_throw_jni(env, "Can't create a Comm object.");
 373     return nullptr;
 374   }
 375
 376   const char* mailbox = env->GetStringUTFChars(jmailbox, 0);
 377   msg_comm_t comm     = MSG_task_irecv_bounded(task, mailbox, rate);
 378   env->ReleaseStringUTFChars(jmailbox, mailbox);
 379
 380   env->SetLongField(jcomm, jtask_field_Comm_bind, (jlong) (uintptr_t)(comm));
 381   env->SetLongField(jcomm, jtask_field_Comm_taskBind, (jlong) (uintptr_t)(task));
 382   env->SetBooleanField(jcomm, jtask_field_Comm_receiving, JNI_TRUE);
 383
 384   return jcomm;
 385 }
 386
 387 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_isend(JNIEnv *env, jobject jtask, jstring jmailbox)
 388 {
 389   msg_comm_t comm;
 390
 391   jclass comm_class = env->FindClass("org/simgrid/msg/Comm");
 392
 393   if (not comm_class)
 394     return nullptr;
 395
 396   jobject jcomm       = env->NewObject(comm_class, jtask_method_Comm_constructor);
 397   const char* mailbox = env->GetStringUTFChars(jmailbox, 0);
 398
 399   msg_task_t task = jtask_to_native(jtask, env);
 400
 401   if (not task) {
 402     env->ReleaseStringUTFChars(jmailbox, mailbox);
 403     env->DeleteLocalRef(jcomm);
 404     jxbt_throw_notbound(env, "task", jtask);
 405         return nullptr;
 406   }
 407
 408   MSG_task_set_data(task, (void *) env->NewGlobalRef(jtask));
 409   comm = MSG_task_isend(task,mailbox);
 410
 411   env->SetLongField(jcomm, jtask_field_Comm_bind, (jlong) (uintptr_t)(comm));
 412   env->SetLongField(jcomm, jtask_field_Comm_taskBind, (jlong) (uintptr_t)(nullptr));
 413   env->SetBooleanField(jcomm, jtask_field_Comm_receiving, JNI_FALSE);
 414
 415   env->ReleaseStringUTFChars(jmailbox, mailbox);
 416
 417   return jcomm;
 418 }
 419
 420 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_isendBounded(JNIEnv *env, jobject jtask, jstring jmailbox,
 421                                                                  jdouble maxrate)
 422 {
 423   msg_task_t task;
 424   jobject jcomm;
 425   msg_comm_t comm;
 426   const char *mailbox;
 427
 428   jclass comm_class = env->FindClass("org/simgrid/msg/Comm");
 429   if (not comm_class)
 430     return nullptr;
 431
 432   jcomm = env->NewObject(comm_class, jtask_method_Comm_constructor);
 433   mailbox = env->GetStringUTFChars(jmailbox, 0);
 434
 435   task = jtask_to_native(jtask, env);
 436
 437   if (not task) {
 438     env->ReleaseStringUTFChars(jmailbox, mailbox);
 439     env->DeleteLocalRef(jcomm);
 440     jxbt_throw_notbound(env, "task", jtask);
 441         return nullptr;
 442   }
 443
 444   MSG_task_set_data(task, (void *) env->NewGlobalRef(jtask));
 445   comm = MSG_task_isend_bounded(task,mailbox,maxrate);
 446
 447   env->SetLongField(jcomm, jtask_field_Comm_bind, (jlong) (uintptr_t)(comm));
 448   env->SetLongField(jcomm, jtask_field_Comm_taskBind, (jlong) (uintptr_t)(nullptr));
 449   env->SetBooleanField(jcomm, jtask_field_Comm_receiving, JNI_FALSE);
 450
 451   env->ReleaseStringUTFChars(jmailbox, mailbox);
 452
 453   return jcomm;
 454 }
 455
 456 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_nativeFinalize(JNIEnv * env, jobject jtask)
 457 {
 458   msg_task_t task = jtask_to_native(jtask, env);
 459
 460   if (not task) {
 461     jxbt_throw_notbound(env, "task", jtask);
 462     return;
 463     }
 464
 465     MSG_task_destroy(task);
 466 }
 467
 468 static void msg_task_cancel_on_failed_dsend(void*t) {
 469   msg_task_t task = (msg_task_t) t;
 470   JNIEnv* env     = get_current_thread_env();
 471   if (env) {
 472     jobject jtask_global = (jobject)MSG_task_get_data(task);
 473     /* Destroy the global ref so that the JVM can free the stuff */
 474     env->DeleteGlobalRef(jtask_global);
 475     /* Don't free the C data here, to avoid a race condition with the GC also sometimes doing so.
 476      * A rare memleak is seen as preferable to a rare "free(): invalid pointer" failure that
 477      * proves really hard to debug.
 478      */
 479   }
 480   MSG_task_set_data(task, nullptr);
 481 }
 482
 483 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_dsend(JNIEnv * env, jobject jtask, jstring jalias)
 484 {
 485   const char *alias = env->GetStringUTFChars(jalias, 0);
 486
 487   msg_task_t task = jtask_to_native(jtask, env);
 488
 489   if (not task) {
 490     env->ReleaseStringUTFChars(jalias, alias);
 491     jxbt_throw_notbound(env, "task", jtask);
 492     return;
 493   }
 494
 495   /* Pass a global ref to the Jtask into the Ctask so that the receiver can use it */
 496   MSG_task_set_data(task, (void *) env->NewGlobalRef(jtask));
 497   MSG_task_dsend(task, alias, msg_task_cancel_on_failed_dsend);
 498
 499   env->ReleaseStringUTFChars(jalias, alias);
 500 }
 501
 502 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_dsendBounded(JNIEnv * env, jobject jtask, jstring jalias,
 503                                                               jdouble maxrate)
 504 {
 505   const char *alias = env->GetStringUTFChars(jalias, 0);
 506
 507   msg_task_t task = jtask_to_native(jtask, env);
 508
 509   if (not task) {
 510     env->ReleaseStringUTFChars(jalias, alias);
 511     jxbt_throw_notbound(env, "task", jtask);
 512     return;
 513   }
 514
 515   /* Pass a global ref to the Jtask into the Ctask so that the receiver can use it */
 516   MSG_task_set_data(task, (void *) env->NewGlobalRef(jtask));
 517   MSG_task_dsend_bounded(task, alias, msg_task_cancel_on_failed_dsend, maxrate);
 518
 519   env->ReleaseStringUTFChars(jalias, alias);
 520 }
 521
 522 JNIEXPORT jboolean JNICALL Java_org_simgrid_msg_Task_listen(JNIEnv * env, jclass cls, jstring jalias)
 523 {
 524   const char *alias = env->GetStringUTFChars(jalias, 0);
 525   int rv = MSG_task_listen(alias);
 526   env->ReleaseStringUTFChars(jalias, alias);
 527
 528   return (jboolean) rv;
 529 }
 530
 531 JNIEXPORT jint JNICALL Java_org_simgrid_msg_Task_listenFrom(JNIEnv * env, jclass cls, jstring jalias)
 532 {
 533   const char *alias = env->GetStringUTFChars(jalias, 0);
 534   int rv = MSG_task_listen_from(alias);
 535   env->ReleaseStringUTFChars(jalias, alias);
 536
 537   return (jint) rv;
 538 }