Changeset 2016

Timestamp:

04/10/07 17:09:15 (2 years ago)

Author:

jcomellas

Message:

* Added ProcessSemaphore? class and tests in the tango.util.locks.Semaphore module.
* Fixed usage of DDOC macros.
* Removed scope attribute for Logger instances.

Files:

• trunk/example/locks/barrier.d (modified) (1 diff)
• trunk/example/locks/condition.d (modified) (1 diff)
• trunk/example/locks/mutex.d (modified) (1 diff)
• trunk/example/locks/readwritemutex.d (modified) (1 diff)
• trunk/example/locks/semaphore.d (modified) (6 diffs)
• trunk/example/networking/selector.d (modified) (1 diff)
• trunk/tango/util/locks/Barrier.d (modified) (6 diffs)
• trunk/tango/util/locks/Condition.d (modified) (7 diffs)
• trunk/tango/util/locks/LockException.d (modified) (1 diff)
• trunk/tango/util/locks/Mutex.d (modified) (4 diffs)
• trunk/tango/util/locks/ReadWriteMutex.d (modified) (2 diffs)
• trunk/tango/util/locks/Semaphore.d (modified) (4 diffs)

trunk/example/locks/barrier.d

@@ -29 +29 @@
-    debug (barrier)
-    {
-scope 
+
-
-        log.addAppender(new ConsoleAppender(new DateLayout()));

trunk/example/locks/condition.d

@@ -22 +22 @@
-    debug (condition)
-    {
-scope 
+
-
-        log.addAppender(new ConsoleAppender(new DateLayout()));

trunk/example/locks/mutex.d

@@ -25 +25 @@
-    debug (mutex)
-    {
-scope 
+
-
-        log.addAppender(new ConsoleAppender(new DateLayout()));

trunk/example/locks/readwritemutex.d

@@ -30 +30 @@
-    debug (readwritemutex)
-    {
-scope 
+
-
-        log.addAppender(new ConsoleAppender(new DateLayout()));

trunk/example/locks/semaphore.d

@@ -10 +10 @@
-private import tango.util.locks.Mutex;
-private import tango.util.locks.LockException;
+private import tango.core.Exception;
-private import tango.core.Thread;
-
+
+
-private import tango.text.convert.Integer;
+private import tango.sys.Process;
+
-debug (semaphore)
-{
@@ -20 +24 @@
-}
-
+const char[] SemaphoreName = "TestProcessSemaphore";
+
-
-/**
- * Example program for the tango.util.locks.Barrier module.
- */
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-{
-    const uint MaxThreadCount   = 10;
-
-    debug (semaphore)
-    {
-        scope Logger log = Log.getLogger("semaphore");
-
-        log.addAppender(new ConsoleAppender(new DateLayout()));
-
-        log.info("Semaphore test");
-    }
-
-    // Semaphore used in the tests.  Start it "locked" (i.e., its initial
@@ -48 +72 @@
-        debug (semaphore)
-        {
-scope Logger log = Log.getLogger("semaphor
+Logger log = Log.getLogger("semaphore.singl
-
-            log.trace("Starting thread");
@@ -118 +142 @@
-        catch (LockException e)
-        {
-Stderr.formatln("Lock exception caught in Semaphore test thread {0}:\n{1}\n",
-           Thread.getThis().name, e.toUtf8())
+Cerr("Lock exception caught in Semaphore test thread " ~ Thread.getThis().name ~
+":\n" ~ e.toUtf8()).newline
-        }
-        catch (Exception e)
-        {
-
-
-
+
+
+
+
+
+
+
+
-    }
-
@@ -135 +164 @@
-    {
-        thread = new Thread(&semaphoreTestThread);
-
+tango.text.convert.Integer.
-
-        group.add(thread);
@@ -167 +196 @@
-    }
-}
+
+/**
+ * Test for multi-process semaphores: this test works by creating a copy of
+ * this process that tries to acquire the ProcessSemaphore that was created
+ * in this function. If everything works as expected, the attempt should fail,
+ * as the count of the semaphore is set to 1.
+ */
+void testProcessSemaphore(char[] programName)
+{
+    bool success = false;
+
+    debug (semaphore)
+    {
+        Logger log = Log.getLogger("semaphore.multi");
+        Logger childLog = Log.getLogger("semaphore.multi.child");
+
+        log.info("ProcessSemaphore test");
+    }
+
+    try
+    {
+        scope ProcessSemaphore sem = new ProcessSemaphore(SemaphoreName, 1);
+        Process proc = new Process(programName, "2");
+
+        log.trace("Created ProcessSemaphore('" ~ SemaphoreName ~ "')'");
+
+        sem.acquire();
+        debug (semaphore)
+            log.trace("Acquired semaphore in main process");
+
+        debug (semaphore)
+            log.trace("Executing child test process: " ~ proc.toUtf8());
+        proc.execute();
+
+        debug (semaphore)
+        {
+            foreach (line; new LineIterator!(char)(proc.stdout))
+            {
+                childLog.trace(line);
+            }
+        }
+        foreach (line; new LineIterator!(char)(proc.stderr))
+        {
+            Cerr(line).newline;
+        }
+
+        debug (semaphore)
+            log.trace("Waiting for child process to finish");
+        auto result = proc.wait();
+
+        success = (result.reason == Process.Result.Exit && result.status == 2);
+
+        debug (semaphore)
+            log.trace("Releasing semaphore in main process");
+        sem.release();
+    }
+    catch (LockException e)
+    {
+        Cerr("Lock exception caught in ProcessSemaphore main test process:\n" ~ e.toUtf8()).newline;
+    }
+    catch (ProcessException e)
+    {
+        Cerr("Process exception caught in ProcessSemaphore main test process:\n" ~ e.toUtf8()).newline;
+    }
+    catch (Exception e)
+    {
+        Cerr("Unexpected exception caught in ProcessSemaphore main test process:\n" ~ e.toUtf8()).newline;
+    }
+
+    if (success)
+    {
+        debug (semaphore)
+            log.info("The ProcessSemaphore test was successful");
+    }
+    else
+    {
+        debug (semaphore)
+        {
+            log.error("The multi-process semaphore is not working");
+            assert(false);
+        }
+        else
+        {
+            assert(false, "The multi-process semaphore is not working");
+        }
+    }
+}
+
+/**
+ * Test for multi-process semaphores (second process).
+ */
+int testSecondProcessSemaphore()
+{
+    int rc = 0;
+
+    debug (semaphore)
+    {
+        Cout("Starting child process\n");
+    }
+
+    try
+    {
+        scope ProcessSemaphore sem = new ProcessSemaphore(SemaphoreName);
+        bool success;
+
+        success = !sem.tryAcquire();
+        if (success)
+        {
+            debug (semaphore)
+                Cout("Tried to acquire semaphore in child process and failed: OK\n");
+            rc = 2;
+        }
+        else
+        {
+            debug (semaphore)
+            {
+                Cout("Acquired semaphore in child process: this should not have happened\n");
+                Cout("Releasing semaphore in child process\n");
+            }
+            sem.release();
+            rc = 1;
+        }
+    }
+    catch (LockException e)
+    {
+        Cerr("Lock exception caught in ProcessSemaphore child test process:\n" ~ e.toUtf8()).newline;
+    }
+    catch (ProcessException e)
+    {
+        Cerr("Process exception caught in ProcessSemaphore child test process:\n" ~ e.toUtf8()).newline;
+    }
+    catch (Exception e)
+    {
+        Cerr("Unexpected exception caught in ProcessSemaphore child test process:\n" ~ e.toUtf8()).newline;
+    }
+
+    debug (semaphore)
+        Cout("Leaving child process\n");
+
+    return rc;
+}

trunk/example/networking/selector.d

@@ -46 +46 @@
-int main(char[][] args)
-{
-scope Logger
+Logger      
-    Sprint!(char)   sprint  = new Sprint!(char)(256);
-

trunk/tango/util/locks/Barrier.d

@@ -22 +22 @@
-     * This class allows $(D_PARAM count) number of threads to synchronize
-     * their completion of (one round of) a task, which is known as "barrier
-$(D_CODE wait()) on the 
-barrier they 
+wait() on the barrier they
+
-     */
-    public class Barrier
@@ -62 +62 @@
-        /**
-         * Block the caller until all $(D_PARAM count) threads have called
-$(D_CODE Barrier.wait()) and then allow all the caller threads to 
-continue in 
+wait() and then allow all the caller threads to continue in
+
-         */
-        public void wait()
@@ -77 +77 @@
-        /**
-         * Check the $(D_PARAM errorCode) argument against possible values
-$(D_CODE SysError.lastCode()) and throw an exception with the
-description 
+SysError.lastCode() and throw an exception with the description
+
-         *
-         * Params:
@@ -129 +129 @@
-     * This class allows $(D_PARAM count) number of threads to synchronize
-     * their completion of (one round of) a task, which is known as "barrier
-$(D_CODE wait()) on the
-barrier they 
+wait() on the barrier they
+
-     *
-     * Remarks:
@@ -169 +169 @@
-         * efficiently solves the problem of what to do if all the first
-         * generation waiters don't leave the barrier before one of the
-$(D_CODE wait()) again (i.e., starts up the next 
-generation 
+wait() again (i.e., starts up the next  generation
+
-         */
-        SubBarrier[2] _subBarrier;
@@ -203 +203 @@
-        /**
-         * Block the caller until all $(D_PARAM count) threads have called
-$(D_CODE Barrier.wait()) and then allow all the caller threads to 
-continue in 
+wait() and then allow all the caller threads to  continue in
+
-         */
-        public void wait()

trunk/tango/util/locks/Condition.d

@@ -22 +22 @@
- * condition under the protection of a mutual exclusion lock (mutex) until
- * the condition is satisfied. That is, the mutex must have been held by
-
-
-
-
-
-
-
+
+
+
+
+
+
- *
- * Remarks:
-$(D_CODE Condition)
-$(D_CODE pthread_cond_t) from the pthread API. The Windows API (before
-Windows Vista) does not provide a native condition variable, so it is
-emulated with a mutex, a semaphore and an event. The Windows condi
-variable emulation 
-
+Condition
+pthread_cond_t from the pthread API. The Windows API (before Windows Vista)
+does not provide a native condition variable, so it is emulated with a
+mutex, a semaphore and an event. The Windows condition variable emula
+
+,
- *
- * Examples:
@@ -190 +189 @@
-        /**
-         * Block on the condition, or until the specified (relative) amount
-== $(D_CODE Interval.max)
+is equal to Interval.max
-         * there is no timeout.
-         *
@@ -233 +232 @@
-        /**
-         * Check the $(D_PARAM errorCode) argument against possible values
-$(D_CODE SysError.lastCode()) and throw an exception with the
-description 
+SysError.lastCode() and throw an exception with the description
+
-         *
-         * Params:
@@ -475 +474 @@
-        /**
-         * Block on the condition, or until the specified (relative) amount
-== $(D_CODE Interval.max)
+is equal to Interval.max
-         * there is no timeout.
-         *
@@ -599 +598 @@
-        /**
-         * If $(B manual reset) is enabled, sleep till the event becomes
-
-
-
-
+
+
+
-         */
-        public void wait()
@@ -615 +613 @@
-
-        /**
-$(D_CODE wait()
+wait(
-         * $(D_PARAM timeout) is a relative timeout. If the timeout is equal to
-
-
+
-         *
-         * Returns: true if the event was signaled; false if the timeout
@@ -646 +643 @@
-        /**
-         * Check the $(D_PARAM errorCode) argument against possible values
-$(D_CODE SysError.lastCode()) and throw an exception with the
-description 
+SysError.lastCode() and throw an exception with the description
+
-         *
-         * Params:

trunk/tango/util/locks/LockException.d

@@ -237 +237 @@
-    public this(char[] file, uint line)
-    {
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    }
-}

trunk/tango/util/locks/Mutex.d

@@ -23 +23 @@
-     * Mutex wrapper that's only valid for threads in the same process.
-     * This implementation is optimized for locking threads that are in the
-$(D_CODE CRITICAL_SECTION) on Windows and to
-a $(D_CODE pthread_mutex_t) on UNIX. Mutexes on Windows are always
-recursive, even if the $(D_CODE NonRecursive)
+CRITICAL_SECTION on Windows and to a
+pthread_mutex_t on UNIX. Mutexes on Windows are always recursive, even
+if the NonRecursive
-     */
-    public class Mutex
@@ -142 +142 @@
-        /**
-         * Check the $(D_PARAM errorCode) argument against possible values
-$(D_CODE SysError.lastCode()) and throw an exception with the
-description 
+SysError.lastCode() and throw an exception with the description
+
-         *
-         * Params:
@@ -304 +304 @@
-     * Mutex wrapper that's only valid for threads in the same process.
-     * This implementation is optimized for locking threads that are in the
-$(D_CODE CRITICAL_SECTION) on Windows and to
-a $(D_CODE pthread_mutex_t)
-$(D_CODE NonRecursive)
+CRITICAL_SECTION on Windows and to a
+pthread_mutex_t
+NonRecursive
-     */
-    private class Mutex
@@ -483 +483 @@
-        /**
-         * Check the $(D_PARAM errorCode) argument against possible values
-$(D_CODE SysError.lastCode()) and throw an exception with the
-description 
+SysError.lastCode() and throw an exception with the description
+
-         *
-         * Params:

trunk/tango/util/locks/ReadWriteMutex.d

@@ -223 +223 @@
-        /**
-         * Check the $(D_PARAM errorCode) argument against possible values
-$(D_CODE SysError.lastCode()) and throw an exception with the
-description 
+SysError.lastCode() and throw an exception with the description
+
-         *
-         * Params:
@@ -290 +290 @@
-     * Remarks:
-     * Based on the ACE_RW_Mutex class from the
-
+,
-     */
-    public class ReadWriteMutex

trunk/tango/util/locks/Semaphore.d

@@ -129 +129 @@
-        /**
-         * Check the $(D_PARAM errorCode) argument against possible values
-$(D_CODE SysError.lastCode()) and throw an exception with the
-description 
+SysError.lastCode() and throw an exception with the description
+
-         *
-         * Params:
@@ -163 +163 @@
-            switch (errorCode)
-            {
+                case EACCES:
+                    throw new AccessDeniedException(file, line);
+                    // break;
+
+                case EEXIST:
+                    throw new AlreadyExistsException(file, line);
+                    // break;
+
-                case EBUSY:
-                case EAGAIN:
@@ -264 +272 @@
-
-            // By default, both the user and group have access to the semaphore
-
-
+
-            if (_sem == SEM_FAILED)
-            {
@@ -403 +410 @@
-        /**
-         * Check the $(D_PARAM errorCode) argument against possible values
-$(D_CODE SysError.lastCode()) and throw an exception with the
-description 
+SysError.lastCode() and throw an exception with the description
+
-         *
-         * Params: