RFile.cxx

Go to the documentation of this file.

/// \file v7/src/RFile.cxx
/// \author Giacomo Parolini <giacomo.parolini@cern.ch>
/// \date 2025-03-19
/// \warning This is part of the ROOT 7 prototype! It will change without notice. It might trigger earthquakes. Feedback
/// is welcome!
 
#include "ROOT/RFile.hxx"
 
#include <ROOT/StringUtils.hxx>
#include <ROOT/RLogger.hxx>
#include <ROOT/RError.hxx>
 
#include <Byteswap.h>
#include <TError.h>
#include <TFile.h>
#include <TIterator.h>
#include <TNamed.h>
#include <TKey.h>
#include <TList.h>
#include <TROOT.h>
 
#include <algorithm>
#include <cstring>
 
ROOT::RLogChannel &ROOT::Internal::RFileLog()
{
   static ROOT::RLogChannel sLog("ROOT.File");
   return sLog;
}
 
using ROOT::RFile;
using ROOT::Internal::RFileLog;
 
namespace {
enum class ENameCycleError {
   kNoError,
   kAnyCycle,
   kInvalidSyntax,
   kCycleTooLarge,
   kNameEmpty,
   kCOUNT
};
 
struct RNameCycleResult {
   std::string fName;
   std::optional<std::int16_t> fCycle;
   ENameCycleError fError;
};
} // namespace
 
static const char *ToString(ENameCycleError err)
{
   static const char *const kErrorStr[] = {"", "", "invalid syntax", "cycle is too large", "name is empty"};
   static_assert(std::size(kErrorStr) == static_cast<std::size_t>(ENameCycleError::kCOUNT));
   return kErrorStr[static_cast<std::size_t>(err)];
}
 
static ENameCycleError DecodeNumericCycle(const char *str, std::optional<std::int16_t> &out)
{
   uint32_t res = 0;
   do {
      if (!isdigit(*str))
         return ENameCycleError::kInvalidSyntax;
      if (res * 10 > std::numeric_limits<std::int16_t>::max())
         return ENameCycleError::kCycleTooLarge;
      res *= 10;
      res += *str - '0';
   } while (*++str);
 
   assert(res < std::numeric_limits<std::int16_t>::max());
   out = static_cast<std::int16_t>(res);
 
   return ENameCycleError::kNoError;
}
 
static RNameCycleResult DecodeNameCycle(std::string_view nameCycleRaw)
{
   RNameCycleResult result{};
 
   if (nameCycleRaw.empty())
      return result;
 
   // Scan the string to find the name length and the semicolon
   std::size_t semicolonIdx = nameCycleRaw.find_first_of(';');
 
   if (semicolonIdx == 0) {
      result.fError = ENameCycleError::kNameEmpty;
      return result;
   }
 
   // Verify that we have at most one ';'
   if (nameCycleRaw.substr(semicolonIdx + 1).find_first_of(';') != std::string_view::npos) {
      result.fError = ENameCycleError::kInvalidSyntax;
      return result;
   }
 
   result.fName = nameCycleRaw.substr(0, semicolonIdx);
   if (semicolonIdx < std::string_view::npos) {
      if (semicolonIdx == nameCycleRaw.length() - 1 && nameCycleRaw[semicolonIdx] == '*')
         result.fError = ENameCycleError::kAnyCycle;
      else
         result.fError = DecodeNumericCycle(nameCycleRaw.substr(semicolonIdx + 1).data(), result.fCycle);
   }
 
   return result;
}
 
