mgmt: Add tables.network_region section in config file to populate NetworkRegionTable

refs: #3159

Change-Id: If049eea2baf64a22abc9437d3ec117dd0d27bbab
diff --git a/daemon/mgmt/tables-config-section.cpp b/daemon/mgmt/tables-config-section.cpp
index f0b9eaf..773e906 100644
--- a/daemon/mgmt/tables-config-section.cpp
+++ b/daemon/mgmt/tables-config-section.cpp
@@ -1,12 +1,12 @@
 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
 /**
- * Copyright (c) 2014,  Regents of the University of California,
- *                      Arizona Board of Regents,
- *                      Colorado State University,
- *                      University Pierre & Marie Curie, Sorbonne University,
- *                      Washington University in St. Louis,
- *                      Beijing Institute of Technology,
- *                      The University of Memphis
+ * Copyright (c) 2014-2015,  Regents of the University of California,
+ *                           Arizona Board of Regents,
+ *                           Colorado State University,
+ *                           University Pierre & Marie Curie, Sorbonne University,
+ *                           Washington University in St. Louis,
+ *                           Beijing Institute of Technology,
+ *                           The University of Memphis.
  *
  * This file is part of NFD (Named Data Networking Forwarding Daemon).
  * See AUTHORS.md for complete list of NFD authors and contributors.
@@ -39,12 +39,14 @@
                                          Pit& pit,
                                          Fib& fib,
                                          StrategyChoice& strategyChoice,
-                                         Measurements& measurements)
+                                         Measurements& measurements,
+                                         NetworkRegionTable& networkRegionTable)
   : m_cs(cs)
   // , m_pit(pit)
   // , m_fib(fib)
   , m_strategyChoice(strategyChoice)
   // , m_measurements(measurements)
+  , m_networkRegionTable(networkRegionTable)
   , m_areTablesConfigured(false)
 {
 
@@ -54,17 +56,16 @@
 TablesConfigSection::setConfigFile(ConfigFile& configFile)
 {
   configFile.addSectionHandler("tables",
-                               bind(&TablesConfigSection::onConfig, this, _1, _2, _3));
+                               bind(&TablesConfigSection::processConfig, this, _1, _2, _3));
 }
 
 
 void
 TablesConfigSection::ensureTablesAreConfigured()
 {
-  if (m_areTablesConfigured)
-    {
-      return;
-    }
+  if (m_areTablesConfigured) {
+    return;
+  }
 
   NFD_LOG_INFO("Setting CS max packets to " << DEFAULT_CS_MAX_PACKETS);
   m_cs.setLimit(DEFAULT_CS_MAX_PACKETS);
@@ -73,9 +74,9 @@
 }
 
 void
-TablesConfigSection::onConfig(const ConfigSection& configSection,
-                              bool isDryRun,
-                              const std::string& filename)
+TablesConfigSection::processConfig(const ConfigSection& configSection,
+                                   bool isDryRun,
+                                   const std::string& filename)
 {
   // tables
   // {
@@ -83,10 +84,16 @@
   //
   //    strategy_choice
   //    {
-  //       /               /localhost/nfd/strategy/best-route
-  //       /localhost      /localhost/nfd/strategy/multicast
-  //       /localhost/nfd  /localhost/nfd/strategy/best-route
-  //       /ndn/broadcast  /localhost/nfd/strategy/multicast
+  //        /               /localhost/nfd/strategy/best-route
+  //        /localhost      /localhost/nfd/strategy/multicast
+  //        /localhost/nfd  /localhost/nfd/strategy/best-route
+  //        /ndn/broadcast  /localhost/nfd/strategy/multicast
+  //    }
+  //
+  //    network_region
+  //    {
+  //       /example/region1
+  //       /example/region2
   //    }
   // }
 
@@ -95,39 +102,42 @@
   boost::optional<const ConfigSection&> csMaxPacketsNode =
     configSection.get_child_optional("cs_max_packets");
 
-  if (csMaxPacketsNode)
-    {
-      boost::optional<size_t> valCsMaxPackets =
-        configSection.get_optional<size_t>("cs_max_packets");
+  if (csMaxPacketsNode) {
+    boost::optional<size_t> valCsMaxPackets =
+      configSection.get_optional<size_t>("cs_max_packets");
 
-      if (!valCsMaxPackets)
-        {
-          BOOST_THROW_EXCEPTION(ConfigFile::Error("Invalid value for option \"cs_max_packets\""
-                                                  " in \"tables\" section"));
-        }
-
-      nCsMaxPackets = *valCsMaxPackets;
+    if (!valCsMaxPackets) {
+      BOOST_THROW_EXCEPTION(ConfigFile::Error("Invalid value for option \"cs_max_packets\""
+                                              " in \"tables\" section"));
     }
 
+    nCsMaxPackets = *valCsMaxPackets;
+  }
+
   boost::optional<const ConfigSection&> strategyChoiceSection =
     configSection.get_child_optional("strategy_choice");
 
-  if (strategyChoiceSection)
-    {
-      processSectionStrategyChoice(*strategyChoiceSection, isDryRun);
-    }
+  if (strategyChoiceSection) {
+    processStrategyChoiceSection(*strategyChoiceSection, isDryRun);
+  }
 
-  if (!isDryRun)
-    {
-      NFD_LOG_INFO("Setting CS max packets to " << nCsMaxPackets);
+  boost::optional<const ConfigSection&> networkRegionSection =
+    configSection.get_child_optional("network_region");
 
-      m_cs.setLimit(nCsMaxPackets);
-      m_areTablesConfigured = true;
-    }
+  if (networkRegionSection) {
+    processNetworkRegionSection(*networkRegionSection, isDryRun);
+  }
+
+  if (!isDryRun) {
+    NFD_LOG_INFO("Setting CS max packets to " << nCsMaxPackets);
+
+    m_cs.setLimit(nCsMaxPackets);
+    m_areTablesConfigured = true;
+  }
 }
 
 void
-TablesConfigSection::processSectionStrategyChoice(const ConfigSection& configSection,
+TablesConfigSection::processStrategyChoiceSection(const ConfigSection& configSection,
                                                   bool isDryRun)
 {
   // strategy_choice
@@ -140,49 +150,65 @@
 
   std::map<Name, Name> choices;
 
-  for (const auto& prefixAndStrategy : configSection)
-    {
-      const Name prefix(prefixAndStrategy.first);
-      if (choices.find(prefix) != choices.end())
-        {
-          BOOST_THROW_EXCEPTION(ConfigFile::Error("Duplicate strategy choice for prefix \"" +
-                                                  prefix.toUri() + "\" in \"strategy_choice\" "
-                                                  "section"));
-        }
-
-      const std::string strategyString(prefixAndStrategy.second.get_value<std::string>());
-      if (strategyString.empty())
-        {
-          BOOST_THROW_EXCEPTION(ConfigFile::Error("Invalid strategy choice \"\" for prefix \"" +
-                                                  prefix.toUri() + "\" in \"strategy_choice\" "
-                                                  "section"));
-        }
-
-      const Name strategyName(strategyString);
-      if (!m_strategyChoice.hasStrategy(strategyName))
-        {
-          BOOST_THROW_EXCEPTION(ConfigFile::Error("Invalid strategy choice \"" +
-                                                  strategyName.toUri() + "\" for prefix \"" +
-                                                  prefix.toUri() + "\" in \"strategy_choice\" "
-                                                  "section"));
-        }
-
-      choices[prefix] = strategyName;
+  for (const auto& prefixAndStrategy : configSection) {
+    const Name prefix(prefixAndStrategy.first);
+    if (choices.find(prefix) != choices.end()) {
+      BOOST_THROW_EXCEPTION(ConfigFile::Error("Duplicate strategy choice for prefix \"" +
+                                              prefix.toUri() + "\" in \"strategy_choice\" "
+                                              "section"));
     }
 
-
-  for (const auto& prefixAndStrategy : choices)
-    {
-      if (!isDryRun && !m_strategyChoice.insert(prefixAndStrategy.first, prefixAndStrategy.second))
-        {
-          BOOST_THROW_EXCEPTION(ConfigFile::Error("Failed to set strategy \"" +
-                                                  prefixAndStrategy.second.toUri() + "\" for "
-                                                  "prefix \"" + prefixAndStrategy.first.toUri() +
-                                                  "\" in \"strategy_choicev\""));
-        }
+    const std::string strategyString(prefixAndStrategy.second.get_value<std::string>());
+    if (strategyString.empty()) {
+      BOOST_THROW_EXCEPTION(ConfigFile::Error("Invalid strategy choice \"\" for prefix \"" +
+                                              prefix.toUri() + "\" in \"strategy_choice\" "
+                                              "section"));
     }
+
+    const Name strategyName(strategyString);
+    if (!m_strategyChoice.hasStrategy(strategyName)) {
+      BOOST_THROW_EXCEPTION(ConfigFile::Error("Invalid strategy choice \"" +
+                                              strategyName.toUri() + "\" for prefix \"" +
+                                              prefix.toUri() + "\" in \"strategy_choice\" "
+                                              "section"));
+    }
+
+    choices[prefix] = strategyName;
+  }
+
+
+  for (const auto& prefixAndStrategy : choices) {
+    if (!isDryRun && !m_strategyChoice.insert(prefixAndStrategy.first, prefixAndStrategy.second)) {
+      BOOST_THROW_EXCEPTION(ConfigFile::Error("Failed to set strategy \"" +
+                                              prefixAndStrategy.second.toUri() + "\" for "
+                                              "prefix \"" + prefixAndStrategy.first.toUri() +
+                                              "\" in \"strategy_choicev\""));
+    }
+  }
 }
 
+void
+TablesConfigSection::processNetworkRegionSection(const ConfigSection& configSection,
+                                                 bool isDryRun)
+{
+  // network_region
+  // {
+  //    /example/region1
+  //    /example/region2
+  // }
+
+  if (!isDryRun) {
+    m_networkRegionTable.clear();
+  }
+
+  for (const auto& pair : configSection) {
+    const Name region(pair.first);
+
+    if (!isDryRun)  {
+      m_networkRegionTable.insert(region);
+    }
+  }
+}
 
 
 } // namespace nfd
diff --git a/daemon/mgmt/tables-config-section.hpp b/daemon/mgmt/tables-config-section.hpp
index 3f132f7..82cb877 100644
--- a/daemon/mgmt/tables-config-section.hpp
+++ b/daemon/mgmt/tables-config-section.hpp
@@ -1,12 +1,12 @@
 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
 /**
- * Copyright (c) 2014,  Regents of the University of California,
- *                      Arizona Board of Regents,
- *                      Colorado State University,
- *                      University Pierre & Marie Curie, Sorbonne University,
- *                      Washington University in St. Louis,
- *                      Beijing Institute of Technology,
- *                      The University of Memphis
+ * Copyright (c) 2014-2015,  Regents of the University of California,
+ *                           Arizona Board of Regents,
+ *                           Colorado State University,
+ *                           University Pierre & Marie Curie, Sorbonne University,
+ *                           Washington University in St. Louis,
+ *                           Beijing Institute of Technology,
+ *                           The University of Memphis.
  *
  * This file is part of NFD (Named Data Networking Forwarding Daemon).
  * See AUTHORS.md for complete list of NFD authors and contributors.
@@ -30,12 +30,19 @@
 #include "table/pit.hpp"
 #include "table/cs.hpp"
 #include "table/measurements.hpp"
+#include "table/network-region-table.hpp"
 #include "table/strategy-choice.hpp"
 
 #include "core/config-file.hpp"
 
 namespace nfd {
 
+/**
+ * \brief Provides parsing for `tables` configuration file section.
+ *
+ * This class enables configuration of CS, PIT, FIB, Strategy Choice, Measurements, and
+ * Network Region tables.
+ */
 class TablesConfigSection
 {
 public:
@@ -43,7 +50,8 @@
                       Pit& pit,
                       Fib& fib,
                       StrategyChoice& strategyChoice,
-                      Measurements& measurements);
+                      Measurements& measurements,
+                      NetworkRegionTable& networkRegionTable);
 
   void
   setConfigFile(ConfigFile& configFile);
