File: DefaultWorkflowSchedulerService.cs

package info (click to toggle)
mono 6.14.1%2Bds2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,282,732 kB
  • sloc: cs: 11,182,461; xml: 2,850,281; ansic: 699,123; cpp: 122,919; perl: 58,604; javascript: 30,841; asm: 21,845; makefile: 19,602; sh: 10,973; python: 4,772; pascal: 925; sql: 859; sed: 16; php: 1
file content (386 lines) | stat: -rw-r--r-- 14,492 bytes parent folder | download | duplicates (7)
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
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
using System;
using System.Collections;
using System.Collections.ObjectModel;
using System.Collections.Generic;
using System.Threading;
using System.Collections.Specialized;
using System.Diagnostics;
using System.Workflow.Runtime;
using System.Globalization;

namespace System.Workflow.Runtime.Hosting
{
    [Obsolete("The System.Workflow.* types are deprecated.  Instead, please use the new types from System.Activities.*")]
    public class DefaultWorkflowSchedulerService : WorkflowSchedulerService
    {
        // next two fields controlled by locking the timerQueue
        private KeyedPriorityQueue<Guid, CallbackInfo, DateTime> timerQueue = new KeyedPriorityQueue<Guid, CallbackInfo, DateTime>();
        private Timer callbackTimer;

        private TimerCallback timerCallback;
        private const string MAX_SIMULTANEOUS_WORKFLOWS_KEY = "maxSimultaneousWorkflows";
        private const int DEFAULT_MAX_SIMULTANEOUS_WORKFLOWS = 5;
        private static TimeSpan infinite = new TimeSpan(Timeout.Infinite);
        private readonly int maxSimultaneousWorkflows;       // Maximum number of work items allowed in ThreadPool queue
        private static TimeSpan fiveMinutes = new TimeSpan(0, 5, 0);

        // next three fields controlled by locking the waitingQueue
        private int numCurrentWorkers;
        private Queue<WorkItem> waitingQueue;       // Queue for extra items waiting to be allowed into thread pool
        private volatile bool running = false;

        private IList<PerformanceCounter> queueCounters;    // expose internal queue length

        private static int DefaultThreadCount
        {
            get
            {
                return Environment.ProcessorCount == 1
                    ? DEFAULT_MAX_SIMULTANEOUS_WORKFLOWS
                    : (int)(DEFAULT_MAX_SIMULTANEOUS_WORKFLOWS * Environment.ProcessorCount * .8);
            }
        }

        public DefaultWorkflowSchedulerService()
            : this(DefaultThreadCount)
        {
        }


        public DefaultWorkflowSchedulerService(int maxSimultaneousWorkflows)
            : base()
        {
            if (maxSimultaneousWorkflows < 1)
                throw new ArgumentOutOfRangeException(MAX_SIMULTANEOUS_WORKFLOWS_KEY, maxSimultaneousWorkflows, String.Empty);
            this.maxSimultaneousWorkflows = maxSimultaneousWorkflows;
            init();
        }

        public DefaultWorkflowSchedulerService(NameValueCollection parameters)
            : base()
        {
            if (parameters == null)
                throw new ArgumentNullException("parameters");

            maxSimultaneousWorkflows = DefaultThreadCount;
            foreach (string key in parameters.Keys)
            {
                if (key == null)
                    throw new ArgumentException(String.Format(Thread.CurrentThread.CurrentCulture, ExecutionStringManager.UnknownConfigurationParameter, "null"));
                string p = parameters[key];
                if (!key.Equals(MAX_SIMULTANEOUS_WORKFLOWS_KEY, StringComparison.OrdinalIgnoreCase))
                    throw new ArgumentException(String.Format(Thread.CurrentThread.CurrentCulture, ExecutionStringManager.UnknownConfigurationParameter, key));
                if (!int.TryParse(p, System.Globalization.NumberStyles.Integer, System.Globalization.CultureInfo.CurrentCulture, out maxSimultaneousWorkflows))
                    throw new FormatException(MAX_SIMULTANEOUS_WORKFLOWS_KEY);
            }

            if (maxSimultaneousWorkflows < 1)
                throw new ArgumentOutOfRangeException(MAX_SIMULTANEOUS_WORKFLOWS_KEY, maxSimultaneousWorkflows, String.Empty);

            init();
        }

        private void init()
        {
            timerCallback = new TimerCallback(OnTimerCallback);
            timerQueue.FirstElementChanged += OnFirstElementChanged;
            waitingQueue = new Queue<WorkItem>();
        }