/// This function first validates, then normalizes the given path in place.
///
/// Returns an empty string if `path` is a suitable path to store an object into a RFile,
/// otherwise returns a description of why that is not the case.
///
/// A valid object path must:
///   - not be empty
///   - not contain the character '.'
///   - not contain ASCII control characters or whitespace characters (including tab or newline).
///   - not contain more than RFile::kMaxPathNesting path fragments (i.e. more than RFile::kMaxPathNesting - 1 '/')
///   - not end with a '/'
///
/// In addition, when *writing* an object to RFile, the character ';' is also banned.
///
/// Passing an invalid path to Put will cause it to throw an exception, and
/// passing an invalid path to Get will always return nullptr.
///
/// If required, `path` is modified to make its hierarchy-related meaning consistent. This entails:
/// - combining any consecutive '/' into a single one;
/// - stripping any leading '/'.
///
static std::string ValidateAndNormalizePath(std::string &path)
{
   ////// First, validate path.
 
   if (path.empty())
      return "path cannot be empty";
 
   if (path.back() == '/')
      return "path cannot end with a '/'";
 
   bool valid = true;
   for (char ch : path) {
      // Disallow control characters, tabs, newlines, whitespace and dot.
      // NOTE: not short-circuiting or early returning to enable loop vectorization.
      valid &= !(ch < 33 || ch == '.');
   }
   if (!valid)
      return "path cannot contain control characters, whitespaces or dots";
 
   //// Path is valid so far, normalize it.
 
   // Strip all leading '/'
   {
      auto nToStrip = 0u;
      const auto len = path.length();
      while (nToStrip < len && path[nToStrip] == '/')
         ++nToStrip;
 
      if (nToStrip > 0)
         path.erase(0, nToStrip);
   }
 
   // Remove duplicate consecutive '/'
   const auto it = std::unique(path.begin(), path.end(), [](char a, char b) { return (a == '/' && b == '/'); });
   path.erase(it, path.end());
 
   //// After the path has been normalized, check the nesting level by counting how many slashes it contains.
   const auto nesting = std::count(path.begin(), path.end(), '/');
   if (nesting > RFile::kMaxPathNesting)
      return "pathView contains too many levels of nesting";
 
   return "";
}
 
static void EnsureFileOpenAndBinary(const TFile *tfile, std::string_view path)
{
   if (!tfile || tfile->IsZombie())
      throw ROOT::RException(R__FAIL("failed to open file " + std::string(path) + " for reading"));
 
   if (tfile->IsRaw() || !tfile->IsBinary() || tfile->IsArchive())
      throw ROOT::RException(R__FAIL("Opened file " + std::string(path) + " is not a ROOT binary file"));
}
 
static std::string ReconstructFullKeyPath(const TKey &key)
{
   std::string path = key.GetName();
   TDirectory *parent = key.GetMotherDir();
   while (parent && parent->GetMotherDir()) {
      path = std::string(parent->GetName()) + "/" + path;
      parent = parent->GetMotherDir();
   }
   return path;
}
 
/////////////////////////////////////////////////////////////////////////////////////////////////
std::pair<std::string_view, std::string_view> ROOT::Detail::DecomposePath(std::string_view path)
{
   auto lastSlashIdx = path.rfind('/');
   if (lastSlashIdx == std::string_view::npos)
      return {{}, path};
 
   auto dirName = path.substr(0, lastSlashIdx + 1);
   auto pathName = path.substr(lastSlashIdx + 1);
   return {dirName, pathName};
}
 
std::unique_ptr<RFile> RFile::Open(std::string_view path, const ROpenOptions &opts)
{
   TDirectory::TContext ctx(nullptr); // XXX: probably not thread safe?
   const char *mode = opts.fEnableBrowsability ? "READ" : "READ_WITHOUT_GLOBALREGISTRATION";
   auto tfile = std::unique_ptr<TFile>(TFile::Open(std::string(path).c_str(), mode));
   EnsureFileOpenAndBinary(tfile.get(), path);
 
   auto rfile = std::unique_ptr<RFile>(new RFile(std::move(tfile)));
   return rfile;
}
 
std::unique_ptr<RFile> RFile::Update(std::string_view path, const RUpdateOptions &opts)
{
   TDirectory::TContext ctx(nullptr); // XXX: probably not thread safe?
   const char *mode = opts.fEnableBrowsability ? "UPDATE" : "UPDATE_WITHOUT_GLOBALREGISTRATION";
   auto tfile = std::unique_ptr<TFile>(TFile::Open(std::string(path).c_str(), mode));
   EnsureFileOpenAndBinary(tfile.get(), path);
 
   auto rfile = std::unique_ptr<RFile>(new RFile(std::move(tfile)));
   return rfile;
}
 
