js/src/jsdtracef.h

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-
   2  * vim: set ts=8 sw=4 et tw=80:
   3  *
   4  * ***** BEGIN LICENSE BLOCK *****
   5  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   6  *
   7  * The contents of this file are subject to the Mozilla Public License Version
   8  * 1.1 (the "License"); you may not use this file except in compliance with
   9  * the License. You may obtain a copy of the License at
  10  * http://www.mozilla.org/MPL/
  11  *
  12  * Software distributed under the License is distributed on an "AS IS" basis,
  13  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  14  * for the specific language governing rights and limitations under the
  15  * License.
  16  *
  17  * Copyright (C) 2007  Sun Microsystems, Inc. All Rights Reserved.
  18  *
  19  * Contributor(s):
  20  *      Brendan Eich <brendan@mozilla.org>
  21  *
  22  * Alternatively, the contents of this file may be used under the terms of
  23  * either of the GNU General Public License Version 2 or later (the "GPL"),
  24  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  25  * in which case the provisions of the GPL or the LGPL are applicable instead
  26  * of those above. If you wish to allow use of your version of this file only
  27  * under the terms of either the GPL or the LGPL, and not to allow others to
  28  * use your version of this file under the terms of the MPL, indicate your
  29  * decision by deleting the provisions above and replace them with the notice
  30  * and other provisions required by the GPL or the LGPL. If you do not delete
  31  * the provisions above, a recipient may use your version of this file under
  32  * the terms of any one of the MPL, the GPL or the LGPL.
  33  *
  34  * ***** END LICENSE BLOCK ***** */
  35
  36 #ifdef INCLUDE_MOZILLA_DTRACE
  37 #include "javascript-trace.h"
  38 #endif
  39 #include "jspubtd.h"
  40 #include "jsprvtd.h"
  41
  42 #ifndef _JSDTRACEF_H
  43 #define _JSDTRACEF_H
  44
  45 JS_BEGIN_EXTERN_C
  46
  47 extern void
  48 jsdtrace_function_entry(JSContext *cx, JSStackFrame *fp, const JSFunction *fun);
  49
  50 extern void
  51 jsdtrace_function_info(JSContext *cx, JSStackFrame *fp, JSStackFrame *dfp,
  52                        const JSFunction *fun);
  53
  54 extern void
  55 jsdtrace_function_args(JSContext *cx, JSStackFrame *fp, const JSFunction *fun,
  56                        jsuint argc, jsval *argv);
  57
  58 extern void
  59 jsdtrace_function_rval(JSContext *cx, JSStackFrame *fp, const JSFunction *fun,
  60                        jsval rval);
  61
  62 extern void
  63 jsdtrace_function_return(JSContext *cx, JSStackFrame *fp, const JSFunction *fun);
  64
  65 extern void
  66 jsdtrace_object_create_start(JSStackFrame *fp, const JSClass *clasp);
  67
  68 extern void
  69 jsdtrace_object_create_done(JSStackFrame *fp, const JSClass *clasp);
  70
  71 extern void
  72 jsdtrace_object_create(JSContext *cx, const JSClass *clasp, const JSObject *obj);
  73
  74 extern void
  75 jsdtrace_object_finalize(const JSObject *obj);
  76
  77 extern void
  78 jsdtrace_execute_start(const JSScript *script);
  79
  80 extern void
  81 jsdtrace_execute_done(const JSScript *script);
  82
  83 JS_END_EXTERN_C
  84
  85 namespace js {
  86
  87 class DTrace {
  88   public:
  89     /*
  90      * If |lval| is provided to the enter/exit methods, it is tested to see if
  91      * it is a function as a predicate to the dtrace event emission.
  92      */
  93     static void enterJSFun(JSContext *cx, JSStackFrame *fp, const JSFunction *fun,
  94                            JSStackFrame *dfp, jsuint argc, jsval *argv, jsval *lval = NULL);
  95     static void exitJSFun(JSContext *cx, JSStackFrame *fp, const JSFunction *fun,
  96                           jsval rval, jsval *lval = NULL);
  97
  98     static void finalizeObject(const JSObject *obj);
  99
 100     class ExecutionScope {
 101         const JSScript *script;
 102         void startExecution();
 103         void endExecution();
 104       public:
 105         explicit ExecutionScope(const JSScript *script) : script(script) { startExecution(); }
 106         ~ExecutionScope() { endExecution(); }
 107     };
 108
 109 };
 110
 111 inline void
 112 DTrace::enterJSFun(JSContext *cx, JSStackFrame *fp, const JSFunction *fun,
 113                    JSStackFrame *dfp, jsuint argc, jsval *argv, jsval *lval)
 114 {
 115 #ifdef INCLUDE_MOZILLA_DTRACE
 116     if (!lval || VALUE_IS_FUNCTION(cx, *lval)) {
 117         if (JAVASCRIPT_FUNCTION_ENTRY_ENABLED())
 118             jsdtrace_function_entry(cx, fp, fun);
 119         if (JAVASCRIPT_FUNCTION_INFO_ENABLED())
 120             jsdtrace_function_info(cx, fp, dfp, fun);
 121         if (JAVASCRIPT_FUNCTION_ARGS_ENABLED())
 122             jsdtrace_function_args(cx, fp, fun, argc, argv);
 123     }
 124 #endif
 125 }
 126
 127 inline void
 128 DTrace::exitJSFun(JSContext *cx, JSStackFrame *fp, const JSFunction *fun,
 129                   jsval rval, jsval *lval)
 130 {
 131 #ifdef INCLUDE_MOZILLA_DTRACE
 132     if (!lval || VALUE_IS_FUNCTION(cx, *lval)) {
 133         if (JAVASCRIPT_FUNCTION_RVAL_ENABLED())
 134             jsdtrace_function_rval(cx, fp, fun, rval);
 135         if (JAVASCRIPT_FUNCTION_RETURN_ENABLED())
 136             jsdtrace_function_return(cx, fp, fun);
 137     }
 138 #endif
 139 }
 140
 141 inline void
 142 DTrace::finalizeObject(const JSObject *obj)
 143 {
 144 #ifdef INCLUDE_MOZILLA_DTRACE
 145     if (JAVASCRIPT_OBJECT_FINALIZE_ENABLED())
 146         jsdtrace_object_finalize(obj);
 147 #endif
 148 }
 149
 150 inline void
 151 DTrace::ExecutionScope::startExecution()
 152 {
 153 #ifdef INCLUDE_MOZILLA_DTRACE
 154     if (JAVASCRIPT_EXECUTE_START_ENABLED())
 155         jsdtrace_execute_start(script);
 156 #endif
 157 }
 158
 159 inline void
 160 DTrace::ExecutionScope::endExecution()
 161 {
 162 #ifdef INCLUDE_MOZILLA_DTRACE
 163     if (JAVASCRIPT_EXECUTE_DONE_ENABLED())
 164         jsdtrace_execute_done(script);
 165 #endif
 166 }
 167
 168 } /* namespace js */
 169
 170 #endif /* _JSDTRACE_H */