/js/src/jswatchpoint.h

  1/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-
  2 *
  3 * ***** BEGIN LICENSE BLOCK *****
  4 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  5 *
  6 * The contents of this file are subject to the Mozilla Public License Version
  7 * 1.1 (the "License"); you may not use this file except in compliance with
  8 * the License. You may obtain a copy of the License at
  9 * http://www.mozilla.org/MPL/
 10 *
 11 * Software distributed under the License is distributed on an "AS IS" basis,
 12 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 13 * for the specific language governing rights and limitations under the
 14 * License.
 15 *
 16 * The Original Code is an implementation of watchpoints for SpiderMonkey.
 17 *
 18 * The Initial Developer of the Original Code is
 19 * Mozilla Foundation.
 20 * Portions created by the Initial Developer are Copyright (C) 2011
 21 * the Initial Developer. All Rights Reserved.
 22 *
 23 * Contributor(s):
 24 *   Jason Orendorff <jorendorff@mozilla.com>
 25 *
 26 * Alternatively, the contents of this file may be used under the terms of
 27 * either the GNU General Public License Version 2 or later (the "GPL"), or
 28 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 29 * in which case the provisions of the GPL or the LGPL are applicable instead
 30 * of those above. If you wish to allow use of your version of this file only
 31 * under the terms of either the GPL or the LGPL, and not to allow others to
 32 * use your version of this file under the terms of the MPL, indicate your
 33 * decision by deleting the provisions above and replace them with the notice
 34 * and other provisions required by the GPL or the LGPL. If you do not delete
 35 * the provisions above, a recipient may use your version of this file under
 36 * the terms of any one of the MPL, the GPL or the LGPL.
 37 *
 38 * ***** END LICENSE BLOCK ***** */
 39
 40#ifndef jswatchpoint_h___
 41#define jswatchpoint_h___
 42
 43#include "jsalloc.h"
 44#include "jsprvtd.h"
 45#include "jsapi.h"
 46#include "jsfriendapi.h"
 47
 48#include "gc/Barrier.h"
 49#include "js/HashTable.h"
 50
 51namespace js {
 52
 53struct WatchKey {
 54    WatchKey() {}
 55    WatchKey(JSObject *obj, jsid id) : object(obj), id(id) {}
 56    WatchKey(const WatchKey &key) : object(key.object.get()), id(key.id.get()) {}
 57    HeapPtrObject object;
 58    HeapId id;
 59};
 60
 61struct Watchpoint {
 62    JSWatchPointHandler handler;
 63    HeapPtrObject closure;
 64    bool held;  /* true if currently running handler */
 65};
 66
 67template <>
 68struct DefaultHasher<WatchKey> {
 69    typedef WatchKey Lookup;
 70    static inline js::HashNumber hash(const Lookup &key);
 71
 72    static bool match(const WatchKey &k, const Lookup &l) {
 73        return k.object == l.object && k.id.get() == l.id.get();
 74    }
 75};
 76
 77class WatchpointMap {
 78  public:
 79    typedef HashMap<WatchKey, Watchpoint, DefaultHasher<WatchKey>, SystemAllocPolicy> Map;
 80
 81    bool init();
 82    bool watch(JSContext *cx, JSObject *obj, jsid id,
 83               JSWatchPointHandler handler, JSObject *closure);
 84    void unwatch(JSObject *obj, jsid id,
 85                 JSWatchPointHandler *handlerp, JSObject **closurep);
 86    void unwatchObject(JSObject *obj);
 87    void clear();
 88
 89    bool triggerWatchpoint(JSContext *cx, JSObject *obj, jsid id, Value *vp);
 90
 91    static bool markAllIteratively(JSTracer *trc);
 92    bool markIteratively(JSTracer *trc);
 93    void markAll(JSTracer *trc);
 94    static void sweepAll(JSRuntime *rt);
 95    void sweep();
 96
 97    static void traceAll(WeakMapTracer *trc);
 98    void trace(WeakMapTracer *trc);
 99
100  private:
101    Map map;
102};
103
104}
105
106#endif /* jswatchpoint_h___ */