std::unique_ptr<RFile> RFile::Recreate(std::string_view path, const RRecreateOptions &opts)
{
   TDirectory::TContext ctx(nullptr); // XXX: probably not thread safe?
   const char *mode = opts.fEnableBrowsability ? "RECREATE" : "RECREATE_WITHOUT_GLOBALREGISTRATION";
   auto tfile = std::unique_ptr<TFile>(TFile::Open(std::string(path).c_str(), mode, "", opts.fCompressionSettings));
   EnsureFileOpenAndBinary(tfile.get(), path);
 
   auto rfile = std::unique_ptr<RFile>(new RFile(std::move(tfile)));
   return rfile;
}
 
RFile::RFile(std::unique_ptr<TFile> file) : fFile(std::move(file)) {}
 
RFile::~RFile() = default;
 
TKey *RFile::GetTKey(std::string_view path) const
{
   // In RFile, differently from TFile, when dealing with a path like "a/b/c", we always consider it to mean
   // "object 'c' in subdirectory 'b' of directory 'a'". We don't try to get any other of the possible combinations,
   // including the object called "a/b/c".
   std::string fullPath = std::string(path);
   char *dirName = fullPath.data();
   char *restOfPath = strchr(dirName, '/');
   TDirectory *dir = fFile.get();
   while (restOfPath) {
      // Truncate `dirName` to the position of this '/'.
      *restOfPath = 0;
      ++restOfPath;
      // `restOfPath` should always be a non-empty string unless `path` ends with '/' (which it shouldn't, as we are
      // supposed to have normalized it before calling this function).
      assert(*restOfPath);
 
      dir = dir->GetDirectory(dirName);
      if (!dir)
         return nullptr;
 
      dirName = restOfPath;
      restOfPath = strchr(restOfPath, '/');
   }
   // NOTE: after this loop `dirName` contains the base name of the object.
 
   // Get the leaf object from the innermost directory.
   TKey *key = dir->FindKey(dirName);
   if (key) {
      // For some reason, FindKey will not return nullptr if we asked for a specific cycle and that cycle
      // doesn't exist. It will instead return any key whose cycle is *at most* the requested one.
      // This is very confusing, so in RFile we actually return null if the requested cycle is not there.
      RNameCycleResult res = DecodeNameCycle(dirName);
      if (res.fError != ENameCycleError::kAnyCycle) {
         if (res.fError != ENameCycleError::kNoError) {
            R__LOG_ERROR(RFileLog()) << "error decoding namecycle '" << dirName << "': " << ToString(res.fError);
            key = nullptr;
         } else if (res.fCycle && *res.fCycle != key->GetCycle()) {
            key = nullptr;
         }
      }
   }
   return key;
}
 
void *RFile::GetUntyped(std::string_view path,
                        std::variant<const char *, std::reference_wrapper<const std::type_info>> type) const
{
   if (!fFile)
      throw ROOT::RException(R__FAIL("File has been closed"));
 
   std::string pathStr{path};
 
   struct {
      TClass *operator()(const char *name) { return TClass::GetClass(name); }
      TClass *operator()(std::reference_wrapper<const std::type_info> ty) { return TClass::GetClass(ty.get()); }
   } typeVisitor;
   const TClass *cls = std::visit(std::move(typeVisitor), type);
 
   if (!cls)
      throw ROOT::RException(R__FAIL(std::string("Could not determine type of object ") + pathStr));
 
   if (auto err = ValidateAndNormalizePath(pathStr); !err.empty())
      throw RException(R__FAIL("Invalid object pathStr '" + pathStr + "': " + err));
 
   TKey *key = GetTKey(pathStr);
   void *obj = key ? key->ReadObjectAny(cls) : nullptr;
 
   if (obj) {
      // Disavow any ownership on `obj` unless the object is a TTree, in which case we need to link it to our internal
      // file for it to be usable.
      if (auto autoAddFunc = cls->GetDirectoryAutoAdd()) {
         if (cls->InheritsFrom("TTree")) {
            autoAddFunc(obj, fFile.get());
            // NOTE(gparolini): this is a hacky but effective way of preventing the Tree from being deleted by
            // the internal TFile once we close it. We need to avoid that because this TTree will be returned inside
            // a unique_ptr and would end up being double-freed if we allowed ROOT to do its own memory management.
            ROOT::Internal::MarkTObjectAsNotOnHeap(*static_cast<TObject *>(obj));
         } else {
            autoAddFunc(obj, nullptr);
         }
      }
   } else if (key) {
      R__LOG_INFO(RFileLog()) << "Tried to get object '" << path << "' of type " << cls->GetName()
                              << " but that path contains an object of type " << key->GetClassName();
   }
 
   return obj;
}
 
