source: trunk/CrypPlugins/WorkspaceManager/Execution/ExecutionEngine.cs @ 1753

Last change on this file since 1753 was 1753, checked in by kopal, 11 years ago

added first support for connecting IControl Connections

File size: 20.1 KB
Line 
1/*                             
2   Copyright 2010 Nils Kopal, Viktor M.
3
4   Licensed under the Apache License, Version 2.0 (the "License");
5   you may not use this file except in compliance with the License.
6   You may obtain a copy of the License at
7
8       http://www.apache.org/licenses/LICENSE-2.0
9
10   Unless required by applicable law or agreed to in writing, software
11   distributed under the License is distributed on an "AS IS" BASIS,
12   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   See the License for the specific language governing permissions and
14   limitations under the License.
15*/
16
17using System;
18using System.Collections.Generic;
19using System.Linq;
20using System.Text;
21
22using WorkspaceManager.Model;
23using System.Threading;
24using System.Collections;
25using Cryptool.PluginBase;
26using System.Reflection;
27using Gears4Net;
28using System.Windows.Threading;
29using System.Runtime.Remoting.Contexts;
30
31namespace WorkspaceManager.Execution
32{
33    /// <summary>
34    /// Engine to execute a model of the WorkspaceManager
35    /// This class needs a WorkspaceManager to be instantiated
36    /// To run an execution process it also needs a WorkspaceModel
37    ///
38    /// This class uses Gears4Net to execute the plugins
39    /// </summary>
40    public class ExecutionEngine
41    {
42        private WorkspaceManager WorkspaceManagerEditor;
43        private Scheduler[] schedulers;
44        private WorkspaceModel workspaceModel;
45
46        public long ExecutedPluginsCounter { get; set; }
47        public bool BenchmarkPlugins { get; set; }
48        public long GuiUpdateInterval { get; set; }
49
50        /// <summary>
51        /// Creates a new ExecutionEngine
52        /// </summary>
53        /// <param name="workspaceManagerEditor"></param>
54        public ExecutionEngine(WorkspaceManager workspaceManagerEditor)
55        {
56            WorkspaceManagerEditor = workspaceManagerEditor;
57        }
58
59        /// <summary>
60        /// Is this ExecutionEngine running?
61        /// </summary>
62        public bool IsRunning
63        {
64            get;
65            private set;
66        }
67
68        /// <summary>
69        /// Execute the given Model
70        /// </summary>
71        /// <param name="workspaceModel"></param>
72        public void Execute(WorkspaceModel workspaceModel)
73        {
74            this.workspaceModel = workspaceModel;
75
76            if (!IsRunning)
77            {
78                IsRunning = true;
79
80                //Here we create n = "ProcessorsCount * 2" Gears4Net schedulers
81                //We do this, because measurements showed that we get the best performance if we
82                //use this amount of schedulers
83                schedulers = new Scheduler[System.Environment.ProcessorCount*2];
84                for(int i=0;i< System.Environment.ProcessorCount*2;i++){
85                    schedulers[i] = new WorkspaceManagerScheduler("Scheduler" + i);                   
86                }
87               
88                //We have to reset all states of PluginModels, ConnectorModels and ConnectionModels:
89                workspaceModel.resetStates();
90
91                //The UpdateGuiProtocol is a kind of "daemon" which will update the view elements if necessary
92                UpdateGuiProtocol updateGuiProtocol = new UpdateGuiProtocol(schedulers[0], workspaceModel, this);
93                schedulers[0].AddProtocol(updateGuiProtocol);
94                updateGuiProtocol.Start();
95
96                //The BenchmarkProtocl counts the amount of executed plugins per seconds and writes this to debug
97                if (this.BenchmarkPlugins)
98                {
99                    BenchmarkProtocol benchmarkProtocol = new BenchmarkProtocol(schedulers[0], this.workspaceModel, this);
100                    schedulers[0].AddProtocol(benchmarkProtocol);
101                    benchmarkProtocol.Start();
102                }
103
104                //Here we create for each PluginModel an own PluginProtocol
105                //By using round-robin we give each protocol to another scheduler to gain
106                //a good average load balancing of the schedulers
107                //we also initalize each plugin
108                int counter=0;
109                foreach (PluginModel pluginModel in workspaceModel.AllPluginModels)
110                {
111                    pluginModel.Plugin.PreExecution();
112                    PluginProtocol pluginProtocol = new PluginProtocol(schedulers[counter], pluginModel,this);
113                    pluginModel.PluginProtocol = pluginProtocol;
114                    schedulers[counter].AddProtocol(pluginProtocol);
115                   
116                    pluginProtocol.Start();
117                    counter = (counter + 1) % (System.Environment.ProcessorCount*2);
118
119                    if (pluginModel.Startable)
120                    {
121                        MessageExecution msg = new MessageExecution();
122                        msg.PluginModel = pluginModel;
123                        pluginProtocol.BroadcastMessageReliably(msg);
124                    }
125                }
126
127                foreach (Scheduler scheduler in schedulers)
128                {
129                    ((WorkspaceManagerScheduler)scheduler).startScheduler();
130                }
131            }
132        }     
133     
134        /// <summary>
135        /// Stop the execution process:
136        /// calls shutdown on all schedulers + calls stop() on each plugin
137        /// </summary>
138        public void Stop()
139        {
140            //First stop alle plugins
141            foreach (PluginModel pluginModel in workspaceModel.AllPluginModels)
142            {
143                pluginModel.Plugin.Stop();
144                pluginModel.Plugin.PostExecution();
145            }           
146
147            IsRunning = false;
148            //Secondly stop all Gears4Net Schedulers
149            foreach (Scheduler scheduler in schedulers)
150            {
151                scheduler.Shutdown();
152            }
153             
154        }
155
156        /// <summary>
157        /// Pause the execution
158        /// </summary>
159        public void Pause()
160        {
161            //not implemented yet
162        }
163
164        /// <summary>
165        /// Use the logger of the WorkspaceManagerEditor
166        /// </summary>
167        /// <param name="message"></param>
168        /// <param name="level"></param>
169        public void GuiLogMessage(string message, NotificationLevel level)
170        {           
171            WorkspaceManagerEditor.GuiLogMessage(message, level);
172        }           
173    }
174 
175    /// <summary>
176    /// Message send to scheduler for a Plugin to trigger the Execution
177    /// </summary>
178    public class MessageExecution : MessageBase
179    {
180        public PluginModel PluginModel;
181    }
182
183    /// <summary>
184    /// A Protocol for updating the GUI in time intervals
185    /// </summary>
186    public class UpdateGuiProtocol : ProtocolBase
187    {
188        private WorkspaceModel workspaceModel;
189        private ExecutionEngine executionEngine;     
190
191        /// <summary>
192        /// Create a new protocol. Each protocol requires a scheduler which provides
193        /// a thread for execution.
194        /// </summary>
195        /// <param name="scheduler"></param>
196        public UpdateGuiProtocol(Scheduler scheduler, WorkspaceModel workspaceModel, ExecutionEngine executionEngine)
197            : base(scheduler)
198        {
199            this.workspaceModel = workspaceModel;
200            this.executionEngine = executionEngine;           
201        }
202
203        /// <summary>
204        /// The main function of the protocol
205        /// </summary>
206        /// <param name="stateMachine"></param>
207        /// <returns></returns>
208        public override System.Collections.Generic.IEnumerator<ReceiverBase> Execute(AbstractStateMachine stateMachine)
209        {
210            while (this.executionEngine.IsRunning)
211            {
212                yield return Timeout(this.executionEngine.GuiUpdateInterval, HandleUpdateGui);
213            }
214        }
215
216        /// <summary>
217        /// Handler function for a message.
218        /// This handler must not block, because it executes inside the thread of the scheduler.
219        /// </summary>
220        /// <param name="msg"></param>
221        private void HandleUpdateGui()
222        {
223            //Get the gui Thread
224            this.workspaceModel.WorkspaceManagerEditor.Presentation.Dispatcher.Invoke(DispatcherPriority.Normal, (SendOrPostCallback)delegate
225            {
226                foreach (PluginModel pluginModel in workspaceModel.AllPluginModels)
227                {
228                    if (pluginModel.GuiNeedsUpdate)
229                    {
230                        //executionEngine.GuiLogMessage("UpdateGui for \"" + pluginModel.Name + "\"", NotificationLevel.Debug);
231                        pluginModel.GuiNeedsUpdate = false;
232                        pluginModel.paint();
233                        if (pluginModel.UpdateableView != null)
234                        {
235                            pluginModel.UpdateableView.update();
236                        }
237                    }
238                }
239                foreach (ConnectionModel connectionModel in workspaceModel.AllConnectionModels)
240                {
241                    if (connectionModel.GuiNeedsUpdate)
242                    {
243                        if (connectionModel.UpdateableView != null)
244                        {
245                            connectionModel.UpdateableView.update();
246                        }
247                    }
248                }
249            }
250            , null);
251        }
252    }
253   
254    /// <summary>
255    /// A Protocol for benchmarking
256    /// </summary>
257    public class BenchmarkProtocol : ProtocolBase
258    {
259        private WorkspaceModel workspaceModel;
260        private ExecutionEngine executionEngine;
261
262        /// <summary>
263        /// Create a new protocol. Each protocol requires a scheduler which provides
264        /// a thread for execution.
265        /// </summary>
266        /// <param name="scheduler"></param>
267        public BenchmarkProtocol(Scheduler scheduler, WorkspaceModel workspaceModel, ExecutionEngine executionEngine)
268            : base(scheduler)
269        {
270            this.workspaceModel = workspaceModel;
271            this.executionEngine = executionEngine;
272        }
273
274        /// <summary>
275        /// The main function of the protocol
276        /// </summary>
277        /// <param name="stateMachine"></param>
278        /// <returns></returns>
279        public override System.Collections.Generic.IEnumerator<ReceiverBase> Execute(AbstractStateMachine stateMachine)
280        {
281            while (this.executionEngine.IsRunning)
282            {
283                yield return Timeout(1000, HandleBenchmark);
284            }
285        }
286
287        /// <summary>
288        /// Handler function for a message.
289        /// This handler must not block, because it executes inside the thread of the scheduler.
290        /// </summary>
291        /// <param name="msg"></param>
292        private void HandleBenchmark()
293        {
294            this.workspaceModel.WorkspaceManagerEditor.GuiLogMessage("Executing at about " + this.executionEngine.ExecutedPluginsCounter + " Plugins/s", NotificationLevel.Debug);
295            this.executionEngine.ExecutedPluginsCounter = 0;
296        }
297
298    }
299
300    /// <summary>
301    /// A Protocol for a PluginModel
302    /// </summary>
303    public class PluginProtocol : ProtocolBase
304    {
305        public PluginModel PluginModel;
306        private ExecutionEngine executionEngine;
307
308        /// <summary>
309        /// Create a new protocol. Each protocol requires a scheduler which provides
310        /// a thread for execution.
311        /// </summary>
312        /// <param name="scheduler"></param>
313        public PluginProtocol(Scheduler scheduler, PluginModel pluginModel,ExecutionEngine executionEngine)
314            : base(scheduler)
315        {
316            this.PluginModel = pluginModel;
317            this.executionEngine = executionEngine;
318        }
319
320        /// <summary>
321        /// The main function of the protocol     
322        /// </summary>
323        /// <param name="stateMachine"></param>
324        /// <returns></returns>
325        public override System.Collections.Generic.IEnumerator<ReceiverBase> Execute(AbstractStateMachine stateMachine)
326        {
327            while (this.executionEngine.IsRunning)
328            {
329                yield return Receive<MessageExecution>(null, this.HandleExecute);
330                //yield return Parallel(1,new PluginWaitReceiver()) & Receive<MessageExecution>(null, this.HandleExecute);
331                //yield return new PluginWaitReceiver() + Receive<MessageExecution>(null, this.HandleExecute);
332                //yield return Parallel(1,new PluginWaitReceiver()) + Receive<MessageExecution>(null, this.HandleExecute);
333            }
334        }
335
336        /// <summary>
337        /// Call the execution function of the wrapped IPlugin
338        /// </summary>
339        /// <param name="msg"></param>
340        private void HandleExecute(MessageExecution msg)
341        {
342            //executionEngine.GuiLogMessage("HandleExecute for \"" + msg.PluginModel.Name + "\"", NotificationLevel.Debug);
343            //Fill the plugins Inputs with data
344            foreach (ConnectorModel connectorModel in PluginModel.InputConnectors)
345            {
346                if (connectorModel.HasData)
347                {
348                    try
349                    {
350                        if (connectorModel.IsDynamic)
351                        {
352                            MethodInfo propertyInfo = PluginModel.Plugin.GetType().GetMethod(connectorModel.DynamicSetterName);
353                            propertyInfo.Invoke(PluginModel.Plugin, new object[] { connectorModel.PropertyName, connectorModel.Data });
354                        }
355                        else
356                        {
357                            PropertyInfo propertyInfo = PluginModel.Plugin.GetType().GetProperty(connectorModel.PropertyName);
358                            propertyInfo.SetValue(PluginModel.Plugin, connectorModel.Data, null);
359                        }
360
361                    }
362                    catch (Exception ex)
363                    {
364                        this.PluginModel.WorkspaceModel.WorkspaceManagerEditor.GuiLogMessage("An error occured while setting value of connector \"" + connectorModel.Name + "\" of \"" + PluginModel + "\": " + ex.Message, NotificationLevel.Error);
365                        this.PluginModel.State = PluginModelState.Error;
366                        this.PluginModel.GuiNeedsUpdate = true;
367                        return;
368                    }
369                    finally
370                    {
371                        connectorModel.HasData = false;
372                        connectorModel.Data = null;
373                        foreach (ConnectionModel connectionModel in connectorModel.InputConnections)
374                        {
375                            connectionModel.Active = false;
376                            connectorModel.GuiNeedsUpdate = true;
377                        }
378                    }
379                }
380            }
381           
382            msg.PluginModel.Plugin.Execute();         
383
384            if (this.executionEngine.BenchmarkPlugins)
385            {
386                this.executionEngine.ExecutedPluginsCounter++;                               
387            }
388        }
389     
390    }
391
392    public class WorkspaceManagerScheduler : Scheduler
393    {
394        private System.Threading.AutoResetEvent wakeup = new System.Threading.AutoResetEvent(false);
395        private bool shutdown = false;
396        private System.Threading.Thread thread;
397        private Context currentContext;
398
399                public WorkspaceManagerScheduler() : this(String.Empty)
400                {
401
402                }
403
404        public WorkspaceManagerScheduler(string name)
405            : base()
406        {
407            this.currentContext = Thread.CurrentContext;
408
409            thread = new System.Threading.Thread(this.Start);
410            thread.SetApartmentState(System.Threading.ApartmentState.MTA);
411                        thread.Name = name;
412           
413        }
414
415        public void startScheduler()
416        {
417            thread.Start();
418        }
419
420        private void Start()
421        {
422            if (this.currentContext != Thread.CurrentContext)
423                this.currentContext.DoCallBack(Start);
424
425            // Loop forever
426            while (true)
427            {
428                this.wakeup.WaitOne();
429
430                // Loop while there are more protocols waiting
431                while (true)
432                {
433                    // Should the scheduler stop?
434                    if (this.shutdown)
435                        return;
436                   
437                    bool donotrun = false;
438                    ProtocolBase protocol = null;
439                    lock (this)
440                    {
441                        // No more protocols? -> Wait
442                        if (this.waitingProtocols.Count == 0)
443                            break;
444
445                        protocol = this.waitingProtocols.Dequeue();
446
447                        if (protocol is PluginProtocol)
448                        {
449                            PluginProtocol pluginProtocol = (PluginProtocol)protocol;
450                            foreach (ConnectorModel outputConnector in pluginProtocol.PluginModel.OutputConnectors)
451                            {
452                                foreach (ConnectionModel connection in outputConnector.OutputConnections)
453                                {                                   
454                                    if (connection.To.HasData &&
455                                        connection.To.PluginModel != pluginProtocol.PluginModel &&
456                                        donotrun == false)
457                                    {                                           
458                                        this.waitingProtocols.Enqueue(protocol);
459                                        donotrun = true;
460                                    }
461                                 
462                                }
463                            }               
464                        }
465
466                    }
467
468                    if (donotrun == false)
469                    {
470                        ProtocolStatus status = protocol.Run();
471
472                        lock (this)
473                        {
474                            switch (status)
475                            {
476                                case ProtocolStatus.Created:
477                                    System.Diagnostics.Debug.Assert(false);
478                                    break;
479                                case ProtocolStatus.Ready:
480                                    this.waitingProtocols.Enqueue(protocol);
481                                    break;
482                                case ProtocolStatus.Waiting:
483                                    break;
484                                case ProtocolStatus.Terminated:
485                                    System.Diagnostics.Debug.Assert(!this.waitingProtocols.Contains(protocol));
486                                    this.RemoveProtocol(protocol);
487                                    break;
488                            }
489                        }
490                    }
491                }
492            }
493        }
494
495        public override void RemoveProtocol(ProtocolBase protocol)
496        {
497            lock (this)
498            {
499                this.protocols.Remove(protocol);
500                if (this.protocols.Count == 0)
501                    this.Shutdown();
502            }
503        }
504
505        public override void AddProtocol(ProtocolBase protocol)
506        {
507            lock (this)
508            {
509                this.protocols.Add(protocol);
510            }
511        }
512
513        public override void Wakeup(ProtocolBase protocol)
514        {
515            lock (this)
516            {
517                if (!this.waitingProtocols.Contains(protocol))
518                    this.waitingProtocols.Enqueue(protocol);
519                this.wakeup.Set();
520            }
521        }
522
523        public override void Shutdown()
524        {
525            this.shutdown = true;
526            this.wakeup.Set();
527        }
528    }
529}
Note: See TracBrowser for help on using the repository browser.