[base] Move hashmap allocator to a field

src/base/hashmap.h

 // Copyright 2012 the V8 project authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 // The reason we write our own hash map instead of using unordered_map in STL,
 // is that STL containers use a mutex pool on debug build, which will lead to
 // deadlock when we are using async signal handler.
 
 #ifndef V8_BASE_HASHMAP_H_
 #define V8_BASE_HASHMAP_H_
@@ skipping 37 matching lines @@
 
   ~TemplateHashMapImpl();
 
   // If an entry with matching key is found, returns that entry.
   // Otherwise, nullptr is returned.
   Entry* Lookup(const Key& key, uint32_t hash) const;
 
   // If an entry with matching key is found, returns that entry.
   // If no matching entry is found, a new entry is inserted with
   // corresponding key, key hash, and default initialized value.
-  Entry* LookupOrInsert(const Key& key, uint32_t hash,
-                        AllocationPolicy allocator = AllocationPolicy());
+  Entry* LookupOrInsert(const Key& key, uint32_t hash);
 
-  Entry* InsertNew(const Key& key, uint32_t hash,
-                   AllocationPolicy allocator = AllocationPolicy());
+  Entry* InsertNew(const Key& key, uint32_t hash);
 
   // Removes the entry with matching key.
   // It returns the value of the deleted entry
   // or null if there is no value for such key.
   Value Remove(const Key& key, uint32_t hash);
 
   // Empties the hash map (occupancy() == 0).
   void Clear();
 
   // The number of (non-empty) entries in the table.
@@ skipping 15 matching lines @@
   Entry* Start() const;
   Entry* Next(Entry* p) const;
 
   // Some match functions defined for convenience.
   static bool PointersMatch(typename MatchFunHelper<Key>::KeyRef key1,
                             typename MatchFunHelper<Key>::KeyRef key2) {
     return key1 == key2;
   }
 
  private:
+  // Helper which holds the entry array as well as the allocation policy.
+  // AllocationPolicy is a base class rather than a field to take advantage of
+  // the empty base optimisation for state-free allocators, such as the
+  // DefaultAllocationPolicy above.

[rmcilroy, 2016/09/19 10:55:11]

Let's make this a field instead of using the empty base optimization. I'd prefer
to keep ZoneAllocationPolicy final.

[Leszek Swirski, 2016/09/19 12:20:56]

Fair enough, done.

+  struct AllocatedEntryHolder : public AllocationPolicy {
+    Entry* values;
+    explicit AllocatedEntryHolder(AllocationPolicy allocator)
+        : AllocationPolicy(allocator) {}
+  };
+
   MatchFun match_;
-  Entry* map_;
+  AllocatedEntryHolder map_;
   uint32_t capacity_;
   uint32_t occupancy_;
 
-  Entry* map_end() const { return map_ + capacity_; }
+  Entry* map_end() const { return map_.values + capacity_; }
   Entry* Probe(const Key& key, uint32_t hash) const;
-  void Initialize(uint32_t capacity, AllocationPolicy allocator);
-  void Resize(AllocationPolicy allocator);
+  void Initialize(uint32_t capacity);
+  void Resize();
 };
 
 template <typename Key>
 struct MatchFunHelper {
   typedef const Key& KeyRef;
   typedef bool (*Fun)(KeyRef key1, KeyRef key2);
 };
 
 template <typename Key>
 struct MatchFunHelper<Key*> {
   typedef Key* KeyRef;
   typedef bool (*Fun)(KeyRef key1, KeyRef key2);
 };
 
 typedef TemplateHashMapImpl<void*, void*, DefaultAllocationPolicy> HashMap;
 
 template <typename Key, typename Value, class AllocationPolicy>
 TemplateHashMapImpl<Key, Value, AllocationPolicy>::TemplateHashMapImpl(
-    MatchFun match, uint32_t initial_capacity, AllocationPolicy allocator) {
+    MatchFun match, uint32_t initial_capacity, AllocationPolicy allocator)
+    : map_(allocator) {
   match_ = match;
-  Initialize(initial_capacity, allocator);
+  Initialize(initial_capacity);
 }
 
 template <typename Key, typename Value, class AllocationPolicy>
 TemplateHashMapImpl<Key, Value, AllocationPolicy>::~TemplateHashMapImpl() {
-  AllocationPolicy::Delete(map_);
+  map_.AllocationPolicy::Delete(map_.values);
 }
 
 template <typename Key, typename Value, class AllocationPolicy>
 typename TemplateHashMapImpl<Key, Value, AllocationPolicy>::Entry*
 TemplateHashMapImpl<Key, Value, AllocationPolicy>::Lookup(const Key& key,
                                                           uint32_t hash) const {
   Entry* p = Probe(key, hash);
   return p->exists() ? p : nullptr;
 }
 
 template <typename Key, typename Value, class AllocationPolicy>
 typename TemplateHashMapImpl<Key, Value, AllocationPolicy>::Entry*
 TemplateHashMapImpl<Key, Value, AllocationPolicy>::LookupOrInsert(
-    const Key& key, uint32_t hash, AllocationPolicy allocator) {
+    const Key& key, uint32_t hash) {
   // Find a matching entry.
   Entry* p = Probe(key, hash);
   if (p->exists()) {
     return p;
   }
 
-  return InsertNew(key, hash, allocator);
+  return InsertNew(key, hash);
 }
 
 template <typename Key, typename Value, class AllocationPolicy>
 typename TemplateHashMapImpl<Key, Value, AllocationPolicy>::Entry*