void RFile::Put(const TNamed &namedObj, std::string_view dirPath)
{
   if (strchr(namedObj.GetName(), '/')) {
      throw ROOT::RException(R__FAIL(std::string("TNamed object '") + namedObj.GetName() +
                                     "' given to RFile::Put cannot have '/' in its name!"));
   }
   std::string completePath = (dirPath.empty() ? "" : std::string(dirPath) + '/') + namedObj.GetName();
   Put(completePath, namedObj, namedObj.GetTitle());
}
 
void RFile::PutUntyped(std::string_view pathSV, const std::type_info &type, const void *obj, std::uint32_t flags,
                       std::string_view title)
{
   const TClass *cls = TClass::GetClass(type);
   if (!cls)
      throw ROOT::RException(R__FAIL(std::string("Could not determine type of object ") + std::string(pathSV)));
 
   std::string path{pathSV};
   if (auto err = ValidateAndNormalizePath(path); !err.empty())
      throw RException(R__FAIL("Invalid object path '" + path + "': " + err));
 
   if (path.find_first_of(';') != std::string_view::npos) {
      throw RException(
         R__FAIL("Invalid object path '" + path +
                 "': character ';' is used to specify an object cycle, which only makes sense when reading."));
   }
 
   if (!fFile)
      throw ROOT::RException(R__FAIL("File has been closed"));
 
   if (!fFile->IsWritable())
      throw ROOT::RException(R__FAIL("File is not writable"));
 
   // If `path` refers to a subdirectory, make sure we always write in an actual TDirectory,
   // otherwise we may have a mix of top-level objects called "a/b/c" and actual directory
   // structures.
   // Sadly, TFile does nothing to prevent this and will happily write "a/b" even if there
   // is already a directory "a" containing an object "b". We don't want that ambiguity here, so we take extra steps
   // to ensure it doesn't happen.
   const auto tokens = ROOT::Split(path, "/");
   const auto FullPathUntil = [&tokens](auto idx) {
      return ROOT::Join("/", std::span<const std::string>{tokens.data(), idx + 1});
   };
   TDirectory *dir = fFile.get();
   for (auto tokIdx = 0u; tokIdx < tokens.size() - 1; ++tokIdx) {
      // Alas, not only does mkdir not fail if the file already contains an object "a/b" and you try
      // to create dir "a", but even when it does fail it doesn't tell you why.
      // We obviously don't want to allow the coexistence of regular object named "a/b" and the directory
      // named "a", so we manually check if each level of nesting doesn't exist already as a non-directory.
      const TKey *existing = dir->GetKey(tokens[tokIdx].c_str());
      if (existing && strcmp(existing->GetClassName(), "TDirectory") != 0 &&
          strcmp(existing->GetClassName(), "TDirectoryFile") != 0) {
         throw ROOT::RException(R__FAIL("error adding object '" + path + "': failed to create directory '" +
                                        FullPathUntil(tokIdx) + "': name already taken by an object of type '" +
                                        existing->GetClassName() + "'"));
      }
      dir = dir->mkdir(tokens[tokIdx].c_str(), "", true);
      if (!dir) {
         throw ROOT::RException(R__FAIL(std::string("failed to create directory ") + FullPathUntil(tokIdx)));
      }
   }
 
   const bool allowOverwrite = (flags & kPutFlag_AllowOverwrite) != 0;
   const bool backupCycle = (flags & kPutFlag_OverwriteKeepCycle) != 0;
   const Option_t *writeOpts = "";
   if (!allowOverwrite) {
      const TKey *existing = dir->GetKey(tokens[tokens.size() - 1].c_str());
      if (existing) {
         throw ROOT::RException(R__FAIL(std::string("trying to overwrite object ") + path + " of type " +
                                        existing->GetClassName() + " with another object of type " + cls->GetName()));
      }
   } else if (!backupCycle) {
      writeOpts = "WriteDelete";
   }
 
   const char *objName = tokens[tokens.size() - 1].c_str();
   assert(dynamic_cast<TDirectoryFile *>(dir));
   int success =
      static_cast<TDirectoryFile *>(dir)->WriteObjectAny(obj, cls, {objName, std::string(title).c_str()}, writeOpts);
 
   if (!success) {
      throw ROOT::RException(R__FAIL(std::string("Failed to write ") + path + " to file"));
   }
}
 
