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, static_cast<double>(jflopsAmount), static_cast<double>(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 = static_cast<int>(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_host_t host;
 184   msg_task_t task = jtask_to_native(jtask, env);
 185
 186   if (not task) {
 187     jxbt_throw_notbound(env, "task", jtask);
 188     return nullptr;
 189   }
 190
 191   host = MSG_task_get_source(task);
 192   if (host == nullptr) {
 193     return nullptr;
 194   }
 195   if (not host->extension(JAVA_HOST_LEVEL)) {
 196     jxbt_throw_jni(env, "MSG_task_get_source() failed");
 197     return nullptr;
 198   }
 199
 200   return (jobject) host->extension(JAVA_HOST_LEVEL);
 201 }
 202
 203 JNIEXPORT jdouble JNICALL Java_org_simgrid_msg_Task_getFlopsAmount(JNIEnv * env, jobject jtask)
 204 {
 205   msg_task_t ptask = jtask_to_native(jtask, env);
 206
 207   if (not ptask) {
 208     jxbt_throw_notbound(env, "task", jtask);
 209     return -1;
 210   }
 211   return (jdouble)MSG_task_get_flops_amount(ptask);
 212 }
 213
 214 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_setName(JNIEnv *env, jobject jtask, jobject jname) {
 215   msg_task_t task = jtask_to_native(jtask, env);
 216
 217   if (not task) {
 218     jxbt_throw_notbound(env, "task", jtask);
 219     return;
 220   }
 221   const char *name = env->GetStringUTFChars((jstring) jname, 0);
 222
 223   env->SetObjectField(jtask, jtask_field_Task_name, jname);
 224   MSG_task_set_name(task, name);
 225
 226   env->ReleaseStringUTFChars((jstring) jname, name);
 227 }
 228
 229 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_setPriority(JNIEnv * env, jobject jtask, jdouble priority)
 230 {
 231   msg_task_t task = jtask_to_native(jtask, env);
 232
 233   if (not task) {
 234     jxbt_throw_notbound(env, "task", jtask);
 235     return;
 236   }
 237   MSG_task_set_priority(task, static_cast<double>(priority));
 238 }
 239
 240 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_setFlopsAmount (JNIEnv *env, jobject jtask, jdouble computationAmount)
 241 {
 242   msg_task_t task = jtask_to_native(jtask, env);
 243
 244   if (not task) {
 245     jxbt_throw_notbound(env, "task", jtask);
 246     return;
 247   }
 248   MSG_task_set_flops_amount(task, static_cast<double>(computationAmount));
 249 }
 250
 251 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_setBytesAmount (JNIEnv *env, jobject jtask, jdouble dataSize)
 252 {
 253   msg_task_t task = jtask_to_native(jtask, env);
 254
 255   if (not task) {
 256     jxbt_throw_notbound(env, "task", jtask);
 257     return;
 258   }
 259   env->SetDoubleField(jtask, jtask_field_Task_messageSize, dataSize);
 260   MSG_task_set_bytes_amount(task, static_cast<double>(dataSize));
 261 }
 262
 263 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_sendBounded(JNIEnv * env,jobject jtask, jstring jalias,
 264                                                              jdouble jtimeout,jdouble maxrate)
 265 {
 266   msg_task_t task = jtask_to_native(jtask, env);
 267   if (not task) {
 268     jxbt_throw_notbound(env, "task", jtask);
 269     return;
 270   }
 271
 272   /* Add a global ref into the Ctask so that the receiver can use it */
 273   MSG_task_set_data(task, (void *) env->NewGlobalRef(jtask));
 274
 275   const char* alias = env->GetStringUTFChars(jalias, 0);
 276   msg_error_t res =
 277       MSG_task_send_with_timeout_bounded(task, alias, static_cast<double>(jtimeout), static_cast<double>(maxrate));
 278   env->ReleaseStringUTFChars(jalias, alias);
 279
 280   if (res != MSG_OK)
 281     jmsg_throw_status(env, res);
 282 }
 283
 284 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_receive(JNIEnv* env, jclass cls, jstring jalias, jdouble jtimeout)
 285 {
 286   msg_task_t task = nullptr;
 287
 288   const char *alias = env->GetStringUTFChars(jalias, 0);
 289   msg_error_t rv;
 290   if (not simgrid::ForcefulKillException::try_n_catch(
 291           [&rv, &task, &alias, &jtimeout]() { rv = MSG_task_receive_with_timeout(&task, alias, (double)jtimeout); })) {
 292     jxbt_throw_by_name(env, "org/simgrid/msg/ProcessKilledError", "Process killed");
 293   }
 294   env->ReleaseStringUTFChars(jalias, alias);
 295   if (env->ExceptionOccurred())
 296     return nullptr;
 297   if (rv != MSG_OK) {
 298     jmsg_throw_status(env, rv);
 299     return nullptr;
 300   }
 301   jobject jtask_global = (jobject) MSG_task_get_data(task);
 302
 303   /* Convert the global ref into a local ref so that the JVM can free the stuff */
 304   jobject jtask_local = env->NewLocalRef(jtask_global);
 305   env->DeleteGlobalRef(jtask_global);
 306   MSG_task_set_data(task, nullptr);
 307
 308   return (jobject) jtask_local;
 309 }
 310
 311 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_irecv(JNIEnv * env, jclass cls, jstring jmailbox) {
 312   jclass comm_class = env->FindClass("org/simgrid/msg/Comm");
 313   if (not comm_class)
 314     return nullptr;
 315
 316   //pointer to store the task object pointer.
 317   msg_task_t* task = new msg_task_t(nullptr);
 318   /* There should be a cache here */
 319
 320   jobject jcomm = env->NewObject(comm_class, jtask_method_Comm_constructor);
 321   if (not jcomm) {
 322     jxbt_throw_jni(env, "Can't create a Comm object.");
 323     return nullptr;
 324   }
 325
 326   const char* mailbox = env->GetStringUTFChars(jmailbox, 0);
 327   msg_comm_t comm     = MSG_task_irecv(task, mailbox);
 328   env->ReleaseStringUTFChars(jmailbox, mailbox);
 329
 330   env->SetLongField(jcomm, jtask_field_Comm_bind, (jlong) (uintptr_t)(comm));
 331   env->SetLongField(jcomm, jtask_field_Comm_taskBind, (jlong) (uintptr_t)(task));
 332   env->SetBooleanField(jcomm, jtask_field_Comm_receiving, JNI_TRUE);
 333
 334   return jcomm;
 335 }
 336
 337 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_receiveBounded(JNIEnv* env, jclass cls, jstring jalias,
 338                                                                    jdouble jtimeout, jdouble rate)
 339 {
 340   msg_task_t task = nullptr;
 341
 342   const char *alias = env->GetStringUTFChars(jalias, 0);
 343   msg_error_t res   = MSG_task_receive_ext_bounded(&task, alias, static_cast<double>(jtimeout), /*host*/ nullptr,
 344                                                  static_cast<double>(rate));
 345   if (env->ExceptionOccurred())
 346     return nullptr;
 347   if (res != MSG_OK) {
 348     jmsg_throw_status(env, res);
 349     return nullptr;
 350   }
 351   jobject jtask_global = (jobject)MSG_task_get_data(task);
 352
 353   /* Convert the global ref into a local ref so that the JVM can free the stuff */
 354   jobject jtask_local = env->NewLocalRef(jtask_global);
 355   env->DeleteGlobalRef(jtask_global);
 356   MSG_task_set_data(task, nullptr);
 357
 358   env->ReleaseStringUTFChars(jalias, alias);
 359
 360   return (jobject) jtask_local;
 361 }
 362
 363 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_irecvBounded(JNIEnv * env, jclass cls, jstring jmailbox,
 364                                                                  jdouble rate)
 365 {
 366   jclass comm_class = env->FindClass("org/simgrid/msg/Comm");
 367   if (not comm_class)
 368     return nullptr;
 369
 370   // pointer to store the task object pointer.
 371   msg_task_t* task = new msg_task_t(nullptr);
 372
 373   jobject jcomm = env->NewObject(comm_class, jtask_method_Comm_constructor);
 374   if (not jcomm) {
 375     jxbt_throw_jni(env, "Can't create a Comm object.");
 376     return nullptr;
 377   }
 378
 379   const char* mailbox = env->GetStringUTFChars(jmailbox, 0);
 380   msg_comm_t comm     = MSG_task_irecv_bounded(task, mailbox, static_cast<double>(rate));
 381   env->ReleaseStringUTFChars(jmailbox, mailbox);
 382
 383   env->SetLongField(jcomm, jtask_field_Comm_bind, (jlong) (uintptr_t)(comm));
 384   env->SetLongField(jcomm, jtask_field_Comm_taskBind, (jlong) (uintptr_t)(task));
 385   env->SetBooleanField(jcomm, jtask_field_Comm_receiving, JNI_TRUE);
 386
 387   return jcomm;
 388 }
 389
 390 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_isend(JNIEnv *env, jobject jtask, jstring jmailbox)
 391 {
 392   msg_comm_t comm;
 393
 394   jclass comm_class = env->FindClass("org/simgrid/msg/Comm");
 395
 396   if (not comm_class)
 397     return nullptr;
 398
 399   jobject jcomm       = env->NewObject(comm_class, jtask_method_Comm_constructor);
 400   const char* mailbox = env->GetStringUTFChars(jmailbox, 0);
 401
 402   msg_task_t task = jtask_to_native(jtask, env);
 403
 404   if (not task) {
 405     env->ReleaseStringUTFChars(jmailbox, mailbox);
 406     env->DeleteLocalRef(jcomm);
 407     jxbt_throw_notbound(env, "task", jtask);
 408         return nullptr;
 409   }
 410
 411   MSG_task_set_data(task, (void *) env->NewGlobalRef(jtask));
 412   comm = MSG_task_isend(task,mailbox);
 413
 414   env->SetLongField(jcomm, jtask_field_Comm_bind, (jlong) (uintptr_t)(comm));
 415   env->SetLongField(jcomm, jtask_field_Comm_taskBind, (jlong) (uintptr_t)(nullptr));
 416   env->SetBooleanField(jcomm, jtask_field_Comm_receiving, JNI_FALSE);
 417
 418   env->ReleaseStringUTFChars(jmailbox, mailbox);
 419
 420   return jcomm;
 421 }
 422
 423 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_isendBounded(JNIEnv *env, jobject jtask, jstring jmailbox,
 424                                                                  jdouble maxrate)
 425 {
 426   msg_task_t task;
 427   jobject jcomm;
 428   msg_comm_t comm;
 429   const char *mailbox;
 430
 431   jclass comm_class = env->FindClass("org/simgrid/msg/Comm");
 432   if (not comm_class)
 433     return nullptr;
 434
 435   jcomm = env->NewObject(comm_class, jtask_method_Comm_constructor);
 436   mailbox = env->GetStringUTFChars(jmailbox, 0);
 437
 438   task = jtask_to_native(jtask, env);
 439
 440   if (not task) {
 441     env->ReleaseStringUTFChars(jmailbox, mailbox);
 442     env->DeleteLocalRef(jcomm);
 443     jxbt_throw_notbound(env, "task", jtask);
 444         return nullptr;
 445   }
 446
 447   MSG_task_set_data(task, (void *) env->NewGlobalRef(jtask));
 448   comm = MSG_task_isend_bounded(task,mailbox,maxrate);
 449
 450   env->SetLongField(jcomm, jtask_field_Comm_bind, (jlong) (uintptr_t)(comm));
 451   env->SetLongField(jcomm, jtask_field_Comm_taskBind, (jlong) (uintptr_t)(nullptr));
 452   env->SetBooleanField(jcomm, jtask_field_Comm_receiving, JNI_FALSE);
 453
 454   env->ReleaseStringUTFChars(jmailbox, mailbox);
 455
 456   return jcomm;
 457 }
 458
 459 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_nativeFinalize(JNIEnv * env, jobject jtask)
 460 {
 461   msg_task_t task = jtask_to_native(jtask, env);
 462
 463   if (not task) {
 464     jxbt_throw_notbound(env, "task", jtask);
 465     return;
 466     }
 467
 468     MSG_task_destroy(task);
 469 }
 470
 471 static void msg_task_cancel_on_failed_dsend(void*t) {
 472   msg_task_t task = (msg_task_t) t;
 473   JNIEnv* env     = get_current_thread_env();
 474   if (env) {
 475     jobject jtask_global = (jobject)MSG_task_get_data(task);
 476     /* Destroy the global ref so that the JVM can free the stuff */
 477     env->DeleteGlobalRef(jtask_global);
 478     /* Don't free the C data here, to avoid a race condition with the GC also sometimes doing so.
 479      * A rare memleak is seen as preferable to a rare "free(): invalid pointer" failure that
 480      * proves really hard to debug.
 481      */
 482   }
 483   MSG_task_set_data(task, nullptr);
 484 }
 485
 486 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_dsend(JNIEnv * env, jobject jtask, jstring jalias)
 487 {
 488   const char *alias = env->GetStringUTFChars(jalias, 0);
 489
 490   msg_task_t task = jtask_to_native(jtask, env);
 491
 492   if (not task) {
 493     env->ReleaseStringUTFChars(jalias, alias);
 494     jxbt_throw_notbound(env, "task", jtask);
 495     return;
 496   }
 497
 498   /* Pass a global ref to the Jtask into the Ctask so that the receiver can use it */
 499   MSG_task_set_data(task, (void *) env->NewGlobalRef(jtask));
 500   MSG_task_dsend(task, alias, msg_task_cancel_on_failed_dsend);
 501
 502   env->ReleaseStringUTFChars(jalias, alias);
 503 }
 504
 505 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_dsendBounded(JNIEnv * env, jobject jtask, jstring jalias,
 506                                                               jdouble maxrate)
 507 {
 508   const char *alias = env->GetStringUTFChars(jalias, 0);
 509
 510   msg_task_t task = jtask_to_native(jtask, env);
 511
 512   if (not task) {
 513     env->ReleaseStringUTFChars(jalias, alias);
 514     jxbt_throw_notbound(env, "task", jtask);
 515     return;
 516   }
 517
 518   /* Pass a global ref to the Jtask into the Ctask so that the receiver can use it */
 519   MSG_task_set_data(task, (void *) env->NewGlobalRef(jtask));
 520   MSG_task_dsend_bounded(task, alias, msg_task_cancel_on_failed_dsend,static_cast<double>(maxrate));
 521
 522   env->ReleaseStringUTFChars(jalias, alias);
 523 }
 524
 525 JNIEXPORT jboolean JNICALL Java_org_simgrid_msg_Task_listen(JNIEnv * env, jclass cls, jstring jalias)
 526 {
 527   const char *alias = env->GetStringUTFChars(jalias, 0);
 528   int rv = MSG_task_listen(alias);
 529   env->ReleaseStringUTFChars(jalias, alias);
 530
 531   return (jboolean) rv;
 532 }
 533
 534 JNIEXPORT jint JNICALL Java_org_simgrid_msg_Task_listenFrom(JNIEnv * env, jclass cls, jstring jalias)
 535 {
 536   const char *alias = env->GetStringUTFChars(jalias, 0);
 537   int rv = MSG_task_listen_from(alias);
 538   env->ReleaseStringUTFChars(jalias, alias);
 539
 540   return (jint) rv;
 541 }