-TemplateHashMapImpl<Key, Value, AllocationPolicy>::InsertNew(
-    const Key& key, uint32_t hash, AllocationPolicy allocator) {
+TemplateHashMapImpl<Key, Value, AllocationPolicy>::InsertNew(const Key& key,
+                                                             uint32_t hash) {
   // Find a matching entry.
   Entry* p = Probe(key, hash);
   DCHECK(!p->exists());
 
   // No entry found; insert one.
   new (p) Entry(key, Value(), hash);
   occupancy_++;
 
   // Grow the map if we reached >= 80% occupancy.
   if (occupancy_ + occupancy_ / 4 >= capacity_) {
-    Resize(allocator);
+    Resize();
     p = Probe(key, hash);
   }
 
   return p;
 }
 
 template <typename Key, typename Value, class AllocationPolicy>
 Value TemplateHashMapImpl<Key, Value, AllocationPolicy>::Remove(const Key& key,
                                                                 uint32_t hash) {
   // Lookup the entry for the key to remove.
@@ skipping 19 matching lines @@
   // This guarantees loop termination as there is at least one empty entry so
   // eventually the removed entry will have an empty entry after it.
   DCHECK(occupancy_ < capacity_);
 
   // p is the candidate entry to clear. q is used to scan forwards.
   Entry* q = p;  // Start at the entry to remove.
   while (true) {
     // Move q to the next entry.
     q = q + 1;
     if (q == map_end()) {
-      q = map_;
+      q = map_.values;
     }
 
     // All entries between p and q have their initial position between p and q
     // and the entry p can be cleared without breaking the search for these
     // entries.
     if (!q->exists()) {
       break;
     }
 
     // Find the initial position for the entry at position q.
-    Entry* r = map_ + (q->hash & (capacity_ - 1));
+    Entry* r = map_.values + (q->hash & (capacity_ - 1));
 
     // If the entry at position q has its initial position outside the range
     // between p and q it can be moved forward to position p and will still be
     // found. There is now a new candidate entry for clearing.
     if ((q > p && (r <= p || r > q)) || (q < p && (r <= p && r > q))) {
       *p = *q;
       p = q;
     }
   }
 
   // Clear the entry which is allowed to en emptied.
   p->clear();
   occupancy_--;
   return value;
 }
 
 template <typename Key, typename Value, class AllocationPolicy>
 void TemplateHashMapImpl<Key, Value, AllocationPolicy>::Clear() {
   // Mark all entries as empty.
   const Entry* end = map_end();
-  for (Entry* p = map_; p < end; p++) {
+  for (Entry* p = map_.values; p < end; p++) {
     p->clear();
   }
   occupancy_ = 0;
 }
 
 template <typename Key, typename Value, class AllocationPolicy>
 typename TemplateHashMapImpl<Key, Value, AllocationPolicy>::Entry*
 TemplateHashMapImpl<Key, Value, AllocationPolicy>::Start() const {
-  return Next(map_ - 1);
+  return Next(map_.values - 1);
 }
 
 template <typename Key, typename Value, class AllocationPolicy>
 typename TemplateHashMapImpl<Key, Value, AllocationPolicy>::Entry*
 TemplateHashMapImpl<Key, Value, AllocationPolicy>::Next(Entry* p) const {
   const Entry* end = map_end();
-  DCHECK(map_ - 1 <= p && p < end);
+  DCHECK(map_.values - 1 <= p && p < end);
   for (p++; p < end; p++) {
     if (p->exists()) {
       return p;
     }
   }
   return nullptr;
 }
 
 template <typename Key, typename Value, class AllocationPolicy>
 typename TemplateHashMapImpl<Key, Value, AllocationPolicy>::Entry*
 TemplateHashMapImpl<Key, Value, AllocationPolicy>::Probe(const Key& key,
                                                          uint32_t hash) const {
   DCHECK(base::bits::IsPowerOfTwo32(capacity_));
-  Entry* p = map_ + (hash & (capacity_ - 1));
+  Entry* p = map_.values + (hash & (capacity_ - 1));
   const Entry* end = map_end();
-  DCHECK(map_ <= p && p < end);
+  DCHECK(map_.values <= p && p < end);
 
   DCHECK(occupancy_ < capacity_);  // Guarantees loop termination.
   while (p->exists() && (hash != p->hash || !match_(key, p->key))) {
     p++;
     if (p >= end) {
-      p = map_;
+      p = map_.values;
     }
   }
 
   return p;
 }
 
 template <typename Key, typename Value, class AllocationPolicy>
 void TemplateHashMapImpl<Key, Value, AllocationPolicy>::Initialize(
-    uint32_t capacity, AllocationPolicy allocator) {
+    uint32_t capacity) {
   DCHECK(base::bits::IsPowerOfTwo32(capacity));
-  map_ = reinterpret_cast<Entry*>(allocator.New(capacity * sizeof(Entry)));
-  if (map_ == nullptr) {
+  map_.values = reinterpret_cast<Entry*>(
+      map_.AllocationPolicy::New(capacity * sizeof(Entry)));
+  if (map_.values == nullptr) {
     FATAL("Out of memory: HashMap::Initialize");
     return;
   }
   capacity_ = capacity;
   Clear();
 }
 
 template <typename Key, typename Value, class AllocationPolicy>
-void TemplateHashMapImpl<Key, Value, AllocationPolicy>::Resize(
-    AllocationPolicy allocator) {
-  Entry* map = map_;
+void TemplateHashMapImpl<Key, Value, AllocationPolicy>::Resize() {
+  Entry* map = map_.values;
   uint32_t n = occupancy_;
 
   // Allocate larger map.
-  Initialize(capacity_ * 2, allocator);
+  Initialize(capacity_ * 2);
 
   // Rehash all current entries.
   for (Entry* p = map; n > 0; p++) {
     if (p->exists()) {
-      Entry* entry = LookupOrInsert(p->key, p->hash, allocator);
+      Entry* entry = LookupOrInsert(p->key, p->hash);
       entry->value = p->value;
       n--;
     }
   }
 
   // Delete old map.
   AllocationPolicy::Delete(map);
 }
 
 // A hash map for pointer keys and values with an STL-like interface.
@@ skipping 34 matching lines @@
                       void*, void*, AllocationPolicy>::MatchFun match,
                   AllocationPolicy allocator = AllocationPolicy())
       : TemplateHashMapImpl<void*, void*, AllocationPolicy>(
             match,
             TemplateHashMapImpl<void*, void*,
                                 AllocationPolicy>::kDefaultHashMapCapacity,
             allocator) {}
 
   Iterator begin() const { return Iterator(this, this->Start()); }
   Iterator end() const { return Iterator(this, nullptr); }
-  Iterator find(Key* key, bool insert = false,
-                AllocationPolicy allocator = AllocationPolicy()) {
+  Iterator find(Key* key, bool insert = false) {
     if (insert) {
-      return Iterator(this, this->LookupOrInsert(key, key->Hash(), allocator));
+      return Iterator(this, this->LookupOrInsert(key, key->Hash()));
     }
     return Iterator(this, this->Lookup(key, key->Hash()));
   }
 };
 
 }  // namespace base
 }  // namespace v8
 
 #endif  // V8_BASE_HASHMAP_H_