Get total memory currently allocated by an Arena allocator

Summary: The Arena allocator knows how much memory it's using up, so create a function that allows clients to figure out how much it's using. Also create a unit test to sanity check this stuff.

Test Plan: folly/test/ArenaTest.cpp

Reviewed By: tudorb@fb.com

FB internal diff: D579399

diff --git a/folly/Arena-inl.h b/folly/Arena-inl.h
index ad839ae4c1198b190e6894000b4bfd726d5cdb69..dcd59e855c059160fc8d1c423a22d1ef20fe278a 100644 (file)
--- a/folly/Arena-inl.h
+++ b/folly/Arena-inl.h
@@ -63,6 +63,7 @@ void* Arena<Alloc>::allocateSlow(size_t size) {
   }
 
   assert(p.second >= size);
+  totalAllocatedSize_ += p.second + sizeof(Block);
   return start;
 }
 
@@ -71,6 +72,8 @@ void Arena<Alloc>::merge(Arena<Alloc>&& other) {
   blocks_.splice_after(blocks_.before_begin(), other.blocks_);
   other.blocks_.clear();
   other.ptr_ = other.end_ = nullptr;
+  totalAllocatedSize_ += other.totalAllocatedSize_;
+  other.totalAllocatedSize_ = 0;
 }
 
 template <class Alloc>

diff --git a/folly/Arena.h b/folly/Arena.h
index eef6fab73b04d02c25fc00e10dc114be335da2f7..26917f0c16d1ca3202b427302bad7a083883ddef 100644 (file)
--- a/folly/Arena.h
+++ b/folly/Arena.h
@@ -63,7 +63,8 @@ class Arena {
                  size_t minBlockSize = kDefaultMinBlockSize)
     : allocAndSize_(alloc, minBlockSize),
       ptr_(nullptr),
-      end_(nullptr) {
+      end_(nullptr),
+      totalAllocatedSize_(0) {
   }
 
   ~Arena();
@@ -92,6 +93,11 @@ class Arena {
   // Transfer ownership of all memory allocated from "other" to "this".
   void merge(Arena&& other);
 
+  // Gets the total memory used by the arena
+  size_t totalSize() const {
+    return totalAllocatedSize_ + sizeof(Arena);
+  }
+
  private:
   // not copyable
   Arena(const Arena&) = delete;
@@ -174,6 +180,7 @@ class Arena {
   BlockList blocks_;
   char* ptr_;
   char* end_;
+  size_t totalAllocatedSize_;
 };
 
 /**

diff --git a/folly/test/ArenaTest.cpp b/folly/test/ArenaTest.cpp
new file mode 100644 (file)
index 0000000..cfbd7dc
--- /dev/null
+++ b/folly/test/ArenaTest.cpp
@@ -0,0 +1,110 @@
+/*
+ * Copyright 2012 Facebook, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "folly/Arena.h"
+#include "folly/StlAllocator.h"
+
+#include <set>
+#include <vector>
+
+#include <glog/logging.h>
+#include <gtest/gtest.h>
+
+using namespace folly;
+
+TEST(Arena, SizeSanity) {
+  std::set<size_t*> allocatedItems;
+
+  static const size_t requestedBlockSize = 64;
+  SysArena arena(requestedBlockSize);
+  size_t minimum_size = sizeof(SysArena), maximum_size = minimum_size;
+  EXPECT_EQ(arena.totalSize(), minimum_size);
+
+  // Insert a single small element to get a new block
+  size_t* ptr = static_cast<size_t*>(arena.allocate(sizeof(long)));
+  allocatedItems.insert(ptr);
+  minimum_size += requestedBlockSize;
+  maximum_size += goodMallocSize(requestedBlockSize + 1);
+  EXPECT_TRUE(arena.totalSize() >= minimum_size);
+  EXPECT_TRUE(arena.totalSize() <= maximum_size);
+  VLOG(4) << minimum_size << " < " << arena.totalSize() << " < "
+          << maximum_size;
+
+  // Insert a larger element, size should be the same
+  ptr = static_cast<size_t*>(arena.allocate(requestedBlockSize / 2));
+  allocatedItems.insert(ptr);
+  EXPECT_TRUE(arena.totalSize() >= minimum_size);
+  EXPECT_TRUE(arena.totalSize() <= maximum_size);
+  VLOG(4) << minimum_size << " < " << arena.totalSize() << " < "
+          << maximum_size;
+
+  // Insert 10 full block sizes to get 10 new blocks
+  for (int i = 0; i < 10; i++) {
+    ptr = static_cast<size_t*>(arena.allocate(requestedBlockSize));
+    allocatedItems.insert(ptr);
+  }
+  minimum_size += 10 * requestedBlockSize;
+  maximum_size += 10 * goodMallocSize(requestedBlockSize + 1);
+  EXPECT_TRUE(arena.totalSize() >= minimum_size);
+  EXPECT_TRUE(arena.totalSize() <= maximum_size);
+  VLOG(4) << minimum_size << " < " << arena.totalSize() << " < "
+          << maximum_size;
+
+  // Insert something huge
+  ptr = static_cast<size_t*>(arena.allocate(10 * requestedBlockSize));
+  allocatedItems.insert(ptr);
+  minimum_size += 10 * requestedBlockSize;
+  maximum_size += goodMallocSize(10 * requestedBlockSize + 1);
+  EXPECT_TRUE(arena.totalSize() >= minimum_size);
+  EXPECT_TRUE(arena.totalSize() <= maximum_size);
+  VLOG(4) << minimum_size << " < " << arena.totalSize() << " < "
+          << maximum_size;
+
+  // Nuke 'em all
+  for (const auto& item : allocatedItems) {
+    arena.deallocate(item);
+  }
+  //The total size should be the same
+  EXPECT_TRUE(arena.totalSize() >= minimum_size);
+  EXPECT_TRUE(arena.totalSize() <= maximum_size);
+  VLOG(4) << minimum_size << " < " << arena.totalSize() << " < "
+          << maximum_size;
+}
+
+TEST(Arena, Vector) {
+  static const size_t requestedBlockSize = 64;
+  SysArena arena(requestedBlockSize);
+
+  EXPECT_EQ(arena.totalSize(), sizeof(SysArena));
+
+  std::vector<size_t, StlAllocator<SysArena, size_t>>
+    vec { {}, StlAllocator<SysArena, size_t>(&arena) };
+
+  for (size_t i = 0; i < 1000; i++) {
+    vec.push_back(i);
+  }
+
+  for (size_t i = 0; i < 1000; i++) {
+    EXPECT_EQ(i, vec[i]);
+  }
+}
+
+int main(int argc, char *argv[]) {
+  testing::InitGoogleTest(&argc, argv);
+  google::ParseCommandLineFlags(&argc, &argv, true);
+  auto ret = RUN_ALL_TESTS();
+  return ret;
+}