File_Namespace::TableFileMgr Class Reference

#include <CachingFileMgr.h>

Collaboration diagram for File_Namespace::TableFileMgr:

Public Member Functions
	TableFileMgr (const std::string &table_path)
	~TableFileMgr ()
void	incrementEpoch ()
	increment the epoch for this subdir (not synced to disk). More...
void	writeAndSyncEpochToDisk ()
	Write and flush the epoch to the epoch file on disk. More...
int32_t	getEpoch () const
	Returns the current epoch (locked) More...
void	removeDiskContent () const
	Removes all disk data for the subdir. More...
size_t	getReservedSpace () const
	Returns the disk space used (in bytes) for the subdir. More...
void	deleteWrapperFile () const
	Deletes only the wrapper file on disk. More...
void	writeWrapperFile (const std::string &doc) const
	Writes wrapper file to disk. More...
bool	hasWrapperFile () const

Private Attributes
std::string	table_path_
std::string	epoch_file_path_
std::string	wrapper_file_path_
Epoch	epoch_
bool	is_checkpointed_ = true
FILE *	epoch_file_ = nullptr
heavyai::shared_mutex	table_mutex_

Detailed Description

Definition at line 92 of file CachingFileMgr.h.

Constructor & Destructor Documentation

File_Namespace::TableFileMgr::TableFileMgr

(

const std::string &

table_path

)

Definition at line 755 of file CachingFileMgr.cpp.

References Epoch::byte_size(), CHECK, File_Namespace::create(), epoch_, epoch_file_, epoch_file_path_, heavyai::file_size(), incrementEpoch(), File_Namespace::open(), File_Namespace::read(), Epoch::storage_ptr(), table_path_, and writeAndSyncEpochToDisk().

    : table_path_(table_path)
    , epoch_file_path_(table_path_ + "/" + FileMgr::EPOCH_FILENAME)
    , wrapper_file_path_(table_path_ + "/" + CachingFileMgr::WRAPPER_FILE_NAME)
    , epoch_(Epoch())
    , is_checkpointed_(true) {
  if (!bf::exists(table_path_)) {
    bf::create_directory(table_path_);
  } else {
    CHECK(bf::is_directory(table_path_)) << "Specified path '" << table_path_
                                         << "' for cache table data is not a directory.";
  }
  if (bf::exists(epoch_file_path_)) {
    CHECK(bf::is_regular_file(epoch_file_path_))
        << "Found epoch file '" << epoch_file_path_ << "' which is not a regular file";
    CHECK(bf::file_size(epoch_file_path_) == Epoch::byte_size())
        << "Found epoch file '" << epoch_file_path_ << "' which is not of expected size";
    epoch_file_ = open(epoch_file_path_);
    read(epoch_file_, 0, Epoch::byte_size(), epoch_.storage_ptr());
  } else {
    epoch_file_ = create(epoch_file_path_, sizeof(Epoch::byte_size()));
    writeAndSyncEpochToDisk();
    incrementEpoch();
  }
}

Here is the call graph for this function:

File_Namespace::TableFileMgr::~TableFileMgr ( )

inline

Definition at line 95 of file CachingFileMgr.h.

References File_Namespace::close(), and epoch_file_.

{ close(epoch_file_); }

Here is the call graph for this function:

Member Function Documentation

void File_Namespace::TableFileMgr::deleteWrapperFile

(

)

const

Deletes only the wrapper file on disk.

Definition at line 825 of file CachingFileMgr.cpp.

References table_mutex_, and wrapper_file_path_.

                                           {
  heavyai::unique_lock<heavyai::shared_mutex> w_lock(table_mutex_);
  bf::remove_all(wrapper_file_path_);
}

int32_t File_Namespace::TableFileMgr::getEpoch

(

)

const

Returns the current epoch (locked)

Definition at line 790 of file CachingFileMgr.cpp.

References Epoch::ceiling(), epoch_, and table_mutex_.

                                     {
  heavyai::shared_lock<heavyai::shared_mutex> r_lock(table_mutex_);
  return static_cast<int32_t>(epoch_.ceiling());
}

Here is the call graph for this function:

size_t File_Namespace::TableFileMgr::getReservedSpace

(

)

const

Returns the disk space used (in bytes) for the subdir.

Definition at line 814 of file CachingFileMgr.cpp.

References heavyai::file_size(), table_mutex_, and table_path_.

                                            {
  heavyai::shared_lock<heavyai::shared_mutex> r_lock(table_mutex_);
  size_t space = 0;
  for (const auto& file : bf::recursive_directory_iterator(table_path_)) {
    if (bf::is_regular_file(file.path())) {
      space += bf::file_size(file.path());
    }
  }
  return space;
}

Here is the call graph for this function:

bool File_Namespace::TableFileMgr::hasWrapperFile

(

)

const

Checks if data wrapper file has been written to disk/cached.

Definition at line 840 of file CachingFileMgr.cpp.

