v8-inspector.h 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376
  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. #ifndef V8_V8_INSPECTOR_H_
  5. #define V8_V8_INSPECTOR_H_
  6. #include <stdint.h>
  7. #include <cctype>
  8. #include <memory>
  9. #include "v8-isolate.h" // NOLINT(build/include_directory)
  10. #include "v8-local-handle.h" // NOLINT(build/include_directory)
  11. namespace v8 {
  12. class Context;
  13. class Name;
  14. class Object;
  15. class StackTrace;
  16. class Value;
  17. } // namespace v8
  18. namespace v8_inspector {
  19. namespace internal {
  20. class V8DebuggerId;
  21. } // namespace internal
  22. namespace protocol {
  23. namespace Debugger {
  24. namespace API {
  25. class SearchMatch;
  26. }
  27. }
  28. namespace Runtime {
  29. namespace API {
  30. class RemoteObject;
  31. class StackTrace;
  32. class StackTraceId;
  33. }
  34. }
  35. namespace Schema {
  36. namespace API {
  37. class Domain;
  38. }
  39. }
  40. } // namespace protocol
  41. class V8_EXPORT StringView {
  42. public:
  43. StringView() : m_is8Bit(true), m_length(0), m_characters8(nullptr) {}
  44. StringView(const uint8_t* characters, size_t length)
  45. : m_is8Bit(true), m_length(length), m_characters8(characters) {}
  46. StringView(const uint16_t* characters, size_t length)
  47. : m_is8Bit(false), m_length(length), m_characters16(characters) {}
  48. bool is8Bit() const { return m_is8Bit; }
  49. size_t length() const { return m_length; }
  50. // TODO(dgozman): add DCHECK(m_is8Bit) to accessors once platform can be used
  51. // here.
  52. const uint8_t* characters8() const { return m_characters8; }
  53. const uint16_t* characters16() const { return m_characters16; }
  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. class V8_EXPORT StringBuffer {
  63. public:
  64. virtual ~StringBuffer() = default;
  65. virtual StringView string() const = 0;
  66. // This method copies contents.
  67. static std::unique_ptr<StringBuffer> create(StringView);
  68. };
  69. class V8_EXPORT V8ContextInfo {
  70. public:
  71. V8ContextInfo(v8::Local<v8::Context> context, int contextGroupId,
  72. StringView humanReadableName)
  73. : context(context),
  74. contextGroupId(contextGroupId),
  75. humanReadableName(humanReadableName),
  76. hasMemoryOnConsole(false) {}
  77. v8::Local<v8::Context> context;
  78. // Each v8::Context is a part of a group. The group id must be non-zero.
  79. int contextGroupId;
  80. StringView humanReadableName;
  81. StringView origin;
  82. StringView auxData;
  83. bool hasMemoryOnConsole;
  84. static int executionContextId(v8::Local<v8::Context> context);
  85. // Disallow copying and allocating this one.
  86. enum NotNullTagEnum { NotNullLiteral };
  87. void* operator new(size_t) = delete;
  88. void* operator new(size_t, NotNullTagEnum, void*) = delete;
  89. void* operator new(size_t, void*) = delete;
  90. V8ContextInfo(const V8ContextInfo&) = delete;
  91. V8ContextInfo& operator=(const V8ContextInfo&) = delete;
  92. };
  93. // This debugger id tries to be unique by generating two random
  94. // numbers, which should most likely avoid collisions.
  95. // Debugger id has a 1:1 mapping to context group. It is used to
  96. // attribute stack traces to a particular debugging, when doing any
  97. // cross-debugger operations (e.g. async step in).
  98. // See also Runtime.UniqueDebuggerId in the protocol.
  99. class V8_EXPORT V8DebuggerId {
  100. public:
  101. V8DebuggerId() = default;
  102. V8DebuggerId(const V8DebuggerId&) = default;
  103. V8DebuggerId& operator=(const V8DebuggerId&) = default;
  104. std::unique_ptr<StringBuffer> toString() const;
  105. bool isValid() const;
  106. std::pair<int64_t, int64_t> pair() const;
  107. private:
  108. friend class internal::V8DebuggerId;
  109. explicit V8DebuggerId(std::pair<int64_t, int64_t>);
  110. int64_t m_first = 0;
  111. int64_t m_second = 0;
  112. };
  113. class V8_EXPORT V8StackTrace {
  114. public:
  115. virtual StringView firstNonEmptySourceURL() const = 0;
  116. virtual bool isEmpty() const = 0;
  117. virtual StringView topSourceURL() const = 0;
  118. virtual int topLineNumber() const = 0;
  119. virtual int topColumnNumber() const = 0;
  120. virtual int topScriptId() const = 0;
  121. virtual StringView topFunctionName() const = 0;
  122. virtual ~V8StackTrace() = default;
  123. virtual std::unique_ptr<protocol::Runtime::API::StackTrace>
  124. buildInspectorObject(int maxAsyncDepth) const = 0;
  125. virtual std::unique_ptr<StringBuffer> toString() const = 0;
  126. // Safe to pass between threads, drops async chain.
  127. virtual std::unique_ptr<V8StackTrace> clone() = 0;
  128. };
  129. class V8_EXPORT V8InspectorSession {
  130. public:
  131. virtual ~V8InspectorSession() = default;
  132. // Cross-context inspectable values (DOM nodes in different worlds, etc.).
  133. class V8_EXPORT Inspectable {
  134. public:
  135. virtual v8::Local<v8::Value> get(v8::Local<v8::Context>) = 0;
  136. virtual ~Inspectable() = default;
  137. };
  138. class V8_EXPORT CommandLineAPIScope {
  139. public:
  140. virtual ~CommandLineAPIScope() = default;
  141. };
  142. virtual void addInspectedObject(std::unique_ptr<Inspectable>) = 0;
  143. // Dispatching protocol messages.
  144. static bool canDispatchMethod(StringView method);
  145. virtual void dispatchProtocolMessage(StringView message) = 0;
  146. virtual std::vector<uint8_t> state() = 0;
  147. virtual std::vector<std::unique_ptr<protocol::Schema::API::Domain>>
  148. supportedDomains() = 0;
  149. virtual std::unique_ptr<V8InspectorSession::CommandLineAPIScope>
  150. initializeCommandLineAPIScope(int executionContextId) = 0;
  151. // Debugger actions.
  152. virtual void schedulePauseOnNextStatement(StringView breakReason,
  153. StringView breakDetails) = 0;
  154. virtual void cancelPauseOnNextStatement() = 0;
  155. virtual void breakProgram(StringView breakReason,
  156. StringView breakDetails) = 0;
  157. virtual void setSkipAllPauses(bool) = 0;
  158. virtual void resume(bool setTerminateOnResume = false) = 0;
  159. virtual void stepOver() = 0;
  160. virtual std::vector<std::unique_ptr<protocol::Debugger::API::SearchMatch>>
  161. searchInTextByLines(StringView text, StringView query, bool caseSensitive,
  162. bool isRegex) = 0;
  163. // Remote objects.
  164. virtual std::unique_ptr<protocol::Runtime::API::RemoteObject> wrapObject(
  165. v8::Local<v8::Context>, v8::Local<v8::Value>, StringView groupName,
  166. bool generatePreview) = 0;
  167. virtual bool unwrapObject(std::unique_ptr<StringBuffer>* error,
  168. StringView objectId, v8::Local<v8::Value>*,
  169. v8::Local<v8::Context>*,
  170. std::unique_ptr<StringBuffer>* objectGroup) = 0;
  171. virtual void releaseObjectGroup(StringView) = 0;
  172. virtual void triggerPreciseCoverageDeltaUpdate(StringView occasion) = 0;
  173. };
  174. class V8_EXPORT WebDriverValue {
  175. public:
  176. explicit WebDriverValue(StringView type, v8::MaybeLocal<v8::Value> value = {})
  177. : type(type), value(value) {}
  178. StringView type;
  179. v8::MaybeLocal<v8::Value> value;
  180. };
  181. class V8_EXPORT V8InspectorClient {
  182. public:
  183. virtual ~V8InspectorClient() = default;
  184. virtual void runMessageLoopOnPause(int contextGroupId) {}
  185. virtual void quitMessageLoopOnPause() {}
  186. virtual void runIfWaitingForDebugger(int contextGroupId) {}
  187. virtual void muteMetrics(int contextGroupId) {}
  188. virtual void unmuteMetrics(int contextGroupId) {}
  189. virtual void beginUserGesture() {}
  190. virtual void endUserGesture() {}
  191. virtual std::unique_ptr<WebDriverValue> serializeToWebDriverValue(
  192. v8::Local<v8::Value> v8_value, int max_depth) {
  193. return nullptr;
  194. }
  195. virtual std::unique_ptr<StringBuffer> valueSubtype(v8::Local<v8::Value>) {
  196. return nullptr;
  197. }
  198. virtual std::unique_ptr<StringBuffer> descriptionForValueSubtype(
  199. v8::Local<v8::Context>, v8::Local<v8::Value>) {
  200. return nullptr;
  201. }
  202. virtual bool isInspectableHeapObject(v8::Local<v8::Object>) { return true; }
  203. virtual v8::Local<v8::Context> ensureDefaultContextInGroup(
  204. int contextGroupId) {
  205. return v8::Local<v8::Context>();
  206. }
  207. virtual void beginEnsureAllContextsInGroup(int contextGroupId) {}
  208. virtual void endEnsureAllContextsInGroup(int contextGroupId) {}
  209. virtual void installAdditionalCommandLineAPI(v8::Local<v8::Context>,
  210. v8::Local<v8::Object>) {}
  211. virtual void consoleAPIMessage(int contextGroupId,
  212. v8::Isolate::MessageErrorLevel level,
  213. const StringView& message,
  214. const StringView& url, unsigned lineNumber,
  215. unsigned columnNumber, V8StackTrace*) {}
  216. virtual v8::MaybeLocal<v8::Value> memoryInfo(v8::Isolate*,
  217. v8::Local<v8::Context>) {
  218. return v8::MaybeLocal<v8::Value>();
  219. }
  220. virtual void consoleTime(const StringView& title) {}
  221. virtual void consoleTimeEnd(const StringView& title) {}
  222. virtual void consoleTimeStamp(const StringView& title) {}
  223. virtual void consoleClear(int contextGroupId) {}
  224. virtual double currentTimeMS() { return 0; }
  225. typedef void (*TimerCallback)(void*);
  226. virtual void startRepeatingTimer(double, TimerCallback, void* data) {}
  227. virtual void cancelTimer(void* data) {}
  228. // TODO(dgozman): this was added to support service worker shadow page. We
  229. // should not connect at all.
  230. virtual bool canExecuteScripts(int contextGroupId) { return true; }
  231. virtual void maxAsyncCallStackDepthChanged(int depth) {}
  232. virtual std::unique_ptr<StringBuffer> resourceNameToUrl(
  233. const StringView& resourceName) {
  234. return nullptr;
  235. }
  236. // The caller would defer to generating a random 64 bit integer if
  237. // this method returns 0.
  238. virtual int64_t generateUniqueId() { return 0; }
  239. virtual void dispatchError(v8::Local<v8::Context>, v8::Local<v8::Message>,
  240. v8::Local<v8::Value>) {}
  241. };
  242. // These stack trace ids are intended to be passed between debuggers and be
  243. // resolved later. This allows to track cross-debugger calls and step between
  244. // them if a single client connects to multiple debuggers.
  245. struct V8_EXPORT V8StackTraceId {
  246. uintptr_t id;
  247. std::pair<int64_t, int64_t> debugger_id;
  248. bool should_pause = false;
  249. V8StackTraceId();
  250. V8StackTraceId(const V8StackTraceId&) = default;
  251. V8StackTraceId(uintptr_t id, const std::pair<int64_t, int64_t> debugger_id);
  252. V8StackTraceId(uintptr_t id, const std::pair<int64_t, int64_t> debugger_id,
  253. bool should_pause);
  254. explicit V8StackTraceId(StringView);
  255. V8StackTraceId& operator=(const V8StackTraceId&) = default;
  256. V8StackTraceId& operator=(V8StackTraceId&&) noexcept = default;
  257. ~V8StackTraceId() = default;
  258. bool IsInvalid() const;
  259. std::unique_ptr<StringBuffer> ToString();
  260. };
  261. class V8_EXPORT V8Inspector {
  262. public:
  263. static std::unique_ptr<V8Inspector> create(v8::Isolate*, V8InspectorClient*);
  264. virtual ~V8Inspector() = default;
  265. // Contexts instrumentation.
  266. virtual void contextCreated(const V8ContextInfo&) = 0;
  267. virtual void contextDestroyed(v8::Local<v8::Context>) = 0;
  268. virtual void resetContextGroup(int contextGroupId) = 0;
  269. virtual v8::MaybeLocal<v8::Context> contextById(int contextId) = 0;
  270. virtual V8DebuggerId uniqueDebuggerId(int contextId) = 0;
  271. // Various instrumentation.
  272. virtual void idleStarted() = 0;
  273. virtual void idleFinished() = 0;
  274. // Async stack traces instrumentation.
  275. virtual void asyncTaskScheduled(StringView taskName, void* task,
  276. bool recurring) = 0;
  277. virtual void asyncTaskCanceled(void* task) = 0;
  278. virtual void asyncTaskStarted(void* task) = 0;
  279. virtual void asyncTaskFinished(void* task) = 0;
  280. virtual void allAsyncTasksCanceled() = 0;
  281. virtual V8StackTraceId storeCurrentStackTrace(StringView description) = 0;
  282. virtual void externalAsyncTaskStarted(const V8StackTraceId& parent) = 0;
  283. virtual void externalAsyncTaskFinished(const V8StackTraceId& parent) = 0;
  284. // Exceptions instrumentation.
  285. virtual unsigned exceptionThrown(v8::Local<v8::Context>, StringView message,
  286. v8::Local<v8::Value> exception,
  287. StringView detailedMessage, StringView url,
  288. unsigned lineNumber, unsigned columnNumber,
  289. std::unique_ptr<V8StackTrace>,
  290. int scriptId) = 0;
  291. virtual void exceptionRevoked(v8::Local<v8::Context>, unsigned exceptionId,
  292. StringView message) = 0;
  293. virtual bool associateExceptionData(v8::Local<v8::Context>,
  294. v8::Local<v8::Value> exception,
  295. v8::Local<v8::Name> key,
  296. v8::Local<v8::Value> value) = 0;
  297. // Connection.
  298. class V8_EXPORT Channel {
  299. public:
  300. virtual ~Channel() = default;
  301. virtual void sendResponse(int callId,
  302. std::unique_ptr<StringBuffer> message) = 0;
  303. virtual void sendNotification(std::unique_ptr<StringBuffer> message) = 0;
  304. virtual void flushProtocolNotifications() = 0;
  305. };
  306. virtual std::unique_ptr<V8InspectorSession> connect(int contextGroupId,
  307. Channel*,
  308. StringView state) = 0;
  309. // API methods.
  310. virtual std::unique_ptr<V8StackTrace> createStackTrace(
  311. v8::Local<v8::StackTrace>) = 0;
  312. virtual std::unique_ptr<V8StackTrace> captureStackTrace(bool fullStack) = 0;
  313. };
  314. } // namespace v8_inspector
  315. #endif // V8_V8_INSPECTOR_H_