Parallelisierung von Schleifen

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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266

using System;
using System.Threading;

namespace gfoidl
{
	/// <summary>
	/// Unterstützung für parallele Ausführung
	/// </summary>
	/// <remarks>
	/// Diese Klasse erlaubt die Parallelisierung von Schleifen.
	/// Diese werden in separaten Threads ausgeführt was 
	/// wiederum die Möglichkeit gibt diese simultan auf
	/// verschiedene CPUs/Kerne auszuführen
	/// </remarks>
	public sealed class Parallel
	{
		/// <summary>
		/// Delegate für den Schleifenkörper
		/// </summary>
		/// <param name="index">
		/// Schleifenindex
		/// </param>
		public delegate void SchleifenKörper(int index);
		//---------------------------------------------------------------------
		#region Felder
		private static int _anzahlThreads = System.Environment.ProcessorCount;

		// Wird für Synchronisation der Threads benötigt:
		private static object _sync = new object();

		// Wird für Singleton-Pattern benötigt:
		private static volatile Parallel _instanz = null;

		// Hintergrundthreads für parallele Ausführung:
		private Thread[] _threads = null;

		// Ereignisse um Job-Verfügbarkeit und Thread-Verfügbarkeit zu
		// signalisieren:
		private AutoResetEvent[] _jobVerfügbar = null;
		private ManualResetEvent[] _threadLeerlauf = null;

