[NUI] Rebase develnui (DevelNUI only patches --> master) (#3910)

[platform/core/csapi/tizenfx.git] / test / Tizen.NUI.Devel.Tests.Ubuntu / nunit.framework / Internal / Execution / ParallelWorkItemDispatcher.cs

// ***********************************************************************
// Copyright (c) 2012-2014 Charlie Poole
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
// ***********************************************************************
#define PORTABLE
#define TIZEN
#define NUNIT_FRAMEWORK
#define NUNITLITE
#define NET_4_5
#define PARALLEL
#define NETCF
#if PARALLEL

using System;
using System.Collections.Generic;
using System.Threading;

namespace NUnit.Framework.Internal.Execution
{
    /// <summary>
    /// ParallelWorkItemDispatcher handles execution of work items by
    /// queuing them for worker threads to process.
    /// </summary>
    public class ParallelWorkItemDispatcher : IWorkItemDispatcher
    {
        private static readonly Logger log = InternalTrace.GetLogger("WorkItemDispatcher");

        private readonly int _levelOfParallelism;
        private int _itemsDispatched;

        // Non-STA
        private readonly WorkShift _parallelShift = new WorkShift("Parallel");
        private readonly WorkShift _nonParallelShift = new WorkShift("NonParallel");
        private readonly Lazy<WorkItemQueue> _parallelQueue;
        private readonly Lazy<WorkItemQueue> _nonParallelQueue;

        // STA
#if !NETCF
        private readonly WorkShift _nonParallelSTAShift = new WorkShift("NonParallelSTA");
        private readonly Lazy<WorkItemQueue> _parallelSTAQueue;
        private readonly Lazy<WorkItemQueue> _nonParallelSTAQueue;
#endif

        // The first WorkItem to be dispatched, assumed to be top-level item
        private WorkItem _topLevelWorkItem;

        /// <summary>
        /// Construct a ParallelWorkItemDispatcher
        /// </summary>
        /// <param name="levelOfParallelism">Number of workers to use</param>
        public ParallelWorkItemDispatcher(int levelOfParallelism)
        {
            _levelOfParallelism = levelOfParallelism;

            Shifts = new WorkShift[]
            {
                _parallelShift,
                _nonParallelShift,
#if !NETCF
                _nonParallelSTAShift
#endif
            };
            foreach (var shift in Shifts)
                shift.EndOfShift += OnEndOfShift;

            _parallelQueue = new Lazy<WorkItemQueue>(() =>
            {
                var parallelQueue = new WorkItemQueue("ParallelQueue");
                _parallelShift.AddQueue(parallelQueue);

                for (int i = 1; i <= _levelOfParallelism; i++)
                {
                    string name = string.Format("Worker#" + i.ToString());
#if NETCF
                    _parallelShift.Assign(new TestWorker(parallelQueue, name));
#else
                    _parallelShift.Assign(new TestWorker(parallelQueue, name, ApartmentState.MTA));
#endif
                }

                return parallelQueue;
            });

#if !NETCF
            _parallelSTAQueue = new Lazy<WorkItemQueue>(() =>
            {
                var parallelSTAQueue = new WorkItemQueue("ParallelSTAQueue");
                _parallelShift.AddQueue(parallelSTAQueue);
                _parallelShift.Assign(new TestWorker(parallelSTAQueue, "Worker#STA", ApartmentState.STA));

                return parallelSTAQueue;
            });
#endif

            _nonParallelQueue = new Lazy<WorkItemQueue>(() =>
            {
                var nonParallelQueue = new WorkItemQueue("NonParallelQueue");
                _nonParallelShift.AddQueue(nonParallelQueue);
#if NETCF
                _nonParallelShift.Assign(new TestWorker(nonParallelQueue, "Worker#NP"));
#else
                _nonParallelShift.Assign(new TestWorker(nonParallelQueue, "Worker#STA_NP", ApartmentState.MTA));
#endif

                return nonParallelQueue;
            });

#if !NETCF
            _nonParallelSTAQueue = new Lazy<WorkItemQueue>(() =>
            {
                var nonParallelSTAQueue = new WorkItemQueue("NonParallelSTAQueue");
                _nonParallelSTAShift.AddQueue(nonParallelSTAQueue);
                _nonParallelSTAShift.Assign(new TestWorker(nonParallelSTAQueue, "Worker#NP_STA", ApartmentState.STA));

                return nonParallelSTAQueue;
            });
#endif
        }

        /// <summary>
        /// Enumerates all the shifts supported by the dispatcher
        /// </summary>
        public IEnumerable<WorkShift> Shifts { get; private set; }

        #region IWorkItemDispatcher Members

        /// <summary>
        /// Dispatch a single work item for execution. The first
        /// work item dispatched is saved as the top-level
        /// work item and used when stopping the run.
        /// </summary>
        /// <param name="work">The item to dispatch</param>
        public void Dispatch(WorkItem work)
        {
            // Special handling of the top-level item
            if (Interlocked.CompareExchange (ref _topLevelWorkItem, work, null) == null)
            {
                Enqueue(work);
                StartNextShift();
            }
            // We run child items directly, rather than enqueuing them...
            // 1. If the context is single threaded.
            // 2. If there is no fixture, and so nothing to do but dispatch grandchildren.
            // 3. For now, if this represents a test case. This avoids issues of
            // tests that access the fixture state and allows handling ApartmentState
            // preferences set on the fixture.
            else if (work.Context.IsSingleThreaded
                  || work.Test.TypeInfo == null
                  || work is SimpleWorkItem)
                Execute(work);
            else
                Enqueue(work);

            Interlocked.Increment(ref _itemsDispatched);
        }

        private void Execute(WorkItem work)
        {
            log.Debug("Directly executing {0}", work.Test.Name);
            work.Execute();
        }

        private void Enqueue(WorkItem work)
        {
            log.Debug("Enqueuing {0}", work.Test.Name);

            if (work.IsParallelizable)
            {
#if !NETCF
                if (work.TargetApartment == ApartmentState.STA)
                    ParallelSTAQueue.Enqueue(work);
                else
#endif
                ParallelQueue.Enqueue(work);
            }
#if !NETCF
            else if (work.TargetApartment == ApartmentState.STA)
                NonParallelSTAQueue.Enqueue(work);
#endif
            else
                NonParallelQueue.Enqueue(work);
        }

        /// <summary>
        /// Cancel the ongoing run completely.
        /// If no run is in process, the call has no effect.
        /// </summary>
        public void CancelRun(bool force)
        {
            foreach (var shift in Shifts)
                shift.Cancel(force);
        }

        #endregion

        #region Private Queue Properties

        // Queues are not actually created until the first time the property
        // is referenced by the Dispatch method adding a WorkItem to it.

        private WorkItemQueue ParallelQueue
        {
            get
            {
                return _parallelQueue.Value;
            }
        }

#if !NETCF
        private WorkItemQueue ParallelSTAQueue
        {
            get
            {
                return _parallelSTAQueue.Value;
            }
        }
#endif

        private WorkItemQueue NonParallelQueue
        {
            get
            {
                return _nonParallelQueue.Value;
            }
        }

#if !NETCF
        private WorkItemQueue NonParallelSTAQueue
        {
            get
            {
                return _nonParallelSTAQueue.Value;
            }
        }
#endif
        #endregion

        #region Helper Methods

        private void OnEndOfShift(object sender, EventArgs ea)
        {
            if (!StartNextShift())
            {
                foreach (var shift in Shifts)
                    shift.ShutDown();
            }
        }

        private bool StartNextShift()
        {
            foreach (var shift in Shifts)
            {
                if (shift.HasWork)
                {
                    shift.Start();
                    return true;
                }
            }

            return false;
        }

        #endregion
    }
}

#endif