[2] | 1 | #region License Information
|
---|
| 2 | /* HeuristicLab
|
---|
[7270] | 3 | * Copyright (C) 2002-2012 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
|
---|
[2] | 4 | *
|
---|
| 5 | * This file is part of HeuristicLab.
|
---|
| 6 | *
|
---|
| 7 | * HeuristicLab is free software: you can redistribute it and/or modify
|
---|
| 8 | * it under the terms of the GNU General Public License as published by
|
---|
| 9 | * the Free Software Foundation, either version 3 of the License, or
|
---|
| 10 | * (at your option) any later version.
|
---|
| 11 | *
|
---|
| 12 | * HeuristicLab is distributed in the hope that it will be useful,
|
---|
| 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
|
---|
| 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
---|
| 15 | * GNU General Public License for more details.
|
---|
| 16 | *
|
---|
| 17 | * You should have received a copy of the GNU General Public License
|
---|
| 18 | * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
|
---|
| 19 | */
|
---|
| 20 | #endregion
|
---|
| 21 |
|
---|
| 22 | using System;
|
---|
| 23 | using System.Collections.Generic;
|
---|
| 24 | using System.Threading;
|
---|
[5193] | 25 | using System.Threading.Tasks;
|
---|
[3376] | 26 | using HeuristicLab.Common;
|
---|
[1823] | 27 | using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
|
---|
[2] | 28 |
|
---|
| 29 | namespace HeuristicLab.Core {
|
---|
[2664] | 30 | [Item("Engine", "A base class for engines.")]
|
---|
[3017] | 31 | [StorableClass]
|
---|
[3262] | 32 | public abstract class Engine : Executable, IEngine {
|
---|
[2653] | 33 | [Storable]
|
---|
[3289] | 34 | protected ILog log;
|
---|
| 35 | public ILog Log {
|
---|
| 36 | get { return log; }
|
---|
| 37 | }
|
---|
| 38 |
|
---|
| 39 | [Storable]
|
---|
[2834] | 40 | private Stack<IOperation> executionStack;
|
---|
| 41 | protected Stack<IOperation> ExecutionStack {
|
---|
[2653] | 42 | get { return executionStack; }
|
---|
[2] | 43 | }
|
---|
[1667] | 44 |
|
---|
[5193] | 45 | #region Variables for communication between threads
|
---|
| 46 | private CancellationTokenSource cancellationTokenSource;
|
---|
| 47 | private bool stopPending;
|
---|
[3262] | 48 | private DateTime lastUpdateTime;
|
---|
[5193] | 49 | #endregion
|
---|
[776] | 50 |
|
---|
[4722] | 51 | [StorableConstructor]
|
---|
[5193] | 52 | protected Engine(bool deserializing) : base(deserializing) { }
|
---|
[4722] | 53 | protected Engine(Engine original, Cloner cloner)
|
---|
| 54 | : base(original, cloner) {
|
---|
| 55 | log = cloner.Clone(original.log);
|
---|
| 56 | executionStack = new Stack<IOperation>();
|
---|
| 57 | IOperation[] contexts = original.executionStack.ToArray();
|
---|
| 58 | for (int i = contexts.Length - 1; i >= 0; i--)
|
---|
| 59 | executionStack.Push(cloner.Clone(contexts[i]));
|
---|
| 60 | }
|
---|
| 61 | protected Engine()
|
---|
| 62 | : base() {
|
---|
| 63 | log = new Log();
|
---|
| 64 | executionStack = new Stack<IOperation>();
|
---|
[3289] | 65 | }
|
---|
[2] | 66 |
|
---|
[3262] | 67 | public sealed override void Prepare() {
|
---|
| 68 | base.Prepare();
|
---|
| 69 | executionStack.Clear();
|
---|
| 70 | OnPrepared();
|
---|
| 71 | }
|
---|
[2834] | 72 | public void Prepare(IOperation initialOperation) {
|
---|
[3262] | 73 | base.Prepare();
|
---|
[2653] | 74 | executionStack.Clear();
|
---|
[2834] | 75 | if (initialOperation != null)
|
---|
| 76 | executionStack.Push(initialOperation);
|
---|
[2790] | 77 | OnPrepared();
|
---|
[2] | 78 | }
|
---|
[3289] | 79 | protected override void OnPrepared() {
|
---|
| 80 | Log.LogMessage("Engine prepared");
|
---|
| 81 | base.OnPrepared();
|
---|
| 82 | }
|
---|
| 83 |
|
---|
[3262] | 84 | public override void Start() {
|
---|
| 85 | base.Start();
|
---|
[5193] | 86 | cancellationTokenSource = new CancellationTokenSource();
|
---|
| 87 | stopPending = false;
|
---|
| 88 | Task task = Task.Factory.StartNew(Run, cancellationTokenSource.Token, cancellationTokenSource.Token);
|
---|
| 89 | task.ContinueWith(t => {
|
---|
| 90 | try {
|
---|
| 91 | t.Wait();
|
---|
| 92 | }
|
---|
| 93 | catch (AggregateException ex) {
|
---|
| 94 | try {
|
---|
| 95 | ex.Flatten().Handle(x => x is OperationCanceledException);
|
---|
| 96 | }
|
---|
| 97 | catch (AggregateException remaining) {
|
---|
| 98 | if (remaining.InnerExceptions.Count == 1) OnExceptionOccurred(remaining.InnerExceptions[0]);
|
---|
| 99 | else OnExceptionOccurred(remaining);
|
---|
| 100 | }
|
---|
| 101 | }
|
---|
| 102 | cancellationTokenSource.Dispose();
|
---|
| 103 | cancellationTokenSource = null;
|
---|
| 104 | if (stopPending) executionStack.Clear();
|
---|
| 105 | if (executionStack.Count == 0) OnStopped();
|
---|
| 106 | else OnPaused();
|
---|
| 107 | });
|
---|
[2] | 108 | }
|
---|
[3289] | 109 | protected override void OnStarted() {
|
---|
| 110 | Log.LogMessage("Engine started");
|
---|
| 111 | base.OnStarted();
|
---|
| 112 | }
|
---|
| 113 |
|
---|
[3262] | 114 | public override void Pause() {
|
---|
| 115 | base.Pause();
|
---|
[5193] | 116 | cancellationTokenSource.Cancel();
|
---|
[2] | 117 | }
|
---|
[3289] | 118 | protected override void OnPaused() {
|
---|
| 119 | Log.LogMessage("Engine paused");
|
---|
| 120 | base.OnPaused();
|
---|
| 121 | }
|
---|
| 122 |
|
---|
[3262] | 123 | public override void Stop() {
|
---|
| 124 | base.Stop();
|
---|
[5193] | 125 | if (ExecutionState == ExecutionState.Paused) {
|
---|
| 126 | executionStack.Clear();
|
---|
| 127 | OnStopped();
|
---|
| 128 | } else {
|
---|
| 129 | stopPending = true;
|
---|
| 130 | cancellationTokenSource.Cancel();
|
---|
| 131 | }
|
---|
[2] | 132 | }
|
---|
[3289] | 133 | protected override void OnStopped() {
|
---|
| 134 | Log.LogMessage("Engine stopped");
|
---|
| 135 | base.OnStopped();
|
---|
| 136 | }
|
---|
[2] | 137 |
|
---|
[3289] | 138 | protected override void OnExceptionOccurred(Exception exception) {
|
---|
| 139 | Log.LogException(exception);
|
---|
| 140 | base.OnExceptionOccurred(exception);
|
---|
| 141 | }
|
---|
| 142 |
|
---|
[2] | 143 | private void Run(object state) {
|
---|
[5193] | 144 | CancellationToken cancellationToken = (CancellationToken)state;
|
---|
| 145 |
|
---|
[2653] | 146 | OnStarted();
|
---|
[3262] | 147 | lastUpdateTime = DateTime.Now;
|
---|
[5240] | 148 | System.Timers.Timer timer = new System.Timers.Timer(250);
|
---|
[5193] | 149 | timer.AutoReset = true;
|
---|
| 150 | timer.Elapsed += new System.Timers.ElapsedEventHandler(timer_Elapsed);
|
---|
[3262] | 151 | timer.Start();
|
---|
[5193] | 152 | try {
|
---|
| 153 | Run(cancellationToken);
|
---|
[2] | 154 | }
|
---|
[5193] | 155 | finally {
|
---|
[5444] | 156 | timer.Elapsed -= new System.Timers.ElapsedEventHandler(timer_Elapsed);
|
---|
[5193] | 157 | timer.Stop();
|
---|
| 158 | ExecutionTime += DateTime.Now - lastUpdateTime;
|
---|
| 159 | }
|
---|
[3262] | 160 |
|
---|
[5193] | 161 | cancellationToken.ThrowIfCancellationRequested();
|
---|
[2] | 162 | }
|
---|
[5193] | 163 | protected abstract void Run(CancellationToken cancellationToken);
|
---|
[2] | 164 |
|
---|
[3262] | 165 | private void timer_Elapsed(object sender, System.Timers.ElapsedEventArgs e) {
|
---|
[5240] | 166 | System.Timers.Timer timer = (System.Timers.Timer)sender;
|
---|
| 167 | timer.Enabled = false;
|
---|
[3262] | 168 | DateTime now = DateTime.Now;
|
---|
| 169 | ExecutionTime += now - lastUpdateTime;
|
---|
| 170 | lastUpdateTime = now;
|
---|
[5240] | 171 | timer.Enabled = true;
|
---|
[3226] | 172 | }
|
---|
[2] | 173 | }
|
---|
| 174 | }
|
---|