ROOT::RFileKeyIterable::RIterator::RIterStackElem::RIterStackElem(TIterator *it, const std::string &path)
   : fIter(it), fDirPath(path)
{
}
 
ROOT::RFileKeyIterable::RIterator::RIterStackElem::~RIterStackElem() = default;
 
ROOT::RFileKeyIterable::RIterator::RIterator(TIterator *iter, Pattern_t pattern, std::uint32_t flags)
   : fPattern(pattern), fFlags(flags)
{
   if (iter) {
      fIterStack.emplace_back(iter);
 
      if (!pattern.empty()) {
         fRootDirNesting = std::count(pattern.begin(), pattern.end(), '/');
         // `pattern` may or may not end with '/', but we consider it a directory regardless.
         // In other words, like in virtually all filesystem operations, "dir" and "dir/" are equivalent.
         fRootDirNesting += pattern.back() != '/';
      }
 
      // Advance the iterator to skip the first key, which is always the TFile key.
      // This will also skip keys until we reach the first correct key we want to return.
      Advance();
   }
}
 
ROOT::RFileKeyIterable::RIterator ROOT::RFileKeyIterable::begin() const
{
   return {fFile->GetListOfKeys()->MakeIterator(), fPattern, fFlags};
}
 
ROOT::RFileKeyIterable::RIterator ROOT::RFileKeyIterable::end() const
{
   return {nullptr, fPattern, fFlags};
}
 
void ROOT::RFileKeyIterable::RIterator::Advance()
{
   fCurKey = nullptr;
 
   const bool recursive = fFlags & RFile::kListRecursive;
   const bool includeObj = fFlags & RFile::kListObjects;
   const bool includeDirs = fFlags & RFile::kListDirs;
 
   // We only want to return keys that refer to user objects, not internal ones, therefore we skip
   // all keys that have internal class names.
   while (!fIterStack.empty()) {
      auto &[iter, dirPath] = fIterStack.back();
      assert(iter);
      TObject *keyObj = iter->Next();
      if (!keyObj) {
         // reached end of the iteration
         fIterStack.pop_back();
         continue;
      }
 
      assert(keyObj->IsA() == TClass::GetClass<TKey>());
      auto key = static_cast<TKey *>(keyObj);
 
      const std::string dirSep = (dirPath.empty() ? "" : "/");
      const bool isDir = TClass::GetClass(key->GetClassName())->InheritsFrom(TDirectory::Class());
 
      if (isDir) {
         TDirectory *dir = key->ReadObject<TDirectory>();
         TIterator *innerIter = dir->GetListOfKeys()->MakeIterator();
         assert(innerIter);
         fIterStack.emplace_back(innerIter, dirPath + dirSep + dir->GetName());
         if (!includeDirs)
            continue;
      } else if (!includeObj) {
         continue;
      }
 
      // Reconstruct the full path of the key
      const std::string &fullPath = dirPath + dirSep + key->GetName();
      assert(!fIterStack.empty());
      const std::size_t nesting = fIterStack.size() - 1;
 
      // Skip key if it's the root dir itself
      if (isDir && fullPath == fPattern)
         continue;
 
      // Skip key if it's not a child of root dir
      if (!ROOT::StartsWith(fullPath, fPattern))
         continue;
 
      // Check that we are in the same directory as "rootDir".
      // Note that for directories we list both the root dir and the immediate children (in non-recursive mode).
      if (!recursive && nesting != fRootDirNesting &&
          (!isDir || nesting != static_cast<std::size_t>(fRootDirNesting + 1)))
         continue;
 
      // All checks passed: return this key.
      assert(!fullPath.empty());
      fCurKey = key;
      break;
   }
}
 