        public int MaxSimultaneousWorkflows
        {
            get { return maxSimultaneousWorkflows; }
        }

        internal protected override void Schedule(WaitCallback callback, Guid workflowInstanceId)
        {
            WorkflowTrace.Host.TraceEvent(TraceEventType.Information, 0, "Scheduling work for instance {0}", workflowInstanceId);

            if (callback == null)
                throw new ArgumentNullException("callback");
            if (workflowInstanceId == Guid.Empty)
                throw new ArgumentException(String.Format(CultureInfo.CurrentUICulture, ExecutionStringManager.CantBeEmptyGuid, "workflowInstanceId"));

            // Add the work item to our internal queue and signal the ProcessQueue thread
            EnqueueWorkItem(new WorkItem(callback, workflowInstanceId));
        }

        internal protected override void Schedule(WaitCallback callback, Guid workflowInstanceId, DateTime whenUtc, Guid timerId)
        {
            WorkflowTrace.Host.TraceEvent(TraceEventType.Information, 0, "Scheduling work for instance {0} on timer ID {1} in {2}", workflowInstanceId, timerId, (whenUtc - DateTime.UtcNow));

            if (callback == null)
                throw new ArgumentNullException("callback");
            if (timerId == Guid.Empty)
                throw new ArgumentException(String.Format(CultureInfo.CurrentUICulture, ExecutionStringManager.CantBeEmptyGuid, "timerId"));
            if (workflowInstanceId == Guid.Empty)
                throw new ArgumentException(String.Format(CultureInfo.CurrentUICulture, ExecutionStringManager.CantBeEmptyGuid, "workflowInstanceId"));

            CallbackInfo ci = new CallbackInfo(this, callback, workflowInstanceId, whenUtc);

            lock (timerQueue)
            {
                timerQueue.Enqueue(timerId, ci, whenUtc);
            }
        }

        internal protected override void Cancel(Guid timerId)
        {
            WorkflowTrace.Host.TraceEvent(TraceEventType.Information, 0, "Cancelling work with timer ID {0}", timerId);

            if (timerId == Guid.Empty)
                throw new ArgumentException(String.Format(CultureInfo.CurrentUICulture, ExecutionStringManager.CantBeEmptyGuid, "timerId"), "timerId");

            lock (timerQueue)
            {
                timerQueue.Remove(timerId);
            }
        }

        override protected void OnStarted()
        {
            lock (timerQueue)
            {
                base.OnStarted();
                CallbackInfo ci = timerQueue.Peek();
                if (ci != null)
                    callbackTimer = CreateTimerCallback(ci);
                running = true;
            }
            lock (waitingQueue)
            {
                int nToStart = Math.Min(maxSimultaneousWorkflows, waitingQueue.Count);
                for (int i = 0; i < nToStart; i++)
                {
                    if (ThreadPool.QueueUserWorkItem(QueueWorkerProcess))
                    {
                        numCurrentWorkers++;
                    }
                }
            }
            if (queueCounters == null && this.Runtime.PerformanceCounterManager != null)
            {
                queueCounters = this.Runtime.PerformanceCounterManager.CreateCounters(ExecutionStringManager.PerformanceCounterWorkflowsWaitingName);
            }
        }

        protected internal override void Stop()
        {
            lock (timerQueue)
            {
                base.Stop();
                if (callbackTimer != null)
                {
                    callbackTimer.Dispose();
                    callbackTimer = null;
                }
                running = false;
            }
            lock (waitingQueue)
            {
                while (numCurrentWorkers > 0)
                {
                    Monitor.Wait(waitingQueue);
                }
            }
        }

        private void OnFirstElementChanged(object source, KeyedPriorityQueueHeadChangedEventArgs<CallbackInfo> e)
        {
            // timerQueue must have been locked by operation that caused this event to fire

            if (callbackTimer != null)
            {
                callbackTimer.Dispose();
                callbackTimer = null;
            }
            if (e.NewFirstElement != null && this.State == WorkflowRuntimeServiceState.Started)
            {
                callbackTimer = CreateTimerCallback(e.NewFirstElement);
            }
        }

