js/jsd/jsd_obj.c

   1 /* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 /*
  39  * JavaScript Debugging support - Object support
  40  */
  41
  42 #include "jsd.h"
  43
  44 /*
  45 * #define JSD_TRACE 1
  46 */
  47
  48 #ifdef JSD_TRACE
  49 #define TRACEOBJ(jsdc, jsdobj, which) _traceObj(jsdc, jsdobj, which)
  50
  51 static char *
  52 _describeObj(JSDContext* jsdc, JSDObject *jsdobj)
  53 {
  54     return
  55         JS_smprintf("%0x new'd in %s at line %d using ctor %s in %s at line %d",
  56                     (int)jsdobj,
  57                     JSD_GetObjectNewURL(jsdc, jsdobj),
  58                     JSD_GetObjectNewLineNumber(jsdc, jsdobj),
  59                     JSD_GetObjectConstructorName(jsdc, jsdobj),
  60                     JSD_GetObjectConstructorURL(jsdc, jsdobj),
  61                     JSD_GetObjectConstructorLineNumber(jsdc, jsdobj));
  62 }
  63
  64 static void
  65 _traceObj(JSDContext* jsdc, JSDObject* jsdobj, int which)
  66 {
  67     char* description;
  68
  69     if( !jsdobj )
  70         return;
  71
  72     description = _describeObj(jsdc, jsdobj);
  73
  74     printf("%s : %s\n",
  75            which == 0 ? "new  " :
  76            which == 1 ? "final" :
  77                         "ctor ",
  78            description);
  79     if(description)
  80         free(description);
  81 }
  82 #else
  83 #define TRACEOBJ(jsdc, jsdobj, which) ((void)0)
  84 #endif /* JSD_TRACE */
  85
  86 #ifdef DEBUG
  87 void JSD_ASSERT_VALID_OBJECT(JSDObject* jsdobj)
  88 {
  89     JS_ASSERT(jsdobj);
  90     JS_ASSERT(!JS_CLIST_IS_EMPTY(&jsdobj->links));
  91     JS_ASSERT(jsdobj->obj);
  92 }
  93 #endif
  94
  95
  96 static void
  97 _destroyJSDObject(JSDContext* jsdc, JSDObject* jsdobj)
  98 {
  99     JS_ASSERT(JSD_OBJECTS_LOCKED(jsdc));
 100
 101     JS_REMOVE_LINK(&jsdobj->links);
 102     JS_HashTableRemove(jsdc->objectsTable, jsdobj->obj);
 103
 104     if(jsdobj->newURL)
 105         jsd_DropAtom(jsdc, jsdobj->newURL);
 106     if(jsdobj->ctorURL)
 107         jsd_DropAtom(jsdc, jsdobj->ctorURL);
 108     if(jsdobj->ctorName)
 109         jsd_DropAtom(jsdc, jsdobj->ctorName);
 110     free(jsdobj);
 111 }
 112
 113 static JSDObject*
 114 _createJSDObject(JSDContext* jsdc, JSContext *cx, JSObject *obj)
 115 {
 116     JSDObject* jsdobj;
 117     JSStackFrame* fp;
 118     JSStackFrame* iter = NULL;
 119     const char* newURL;
 120     jsbytecode* pc;
 121
 122     JS_ASSERT(JSD_OBJECTS_LOCKED(jsdc));
 123
 124     jsdobj = (JSDObject*) calloc(1, sizeof(JSDObject));
 125     if (jsdobj)
 126     {
 127         JS_INIT_CLIST(&jsdobj->links);
 128         JS_APPEND_LINK(&jsdobj->links, &jsdc->objectsList);
 129         jsdobj->obj = obj;
 130         JS_HashTableAdd(jsdc->objectsTable, obj, jsdobj);
 131
 132         if (jsdc->flags & JSD_DISABLE_OBJECT_TRACE)
 133             return jsdobj;
 134
 135         /* walk the stack to find js frame (if any) causing creation */
 136         while (NULL != (fp = JS_FrameIterator(cx, &iter)))
 137         {
 138             if( !JS_IsNativeFrame(cx, fp) )
 139             {
 140                 JSScript* script = JS_GetFrameScript(cx, fp);
 141                 if( !script )
 142                     continue;
 143
 144                 newURL = JS_GetScriptFilename(cx, script);
 145                 if( newURL )
 146                     jsdobj->newURL = jsd_AddAtom(jsdc, newURL);
 147
 148                 pc = JS_GetFramePC(cx, fp);
 149                 if( pc )
 150                     jsdobj->newLineno = JS_PCToLineNumber(cx, script, pc);
 151
 152                 break;
 153             }
 154         }
 155     }
 156     return jsdobj;
 157 }
 158
 159 void JS_DLL_CALLBACK
 160 jsd_ObjectHook(JSContext *cx, JSObject *obj, JSBool isNew, void *closure)
 161 {
 162     JSDObject* jsdobj;
 163     JSDContext* jsdc = (JSDContext*) closure;
 164
 165     if( ! jsdc || ! jsdc->inited )
 166         return;
 167
 168     JSD_LOCK_OBJECTS(jsdc);
 169     if(isNew)
 170     {
 171         jsdobj = _createJSDObject(jsdc, cx, obj);
 172         TRACEOBJ(jsdc, jsdobj, 0);
 173     }
 174     else
 175     {
 176         jsdobj = jsd_GetJSDObjectForJSObject(jsdc, obj);
 177         if( jsdobj )
 178         {
 179             TRACEOBJ(jsdc, jsdobj, 1);
 180             _destroyJSDObject(jsdc, jsdobj);
 181         }
 182     }
 183     JSD_UNLOCK_OBJECTS(jsdc);
 184 }
 185
 186 void
 187 jsd_Constructing(JSDContext* jsdc, JSContext *cx, JSObject *obj,
 188                  JSStackFrame *fp)
 189 {
 190     JSDObject* jsdobj;
 191     JSScript* script;
 192     JSDScript* jsdscript;
 193     const char* ctorURL;
 194     const char* ctorName;
 195
 196     JSD_LOCK_OBJECTS(jsdc);
 197     jsdobj = jsd_GetJSDObjectForJSObject(jsdc, obj);
 198     if( jsdobj && !jsdobj->ctorURL && !JS_IsNativeFrame(cx, fp) )
 199     {
 200         script = JS_GetFrameScript(cx, fp);
 201         if( script )
 202         {
 203             ctorURL = JS_GetScriptFilename(cx, script);
 204             if( ctorURL )
 205                 jsdobj->ctorURL = jsd_AddAtom(jsdc, ctorURL);
 206
 207             JSD_LOCK_SCRIPTS(jsdc);
 208             jsdscript = jsd_FindJSDScript(jsdc, script);
 209             JSD_UNLOCK_SCRIPTS(jsdc);
 210             if( jsdscript )
 211             {
 212                 ctorName = jsd_GetScriptFunctionName(jsdc, jsdscript);
 213                 if( ctorName )
 214                     jsdobj->ctorName = jsd_AddAtom(jsdc, ctorName);
 215             }
 216             jsdobj->ctorLineno = JS_GetScriptBaseLineNumber(cx, script);
 217         }
 218     }
 219     TRACEOBJ(jsdc, jsdobj, 3);
 220     JSD_UNLOCK_OBJECTS(jsdc);
 221 }
 222
 223 JS_STATIC_DLL_CALLBACK(JSHashNumber)
 224 _hash_root(const void *key)
 225 {
 226     return ((JSHashNumber) key) >> 2; /* help lame MSVC1.5 on Win16 */
 227 }
 228
 229 JSBool
 230 jsd_InitObjectManager(JSDContext* jsdc)
 231 {
 232     JS_INIT_CLIST(&jsdc->objectsList);
 233     jsdc->objectsTable = JS_NewHashTable(256, _hash_root,
 234                                          JS_CompareValues, JS_CompareValues,
 235                                          NULL, NULL);
 236     return (JSBool) jsdc->objectsTable;
 237 }
 238
 239 void
 240 jsd_DestroyObjectManager(JSDContext* jsdc)
 241 {
 242     JSD_LOCK_OBJECTS(jsdc);
 243     while( !JS_CLIST_IS_EMPTY(&jsdc->objectsList) )
 244         _destroyJSDObject(jsdc, (JSDObject*)JS_NEXT_LINK(&jsdc->objectsList));
 245     JS_HashTableDestroy(jsdc->objectsTable);
 246     JSD_UNLOCK_OBJECTS(jsdc);
 247 }
 248
 249 JSDObject*
 250 jsd_IterateObjects(JSDContext* jsdc, JSDObject** iterp)
 251 {
 252     JSDObject *jsdobj = *iterp;
 253
 254     JS_ASSERT(JSD_OBJECTS_LOCKED(jsdc));
 255
 256     if( !jsdobj )
 257         jsdobj = (JSDObject *)jsdc->objectsList.next;
 258     if( jsdobj == (JSDObject *)&jsdc->objectsList )
 259         return NULL;
 260     *iterp = (JSDObject*) jsdobj->links.next;
 261     return jsdobj;
 262 }
 263
 264 JSObject*
 265 jsd_GetWrappedObject(JSDContext* jsdc, JSDObject* jsdobj)
 266 {
 267     return jsdobj->obj;
 268 }
 269
 270 const char*
 271 jsd_GetObjectNewURL(JSDContext* jsdc, JSDObject* jsdobj)
 272 {
 273     if( jsdobj->newURL )
 274         return JSD_ATOM_TO_STRING(jsdobj->newURL);
 275     return NULL;
 276 }
 277
 278 uintN
 279 jsd_GetObjectNewLineNumber(JSDContext* jsdc, JSDObject* jsdobj)
 280 {
 281     return jsdobj->newLineno;
 282 }
 283
 284 const char*
 285 jsd_GetObjectConstructorURL(JSDContext* jsdc, JSDObject* jsdobj)
 286 {
 287     if( jsdobj->ctorURL )
 288         return JSD_ATOM_TO_STRING(jsdobj->ctorURL);
 289     return NULL;
 290 }
 291
 292 uintN
 293 jsd_GetObjectConstructorLineNumber(JSDContext* jsdc, JSDObject* jsdobj)
 294 {
 295     return jsdobj->ctorLineno;
 296 }
 297
 298 const char*
 299 jsd_GetObjectConstructorName(JSDContext* jsdc, JSDObject* jsdobj)
 300 {
 301     if( jsdobj->ctorName )
 302         return JSD_ATOM_TO_STRING(jsdobj->ctorName);
 303     return NULL;
 304 }
 305
 306 JSDObject*
 307 jsd_GetJSDObjectForJSObject(JSDContext* jsdc, JSObject* jsobj)
 308 {
 309     JSDObject* jsdobj;
 310
 311     JSD_LOCK_OBJECTS(jsdc);
 312     jsdobj = (JSDObject*) JS_HashTableLookup(jsdc->objectsTable, jsobj);
 313     JSD_UNLOCK_OBJECTS(jsdc);
 314     return jsdobj;
 315 }
 316
 317 JSDObject*
 318 jsd_GetObjectForValue(JSDContext* jsdc, JSDValue* jsdval)
 319 {
 320     return jsd_GetJSDObjectForJSObject(jsdc, JSVAL_TO_OBJECT(jsdval->val));
 321 }
 322
 323 JSDValue*
 324 jsd_GetValueForObject(JSDContext* jsdc, JSDObject* jsdobj)
 325 {
 326     return jsd_NewValue(jsdc, OBJECT_TO_JSVAL(jsdobj->obj));
 327 }
 328
 329