DXR is a code search and navigation tool aimed at making sense of large projects. It supports full-text and regex searches as well as structural queries.

Implementation

Mercurial (c68fe15a81fc)

VCS Links

Line Code
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

/* Private maps (hashtables). */

#ifndef xpcmaps_h___
#define xpcmaps_h___

#include "mozilla/MemoryReporting.h"

#include "js/GCHashTable.h"

// Maps...

// Note that most of the declarations for hash table entries begin with
// a pointer to something or another. This makes them look enough like
// the PLDHashEntryStub struct that the default ops (PLDHashTable::StubOps())
// just do the right thing for most of our needs.

// no virtuals in the maps - all the common stuff inlined
// templates could be used to good effect here.

/***************************************************************************/
// default initial sizes for maps (hashtables)

#define XPC_JS_MAP_LENGTH 32

#define XPC_NATIVE_MAP_LENGTH 8
#define XPC_NATIVE_PROTO_MAP_LENGTH 8
#define XPC_DYING_NATIVE_PROTO_MAP_LENGTH 8
#define XPC_NATIVE_INTERFACE_MAP_LENGTH 32
#define XPC_NATIVE_SET_MAP_LENGTH 32
#define XPC_WRAPPER_MAP_LENGTH 8

/*************************/

class JSObject2WrappedJSMap {
  using Map = js::HashMap<JS::Heap<JSObject*>, nsXPCWrappedJS*,
                          js::MovableCellHasher<JS::Heap<JSObject*>>,
                          InfallibleAllocPolicy>;

 public:
  JSObject2WrappedJSMap() = default;

  inline nsXPCWrappedJS* Find(JSObject* Obj) {
    MOZ_ASSERT(Obj, "bad param");
    Map::Ptr p = mTable.lookup(Obj);
    return p ? p->value() : nullptr;
  }

#ifdef DEBUG
  inline bool HasWrapper(nsXPCWrappedJS* wrapper) {
    for (auto iter = mTable.iter(); !iter.done(); iter.next()) {
      if (iter.get().value() == wrapper) {
        return true;
      }
    }
    return false;
  }
#endif

  inline nsXPCWrappedJS* Add(JSContext* cx, nsXPCWrappedJS* wrapper) {
    MOZ_ASSERT(wrapper, "bad param");
    JSObject* obj = wrapper->GetJSObjectPreserveColor();
    Map::AddPtr p = mTable.lookupForAdd(obj);
    if (p) {
      return p->value();
    }
    if (!mTable.add(p, obj, wrapper)) {
      return nullptr;
    }
    return wrapper;
  }

  inline void Remove(nsXPCWrappedJS* wrapper) {
    MOZ_ASSERT(wrapper, "bad param");
    mTable.remove(wrapper->GetJSObjectPreserveColor());
  }

  inline uint32_t Count() { return mTable.count(); }

  inline void Dump(int16_t depth) {
    for (auto iter = mTable.iter(); !iter.done(); iter.next()) {
      iter.get().value()->DebugDump(depth);
    }
  }

  void UpdateWeakPointersAfterGC();

  void ShutdownMarker();

  size_t SizeOfIncludingThis(mozilla::MallocSizeOf mallocSizeOf) const;

  // Report the sum of SizeOfIncludingThis() for all wrapped JS in the map.
  // Each wrapped JS is only in one map.
  size_t SizeOfWrappedJS(mozilla::MallocSizeOf mallocSizeOf) const;

 private:
  Map mTable{XPC_JS_MAP_LENGTH};
};

/*************************/

class Native2WrappedNativeMap {
 public:
  struct Entry : public PLDHashEntryHdr {
    nsISupports* key;
    XPCWrappedNative* value;
  };

  Native2WrappedNativeMap();

  inline XPCWrappedNative* Find(nsISupports* Obj) const {
    MOZ_ASSERT(Obj, "bad param");
    auto entry = static_cast<Entry*>(mTable.Search(Obj));
    return entry ? entry->value : nullptr;
  }

  inline XPCWrappedNative* Add(XPCWrappedNative* wrapper) {
    MOZ_ASSERT(wrapper, "bad param");
    nsISupports* obj = wrapper->GetIdentityObject();
    MOZ_ASSERT(!Find(obj), "wrapper already in new scope!");
    auto entry = static_cast<Entry*>(mTable.Add(obj, mozilla::fallible));
    if (!entry) {
      return nullptr;
    }
    if (entry->key) {
      return entry->value;
    }
    entry->key = obj;
    entry->value = wrapper;
    return wrapper;
  }

