Merge pull request #649 from dawgfoto/fix11378

fix Issue 11378 - implicit runtime initialization/finalization is broken

Author: WalterBright

posix.mak

@@ -169,7 +169,7 @@ $(DRUNTIME): $(OBJS) $(SRCS)
 	$(DMD) -lib -of$(DRUNTIME) -Xfdruntime.json $(DFLAGS) $(SRCS) $(OBJS)
 
 UT_MODULES:=$(patsubst src/%.d,$(OBJDIR)/%,$(SRCS))
-ADDITIONAL_TESTS:=
+ADDITIONAL_TESTS:=test/init_fini
 ADDITIONAL_TESTS+=$(if $(findstring $(OS),linux),test/shared,)
 
 unittest : $(UT_MODULES) $(addsuffix /.run,$(ADDITIONAL_TESTS))
@@ -215,8 +215,12 @@ $(OBJDIR)/% : $(OBJDIR)/test_runner
 # succeeded, render the file new again
 	@touch $@
 
-test/%/.run: test/%/Makefile $(DRUNTIMESO)
-	$(QUIET)$(MAKE) -C test/$* MODEL=$(MODEL) OS=$(OS) DMD=$(abspath $(DMD)) DRUNTIMESO=$(abspath $(DRUNTIMESO)) QUIET=$(QUIET)
+test/init_fini/.run: $(DRUNTIME)
+test/shared/.run: $(DRUNTIMESO)
+
+test/%/.run: test/%/Makefile
+	$(QUIET)$(MAKE) -C test/$* MODEL=$(MODEL) OS=$(OS) DMD=$(abspath $(DMD)) \
+		DRUNTIME=$(abspath $(DRUNTIME)) DRUNTIMESO=$(abspath $(DRUNTIMESO)) QUIET=$(QUIET)
 
 detab:
 	detab $(MANIFEST)

src/core/runtime.d

@@ -24,6 +24,11 @@ version (Windows) extern (C) void* rt_loadLibraryW(const wchar_t* name);
 /// C interface for Runtime.unloadLibrary, returns 1/0 instead of bool
 extern (C) int rt_unloadLibrary(void* ptr);
 
+/// C interface for Runtime.initialize, returns 1/0 instead of bool
+extern(C) int rt_init();
+/// C interface for Runtime.terminate, returns 1/0 instead of bool
+extern(C) int rt_term();
+
 private
 {
     alias bool function() ModuleUnitTester;
@@ -37,8 +42,6 @@ private
     extern (C) TraceHandler rt_getTraceHandler();
 
     alias void delegate( Throwable ) ExceptionHandler;
-    extern (C) bool rt_init( ExceptionHandler dg = null );
-    extern (C) bool rt_term( ExceptionHandler dg = null );
 
     extern (C) void* thread_stackBottom();
 
@@ -101,40 +104,42 @@ struct Runtime
      * Initializes the runtime.  This call is to be used in instances where the
      * standard program initialization process is not executed.  This is most
      * often in shared libraries or in libraries linked to a C program.
-     *
-     * Params:
-     *  dg = A delegate which will receive any exception thrown during the
-     *       initialization process or null if such exceptions should be
-     *       discarded.
+     * If the runtime was already successfully initialized this returns true.
+     * Each call to initialize must be paired by a call to $(LREF, terminate).
      *
      * Returns:
-     *  true if initialization succeeds and false if initialization fails.
+     *  true if initialization succeeded or false if initialization failed.
      */
-    static bool initialize( ExceptionHandler dg = null )
+    static bool initialize()
+    {
+        return !!rt_init();
+    }
+
+    deprecated("Please use the overload of Runtime.initialize that takes no argument.")
+    static bool initialize(ExceptionHandler dg = null)
     {
-        return rt_init( dg );
+        return !!rt_init();
     }
 
 
     /**
-     * Terminates the runtime. This call is to be used in instances
-     * where the standard program termination process will not be not
-     * executed. This is most often in shared libraries or in
-     * libraries linked to a C program. All non-daemon threads must be
-     * joined or detached prior to calling this function. See also
-     * $(CXREF thread, thread_joinAll) and $(CXREF thread, thread_detachThis).
-     *
-     * Params:
-     *  dg = A delegate which will receive any exception thrown during the
-     *       termination process or null if such exceptions should be
-     *       discarded.
+     * Terminates the runtime.  This call is to be used in instances where the
+     * standard program termination process will not be not executed.  This is
+     * most often in shared libraries or in libraries linked to a C program.
+     * If the runtime was not successfully initialized the function returns false.
      *
      * Returns:
-     *  true if termination succeeds and false if termination fails.
+     *  true if termination succeeded or false if termination failed.
      */
-    static bool terminate( ExceptionHandler dg = null )
+    static bool terminate()
+    {
+        return !!rt_term();
+    }
+
+    deprecated("Please use the overload of Runtime.terminate that takes no argument.")
+    static bool terminate(ExceptionHandler dg = null)
     {
-        return rt_term( dg );
+        return !!rt_term();
     }
 
 

src/rt/dmain2.d

@@ -148,17 +148,25 @@ extern (C) __gshared bool rt_trapExceptions = true;
 
 alias void delegate(Throwable) ExceptionHandler;
 
+/**
+ * Keep track of how often rt_init/rt_term were called.
+ */
+shared size_t _initCount;
+
 /**********************************************
  * Initialize druntime.
  * If a C program wishes to call D code, and there's no D main(), then it
  * must call rt_init() and rt_term().
- * If it fails, call dg. Except that what dg might be
- * able to do is undetermined, since the state of druntime
- * will not be known.
- * This needs rethinking.
  */
-extern (C) bool rt_init(ExceptionHandler dg = null)
+extern (C) int rt_init()
 {
+    /* @@BUG 11380 @@ Need to synchronize rt_init/rt_term calls for
+       version (Shared) druntime, because multiple C threads might
+       initialize different D libraries without knowing about the
+       shared druntime. Also we need to attach any thread that calls
+       rt_init. */
+    if (_initCount++) return 1;
+
     _STI_monitor_staticctor();
     _STI_critical_init();
 
@@ -169,68 +177,45 @@ extern (C) bool rt_init(ExceptionHandler dg = null)
         initStaticDataGC();
         rt_moduleCtor();
         rt_moduleTlsCtor();
-        return true;
+        return 1;
     }
-    catch (Throwable e)
+    catch (Throwable t)
     {
-        /* Note that if we get here, the runtime is in an unknown state.
-         * I'm not sure what the point of calling dg is.
-         */
-        if (dg)
-            dg(e);
-        else
-            throw e;    // rethrow, don't silently ignore error
-        /* Rethrow, and the two STD functions aren't called?
-         * This needs rethinking.
-         */
+        _initCount = 0;
+        printThrowable(t);
     }
     _STD_critical_term();
     _STD_monitor_staticdtor();
-    return false;
+    return 0;
 }
 
 /**********************************************
  * Terminate use of druntime.
- * If it fails, call dg. Except that what dg might be
- * able to do is undetermined, since the state of druntime
- * will not be known.
- * This needs rethinking.
  */
