aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Framework/Parallel.cs
blob: ab2e108353f1830ca2288746b2df6beae6cf015f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
/*
 * Copyright (c) Contributors, http://opensimulator.org/
 * See CONTRIBUTORS.TXT for a full list of copyright holders.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the OpenSimulator Project nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

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

namespace OpenSim.Framework
{
    /// <summary>
    /// Provides helper methods for parallelizing loops
    /// </summary>
    public static class Parallel
    {
        public static readonly int ProcessorCount = System.Environment.ProcessorCount;

        /// <summary>
        /// Executes a for loop in which iterations may run in parallel
        /// </summary>
        /// <param name="fromInclusive">The loop will be started at this index</param>
        /// <param name="toExclusive">The loop will be terminated before this index is reached</param>
        /// <param name="body">Method body to run for each iteration of the loop</param>
        public static void For(int fromInclusive, int toExclusive, Action<int> body)
        {
            For(ProcessorCount, fromInclusive, toExclusive, body);
        }

        /// <summary>
        /// Executes a for loop in which iterations may run in parallel
        /// </summary>
        /// <param name="threadCount">The number of concurrent execution threads to run</param>
        /// <param name="fromInclusive">The loop will be started at this index</param>
        /// <param name="toExclusive">The loop will be terminated before this index is reached</param>
        /// <param name="body">Method body to run for each iteration of the loop</param>
        public static void For(int threadCount, int fromInclusive, int toExclusive, Action<int> body)
        {
            int counter = threadCount;
            AutoResetEvent threadFinishEvent = new AutoResetEvent(false);
            Exception exception = null;

            --fromInclusive;

            for (int i = 0; i < threadCount; i++)
            {
                ThreadPool.UnsafeQueueUserWorkItem(
                    delegate(object o)
                    {
                        int threadIndex = (int)o;

                        while (exception == null)
                        {
                            int currentIndex = Interlocked.Increment(ref fromInclusive);

                            if (currentIndex >= toExclusive)
                                break;

                            try { body(currentIndex); }
                            catch (Exception ex) { exception = ex; break; }
                        }

                        if (Interlocked.Decrement(ref counter) == 0)
                            threadFinishEvent.Set();
                    }, i
                );
            }

            threadFinishEvent.WaitOne();
            threadFinishEvent.Close();

            if (exception != null)
                throw new Exception(exception.Message, exception);
        }

        /// <summary>
        /// Executes a foreach loop in which iterations may run in parallel
        /// </summary>
        /// <typeparam name="T">Object type that the collection wraps</typeparam>
        /// <param name="enumerable">An enumerable collection to iterate over</param>
        /// <param name="body">Method body to run for each object in the collection</param>
        public static void ForEach<T>(IEnumerable<T> enumerable, Action<T> body)
        {
            ForEach<T>(ProcessorCount, enumerable, body);
        }

        /// <summary>
        /// Executes a foreach loop in which iterations may run in parallel
        /// </summary>
        /// <typeparam name="T">Object type that the collection wraps</typeparam>
        /// <param name="threadCount">The number of concurrent execution threads to run</param>
        /// <param name="enumerable">An enumerable collection to iterate over</param>
        /// <param name="body">Method body to run for each object in the collection</param>
        public static void ForEach<T>(int threadCount, IEnumerable<T> enumerable, Action<T> body)
        {
            int counter = threadCount;
            AutoResetEvent threadFinishEvent = new AutoResetEvent(false);
            IEnumerator<T> enumerator = enumerable.GetEnumerator();
            Exception exception = null;

            for (int i = 0; i < threadCount; i++)
            {
                ThreadPool.UnsafeQueueUserWorkItem(
                    delegate(object o)
                    {
                        int threadIndex = (int)o;

                        while (exception == null)
                        {
                            T entry;

                            lock (enumerator)
                            {
                                if (!enumerator.MoveNext())
                                    break;
                                entry = (T)enumerator.Current; // Explicit typecast for Mono's sake
                            }

                            try { body(entry); }
                            catch (Exception ex) { exception = ex; break; }
                        }

                        if (Interlocked.Decrement(ref counter) == 0)
                            threadFinishEvent.Set();
                    }, i
                );
            }

            threadFinishEvent.WaitOne();
            threadFinishEvent.Close();

            if (exception != null)
                throw new Exception(exception.Message, exception);
        }

        /// <summary>
        /// Executes a series of tasks in parallel
        /// </summary>
        /// <param name="actions">A series of method bodies to execute</param>
        public static void Invoke(params Action[] actions)
        {
            Invoke(ProcessorCount, actions);
        }

        /// <summary>
        /// Executes a series of tasks in parallel
        /// </summary>
        /// <param name="threadCount">The number of concurrent execution threads to run</param>
        /// <param name="actions">A series of method bodies to execute</param>
        public static void Invoke(int threadCount, params Action[] actions)
        {
            int counter = threadCount;
            AutoResetEvent threadFinishEvent = new AutoResetEvent(false);
            int index = -1;
            Exception exception = null;

            for (int i = 0; i < threadCount; i++)
            {
                ThreadPool.UnsafeQueueUserWorkItem(
                    delegate(object o)
                    {
                        int threadIndex = (int)o;

                        while (exception == null)
                        {
                            int currentIndex = Interlocked.Increment(ref index);

                            if (currentIndex >= actions.Length)
                                break;

                            try { actions[currentIndex](); }
                            catch (Exception ex) { exception = ex; break; }
                        }

                        if (Interlocked.Decrement(ref counter) == 0)
                            threadFinishEvent.Set();
                    }, i
                );
            }

            threadFinishEvent.WaitOne();
            threadFinishEvent.Close();

            if (exception != null)
                throw new Exception(exception.Message, exception);
        }
    }
}