mirror-processhacker/1.x/trunk/ProcessHacker.Common/Threading/FastEvent.cs

/*
 * Process Hacker - 
 *   fast event
 * 
 * Copyright (C) 2009 wj32
 * 
 * This file is part of Process Hacker.
 * 
 * Process Hacker is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Process Hacker is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Process Hacker.  If not, see <http://www.gnu.org/licenses/>.
 */

using System;
using System.Threading;

namespace ProcessHacker.Common.Threading
{
    /// <summary>
    /// Provides a fast synchronization event.
    /// </summary>
    /// <remarks>
    /// This event structure will not create any kernel-mode 
    /// event object until necessary.
    /// </remarks>
    public struct FastEvent
    {
        private const int EventSet = 0x1;
        private const int EventRefCountShift = 1;
        private const int EventRefCountIncrement = 0x2;

        private int _value;
        private IntPtr _event;

        /// <summary>
        /// Creates a synchronization event.
        /// </summary>
        /// <param name="value">
        /// The initial value of the event. Always set to false.
        /// </param>
        public FastEvent(bool value)
        {
            // Set value; need one reference for the Set method.
            _value = (value ? EventSet : 0) + EventRefCountIncrement;
            _event = IntPtr.Zero;
        }

        /// <summary>
        /// Gets the current value of the event.
        /// </summary>
        public bool Value
        {
            get { return (_value & EventSet) != 0; }
        }

        /// <summary>
        /// Dereferences the event, closing it if necessary.
        /// </summary>
        private void DerefEvent()
        {
            if ((Interlocked.Add(ref _value, -EventRefCountIncrement) >> EventRefCountShift) == 0)
            {
                if (_event != IntPtr.Zero)
                {
                    NativeMethods.CloseHandle(_event);
                    _event = IntPtr.Zero;
                }
            }
        }

        /// <summary>
        /// References the event.
        /// </summary>
        private void RefEvent()
        {
            Interlocked.Add(ref _value, EventRefCountIncrement);
        }

        /// <summary>
        /// Resets the event.
        /// </summary>
        public void Reset()
        {
            if ((_value & EventSet) != 0)
            {
                _value = EventRefCountIncrement;
            }
        }

        /// <summary>
        /// Sets the event.
        /// </summary>
        public void Set()
        {
            // 1. Value = 1.
            // 2. Event = Global Event.
            // 3. Set Event.
            // 4. [Optional] Dereference the Global Event.

            int oldValue;

            // Set the value.
            do
            {
                oldValue = _value;

                // Has the event already been set?
                if ((oldValue & EventSet) != 0)
                    return;
            } while (Interlocked.CompareExchange(ref _value, oldValue | EventSet, oldValue) != oldValue);

            // Do an update-to-date read.
            IntPtr localEvent = Interlocked.CompareExchange(ref _event, IntPtr.Zero, IntPtr.Zero);

            // Set the event if we had one.
            if (localEvent != IntPtr.Zero)
            {
                NativeMethods.SetEvent(localEvent);
            }

            // Note that at this point we don't need to worry about anyone 
            // creating the event and waiting for it, because if they did 
            // they would check the value first. It would be 1, so they 
            // wouldn't wait at all.

            this.DerefEvent();
        }

        /// <summary>
        /// Waits for the event to be set by busy waiting.
        /// </summary>
        public void SpinWait()
        {
            if (Thread.VolatileRead(ref _value) == 1)
                return;

            if (NativeMethods.SpinEnabled)
            {
                while (Thread.VolatileRead(ref _value) == 0)
                    Thread.SpinWait(400);
            }
            else
            {
                while (Thread.VolatileRead(ref _value) == 0)
                    Thread.Sleep(0);
            }
        }

        /// <summary>
        /// Waits for the event to be set by busy waiting.
        /// </summary>
        /// <param name="spinCount">The number of times to check the value.</param>
        /// <returns>Whether the event was set during the wait period.</returns>
        public bool SpinWait(int spinCount)
        {
            if (Thread.VolatileRead(ref _value) == 1)
                return true;

            for (int i = 0; i < spinCount; i++)
            {
                if (Thread.VolatileRead(ref _value) == 1)
                    return true;
            }

            return false;
        }

        /// <summary>
        /// Waits for the event to be set.
        /// </summary>
        public void Wait()
        {
            this.Wait(Timeout.Infinite);
        }

        /// <summary>
        /// Waits for the event to be set.
        /// </summary>
        /// <param name="millisecondsTimeout">The number of milliseconds to wait.</param>
        /// <returns>Whether the event was set before the timeout period elapsed.</returns>
        public bool Wait(int millisecondsTimeout)
        {
            // 1. [Optional] If Value = 1, Return.
            // 2. [Optional] If Timeout = 0 And Value = 0, Return.
            // 3. [Optional] Reference the Global Event.
            // 4. [Optional] If Global Event is present, skip Step 5.
            // 5. Create Event.
            // 6. Global Event = Event only if Global Event is not present.
            // 7. If Value = 1, Return (rather, go to Step 9).
            // 8. Wait for Global Event.
            // 9. [Optional] Dereference the Global Event.

            int result;
            IntPtr newEvent;

            result = _value;

            // Shortcut: return immediately if the event is set.
            if ((result & EventSet) != 0)
                return true;

            // Shortcut: if the timeout is 0, return immediately if 
            // the event isn't set.
            if (millisecondsTimeout == 0)
            {
                if ((result & EventSet) == 0)
                    return false;
            }

            // Prevent the event from being closed or invalidated.
            this.RefEvent();

            // Shortcut: don't bother creating an event if we already have one.
            newEvent = Interlocked.CompareExchange(ref _event, IntPtr.Zero, IntPtr.Zero);

            // If we don't have an event, create one and try to set it.
            if (newEvent == IntPtr.Zero)
            {
                // Create an event. We might not need it, though.
                newEvent = NativeMethods.CreateEvent(IntPtr.Zero, true, false, null);

                // Atomically use the event only if we don't already 
                // have one.
                if (Interlocked.CompareExchange(
                    ref _event,
                    newEvent,
                    IntPtr.Zero
                    ) != IntPtr.Zero)
                {
                    // Someone else set the event before we did.
                    NativeMethods.CloseHandle(newEvent);
                }
            }

            try
            {
                // Check the value to see if we are meant to wait. This step 
                // is essential, because if someone set the event before we 
                // created the event (previous step), we would be waiting 
                // on an event no one knows about.
                if ((Interlocked.CompareExchange(ref _value, 0, 0) & EventSet) != 0)
                    return true;

                result = NativeMethods.WaitForSingleObject(_event, millisecondsTimeout);

                return result == NativeMethods.WaitObject0;
            }
            finally
            {
                // We don't need the event anymore.
                this.DerefEvent();
            }
        }
    }
}