cas_flags.h

Go to the documentation of this file.

//
// Copyright (C) 2024 The Android Open Source Project
//
// 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 <stdint.h>
 
#include <string>
#include <vector>
 
#include "cuttlefish/flag_parser/flag.h"
#include "cuttlefish/flag_parser/gflags_compat.h"
 
namespace cuttlefish {
 
// Wrapper for flag values that tracks whether a value was user-specified
// (via command-line or config file) versus using a default.
template <typename T>
class FlagValue {
 public:
  explicit FlagValue(const T& default_value) : default_value_(default_value) {}
 
  // Use ref-qualifier to avoid calling value() on a temporary.
  const T& value() const& { return value_ ? *value_ : default_value_; }
  void set_value(const T& value) { value_.emplace(value); }
  bool user_provided() const { return value_.has_value(); }
 
 private:
  friend struct CasDownloaderFlags;
 
  cuttlefish::Flag Flag(const std::string& name) {
    return GflagsCompatFlag(name, value_);
  }
 
  std::optional<T> value_;
  T default_value_;
};
 
inline constexpr int kDefaultMemoryLimit = 0;  // 0 for no limit.
inline constexpr int kDefaultCasConcurrency = 500;
inline constexpr int kDefaultRpcTimeout = 120;
inline constexpr int kDefaultGetCapabilitiesTimeout = 5;
inline constexpr int kDefaultGetTreeTimeout = 5;
inline constexpr int kDefaultBatchReadBlobsTimeout = 180;
inline constexpr int kDefaultBatchUpdateBlobsTimeout = 60;
 
// Default cache size for CAS cache: 8 GiB.
// Note: this is only effective when cache_dir is set.
inline constexpr int64_t kMinCacheMaxSize = 8LL * 1024 * 1024 * 1024;
 
// Default path to CAS downloader config file.
inline constexpr const char kDefaultCasConfigFilePath[] =
    "/etc/casdownloader/config.json";
 
// Default path to CAS downloader binary.
inline constexpr const char kDefaultDownloaderPath[] = "/usr/bin/casdownloader";
 
// Flags for the CAS downloader binary.
struct CasDownloaderFlags {
  CasDownloaderFlags();
  std::vector<Flag> Flags();
 
  FlagValue<std::string> cas_config_filepath;
  FlagValue<std::string> downloader_path;
  FlagValue<bool> prefer_uncompressed;
  FlagValue<std::string> cache_dir;
  FlagValue<std::string> invocation_id;
  FlagValue<int64_t> cache_max_size;
  FlagValue<bool> cache_lock;
  FlagValue<bool> use_hardlink;
  FlagValue<int> memory_limit;
  FlagValue<int> cas_concurrency;
  FlagValue<int> rpc_timeout;
  FlagValue<int> get_capabilities_timeout;
  FlagValue<int> get_tree_timeout;
  FlagValue<int> batch_read_blobs_timeout;
  FlagValue<int> batch_update_blobs_timeout;
  FlagValue<bool> version;
};
 
}  // namespace cuttlefish