arangodb/arangod/MMFiles/MMFilesWalRecoverState.h

////////////////////////////////////////////////////////////////////////////////
/// 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
////////////////////////////////////////////////////////////////////////////////

#ifndef ARANGOD_MMFILES_WAL_RECOVER_STATE_H
#define ARANGOD_MMFILES_WAL_RECOVER_STATE_H 1

#include "Basics/Common.h"
#include "MMFiles/MMFilesDatafile.h"
#include "MMFiles/MMFilesWalLogfile.h"
#include "MMFiles/MMFilesWalMarker.h"
#include "VocBase/ticks.h"
#include "VocBase/voc-types.h"
#include "VocBase/vocbase.h"

namespace arangodb {
class DatabaseFeature;
class SingleCollectionTransaction;

/// @brief state that is built up when scanning a WAL logfile during recovery
struct MMFilesWalRecoverState {
  MMFilesWalRecoverState(MMFilesWalRecoverState const&) = delete;
  MMFilesWalRecoverState& operator=(MMFilesWalRecoverState const&) = delete;

  /// @brief creates the recover state
  explicit MMFilesWalRecoverState(bool ignoreRecoveryErrors, TRI_voc_tick_t& recoveryTick);

  /// @brief destroys the recover state
  ~MMFilesWalRecoverState();

  /// @brief checks if there will be a drop marker for the database or
  /// collection
  bool willBeDropped(TRI_voc_tick_t databaseId, TRI_voc_cid_t collectionId) const {
    if (totalDroppedDatabases.find(databaseId) != totalDroppedDatabases.end()) {
      return true;
    }
    return (totalDroppedCollections.find(collectionId) !=
            totalDroppedCollections.end());
  }

  /// @brief checks if there will be a drop marker for the collection
  bool willBeDropped(TRI_voc_cid_t collectionId) const {
    return (totalDroppedCollections.find(collectionId) !=
            totalDroppedCollections.end());
  }

  /// @brief checks if there will be a drop marker for the view
  bool willViewBeDropped(TRI_voc_cid_t viewId) const {
    return (totalDroppedViews.find(viewId) != totalDroppedViews.end());
  }

  /// @brief checks if there will be a drop marker for the database or database
  bool willViewBeDropped(TRI_voc_tick_t databaseId, TRI_voc_cid_t viewId) const {
    if (totalDroppedDatabases.find(databaseId) != totalDroppedDatabases.end()) {
      return true;
    }
    return (totalDroppedViews.find(viewId) != totalDroppedViews.end());
  }

  /// @brief checks if a database is dropped already
  bool isDropped(TRI_voc_tick_t databaseId) const {
    return (droppedDatabases.find(databaseId) != droppedDatabases.end());
  }

  /// @brief checks if a database or collection is dropped already
  bool isDropped(TRI_voc_tick_t databaseId, TRI_voc_cid_t collectionId) const {
    if (isDropped(databaseId)) {
      // database has been dropped
      return true;
    }

    if (droppedCollections.find(collectionId) != droppedCollections.end()) {
      // collection has been dropped
      return true;
    }

    return false;
  }

  /// @brief current recovery tick
  inline TRI_voc_tick_t currentTick() const noexcept { return recoveryTick; }

  /// @brief whether or not to abort recovery on first error
  inline bool canContinue() const { return ignoreRecoveryErrors; }

  /// @brief whether or not the recovery procedure must be run
  inline bool mustRecover() const { return !logfilesToProcess.empty(); }

  /// @brief whether or not to ignore a specific transaction in replay
  inline bool ignoreTransaction(TRI_voc_tid_t transactionId) const {
    return (transactionId > 0 &&
            failedTransactions.find(transactionId) != failedTransactions.end());
  }

  void resetCollection() { resetCollection(0, 0); }

  void resetCollection(TRI_voc_tick_t databaseId, TRI_voc_cid_t collectionId) {
    lastDatabaseId = databaseId;
    lastCollectionId = collectionId;
  }

  /// @brief release opened collections and databases so they can be shut down
  /// etc.
  void releaseResources();

  /// @brief gets a database (and inserts it into the cache if not in it)
  TRI_vocbase_t* useDatabase(TRI_voc_tick_t);

  /// @brief releases a database
  TRI_vocbase_t* releaseDatabase(TRI_voc_tick_t);

  /// @brief release a collection (so it can be dropped)
  std::shared_ptr<arangodb::LogicalCollection> releaseCollection(TRI_voc_cid_t);

  /// @brief gets a collection (and inserts it into the cache if not in it)
  arangodb::LogicalCollection* useCollection(TRI_vocbase_t*, TRI_voc_cid_t, int&);

  arangodb::LogicalView* releaseView(TRI_voc_cid_t);

  /// @brief looks up a collection
  /// the collection will be opened after this call and inserted into a local
  /// cache for faster lookups
  /// returns nullptr if the collection does not exist
  arangodb::LogicalCollection* getCollection(TRI_voc_tick_t, TRI_voc_cid_t);

  /// @brief executes a single operation inside a transaction
  int executeSingleOperation(TRI_voc_tick_t, TRI_voc_cid_t, MMFilesMarker const*, TRI_voc_fid_t,
                             std::function<int(SingleCollectionTransaction*, MMFilesMarkerEnvelope*)>);

  /// @brief callback to handle one marker during recovery
  /// this function modifies indexes etc.
  static bool ReplayMarker(MMFilesMarker const*, void*, MMFilesDatafile*);

  /// @brief callback to handle one marker during recovery
  /// this function only builds up state and does not change any data
  static bool InitialScanMarker(MMFilesMarker const*, void*, MMFilesDatafile*);

  /// @brief replay a single logfile
  int replayLogfile(MMFilesWalLogfile*, int);

  /// @brief replay all logfiles
  int replayLogfiles();

  /// @brief abort open transactions
  int abortOpenTransactions();

  /// @brief remove all empty logfiles found during logfile inspection
  int removeEmptyLogfiles();

  /// @brief fill the secondary indexes of all collections used in recovery
  int fillIndexes();

  DatabaseFeature* databaseFeature;
  std::unordered_map<TRI_voc_tid_t, std::pair<TRI_voc_tick_t, bool>> failedTransactions;
  std::unordered_set<TRI_voc_cid_t> droppedCollections;
  std::unordered_set<TRI_voc_cid_t> droppedViews;
  std::unordered_set<TRI_voc_tick_t> droppedDatabases;
  std::unordered_set<TRI_voc_cid_t> totalDroppedCollections;
  std::unordered_set<TRI_voc_cid_t> totalDroppedViews;
  std::unordered_set<TRI_voc_tick_t> totalDroppedDatabases;

  TRI_voc_tick_t lastTick;
  std::vector<MMFilesWalLogfile*> logfilesToProcess;
  std::unordered_map<TRI_voc_cid_t, std::shared_ptr<arangodb::LogicalCollection>> openedCollections;
  std::unordered_map<TRI_voc_tick_t, TRI_vocbase_t*> openedDatabases;
  std::vector<std::string> emptyLogfiles;

  bool ignoreRecoveryErrors;
  int64_t errorCount;
  TRI_voc_rid_t maxRevisionId;
  LocalDocumentId maxLocalDocumentId;

 private:
  TRI_voc_tick_t& recoveryTick;
  TRI_voc_tick_t lastDatabaseId;
  TRI_voc_cid_t lastCollectionId;
};

}  // namespace arangodb

#endif