References table_mutex_, and wrapper_file_path_.

                                        {
  heavyai::shared_lock<heavyai::shared_mutex> r_lock(table_mutex_);
  return bf::exists(wrapper_file_path_);
}

void File_Namespace::TableFileMgr::incrementEpoch

(

)

increment the epoch for this subdir (not synced to disk).

Definition at line 781 of file CachingFileMgr.cpp.

References Epoch::ceiling(), CHECK, epoch_, Epoch::increment(), is_checkpointed_, Epoch::max_allowable_epoch(), and table_mutex_.

Referenced by TableFileMgr().

                                  {
  heavyai::unique_lock<heavyai::shared_mutex> w_lock(table_mutex_);
  epoch_.increment();
  is_checkpointed_ = false;
  CHECK(epoch_.ceiling() <= Epoch::max_allowable_epoch())
      << "Epoch greater than maximum allowed value (" << epoch_.ceiling() << " > "
      << Epoch::max_allowable_epoch() << ").";
}

Here is the call graph for this function:

Here is the caller graph for this function:

void File_Namespace::TableFileMgr::removeDiskContent

(

)

const

Removes all disk data for the subdir.

Definition at line 809 of file CachingFileMgr.cpp.

References table_mutex_, and table_path_.

                                           {
  heavyai::unique_lock<heavyai::shared_mutex> w_lock(table_mutex_);
  bf::remove_all(table_path_);
}

void File_Namespace::TableFileMgr::writeAndSyncEpochToDisk

(

)

Write and flush the epoch to the epoch file on disk.

Definition at line 795 of file CachingFileMgr.cpp.

References Epoch::byte_size(), CHECK, epoch_, epoch_file_, heavyai::fsync(), is_checkpointed_, Epoch::storage_ptr(), table_mutex_, and File_Namespace::write().

Referenced by TableFileMgr().

                                           {
  heavyai::unique_lock<heavyai::shared_mutex> w_lock(table_mutex_);
  write(epoch_file_, 0, Epoch::byte_size(), epoch_.storage_ptr());
  int32_t status = fflush(epoch_file_);
  CHECK(status == 0) << "Could not flush epoch file to disk";
#ifdef __APPLE__
  status = fcntl(fileno(epoch_file_), 51);
#else
  status = heavyai::fsync(fileno(epoch_file_));
#endif
  CHECK(status == 0) << "Could not sync epoch file to disk";
  is_checkpointed_ = true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void File_Namespace::TableFileMgr::writeWrapperFile

(

const std::string &

doc

)

const

Writes wrapper file to disk.

Definition at line 830 of file CachingFileMgr.cpp.

References table_mutex_, and wrapper_file_path_.

                                                              {
  heavyai::unique_lock<heavyai::shared_mutex> w_lock(table_mutex_);
  std::ofstream ofs(wrapper_file_path_);
  if (!ofs) {
    throw std::runtime_error{"Error trying to create file \"" + wrapper_file_path_ +
                             "\". The error was: " + std::strerror(errno)};
  }
  ofs << doc;
}

Member Data Documentation

Epoch File_Namespace::TableFileMgr::epoch_

private

Definition at line 141 of file CachingFileMgr.h.

Referenced by getEpoch(), incrementEpoch(), TableFileMgr(), and writeAndSyncEpochToDisk().

FILE* File_Namespace::TableFileMgr::epoch_file_ = nullptr

private

Definition at line 143 of file CachingFileMgr.h.

Referenced by TableFileMgr(), writeAndSyncEpochToDisk(), and ~TableFileMgr().

std::string File_Namespace::TableFileMgr::epoch_file_path_

private

Definition at line 139 of file CachingFileMgr.h.

Referenced by TableFileMgr().

bool File_Namespace::TableFileMgr::is_checkpointed_ = true

private

Definition at line 142 of file CachingFileMgr.h.

Referenced by incrementEpoch(), and writeAndSyncEpochToDisk().

heavyai::shared_mutex File_Namespace::TableFileMgr::table_mutex_

mutableprivate

Definition at line 145 of file CachingFileMgr.h.

Referenced by deleteWrapperFile(), getEpoch(), getReservedSpace(), hasWrapperFile(), incrementEpoch(), removeDiskContent(), writeAndSyncEpochToDisk(), and writeWrapperFile().

std::string File_Namespace::TableFileMgr::table_path_

private

Definition at line 138 of file CachingFileMgr.h.

Referenced by getReservedSpace(), removeDiskContent(), and TableFileMgr().

std::string File_Namespace::TableFileMgr::wrapper_file_path_

private

Definition at line 140 of file CachingFileMgr.h.

Referenced by deleteWrapperFile(), hasWrapperFile(), and writeWrapperFile().

---

The documentation for this class was generated from the following files:

• /home/jenkins-slave/workspace/core-os-doxygen/DataMgr/FileMgr/CachingFileMgr.h
• /home/jenkins-slave/workspace/core-os-doxygen/DataMgr/FileMgr/CachingFileMgr.cpp