ROOT::RKeyInfo ROOT::RFileKeyIterable::RIterator::operator*()
{
   if (fIterStack.empty())
      throw ROOT::RException(R__FAIL("tried to dereference an invalid iterator"));
 
   const TKey *key = fCurKey;
   if (!key)
      throw ROOT::RException(R__FAIL("tried to dereference an invalid iterator"));
 
   const bool isDir =
      strcmp(key->GetClassName(), "TDirectory") == 0 || strcmp(key->GetClassName(), "TDirectoryFile") == 0;
   const auto &dirPath = fIterStack.back().fDirPath;
 
   RKeyInfo keyInfo;
   keyInfo.fCategory = isDir ? RKeyInfo::ECategory::kDirectory : RKeyInfo::ECategory::kObject;
   keyInfo.fPath = dirPath;
   if (!isDir)
      keyInfo.fPath += std::string(dirPath.empty() ? "" : "/") + key->GetName();
   keyInfo.fClassName = key->GetClassName();
   keyInfo.fCycle = key->GetCycle();
   keyInfo.fTitle = key->GetTitle();
   return keyInfo;
}
 
void RFile::Print(std::ostream &out) const
{
   std::vector<RKeyInfo> keys;
   auto keysIter = ListKeys();
   for (const auto &key : keysIter) {
      keys.emplace_back(key);
   }
 
   std::sort(keys.begin(), keys.end(), [](const auto &a, const auto &b) { return a.GetPath() < b.GetPath(); });
   for (const auto &key : keys) {
      out << key.GetClassName() << " " << key.GetPath() << ";" << key.GetCycle() << ": \"" << key.GetTitle() << "\"\n";
   }
}
 
size_t RFile::Flush()
{
   return fFile->Write();
}
 
void RFile::Close()
{
   // NOTE: this also flushes the file internally
   fFile.reset();
}
 
ROOT::RKeyInfo::RKeyInfo(const TKey &key)
   : fPath(ReconstructFullKeyPath(key)),
     fTitle(key.GetTitle()),
     fClassName(key.GetClassName()),
     fCycle(key.GetCycle()),
     fLenObj(key.GetObjlen()),
     fNBytesObj(key.GetNbytes() - key.GetKeylen()),
     fNBytesKey(key.GetKeylen()),
     fSeekKey(key.GetSeekKey()),
     fSeekParentDir(key.GetSeekPdir())
{
}
 
std::optional<ROOT::RKeyInfo> RFile::GetKeyInfo(std::string_view path) const
{
   const TKey *key = GetTKey(path);
   if (!key)
      return {};
 
   RKeyInfo keyInfo(*key);
   return keyInfo;
}
 
void *ROOT::Internal::RFile_GetObjectFromKey(RFile &file, const RKeyInfo &key)
{
   const auto nameCycle = std::string(key.GetPath()) + ";" + std::to_string(key.GetCycle());
   void *obj = file.GetUntyped(nameCycle, key.GetClassName().c_str());
   return obj;
}
 
TFile *ROOT::Internal::GetRFileTFile(RFile &file)
{
   return file.fFile.get();
}
 
RFile::RRecreateOptions::RRecreateOptions() = default;
RFile::ROpenOptions::ROpenOptions() = default;
RFile::RUpdateOptions::RUpdateOptions() = default;