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.h"
  11 #include "jmsg_host.h"
  12 #include "jmsg_task.h"
  13 #include "jmsg_process.h"
  14 #include "jxbt_utilities.h"
  15
  16 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(java);
  17
  18 SG_BEGIN_DECL()
  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 (!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, bprintf("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 (!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 (!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 (!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 (!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 (!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 (!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 (!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 (!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 (!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 (!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 (!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 (!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                                                             jobject jhost)
 279 {
 280   msg_task_t task = nullptr;
 281   msg_host_t host = nullptr;
 282
 283   if (jhost) {
 284     host = jhost_get_native(env, jhost);
 285
 286     if (!host) {
 287       jxbt_throw_notbound(env, "host", jhost);
 288       return nullptr;
 289     }
 290   }
 291
 292   const char *alias = env->GetStringUTFChars(jalias, 0);
 293   msg_error_t rv = MSG_task_receive_ext(&task, alias, (double) jtimeout, host);
 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
 309   return (jobject) jtask_local;
 310 }
 311
 312 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_irecv(JNIEnv * env, jclass cls, jstring jmailbox) {
 313   jclass comm_class = env->FindClass("org/simgrid/msg/Comm");
 314   if (!comm_class)
 315     return nullptr;
 316
 317   //pointer to store the task object pointer.
 318   msg_task_t *task = xbt_new(msg_task_t,1);
 319   *task = nullptr;
 320   /* There should be a cache here */
 321
 322   jobject jcomm = env->NewObject(comm_class, jtask_method_Comm_constructor);
 323   if (!jcomm) {
 324     jxbt_throw_jni(env, "Can't create a Comm object.");
 325     return nullptr;
 326   }
 327
 328   const char* mailbox = env->GetStringUTFChars(jmailbox, 0);
 329   msg_comm_t comm     = MSG_task_irecv(task, mailbox);
 330   env->ReleaseStringUTFChars(jmailbox, mailbox);
 331
 332   env->SetLongField(jcomm, jtask_field_Comm_bind, (jlong) (uintptr_t)(comm));
 333   env->SetLongField(jcomm, jtask_field_Comm_taskBind, (jlong) (uintptr_t)(task));
 334   env->SetBooleanField(jcomm, jtask_field_Comm_receiving, JNI_TRUE);
 335
 336   return jcomm;
 337 }
 338
 339 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_receiveBounded(JNIEnv * env, jclass cls, jstring jalias,
 340                                                                    jdouble jtimeout, jobject jhost, jdouble rate)
 341 {
 342   msg_error_t rv;
 343   msg_task_t *task = xbt_new(msg_task_t,1);
 344   *task = nullptr;
 345
 346   msg_host_t host = nullptr;
 347
 348   if (jhost) {
 349     host = jhost_get_native(env, jhost);
 350
 351     if (!host) {
 352       jxbt_throw_notbound(env, "host", jhost);
 353       return nullptr;
 354     }
 355   }
 356
 357   const char *alias = env->GetStringUTFChars(jalias, 0);
 358   rv = MSG_task_receive_ext_bounded(task, alias, static_cast<double>(jtimeout), host, static_cast<double>(rate));
 359   if (env->ExceptionOccurred())
 360     return nullptr;
 361   if (rv != MSG_OK) {
 362     jmsg_throw_status(env,rv);
 363     return nullptr;
 364   }
 365   jobject jtask_global = (jobject) MSG_task_get_data(*task);
 366
 367   /* Convert the global ref into a local ref so that the JVM can free the stuff */
 368   jobject jtask_local = env->NewLocalRef(jtask_global);
 369   env->DeleteGlobalRef(jtask_global);
 370   MSG_task_set_data(*task, nullptr);
 371
 372   env->ReleaseStringUTFChars(jalias, alias);
 373
 374   xbt_free(task);
 375
 376   return (jobject) jtask_local;
 377 }
 378
 379 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_irecvBounded(JNIEnv * env, jclass cls, jstring jmailbox,
 380                                                                  jdouble rate)
 381 {
 382   jclass comm_class = env->FindClass("org/simgrid/msg/Comm");
 383   if (!comm_class)
 384     return nullptr;
 385
 386   // pointer to store the task object pointer.
 387   msg_task_t* task = xbt_new0(msg_task_t, 1);
 388
 389   jobject jcomm = env->NewObject(comm_class, jtask_method_Comm_constructor);
 390   if (!jcomm) {
 391     jxbt_throw_jni(env, "Can't create a Comm object.");
 392     return nullptr;
 393   }
 394
 395   const char* mailbox = env->GetStringUTFChars(jmailbox, 0);
 396   msg_comm_t comm     = MSG_task_irecv_bounded(task, mailbox, static_cast<double>(rate));
 397   env->ReleaseStringUTFChars(jmailbox, mailbox);
 398
 399   env->SetLongField(jcomm, jtask_field_Comm_bind, (jlong) (uintptr_t)(comm));
 400   env->SetLongField(jcomm, jtask_field_Comm_taskBind, (jlong) (uintptr_t)(task));
 401   env->SetBooleanField(jcomm, jtask_field_Comm_receiving, JNI_TRUE);
 402
 403   return jcomm;
 404 }
 405
 406 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_isend(JNIEnv *env, jobject jtask, jstring jmailbox)
 407 {
 408   msg_comm_t comm;
 409
 410   jclass comm_class = env->FindClass("org/simgrid/msg/Comm");
 411
 412   if (!comm_class) return nullptr;
 413
 414   jobject jcomm       = env->NewObject(comm_class, jtask_method_Comm_constructor);
 415   const char* mailbox = env->GetStringUTFChars(jmailbox, 0);
 416
 417   msg_task_t task = jtask_to_native(jtask, env);
 418
 419   if (!task) {
 420     env->ReleaseStringUTFChars(jmailbox, mailbox);
 421     env->DeleteLocalRef(jcomm);
 422     jxbt_throw_notbound(env, "task", jtask);
 423         return nullptr;
 424   }
 425
 426   MSG_task_set_data(task, (void *) env->NewGlobalRef(jtask));
 427   comm = MSG_task_isend(task,mailbox);
 428
 429   env->SetLongField(jcomm, jtask_field_Comm_bind, (jlong) (uintptr_t)(comm));
 430   env->SetLongField(jcomm, jtask_field_Comm_taskBind, (jlong) (uintptr_t)(nullptr));
 431   env->SetBooleanField(jcomm, jtask_field_Comm_receiving, JNI_FALSE);
 432
 433   env->ReleaseStringUTFChars(jmailbox, mailbox);
 434
 435   return jcomm;
 436 }
 437
 438 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_isendBounded(JNIEnv *env, jobject jtask, jstring jmailbox,
 439                                                                  jdouble maxrate)
 440 {
 441   msg_task_t task;
 442   jobject jcomm;
 443   msg_comm_t comm;
 444   const char *mailbox;
 445
 446   jclass comm_class = env->FindClass("org/simgrid/msg/Comm");
 447   if (!comm_class)
 448     return nullptr;
 449
 450   jcomm = env->NewObject(comm_class, jtask_method_Comm_constructor);
 451   mailbox = env->GetStringUTFChars(jmailbox, 0);
 452
 453   task = jtask_to_native(jtask, env);
 454
 455   if (!task) {
 456     env->ReleaseStringUTFChars(jmailbox, mailbox);
 457     env->DeleteLocalRef(jcomm);
 458     jxbt_throw_notbound(env, "task", jtask);
 459         return nullptr;
 460   }
 461
 462   MSG_task_set_data(task, (void *) env->NewGlobalRef(jtask));
 463   comm = MSG_task_isend_bounded(task,mailbox,maxrate);
 464
 465   env->SetLongField(jcomm, jtask_field_Comm_bind, (jlong) (uintptr_t)(comm));
 466   env->SetLongField(jcomm, jtask_field_Comm_taskBind, (jlong) (uintptr_t)(nullptr));
 467   env->SetBooleanField(jcomm, jtask_field_Comm_receiving, JNI_FALSE);
 468
 469   env->ReleaseStringUTFChars(jmailbox, mailbox);
 470
 471   return jcomm;
 472 }
 473
 474 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_nativeFinalize(JNIEnv * env, jobject jtask)
 475 {
 476   msg_task_t task = jtask_to_native(jtask, env);
 477
 478   if (!task) {
 479     jxbt_throw_notbound(env, "task", jtask);
 480     return;
 481     }
 482
 483     MSG_task_destroy(task);
 484 }
 485
 486 static void msg_task_cancel_on_failed_dsend(void*t) {
 487   msg_task_t task = (msg_task_t) t;
 488   JNIEnv *env =get_current_thread_env();
 489   jobject jtask_global = (jobject) MSG_task_get_data(task);
 490
 491   /* Destroy the global ref so that the JVM can free the stuff */
 492   env->DeleteGlobalRef(jtask_global);
 493   MSG_task_set_data(task, nullptr);
 494   MSG_task_destroy(task);
 495 }
 496
 497 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_dsend(JNIEnv * env, jobject jtask, jstring jalias)
 498 {
 499   const char *alias = env->GetStringUTFChars(jalias, 0);
 500
 501   msg_task_t task = jtask_to_native(jtask, env);
 502
 503   if (!task) {
 504     env->ReleaseStringUTFChars(jalias, alias);
 505     jxbt_throw_notbound(env, "task", jtask);
 506     return;
 507   }
 508
 509   /* Pass a global ref to the Jtask into the Ctask so that the receiver can use it */
 510   MSG_task_set_data(task, (void *) env->NewGlobalRef(jtask));
 511   MSG_task_dsend(task, alias, msg_task_cancel_on_failed_dsend);
 512
 513   env->ReleaseStringUTFChars(jalias, alias);
 514 }
 515
 516 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_dsendBounded(JNIEnv * env, jobject jtask, jstring jalias,
 517                                                               jdouble maxrate)
 518 {
 519   const char *alias = env->GetStringUTFChars(jalias, 0);
 520
 521   msg_task_t task = jtask_to_native(jtask, env);
 522
 523   if (!task) {
 524     env->ReleaseStringUTFChars(jalias, alias);
 525     jxbt_throw_notbound(env, "task", jtask);
 526     return;
 527   }
 528
 529   /* Pass a global ref to the Jtask into the Ctask so that the receiver can use it */
 530   MSG_task_set_data(task, (void *) env->NewGlobalRef(jtask));
 531   MSG_task_dsend_bounded(task, alias, msg_task_cancel_on_failed_dsend,static_cast<double>(maxrate));
 532
 533   env->ReleaseStringUTFChars(jalias, alias);
 534 }
 535
 536 JNIEXPORT jboolean JNICALL Java_org_simgrid_msg_Task_listen(JNIEnv * env, jclass cls, jstring jalias)
 537 {
 538   const char *alias = env->GetStringUTFChars(jalias, 0);
 539   int rv = MSG_task_listen(alias);
 540   env->ReleaseStringUTFChars(jalias, alias);
 541
 542   return (jboolean) rv;
 543 }
 544
 545 JNIEXPORT jint JNICALL Java_org_simgrid_msg_Task_listenFrom(JNIEnv * env, jclass cls, jstring jalias)
 546 {
 547   const char *alias = env->GetStringUTFChars(jalias, 0);
 548   int rv = MSG_task_listen_from(alias);
 549   env->ReleaseStringUTFChars(jalias, alias);
 550
 551   return (jint) rv;
 552 }
 553
 554 SG_END_DECL()