v8  6.8.275(node10.15.3)
V8 is Google's open source JavaScript engine
v8-inspector.h
Go to the documentation of this file.
1 // Copyright 2016 the V8 project authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4 
5 #ifndef V8_V8_INSPECTOR_H_
6 #define V8_V8_INSPECTOR_H_
7 
8 #include <stdint.h>
9 #include <cctype>
10 
11 #include <memory>
12 
13 #include "v8.h" // NOLINT(build/include)
14 
15 namespace v8_inspector {
16 
17 namespace protocol {
18 namespace Debugger {
19 namespace API {
20 class SearchMatch;
21 }
22 }
23 namespace Runtime {
24 namespace API {
25 class RemoteObject;
26 class StackTrace;
27 }
28 }
29 namespace Schema {
30 namespace API {
31 class Domain;
32 }
33 }
34 } // namespace protocol
35 
37  public:
38  StringView() : m_is8Bit(true), m_length(0), m_characters8(nullptr) {}
39 
40  StringView(const uint8_t* characters, size_t length)
41  : m_is8Bit(true), m_length(length), m_characters8(characters) {}
42 
43  StringView(const uint16_t* characters, size_t length)
44  : m_is8Bit(false), m_length(length), m_characters16(characters) {}
45 
46  bool is8Bit() const { return m_is8Bit; }
47  size_t length() const { return m_length; }
48 
49  // TODO(dgozman): add DCHECK(m_is8Bit) to accessors once platform can be used
50  // here.
51  const uint8_t* characters8() const { return m_characters8; }
52  const uint16_t* characters16() const { return m_characters16; }
53 
54  private:
55  bool m_is8Bit;
56  size_t m_length;
57  union {
58  const uint8_t* m_characters8;
59  const uint16_t* m_characters16;
60  };
61 };
62 
64  public:
65  virtual ~StringBuffer() {}
66  virtual const StringView& string() = 0;
67  // This method copies contents.
68  static std::unique_ptr<StringBuffer> create(const StringView&);
69 };
70 
72  public:
73  V8ContextInfo(v8::Local<v8::Context> context, int contextGroupId,
74  const StringView& humanReadableName)
75  : context(context),
76  contextGroupId(contextGroupId),
77  humanReadableName(humanReadableName),
78  hasMemoryOnConsole(false) {}
79 
81  // Each v8::Context is a part of a group. The group id must be non-zero.
87 
88  static int executionContextId(v8::Local<v8::Context> context);
89 
90  private:
91  // Disallow copying and allocating this one.
92  enum NotNullTagEnum { NotNullLiteral };
93  void* operator new(size_t) = delete;
94  void* operator new(size_t, NotNullTagEnum, void*) = delete;
95  void* operator new(size_t, void*) = delete;
96  V8ContextInfo(const V8ContextInfo&) = delete;
97  V8ContextInfo& operator=(const V8ContextInfo&) = delete;
98 };
99 
101  public:
102  virtual StringView firstNonEmptySourceURL() const = 0;
103  virtual bool isEmpty() const = 0;
104  virtual StringView topSourceURL() const = 0;
105  virtual int topLineNumber() const = 0;
106  virtual int topColumnNumber() const = 0;
107  virtual StringView topScriptId() const = 0;
108  virtual StringView topFunctionName() const = 0;
109 
110  virtual ~V8StackTrace() {}
111  virtual std::unique_ptr<protocol::Runtime::API::StackTrace>
112  buildInspectorObject() const = 0;
113  virtual std::unique_ptr<StringBuffer> toString() const = 0;
114 
115  // Safe to pass between threads, drops async chain.
116  virtual std::unique_ptr<V8StackTrace> clone() = 0;
117 };
118 
120  public:
121  virtual ~V8InspectorSession() {}
122 
123  // Cross-context inspectable values (DOM nodes in different worlds, etc.).
125  public:
127  virtual ~Inspectable() {}
128  };
129  virtual void addInspectedObject(std::unique_ptr<Inspectable>) = 0;
130 
131  // Dispatching protocol messages.
132  static bool canDispatchMethod(const StringView& method);
133  virtual void dispatchProtocolMessage(const StringView& message) = 0;
134  virtual std::unique_ptr<StringBuffer> stateJSON() = 0;
135  virtual std::vector<std::unique_ptr<protocol::Schema::API::Domain>>
136  supportedDomains() = 0;
137 
138  // Debugger actions.
139  virtual void schedulePauseOnNextStatement(const StringView& breakReason,
140  const StringView& breakDetails) = 0;
141  virtual void cancelPauseOnNextStatement() = 0;
142  virtual void breakProgram(const StringView& breakReason,
143  const StringView& breakDetails) = 0;
144  virtual void setSkipAllPauses(bool) = 0;
145  virtual void resume() = 0;
146  virtual void stepOver() = 0;
147  virtual std::vector<std::unique_ptr<protocol::Debugger::API::SearchMatch>>
148  searchInTextByLines(const StringView& text, const StringView& query,
149  bool caseSensitive, bool isRegex) = 0;
150 
151  // Remote objects.
152  virtual std::unique_ptr<protocol::Runtime::API::RemoteObject> wrapObject(
154  bool generatePreview) = 0;
155 
156  virtual bool unwrapObject(std::unique_ptr<StringBuffer>* error,
157  const StringView& objectId, v8::Local<v8::Value>*,
159  std::unique_ptr<StringBuffer>* objectGroup) = 0;
160  virtual void releaseObjectGroup(const StringView&) = 0;
161 };
162 
164  public:
165  virtual ~V8InspectorClient() {}
166 
167  virtual void runMessageLoopOnPause(int contextGroupId) {}
168  virtual void quitMessageLoopOnPause() {}
169  virtual void runIfWaitingForDebugger(int contextGroupId) {}
170 
171  virtual void muteMetrics(int contextGroupId) {}
172  virtual void unmuteMetrics(int contextGroupId) {}
173 
174  virtual void beginUserGesture() {}
175  virtual void endUserGesture() {}
176 
177  virtual std::unique_ptr<StringBuffer> valueSubtype(v8::Local<v8::Value>) {
178  return nullptr;
179  }
181  return false;
182  }
183  virtual bool isInspectableHeapObject(v8::Local<v8::Object>) { return true; }
184 
186  int contextGroupId) {
187  return v8::Local<v8::Context>();
188  }
189  virtual void beginEnsureAllContextsInGroup(int contextGroupId) {}
190  virtual void endEnsureAllContextsInGroup(int contextGroupId) {}
191 
194  virtual void consoleAPIMessage(int contextGroupId,
196  const StringView& message,
197  const StringView& url, unsigned lineNumber,
198  unsigned columnNumber, V8StackTrace*) {}
201  return v8::MaybeLocal<v8::Value>();
202  }
203 
204  virtual void consoleTime(const StringView& title) {}
205  virtual void consoleTimeEnd(const StringView& title) {}
206  virtual void consoleTimeStamp(const StringView& title) {}
207  virtual void consoleClear(int contextGroupId) {}
208  virtual double currentTimeMS() { return 0; }
209  typedef void (*TimerCallback)(void*);
210  virtual void startRepeatingTimer(double, TimerCallback, void* data) {}
211  virtual void cancelTimer(void* data) {}
212 
213  // TODO(dgozman): this was added to support service worker shadow page. We
214  // should not connect at all.
215  virtual bool canExecuteScripts(int contextGroupId) { return true; }
216 
217  virtual void maxAsyncCallStackDepthChanged(int depth) {}
218 };
219 
220 // These stack trace ids are intended to be passed between debuggers and be
221 // resolved later. This allows to track cross-debugger calls and step between
222 // them if a single client connects to multiple debuggers.
224  uintptr_t id;
225  std::pair<int64_t, int64_t> debugger_id;
226 
227  V8StackTraceId();
228  V8StackTraceId(uintptr_t id, const std::pair<int64_t, int64_t> debugger_id);
229  ~V8StackTraceId() = default;
230 
231  bool IsInvalid() const;
232 };
233 
235  public:
236  static std::unique_ptr<V8Inspector> create(v8::Isolate*, V8InspectorClient*);
237  virtual ~V8Inspector() {}
238 
239  // Contexts instrumentation.
240  virtual void contextCreated(const V8ContextInfo&) = 0;
241  virtual void contextDestroyed(v8::Local<v8::Context>) = 0;
242  virtual void resetContextGroup(int contextGroupId) = 0;
243 
244  // Various instrumentation.
245  virtual void idleStarted() = 0;
246  virtual void idleFinished() = 0;
247 
248  // Async stack traces instrumentation.
249  virtual void asyncTaskScheduled(const StringView& taskName, void* task,
250  bool recurring) = 0;
251  virtual void asyncTaskCanceled(void* task) = 0;
252  virtual void asyncTaskStarted(void* task) = 0;
253  virtual void asyncTaskFinished(void* task) = 0;
254  virtual void allAsyncTasksCanceled() = 0;
255 
256  virtual V8StackTraceId storeCurrentStackTrace(
257  const StringView& description) = 0;
258  virtual void externalAsyncTaskStarted(const V8StackTraceId& parent) = 0;
259  virtual void externalAsyncTaskFinished(const V8StackTraceId& parent) = 0;
260 
261  // Exceptions instrumentation.
262  virtual unsigned exceptionThrown(
263  v8::Local<v8::Context>, const StringView& message,
264  v8::Local<v8::Value> exception, const StringView& detailedMessage,
265  const StringView& url, unsigned lineNumber, unsigned columnNumber,
266  std::unique_ptr<V8StackTrace>, int scriptId) = 0;
267  virtual void exceptionRevoked(v8::Local<v8::Context>, unsigned exceptionId,
268  const StringView& message) = 0;
269 
270  // Connection.
272  public:
273  virtual ~Channel() {}
274  virtual void sendResponse(int callId,
275  std::unique_ptr<StringBuffer> message) = 0;
276  virtual void sendNotification(std::unique_ptr<StringBuffer> message) = 0;
277  virtual void flushProtocolNotifications() = 0;
278  };
279  virtual std::unique_ptr<V8InspectorSession> connect(
280  int contextGroupId, Channel*, const StringView& state) = 0;
281 
282  // API methods.
283  virtual std::unique_ptr<V8StackTrace> createStackTrace(
285  virtual std::unique_ptr<V8StackTrace> captureStackTrace(bool fullStack) = 0;
286 };
287 
288 } // namespace v8_inspector
289 
290 #endif // V8_V8_INSPECTOR_H_
virtual v8::Local< v8::Context > ensureDefaultContextInGroup(int contextGroupId)
Definition: v8-inspector.h:185
virtual void cancelTimer(void *data)
Definition: v8-inspector.h:211
virtual void runMessageLoopOnPause(int contextGroupId)
Definition: v8-inspector.h:167
const uint8_t * m_characters8
Definition: v8-inspector.h:58
StringView(const uint16_t *characters, size_t length)
Definition: v8-inspector.h:43
std::pair< int64_t, int64_t > debugger_id
Definition: v8-inspector.h:225
MessageErrorLevel
Definition: v8.h:7275
virtual void maxAsyncCallStackDepthChanged(int depth)
Definition: v8-inspector.h:217
virtual bool canExecuteScripts(int contextGroupId)
Definition: v8-inspector.h:215
virtual void runIfWaitingForDebugger(int contextGroupId)
Definition: v8-inspector.h:169
v8::Local< v8::Context > context
Definition: v8-inspector.h:80
virtual void installAdditionalCommandLineAPI(v8::Local< v8::Context >, v8::Local< v8::Object >)
Definition: v8-inspector.h:192
virtual void consoleTime(const StringView &title)
Definition: v8-inspector.h:204
virtual bool isInspectableHeapObject(v8::Local< v8::Object >)
Definition: v8-inspector.h:183
V8ContextInfo(v8::Local< v8::Context > context, int contextGroupId, const StringView &humanReadableName)
Definition: v8-inspector.h:73
StringView(const uint8_t *characters, size_t length)
Definition: v8-inspector.h:40
virtual bool formatAccessorsAsProperties(v8::Local< v8::Value >)
Definition: v8-inspector.h:180
virtual v8::MaybeLocal< v8::Value > memoryInfo(v8::Isolate *, v8::Local< v8::Context >)
Definition: v8-inspector.h:199
virtual void endEnsureAllContextsInGroup(int contextGroupId)
Definition: v8-inspector.h:190
virtual std::unique_ptr< StringBuffer > valueSubtype(v8::Local< v8::Value >)
Definition: v8-inspector.h:177
virtual void unmuteMetrics(int contextGroupId)
Definition: v8-inspector.h:172
virtual void beginEnsureAllContextsInGroup(int contextGroupId)
Definition: v8-inspector.h:189
const uint16_t * m_characters16
Definition: v8-inspector.h:59
const uint8_t * characters8() const
Definition: v8-inspector.h:51
virtual void consoleAPIMessage(int contextGroupId, v8::Isolate::MessageErrorLevel level, const StringView &message, const StringView &url, unsigned lineNumber, unsigned columnNumber, V8StackTrace *)
Definition: v8-inspector.h:194
const uint16_t * characters16() const
Definition: v8-inspector.h:52
virtual void consoleTimeEnd(const StringView &title)
Definition: v8-inspector.h:205
size_t length() const
Definition: v8-inspector.h:47
virtual void quitMessageLoopOnPause()
Definition: v8-inspector.h:168
#define V8_EXPORT
Definition: v8.h:56
virtual void muteMetrics(int contextGroupId)
Definition: v8-inspector.h:171
virtual void consoleTimeStamp(const StringView &title)
Definition: v8-inspector.h:206
virtual void startRepeatingTimer(double, TimerCallback, void *data)
Definition: v8-inspector.h:210
virtual void consoleClear(int contextGroupId)
Definition: v8-inspector.h:207