CachingFileMgr.h

Go to the documentation of this file.

/*
 * Copyright 2021 Omnisci, 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.
 */

#pragma once

#include "FileMgr.h"

namespace File_Namespace {

inline std::string get_dir_name_for_table(int db_id, int tb_id) {
  std::stringstream file_name;
  file_name << "table_" << db_id << "_" << tb_id << "/";
  return file_name.str();
}

class CachingFileMgr : public FileMgr {
 public:
  CachingFileMgr(const std::string& base_path, const size_t num_reader_threads = 0);
  ~CachingFileMgr() {}
  bool coreInit() override;

  // Simple getters.
  inline MgrType getMgrType() override { return CACHING_FILE_MGR; };
  inline std::string getStringMgrType() override { return ToString(CACHING_FILE_MGR); }
  inline size_t getDefaultPageSize() { return defaultPageSize_; }

  // TODO(Misiu): These are unimplemented for now, but will become necessary when we want
  // to limit the size.
  inline size_t getMaxSize() override {
    UNREACHABLE() << "Unimplemented";
    return 0;
  }
  inline size_t getInUseSize() override {
    UNREACHABLE() << "Unimplemented";
    return 0;
  }
  inline size_t getAllocated() override {
    UNREACHABLE() << "Unimplemented";
    return 0;
  }
  inline bool isAllocationCapped() override { return false; }

  void clearForTable(int db_id, int tb_id);

  std::string getOrAddTableDir(int db_id, int tb_id);

  inline bool hasFileMgrKey() const override { return false; }
  void closeRemovePhysical() override;

  uint64_t getChunkSpaceReservedByTable(int db_id, int tb_id);
  uint64_t getMetadataSpaceReservedByTable(int db_id, int tb_id);
  uint64_t getWrapperSpaceReservedByTable(int db_id, int tb_id);
  uint64_t getSpaceReservedByTable(int db_id, int tb_id);

  std::string describeSelf() override;
};

}  // namespace File_Namespace