        private void OnTimerCallback(object ignored)
        {
            //Make sure activity ID comes out of Threadpool are initialized to null.
            Trace.CorrelationManager.ActivityId = Guid.Empty;

            CallbackInfo ci = null;
            bool fire = false;
            try
            {
                lock (timerQueue)
                {
                    if (State == WorkflowRuntimeServiceState.Started)
                    {
                        ci = timerQueue.Peek();
                        if (ci != null)
                        {
                            if (ci.IsExpired)
                            {
                                WorkflowTrace.Host.TraceEvent(TraceEventType.Information, 0, "Timeout occured for timer for instance {0}", ci.State);
                                timerQueue.Dequeue();
                                fire = true;
                            }
                            else
                            {
                                callbackTimer = CreateTimerCallback(ci);
                            }
                        }
                    }
                }
                if (fire && ci != null)
                    ci.Callback(ci.State);
            }
            // Ignore cases where the workflow has been stolen out from under us
            catch (WorkflowOwnershipException)
            { }
            catch (ThreadAbortException e)
            {
                WorkflowTrace.Host.TraceEvent(TraceEventType.Error, 0, "Timeout for instance, {0} threw exception {1}", ci == null ? null : ci.State, e.Message);
                RaiseServicesExceptionNotHandledEvent(e, (Guid)ci.State);
                throw;
            }
            catch (Exception e)
            {
                WorkflowTrace.Host.TraceEvent(TraceEventType.Error, 0, "Timeout for instance, {0} threw exception {1}", ci == null ? null : ci.State, e.Message);
                RaiseServicesExceptionNotHandledEvent(e, (Guid)ci.State);
            }
        }

        private Timer CreateTimerCallback(CallbackInfo info)
        {
            DateTime now = DateTime.UtcNow;
            TimeSpan span = (info.When > now) ? info.When - now : TimeSpan.Zero;
            if (span > fiveMinutes) // never let more than five minutes go by without checking
                span = fiveMinutes;
            return new Timer(timerCallback, info.State, span, infinite);
        }

        private void EnqueueWorkItem(WorkItem workItem)
        {
            lock (waitingQueue)
            {
                waitingQueue.Enqueue(workItem);
                if (running && numCurrentWorkers < maxSimultaneousWorkflows)
                {
                    if (ThreadPool.QueueUserWorkItem(this.QueueWorkerProcess))
                    {
                        numCurrentWorkers++;
                    }
                }
            }
            if (queueCounters != null)
            {
                foreach (PerformanceCounter p in queueCounters)
                {
                    p.RawValue = waitingQueue.Count;
                }
            }
        }

        private void QueueWorkerProcess(object state /*unused*/)
        {
            //Make sure activity ID comes out of Threadpool are initialized to null.
            Trace.CorrelationManager.ActivityId = Guid.Empty;

            while (true)
            {
                WorkItem workItem;
                lock (waitingQueue)
                {
                    if (waitingQueue.Count == 0 || !running)
                    {
                        numCurrentWorkers--;
                        Monitor.Pulse(waitingQueue);
                        return;
                    }
                    workItem = waitingQueue.Dequeue();
                }
                if (queueCounters != null)
                {
                    foreach (PerformanceCounter p in queueCounters)
                    {
                        p.RawValue = waitingQueue.Count;
                    }
                }
                workItem.Invoke(this);
            }
        }


        internal class WorkItem
        {
            private WaitCallback callback;
            private object state;

            public WorkItem(WaitCallback callback, object state)
            {
                this.callback = callback;
                this.state = state;
            }

            public WaitCallback Callback
            {
                get { return callback; }
            }

            public void Invoke(WorkflowSchedulerService service)
            {
                try
                {
                    WorkflowTrace.Host.TraceEvent(TraceEventType.Information, 0, "Running workflow {0}", state);
                    Callback(state);
                }
                catch (Exception e)
                {
                    if (WorkflowExecutor.IsIrrecoverableException(e))
                    {
                        throw;
                    }
                    else
                    {
                        service.RaiseExceptionNotHandledEvent(e, (Guid)state);
                    }
                }
            }
        }

        internal class CallbackInfo
        {
            WaitCallback callback;
            object state;
            DateTime when;
            WorkflowSchedulerService service;

            public CallbackInfo(WorkflowSchedulerService service, WaitCallback callback, object state, DateTime when)
            {
                this.service = service;
                this.callback = callback;
                this.state = state;
                this.when = when;
            }

            public DateTime When
            {
                get { return when; }
            }

            public bool IsExpired
            {
                get { return DateTime.UtcNow >= when; }
            }

            public object State
            {
                get { return state; }
            }

            public WaitCallback Callback
            {
                get { return callback; }
            }
        }
    }
}