KeyValueContainer.hpp 13.6 KB
Newer Older
Matthieu Dorier's avatar
Matthieu Dorier committed
1 2 3 4 5
/*
 * (C) 2018 The University of Chicago
 * 
 * See COPYRIGHT in top-level directory.
 */
Matthieu Dorier's avatar
Matthieu Dorier committed
6 7 8 9 10
#ifndef __HEPNOS_KEYVAL_CONTAINER_H
#define __HEPNOS_KEYVAL_CONTAINER_H

#include <memory>
#include <string>
11
#include <sstream>
Matthieu Dorier's avatar
Matthieu Dorier committed
12 13 14
#include <boost/archive/binary_oarchive.hpp>
#include <boost/archive/binary_iarchive.hpp>
#include <boost/serialization/string.hpp>
15 16
#include <hepnos/InputArchive.hpp>
#include <hepnos/ProductID.hpp>
Matthieu Dorier's avatar
Matthieu Dorier committed
17 18 19 20 21
#include <hepnos/Demangle.hpp>
#include <hepnos/Exception.hpp>

namespace hepnos {

22 23
class WriteBatch;

Matthieu Dorier's avatar
Matthieu Dorier committed
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
class KeyValueContainer {

    public:

    /**
     * @brief Default constructor.
     */
    KeyValueContainer() = default;

    /**
     * @brief Copy constructor.
     */
    KeyValueContainer(const KeyValueContainer& other) = default;

    /**
     * @brief Move constructor.
     */
    KeyValueContainer(KeyValueContainer&& other) = default;

    /**
     * @brief Copy-assignment operator.
     */
    KeyValueContainer& operator=(const KeyValueContainer& other) = default;

    /**
     * @brief Move-assignment operator.
     */
    KeyValueContainer& operator=(KeyValueContainer&& other) = default;

    /**
     * @brief Destructor.
     */
    virtual ~KeyValueContainer() = default;

58 59 60 61 62 63 64
    /**
     * @brief Gets the DataStore to which this instance of KeyValueContainer belongs.
     *
     * @return DataStore.
     */
    virtual DataStore* getDataStore() const = 0;

Matthieu Dorier's avatar
Matthieu Dorier committed
65 66 67 68 69
    /**
     * @brief Stores raw key/value data in this KeyValueContainer.
     * This function is virtual and must be overloaded in the child class.
     *
     * @param key Key
70 71
     * @param value Value pointer
     * @param vsize Value size (in bytes)
Matthieu Dorier's avatar
Matthieu Dorier committed
72
     *
73
     * @return A valid ProductID if the key did not already exist, an invalid one otherwise.
Matthieu Dorier's avatar
Matthieu Dorier committed
74
     */
75
    virtual ProductID storeRawData(const std::string& key, const char* value, size_t vsize) = 0;
76

77 78 79 80 81 82 83 84 85 86 87 88
    /**
     * @brief Stores raw key/value data in a WriteBatch.
     * This function is virtual and must be overloaded in the child class.
     *
     * @param batch Batch in which to write.
     * @param key Key
     * @param value Value pointer
     * @param vsize Value size (in bytes)
     *
     * @return 
     */
    virtual ProductID storeRawData(WriteBatch& batch, const std::string& key, const char* value, size_t vsize) = 0;
Matthieu Dorier's avatar
Matthieu Dorier committed
89 90 91 92 93 94 95 96 97 98

    /**
     * @brief Loads raw key/value data from this KeyValueContainer.
     * This function is virtual and must be overloaded in the child class.
     *
     * @param key Key
     * @param buffer Buffer used to hold the value.
     *
     * @return true if the key exists, false otherwise.
     */
99
    virtual bool loadRawData(const std::string& key, std::string& buffer) const = 0;
Matthieu Dorier's avatar
Matthieu Dorier committed
100

101 102
    virtual bool loadRawData(const std::string& key, char* value, size_t* vsize) const = 0;

Matthieu Dorier's avatar
Matthieu Dorier committed
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
    /**
     * @brief Stores a key/value pair into the KeyValueContainer.
     * The type of the key should have operator<< available
     * to stream it into a std::stringstream for the purpose
     * of converting it into an std::string. The resulting
     * string must not have the "/", or "%" characters. The
     * type of the value must be serializable using Boost.
     *
     * @tparam K type of the key.
     * @tparam V type of the value.
     * @param key Key to store.
     * @param value Value to store.
     *
     * @return true if the key was found. false otherwise.
     */
    template<typename K, typename V>
119
    ProductID store(const K& key, const V& value) {
120
        return storeImpl(key, value, std::is_pod<V>());
121 122
    }

123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
    /**
     * @brief Stores a key/value pair into the WriteBatch.
     * The type of the key should have operator<< available
     * to stream it into a std::stringstream for the purpose
     * of converting it into an std::string. The resulting
     * string must not have the "/", or "%" characters. The
     * type of the value must be serializable using Boost.
     *
     * @tparam K type of the key.
     * @tparam V type of the value.
     * @param key Key to store.
     * @param value Value to store.
     *
     * @return true if the key was found. false otherwise.
     */
138 139
    template<typename K, typename V>
    ProductID store(WriteBatch& batch, const K& key, const V& value) {
140
        return storeImpl(batch, key, value, std::is_pod<V>());
Matthieu Dorier's avatar
Matthieu Dorier committed
141 142
    }

143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
    /**
     * @brief Version of store when the value is an std::vector.
     */
    template<typename K, typename V>
    ProductID store(const K& key, const std::vector<V>& value, int start=0, int end=-1) {
        std::string key_str, val_str;
        serializeKeyValueVector(std::is_pod<V>(), key, value, key_str, val_str, start, end);
        return storeRawData(key_str, val_str.data(), val_str.size());
    }

