source: branches/Async/HeuristicLab.Algorithms.Benchmarks/3.3/BenchmarkAlgorithm.cs @ 13354

Last change on this file since 13354 was 13354, checked in by jkarder, 4 years ago

#2258: improved cancellation support

File size: 19.4 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2015 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
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
22using System;
23using System.Collections.Generic;
24using System.Drawing;
25using System.Linq;
26using System.Threading;
27using System.Threading.Tasks;
28using HeuristicLab.Collections;
29using HeuristicLab.Common;
30using HeuristicLab.Core;
31using HeuristicLab.Data;
32using HeuristicLab.Optimization;
33using HeuristicLab.Parameters;
34using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
35using HeuristicLab.PluginInfrastructure;
36
37namespace HeuristicLab.Algorithms.Benchmarks {
38  [Item("Benchmark Algorithm", "An algorithm to execute performance benchmarks (Linpack, Dhrystone, Whetstone, etc.).")]
39  [Creatable(CreatableAttribute.Categories.TestingAndAnalysis, Priority = 130)]
40  [StorableClass]
41  public sealed class BenchmarkAlgorithm : IAlgorithm {
42    private CancellationTokenSource cancellationTokenSource;
43
44    public string ItemName {
45      get { return ItemAttribute.GetName(this.GetType()); }
46    }
47    public string ItemDescription {
48      get { return ItemAttribute.GetDescription(this.GetType()); }
49    }
50    public Version ItemVersion {
51      get { return ItemAttribute.GetVersion(this.GetType()); }
52    }
53    public static Image StaticItemImage {
54      get { return HeuristicLab.Common.Resources.VSImageLibrary.Event; }
55    }
56    public Image ItemImage {
57      get {
58        if (ExecutionState == ExecutionState.Prepared) return HeuristicLab.Common.Resources.VSImageLibrary.ExecutablePrepared;
59        else if (ExecutionState == ExecutionState.Started) return HeuristicLab.Common.Resources.VSImageLibrary.ExecutableStarted;
60        else if (ExecutionState == ExecutionState.Paused) return HeuristicLab.Common.Resources.VSImageLibrary.ExecutablePaused;
61        else if (ExecutionState == ExecutionState.Stopped) return HeuristicLab.Common.Resources.VSImageLibrary.ExecutableStopped;
62        else return ItemAttribute.GetImage(this.GetType());
63      }
64    }
65
66    [Storable]
67    private DateTime lastUpdateTime;
68
69    [Storable]
70    private IBenchmark benchmark;
71    public IBenchmark Benchmark {
72      get { return benchmark; }
73      set {
74        if (value == null) throw new ArgumentNullException();
75        benchmark = value;
76      }
77    }
78
79    [Storable]
80    private ExecutionState executionState;
81    public ExecutionState ExecutionState {
82      get { return executionState; }
83      private set {
84        if (executionState != value) {
85          executionState = value;
86          OnExecutionStateChanged();
87          OnItemImageChanged();
88        }
89      }
90    }
91
92    [Storable]
93    private TimeSpan executionTime;
94    public TimeSpan ExecutionTime {
95      get { return executionTime; }
96      private set {
97        executionTime = value;
98        OnExecutionTimeChanged();
99      }
100    }
101
102    [Storable]
103    private bool storeAlgorithmInEachRun;
104    public bool StoreAlgorithmInEachRun {
105      get { return storeAlgorithmInEachRun; }
106      set {
107        if (storeAlgorithmInEachRun != value) {
108          storeAlgorithmInEachRun = value;
109          OnStoreAlgorithmInEachRunChanged();
110        }
111      }
112    }
113
114    [Storable]
115    private int runsCounter;
116
117    [Storable]
118    private RunCollection runs = new RunCollection();
119    public RunCollection Runs {
120      get { return runs; }
121      private set {
122        if (value == null) throw new ArgumentNullException();
123        if (runs != value) {
124          if (runs != null) DeregisterRunsEvents();
125          runs = value;
126          if (runs != null) RegisterRunsEvents();
127        }
128      }
129    }
130
131    [Storable]
132    private ResultCollection results;
133    public ResultCollection Results {
134      get { return results; }
135    }
136
137    public Type ProblemType {
138      get {
139        // BenchmarkAlgorithm does not have a problem, so return a type which is no problem for sure
140        return typeof(BenchmarkAlgorithm);
141      }
142    }
143
144    public IProblem Problem {
145      get { return null; }
146      set { throw new NotImplementedException("BenchmarkAlgorithm does not have a problem."); }
147    }
148
149    [Storable]
150    private string name;
151    public string Name {
152      get { return name; }
153      set {
154        if (!CanChangeName) throw new NotSupportedException("Name cannot be changed.");
155        if (!(name.Equals(value) || (value == null) && (name == string.Empty))) {
156          CancelEventArgs<string> e = value == null ? new CancelEventArgs<string>(string.Empty) : new CancelEventArgs<string>(value);
157          OnNameChanging(e);
158          if (!e.Cancel) {
159            name = value == null ? string.Empty : value;
160            OnNameChanged();
161            runs.OptimizerName = name;
162          }
163        }
164      }
165    }
166    public bool CanChangeName {
167      get { return true; }
168    }
169
170    [Storable]
171    private string description;
172    public string Description {
173      get { return description; }
174      set {
175        if (!CanChangeDescription) throw new NotSupportedException("Description cannot be changed.");
176        if (!(description.Equals(value) || (value == null) && (description == string.Empty))) {
177          description = value == null ? string.Empty : value;
178          OnDescriptionChanged();
179        }
180      }
181    }
182    public bool CanChangeDescription {
183      get { return true; }
184    }
185
186    [Storable]
187    private ParameterCollection parameters = new ParameterCollection();
188    public IKeyedItemCollection<string, IParameter> Parameters {
189      get { return parameters; }
190    }
191    private ReadOnlyKeyedItemCollection<string, IParameter> readOnlyParameters;
192    IKeyedItemCollection<string, IParameter> IParameterizedItem.Parameters {
193      get {
194        if (readOnlyParameters == null) readOnlyParameters = parameters.AsReadOnly();
195        return readOnlyParameters;
196      }
197    }
198
199    public IEnumerable<IOptimizer> NestedOptimizers {
200      get { return Enumerable.Empty<IOptimizer>(); }
201    }
202
203    #region Parameter Properties
204    public IConstrainedValueParameter<IBenchmark> BenchmarkParameter {
205      get { return (IConstrainedValueParameter<IBenchmark>)Parameters["Benchmark"]; }
206    }
207    private ValueParameter<IntValue> ChunkSizeParameter {
208      get { return (ValueParameter<IntValue>)Parameters["ChunkSize"]; }
209    }
210    private ValueParameter<DoubleValue> TimeLimitParameter {
211      get { return (ValueParameter<DoubleValue>)Parameters["TimeLimit"]; }
212    }
213    #endregion
214
215    #region Constructors
216    [StorableConstructor]
217    private BenchmarkAlgorithm(bool deserializing) { }
218    private BenchmarkAlgorithm(BenchmarkAlgorithm original, Cloner cloner) {
219      if (original.ExecutionState == ExecutionState.Started) throw new InvalidOperationException(string.Format("Clone not allowed in execution state \"{0}\".", ExecutionState));
220      cloner.RegisterClonedObject(original, this);
221      name = original.name;
222      description = original.description;
223      parameters = cloner.Clone(original.parameters);
224      readOnlyParameters = null;
225      executionState = original.executionState;
226      executionTime = original.executionTime;
227      storeAlgorithmInEachRun = original.storeAlgorithmInEachRun;
228      runsCounter = original.runsCounter;
229      Runs = cloner.Clone(original.runs);
230      results = cloner.Clone(original.results);
231    }
232    public BenchmarkAlgorithm() {
233      name = ItemName;
234      description = ItemDescription;
235      parameters = new ParameterCollection();
236      readOnlyParameters = null;
237      executionState = ExecutionState.Stopped;
238      executionTime = TimeSpan.Zero;
239      storeAlgorithmInEachRun = false;
240      runsCounter = 0;
241      Runs = new RunCollection() { OptimizerName = name };
242      results = new ResultCollection();
243      CreateParameters();
244      DiscoverBenchmarks();
245      Prepare();
246    }
247    #endregion
248
249    private void CreateParameters() {
250      Parameters.Add(new ValueParameter<IntValue>("ChunkSize", "The size in MB of the chunk data array that is generated.", new IntValue(0)));
251      Parameters.Add(new ValueParameter<DoubleValue>("TimeLimit", "The time limit in minutes for a benchmark run (zero means a fixed number of iterations).", new DoubleValue(0)));
252    }
253    private void DiscoverBenchmarks() {
254      var benchmarks = from t in ApplicationManager.Manager.GetTypes(typeof(IBenchmark))
255                       select t;
256      ItemSet<IBenchmark> values = new ItemSet<IBenchmark>();
257      foreach (var benchmark in benchmarks) {
258        IBenchmark b = (IBenchmark)Activator.CreateInstance(benchmark);
259        values.Add(b);
260      }
261      string paramName = "Benchmark";
262      if (!Parameters.ContainsKey(paramName)) {
263        if (values.Count > 0) {
264          Parameters.Add(new ConstrainedValueParameter<IBenchmark>(paramName, "The benchmark which should be executed.", values, values.First(a => a is IBenchmark)));
265        } else {
266          Parameters.Add(new ConstrainedValueParameter<IBenchmark>(paramName, "The benchmark which should be executed.", values));
267        }
268      }
269    }
270
271    public IDeepCloneable Clone(Cloner cloner) {
272      return new BenchmarkAlgorithm(this, cloner);
273    }
274    public object Clone() {
275      return Clone(new Cloner());
276    }
277
278    public override string ToString() {
279      return Name;
280    }
281
282    public void Prepare() {
283      if ((ExecutionState != ExecutionState.Prepared) && (ExecutionState != ExecutionState.Paused) && (ExecutionState != ExecutionState.Stopped))
284        throw new InvalidOperationException(string.Format("Prepare not allowed in execution state \"{0}\".", ExecutionState));
285      results.Clear();
286      OnPrepared();
287    }
288    public void Prepare(bool clearRuns) {
289      if ((ExecutionState != ExecutionState.Prepared) && (ExecutionState != ExecutionState.Paused) && (ExecutionState != ExecutionState.Stopped))
290        throw new InvalidOperationException(string.Format("Prepare not allowed in execution state \"{0}\".", ExecutionState));
291      if (clearRuns) runs.Clear();
292      Prepare();
293    }
294    public void Pause() {
295      if (ExecutionState != ExecutionState.Started)
296        throw new InvalidOperationException(string.Format("Pause not allowed in execution state \"{0}\".", ExecutionState));
297    }
298    public void Stop() {
299      if ((ExecutionState != ExecutionState.Started) && (ExecutionState != ExecutionState.Paused))
300        throw new InvalidOperationException(string.Format("Stop not allowed in execution state \"{0}\".", ExecutionState));
301      cancellationTokenSource.Cancel();
302    }
303    public void Start() {
304      StartAsync().Wait();
305    }
306    public async Task StartAsync() {
307      await StartAsync(CancellationToken.None);
308    }
309    public async Task StartAsync(CancellationToken cancellationToken) {
310      cancellationTokenSource = new CancellationTokenSource();
311      OnStarted();
312      using (var cts = CancellationTokenSource.CreateLinkedTokenSource(cancellationTokenSource.Token, cancellationToken)) {
313        Task task = Task.Factory.StartNew(Run, cts.Token, cts.Token);
314        await task.ContinueWith(t => {
315          try {
316            t.Wait();
317          }
318          catch (AggregateException ex) {
319            try {
320              ex.Flatten().Handle(x => x is OperationCanceledException);
321            }
322            catch (AggregateException remaining) {
323              if (remaining.InnerExceptions.Count == 1) OnExceptionOccurred(remaining.InnerExceptions[0]);
324              else OnExceptionOccurred(remaining);
325            }
326          }
327
328          cancellationTokenSource.Dispose();
329          cancellationTokenSource = null;
330          OnStopped();
331        });
332      }
333    }
334    private void Run(object state) {
335      CancellationToken cancellationToken = (CancellationToken)state;
336      lastUpdateTime = DateTime.UtcNow;
337      System.Timers.Timer timer = new System.Timers.Timer(250);
338      timer.AutoReset = true;
339      timer.Elapsed += new System.Timers.ElapsedEventHandler(timer_Elapsed);
340      timer.Start();
341      try {
342        Benchmark = (IBenchmark)BenchmarkParameter.ActualValue;
343        int chunkSize = ((IntValue)ChunkSizeParameter.ActualValue).Value;
344        if (chunkSize > 0) {
345          Benchmark.ChunkData = CreateChunkData(chunkSize);
346        } else if (chunkSize < 0) {
347          throw new ArgumentException("ChunkSize must not be negativ.");
348        }
349        TimeSpan timelimit = TimeSpan.FromMinutes(((DoubleValue)TimeLimitParameter.ActualValue).Value);
350        if (timelimit.TotalMilliseconds < 0) {
351          throw new ArgumentException("TimeLimit must not be negativ. ");
352        }
353        Benchmark.TimeLimit = timelimit;
354        Benchmark.Run(cancellationToken, results);
355      }
356      catch (OperationCanceledException) {
357      }
358      finally {
359        timer.Elapsed -= new System.Timers.ElapsedEventHandler(timer_Elapsed);
360        timer.Stop();
361        ExecutionTime += DateTime.UtcNow - lastUpdateTime;
362      }
363    }
364
365    private void timer_Elapsed(object sender, System.Timers.ElapsedEventArgs e) {
366      System.Timers.Timer timer = (System.Timers.Timer)sender;
367      timer.Enabled = false;
368      DateTime now = DateTime.UtcNow;
369      ExecutionTime += now - lastUpdateTime;
370      lastUpdateTime = now;
371      timer.Enabled = true;
372    }
373
374    public void CollectResultValues(IDictionary<string, IItem> values) {
375      values.Add("Execution Time", new TimeSpanValue(ExecutionTime));
376      CollectResultsRecursively("", Results, values);
377    }
378    private void CollectResultsRecursively(string path, ResultCollection results, IDictionary<string, IItem> values) {
379      foreach (IResult result in results) {
380        values.Add(path + result.Name, result.Value);
381        ResultCollection childCollection = result.Value as ResultCollection;
382        if (childCollection != null) {
383          CollectResultsRecursively(path + result.Name + ".", childCollection, values);
384        }
385      }
386    }
387    public void CollectParameterValues(IDictionary<string, IItem> values) {
388      foreach (IValueParameter param in parameters.OfType<IValueParameter>()) {
389        if (param.GetsCollected && param.Value != null) values.Add(param.Name, param.Value);
390        if (param.Value is IParameterizedItem) {
391          Dictionary<string, IItem> children = new Dictionary<string, IItem>();
392          ((IParameterizedItem)param.Value).CollectParameterValues(children);
393          foreach (string key in children.Keys)
394            values.Add(param.Name + "." + key, children[key]);
395        }
396      }
397    }
398
399    private byte[][] CreateChunkData(int megaBytes) {
400      if (megaBytes <= 0) {
401        throw new ArgumentException("MegaBytes must be greater than zero", "megaBytes");
402      }
403      Random random = new Random();
404      byte[][] chunk = new byte[megaBytes][];
405      for (int i = 0; i < chunk.Length; i++) {
406        chunk[i] = new byte[1024 * 1024];
407        random.NextBytes(chunk[i]);
408      }
409      return chunk;
410    }
411
412    #region Events
413    public event EventHandler ExecutionStateChanged;
414    private void OnExecutionStateChanged() {
415      EventHandler handler = ExecutionStateChanged;
416      if (handler != null) handler(this, EventArgs.Empty);
417    }
418    public event EventHandler ExecutionTimeChanged;
419    private void OnExecutionTimeChanged() {
420      EventHandler handler = ExecutionTimeChanged;
421      if (handler != null) handler(this, EventArgs.Empty);
422    }
423    public event EventHandler ProblemChanged { add { } remove { } }
424    public event EventHandler StoreAlgorithmInEachRunChanged;
425    private void OnStoreAlgorithmInEachRunChanged() {
426      EventHandler handler = StoreAlgorithmInEachRunChanged;
427      if (handler != null) handler(this, EventArgs.Empty);
428    }
429    public event EventHandler Prepared;
430    private void OnPrepared() {
431      ExecutionState = ExecutionState.Prepared;
432      ExecutionTime = TimeSpan.Zero;
433      foreach (IStatefulItem statefulObject in this.GetObjectGraphObjects().OfType<IStatefulItem>()) {
434        statefulObject.InitializeState();
435      }
436      EventHandler handler = Prepared;
437      if (handler != null) handler(this, EventArgs.Empty);
438    }
439    public event EventHandler Started;
440    private void OnStarted() {
441      ExecutionState = ExecutionState.Started;
442      EventHandler handler = Started;
443      if (handler != null) handler(this, EventArgs.Empty);
444    }
445    public event EventHandler Paused;
446    private void OnPaused() {
447      ExecutionState = ExecutionState.Paused;
448      EventHandler handler = Paused;
449      if (handler != null) handler(this, EventArgs.Empty);
450    }
451    public event EventHandler Stopped;
452    private void OnStopped() {
453      ExecutionState = ExecutionState.Stopped;
454      foreach (IStatefulItem statefulObject in this.GetObjectGraphObjects().OfType<IStatefulItem>()) {
455        statefulObject.ClearState();
456      }
457      runsCounter++;
458      runs.Add(new Run(string.Format("{0} Run {1}", Name, runsCounter), this));
459      EventHandler handler = Stopped;
460      if (handler != null) handler(this, EventArgs.Empty);
461    }
462    public event EventHandler<EventArgs<Exception>> ExceptionOccurred;
463    private void OnExceptionOccurred(Exception exception) {
464      EventHandler<EventArgs<Exception>> handler = ExceptionOccurred;
465      if (handler != null) handler(this, new EventArgs<Exception>(exception));
466    }
467
468    public event EventHandler<CancelEventArgs<string>> NameChanging;
469    private void OnNameChanging(CancelEventArgs<string> e) {
470      var handler = NameChanging;
471      if (handler != null) handler(this, e);
472    }
473
474    public event EventHandler NameChanged;
475    private void OnNameChanged() {
476      var handler = NameChanged;
477      if (handler != null) handler(this, EventArgs.Empty);
478      OnToStringChanged();
479    }
480
481    public event EventHandler DescriptionChanged;
482    private void OnDescriptionChanged() {
483      var handler = DescriptionChanged;
484      if (handler != null) handler(this, EventArgs.Empty);
485    }
486
487    public event EventHandler ItemImageChanged;
488    private void OnItemImageChanged() {
489      EventHandler handler = ItemImageChanged;
490      if (handler != null) handler(this, EventArgs.Empty);
491    }
492    public event EventHandler ToStringChanged;
493    private void OnToStringChanged() {
494      EventHandler handler = ToStringChanged;
495      if (handler != null) handler(this, EventArgs.Empty);
496    }
497
498    private void DeregisterRunsEvents() {
499      runs.CollectionReset -= new CollectionItemsChangedEventHandler<IRun>(Runs_CollectionReset);
500    }
501    private void RegisterRunsEvents() {
502      runs.CollectionReset += new CollectionItemsChangedEventHandler<IRun>(Runs_CollectionReset);
503    }
504    private void Runs_CollectionReset(object sender, CollectionItemsChangedEventArgs<IRun> e) {
505      runsCounter = runs.Count;
506    }
507    #endregion
508  }
509}
Note: See TracBrowser for help on using the repository browser.