"

 COPYRIGHT (c) 1993 by Claus Gittinger

	      All Rights Reserved

 This software is furnished under a license and may be used

 only in accordance with the terms of that license and with the

 inclusion of the above copyright notice.   This software may not

 be provided or otherwise made available to, or used by, any

 other person.  No title to or ownership of the software is

 hereby transferred.

"

"{ Package: 'stx:libbasic' }"

Object subclass:#Semaphore

	instanceVariableNames:'count waitingProcesses lastOwnerID name'

	classVariableNames:''

	poolDictionaries:''

	category:'Kernel-Processes'

!

!Semaphore class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1993 by Claus Gittinger

	      All Rights Reserved

 This software is furnished under a license and may be used

 only in accordance with the terms of that license and with the

 inclusion of the above copyright notice.   This software may not

 be provided or otherwise made available to, or used by, any

 other person.  No title to or ownership of the software is

 hereby transferred.

"

!

documentation

"

    Semaphores are used to synchronize processes providing a nonBusy wait

    mechanism. A process can wait for the availability of some resource by

    performing a Semaphore>>wait, which will suspend the process until the

    resource becomes available. Signalling is done by (another process performing) 

    Semaphore>>signal.

    If the resource has been already available before the wait, no suspending is

    done, but the resource immediately allocated.

    The resource internally keeps a count, the number of times the resource can be

    allocated. If the semaphore is created with a count greater than 1, the sema

    can be waited-upon that many times without blocking.

    On the other hand, if initialized with a negative count, the semaphore

    must be signalled that many times more often in order for a wait to not block.

    In other words: whenever the semaphore has a count greater than zero, 

    the wait operation will proceed. Otherwise, it will block until the count has

    been incremented by signal operations to be greater than zero.

    There are also semaphores for mutual access to a critical region

    (Semaphore>>forMutualExclusion and Semaphore>>critical:).

    Additional protocol is provided for oneShot semaphores, 

    (#signalOnce) and for conditional signalling (#signalIf).

    You can also attach semaphores to external events (such as I/O arrival or

    timer events). 

    This is done by telling the Processor to signal the semaphore 

    under some condition.

    See 'Processor>>signal:afterSeconds:', 'Processor>>signal:onInput:' etc.

    See examples in doc/coding (found in the CodingExamples-nameSpace).

    Warning/Note/Hint:

        a Semaphore-forMutualExclusion does NEVER allow for the critical

        region to be entered twice - NOT EVEN by the same process.

        That means, that a recursive attempt to enter that section leads

        to a deadlock.

        Use a RecursionLock instead, to avoid this.

    Hint:

        now (Jul2002), Semaphores now allow for a negative count; this allows for

        a sync-point to be implemented easily (i.e. to wait for multiple other processes

        to arrive at a sync-point).

        See examples.

    [instance variables:]

        count                   <SmallInteger>          the number of waits, that will go through

                                                        without blocking.

                                                        Incremented on #signal; decremented on #wait.

        waitingProcesses        <OrderedCollection>     waiting processes - will be served first

                                                        come first served when signalled.

        lastOwnerID             <SmallInteger>          a debugging aid: set when count drops

                                                        to zero to the current processes id.

                                                        Helps in finding deadlocks.

        name                    <String>                a debugging aid: an optional userFriendly

                                                        name; helps to identify a semaphore easier.

    [see also:]

        SemaphoreSet RecursionLock Monitor

        SharedQueue Delay 

        Process ProcessorScheduler

    [author:]

        Claus Gittinger

"

!

examples

"

    two processes synchronizing on a sema:

                                                        [exBegin]

        |sema thread1 thread2|

        sema := Semaphore new.

        thread1 := [

                        Transcript showCR:'here is thread 1; now waiting ...'.

                        sema wait.

                        Transcript showCR:'here is thread 1 again.'.

                   ] newProcess.

        thread2 := [

                        Transcript showCR:'here is thread 2; delaying a bit ...'.

                        Delay waitForSeconds:5.

                        Transcript showCR:'here is thread 2 again; now signalling the sema'.

                        sema signal.

                        Transcript showCR:'here is thread 2 after the signalling.'.

                  ] newProcess.

        thread1 priority:7.

        thread2 priority:6.

        thread1 resume.

        thread2 resume.

                                                        [exEnd]

    semaphore for critical regions:

                                                        [exBegin]

        |accessLock|

        accessLock := Semaphore forMutualExclusion.

        [

            5 timesRepeat:[

                Delay waitForSeconds:2.

                accessLock critical:[

                    Transcript showCR:'thread1 in critical region'.

                    Delay waitForSeconds:1.

                    Transcript showCR:'thread1 leaving critical region'.

                ].

            ]

        ] forkAt:5.

        [

            5 timesRepeat:[

                Delay waitForSeconds:1.

                accessLock critical:[

                    Transcript showCR:'thread2 in critical region'.

                    Delay waitForSeconds:2.

                    Transcript showCR:'thread2 leaving critical region'.

                ].

            ]

        ] forkAt:4.

                                                        [exEnd]

    a deadlock due to recursive enter of a critical region:

                                                        [exBegin]

        |accessLock block|

        accessLock := Semaphore forMutualExclusion.

        block := [:arg |

                    Transcript showCR:'about to enter'.

                    accessLock critical:[

                        Transcript showCR:'entered - doing action'.

                        arg value

                    ].

                    Transcript showCR:'left region'.

                 ].

        block value:[].                 'this works'.

        block value:[block value:[] ].  'this deadlocks'.

                                                        [exEnd]

    Avoid the deadlock by using a RecursionLock instead:

                                                        [exBegin]

        |accessLock block|

        accessLock := RecursionLock new.

        block := [:arg |

                    Transcript showCR:'about to enter'.

                    accessLock critical:[

                        Transcript showCR:'entered - doing action'.

                        arg value

                    ].

                    Transcript showCR:'left region'.

                 ].

        block value:[].                 'this works'.

        block value:[block value:[] ].  'this deadlocks'.

                                                        [exEnd]

   Wait for multiple processes to arrive at a sync-point:

                                                        [exBegin]

        |syncSema proceedSema thread1 thread2 thread3|

        syncSema := Semaphore new.

        syncSema setCount:(1-3).

        proceedSema := Semaphore new.

        thread1 := [

                        Transcript showCR:'here is thread 1; now busy ...'.

                        Delay waitForSeconds:(2 + (Random nextIntegerBetween:2 and:4)).

                        Transcript showCR:'here is thread 1 again - now syncing.'.

                        syncSema signal.

                        Transcript showCR:'thread 1 is waiting for all others...'.

                        proceedSema wait.

                        Transcript showCR:'thread 1 done.'.

                   ] newProcess.

        thread2 := [

                        Transcript showCR:'here is thread 2; now busy ...'.

                        Delay waitForSeconds:(3 + (Random nextIntegerBetween:2 and:4)).

                        Transcript showCR:'here is thread 2 again - now syncing.'.

                        syncSema signal.

                        Transcript showCR:'thread 2 is waiting for all others...'.

                        proceedSema wait.

                        Transcript showCR:'thread 2 done.'.

                  ] newProcess.

        thread3 := [

                        Transcript showCR:'here is thread 3; now busy ...'.

                        Delay waitForSeconds:(4 + (Random nextIntegerBetween:2 and:4)).

                        Transcript showCR:'here is thread 3 again - now syncing.'.

                        syncSema signal.

                        Transcript showCR:'thread 3 is waiting for all others...'.

                        proceedSema wait.

                        Transcript showCR:'thread 3 done.'.

                  ] newProcess.

        thread1 priority:7.

        thread2 priority:6.

        thread3 priority:9.

        thread1 resume.

        thread2 resume.

        thread3 resume.

        Transcript showCR:'main thread: now waiting for other threads...'.

        syncSema wait.

        Transcript showCR:'main thread: all other threads at syncPoint.'.

        Delay waitForSeconds:2.

        Transcript showCR:'main thread: now let them proceed...'.

        proceedSema signalForAll.

        Transcript showCR:'main thread: done.'.

                                                        [exEnd]

   waitWithTimeout:0 can also be used to conditionally aquire the semaphore

   i.e. only aquire it if its available.

     |s|

     s := Semaphore new.

     [

          (s waitWithTimeout:0) notNil ifTrue:[

                Transcript showCR:'process1 got the sema'.

                Delay waitForSeconds:1.

                Transcript showCR:'process1 signals sema'.

                s signal.

          ] ifFalse:[

                Transcript showCR:'process1 has NOT got the sema'.

          ].

     ] fork.

     [

          (s waitWithTimeout:0) notNil ifTrue:[

                Transcript showCR:'process2 got the sema'.

                Delay waitForSeconds:1.

                Transcript showCR:'process2 signals sema'.

                s signal.

          ] ifFalse:[

                Transcript showCR:'process2 has NOT got the sema'.

          ]

     ] fork.

     s signal.

     Delay waitForSeconds:0.5.

     Transcript showCR:'master waits for sema'.

     s wait.

     Transcript showCR:'master got the sema'.

"

! !

!Semaphore class methodsFor:'instance creation'!

forMutualExclusion

    "create & return a new semaphore which allows exactly one process to

     wait on it without blocking. This type of semaphore is used

     for mutual exclusion from critical regions (see #critical:).

     Also see RecursionLock, to avoid deadlock in case of recursive entered

     critical regions."

    ^ super new setCount:1; name:'criticalRegionSema'

    "Modified: / 17.6.1998 / 16:23:09 / cg"

!

new

    "create & return a new semaphore which blocks until a signal is sent"

    ^ super new setCount:0

!

new:n

    "create & return a new semaphore which allows n waits before

     blocking"

    ^ super new setCount:n

! !

!Semaphore methodsFor:'friend-class interface'!

checkAndRegisterProcess:process

    "interface for SemaphoreSet.

     If the semaphore is available, decrement it and return true.

     Otherwise register our process to be wakened up once the semaphore is available

     and return false.

     ATTENTION: this must be invoked with OperatingSystem-interrupts-blocked.

    "

    count > 0 ifTrue:[

        count := count - 1.

        count == 0 ifTrue:[

            lastOwnerID := Processor activeProcessId.

        ].

        ^ true

    ].

    (waitingProcesses identityIndexOf:process) == 0 ifTrue:[

        self addWaitingProcess:process.

    ].

    ^ false

    "Modified: 14.12.1995 / 10:32:17 / stefan"

    "Modified: 10.1.1997 / 21:42:18 / cg"

!

unregisterProcess:process

    "interface for SemaphoreSet.

     Unregister our process from the Semaphore"

    waitingProcesses removeIdentical:process ifAbsent:[].

    "Created: 14.12.1995 / 10:31:50 / stefan"

    "Modified: 1.2.1997 / 12:11:22 / cg"

! !

!Semaphore methodsFor:'printing & storing'!

displayString

    "return a string to display the receiver - include the

     count for your convenience"

    ^ self class name , '(' , count printString , ' name: ' , (name ? 'unnamed') , ')'

    "Modified: 28.6.1997 / 16:21:09 / cg"

!

name

    "return the semaphores userFriendly name"

    ^ name

!

name:aString

    "set the semaphores userFriendly name"

    name := aString

! !

!Semaphore methodsFor:'private'!

addWaitingProcess:aProcess

    "add aProcess to the list of waiting processes.

     Sort, so that higher priority process are resumed first.

     Processes having the same priority are ordered first-come-first-serve.

     NOTE: must be called with blocked interrupts"

    "for now"

    waitingProcesses add:aProcess.

"/    |priority insertIndex|

"/

"/    (waitingProcesses size == 0 

"/     or:[(priority := aProcess priority) <= waitingProcesses last priority]) ifTrue:[

"/        waitingProcesses add:aProcess.

"/        ^ self.

"/    ].

"/

"/    insertIndex := waitingProcesses findFirst:[:process| process priority < priority].

"/    waitingProcesses add:aProcess beforeIndex:insertIndex.

! !

!Semaphore methodsFor:'private-accessing'!

initSignals

    "set the count of the semaphore to zero.

     provided for ST-80 compatibility."

    count := 0

    "Created: 17.2.1997 / 11:31:19 / cg"

!

setCount:n

    "set the count of the semaphore;

     thats the number of possible waits, without blocking"

    waitingProcesses := OrderedCollection new:2.

    count := n

    "Modified: 17.2.1997 / 11:36:40 / cg"

! !

!Semaphore methodsFor:'queries'!

count

    "return the number of 'already-counted' trigger events.

     Thats the number of waits which will succeed without blocking"

    ^ count

    "Created: 23.1.1997 / 02:55:58 / cg"

!

lastOwnerId

    "return the processId of the last owning process

     (the one which counted to zero).

     May be very useful in debugging deadLock situations"

    ^ lastOwnerID

    "Created: 24.1.1997 / 23:09:33 / cg"

!

numberOfWaitingProcesses

    "return the number of processes waiting on the receiver"

    ^ waitingProcesses size

    "Created: 3.5.1996 / 18:06:27 / cg"

!

waitingProcesses

    "return the processes waiting on the receiver"

    ^ waitingProcesses

    "Created: 18.7.1996 / 20:53:33 / cg"

!

wouldBlock

    "return true, if the receiver would block the activeProcess

     if a wait was performed. False otherwise.

     Attention: if asked without some global lock (blockedInterrupts),

     the returned value may be wrong right away."

    ^ count <= 0

! !

!Semaphore methodsFor:'testing'!

isEmpty

    "ST80 compatibility - return true if there are no waiters"

    ^ waitingProcesses isEmpty

    "Created: / 3.5.1996 / 18:06:27 / cg"

    "Modified: / 18.6.1998 / 16:07:38 / cg"

! !

!Semaphore methodsFor:'wait & signal'!

clear

    "clear the semaphores count"

    count := 0

!