		// Schleife:
		private int _aktuellerIndex;
		private int _stopIndex;
		private SchleifenKörper _schleifenKörper;
		#endregion
		//---------------------------------------------------------------------
		#region Eigenschaften
		/// <summary>
		/// <para>
		/// Anzahl der Threads die für die parallele Ausführung verwendet
		/// werden.
		/// </para>
		/// <para>
		/// Standardmäßig wird die Anzahl auf die Anzahl der CPUs im
		/// System gesetzt (siehe auch
		/// <see cref="System.Environment.ProcessorCount"/>).
		/// </para>
		/// </summary>
		public static int ThreadAnzahl
		{
			get { return _anzahlThreads; }
			set
			{
				lock (_sync)
				{
					_anzahlThreads = Math.Max(1, value);
				}
			}
		}
		//---------------------------------------------------------------------
		private static Parallel Instanz
		{
			get
			{
				if (_instanz == null)
				{
					_instanz = new Parallel();
					_instanz.Initiieren();
				}
				else
				{
					if (_instanz._threads.Length != _anzahlThreads)
					{
						// Alte Threads terminieren:
						_instanz.Terminieren();

						// Reinitiieren:
						_instanz.Initiieren();
					}
				}

				return _instanz;
			}
		}
		#endregion
		//---------------------------------------------------------------------
		#region Konstruktor
		/// <summary>
		/// Privater Konstruktor um Instanziierung der Klasse zu vermeiden
		/// (Singleton).
		/// </summary>
		private Parallel() { }
		#endregion
		//---------------------------------------------------------------------
		#region Methoden
		/// <summary>
		/// For-Schleife in der die Ausführung parallel stattfindet
		/// </summary>
		/// <param name="start">
		/// Startindex
		/// </param>
		/// <param name="ende">
		/// Obergrenze des Index (exklusiv)
		/// </param>
		/// <param name="schleifenKörper">
		/// Schleifenkörper
		/// </param>
		/// <remarks>
		/// <para>
		/// Diese Methode wird benötigt um die For-Schleife parallet 
		/// in verschiedenen Threads auszuführen.
		/// </para>
		/// <para>
		/// Die Anzahl der Iterationen entspricht <paramref name="ende"/>
		/// - <paramref name="start"/> - 1.
		/// </para>
		/// </remarks>
		/// <example>
		/// <code>
		/// Parallel.For(0, 20, delegate(int i)
		/// // Äquivalent zu:
		/// // for (int i = 0; i &lt; 20; i++)
		/// {
		///		Console.WriteLine(i);
		/// });
		/// </code>
		/// </example>
		public static void For(
			int start,
			int ende,
			SchleifenKörper schleifenKörper)
		{
			lock (_sync)
			{
				// Instanz des Managers holen:
				Parallel instanz = Instanz;

				instanz._aktuellerIndex = start - 1;
				instanz._stopIndex = ende;
				instanz._schleifenKörper = schleifenKörper;

				// Allen Threads signalisieren dass ein Job verfügbar ist
				// und sie als beschäftigt markieren:
				for (int i = 0; i < _anzahlThreads; i++)
				{
					instanz._threadLeerlauf[i].Reset();
					instanz._jobVerfügbar[i].Set();
				}

				// Warten bis alle Threads im Leerlauf sind:
				for (int i = 0; i < _anzahlThreads; i++)
				{
					instanz._threadLeerlauf[i].WaitOne();
				}
			}
		}
		//---------------------------------------------------------------------
		/// <summary>
		/// Initiiert die Instanz der Klasse (Singleton) die benötigt wird
		/// um die Anzahl der Threads zu erstellen und diese zu 
		/// synchronisieren
		/// </summary>
		private void Initiieren()
		{
			// Ereignis-Array der über verfügbare Jobs signalisiert:
			_jobVerfügbar = new AutoResetEvent[_anzahlThreads];

			// Ereignis-Array der über verfügbaren Thread signalisiert:
			_threadLeerlauf = new ManualResetEvent[_anzahlThreads];

			// Thread-Array:
			_threads = new Thread[_anzahlThreads];

			for (int i = 0; i < _anzahlThreads; i++)
			{
				_jobVerfügbar[i] = new AutoResetEvent(false);
				_threadLeerlauf[i] = new ManualResetEvent(true);

				_threads[i] = new Thread(
					new ParameterizedThreadStart(ArbeiterThread));
				_threads[i].IsBackground = true;
				_threads[i].Start(i);
			}
		}
		//---------------------------------------------------------------------
		/// <summary>
		/// Terminiert alle Threads und schließt die Synchronisations-Objekte
		/// </summary>
		private void Terminieren()
		{
			// Thread beenden indem der Schleifenkörper auf null 
			// gesetzt wird und verfügbare Arbeit signalisiert wird:
			_schleifenKörper = null;

			for (int i = 0, anzahlThreads = _threads.Length; i < anzahlThreads; i++)
			{
				_jobVerfügbar[i].Set();

				// Warten bis Thread terminiert ist:
				_threads[i].Join();

				// Ereignisse schließen:
				_jobVerfügbar[i].Close();
				_threadLeerlauf[i].Close();
			}

			// Aufräumen:
			_jobVerfügbar = null;
			_threadLeerlauf = null;
			_threads = null;
		}
		//---------------------------------------------------------------------
		/// <summary>
		/// Führt die parallele Ausführung durch
		/// </summary>
		/// <param name="index">
		/// Zählvariable
		/// </param>
		/// <remarks>
		/// Die Zählvariable ist deshalb als object deklariert da diese
		/// Methode über ParameterizedThreadStart aufgerufen wird. Hier sind
		/// nur object-Argumente erlaubt
		/// </remarks>
		private void ArbeiterThread(object index)
		{
			int threadIndex = (int)index;
			int lokalerIndex = 0;

			while (true)
			{
				// Warten bis ein Job zu tun ist:
				_jobVerfügbar[threadIndex].WaitOne();

				// Ist der Schleifenkörper null -> Schleife verlassen:
				if (_schleifenKörper == null) break;

				while (true)
				{
					// Lokalen Index ermitteln indem der globale 
					// Schleifenzähler inkrementiert wird:
					lokalerIndex = Interlocked.Increment(ref _aktuellerIndex);

					if (lokalerIndex >= _stopIndex) break;

					// Schleifenkörper ausführen:
					_schleifenKörper(lokalerIndex);
				}

				// Verfügbare Threads signalisieren:
				_threadLeerlauf[threadIndex].Set();
			}
		}
		#endregion
	}
}