  inline void Clear() { mTable.Clear(); }

  inline uint32_t Count() { return mTable.EntryCount(); }

  PLDHashTable::Iterator Iter() { return mTable.Iter(); }

  size_t SizeOfIncludingThis(mozilla::MallocSizeOf mallocSizeOf) const;

 private:
  PLDHashTable mTable;
};

/*************************/

class IID2NativeInterfaceMap {
 public:
  struct Entry : public PLDHashEntryHdr {
    const nsIID* key;
    XPCNativeInterface* value;

    static const struct PLDHashTableOps sOps;
  };

  IID2NativeInterfaceMap();

  inline XPCNativeInterface* Find(REFNSIID iid) const {
    auto entry = static_cast<Entry*>(mTable.Search(&iid));
    return entry ? entry->value : nullptr;
  }

  inline XPCNativeInterface* Add(XPCNativeInterface* iface) {
    MOZ_ASSERT(iface, "bad param");
    const nsIID* iid = iface->GetIID();
    auto entry = static_cast<Entry*>(mTable.Add(iid, mozilla::fallible));
    if (!entry) {
      return nullptr;
    }
    if (entry->key) {
      return entry->value;
    }
    entry->key = iid;
    entry->value = iface;
    return iface;
  }

  inline void Remove(XPCNativeInterface* iface) {
    MOZ_ASSERT(iface, "bad param");
    mTable.Remove(iface->GetIID());
  }

  inline uint32_t Count() { return mTable.EntryCount(); }

  PLDHashTable::Iterator Iter() { return mTable.Iter(); }

  size_t SizeOfIncludingThis(mozilla::MallocSizeOf mallocSizeOf) const;

 private:
  PLDHashTable mTable;
};

/*************************/

class ClassInfo2NativeSetMap {
 public:
  struct Entry : public PLDHashEntryHdr {
    nsIClassInfo* key;
    XPCNativeSet* value;  // strong reference
    static const PLDHashTableOps sOps;

   private:
    static bool Match(const PLDHashEntryHdr* aEntry, const void* aKey);
    static void Clear(PLDHashTable* aTable, PLDHashEntryHdr* aEntry);
  };

  ClassInfo2NativeSetMap();

  inline XPCNativeSet* Find(nsIClassInfo* info) const {
    auto entry = static_cast<Entry*>(mTable.Search(info));
    return entry ? entry->value : nullptr;
  }

  inline XPCNativeSet* Add(nsIClassInfo* info, XPCNativeSet* set) {
    MOZ_ASSERT(info, "bad param");
    auto entry = static_cast<Entry*>(mTable.Add(info, mozilla::fallible));
    if (!entry) {
      return nullptr;
    }
    if (entry->key) {
      return entry->value;
    }
    entry->key = info;
    NS_ADDREF(entry->value = set);
    return set;
  }

  inline void Remove(nsIClassInfo* info) {
    MOZ_ASSERT(info, "bad param");
    mTable.Remove(info);
  }

  inline uint32_t Count() { return mTable.EntryCount(); }

  // ClassInfo2NativeSetMap holds pointers to *some* XPCNativeSets.
  // So we don't want to count those XPCNativeSets, because they are better
  // counted elsewhere (i.e. in XPCJSContext::mNativeSetMap, which holds
  // pointers to *all* XPCNativeSets).  Hence the "Shallow".
  size_t ShallowSizeOfIncludingThis(mozilla::MallocSizeOf mallocSizeOf);

 private:
  PLDHashTable mTable;
};

/*************************/

class ClassInfo2WrappedNativeProtoMap {
 public:
  struct Entry : public PLDHashEntryHdr {
    nsIClassInfo* key;
    XPCWrappedNativeProto* value;
  };

  ClassInfo2WrappedNativeProtoMap();

  inline XPCWrappedNativeProto* Find(nsIClassInfo* info) const {
    auto entry = static_cast<Entry*>(mTable.Search(info));
    return entry ? entry->value : nullptr;
  }

  inline XPCWrappedNativeProto* Add(nsIClassInfo* info,
                                    XPCWrappedNativeProto* proto) {
    MOZ_ASSERT(info, "bad param");
    auto entry = static_cast<Entry*>(mTable.Add(info, mozilla::fallible));
    if (!entry) {
      return nullptr;
    }
    if (entry->key) {
      return entry->value;
    }
    entry->key = info;
    entry->value = proto;
    return proto;
  }

