#pragma once

#include <chrono>

#include <cstdint>

#include <string>

#include "envoy/admin/v3/server_info.pb.h"

#include "envoy/common/pure.h"

#include "envoy/config/bootstrap/v3/bootstrap.pb.h"

#include "envoy/network/address.h"

#include "envoy/stats/tag.h"

#include "absl/types/optional.h"

#include "spdlog/spdlog.h"

namespace Envoy {

namespace Server {

/**

 * Whether to run Envoy in serving mode, or in config validation mode at one of two levels (in which

 * case we'll verify the configuration file is valid, print any errors, and exit without serving.)

 */

enum class Mode {

  /**

   * Default mode: Regular Envoy serving process. Configs are validated in the normal course of

   * initialization, but if all is well we proceed to serve traffic.

   */

  Serve,

  /**

   * Validate as much as possible without opening network connections upstream or downstream.

   */

  Validate,

  /**

   * Completely load and initialize the config, and then exit without running the listener loop.

   */

  InitOnly,

  // TODO(rlazarus): Add a fourth option for "light validation": Mock out access to the filesystem.

  // Perform no validation of files referenced in the config, such as runtime configs, SSL certs,

  // etc. Validation will pass even if those files are malformed or don't exist, allowing the config

  // to be validated in a non-prod environment.

};

/**

 * During the drain sequence, different components ask the DrainManager

 * whether to drain via drainClose(). This enum dictates the behaviour of

 * drainClose() calls.

 */

enum class DrainStrategy {

  /**

   * The probability of drainClose() returning true increases from 0 to 100%

   * over the duration of the drain period.

   */

  Gradual,

  /**

   * drainClose() will return true as soon as the drain sequence is initiated.

   */

  Immediate,

};

using CommandLineOptionsPtr = std::unique_ptr<envoy::admin::v3::CommandLineOptions>;

/**

 * General options for the server.

 */

class Options {

public:

  /**

   * @return uint64_t the base ID for the server. This is required for system-wide things like

   *         shared memory, domain sockets, etc. that are used during hot restart. Setting the

   *         base ID to a different value will allow the server to run multiple times on the same

   *         host if desired.

   */

  virtual uint64_t baseId() const PURE;

  /**

   * @return bool choose an unused base ID dynamically. The chosen base id can be written to a

   *         a file using the baseIdPath option.

   */

  virtual bool useDynamicBaseId() const PURE;

  /**

   * @return bool don't get hot restart information from the parent if the communication channel

   *         to the parent instance fails to connect.

   */

  virtual bool skipHotRestartOnNoParent() const PURE;

  /**

   * @return bool don't get stats from the parent. If there are a lot of stats, getting them

   *         from the parent instance can be slow and require a lot of memory.

   */

  virtual bool skipHotRestartParentStats() const PURE;

  /**

   * @return const std::string& the dynamic base id output file.

   */

  virtual const std::string& baseIdPath() const PURE;

  /**

   * @return the number of worker threads to run in the server.

   */

  virtual uint32_t concurrency() const PURE;

  /**

   * @return the duration of the drain period in seconds.

   */

  virtual std::chrono::seconds drainTime() const PURE;

  /**

   * @return the strategy that defines behaviour of DrainManager::drainClose();

   */

  virtual DrainStrategy drainStrategy() const PURE;

  /**

   * @return the delay before shutting down the parent envoy in a hot restart,

   *         generally longer than drainTime().

   */

  virtual std::chrono::seconds parentShutdownTime() const PURE;

  /**

   * @return const std::string& the path to the configuration file.

   */

  virtual const std::string& configPath() const PURE;

  /**

   * @return const std::string& an inline YAML bootstrap config that merges

   *                            into the config loaded in configPath().

   */

  virtual const std::string& configYaml() const PURE;

  /**

   * @return const envoy::config::bootstrap::v2::Bootstrap& a bootstrap proto object

   * that merges into the config last, after configYaml and configPath.

   */

  virtual const envoy::config::bootstrap::v3::Bootstrap& configProto() const PURE;

  /**

   * @return bool allow unknown fields in the static configuration?

   */

  virtual bool allowUnknownStaticFields() const PURE;

  /**

   * @return bool allow unknown fields in the dynamic configuration?

   */

