Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Move ForcefulKillException to the root namespace, along with the other exceptions
[simgrid.git] / 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([&rv, &task, &alias, &jtimeout]() {
291         rv = MSG_task_receive_ext(&task, alias, (double)jtimeout, /*host*/ nullptr);
292       })) {
293     jxbt_throw_by_name(env, "org/simgrid/msg/ProcessKilledError", "Process killed");
294   }
295   env->ReleaseStringUTFChars(jalias, alias);
296   if (env->ExceptionOccurred())
297     return nullptr;
298   if (rv != MSG_OK) {
299     jmsg_throw_status(env, rv);
300     return nullptr;
301   }
302   jobject jtask_global = (jobject) MSG_task_get_data(task);
303
304   /* Convert the global ref into a local ref so that the JVM can free the stuff */
305   jobject jtask_local = env->NewLocalRef(jtask_global);
306   env->DeleteGlobalRef(jtask_global);
307   MSG_task_set_data(task, nullptr);
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 (not comm_class)
315     return nullptr;
316
317   //pointer to store the task object pointer.
318   msg_task_t* task = new msg_task_t(nullptr);
319   /* There should be a cache here */
320
321   jobject jcomm = env->NewObject(comm_class, jtask_method_Comm_constructor);
322   if (not jcomm) {
323     jxbt_throw_jni(env, "Can't create a Comm object.");
324     return nullptr;
325   }
326
327   const char* mailbox = env->GetStringUTFChars(jmailbox, 0);
328   msg_comm_t comm     = MSG_task_irecv(task, mailbox);
329   env->ReleaseStringUTFChars(jmailbox, mailbox);
330
331   env->SetLongField(jcomm, jtask_field_Comm_bind, (jlong) (uintptr_t)(comm));
332   env->SetLongField(jcomm, jtask_field_Comm_taskBind, (jlong) (uintptr_t)(task));
333   env->SetBooleanField(jcomm, jtask_field_Comm_receiving, JNI_TRUE);
334
335   return jcomm;
336 }
337
338 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_receiveBounded(JNIEnv* env, jclass cls, jstring jalias,
339                                                                    jdouble jtimeout, jdouble rate)
340 {
341   msg_task_t task = nullptr;
342
343   const char *alias = env->GetStringUTFChars(jalias, 0);
344   msg_error_t res   = MSG_task_receive_ext_bounded(&task, alias, static_cast<double>(jtimeout), /*host*/ nullptr,
345                                                  static_cast<double>(rate));
346   if (env->ExceptionOccurred())
347     return nullptr;
348   if (res != MSG_OK) {
349     jmsg_throw_status(env, res);
350     return nullptr;
351   }
352   jobject jtask_global = (jobject)MSG_task_get_data(task);
353
354   /* Convert the global ref into a local ref so that the JVM can free the stuff */
355   jobject jtask_local = env->NewLocalRef(jtask_global);
356   env->DeleteGlobalRef(jtask_global);
357   MSG_task_set_data(task, nullptr);
358
359   env->ReleaseStringUTFChars(jalias, alias);
360
361   return (jobject) jtask_local;
362 }
363
364 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_irecvBounded(JNIEnv * env, jclass cls, jstring jmailbox,
365                                                                  jdouble rate)
366 {
367   jclass comm_class = env->FindClass("org/simgrid/msg/Comm");
368   if (not comm_class)
369     return nullptr;
370
371   // pointer to store the task object pointer.
372   msg_task_t* task = new msg_task_t(nullptr);
373
374   jobject jcomm = env->NewObject(comm_class, jtask_method_Comm_constructor);
375   if (not jcomm) {
376     jxbt_throw_jni(env, "Can't create a Comm object.");
377     return nullptr;
378   }
379
380   const char* mailbox = env->GetStringUTFChars(jmailbox, 0);
381   msg_comm_t comm     = MSG_task_irecv_bounded(task, mailbox, static_cast<double>(rate));
382   env->ReleaseStringUTFChars(jmailbox, mailbox);
383
384   env->SetLongField(jcomm, jtask_field_Comm_bind, (jlong) (uintptr_t)(comm));
385   env->SetLongField(jcomm, jtask_field_Comm_taskBind, (jlong) (uintptr_t)(task));
386   env->SetBooleanField(jcomm, jtask_field_Comm_receiving, JNI_TRUE);
387
388   return jcomm;
389 }
390
391 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_isend(JNIEnv *env, jobject jtask, jstring jmailbox)
392 {
393   msg_comm_t comm;
394
395   jclass comm_class = env->FindClass("org/simgrid/msg/Comm");
396
397   if (not comm_class)
398     return nullptr;
399
400   jobject jcomm       = env->NewObject(comm_class, jtask_method_Comm_constructor);
401   const char* mailbox = env->GetStringUTFChars(jmailbox, 0);
402
403   msg_task_t task = jtask_to_native(jtask, env);
404
405   if (not task) {
406     env->ReleaseStringUTFChars(jmailbox, mailbox);
407     env->DeleteLocalRef(jcomm);
408     jxbt_throw_notbound(env, "task", jtask);
409         return nullptr;
410   }
411
412   MSG_task_set_data(task, (void *) env->NewGlobalRef(jtask));
413   comm = MSG_task_isend(task,mailbox);
414
415   env->SetLongField(jcomm, jtask_field_Comm_bind, (jlong) (uintptr_t)(comm));
416   env->SetLongField(jcomm, jtask_field_Comm_taskBind, (jlong) (uintptr_t)(nullptr));
417   env->SetBooleanField(jcomm, jtask_field_Comm_receiving, JNI_FALSE);
418
419   env->ReleaseStringUTFChars(jmailbox, mailbox);
420
421   return jcomm;
422 }
423
424 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_isendBounded(JNIEnv *env, jobject jtask, jstring jmailbox,
425                                                                  jdouble maxrate)
426 {
427   msg_task_t task;
428   jobject jcomm;
429   msg_comm_t comm;
430   const char *mailbox;
431
432   jclass comm_class = env->FindClass("org/simgrid/msg/Comm");
433   if (not comm_class)
434     return nullptr;
435
436   jcomm = env->NewObject(comm_class, jtask_method_Comm_constructor);
437   mailbox = env->GetStringUTFChars(jmailbox, 0);
438
439   task = jtask_to_native(jtask, env);
440
441   if (not task) {
442     env->ReleaseStringUTFChars(jmailbox, mailbox);
443     env->DeleteLocalRef(jcomm);
444     jxbt_throw_notbound(env, "task", jtask);
445         return nullptr;
446   }
447
448   MSG_task_set_data(task, (void *) env->NewGlobalRef(jtask));
449   comm = MSG_task_isend_bounded(task,mailbox,maxrate);
450
451   env->SetLongField(jcomm, jtask_field_Comm_bind, (jlong) (uintptr_t)(comm));
452   env->SetLongField(jcomm, jtask_field_Comm_taskBind, (jlong) (uintptr_t)(nullptr));
453   env->SetBooleanField(jcomm, jtask_field_Comm_receiving, JNI_FALSE);
454
455   env->ReleaseStringUTFChars(jmailbox, mailbox);
456
457   return jcomm;
458 }
459
460 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_nativeFinalize(JNIEnv * env, jobject jtask)
461 {
462   msg_task_t task = jtask_to_native(jtask, env);
463
464   if (not task) {
465     jxbt_throw_notbound(env, "task", jtask);
466     return;
467     }
468
469     MSG_task_destroy(task);
470 }
471
472 static void msg_task_cancel_on_failed_dsend(void*t) {
473   msg_task_t task = (msg_task_t) t;
474   JNIEnv* env     = get_current_thread_env();
475   if (env) {
476     jobject jtask_global = (jobject)MSG_task_get_data(task);
477     /* Destroy the global ref so that the JVM can free the stuff */
478     env->DeleteGlobalRef(jtask_global);
479     /* Don't free the C data here, to avoid a race condition with the GC also sometimes doing so.
480      * A rare memleak is seen as preferable to a rare "free(): invalid pointer" failure that
481      * proves really hard to debug.
482      */
483   }
484   MSG_task_set_data(task, nullptr);
485 }
486
487 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_dsend(JNIEnv * env, jobject jtask, jstring jalias)
488 {
489   const char *alias = env->GetStringUTFChars(jalias, 0);
490
491   msg_task_t task = jtask_to_native(jtask, env);
492
493   if (not task) {
494     env->ReleaseStringUTFChars(jalias, alias);
495     jxbt_throw_notbound(env, "task", jtask);
496     return;
497   }
498
499   /* Pass a global ref to the Jtask into the Ctask so that the receiver can use it */
500   MSG_task_set_data(task, (void *) env->NewGlobalRef(jtask));
501   MSG_task_dsend(task, alias, msg_task_cancel_on_failed_dsend);
502
503   env->ReleaseStringUTFChars(jalias, alias);
504 }
505
506 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_dsendBounded(JNIEnv * env, jobject jtask, jstring jalias,
507                                                               jdouble maxrate)
508 {
509   const char *alias = env->GetStringUTFChars(jalias, 0);
510
511   msg_task_t task = jtask_to_native(jtask, env);
512
513   if (not task) {
514     env->ReleaseStringUTFChars(jalias, alias);
515     jxbt_throw_notbound(env, "task", jtask);
516     return;
517   }
518
519   /* Pass a global ref to the Jtask into the Ctask so that the receiver can use it */
520   MSG_task_set_data(task, (void *) env->NewGlobalRef(jtask));
521   MSG_task_dsend_bounded(task, alias, msg_task_cancel_on_failed_dsend,static_cast<double>(maxrate));
522
523   env->ReleaseStringUTFChars(jalias, alias);
524 }
525
526 JNIEXPORT jboolean JNICALL Java_org_simgrid_msg_Task_listen(JNIEnv * env, jclass cls, jstring jalias)
527 {
528   const char *alias = env->GetStringUTFChars(jalias, 0);
529   int rv = MSG_task_listen(alias);
530   env->ReleaseStringUTFChars(jalias, alias);
531
532   return (jboolean) rv;
533 }
534
535 JNIEXPORT jint JNICALL Java_org_simgrid_msg_Task_listenFrom(JNIEnv * env, jclass cls, jstring jalias)
536 {
537   const char *alias = env->GetStringUTFChars(jalias, 0);
538   int rv = MSG_task_listen_from(alias);
539   env->ReleaseStringUTFChars(jalias, alias);
540
541   return (jint) rv;
542 }