src/bindings/java/JavaContext.cpp

   1 /* context_java - implementation of context switching for java threads */
   2
   3 /* Copyright (c) 2009-2010, 2012-2014. The SimGrid Team.
   4  * All rights reserved.                                                     */
   5
   6 /* This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the license (GNU LGPL) which comes with this package. */
   8
   9 #include <functional>
  10 #include <utility>
  11
  12 #include <xbt/function_types.h>
  13 #include <simgrid/simix.h>
  14 #include <xbt/ex.h>
  15 #include "JavaContext.hpp"
  16 #include "jxbt_utilities.h"
  17 #include "xbt/dynar.h"
  18 #include "../../simix/smx_private.h"
  19 extern JavaVM *__java_vm;
  20
  21 XBT_LOG_NEW_DEFAULT_CATEGORY(jmsg, "MSG for Java(TM)");
  22
  23 namespace simgrid {
  24 namespace java {
  25
  26 simgrid::simix::ContextFactory* java_factory()
  27 {
  28   XBT_INFO("Using regular java threads.");
  29   return new JavaContextFactory();
  30 }
  31
  32 JavaContextFactory::JavaContextFactory()
  33   : ContextFactory("JavaContextFactory")
  34 {
  35 }
  36
  37 JavaContextFactory::~JavaContextFactory()
  38 {
  39 }
  40
  41 JavaContext* JavaContextFactory::self()
  42 {
  43   return (JavaContext*) xbt_os_thread_get_extra_data();
  44 }
  45
  46 JavaContext* JavaContextFactory::create_context(
  47   std::function<void()> code,
  48   void_pfn_smxprocess_t cleanup, smx_process_t process)
  49 {
  50   return this->new_context<JavaContext>(std::move(code), cleanup, process);
  51 }
  52
  53 void JavaContextFactory::run_all()
  54 {
  55   xbt_dynar_t processes = SIMIX_process_get_runnable();
  56   smx_process_t process;
  57   unsigned int cursor;
  58   xbt_dynar_foreach(processes, cursor, process) {
  59     static_cast<JavaContext*>(SIMIX_process_get_context(process))->resume();
  60   }
  61 }
  62
  63 JavaContext::JavaContext(std::function<void()> code,
  64         void_pfn_smxprocess_t cleanup_func,
  65         smx_process_t process)
  66   : Context(std::move(code), cleanup_func, process)
  67 {
  68   static int thread_amount=0;
  69   thread_amount++;
  70
  71   /* If the user provided a function for the process then use it otherwise is the context for maestro */
  72   if (has_code()) {
  73     this->jprocess = nullptr;
  74     this->begin = xbt_os_sem_init(0);
  75     this->end = xbt_os_sem_init(0);
  76
  77     try {
  78        this->thread = xbt_os_thread_create(
  79          nullptr, JavaContext::wrapper, this, nullptr);
  80     }
  81     catch (xbt_ex& ex) {
  82       char* str = bprintf(
  83         "Failed to create context #%d. You may want to switch to Java coroutines to increase your limits (error: %s)."
  84         "See the Install section of simgrid-java documentation (in doc/install.html) for more on coroutines.",
  85         thread_amount, ex.what());
  86       xbt_ex new_exception(str);
  87       new_exception.category = ex.category;
  88       new_exception.value = ex.value;
  89       new_exception.file = __FILE__;
  90       new_exception.line = __LINE__;
  91       new_exception.func = __func__;
  92       std::throw_with_nested(std::move(new_exception));
  93     }
  94   } else {
  95     this->thread = nullptr;
  96     xbt_os_thread_set_extra_data(this);
  97   }
  98 }
  99
 100 JavaContext::~JavaContext()
 101 {
 102   if (this->thread) {
 103     // We are not in maestro context
 104     xbt_os_thread_join(this->thread, nullptr);
 105     xbt_os_sem_destroy(this->begin);
 106     xbt_os_sem_destroy(this->end);
 107   }
 108 }
 109
 110 void* JavaContext::wrapper(void *data)
 111 {
 112   JavaContext* context = (JavaContext*)data;
 113   xbt_os_thread_set_extra_data(context);
 114   //Attach the thread to the JVM
 115
 116   JNIEnv *env;
 117   XBT_ATTRIB_UNUSED jint error =
 118     __java_vm->AttachCurrentThread((void **) &env, nullptr);
 119   xbt_assert((error == JNI_OK), "The thread could not be attached to the JVM");
 120   context->jenv = get_current_thread_env();
 121   //Wait for the first scheduling round to happen.
 122   xbt_os_sem_acquire(context->begin);
 123   //Create the "Process" object if needed.
 124   (*context)();
 125   context->stop();
 126   return nullptr;
 127 }
 128
 129 void JavaContext::stop()
 130 {
 131   /* I am the current process and I am dying */
 132   if (this->iwannadie) {
 133     this->iwannadie = 0;
 134     JNIEnv *env = get_current_thread_env();
 135     XBT_DEBUG("Gonna launch Killed Error");
 136     // TODO Adrien, if the process has not been created at the java layer, why should we raise the exception/error at the java level (this happens
 137     // for instance during the migration process that creates at the C level two processes: one on the SRC node and one on the DST node, if the DST process is killed.
 138     // it is not required to raise an exception at the JAVA level, the low level should be able to manage such an issue correctly but this is not the case right now unfortunately ...
 139     // TODO it will be nice to have the name of the process to help the end-user to know which Process has been killed
 140    // jxbt_throw_by_name(env, "org/simgrid/msg/ProcessKilledError", bprintf("Process %s killed :) (file smx_context_java.c)", MSG_process_get_name( (msg_process_t)context) ));
 141     jxbt_throw_by_name(env, "org/simgrid/msg/ProcessKilledError",
 142       bprintf("Process %s killed :) (file JavaContext.cpp)",
 143       simcall_process_get_name(this->process()) ));
 144     XBT_DEBUG("Trigger a cancel error at the C level");
 145     THROWF(cancel_error, 0, "process cancelled");
 146   } else {
 147     Context::stop();
 148     /* detach the thread and kills it */
 149     JNIEnv *env = this->jenv;
 150     env->DeleteGlobalRef(this->jprocess);
 151     XBT_ATTRIB_UNUSED jint error = __java_vm->DetachCurrentThread();
 152     xbt_assert((error == JNI_OK), "The thread couldn't be detached.");
 153     xbt_os_sem_release(this->end);
 154     xbt_os_thread_exit(nullptr);
 155   }
 156 }
 157
 158 void JavaContext::suspend()
 159 {
 160   xbt_os_sem_release(this->end);
 161   xbt_os_sem_acquire(this->begin);
 162 }
 163
 164 // FIXME: inline those functions
 165 void JavaContext::resume()
 166 {
 167   xbt_os_sem_release(this->begin);
 168   xbt_os_sem_acquire(this->end);
 169 }
 170
 171 }
 172 }