Move KVStoreConfig from kvstore.{h,cc} to kvstore_config.{h,cc}

A number of files which currently #include kvstore.h only actually
need the declarion of KVStoreConfig.

Given that kvstore.h is relatively large, move KVStoreConfig to it's
own header / source file to reduce the amount of headers other files
need to include to use it.

Change-Id: I836ac199fd8d8ae8af83193ea69f3a8cf8fccb5f
Reviewed-on: http://review.couchbase.org/82682
Reviewed-by: Oliver Downard <[email protected]>
Tested-by: Build Bot <[email protected]>

Author: daverigby

engines/ep/CMakeLists.txt

@@ -146,7 +146,6 @@ ADD_CUSTOM_COMMAND(OUTPUT
                         genconfig
                   COMMENT "Generating code for configuration class")
 
-SET(KVSTORE_SOURCE src/kvstore.cc)
 SET(COUCH_KVSTORE_SOURCE src/couch-kvstore/couch-kvstore.cc
             src/couch-kvstore/couch-fs-stats.cc)
 SET(OBJECTREGISTRY_SOURCE src/objectregistry.cc)
@@ -205,6 +204,8 @@ ADD_LIBRARY(ep_objs OBJECT
             src/htresizer.cc
             src/item.cc
             src/item_pager.cc
+            src/kvstore.cc
+            src/kvstore_config.cc
             src/logger.cc
             src/kv_bucket.cc
             src/kvshard.cc
@@ -234,7 +235,6 @@ ADD_LIBRARY(ep_objs OBJECT
             ${OBJECTREGISTRY_SOURCE}
             ${CMAKE_CURRENT_BINARY_DIR}/src/stats-info.c
             ${CONFIG_SOURCE}
-            ${KVSTORE_SOURCE}
             ${COUCH_KVSTORE_SOURCE}
             ${FOREST_KVSTORE_SOURCE}
             ${ROCKSDB_KVSTORE_SOURCE}

engines/ep/src/couch-kvstore/couch-kvstore.cc

@@ -46,6 +46,7 @@
 #include "common.h"
 #include "couch-kvstore/couch-kvstore.h"
 #include "ep_types.h"
+#include "kvstore_config.h"
 #define STATWRITER_NAMESPACE couchstore_engine
 #include "statwriter.h"
 #undef STATWRITER_NAMESPACE

engines/ep/src/kvshard.h

@@ -19,7 +19,7 @@
 
 #include "config.h"
 
-#include "kvstore.h"
+#include "kvstore_config.h"
 #include "utility.h"
 #include "vbucket.h"
 

engines/ep/src/kvstore.cc

@@ -29,51 +29,14 @@
 #ifdef EP_USE_ROCKSDB
 #include "rocksdb-kvstore/rocksdb-kvstore.h"
 #endif
+#include "kvstore_config.h"
 #include "statwriter.h"
 #include "kvstore.h"
 #include "vbucket.h"
 #include <platform/dirutils.h>
 #include <sys/types.h>
 #include <sys/stat.h>
 
-KVStoreConfig::KVStoreConfig(Configuration& config, uint16_t shardid)
-    : KVStoreConfig(config.getMaxVbuckets(),
-                    config.getMaxNumShards(),
-                    config.getDbname(),
-                    config.getBackend(),
-                    shardid,
-                    config.isCollectionsPrototypeEnabled()) {
-    setPeriodicSyncBytes(config.getFsyncAfterEveryNBytesWritten());
-    config.addValueChangedListener("fsync_after_every_n_bytes_written",
-                                   new ConfigChangeListener(*this));
-}
-
-KVStoreConfig::KVStoreConfig(uint16_t _maxVBuckets,
-                             uint16_t _maxShards,
-                             const std::string& _dbname,
-                             const std::string& _backend,
-                             uint16_t _shardId,
-                             bool _persistDocNamespace)
-    : maxVBuckets(_maxVBuckets),
-      maxShards(_maxShards),
-      dbname(_dbname),
-      backend(_backend),
-      shardId(_shardId),
-      logger(&global_logger),
-      buffered(true),
-      persistDocNamespace(_persistDocNamespace) {
-}
-
-KVStoreConfig& KVStoreConfig::setLogger(Logger& _logger) {
-    logger = &_logger;
-    return *this;
-}
-
-KVStoreConfig& KVStoreConfig::setBuffered(bool _buffered) {
-    buffered = _buffered;
-    return *this;
-}
-
 KVStoreRWRO KVStoreFactory::create(KVStoreConfig& config) {
     std::string backend = config.getBackend();
     if (backend == "couchdb") {

engines/ep/src/kvstore.h

@@ -531,121 +531,6 @@ class StorageProperties {
 class RollbackCB;
 class Configuration;
 
-class KVStoreConfig {
-public:
-    /**
-     * This constructor intialises the object from a central
-     * ep-engine Configuration instance.
-     */
-    KVStoreConfig(Configuration& config, uint16_t shardId);
-
-    /**
-     * This constructor sets the mandatory config options
-     *
-     * Optional config options are set using a separate method
-     */
-    KVStoreConfig(uint16_t _maxVBuckets,
-                  uint16_t _maxShards,
-                  const std::string& _dbname,
-                  const std::string& _backend,
-                  uint16_t _shardId,
-                  bool persistDocNamespace);
-
-    uint16_t getMaxVBuckets() const {
-        return maxVBuckets;
-    }
-
-    uint16_t getMaxShards() const {
-        return maxShards;
-    }
-
-    std::string getDBName() const {
-        return dbname;
-    }
-
-    const std::string& getBackend() const {
-        return backend;
-    }
-
-    uint16_t getShardId() const {
-        return shardId;
-    }
-
-    Logger& getLogger() {
-        return *logger;
-    }
-
-    /**
-     * Indicates whether or not underlying file operations will be
-     * buffered by the storage engine used.
-     *
-     * Only recognised by CouchKVStore
-     */
-    bool getBuffered() const {
-        return buffered;
-    }
-
-    /**
-     * Used to override the default logger object
-     */
-    KVStoreConfig& setLogger(Logger& _logger);
-
-    /**
-     * Used to override the default buffering behaviour.
-     *
-     * Only recognised by CouchKVStore
-     */
-    KVStoreConfig& setBuffered(bool _buffered);
-
-    bool shouldPersistDocNamespace() const {
-        return persistDocNamespace;
-    }
-
-    void setPersistDocNamespace(bool value) {
-        persistDocNamespace = value;
-    }
-
-    uint64_t getPeriodicSyncBytes() const {
-        return periodicSyncBytes;
-    }
-
-    void setPeriodicSyncBytes(uint64_t bytes) {
-        periodicSyncBytes = bytes;
-    }
-
-private:
-    /// A listener class to update KVStore related configs at runtime.
-    class ConfigChangeListener : public ValueChangedListener {
-    public:
-        ConfigChangeListener(KVStoreConfig& c) : config(c) {
-        }
-
-        void sizeValueChanged(const std::string& key, size_t value) override {
-            if (key == "fsync_after_every_n_bytes_written") {
-                config.setPeriodicSyncBytes(value);
-            }
-        }
-
-    private:
-        KVStoreConfig& config;
-    };
-
-    uint16_t maxVBuckets;
-    uint16_t maxShards;
-    std::string dbname;
-    std::string backend;
-    uint16_t shardId;
-    Logger* logger;
-    bool buffered;
-    bool persistDocNamespace;
-
-    /**
-     * If non-zero, tell storage layer to issue a sync() operation after every
-     * N bytes written.
-     */
-    uint64_t periodicSyncBytes;
-};
-
 class IORequest {
 public:
     IORequest(uint16_t vbId, MutationRequestCallback &cb, bool del,

engines/ep/src/kvstore_config.cc

@@ -0,0 +1,72 @@
+/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *     Copyright 2017 Couchbase, 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 "kvstore_config.h"
+
+/// A listener class to update KVStore related configs at runtime.
+class KVStoreConfig::ConfigChangeListener : public ValueChangedListener {
+public:
+    ConfigChangeListener(KVStoreConfig& c) : config(c) {
+    }
+
+    void sizeValueChanged(const std::string& key, size_t value) override {
+        if (key == "fsync_after_every_n_bytes_written") {
+            config.setPeriodicSyncBytes(value);
+        }
+    }
+
+private:
+    KVStoreConfig& config;
+};
+
+KVStoreConfig::KVStoreConfig(Configuration& config, uint16_t shardid)
+    : KVStoreConfig(config.getMaxVbuckets(),
+                    config.getMaxNumShards(),
+                    config.getDbname(),
+                    config.getBackend(),
+                    shardid,
+                    config.isCollectionsPrototypeEnabled()) {
+    setPeriodicSyncBytes(config.getFsyncAfterEveryNBytesWritten());
+    config.addValueChangedListener("fsync_after_every_n_bytes_written",
+                                   new ConfigChangeListener(*this));
+}
+
+KVStoreConfig::KVStoreConfig(uint16_t _maxVBuckets,
+                             uint16_t _maxShards,
+                             const std::string& _dbname,
+                             const std::string& _backend,
+                             uint16_t _shardId,
+                             bool _persistDocNamespace)
+    : maxVBuckets(_maxVBuckets),
+      maxShards(_maxShards),
+      dbname(_dbname),
+      backend(_backend),
+      shardId(_shardId),
+      logger(&global_logger),
+      buffered(true),
+      persistDocNamespace(_persistDocNamespace) {
+}
+
+KVStoreConfig& KVStoreConfig::setLogger(Logger& _logger) {
+    logger = &_logger;
+    return *this;
+}
+
+KVStoreConfig& KVStoreConfig::setBuffered(bool _buffered) {
+    buffered = _buffered;
+    return *this;
+}