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
|
//===-- MIDriver.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
//
//===----------------------------------------------------------------------===//
#pragma once
// Third party headers
#include <queue>
// In-house headers:
#include "MICmdData.h"
#include "MICmnBase.h"
#include "MICmnConfig.h"
#include "MICmnStreamStdin.h"
#include "MIDriverBase.h"
#include "MIDriverMgr.h"
#include "MIUtilSingletonBase.h"
// Declarations:
class CMICmnLLDBDebugger;
class CMICmnStreamStdout;
//++
//============================================================================
// Details: MI driver implementation class. A singleton class derived from
// LLDB SBBroadcaster class. Register the instance of *this class with
// the CMIDriverMgr. The CMIDriverMgr sets the driver(s) of to start
// work depending on the one selected to work. A driver can if not able
// to handle an instruction or 'command' can pass that command onto
// another driver object registered with the Driver Manager.
//--
class CMIDriver : public CMICmnBase,
public CMIDriverMgr::IDriver,
public CMIDriverBase,
public MI::ISingleton<CMIDriver> {
friend class MI::ISingleton<CMIDriver>;
// Enumerations:
public:
//++ ----------------------------------------------------------------------
// Details: The MI Driver has a running state which is used to help determine
// which specific action(s) it should take or not allow.
// The driver when operational and not shutting down alternates
// between eDriverState_RunningNotDebugging and
// eDriverState_RunningDebugging. eDriverState_RunningNotDebugging
// is normally set when a breakpoint is hit or halted.
// eDriverState_RunningDebugging is normally set when "exec-continue"
// or "exec-run" is issued.
//--
enum DriverState_e {
eDriverState_NotRunning = 0, // The MI Driver is not operating
eDriverState_Initialising, // The MI Driver is setting itself up
eDriverState_RunningNotDebugging, // The MI Driver is operational acting on
// any MI commands sent to it
eDriverState_RunningDebugging, // The MI Driver is currently overseeing an
// inferior program that is running
eDriverState_ShuttingDown, // The MI Driver is tearing down resources and
// about exit
eDriverState_count // Always last
};
// Methods:
public:
// MI system
bool Initialize() override;
bool Shutdown() override;
// MI state
bool GetExitApplicationFlag() const;
DriverState_e GetCurrentDriverState() const;
bool SetDriverStateRunningNotDebugging();
bool SetDriverStateRunningDebugging();
void SetDriverDebuggingArgExecutable();
bool IsDriverDebuggingArgExecutable() const;
// MI information about itself
const CMIUtilString &GetAppNameShort() const;
const CMIUtilString &GetAppNameLong() const;
const CMIUtilString &GetVersionDescription() const;
// MI do work
bool WriteMessageToLog(const CMIUtilString &vMessage);
bool SetEnableFallThru(const bool vbYes);
bool GetEnableFallThru() const;
bool HaveExecutableFileNamePathOnCmdLine() const;
const CMIUtilString &GetExecutableFileNamePathOnCmdLine() const;
// Overridden:
public:
// From CMIDriverMgr::IDriver
bool DoInitialize() override;
bool DoShutdown() override;
bool DoMainLoop() override;
lldb::SBError DoParseArgs(const int argc, const char *argv[], FILE *vpStdOut,
bool &vwbExiting) override;
CMIUtilString GetError() const override;
const CMIUtilString &GetName() const override;
lldb::SBDebugger &GetTheDebugger() override;
bool GetDriverIsGDBMICompatibleDriver() const override;
bool SetId(const CMIUtilString &vId) override;
const CMIUtilString &GetId() const override;
// From CMIDriverBase
void SetExitApplicationFlag(const bool vbForceExit) override;
bool DoFallThruToAnotherDriver(const CMIUtilString &vCmd,
CMIUtilString &vwErrMsg) override;
bool SetDriverToFallThruTo(const CMIDriverBase &vrOtherDriver) override;
FILE *GetStdin() const override;
FILE *GetStdout() const override;
FILE *GetStderr() const override;
const CMIUtilString &GetDriverName() const override;
const CMIUtilString &GetDriverId() const override;
void DeliverSignal(int signal) override;
// Typedefs:
private:
typedef std::queue<CMIUtilString> QueueStdinLine_t;
// Methods:
private:
/* ctor */ CMIDriver();
/* ctor */ CMIDriver(const CMIDriver &);
void operator=(const CMIDriver &);
lldb::SBError ParseArgs(const int argc, const char *argv[], FILE *vpStdOut,
bool &vwbExiting);
bool DoAppQuit();
bool InterpretCommand(const CMIUtilString &vTextLine);
bool InterpretCommandThisDriver(const CMIUtilString &vTextLine,
bool &vwbCmdYesValid);
CMIUtilString
WrapCLICommandIntoMICommand(const CMIUtilString &vTextLine) const;
bool InterpretCommandFallThruDriver(const CMIUtilString &vTextLine,
bool &vwbCmdYesValid);
bool ExecuteCommand(const SMICmdData &vCmdData);
bool StartWorkerThreads();
bool StopWorkerThreads();
bool InitClientIDEToMIDriver() const;
bool InitClientIDEEclipse() const;
bool LocalDebugSessionStartupExecuteCommands();
bool ExecuteCommandFile(const bool vbAsyncMode);
// Overridden:
private:
// From CMICmnBase
/* dtor */ ~CMIDriver() override;
// Attributes:
private:
static const CMIUtilString ms_constAppNameShort;
static const CMIUtilString ms_constAppNameLong;
static const CMIUtilString ms_constMIVersion;
//
bool m_bFallThruToOtherDriverEnabled; // True = yes fall through, false = do
// not pass on command
CMIUtilThreadMutex m_threadMutex;
bool m_bDriverIsExiting; // True = yes, driver told to quit, false = continue
// working
void *m_handleMainThread; // *this driver is run by the main thread
CMICmnStreamStdin &m_rStdin;
CMICmnLLDBDebugger &m_rLldbDebugger;
CMICmnStreamStdout &m_rStdOut;
DriverState_e m_eCurrentDriverState;
bool m_bHaveExecutableFileNamePathOnCmdLine; // True = yes, executable given
// as one of the parameters to
// the MI Driver, false = not
// found
CMIUtilString m_strCmdLineArgExecuteableFileNamePath;
bool m_bDriverDebuggingArgExecutable; // True = the MI Driver (MI mode) is
// debugging executable passed as
// argument,
// false = running via a client (e.g. Eclipse)
bool m_bHaveCommandFileNamePathOnCmdLine; // True = file with initial commands
// given as one of the parameters to
// the MI Driver, false = not found
CMIUtilString m_strCmdLineArgCommandFileNamePath;
};
|
