Extend cachebench to bind memory tiers to NUMA nodes

Author: vinser52

cachelib/cachebench/CMakeLists.txt

@@ -89,5 +89,6 @@ if (BUILD_TESTS)
   add_test (consistency/tests/ValueHistoryTest.cpp)
   add_test (consistency/tests/ValueTrackerTest.cpp)
   add_test (util/tests/NandWritesTest.cpp)
+  add_test (util/tests/MemoryTierConfigTest)
   add_test (cache/tests/TimeStampTickerTest.cpp)
 endif()

cachelib/cachebench/util/CacheConfig.cpp

@@ -138,8 +138,53 @@ std::shared_ptr<RebalanceStrategy> CacheConfig::getRebalanceStrategy() const {
 MemoryTierConfig::MemoryTierConfig(const folly::dynamic& configJson) {
   JSONSetVal(configJson, file);
   JSONSetVal(configJson, ratio);
+  JSONSetVal(configJson, memBindNodes);
 
-  checkCorrectSize<MemoryTierConfig, 40>();
+  checkCorrectSize<MemoryTierConfig, 72>();
+}
+
+static bool starts_with() {return true;}
+
+std::vector<size_t> MemoryTierConfig::parseNumaNodes() {
+  std::vector<size_t> numaNodes;
+
+  std::vector<folly::StringPiece> tokens;
+  folly::split(",", memBindNodes, tokens, true /*ignore empty*/);
+  for(const auto &token : tokens) {
+    if(token.startsWith("!")) {
+      throw std::invalid_argument(folly::sformat(
+        "invalid NUMA nodes binding in memory tier config: {} "
+        "inverse !N or !N-N is not supported "
+        "nodes may be specified as N,N,N or N-N or N,N-N or N-N,N-N and so forth.",
+        token));
+    }
+    else if(token.startsWith("+")) {
+      throw std::invalid_argument(folly::sformat(
+        "invalid NUMA nodes binding in memory tier config: {} "
+        "relative nodes are not supported. "
+        "nodes may be specified as N,N,N or N-N or N,N-N or N-N,N-N and so forth.",
+        token));
+    }
+    else if (token.contains("-")) {
+      size_t begin, end;
+      if(folly::split("-", token, begin, end) && begin < end) {
+        while(begin <=end) {
+          numaNodes.push_back(begin++);
+        }
+      } else {
+        throw std::invalid_argument(folly::sformat(
+        "invalid NUMA nodes binding in memory tier config: {} "
+        "Invalid range format. "
+        "nodes may be specified as N,N,N or N-N or N,N-N or N-N,N-N and so forth.",
+        token));
+      }
+    }
+    else {
+      numaNodes.push_back(folly::to<size_t>(token));
+    }
+  }
+
+  return numaNodes;
 }
 
 } // namespace cachebench

cachelib/cachebench/util/CacheConfig.h

@@ -48,11 +48,13 @@ struct MemoryTierConfig : public JSONConfig {
   MemoryTierCacheConfig getMemoryTierCacheConfig() {
     MemoryTierCacheConfig config = memoryTierCacheConfigFromSource();
     config.setRatio(ratio);
+    config.setMemBind(parseNumaNodes());
     return config;
   }
 
   std::string file{""};
   size_t ratio{0};
+  std::string memBindNodes{""};
 
 private:
   MemoryTierCacheConfig memoryTierCacheConfigFromSource() {
@@ -62,6 +64,8 @@ struct MemoryTierConfig : public JSONConfig {
       return MemoryTierCacheConfig::fromFile(file);
     }
   }
+
+  std::vector<size_t> parseNumaNodes();
 };
 
 struct CacheConfig : public JSONConfig {

cachelib/cachebench/util/tests/MemoryTierConfigTest.cpp

@@ -0,0 +1,86 @@
+/*
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * 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.
+ */
+
+// Copyright 2022-present Facebook. All Rights Reserved.
+
+#include <algorithm>
+
+#include <gmock/gmock.h>
+#include <gtest/gtest.h>
+
+#include "cachelib/cachebench/util/CacheConfig.h"
+
+namespace facebook {
+namespace cachelib {
+namespace cachebench {
+
+TEST(MemoryTierConfigTest, MemBind_SingleNumaNode) {
+  const std::string configString =
+    "{"
+    "  \"ratio\": 1,"
+    "  \"memBindNodes\": 1"
+    "}";
+
+  const std::vector<size_t> expectedNumaNodes = {1};
+
+  auto configJson = folly::parseJson(folly::json::stripComments(configString));
+  
+  MemoryTierConfig memoryTierConfig(configJson);
+  MemoryTierCacheConfig tierCacheConfig = memoryTierConfig.getMemoryTierCacheConfig();
+
+  auto parsedNumaNodes = tierCacheConfig.getMemBind();
+  ASSERT_TRUE(std::equal(expectedNumaNodes.begin(), expectedNumaNodes.end(), parsedNumaNodes.begin()));
+}
+
+TEST(MemoryTierConfigTest, MemBind_RangeNumaNodes) {
+  const std::string configString =
+    "{"
+    "  \"ratio\": 1,"
+    "  \"memBindNodes\": \"0-2\""
+    "}";
+
+  const std::vector<size_t> expectedNumaNodes = {0, 1, 2};
+
+  auto configJson = folly::parseJson(folly::json::stripComments(configString));
+  
+  MemoryTierConfig memoryTierConfig(configJson);
+  MemoryTierCacheConfig tierCacheConfig = memoryTierConfig.getMemoryTierCacheConfig();
+
+  auto parsedNumaNodes = tierCacheConfig.getMemBind();
+  ASSERT_TRUE(std::equal(expectedNumaNodes.begin(), expectedNumaNodes.end(), parsedNumaNodes.begin()));
+}
+
+TEST(MemoryTierConfigTest, MemBind_SingleAndRangeNumaNodes) {
+  const std::string configString =
+    "{"
+    "  \"ratio\": 1,"
+    "  \"memBindNodes\": \"0,2-5\""
+    "}";
+
+  const std::vector<size_t> expectedNumaNodes = {0, 2, 3, 4, 5};
+
+  auto configJson = folly::parseJson(folly::json::stripComments(configString));
+  
+  MemoryTierConfig memoryTierConfig(configJson);
+  MemoryTierCacheConfig tierCacheConfig = memoryTierConfig.getMemoryTierCacheConfig();
+
+  auto parsedNumaNodes = tierCacheConfig.getMemBind();
+  ASSERT_TRUE(std::equal(expectedNumaNodes.begin(), expectedNumaNodes.end(), parsedNumaNodes.begin()));
+}
+
+} // namespace facebook
+} // namespace cachelib
+} // namespace cachebench