    /**
     * @brief Version of store when the value is an std::vector.
     */
    template<typename K, typename V>
    ProductID store(WriteBatch& batch, const K& key, const std::vector<V>& value, int start=0, int end=-1) {
        std::string key_str, val_str;
        serializeKeyValueVector(std::is_pod<V>(), key, value, key_str, val_str, start, end);
        return storeRawData(batch, key_str, val_str.data(), val_str.size());
    }

Matthieu Dorier's avatar
Matthieu Dorier committed
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
    /**
     * @brief Loads a value associated with a key from the 
     * KeyValueContainer. The type of the key should have 
     * operator<< available to stream it into a std::stringstream 
     * for the purpose of converting it into an std::string. 
     * The resulting string must not have the "/" or "%" characters.
     * The type of the value must be serializable using Boost.
     *
     * @tparam K type of the key.
     * @tparam V type of the value.
     * @param key Key to load.
     * @param value Value to load.
     *
     * @return true if the key exists and was loaded. False otherwise.
     */
    template<typename K, typename V>
    bool load(const K& key, V& value) const {
180 181 182
        return loadImpl(key, value, std::is_pod<V>());
    }

183 184 185 186 187 188 189 190
    /**
     * @brief Version of load for vectors.
     */
    template<typename K, typename V>
    bool load(const K& key, std::vector<V>& value) const {
        return loadVectorImpl(key, value, std::is_pod<V>());
    }

191 192
    private:

193 194 195 196
    /**
     * @brief Implementation of the store function when the value is
     * not an std::vector and not a POD.
     */
197 198 199 200 201 202 203 204
    template<typename K, typename V>
    ProductID storeImpl(const K& key, const V& value,
            const std::integral_constant<bool, false>&) {
        std::string key_str, val_str;
        serializeKeyValue(key, value, key_str, val_str);
        return storeRawData(key_str, val_str.data(), val_str.size());
    }

205 206 207 208
    /**
     * @brief Implementation of the store function with WriteBatch
     * and the value type is not am std::vector and not a POD.
     */
209 210 211 212 213 214 215 216
    template<typename K, typename V>
    ProductID storeImpl(WriteBatch& batch, const K& key, const V& value,
            const std::integral_constant<bool, false>&) {
        std::string key_str, val_str;
        serializeKeyValue(key, value, key_str, val_str);
        return storeRawData(batch, key_str, val_str.data(), val_str.size());
    }

217 218 219 220
    /**
     * @brief Implementation of the store function when the value
     * type is a POD.
     */
221 222 223 224 225 226 227 228
    template<typename K, typename V>
    ProductID storeImpl(const K& key, const V& value,
            const std::integral_constant<bool, true>&) {
        std::string key_str;
        serializeKeyValue(key, value, key_str);
        return storeRawData(key_str, reinterpret_cast<const char*>(&value), sizeof(value));
    }

229 230 231 232
    /**
     * @brief Implementation of the store function with WriteBatch
     * when the value type is a POD.
     */
233 234 235 236 237 238 239 240
    template<typename K, typename V>
    ProductID storeImpl(WriteBatch& batch, const K& key, const V& value,
            const std::integral_constant<bool, true>&) {
        std::string key_str;
        serializeKeyValue(key, value, key_str);
        return storeRawData(batch, key_str, reinterpret_cast<const char*>(&value), sizeof(value));
    }

241 242 243
    /**
     * @brief Implementation of the load function when the value type is a POD.
     */
244 245 246 247 248 249 250 251 252 253 254 255 256
    template<typename K, typename V>
    bool loadImpl(const K& key, V& value,
            const std::integral_constant<bool, true>&) const {
        std::string buffer;
        std::stringstream ss_key;
        ss_key << key << "#" << demangle<V>();
        size_t vsize = sizeof(value);
        if(!loadRawData(ss_key.str(), reinterpret_cast<char*>(&value), &vsize)) {
            return false;
        }
        return vsize == sizeof(value);
    }

257 258 259
    /**
     * @brief Implementation of the load function when the value type is not a POD.
     */
260 261 262
    template<typename K, typename V>
    bool loadImpl(const K& key, V& value,
            const std::integral_constant<bool, false>&) const {
263
        std::string buffer;
Matthieu Dorier's avatar
Matthieu Dorier committed
264 265 266 267 268 269
        std::stringstream ss_key;
        ss_key << key << "#" << demangle<V>();
        if(!loadRawData(ss_key.str(), buffer)) {
            return false;
        }
        try {
270
            std::stringstream ss(buffer);
271
            InputArchive ia(getDataStore(), ss);
Matthieu Dorier's avatar
Matthieu Dorier committed
272 273 274 275 276 277
            ia >> value;
        } catch(...) {
            throw Exception("Exception occured during serialization");
        }
        return true;
    }
278

279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333
    /**
     * @brief Implementation of the load function when the value type is a vector of POD.
     */
    template<typename K, typename V>
    bool loadVectorImpl(const K& key, std::vector<V>& value,
            const std::integral_constant<bool, true>&) const {
        std::string buffer;
        std::stringstream ss_key;
        ss_key << key << "#" << demangle<std::vector<V>>();
        if(!loadRawData(ss_key.str(), buffer)) {
            return false;
        }
        size_t count = 0;
        if(buffer.size() < sizeof(count)) {
            return false;
        }
        std::memcpy(&count, buffer.data(), sizeof(count));
        if(buffer.size() != sizeof(count) + count*sizeof(V)) {
            return false;
        }
        value.resize(count);
        std::memcpy(value.data(), buffer.data()+sizeof(count), count*sizeof(V));
        return true;
    }

