src/bindings/java/jmsg_task.cpp

   1 /* Functions related to the java task instances.                            */
   2
   3 /* Copyright (c) 2007-2017. 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
  10 #include "jmsg.hpp"
  11 #include "jmsg_host.h"
  12 #include "jmsg_process.h"
  13 #include "jmsg_task.h"
  14 #include "jxbt_utilities.hpp"
  15
  16 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(java);
  17
  18 extern "C" {
  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          = xbt_new0(msg_host_t, host_count);
  80   double* computeDurations   = xbt_new0(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   = xbt_new0(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
 104 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_cancel(JNIEnv * env, jobject jtask)
 105 {
 106   msg_task_t ptask = jtask_to_native(jtask, env);
 107
 108   if (not ptask) {
 109     jxbt_throw_notbound(env, "task", jtask);
 110     return;
 111   }
 112
 113   msg_error_t rv = MSG_task_cancel(ptask);
 114
 115   jxbt_check_res("MSG_task_cancel()", rv, MSG_OK, "unexpected error , please report this bug");
 116 }
 117
 118 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_execute(JNIEnv * env, jobject jtask)
 119 {
 120   msg_task_t task = jtask_to_native(jtask, env);
 121
 122   if (not task) {
 123     jxbt_throw_notbound(env, "task", jtask);
 124     return;
 125   }
 126   msg_error_t rv;
 127   rv = MSG_task_execute(task);
 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   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   msg_process_t process;
 159
 160   msg_task_t task = jtask_to_native(jtask, env);
 161
 162   if (not task) {
 163     jxbt_throw_notbound(env, "task", jtask);
 164     return nullptr;
 165   }
 166
 167   process = MSG_task_get_sender(task);
 168   if (process == nullptr) {
 169     return nullptr;
 170   }
 171   return (jobject)jprocess_from_native(process);
 172 }
 173
 174 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_getSource(JNIEnv * env, jobject jtask)
 175 {
 176   msg_host_t host;
 177   msg_task_t task = jtask_to_native(jtask, env);
 178
 179   if (not task) {
 180     jxbt_throw_notbound(env, "task", jtask);
 181     return nullptr;
 182   }
 183
 184   host = MSG_task_get_source(task);
 185   if (host == nullptr) {
 186     return nullptr;
 187   }
 188   if (not host->extension(JAVA_HOST_LEVEL)) {
 189     jxbt_throw_jni(env, "MSG_task_get_source() failed");
 190     return nullptr;
 191   }
 192
 193   return (jobject) host->extension(JAVA_HOST_LEVEL);
 194 }
 195
 196 JNIEXPORT jdouble JNICALL Java_org_simgrid_msg_Task_getFlopsAmount(JNIEnv * env, jobject jtask)
 197 {
 198   msg_task_t ptask = jtask_to_native(jtask, env);
 199
 200   if (not ptask) {
 201     jxbt_throw_notbound(env, "task", jtask);
 202     return -1;
 203   }
 204   return (jdouble) MSG_task_get_flops_amount(ptask);
 205 }
 206
 207 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_setName(JNIEnv *env, jobject jtask, jobject jname) {
 208   msg_task_t task = jtask_to_native(jtask, env);
 209
 210   if (not task) {
 211     jxbt_throw_notbound(env, "task", jtask);
 212     return;
 213   }
 214   const char *name = env->GetStringUTFChars((jstring) jname, 0);
 215
 216   env->SetObjectField(jtask, jtask_field_Task_name, jname);
 217   MSG_task_set_name(task, name);
 218
 219   env->ReleaseStringUTFChars((jstring) jname, name);
 220 }
 221
 222 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_setPriority(JNIEnv * env, jobject jtask, jdouble priority)
 223 {
 224   msg_task_t task = jtask_to_native(jtask, env);
 225
 226   if (not task) {
 227     jxbt_throw_notbound(env, "task", jtask);
 228     return;
 229   }
 230   MSG_task_set_priority(task, static_cast<double>(priority));
 231 }
 232
 233 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_setFlopsAmount (JNIEnv *env, jobject jtask, jdouble computationAmount)
 234 {
 235   msg_task_t task = jtask_to_native(jtask, env);
 236
 237   if (not task) {
 238     jxbt_throw_notbound(env, "task", jtask);
 239     return;
 240   }
 241   MSG_task_set_flops_amount(task, static_cast<double>(computationAmount));
 242 }
 243
 244 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_setBytesAmount (JNIEnv *env, jobject jtask, jdouble dataSize)
 245 {
 246   msg_task_t task = jtask_to_native(jtask, env);
 247
 248   if (not task) {
 249     jxbt_throw_notbound(env, "task", jtask);
 250     return;
 251   }
 252   env->SetDoubleField(jtask, jtask_field_Task_messageSize, dataSize);
 253   MSG_task_set_bytes_amount(task, static_cast<double>(dataSize));
 254 }
 255
 256 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_sendBounded(JNIEnv * env,jobject jtask, jstring jalias,
 257                                                              jdouble jtimeout,jdouble maxrate)
 258 {
 259   msg_task_t task = jtask_to_native(jtask, env);
 260   if (not task) {
 261     jxbt_throw_notbound(env, "task", jtask);
 262     return;
 263   }
 264
 265   /* Add a global ref into the Ctask so that the receiver can use it */
 266   MSG_task_set_data(task, (void *) env->NewGlobalRef(jtask));
 267
 268   const char* alias = env->GetStringUTFChars(jalias, 0);
 269   msg_error_t res =
 270       MSG_task_send_with_timeout_bounded(task, alias, static_cast<double>(jtimeout), static_cast<double>(maxrate));
 271   env->ReleaseStringUTFChars(jalias, alias);
 272
 273   if (res != MSG_OK)
 274     jmsg_throw_status(env, res);
 275 }
 276
 277 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_receive(JNIEnv* env, jclass cls, jstring jalias, jdouble jtimeout)
 278 {
 279   msg_task_t task = nullptr;
 280
 281   const char *alias = env->GetStringUTFChars(jalias, 0);
 282   msg_error_t rv    = MSG_task_receive_ext(&task, alias, (double)jtimeout, /*host*/ nullptr);
 283   env->ReleaseStringUTFChars(jalias, alias);
 284   if (env->ExceptionOccurred())
 285     return nullptr;
 286   if (rv != MSG_OK) {
 287     jmsg_throw_status(env,rv);
 288     return nullptr;
 289   }
 290   jobject jtask_global = (jobject) MSG_task_get_data(task);
 291
 292   /* Convert the global ref into a local ref so that the JVM can free the stuff */
 293   jobject jtask_local = env->NewLocalRef(jtask_global);
 294   env->DeleteGlobalRef(jtask_global);
 295   MSG_task_set_data(task, nullptr);
 296
 297   return (jobject) jtask_local;
 298 }
 299
 300 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_irecv(JNIEnv * env, jclass cls, jstring jmailbox) {
 301   jclass comm_class = env->FindClass("org/simgrid/msg/Comm");
 302   if (not comm_class)
 303     return nullptr;
 304
 305   //pointer to store the task object pointer.
 306   msg_task_t *task = xbt_new(msg_task_t,1);
 307   *task = nullptr;
 308   /* There should be a cache here */
 309
 310   jobject jcomm = env->NewObject(comm_class, jtask_method_Comm_constructor);
 311   if (not jcomm) {
 312     jxbt_throw_jni(env, "Can't create a Comm object.");
 313     return nullptr;
 314   }
 315
 316   const char* mailbox = env->GetStringUTFChars(jmailbox, 0);
 317   msg_comm_t comm     = MSG_task_irecv(task, mailbox);
 318   env->ReleaseStringUTFChars(jmailbox, mailbox);
 319
 320   env->SetLongField(jcomm, jtask_field_Comm_bind, (jlong) (uintptr_t)(comm));
 321   env->SetLongField(jcomm, jtask_field_Comm_taskBind, (jlong) (uintptr_t)(task));
 322   env->SetBooleanField(jcomm, jtask_field_Comm_receiving, JNI_TRUE);
 323
 324   return jcomm;
 325 }
 326
 327 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_receiveBounded(JNIEnv* env, jclass cls, jstring jalias,
 328                                                                    jdouble jtimeout, jdouble rate)
 329 {
 330   msg_task_t task = nullptr;
 331
 332   const char *alias = env->GetStringUTFChars(jalias, 0);
 333   msg_error_t res   = MSG_task_receive_ext_bounded(&task, alias, static_cast<double>(jtimeout), /*host*/ nullptr,
 334                                                  static_cast<double>(rate));
 335   if (env->ExceptionOccurred())
 336     return nullptr;
 337   if (res != MSG_OK) {
 338     jmsg_throw_status(env, res);
 339     return nullptr;
 340   }
 341   jobject jtask_global = (jobject)MSG_task_get_data(task);
 342
 343   /* Convert the global ref into a local ref so that the JVM can free the stuff */
 344   jobject jtask_local = env->NewLocalRef(jtask_global);
 345   env->DeleteGlobalRef(jtask_global);
 346   MSG_task_set_data(task, nullptr);
 347
 348   env->ReleaseStringUTFChars(jalias, alias);
 349
 350   return (jobject) jtask_local;
 351 }
 352
 353 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_irecvBounded(JNIEnv * env, jclass cls, jstring jmailbox,
 354                                                                  jdouble rate)
 355 {
 356   jclass comm_class = env->FindClass("org/simgrid/msg/Comm");
 357   if (not comm_class)
 358     return nullptr;
 359
 360   // pointer to store the task object pointer.
 361   msg_task_t* task = xbt_new0(msg_task_t, 1);
 362
 363   jobject jcomm = env->NewObject(comm_class, jtask_method_Comm_constructor);
 364   if (not jcomm) {
 365     jxbt_throw_jni(env, "Can't create a Comm object.");
 366     return nullptr;
 367   }
 368
 369   const char* mailbox = env->GetStringUTFChars(jmailbox, 0);
 370   msg_comm_t comm     = MSG_task_irecv_bounded(task, mailbox, static_cast<double>(rate));
 371   env->ReleaseStringUTFChars(jmailbox, mailbox);
 372
 373   env->SetLongField(jcomm, jtask_field_Comm_bind, (jlong) (uintptr_t)(comm));
 374   env->SetLongField(jcomm, jtask_field_Comm_taskBind, (jlong) (uintptr_t)(task));
 375   env->SetBooleanField(jcomm, jtask_field_Comm_receiving, JNI_TRUE);
 376
 377   return jcomm;
 378 }
 379
 380 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_isend(JNIEnv *env, jobject jtask, jstring jmailbox)
 381 {
 382   msg_comm_t comm;
 383
 384   jclass comm_class = env->FindClass("org/simgrid/msg/Comm");
 385
 386   if (not comm_class)
 387     return nullptr;
 388
 389   jobject jcomm       = env->NewObject(comm_class, jtask_method_Comm_constructor);
 390   const char* mailbox = env->GetStringUTFChars(jmailbox, 0);
 391
 392   msg_task_t task = jtask_to_native(jtask, env);
 393
 394   if (not task) {
 395     env->ReleaseStringUTFChars(jmailbox, mailbox);
 396     env->DeleteLocalRef(jcomm);
 397     jxbt_throw_notbound(env, "task", jtask);
 398         return nullptr;
 399   }
 400
 401   MSG_task_set_data(task, (void *) env->NewGlobalRef(jtask));
 402   comm = MSG_task_isend(task,mailbox);
 403
 404   env->SetLongField(jcomm, jtask_field_Comm_bind, (jlong) (uintptr_t)(comm));
 405   env->SetLongField(jcomm, jtask_field_Comm_taskBind, (jlong) (uintptr_t)(nullptr));
 406   env->SetBooleanField(jcomm, jtask_field_Comm_receiving, JNI_FALSE);
 407
 408   env->ReleaseStringUTFChars(jmailbox, mailbox);
 409
 410   return jcomm;
 411 }
 412
 413 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_isendBounded(JNIEnv *env, jobject jtask, jstring jmailbox,
 414                                                                  jdouble maxrate)
 415 {
 416   msg_task_t task;
 417   jobject jcomm;
 418   msg_comm_t comm;
 419   const char *mailbox;
 420
 421   jclass comm_class = env->FindClass("org/simgrid/msg/Comm");
 422   if (not comm_class)
 423     return nullptr;
 424
 425   jcomm = env->NewObject(comm_class, jtask_method_Comm_constructor);
 426   mailbox = env->GetStringUTFChars(jmailbox, 0);
 427
 428   task = jtask_to_native(jtask, env);
 429
 430   if (not task) {
 431     env->ReleaseStringUTFChars(jmailbox, mailbox);
 432     env->DeleteLocalRef(jcomm);
 433     jxbt_throw_notbound(env, "task", jtask);
 434         return nullptr;
 435   }
 436
 437   MSG_task_set_data(task, (void *) env->NewGlobalRef(jtask));
 438   comm = MSG_task_isend_bounded(task,mailbox,maxrate);
 439
 440   env->SetLongField(jcomm, jtask_field_Comm_bind, (jlong) (uintptr_t)(comm));
 441   env->SetLongField(jcomm, jtask_field_Comm_taskBind, (jlong) (uintptr_t)(nullptr));
 442   env->SetBooleanField(jcomm, jtask_field_Comm_receiving, JNI_FALSE);
 443
 444   env->ReleaseStringUTFChars(jmailbox, mailbox);
 445
 446   return jcomm;
 447 }
 448
 449 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_nativeFinalize(JNIEnv * env, jobject jtask)
 450 {
 451   msg_task_t task = jtask_to_native(jtask, env);
 452
 453   if (not task) {
 454     jxbt_throw_notbound(env, "task", jtask);
 455     return;
 456     }
 457
 458     MSG_task_destroy(task);
 459 }
 460
 461 static void msg_task_cancel_on_failed_dsend(void*t) {
 462   msg_task_t task = (msg_task_t) t;
 463   JNIEnv *env =get_current_thread_env();
 464   jobject jtask_global = (jobject) MSG_task_get_data(task);
 465
 466   /* Destroy the global ref so that the JVM can free the stuff */
 467   env->DeleteGlobalRef(jtask_global);
 468   MSG_task_set_data(task, nullptr);
 469   MSG_task_destroy(task);
 470 }
 471
 472 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_dsend(JNIEnv * env, jobject jtask, jstring jalias)
 473 {
 474   const char *alias = env->GetStringUTFChars(jalias, 0);
 475
 476   msg_task_t task = jtask_to_native(jtask, env);
 477
 478   if (not task) {
 479     env->ReleaseStringUTFChars(jalias, alias);
 480     jxbt_throw_notbound(env, "task", jtask);
 481     return;
 482   }
 483
 484   /* Pass a global ref to the Jtask into the Ctask so that the receiver can use it */
 485   MSG_task_set_data(task, (void *) env->NewGlobalRef(jtask));
 486   MSG_task_dsend(task, alias, msg_task_cancel_on_failed_dsend);
 487
 488   env->ReleaseStringUTFChars(jalias, alias);
 489 }
 490
 491 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_dsendBounded(JNIEnv * env, jobject jtask, jstring jalias,
 492                                                               jdouble maxrate)
 493 {
 494   const char *alias = env->GetStringUTFChars(jalias, 0);
 495
 496   msg_task_t task = jtask_to_native(jtask, env);
 497
 498   if (not task) {
 499     env->ReleaseStringUTFChars(jalias, alias);
 500     jxbt_throw_notbound(env, "task", jtask);
 501     return;
 502   }
 503
 504   /* Pass a global ref to the Jtask into the Ctask so that the receiver can use it */
 505   MSG_task_set_data(task, (void *) env->NewGlobalRef(jtask));
 506   MSG_task_dsend_bounded(task, alias, msg_task_cancel_on_failed_dsend,static_cast<double>(maxrate));
 507
 508   env->ReleaseStringUTFChars(jalias, alias);
 509 }
 510
 511 JNIEXPORT jboolean JNICALL Java_org_simgrid_msg_Task_listen(JNIEnv * env, jclass cls, jstring jalias)
 512 {
 513   const char *alias = env->GetStringUTFChars(jalias, 0);
 514   int rv = MSG_task_listen(alias);
 515   env->ReleaseStringUTFChars(jalias, alias);
 516
 517   return (jboolean) rv;
 518 }
 519
 520 JNIEXPORT jint JNICALL Java_org_simgrid_msg_Task_listenFrom(JNIEnv * env, jclass cls, jstring jalias)
 521 {
 522   const char *alias = env->GetStringUTFChars(jalias, 0);
 523   int rv = MSG_task_listen_from(alias);
 524   env->ReleaseStringUTFChars(jalias, alias);
 525
 526   return (jint) rv;
 527 }
 528 }