sensordatastore.cpp

/*
 * sensordatastore.cpp
 *
 *  Created on: Jul 24, 2013
 *      Author: Axel Auweter
 */

/**
 * @mainpage
 * The DCDBLib library is a dynamic runtime library providing
 * functions to initialize and access the DCDB data store. It
 * is being used by the CollectAgent to handle insertion of
 * data and can be used by tools responsible for data analysis.
 *
 * Its main class is the SensorDataStore class which provides
 * functions to connect to the data store, initialize an empty
 * data base and to (TODO) retrieve data.
 *
 * For its internal handling, SensorDataStore relies on the
 * SensorDataStoreImpl class (which hides all private member
 * functions belonging to the SensorDataStore class from the
 * header that is used by programmers who link against this
 * library). Raw database functionality is abstracted into the
 * CassandraBackend class (to easy switching to other
 * key-value style databases in the future).
 *
 * To use the library in your client application, simnply
 * include the sensordatastore.h header file and initialize
 * an object of the SensorDataStore class.
 */

#include <string>
#include <iostream>

#include <stdint.h>

#include "sensordatastore_internal.h"

/**
 * @details
 * This function serializes a SensorId object into a
 * big-endian 128-bit character array represented as
 * std::string.
 */
std::string SensorDataStoreImpl::sidConvert(SensorId *sid)
{
    uint64_t ll[2];
    ll[0] = Endian::hostToBE(sid->raw[0]);
    ll[1] = Endian::hostToBE(sid->raw[1]);
    return std::string((char*)ll, 16);
}

/**
 * @details
 * The conversion of a MQTT message topic to a SensorId
 * object is performed by byte-wise scanning of the string,
 * and skipping of all characters except for those in the
 * range [0-9,a-f,A-F]. Each character is then turned from
 * hex string into its binary representation an OR'ed into
 * the 128-bit raw fields of the SensorId object.
 *
 * Applications should not call this function directly, but
 * use the topicToSid function provided by the
 * SensorDataStore class.
 */
bool SensorDataStoreImpl::topicToSid(SensorId* sid, std::string topic)
{
    uint64_t pos = 0;
    const char* buf = topic.c_str();
    sid->raw[0] = 0;
    sid->raw[1] = 0;
    while (*buf && pos < 128) {
        if (*buf >= '0' && *buf <= '9') {
            sid->raw[pos / 64] |= (((uint64_t)(*buf - '0')) << (60-(pos%64)));
            pos += 4;
        }
        else if (*buf >= 'A' && *buf <= 'F') {
            sid->raw[pos / 64] |= (((uint64_t)(*buf - 'A' + 0xa)) << (60-(pos%64)));
            pos += 4;
        }
        else if (*buf >= 'a' && *buf <= 'f') {
            sid->raw[pos / 64] |= (((uint64_t)(*buf - 'a' + 0xa)) << (60-(pos%64)));
            pos += 4;
        }
        buf++;
    }
    return pos == 128;
}

/**
 * @details
 * Initialization of the SensorDataStore happens in three
 * steps:
 *  - Establish Connection
 *  - Check if all keyspaces are present and create them if not
 *  - Check if all column families are present and create them if not
 *
 *  Applications should not call this function directly, but
 *  use the init function provideed by the SensorDataStore class.
 */
void SensorDataStoreImpl::init(std::string hostname, int port) {

  /*
   * Open the connection to the Cassandra database and
   * create the necessary keyspaces and column families.
   */
  csBackend->connect(hostname, port);

  /* Keyspace and column family for sensor aliases */
  /* FIXME: We should have a good way to determine the number of replicas here */
  if (!csBackend->existsKeyspace(CONFIG_KEYSPACE_NAME)) {
      std::cout << "Creating Keyspace " << CONFIG_KEYSPACE_NAME << "...\n";
      csBackend->createKeyspace(CONFIG_KEYSPACE_NAME, 1);
  }

  csBackend->selectKeyspace(CONFIG_KEYSPACE_NAME);

  if (!(csBackend->getActiveKeyspace().compare(CONFIG_KEYSPACE_NAME) == 0)) {
      std::cout << "Cannot select keyspace " << CONFIG_KEYSPACE_NAME << "\n";
      exit(EXIT_FAILURE);
  }

  if (!csBackend->existsColumnFamily(CF_SENSORALIASES)) {
      std::cout << "Creating Column Familiy " CF_SENSORALIASES "...\n";
      csBackend->createColumnFamily(CF_SENSORALIASES,
          "name varchar, pattern varchar",
          "name",
          "COMPACT STORAGE AND CACHING = all");
  }

  /* Keyspace and column family for raw sensor data */
  if (!csBackend->existsKeyspace(KEYSPACE_NAME)) {
      std::cout << "Creating Keyspace " << KEYSPACE_NAME << "...\n";
      csBackend->createKeyspace(KEYSPACE_NAME, 1);
  }

  csBackend->selectKeyspace(KEYSPACE_NAME);

  if (!(csBackend->getActiveKeyspace().compare(KEYSPACE_NAME) == 0)) {
      std::cout << "Cannot select keyspace " << KEYSPACE_NAME << "\n";
      exit(EXIT_FAILURE);
  }

  if (!csBackend->existsColumnFamily(CF_SENSORDATA)) {
      std::cout << "Creating Column Familiy " CF_SENSORDATA "...\n";
      csBackend->createColumnFamily(CF_SENSORDATA,
          "sid blob, ts bigint, value bigint",
          "sid, ts",
          "COMPACT STORAGE");
  }
}

