js/public/OldDebugAPI.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-
   2  * vim: set ts=8 sts=4 et sw=4 tw=99:
   3  * This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef js_OldDebugAPI_h
   8 #define js_OldDebugAPI_h
   9
  10 /*
  11  * JS debugger API.
  12  */
  13
  14 #include "mozilla/NullPtr.h"
  15
  16 #include "jsapi.h"
  17 #include "jsbytecode.h"
  18
  19 #include "js/CallArgs.h"
  20 #include "js/TypeDecls.h"
  21
  22 class JSAtom;
  23 struct JSFreeOp;
  24
  25 namespace js {
  26 class InterpreterFrame;
  27 class FrameIter;
  28 class ScriptSource;
  29 }
  30
  31
  32 namespace JS {
  33
  34 extern JS_PUBLIC_API(char*)
  35 FormatStackDump(JSContext* cx, char* buf, bool showArgs, bool showLocals, bool showThisProps);
  36
  37 } // namespace JS
  38
  39 # ifdef JS_DEBUG
  40 JS_FRIEND_API(void) js_DumpValue(const JS::Value& val);
  41 JS_FRIEND_API(void) js_DumpId(jsid id);
  42 JS_FRIEND_API(void) js_DumpInterpreterFrame(JSContext* cx, js::InterpreterFrame* start = nullptr);
  43 # endif
  44
  45 JS_FRIEND_API(void)
  46 js_DumpBacktrace(JSContext* cx);
  47
  48 typedef enum JSTrapStatus {
  49     JSTRAP_ERROR,
  50     JSTRAP_CONTINUE,
  51     JSTRAP_RETURN,
  52     JSTRAP_THROW,
  53     JSTRAP_LIMIT
  54 } JSTrapStatus;
  55
  56 extern JS_PUBLIC_API(JSString*)
  57 JS_DecompileScript(JSContext* cx, JS::HandleScript script, const char* name, unsigned indent);
  58
  59 /*
  60  * Currently, we only support runtime-wide debugging. In the future, we should
  61  * be able to support compartment-wide debugging.
  62  */
  63 extern JS_PUBLIC_API(void)
  64 JS_SetRuntimeDebugMode(JSRuntime* rt, bool debug);
  65
  66 /*
  67  * Debug mode is a compartment-wide mode that enables a debugger to attach
  68  * to and interact with running methodjit-ed frames. In particular, it causes
  69  * every function to be compiled as if an eval was present (so eval-in-frame)
  70  * can work, and it ensures that functions can be re-JITed for other debug
  71  * features. In general, it is not safe to interact with frames that were live
  72  * before debug mode was enabled. For this reason, it is also not safe to
  73  * enable debug mode while frames are live.
  74  */
  75
  76 /* Get current state of debugging mode. */
  77 extern JS_PUBLIC_API(bool)
  78 JS_GetDebugMode(JSContext* cx);
  79
  80 /*
  81  * Turn on/off debugging mode for all compartments. This returns false if any code
  82  * from any of the runtime's compartments is running or on the stack.
  83  */
  84 JS_FRIEND_API(bool)
  85 JS_SetDebugModeForAllCompartments(JSContext* cx, bool debug);
  86
  87 /*
  88  * Turn on/off debugging mode for a single compartment. This should only be
  89  * used when no code from this compartment is running or on the stack in any
  90  * thread.
  91  */
  92 JS_FRIEND_API(bool)
  93 JS_SetDebugModeForCompartment(JSContext* cx, JSCompartment* comp, bool debug);
  94
  95 /*
  96  * Turn on/off debugging mode for a context's compartment.
  97  */
  98 JS_FRIEND_API(bool)
  99 JS_SetDebugMode(JSContext* cx, bool debug);
 100
 101
 102 /************************************************************************/
 103
 104 // Raw JSScript* because this needs to be callable from a signal handler.
 105 extern JS_PUBLIC_API(unsigned)
 106 JS_PCToLineNumber(JSContext* cx, JSScript* script, jsbytecode* pc);
 107
 108 extern JS_PUBLIC_API(jsbytecode*)
 109 JS_LineNumberToPC(JSContext* cx, JSScript* script, unsigned lineno);
 110
 111 extern JS_PUBLIC_API(JSScript*)
 112 JS_GetFunctionScript(JSContext* cx, JS::HandleFunction fun);
 113
 114
 115 /************************************************************************/
 116
 117 extern JS_PUBLIC_API(const char*)
 118 JS_GetScriptFilename(JSScript* script);
 119
 120 extern JS_PUBLIC_API(const jschar*)
 121 JS_GetScriptSourceMap(JSContext* cx, JSScript* script);
 122
 123 extern JS_PUBLIC_API(unsigned)
 124 JS_GetScriptBaseLineNumber(JSContext* cx, JSScript* script);
 125
 126 extern JS_PUBLIC_API(unsigned)
 127 JS_GetScriptLineExtent(JSContext* cx, JSScript* script);
 128
 129
 130 /************************************************************************/
 131
 132 /**
 133  * Add various profiling-related functions as properties of the given object.
 134  */
 135 extern JS_PUBLIC_API(bool)
 136 JS_DefineProfilingFunctions(JSContext* cx, JSObject* obj);
 137
 138 /* Defined in vm/Debugger.cpp. */
 139 extern JS_PUBLIC_API(bool)
 140 JS_DefineDebuggerObject(JSContext* cx, JS::HandleObject obj);
 141
 142 extern JS_PUBLIC_API(void)
 143 JS_DumpPCCounts(JSContext* cx, JS::HandleScript script);
 144
 145 extern JS_PUBLIC_API(void)
 146 JS_DumpCompartmentPCCounts(JSContext* cx);
 147
 148 #endif /* js_OldDebugAPI_h */