summaryrefslogtreecommitdiffstats
path: root/lldb/tools/lldb-mi/MICmnLLDBDebugger.h
blob: bec9adf13830f24590dd10ef702fbb3d42c66197 (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
//===-- MICmnLLDBDebugger.h -------------------------------------*- C++ -*-===//
//
//                     The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//

#pragma once

// Third party headers
#include "lldb/API/SBDebugger.h"
#include "lldb/API/SBEvent.h"
#include "lldb/API/SBListener.h"
#include <condition_variable>
#include <map>
#include <mutex>

// In-house headers:
#include "MICmnBase.h"
#include "MIUtilSingletonBase.h"
#include "MIUtilThreadBaseStd.h"

// Declarations:
class CMIDriverBase;
class CMICmnLLDBDebuggerHandleEvents;

//++
//============================================================================
// Details: MI proxy/adapter for the LLDB public SBDebugger API. The CMIDriver
//          requires *this object. Command classes make calls on *this object
//          to facilitate their work effort. The instance runs in its own worker
//          thread.
//          A singleton class.
//--
class CMICmnLLDBDebugger : public CMICmnBase,
                           public CMIUtilThreadActiveObjBase,
                           public MI::ISingleton<CMICmnLLDBDebugger> {
  friend class MI::ISingleton<CMICmnLLDBDebugger>;

  // Methods:
public:
  bool Initialize() override;
  bool Shutdown() override;

  bool SetDriver(const CMIDriverBase &vClientDriver);
  CMIDriverBase &GetDriver() const;
  lldb::SBDebugger &GetTheDebugger();
  lldb::SBListener &GetTheListener();
  void WaitForHandleEvent();
  bool CheckIfNeedToRebroadcastStopEvent();
  void RebroadcastStopEvent();

  // MI Commands can use these functions to listen for events they require
  bool RegisterForEvent(const CMIUtilString &vClientName,
                        const CMIUtilString &vBroadcasterClass,
                        const MIuint vEventMask);
  bool UnregisterForEvent(const CMIUtilString &vClientName,
                          const CMIUtilString &vBroadcasterClass);
  bool RegisterForEvent(const CMIUtilString &vClientName,
                        const lldb::SBBroadcaster &vBroadcaster,
                        const MIuint vEventMask);
  bool UnregisterForEvent(const CMIUtilString &vClientName,
                          const lldb::SBBroadcaster &vBroadcaster);

  // Overridden:
public:
  // From CMIUtilThreadActiveObjBase
  const CMIUtilString &ThreadGetName() const override;

  // Overridden:
protected:
  // From CMIUtilThreadActiveObjBase
  bool ThreadRun(bool &vrIsAlive) override;
  bool ThreadFinish() override;

  // Typedefs:
private:
  typedef std::map<CMIUtilString, MIuint> MapBroadcastClassNameToEventMask_t;
  typedef std::pair<CMIUtilString, MIuint>
      MapPairBroadcastClassNameToEventMask_t;
  typedef std::map<CMIUtilString, MIuint> MapIdToEventMask_t;
  typedef std::pair<CMIUtilString, MIuint> MapPairIdToEventMask_t;

  // Methods:
private:
  /* ctor */ CMICmnLLDBDebugger();
  /* ctor */ CMICmnLLDBDebugger(const CMICmnLLDBDebugger &);
  void operator=(const CMICmnLLDBDebugger &);

  bool InitSBDebugger();
  bool InitSBListener();
  bool InitStdStreams();
  bool MonitorSBListenerEvents(bool &vrbYesExit);

  bool BroadcasterGetMask(const CMIUtilString &vBroadcasterClass,
                          MIuint &vEventMask) const;
  bool BroadcasterRemoveMask(const CMIUtilString &vBroadcasterClass);
  bool BroadcasterSaveMask(const CMIUtilString &vBroadcasterClass,
                           const MIuint vEventMask);

  MIuint
  ClientGetMaskForAllClients(const CMIUtilString &vBroadcasterClass) const;
  bool ClientSaveMask(const CMIUtilString &vClientName,
                      const CMIUtilString &vBroadcasterClass,
                      const MIuint vEventMask);
  bool ClientRemoveTheirMask(const CMIUtilString &vClientName,
                             const CMIUtilString &vBroadcasterClass);
  bool ClientGetTheirMask(const CMIUtilString &vClientName,
                          const CMIUtilString &vBroadcasterClass,
                          MIuint &vwEventMask);
  bool LoadMIFormatters(lldb::SBTypeCategory miCategory);
  bool RegisterMISummaryProviders();
  // Overridden:
private:
  // From CMICmnBase
  /* dtor */ ~CMICmnLLDBDebugger() override;

  // Attributes:
private:
  CMIDriverBase
      *m_pClientDriver; // The driver that wants to use *this LLDB debugger
  lldb::SBDebugger m_lldbDebugger; // SBDebugger is the primordial object that
                                   // creates SBTargets and provides access to
                                   // them
  lldb::SBListener m_lldbListener; // API clients can register its own listener
                                   // to debugger events
  const CMIUtilString m_constStrThisThreadId;
  MapBroadcastClassNameToEventMask_t m_mapBroadcastClassNameToEventMask;
  MapIdToEventMask_t m_mapIdToEventMask;
  std::mutex m_mutexEventQueue;
  std::condition_variable m_conditionEventQueueEmpty;
  uint32_t m_nLastStopId;
};
OpenPOWER on IntegriCloud