arangodb/arangod/MMFiles/MMFilesIndexElement.cpp

////////////////////////////////////////////////////////////////////////////////
/// DISCLAIMER
///
/// Copyright 2014-2016 ArangoDB GmbH, Cologne, Germany
/// Copyright 2004-2014 triAGENS GmbH, Cologne, Germany
///
/// 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.
///
/// Copyright holder is ArangoDB GmbH, Cologne, Germany
///
/// @author Jan Steemann
////////////////////////////////////////////////////////////////////////////////

#include "MMFilesIndexElement.h"
#include "Basics/VelocyPackHelper.h"
#include "MMFiles/MMFilesIndexLookupContext.h"

using namespace arangodb;

MMFilesHashIndexElement::MMFilesHashIndexElement(LocalDocumentId const& documentId,
                                                 std::vector<std::pair<VPackSlice, uint32_t>> const& values)
    : _localDocumentId(documentId), _hash(static_cast<uint32_t>(hash(values))) {
  for (size_t i = 0; i < values.size(); ++i) {
    subObject(i)->fill(values[i].first, values[i].second);
  }
}

MMFilesHashIndexElement* MMFilesHashIndexElement::initialize(
    MMFilesHashIndexElement* element, LocalDocumentId const& documentId,
    std::vector<std::pair<arangodb::velocypack::Slice, uint32_t>> const& values) {
  TRI_ASSERT(!values.empty());
  return new (element) MMFilesHashIndexElement(documentId, values);
}

/// @brief velocypack sub-object (for indexes, as part of IndexElement,
/// if offset is non-zero, then it is an offset into the VelocyPack data in
/// the datafile or WAL file. If offset is 0, then data contains the actual data
/// in place.
arangodb::velocypack::Slice MMFilesHashIndexElement::slice(MMFilesIndexLookupContext* context,
                                                           size_t position) const {
  MMFilesIndexElementValue const* sub = subObject(position);

  if (sub->isInline()) {
    return arangodb::velocypack::Slice(&sub->value.data[0]);
  }

  uint32_t offset = sub->value.offset;
  if (offset == 0) {
    return arangodb::velocypack::Slice::nullSlice();
  }
  uint8_t const* vpack = context->lookup(LocalDocumentId{_localDocumentId.id()});
  if (vpack == nullptr) {
    THROW_ARANGO_EXCEPTION(TRI_ERROR_ARANGO_DOCUMENT_NOT_FOUND);
  }
  return VPackSlice(vpack + sub->value.offset);
}

uint64_t MMFilesHashIndexElement::hash(arangodb::velocypack::Slice const& values) {
  uint64_t hash = 0x0123456789abcdef;
  size_t const n = values.length();

  for (size_t i = 0; i < n; ++i) {
    // must use normalized hash here, to normalize different representations
    // of arrays/objects/numbers
    hash = values.at(i).normalizedHash(hash);
  }

  return hash & 0x00000000FFFFFFFFULL;
}

uint64_t MMFilesHashIndexElement::hash(std::vector<arangodb::velocypack::Slice> const& values) {
  uint64_t hash = 0x0123456789abcdef;
  size_t const n = values.size();

  for (size_t i = 0; i < n; ++i) {
    // must use normalized hash here, to normalize different representations
    // of arrays/objects/numbers
    hash = values[i].normalizedHash(hash);
  }

  return hash & 0x00000000FFFFFFFFULL;
}

uint64_t MMFilesHashIndexElement::hash(
    std::vector<std::pair<arangodb::velocypack::Slice, uint32_t>> const& values) {
  uint64_t hash = 0x0123456789abcdef;
  size_t const n = values.size();

  for (size_t i = 0; i < n; ++i) {
    // must use normalized hash here, to normalize different representations
    // of arrays/objects/numbers
    hash = values[i].first.normalizedHash(hash);
  }

  return hash & 0x00000000FFFFFFFFULL;
}

MMFilesSkiplistIndexElement::MMFilesSkiplistIndexElement(
    LocalDocumentId const& documentId,
    std::vector<std::pair<VPackSlice, uint32_t>> const& values)
    : _localDocumentId(documentId) {
  for (size_t i = 0; i < values.size(); ++i) {
    subObject(i)->fill(values[i].first, values[i].second);
  }
}

MMFilesSkiplistIndexElement* MMFilesSkiplistIndexElement::initialize(
    MMFilesSkiplistIndexElement* element, LocalDocumentId const& documentId,
    std::vector<std::pair<arangodb::velocypack::Slice, uint32_t>> const& values) {
  TRI_ASSERT(!values.empty());
  return new (element) MMFilesSkiplistIndexElement(documentId, values);
}

/// @brief velocypack sub-object (for indexes, as part of IndexElement,
/// if offset is non-zero, then it is an offset into the VelocyPack data in
/// the datafile or WAL file. If offset is 0, then data contains the actual data
/// in place.
arangodb::velocypack::Slice MMFilesSkiplistIndexElement::slice(MMFilesIndexLookupContext* context,
                                                               size_t position) const {
  MMFilesIndexElementValue const* sub = subObject(position);

  if (sub->isInline()) {
    return arangodb::velocypack::Slice(&sub->value.data[0]);
  }

  uint32_t offset = sub->value.offset;
  if (offset == 0) {
    return arangodb::velocypack::Slice::nullSlice();
  }
  uint8_t const* vpack = context->lookup(LocalDocumentId{_localDocumentId.id()});
  if (vpack == nullptr) {
    THROW_ARANGO_EXCEPTION(TRI_ERROR_ARANGO_DOCUMENT_NOT_FOUND);
  }
  return VPackSlice(vpack + sub->value.offset);
}

MMFilesSimpleIndexElement::MMFilesSimpleIndexElement(LocalDocumentId const& documentId,
                                                     arangodb::velocypack::Slice const& value,
                                                     uint32_t offset)
    : _localDocumentId(documentId),
      _hashAndOffset(hash(value) | (static_cast<uint64_t>(offset) << 32)) {}

uint64_t MMFilesSimpleIndexElement::hash(arangodb::velocypack::Slice const& value) {
  TRI_ASSERT(value.isString());
  return value.hashString() & 0x00000000FFFFFFFFULL;
}

VPackSlice MMFilesSimpleIndexElement::slice(MMFilesIndexLookupContext* context) const {
  uint8_t const* vpack = context->lookup(_localDocumentId);
  if (vpack == nullptr) {
    THROW_ARANGO_EXCEPTION(TRI_ERROR_ARANGO_DOCUMENT_NOT_FOUND);
  }
  return VPackSlice(vpack + offset());
}