summaryrefslogtreecommitdiffstats
path: root/lldb/tools/lldb-perf/lib/TestCase.h
blob: 4ab4bd1c176ad396bf38526c1616fc7eb8d860ed (plain)
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
//===-- TestCase.h ----------------------------------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//

#ifndef __PerfTestDriver__TestCase__
#define __PerfTestDriver__TestCase__

#include "Measurement.h"
#include "lldb/API/LLDB.h"
#include <getopt.h>

namespace lldb_perf {

class Results;

class TestCase {
public:
  TestCase();

  struct ActionWanted {
    enum class Type {
      eStepOver,
      eContinue,
      eStepOut,
      eRelaunch,
      eCallNext,
      eNone,
      eKill
    } type;
    lldb::SBThread thread;
    lldb::SBLaunchInfo launch_info;

    ActionWanted() : type(Type::eContinue), thread(), launch_info(NULL) {}

    void None() {
      type = Type::eNone;
      thread = lldb::SBThread();
    }

    void Continue() {
      type = Type::eContinue;
      thread = lldb::SBThread();
    }

    void StepOver(lldb::SBThread t) {
      type = Type::eStepOver;
      thread = t;
    }

    void StepOut(lldb::SBThread t) {
      type = Type::eStepOut;
      thread = t;
    }

    void Relaunch(lldb::SBLaunchInfo l) {
      type = Type::eRelaunch;
      thread = lldb::SBThread();
      launch_info = l;
    }

    void Kill() {
      type = Type::eKill;
      thread = lldb::SBThread();
    }

    void CallNext() {
      type = Type::eCallNext;
      thread = lldb::SBThread();
    }
  };

  virtual ~TestCase() {}

  virtual bool Setup(int &argc, const char **&argv);

  virtual void TestStep(int counter, ActionWanted &next_action) = 0;

  bool Launch(lldb::SBLaunchInfo &launch_info);

  bool Launch(std::initializer_list<const char *> args = {});

  void Loop();

  void SetVerbose(bool);

  bool GetVerbose();

  virtual void WriteResults(Results &results) = 0;

  template <typename G, typename A>
  Measurement<G, A> CreateMeasurement(A a, const char *name = NULL,
                                      const char *description = NULL) {
    return Measurement<G, A>(a, name, description);
  }

  template <typename A>
  TimeMeasurement<A> CreateTimeMeasurement(A a, const char *name = NULL,
                                           const char *description = NULL) {
    return TimeMeasurement<A>(a, name, description);
  }

  template <typename A>
  MemoryMeasurement<A> CreateMemoryMeasurement(A a, const char *name = NULL,
                                               const char *description = NULL) {
    return MemoryMeasurement<A>(a, name, description);
  }

  static int Run(TestCase &test, int argc, const char **argv);

  virtual bool ParseOption(int short_option, const char *optarg) {
    return false;
  }

  virtual struct option *GetLongOptions() { return NULL; }

  lldb::SBDebugger &GetDebugger() { return m_debugger; }

  lldb::SBTarget &GetTarget() { return m_target; }

  lldb::SBProcess &GetProcess() { return m_process; }

  lldb::SBThread &GetThread() { return m_thread; }

  int GetStep() { return m_step; }

  static const int RUN_SUCCESS = 0;
  static const int RUN_SETUP_ERROR = 100;

protected:
  lldb::SBDebugger m_debugger;
  lldb::SBTarget m_target;
  lldb::SBProcess m_process;
  lldb::SBThread m_thread;
  lldb::SBListener m_listener;
  bool m_verbose;
  int m_step;
};
}

#endif /* defined(__PerfTestDriver__TestCase__) */
OpenPOWER on IntegriCloud