/**
 * @details
 * To insert a sensor reading, the Rsvd field of the SensorId must
 * be filled with a time component that ensures that the maximum
 * number of 2^32 columns per key is not exceeded while still
 * allowing relatively easy retrieval of data.
 *
 * We achieve this by using a "week-stamp" (i.e. number of weeks
 * since Unix epoch) within the Rsvd field of the SensorId before
 * calling the Cassandra Backend to do the raw insert.
 *
 * Applications should not call this function directly, but
 * use the insert function provided by the SensorDataStore class.
 */
void SensorDataStoreImpl::insert(SensorId* sid, uint64_t ts, uint64_t value)
{
  /* Calculate and insert week number */
  uint16_t week = ts / 604800000000;
  sid->dsid.rsvd = week;

  /* Insert into Cassandra */
  csBackend->insert(CF_SENSORDATA, sidConvert(sid), ts, value);
}

/**
 * @details
 * This constructor only sets the internal csBackend variable to
 * the externally provided CassandraBackend object.
 */
SensorDataStoreImpl::SensorDataStoreImpl(CassandraBackend *csb)
{
  csBackend = csb;
}

/**
 * @details
 * Due to the simplicity of the class, the destructor is left empty.
 */
SensorDataStoreImpl::~SensorDataStoreImpl()
{
}

/**
 * @details
 * The main task of this function is to ensure that the
 * SensorDataStore object owns an instance of SensorDataStoreImpl.
 * Once this is ensured, the actual initialization work is
 * performed by the init function of SensorDataStoreImpl.
 */
void SensorDataStore::init(std::string hostname, int port)
{
    /* Allocate new SensorDataStoreImpl Object if necessary */
    if (!impl) {
        impl = new SensorDataStoreImpl(csBackend);
    }
    
    /* Call the Impl class init function */
    impl->init(hostname, port);
}

/**
 * @details
 * Instead of doing the actual work, this function simply
 * forwards to the insert function of the SensorDataStoreImpl
 * class.
 */
bool SensorDataStore::topicToSid(SensorId* sid, std::string topic)
{
    return impl->topicToSid(sid, topic);
}

/**
 * @details
 * Instead of doing the actual work, this function simply
 * forwards to the insert function of the SensorDataStoreImpl
 * class.
 */
void SensorDataStore::insert(SensorId* sid, uint64_t ts, uint64_t value)
//template <typename T> void SensorDataStore::insert(T* sid, uint64_t ts, uint64_t value)
{
    impl->insert(sid, ts, value);
}

/**
 * @details
 * This constructor for SensorDataStore acts similarly to the
 * standard constructor by calling the standard constructor
 * with "localhost" as the hostname and 9160 as the port number.
 */
SensorDataStore::SensorDataStore()
{
    csBackend = new CassandraBackend();
    impl = nullptr;
    init("localhost", 9042);
}

/**
 * @details
 * This constructor for SensorDataStore objects initializes
 * the object and connects to the database at the given
 * hostname on the given port.
 *
 * For this, the constructor allocates a CassandraBackend
 * object that is then used by SensorDataStoreImpl for doing
 * the raw database accesses.
 */
SensorDataStore::SensorDataStore(std::string hostname, int port)
{
    csBackend = new CassandraBackend();
    impl = nullptr;
    init(hostname, port);
}

/**
 * @details
 * The SensorDataStore desctructor deallocates the
 * SensorDataStoreImpl and CassandraBackend objects.
 */
SensorDataStore::~SensorDataStore()
{
  /* Clean up... */
  if (impl)
    delete impl;
  if (csBackend)
    delete csBackend;

}