DBMain and Settings Manager

CMakeLists.txt

@@ -356,6 +356,7 @@ endif()
 set(TERRIER_LINK_LIBS
     ${TERRIER_LINK_LIBS}
     ${PTHREAD_LIBRARY}
+    gflags
     pg_query)
 
 set(TERRIER_TEST_LINK_LIBS

apidoc/Doxyfile.in

@@ -831,7 +831,8 @@ RECURSIVE              = YES
 # Note that relative paths are relative to the directory from which doxygen is
 # run.
 
-EXCLUDE                = ../src/include/parser/parsenodes.h
+EXCLUDE                = ../src/include/parser/parsenodes.h \
+                         ../src/include/settings/settings_defs.h
 
 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
 # directories that are symbolic links (a Unix file system feature) are excluded

build-support/clang_format_exclusions.txt

@@ -1 +1,2 @@
 *third_party*
+*/include/settings/settings_defs.h

src/catalog/settings_handle.cpp

@@ -59,7 +59,6 @@ SqlTableHelper *SettingsCatalogTable::Create(transaction::TransactionContext *tx
 
   // now actually create, with the provided schema
   pg_settings->Create();
-  // catalog->AddToMaps(db_oid, pg_settings_oid, name, pg_settings);
   return pg_settings;
 }
 

src/include/catalog/catalog_entry.h

@@ -134,6 +134,15 @@ class CatalogEntry {
     return (type::TransientValuePeeker::PeekVarChar(entry_[index]));
   }
 
+  /**
+   * Set the value for a given column
+   * @param col_num the column index
+   * @param value the value of the column
+   */
+  void SetColumn(int32_t col_num, const type::TransientValue &value) {
+    entry_[col_num] = type::TransientValueFactory::GetCopy(value);
+  }
+
   /**
    * Get oid, e.g. tablespace_oid_t, table_oid_t.
    */

src/include/catalog/settings_handle.h

@@ -102,4 +102,25 @@ class SettingsCatalogTable {
   catalog::SqlTableHelper *pg_settings_;
 };
 
+enum class SettingsTableColumn {
+  OID = 0,
+  NAME = 1,
+  SETTING = 2,
+  UNIT = 3,
+  CATEGORY = 4,
+  SHORT_DESC = 5,
+  EXTRA_DESC = 6,
+  CONTEXT = 7,
+  VARTYPE = 8,
+  SOURCE = 9,
+  MIN_VAL = 10,
+  MAX_VAL = 11,
+  ENUMVALS = 12,
+  BOOT_VAL = 13,
+  RESET_VAL = 14,
+  SOURCEFILE = 15,
+  SOURCELINE = 16,
+  PENDING_RESTART = 17
+};
+
 }  // namespace terrier::catalog

src/include/common/action_context.h

@@ -0,0 +1,53 @@
+#pragma once
+#include <atomic>
+
+namespace terrier::common {
+
+/**
+ * All possible states of action.
+ */
+enum class ActionState {
+  INITIATED = 0,
+  IN_PROGRESS = 1,
+  SUCCESS = 2,
+  FAILURE = 3,
+  DEFERRED = 4,
+};
+
+/**
+ * ActionContext is used to keep track of action state and system behavior.
+ */
+class ActionContext {
+ public:
+  ActionContext(const ActionContext &) = delete;
+
+  /**
+   * Constructor of ActionContext.
+   * @param action_id id of this action.
+   */
+  explicit ActionContext(int32_t action_id) : action_id_(action_id), state_(ActionState ::INITIATED) {}
+
+  /**
+   * Get the state of this action.
+   * @return action state.
+   */
+  ActionState GetState() { return state_.load(); }
+
+  /**
+   * Set the state of this action.
+   * @param state action state.
+   */
+  void SetState(ActionState state) { state_.store(state); }
+
+  /**
+   * Get action id.
+   * @return action id.
+   */
+  int32_t GetActionId() { return action_id_; }
+
+ private:
+  int32_t action_id_;
+  std::atomic<ActionState> state_;
+};
+
+}  // namespace terrier::common

src/include/common/exception.h