-extern (C) bool rt_term(ExceptionHandler dg = null)
+extern (C) int rt_term()
 {
+    if (!_initCount) return 0; // was never initialized
+    if (--_initCount) return 1;
+
     try
     {
-        /* Check that all other non-daemon threads have finished
-         * execution before calling the shared module destructors.
-         * Calling thread_joinAll here would be too late because other
-         * shared libraries might have already been
-         * destructed/unloaded.
-         */
-        import core.thread : Thread;
-        auto tthis = Thread.getThis();
-        foreach (t; Thread)
-        {
-            if (t !is tthis && t.isRunning && !t.isDaemon)
-                assert(0, "Can only call rt_term when all non-daemon threads have been joined or detached.");
-        }
-
         rt_moduleTlsDtor();
+        thread_joinAll();
         rt_moduleDtor();
         gc_term();
         finiSections();
-        return true;
+        return 1;
     }
-    catch (Throwable e)
+    catch (Throwable t)
     {
-        if (dg)
-            dg(e);
+        printThrowable(t);
     }
     finally
     {
         _STD_critical_term();
         _STD_monitor_staticdtor();
     }
-    return false;
+    return 0;
 }
 
 /***********************************
@@ -392,29 +377,6 @@ extern (C) int _d_run_main(int argc, char **argv, MainFunc mainFunc)
 
     void tryExec(scope void delegate() dg)
     {
-        static void print(Throwable t)
-        {
-            void sink(const(char)[] buf) nothrow
-            {
-                printf("%.*s", cast(int)buf.length, buf.ptr);
-            }
-
-            for (; t; t = t.next)
-            {
-                t.toString(&sink); sink("\n");
-
-                auto e = cast(Error)t;
-                if (e is null || e.bypassedException is null) continue;
-
-                sink("=== Bypassed ===\n");
-                for (auto t2 = e.bypassedException; t2; t2 = t2.next)
-                {
-                    t2.toString(&sink); sink("\n");
-                }
-                sink("=== ~Bypassed ===\n");
-            }
-        }
-
         if (trapExceptions)
         {
             try
@@ -423,7 +385,7 @@ extern (C) int _d_run_main(int argc, char **argv, MainFunc mainFunc)
             }
             catch (Throwable t)
             {
-                print(t);
+                printThrowable(t);
                 result = EXIT_FAILURE;
             }
         }
@@ -441,33 +403,18 @@ extern (C) int _d_run_main(int argc, char **argv, MainFunc mainFunc)
     //       the user's main function.  If main terminates with an exception,
     //       the exception is handled and then cleanup begins.  An exception
     //       thrown during cleanup, however, will abort the cleanup process.
-    void runMain()
-    {
-        if (runModuleUnitTests())
-            tryExec({ result = mainFunc(args); });
-        else
-            result = EXIT_FAILURE;
-
-        tryExec({thread_joinAll();});
-    }
-
-    void runMainWithInit()
+    void runAll()
     {
         if (rt_init() && runModuleUnitTests())
             tryExec({ result = mainFunc(args); });
         else
             result = EXIT_FAILURE;
 
-        tryExec({thread_joinAll();});
-
         if (!rt_term())
             result = (result == EXIT_SUCCESS) ? EXIT_FAILURE : result;
     }
 
-    version (linux) // initialization is done in rt.sections_linux
-        tryExec(&runMain);
-    else
-        tryExec(&runMainWithInit);
+    tryExec(&runAll);
 
     // Issue 10344: flush stdout and return nonzero on failure
     if (.fflush(.stdout) != 0)
@@ -481,3 +428,26 @@ extern (C) int _d_run_main(int argc, char **argv, MainFunc mainFunc)
 
     return result;
 }
+
+private void printThrowable(Throwable t)
+{
+    void sink(const(char)[] buf) nothrow
+    {
+        printf("%.*s", cast(int)buf.length, buf.ptr);
+    }
+
+    for (; t; t = t.next)
+    {
+        t.toString(&sink); sink("\n");
+
+        auto e = cast(Error)t;
+        if (e is null || e.bypassedException is null) continue;
+
+        sink("=== Bypassed ===\n");
+        for (auto t2 = e.bypassedException; t2; t2 = t2.next)
+        {
+            t2.toString(&sink); sink("\n");
+        }
+        sink("=== ~Bypassed ===\n");
+    }
+}