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