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/s4u/Host.hpp"
   9 #include "src/kernel/context/Context.hpp"
  10
  11 #include "jmsg.hpp"
  12 #include "jmsg_host.h"
  13 #include "jmsg_process.h"
  14 #include "jmsg_task.h"
  15 #include "jxbt_utilities.hpp"
  16
  17 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(java);
  18
  19 static jmethodID jtask_method_Comm_constructor;
  20
  21 static jfieldID jtask_field_Task_bind;
  22 static jfieldID jtask_field_Task_name;
  23 static jfieldID jtask_field_Task_messageSize;
  24 static jfieldID jtask_field_Comm_bind;
  25 static jfieldID jtask_field_Comm_taskBind;
  26 static jfieldID jtask_field_Comm_receiving;
  27
  28 void jtask_bind(jobject jtask, msg_task_t task, JNIEnv * env)
  29 {
  30   env->SetLongField(jtask, jtask_field_Task_bind, (intptr_t)task);
  31 }
  32
  33 msg_task_t jtask_to_native(jobject jtask, JNIEnv* env)
  34 {
  35   return (msg_task_t)(intptr_t)env->GetLongField(jtask, jtask_field_Task_bind);
  36 }
  37
  38 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_nativeInit(JNIEnv *env, jclass cls) {
  39   jclass jtask_class_Comm = env->FindClass("org/simgrid/msg/Comm");
  40   jclass jtask_class_Task = env->FindClass("org/simgrid/msg/Task");
  41   xbt_assert(jtask_class_Comm && jtask_class_Task,
  42              "Native initialization of msg/Comm or msg/Task failed. Please report that bug");
  43
  44   jtask_method_Comm_constructor = env->GetMethodID(jtask_class_Comm, "<init>", "()V");
  45   jtask_field_Task_bind = jxbt_get_jfield(env, jtask_class_Task, "bind", "J");
  46   jtask_field_Task_name = jxbt_get_jfield(env, jtask_class_Task, "name", "Ljava/lang/String;");
  47   jtask_field_Task_messageSize = jxbt_get_jfield(env, jtask_class_Task, "messageSize", "D");
  48   jtask_field_Comm_bind = jxbt_get_jfield(env, jtask_class_Comm, "bind", "J");
  49   jtask_field_Comm_taskBind = jxbt_get_jfield(env, jtask_class_Comm, "taskBind", "J");
  50   jtask_field_Comm_receiving = jxbt_get_jfield(env, jtask_class_Comm, "receiving", "Z");
  51   xbt_assert(jtask_field_Task_bind && jtask_field_Comm_bind && jtask_field_Comm_taskBind &&
  52                  jtask_field_Comm_receiving && jtask_method_Comm_constructor,
  53              "Native initialization of msg/Task failed. Please report that bug");
  54 }
  55
  56 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_create(JNIEnv * env, jobject jtask, jstring jname,
  57                                       jdouble jflopsAmount, jdouble jbytesAmount)
  58 {
  59   const char *name = nullptr;      /* the name of the task                                 */
  60
  61   if (jname)
  62     name = env->GetStringUTFChars(jname, 0);
  63   msg_task_t task = MSG_task_create(name, static_cast<double>(jflopsAmount), static_cast<double>(jbytesAmount), jtask);
  64   if (jname)
  65     env->ReleaseStringUTFChars(jname, name);
  66
  67   /* bind & store the task */
  68   jtask_bind(jtask, task, env);
  69 }
  70
  71 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_parallelCreate(JNIEnv * env, jobject jtask, jstring jname,
  72                                          jobjectArray jhosts, jdoubleArray jcomputeDurations_arg,
  73                                          jdoubleArray jmessageSizes_arg)
  74 {
  75   int host_count = static_cast<int>(env->GetArrayLength(jhosts));
  76
  77   jdouble* jcomputeDurations = env->GetDoubleArrayElements(jcomputeDurations_arg, 0);
  78   msg_host_t* hosts          = new msg_host_t[host_count];
  79   double* computeDurations   = new double[host_count];
  80   for (int index = 0; index < host_count; index++) {
  81     jobject jhost           = env->GetObjectArrayElement(jhosts, index);
  82     hosts[index] = jhost_get_native(env, jhost);
  83     computeDurations[index] = jcomputeDurations[index];
  84   }
  85   env->ReleaseDoubleArrayElements(jcomputeDurations_arg, jcomputeDurations, 0);
  86
  87   jdouble* jmessageSizes = env->GetDoubleArrayElements(jmessageSizes_arg, 0);
  88   double* messageSizes   = new double[host_count * host_count];
  89   for (int index = 0; index < host_count * host_count; index++) {
  90     messageSizes[index] = jmessageSizes[index];
  91   }
  92   env->ReleaseDoubleArrayElements(jmessageSizes_arg, jmessageSizes, 0);
  93
  94   /* get the C string from the java string */
  95   const char* name = env->GetStringUTFChars(jname, 0);
  96   msg_task_t task  = MSG_parallel_task_create(name, host_count, hosts, computeDurations, messageSizes, jtask);
  97   env->ReleaseStringUTFChars(jname, name);
  98
  99   /* associate the java task object and the native task */
 100   jtask_bind(jtask, task, env);
 101
 102   delete[] hosts;
 103   delete[] computeDurations;
 104   delete[] messageSizes;
 105 }
 106
 107 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_cancel(JNIEnv * env, jobject jtask)
 108 {
 109   msg_task_t ptask = jtask_to_native(jtask, env);
 110
 111   if (not ptask) {
 112     jxbt_throw_notbound(env, "task", jtask);
 113     return;
 114   }
 115
 116   msg_error_t rv = MSG_task_cancel(ptask);
 117
 118   jxbt_check_res("MSG_task_cancel()", rv, MSG_OK, "unexpected error , please report this bug");
 119 }
 120
 121 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_execute(JNIEnv * env, jobject jtask)
 122 {
 123   msg_task_t task = jtask_to_native(jtask, env);
 124
 125   if (not task) {
 126     jxbt_throw_notbound(env, "task", jtask);
 127     return;
 128   }
 129   msg_error_t rv;
 130   simgrid::kernel::context::try_n_catch_stoprequest(
 131       [&rv, &task]() { rv = MSG_task_execute(task); },
 132       [&env] { jxbt_throw_by_name(env, "org/simgrid/msg/ProcessKilledError", "Process killed"); });
 133
 134   if (env->ExceptionOccurred())
 135     return;
 136   if (rv != MSG_OK) {
 137     jmsg_throw_status(env, rv);
 138   }
 139 }
 140
 141 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_setBound(JNIEnv * env, jobject jtask, jdouble bound)
 142 {
 143   msg_task_t task = jtask_to_native(jtask, env);
 144
 145   if (not task) {
 146     jxbt_throw_notbound(env, "task", jtask);
 147     return;
 148   }
 149   MSG_task_set_bound(task, bound);
 150 }
 151
 152 JNIEXPORT jstring JNICALL Java_org_simgrid_msg_Task_getName(JNIEnv * env, jobject jtask) {
 153   msg_task_t task = jtask_to_native(jtask, env);
 154
 155   if (not task) {
 156     jxbt_throw_notbound(env, "task", jtask);
 157     return nullptr;
 158   }
 159
 160   return env->NewStringUTF(MSG_task_get_name(task));
 161 }
 162
 163 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_getSender(JNIEnv * env, jobject jtask) {
 164   msg_process_t process;
 165
 166   msg_task_t task = jtask_to_native(jtask, env);
 167
 168   if (not task) {
 169     jxbt_throw_notbound(env, "task", jtask);
 170     return nullptr;
 171   }
 172
 173   process = MSG_task_get_sender(task);
 174   if (process == nullptr) {
 175     return nullptr;
 176   }
 177   return (jobject)jprocess_from_native(process);
 178 }
 179
 180 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_getSource(JNIEnv * env, jobject jtask)
 181 {
 182   msg_host_t host;
 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   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, static_cast<double>(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, static_cast<double>(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, static_cast<double>(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 =
 276       MSG_task_send_with_timeout_bounded(task, alias, static_cast<double>(jtimeout), static_cast<double>(maxrate));
 277   env->ReleaseStringUTFChars(jalias, alias);
 278
 279   if (res != MSG_OK)
 280     jmsg_throw_status(env, res);
 281 }
 282
 283 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_receive(JNIEnv* env, jclass cls, jstring jalias, jdouble jtimeout)
 284 {
 285   msg_task_t task = nullptr;
 286
 287   const char *alias = env->GetStringUTFChars(jalias, 0);
 288   msg_error_t rv;
 289   simgrid::kernel::context::try_n_catch_stoprequest(
 290       [&rv, &task, &alias, &jtimeout]() {
 291         rv = MSG_task_receive_ext(&task, alias, (double)jtimeout, /*host*/ nullptr);
 292       },
 293       [&env]() { jxbt_throw_by_name(env, "org/simgrid/msg/ProcessKilledError", "Process killed"); });
 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   jobject jtask_global = (jobject) MSG_task_get_data(task);
 475
 476   /* Destroy the global ref so that the JVM can free the stuff */
 477   env->DeleteGlobalRef(jtask_global);
 478   MSG_task_set_data(task, nullptr);
 479 }
 480
 481 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_dsend(JNIEnv * env, jobject jtask, jstring jalias)
 482 {
 483   const char *alias = env->GetStringUTFChars(jalias, 0);
 484
 485   msg_task_t task = jtask_to_native(jtask, env);
 486
 487   if (not task) {
 488     env->ReleaseStringUTFChars(jalias, alias);
 489     jxbt_throw_notbound(env, "task", jtask);
 490     return;
 491   }
 492
 493   /* Pass a global ref to the Jtask into the Ctask so that the receiver can use it */
 494   MSG_task_set_data(task, (void *) env->NewGlobalRef(jtask));
 495   MSG_task_dsend(task, alias, msg_task_cancel_on_failed_dsend);
 496
 497   env->ReleaseStringUTFChars(jalias, alias);
 498 }
 499
 500 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_dsendBounded(JNIEnv * env, jobject jtask, jstring jalias,
 501                                                               jdouble maxrate)
 502 {
 503   const char *alias = env->GetStringUTFChars(jalias, 0);
 504
 505   msg_task_t task = jtask_to_native(jtask, env);
 506
 507   if (not task) {
 508     env->ReleaseStringUTFChars(jalias, alias);
 509     jxbt_throw_notbound(env, "task", jtask);
 510     return;
 511   }
 512
 513   /* Pass a global ref to the Jtask into the Ctask so that the receiver can use it */
 514   MSG_task_set_data(task, (void *) env->NewGlobalRef(jtask));
 515   MSG_task_dsend_bounded(task, alias, msg_task_cancel_on_failed_dsend,static_cast<double>(maxrate));
 516
 517   env->ReleaseStringUTFChars(jalias, alias);
 518 }
 519
 520 JNIEXPORT jboolean JNICALL Java_org_simgrid_msg_Task_listen(JNIEnv * env, jclass cls, jstring jalias)
 521 {
 522   const char *alias = env->GetStringUTFChars(jalias, 0);
 523   int rv = MSG_task_listen(alias);
 524   env->ReleaseStringUTFChars(jalias, alias);
 525
 526   return (jboolean) rv;
 527 }
 528
 529 JNIEXPORT jint JNICALL Java_org_simgrid_msg_Task_listenFrom(JNIEnv * env, jclass cls, jstring jalias)
 530 {
 531   const char *alias = env->GetStringUTFChars(jalias, 0);
 532   int rv = MSG_task_listen_from(alias);
 533   env->ReleaseStringUTFChars(jalias, alias);
 534
 535   return (jint) rv;
 536 }