Method Init

be/src/runtime/tuple-cache-mgr.cc:149–249

            STATS_MAX_TUPLE_CACHE_ENTRY_SIZE, 3))) {}

Status TupleCacheMgr::Init(int64_t process_bytes_limit) {
  if (cache_config_.empty()) {
    LOG(INFO) << "Tuple Cache is disabled.";
    return Status::OK();
  }

  // The expected form of the configuration string is: dir1:capacity
  // Example: /tmp/data1:1TB
  vector<string> all_cache_configs = Split(cache_config_, ":", SkipEmpty());
  if (all_cache_configs.size() != 2) {
    return Status(Substitute("Malformed data cache configuration $0", cache_config_));
  }

  // Parse the capacity string to make sure it's well-formed
  bool is_percent = false;
  int64_t capacity = ParseUtil::ParseMemSpec(all_cache_configs[1], &is_percent, 0);
  if (is_percent) {
    return Status(Substitute("Malformed tuple cache capacity configuration $0",
        all_cache_configs[1]));
  }
  // For normal execution (not backend tests), impose a minimum size on the
  // cache of 64MB.
  if (!TestInfo::is_be_test() && capacity < MIN_TUPLE_CACHE_CAPACITY_BYTES) {
    return Status(Substitute(
        "Tuple cache capacity $0 is less than the minimum allowed capacity $1",
        all_cache_configs[1], MIN_TUPLE_CACHE_CAPACITY_STR));
  }

  vector<string> cache_dirs = Split(all_cache_configs[0], ",", SkipEmpty());
  if (cache_dirs.size() > 1) {
    return Status(Substitute("Malformed tuple cache directory $0. "
        "The tuple cache only supports a single directory.", all_cache_configs[0]));
  }
  cache_dir_ = cache_dirs[0];

  // Verify the validity of the path specified.
  if (!FileSystemUtil::IsCanonicalPath(cache_dir_)) {
    return Status(Substitute("$0 is not a canonical path", cache_dir_));
  }
  RETURN_IF_ERROR(FileSystemUtil::VerifyIsDirectory(cache_dir_));

  // Verify we can create a file in the cache directory
  filesystem::path path =
      filesystem::path(cache_dir_) / Substitute("$0test", CACHE_FILE_PREFIX);
  RETURN_IF_ERROR(FileSystemUtil::CreateFile(path.string()));

  // Remove any existing cache files from the cache directory. This ensures that the
  // usage starts at zero. This also removes the test file we just wrote.
  RETURN_IF_ERROR(DeleteExistingFiles());

  // Check that there is enough space available for the specified cache size
  uint64_t available_bytes;
  RETURN_IF_ERROR(FileSystemUtil::GetSpaceAvailable(cache_dir_, &available_bytes));
  if (available_bytes < capacity) {
    string err = Substitute("Insufficient space for $0. Required $1. Only $2 is "
        "available", cache_dir_, PrettyPrinter::PrintBytes(capacity),
        PrettyPrinter::PrintBytes(available_bytes));
    LOG(ERROR) << err;