@@ -16,11 +16,12 @@ namespace terrier {
 #define CATALOG_EXCEPTION(msg) CatalogException(msg, __FILE__, __LINE__)
 #define PARSER_EXCEPTION(msg) ParserException(msg, __FILE__, __LINE__)
 #define NETWORK_PROCESS_EXCEPTION(msg) NetworkProcessException(msg, __FILE__, __LINE__)
+#define SETTINGS_EXCEPTION(msg) SettingsException(msg, __FILE__, __LINE__)
 
 /**
  * Exception types
  */
-enum class ExceptionType { RESERVED = 0, NOT_IMPLEMENTED = 1, CATALOG = 2, NETWORK = 3, PARSER = 4 };
+enum class ExceptionType { RESERVED = 0, NOT_IMPLEMENTED = 1, CATALOG = 2, NETWORK = 3, PARSER = 4, SETTINGS = 5 };
 
 /**
  * Exception base class.
@@ -61,6 +62,8 @@ class Exception : public std::runtime_error {
         return "Parser";
       case ExceptionType::NETWORK:
         return "Network";
+      case ExceptionType::SETTINGS:
+        return "Settings";
       default:
         return "Unknown exception type";
     }
@@ -107,5 +110,6 @@ DEFINE_EXCEPTION(NotImplementedException, ExceptionType::NOT_IMPLEMENTED);
 DEFINE_EXCEPTION(CatalogException, ExceptionType::CATALOG);
 DEFINE_EXCEPTION(ParserException, ExceptionType::PARSER);
 DEFINE_EXCEPTION(NetworkProcessException, ExceptionType::NETWORK);
+DEFINE_EXCEPTION(SettingsException, ExceptionType::SETTINGS);
 
 }  // namespace terrier

src/include/common/object_pool.h

@@ -177,6 +177,12 @@ class ObjectPool {
     }
   }
 
+  /**
+   * Get the size limit of the object pool
+   * @return the size limit
+   */
+  int64_t GetSizeLimit() const { return size_limit_; }
+
  private:
   Allocator alloc_;
   SpinLatch latch_;

src/include/loggers/settings_logger.h

@@ -0,0 +1,21 @@
+#pragma once
+
+#include <memory>
+#include "spdlog/sinks/basic_file_sink.h"
+#include "spdlog/spdlog.h"
+
+namespace terrier::settings {
+extern std::shared_ptr<spdlog::logger> settings_logger;
+
+void init_settings_logger();
+}  // namespace terrier::settings
+
+#define SETTINGS_LOG_TRACE(...) ::terrier::settings::settings_logger->trace(__VA_ARGS__);
+
+#define SETTINGS_LOG_DEBUG(...) ::terrier::settings::settings_logger->debug(__VA_ARGS__);
+
+#define SETTINGS_LOG_INFO(...) ::terrier::settings::settings_logger->info(__VA_ARGS__);
+
+#define SETTINGS_LOG_WARN(...) ::terrier::settings::settings_logger->warn(__VA_ARGS__);
+
+#define SETTINGS_LOG_ERROR(...) ::terrier::settings::settings_logger->error(__VA_ARGS__);

src/include/main/db_main.h

@@ -0,0 +1,102 @@
+#pragma once
+
+#include <memory>
+#include <unordered_map>
+#include <utility>
+#include "catalog/catalog.h"
+#include "common/action_context.h"
+#include "common/stat_registry.h"
+#include "network/terrier_server.h"
+#include "settings/settings_param.h"
+#include "transaction/transaction_manager.h"
+
+namespace terrier {
+
+namespace settings {
+class SettingsManager;
+class SettingsTests;
+}  // namespace settings
+
+/**
+ * The DBMain Class holds all the singleton pointers. It has the full knowledge
+ * of the whole database systems and serves as a global context of the system.
+ * *Only the settings manager should be able to access the DBMain object.*
+ */
+class DBMain {
+ public:
+  DBMain() = default;
+
+  /**
+   * The constructor of DBMain
+   * @param param_map a map stores setting values
+   */
+  explicit DBMain(std::unordered_map<settings::Param, settings::ParamInfo> &&param_map)
+      : param_map_(std::move(param_map)) {}
+
+  /**
+   * This function boots the backend components.
+   * It initializes the following components in the following order:
+   *    SettingsManager
+   *    Garbage Collector
+   *    Catalog
+   *    Worker Pool
+   *    Logging
+   *    Stats
+   */
+  void Init();
+
+  /**
+   * Boots the traffic cop and networking layer, starts the server loop.
+   * It will block until server shuts down.
+   */
+  void Run();
+
+  /**
+   * Shuts down the server.
+   * It is worth noting that in normal cases, terrier will shut down and return from Run().
+   * So, use this function only when you want to shutdown the server from code.
+   * For example, in the end of unit tests when you want to shut down your test server.
+   */
+  void ForceShutdown();
+
+  // TODO(Weichen): Use unique ptr is enough.
+  /**
+   * Basic empty callbacks used by settings manager
+   * @param old_value the old value of corresponding setting
+   * @param new_value the new value of corresponding setting
+   * @param action_context action context for empty callback
+   */
+  void EmptyCallback(void *old_value, void *new_value, const std::shared_ptr<common::ActionContext> &action_context);
+
+  /**
+   * Buffer pool size callback used by settings manager
+   * @param old_value old value of buffer pool size
+   * @param new_value new value of buffer pool size
+   * @param action_context action context for changing buffer pool size
+   */
+  void BufferPoolSizeCallback(void *old_value, void *new_value,
+                              const std::shared_ptr<common::ActionContext> &action_context);
+
+ private:
+  friend class settings::SettingsManager;
+  friend class settings::SettingsTests;
+  std::shared_ptr<common::StatisticsRegistry> main_stat_reg_;
+  std::unordered_map<settings::Param, settings::ParamInfo> param_map_;
+  transaction::TransactionManager *txn_manager_;
+  catalog::Catalog *catalog_;
+  settings::SettingsManager *settings_manager_;
+  network::TerrierServer server_;
+
+  /**
+   * Initializes all loggers.
+   * If you have a new logger to initialize, put it here.
+   */
+  void InitLoggers();
+
+  /**
+   * Cleans up and exit.
+   */
+  void CleanUp();
+};
+
+}  // namespace terrier

src/include/settings/CPPLINT.cfg

@@ -0,0 +1 @@
+exclude_files=settings_defs.h