  virtual bool rejectUnknownDynamicFields() const PURE;

  /**

   * @return bool ignore unknown fields in the dynamic configuration?

   **/

  virtual bool ignoreUnknownDynamicFields() const PURE;

  /**

   * @return bool skip deprecated warning log messages?

   **/

  virtual bool skipDeprecatedLogs() const PURE;

  /**

   * @return const std::string& the admin address output file.

   */

  virtual const std::string& adminAddressPath() const PURE;

  /**

   * @return Network::Address::IpVersion the local address IP version.

   */

  virtual Network::Address::IpVersion localAddressIpVersion() const PURE;

  /**

   * @return spdlog::level::level_enum the default log level for the server.

   */

  virtual spdlog::level::level_enum logLevel() const PURE;

  /**

   * @return const std::vector<std::pair<std::string, spdlog::level::level_enum>>& pair of

   * component,log level for all configured components.

   */

  virtual const std::vector<std::pair<std::string, spdlog::level::level_enum>>&

  componentLogLevels() const PURE;

  /**

   * @return const std::string& the log format string.

   */

  virtual const std::string& logFormat() const PURE;

  /**

   * @return whether or not a log format was set by CLI option.

   */

  virtual bool logFormatSet() const PURE;

  /**

   * @return const bool indicating whether to escape c-style escape sequences in logs.

   */

  virtual bool logFormatEscaped() const PURE;

  /**

   * @return const bool logger mode: whether to use Fine-Grain Logger.

   */

  virtual bool enableFineGrainLogging() const PURE;

  /**

   * @return const std::string& the log file path.

   */

  virtual const std::string& logPath() const PURE;

  /**

   * @return the restart epoch. 0 indicates the first server start, 1 the second, and so on.

   */

  virtual uint64_t restartEpoch() const PURE;

  /**

   * @return whether to verify the configuration file is valid, print any errors, and exit

   *         without serving.

   */

  virtual Mode mode() const PURE;

  /**

   * @return std::chrono::milliseconds the duration in msec between log flushes.

   */

  virtual std::chrono::milliseconds fileFlushIntervalMsec() const PURE;

  /**

   * @return uint64_t the minimum size in kilobytes before the log buffer is flushed.

   */

  virtual uint64_t fileFlushMinSizeKB() const PURE;

  /**

   * @return const std::string& the server's cluster.

   */

  virtual const std::string& serviceClusterName() const PURE;

  /**

   * @return const std::string& the server's node identification.

   */

  virtual const std::string& serviceNodeName() const PURE;

  /**

   * @return const std::string& the server's zone.

   */

  virtual const std::string& serviceZone() const PURE;

  /**

   * @return bool indicating whether the hot restart functionality has been disabled via cli flags.

   */

  virtual bool hotRestartDisabled() const PURE;

  /**

   * @return bool indicating whether system signal listeners are enabled.

   */

  virtual bool signalHandlingEnabled() const PURE;

  /**

   * @return bool indicating whether mutex tracing functionality has been enabled.

   */

  virtual bool mutexTracingEnabled() const PURE;

  /**

   * @return bool indicating whether core dumps have been enabled.

   */

  virtual bool coreDumpEnabled() const PURE;

  /**

   * @return bool indicating whether cpuset size should determine the number of worker threads.

   */

  virtual bool cpusetThreadsEnabled() const PURE;

  /**

   * @return the names of extensions to disable.

   */

  virtual const std::vector<std::string>& disabledExtensions() const PURE;

  /**

   * Converts the Options in to CommandLineOptions proto message defined in server_info.proto.

   * @return CommandLineOptionsPtr the protobuf representation of the options.

   */

  virtual CommandLineOptionsPtr toCommandLineOptions() const PURE;

  /**

   * @return the path of socket file.

   */

  virtual const std::string& socketPath() const PURE;

  /**

   * @return the mode of socket file.

   */

  virtual mode_t socketMode() const PURE;

  /**

   * @return the stats tags provided by the cli. Tags may contain duplicates. It is the

   * responsibility of the caller to handle the duplicates.

   */

  virtual const Stats::TagVector& statsTags() const PURE;

};

} // namespace Server

} // namespace Envoy