Make HPACK static table static and immutable.

net/spdy/hpack_header_table_test.cc

 // Copyright 2014 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "net/spdy/hpack_header_table.h"
 
 #include <algorithm>
 #include <set>
 #include <string>
 #include <vector>
@@ skipping 16 matching lines @@
  public:
   explicit HpackHeaderTablePeer(HpackHeaderTable* table)
       : table_(table) {}
 
   const HpackHeaderTable::EntryTable& dynamic_entries() {
     return table_->dynamic_entries_;
   }
   const HpackHeaderTable::EntryTable& static_entries() {
     return table_->static_entries_;
   }
-  const HpackHeaderTable::OrderedEntrySet& index() {
-    return table_->index_;
+  size_t index_size() {
+    return table_->static_index_.size() + table_->dynamic_index_.size();
   }
   std::vector<HpackEntry*> EvictionSet(StringPiece name, StringPiece value) {
     HpackHeaderTable::EntryTable::iterator begin, end;
     table_->EvictionSet(name, value, &begin, &end);
     std::vector<HpackEntry*> result;
     for (; begin != end; ++begin) {
       result.push_back(&(*begin));
     }
     return result;
   }
   size_t total_insertions() {
     return table_->total_insertions_;
   }
   size_t dynamic_entries_count() {
     return table_->dynamic_entries_.size();
   }
   size_t EvictionCountForEntry(StringPiece name, StringPiece value) {
     return table_->EvictionCountForEntry(name, value);
   }
   size_t EvictionCountToReclaim(size_t reclaim_size) {
     return table_->EvictionCountToReclaim(reclaim_size);
   }
   void Evict(size_t count) {
     return table_->Evict(count);
   }
 
-  void AddStaticEntry(StringPiece name, StringPiece value) {
-    table_->static_entries_.push_back(
-        HpackEntry(name, value, true, table_->total_insertions_++));
-  }
-
   void AddDynamicEntry(StringPiece name, StringPiece value) {
     table_->dynamic_entries_.push_back(
         HpackEntry(name, value, false, table_->total_insertions_++));
   }
 
  private:
   HpackHeaderTable* table_;
 };
 
 }  // namespace test
 
 namespace {
 
 class HpackHeaderTableTest : public ::testing::Test {
  protected:
   typedef std::vector<HpackEntry> HpackEntryVector;
 
-  HpackHeaderTableTest()
-      : table_(),
-        peer_(&table_),
-        name_("header-name"),
-        value_("header value") {}
+  HpackHeaderTableTest() : table_(), peer_(&table_) {}
 
   // Returns an entry whose Size() is equal to the given one.
   static HpackEntry MakeEntryOfSize(uint32 size) {
     EXPECT_GE(size, HpackEntry::kSizeOverhead);
     string name((size - HpackEntry::kSizeOverhead) / 2, 'n');
     string value(size - HpackEntry::kSizeOverhead - name.size(), 'v');
     HpackEntry entry(name, value);
     EXPECT_EQ(size, entry.Size());
     return entry;
   }
@@ skipping 17 matching lines @@
   // Adds the given vector of entries to the given header table,
   // expecting no eviction to happen.
   void AddEntriesExpectNoEviction(const HpackEntryVector& entries) {
     for (HpackEntryVector::const_iterator it = entries.begin();
          it != entries.end(); ++it) {
       HpackHeaderTable::EntryTable::iterator begin, end;
 
       table_.EvictionSet(it->name(), it->value(), &begin, &end);
       EXPECT_EQ(0, distance(begin, end));
 
-      HpackEntry* entry = table_.TryAddEntry(it->name(), it->value());
+      const HpackEntry* entry = table_.TryAddEntry(it->name(), it->value());
       EXPECT_NE(entry, static_cast<HpackEntry*>(NULL));
     }
 
     for (size_t i = 0; i != entries.size(); ++i) {
       // Static table has 61 entries, dynamic entries follow those.
       size_t index = 61 + entries.size() - i;
-      HpackEntry* entry = table_.GetByIndex(index);
+      const HpackEntry* entry = table_.GetByIndex(index);
       EXPECT_EQ(entries[i].name(), entry->name());
       EXPECT_EQ(entries[i].value(), entry->value());
       EXPECT_EQ(index, table_.IndexOf(entry));
     }
   }
 
-  HpackEntry StaticEntry() {
-    peer_.AddStaticEntry(name_, value_);
-    return peer_.static_entries().back();
-  }
-  HpackEntry DynamicEntry() {
-    peer_.AddDynamicEntry(name_, value_);
+  HpackEntry DynamicEntry(string name, string value) {
+    peer_.AddDynamicEntry(name, value);
     return peer_.dynamic_entries().back();
   }
 
   HpackHeaderTable table_;
   test::HpackHeaderTablePeer peer_;
-  string name_, value_;
 };
 
 TEST_F(HpackHeaderTableTest, StaticTableInitialization) {
   EXPECT_EQ(0u, table_.size());
   EXPECT_EQ(kDefaultHeaderTableSizeSetting, table_.max_size());
   EXPECT_EQ(kDefaultHeaderTableSizeSetting, table_.settings_size_bound());
 
   EXPECT_EQ(0u, peer_.dynamic_entries_count());
   EXPECT_EQ(peer_.static_entries().size(), peer_.total_insertions());
 
   // Static entries have been populated and inserted into the table & index.
   EXPECT_NE(0u, peer_.static_entries().size());
-  EXPECT_EQ(peer_.index().size(), peer_.static_entries().size());
+  EXPECT_EQ(peer_.index_size(), peer_.static_entries().size());
   for (size_t i = 0; i != peer_.static_entries().size(); ++i) {
     const HpackEntry* entry = &peer_.static_entries()[i];
 
     EXPECT_TRUE(entry->IsStatic());
     EXPECT_EQ(entry, table_.GetByIndex(i + 1));
     EXPECT_EQ(entry, table_.GetByNameAndValue(entry->name(), entry->value()));
   }
 }
 
 TEST_F(HpackHeaderTableTest, BasicDynamicEntryInsertionAndEviction) {
   size_t static_count = peer_.total_insertions();
-  HpackEntry* first_static_entry = table_.GetByIndex(1);
+  const HpackEntry* first_static_entry = table_.GetByIndex(1);
 
   EXPECT_EQ(1u, table_.IndexOf(first_static_entry));
 
-  HpackEntry* entry = table_.TryAddEntry("header-key", "Header Value");
+  const HpackEntry* entry = table_.TryAddEntry("header-key", "Header Value");
   EXPECT_EQ("header-key", entry->name());
   EXPECT_EQ("Header Value", entry->value());
   EXPECT_FALSE(entry->IsStatic());
 
   // Table counts were updated appropriately.
   EXPECT_EQ(entry->Size(), table_.size());
   EXPECT_EQ(1u, peer_.dynamic_entries_count());
   EXPECT_EQ(peer_.dynamic_entries().size(), peer_.dynamic_entries_count());
   EXPECT_EQ(static_count + 1, peer_.total_insertions());
-  EXPECT_EQ(static_count + 1, peer_.index().size());
+  EXPECT_EQ(static_count + 1, peer_.index_size());
 
   // Index() of entries reflects the insertion.
   EXPECT_EQ(1u, table_.IndexOf(first_static_entry));
   // Static table has 61 entries.
   EXPECT_EQ(62u, table_.IndexOf(entry));
   EXPECT_EQ(first_static_entry, table_.GetByIndex(1));
   EXPECT_EQ(entry, table_.GetByIndex(62));
 
   // Evict |entry|. Table counts are again updated appropriately.
   peer_.Evict(1);
   EXPECT_EQ(0u, table_.size());
   EXPECT_EQ(0u, peer_.dynamic_entries_count());
   EXPECT_EQ(peer_.dynamic_entries().size(), peer_.dynamic_entries_count());
   EXPECT_EQ(static_count + 1, peer_.total_insertions());
-  EXPECT_EQ(static_count, peer_.index().size());
+  EXPECT_EQ(static_count, peer_.index_size());
 
   // Index() of |first_static_entry| reflects the eviction.
   EXPECT_EQ(1u, table_.IndexOf(first_static_entry));
   EXPECT_EQ(first_static_entry, table_.GetByIndex(1));
 }
 
 TEST_F(HpackHeaderTableTest, EntryIndexing) {
-  HpackEntry* first_static_entry = table_.GetByIndex(1);
+  const HpackEntry* first_static_entry = table_.GetByIndex(1);
 
   // Static entries are queryable by name & value.
   EXPECT_EQ(first_static_entry, table_.GetByName(first_static_entry->name()));
   EXPECT_EQ(first_static_entry, table_.GetByNameAndValue(
         first_static_entry->name(), first_static_entry->value()));
 
   // Create a mix of entries which duplicate names, and names & values of both
   // dynamic and static entries.
-  HpackEntry* entry1 = table_.TryAddEntry(first_static_entry->name(),
-                                          first_static_entry->value());
-  HpackEntry* entry2 = table_.TryAddEntry(first_static_entry->name(),
-                                          "Value Four");
-  HpackEntry* entry3 = table_.TryAddEntry("key-1", "Value One");
-  HpackEntry* entry4 = table_.TryAddEntry("key-2", "Value Three");
-  HpackEntry* entry5 = table_.TryAddEntry("key-1", "Value Two");
-  HpackEntry* entry6 = table_.TryAddEntry("key-2", "Value Three");
-  HpackEntry* entry7 = table_.TryAddEntry("key-2", "Value Four");
+  const HpackEntry* entry1 = table_.TryAddEntry(first_static_entry->name(),
+                                                first_static_entry->value());
+  const HpackEntry* entry2 =
+      table_.TryAddEntry(first_static_entry->name(), "Value Four");
+  const HpackEntry* entry3 = table_.TryAddEntry("key-1", "Value One");
+  const HpackEntry* entry4 = table_.TryAddEntry("key-2", "Value Three");
+  const HpackEntry* entry5 = table_.TryAddEntry("key-1", "Value Two");
+  const HpackEntry* entry6 = table_.TryAddEntry("key-2", "Value Three");
+  const HpackEntry* entry7 = table_.TryAddEntry("key-2", "Value Four");
 
   // Entries are queryable under their current index.
   EXPECT_EQ(entry7, table_.GetByIndex(62));
   EXPECT_EQ(entry6, table_.GetByIndex(63));
   EXPECT_EQ(entry5, table_.GetByIndex(64));
   EXPECT_EQ(entry4, table_.GetByIndex(65));
   EXPECT_EQ(entry3, table_.GetByIndex(66));
   EXPECT_EQ(entry2, table_.GetByIndex(67));
   EXPECT_EQ(entry1, table_.GetByIndex(68));
   EXPECT_EQ(first_static_entry, table_.GetByIndex(1));
 
   // Querying by name returns the lowest-value matching entry.
   EXPECT_EQ(entry3, table_.GetByName("key-1"));
   EXPECT_EQ(entry7, table_.GetByName("key-2"));
   EXPECT_EQ(entry2->name(),
             table_.GetByName(first_static_entry->name())->name());
   EXPECT_EQ(NULL, table_.GetByName("not-present"));
 
-  // Querying by name & value returns the lowest-index matching entry.
+  // Querying by name & value returns the lowest-index matching entry among
+  // static entries, and the highest-index one among dynamic entries.
   EXPECT_EQ(entry3, table_.GetByNameAndValue("key-1", "Value One"));
   EXPECT_EQ(entry5, table_.GetByNameAndValue("key-1", "Value Two"));
-  EXPECT_EQ(entry6, table_.GetByNameAndValue("key-2", "Value Three"));
+  EXPECT_EQ(entry4, table_.GetByNameAndValue("key-2", "Value Three"));
   EXPECT_EQ(entry7, table_.GetByNameAndValue("key-2", "Value Four"));
   EXPECT_EQ(first_static_entry,
             table_.GetByNameAndValue(first_static_entry->name(),
                                      first_static_entry->value()));
   EXPECT_EQ(entry2, table_.GetByNameAndValue(first_static_entry->name(),
                                              "Value Four"));
   EXPECT_EQ(NULL, table_.GetByNameAndValue("key-1", "Not Present"));
   EXPECT_EQ(NULL, table_.GetByNameAndValue("not-present", "Value One"));
 
   // Evict |entry1|. Queries for its name & value now return the static entry.
   // |entry2| remains queryable.
   peer_.Evict(1);
   EXPECT_EQ(first_static_entry,
       table_.GetByNameAndValue(first_static_entry->name(),
                                first_static_entry->value()));
   EXPECT_EQ(entry2, table_.GetByNameAndValue(first_static_entry->name(),
                                              "Value Four"));
 
   // Evict |entry2|. Queries by its name & value are not found.
   peer_.Evict(1);
   EXPECT_EQ(NULL, table_.GetByNameAndValue(first_static_entry->name(),
                                            "Value Four"));
 }
 
 TEST_F(HpackHeaderTableTest, SetSizes) {
   string key = "key", value = "value";
-  HpackEntry* entry1 = table_.TryAddEntry(key, value);
-  HpackEntry* entry2 = table_.TryAddEntry(key, value);
-  HpackEntry* entry3 = table_.TryAddEntry(key, value);
+  const HpackEntry* entry1 = table_.TryAddEntry(key, value);
+  const HpackEntry* entry2 = table_.TryAddEntry(key, value);
+  const HpackEntry* entry3 = table_.TryAddEntry(key, value);
 
   // Set exactly large enough. No Evictions.
   size_t max_size = entry1->Size() + entry2->Size() + entry3->Size();
   table_.SetMaxSize(max_size);
   EXPECT_EQ(3u, peer_.dynamic_entries().size());
 
   // Set just too small. One eviction.
   max_size = entry1->Size() + entry2->Size() + entry3->Size() - 1;
   table_.SetMaxSize(max_size);
   EXPECT_EQ(2u, peer_.dynamic_entries().size());
@@ skipping 11 matching lines @@
   // and will force evictions.
   max_size = entry3->Size() - 1;
   table_.SetSettingsHeaderTableSize(max_size);
   EXPECT_EQ(max_size, table_.max_size());
   EXPECT_EQ(max_size, table_.settings_size_bound());
   EXPECT_EQ(0u, peer_.dynamic_entries().size());
 }
 
 TEST_F(HpackHeaderTableTest, EvictionCountForEntry) {
   string key = "key", value = "value";
-  HpackEntry* entry1 = table_.TryAddEntry(key, value);
-  HpackEntry* entry2 = table_.TryAddEntry(key, value);
+  const HpackEntry* entry1 = table_.TryAddEntry(key, value);
+  const HpackEntry* entry2 = table_.TryAddEntry(key, value);
   size_t entry3_size = HpackEntry::Size(key, value);
 
   // Just enough capacity for third entry.
   table_.SetMaxSize(entry1->Size() + entry2->Size() + entry3_size);
   EXPECT_EQ(0u, peer_.EvictionCountForEntry(key, value));
   EXPECT_EQ(1u, peer_.EvictionCountForEntry(key, value + "x"));
 
   // No extra capacity. Third entry would force evictions.
   table_.SetMaxSize(entry1->Size() + entry2->Size());
   EXPECT_EQ(1u, peer_.EvictionCountForEntry(key, value));
   EXPECT_EQ(2u, peer_.EvictionCountForEntry(key, value + "x"));
 }
 
 TEST_F(HpackHeaderTableTest, EvictionCountToReclaim) {
   string key = "key", value = "value";
-  HpackEntry* entry1 = table_.TryAddEntry(key, value);
-  HpackEntry* entry2 = table_.TryAddEntry(key, value);
+  const HpackEntry* entry1 = table_.TryAddEntry(key, value);
+  const HpackEntry* entry2 = table_.TryAddEntry(key, value);
 
   EXPECT_EQ(1u, peer_.EvictionCountToReclaim(1));
   EXPECT_EQ(1u, peer_.EvictionCountToReclaim(entry1->Size()));
   EXPECT_EQ(2u, peer_.EvictionCountToReclaim(entry1->Size() + 1));
   EXPECT_EQ(2u, peer_.EvictionCountToReclaim(entry1->Size() + entry2->Size()));
 }
 
 // Fill a header table with entries. Make sure the entries are in
 // reverse order in the header table.
 TEST_F(HpackHeaderTableTest, TryAddEntryBasic) {
@@ skipping 35 matching lines @@
 }
 
 // Fill a header table with entries, and then add an entry just big
 // enough to cause eviction of all but one entry. Make sure the
 // eviction happens as expected and the long entry is inserted into
 // the table.
 TEST_F(HpackHeaderTableTest, TryAddEntryEviction) {
   HpackEntryVector entries = MakeEntriesOfTotalSize(table_.max_size());
   AddEntriesExpectNoEviction(entries);
 
-  HpackEntry* survivor_entry = table_.GetByIndex(61 + 1);
+  const HpackEntry* survivor_entry = table_.GetByIndex(61 + 1);
   HpackEntry long_entry =
       MakeEntryOfSize(table_.max_size() - survivor_entry->Size());
 
   // All dynamic entries but the first are to be evicted.
   EXPECT_EQ(peer_.dynamic_entries().size() - 1, peer_.EvictionSet(
       long_entry.name(), long_entry.value()).size());
 
-  HpackEntry* new_entry = table_.TryAddEntry(long_entry.name(),
-                                             long_entry.value());
+  const HpackEntry* new_entry =
+      table_.TryAddEntry(long_entry.name(), long_entry.value());
   EXPECT_EQ(62u, table_.IndexOf(new_entry));
   EXPECT_EQ(2u, peer_.dynamic_entries().size());
   EXPECT_EQ(table_.GetByIndex(63), survivor_entry);
   EXPECT_EQ(table_.GetByIndex(62), new_entry);
 }
 
 // Fill a header table with entries, and then add an entry bigger than
 // the entire table. Make sure no entry remains in the table.
 TEST_F(HpackHeaderTableTest, TryAddTooLargeEntry) {
   HpackEntryVector entries = MakeEntriesOfTotalSize(table_.max_size());
   AddEntriesExpectNoEviction(entries);
 
-  HpackEntry long_entry = MakeEntryOfSize(table_.max_size() + 1);
+  const HpackEntry long_entry = MakeEntryOfSize(table_.max_size() + 1);
 
   // All entries are to be evicted.
   EXPECT_EQ(peer_.dynamic_entries().size(), peer_.EvictionSet(
       long_entry.name(), long_entry.value()).size());
 
-  HpackEntry* new_entry = table_.TryAddEntry(long_entry.name(),
-                                             long_entry.value());
+  const HpackEntry* new_entry =
+      table_.TryAddEntry(long_entry.name(), long_entry.value());
   EXPECT_EQ(new_entry, static_cast<HpackEntry*>(NULL));
   EXPECT_EQ(0u, peer_.dynamic_entries().size());
 }
 
 TEST_F(HpackHeaderTableTest, ComparatorNameOrdering) {
-  HpackEntry entry1(StaticEntry());
-  name_[0]--;
-  HpackEntry entry2(StaticEntry());
+  HpackEntry entry1("header", "value");
+  HpackEntry entry2("HEADER", "value");
 
-  HpackHeaderTable::EntryComparator comparator(&table_);
+  HpackHeaderTable::EntryComparator comparator;
   EXPECT_FALSE(comparator(&entry1, &entry2));
   EXPECT_TRUE(comparator(&entry2, &entry1));
 }
 
 TEST_F(HpackHeaderTableTest, ComparatorValueOrdering) {
-  HpackEntry entry1(StaticEntry());
-  value_[0]--;
-  HpackEntry entry2(StaticEntry());
+  HpackEntry entry1("header", "value");
+  HpackEntry entry2("header", "VALUE");
 
-  HpackHeaderTable::EntryComparator comparator(&table_);
+  HpackHeaderTable::EntryComparator comparator;
   EXPECT_FALSE(comparator(&entry1, &entry2));
   EXPECT_TRUE(comparator(&entry2, &entry1));
 }
 
 TEST_F(HpackHeaderTableTest, ComparatorIndexOrdering) {
-  HpackEntry entry1(StaticEntry());
-  HpackEntry entry2(StaticEntry());
+  HpackHeaderTable::EntryComparator comparator;
+  HpackEntry entry1(DynamicEntry("name", "value"));
+  HpackEntry entry2(DynamicEntry("name", "value"));
 
-  HpackHeaderTable::EntryComparator comparator(&table_);
-  EXPECT_TRUE(comparator(&entry1, &entry2));
-  EXPECT_FALSE(comparator(&entry2, &entry1));
-
-  HpackEntry entry3(DynamicEntry());
-  HpackEntry entry4(DynamicEntry());
-
-  // |entry4| has lower index than |entry3|.
-  EXPECT_TRUE(comparator(&entry4, &entry3));
-  EXPECT_FALSE(comparator(&entry3, &entry4));
-
-  // |entry1| has lower index than |entry3|.
-  EXPECT_TRUE(comparator(&entry1, &entry3));
-  EXPECT_FALSE(comparator(&entry3, &entry1));
-
-  // |entry1| & |entry2| ordering is preserved, though each Index() has changed.
+  // |entry1| has lower insertion index than |entry2|.
   EXPECT_TRUE(comparator(&entry1, &entry2));
   EXPECT_FALSE(comparator(&entry2, &entry1));
 }
 
 TEST_F(HpackHeaderTableTest, ComparatorEqualityOrdering) {
-  HpackEntry entry1(StaticEntry());
-  HpackEntry entry2(DynamicEntry());
+  HpackEntry entry1("name", "value");
+  HpackEntry entry2(DynamicEntry("name", "value"));
 
-  HpackHeaderTable::EntryComparator comparator(&table_);
+  HpackHeaderTable::EntryComparator comparator;
   EXPECT_FALSE(comparator(&entry1, &entry1));
   EXPECT_FALSE(comparator(&entry2, &entry2));
 }
 
 }  // namespace
 
 }  // namespace net