@@ -54,20 +62,25 @@
 private:
 
   void
-  onConfig(const ConfigSection& configSection,
-           bool isDryRun,
-           const std::string& filename);
+  processConfig(const ConfigSection& configSection,
+                bool isDryRun,
+                const std::string& filename);
 
   void
-  processSectionStrategyChoice(const ConfigSection& configSection,
+  processStrategyChoiceSection(const ConfigSection& configSection,
                                bool isDryRun);
 
+  void
+  processNetworkRegionSection(const ConfigSection& configSection,
+                              bool isDryRun);
+
 private:
   Cs& m_cs;
   // Pit& m_pit;
   // Fib& m_fib;
   StrategyChoice& m_strategyChoice;
   // Measurements& m_measurements;
+  NetworkRegionTable& m_networkRegionTable;
 
   bool m_areTablesConfigured;
 
diff --git a/daemon/nfd.cpp b/daemon/nfd.cpp
index d880ebb..262bbf5 100644
--- a/daemon/nfd.cpp
+++ b/daemon/nfd.cpp
@@ -147,7 +147,8 @@
                                    m_forwarder->getPit(),
                                    m_forwarder->getFib(),
                                    m_forwarder->getStrategyChoice(),
-                                   m_forwarder->getMeasurements());
+                                   m_forwarder->getMeasurements(),
+                                   m_forwarder->getNetworkRegionTable());
   tablesConfig.setConfigFile(config);
 
   m_internalFace->getValidator().setConfigFile(config);
@@ -189,7 +190,8 @@
                                    m_forwarder->getPit(),
                                    m_forwarder->getFib(),
                                    m_forwarder->getStrategyChoice(),
-                                   m_forwarder->getMeasurements());
+                                   m_forwarder->getMeasurements(),
+                                   m_forwarder->getNetworkRegionTable());
 
   tablesConfig.setConfigFile(config);
 
diff --git a/daemon/table/network-region-table.hpp b/daemon/table/network-region-table.hpp
index 499c356..2a423a7 100644
--- a/daemon/table/network-region-table.hpp
+++ b/daemon/table/network-region-table.hpp
@@ -33,6 +33,9 @@
 /** \brief stores a collection of producer region names
  *
  *  This table is used in forwarding to process Interests with Link objects.
+ *
+ *  NetworkRegionTable exposes a set-like API, including methods `insert`, `clear`,
+ *  `find`, `size`, `begin`, and `end`.
  */
 class NetworkRegionTable : public std::set<Name>
 {