  inline void Clear() { mTable.Clear(); }

  inline uint32_t Count() { return mTable.EntryCount(); }

  PLDHashTable::Iterator Iter() { return mTable.Iter(); }

  size_t SizeOfIncludingThis(mozilla::MallocSizeOf mallocSizeOf) const;

 private:
  PLDHashTable mTable;
};

/*************************/

class NativeSetMap {
 public:
  struct Entry : public PLDHashEntryHdr {
    XPCNativeSet* key_value;

    static bool Match(const PLDHashEntryHdr* entry, const void* key);

    static const struct PLDHashTableOps sOps;
  };

  NativeSetMap();

  inline XPCNativeSet* Find(XPCNativeSetKey* key) const {
    auto entry = static_cast<Entry*>(mTable.Search(key));
    return entry ? entry->key_value : nullptr;
  }

  inline XPCNativeSet* Add(const XPCNativeSetKey* key, XPCNativeSet* set) {
    MOZ_ASSERT(key, "bad param");
    MOZ_ASSERT(set, "bad param");
    auto entry = static_cast<Entry*>(mTable.Add(key, mozilla::fallible));
    if (!entry) {
      return nullptr;
    }
    if (entry->key_value) {
      return entry->key_value;
    }
    entry->key_value = set;
    return set;
  }

  bool AddNew(const XPCNativeSetKey* key, XPCNativeSet* set) {
    XPCNativeSet* set2 = Add(key, set);
    if (!set2) {
      return false;
    }
#ifdef DEBUG
    XPCNativeSetKey key2(set);
    MOZ_ASSERT(key->Hash() == key2.Hash());
    MOZ_ASSERT(set2 == set, "Should not have found an existing entry");
#endif
    return true;
  }

  inline void Remove(XPCNativeSet* set) {
    MOZ_ASSERT(set, "bad param");

    XPCNativeSetKey key(set);
    mTable.Remove(&key);
  }

  inline uint32_t Count() { return mTable.EntryCount(); }

  PLDHashTable::Iterator Iter() { return mTable.Iter(); }

  size_t SizeOfIncludingThis(mozilla::MallocSizeOf mallocSizeOf) const;

 private:
  PLDHashTable mTable;
};

/***************************************************************************/

class XPCWrappedNativeProtoMap {
 public:
  using Entry = PLDHashEntryStub;

  XPCWrappedNativeProtoMap();

  inline XPCWrappedNativeProto* Add(XPCWrappedNativeProto* proto) {
    MOZ_ASSERT(proto, "bad param");
    auto entry =
        static_cast<PLDHashEntryStub*>(mTable.Add(proto, mozilla::fallible));
    if (!entry) {
      return nullptr;
    }
    if (entry->key) {
      return (XPCWrappedNativeProto*)entry->key;
    }
    entry->key = proto;
    return proto;
  }

  inline uint32_t Count() { return mTable.EntryCount(); }

  PLDHashTable::Iterator Iter() { return mTable.Iter(); }

 private:
  PLDHashTable mTable;
};

/***************************************************************************/

class JSObject2JSObjectMap {
  using Map = JS::GCHashMap<JS::Heap<JSObject*>, JS::Heap<JSObject*>,
                            js::MovableCellHasher<JS::Heap<JSObject*>>,
                            js::SystemAllocPolicy>;

 public:
  JSObject2JSObjectMap() = default;

  inline JSObject* Find(JSObject* key) {
    MOZ_ASSERT(key, "bad param");
    if (Map::Ptr p = mTable.lookup(key)) {
      return p->value();
    }
    return nullptr;
  }

  /* Note: If the entry already exists, return the old value. */
  inline JSObject* Add(JSContext* cx, JSObject* key, JSObject* value) {
    MOZ_ASSERT(key, "bad param");
    Map::AddPtr p = mTable.lookupForAdd(key);
    if (p) {
      JSObject* oldValue = p->value();
      p->value() = value;
      return oldValue;
    }
    if (!mTable.add(p, key, value)) {
      return nullptr;
    }
    MOZ_ASSERT(xpc::ObjectScope(key)->mWaiverWrapperMap == this);
    return value;
  }

  inline void Remove(JSObject* key) {
    MOZ_ASSERT(key, "bad param");
    mTable.remove(key);
  }

  inline uint32_t Count() { return mTable.count(); }

  void Sweep() { mTable.sweep(); }

 private:
  Map mTable{XPC_WRAPPER_MAP_LENGTH};
};

#endif /* xpcmaps_h___ */