    /**
     * @brief Implementation of the load function when the value type is a vector of non-POD.
     */
    template<typename K, typename V>
    bool loadVectorImpl(const K& key, std::vector<V>& value,
            const std::integral_constant<bool, false>&) const {
        std::string buffer;
        std::stringstream ss_key;
        ss_key << key << "#" << demangle<std::vector<V>>();
        if(!loadRawData(ss_key.str(), buffer)) {
            return false;
        }
        try {
            std::stringstream ss(buffer);
            InputArchive ia(getDataStore(), ss);
            size_t count = 0;
            ia >> count;
            value.resize(count);
            for(unsigned i=0; i<count; i++) {
                ia >> value[i];
            }
        } catch(...) {
            throw Exception("Exception occured during serialization");
        }
        return true;
    }
    /**
     * @brief Creates the string key based on the provided key
     * and the type of the value. Serializes the value into a string.
     */
334 335 336
    template<typename K, typename V>
    static void serializeKeyValue(const K& key, const V& value,
            std::string& key_str, std::string& value_str) {
337
        serializeKeyValue(key, value, key_str);
338
        std::stringstream ss_value;
339
        boost::archive::binary_oarchive oa(ss_value, boost::archive::archive_flags::no_header);
340 341 342 343 344 345 346
        try {
            oa << value;
        } catch(...) {
            throw Exception("Exception occured during serialization");
        }
        value_str = ss_value.str();
    }
347

348 349 350 351
    /**
     * @brief Creates the string key based on the provided key
     * and the type of the value.
     */
352 353 354 355 356 357
    template<typename K, typename V>
    static void serializeKeyValue(const K& key, const V& value, std::string& key_str) {
        std::stringstream ss_key;
        ss_key << key << "#" << demangle<V>();
        key_str = std::move(ss_key.str());
    }
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402

    /**
     * @brief Version of serializeKeyValue for vectors of non-POD datatypes.
     */
    template<typename K, typename V>
    static void serializeKeyValueVector(const std::integral_constant<bool, false>&,
            const K& key, const std::vector<V>& value,
            std::string& key_str, std::string& value_str,
            int start, int end) {
        if(end == -1)
            end = value.size();
        if(start < 0 || start > end || end > value.size())
            throw Exception("Invalid range when storing vector");
        serializeKeyValue(key, value, key_str);
        std::stringstream ss_value;
        boost::archive::binary_oarchive oa(ss_value, boost::archive::archive_flags::no_header);
        try {
            size_t count = end-start;
            oa << count;
            for(auto i = start; i < end; i++)
                oa << value[i];
        } catch(...) {
            throw Exception("Exception occured during serialization");
        }
        value_str = ss_value.str();
    }

    /**
     * @brief Version of serializeKeyValue for vectors of POD datatypes.
     */
    template<typename K, typename V>
    static void serializeKeyValueVector(const std::integral_constant<bool, true>&,
            const K& key, const std::vector<V>& value,
            std::string& key_str, std::string& value_str,
            int start, int end) {
        if(end == -1)
            end = value.size();
        if(start < 0 || start > end || end > value.size())
            throw Exception("Invalid range when storing vector");
        serializeKeyValue(key, value, key_str);
        size_t count = end-start;
        value_str.resize(sizeof(count) + count*sizeof(V));
        std::memcpy(const_cast<char*>(value_str.data()), &count, sizeof(count));
        std::memcpy(const_cast<char*>(value_str.data())+sizeof(count), &value[start], count*sizeof(V));
    }
Matthieu Dorier's avatar
Matthieu Dorier committed
403 404 405 406 407
};

}

#endif