include/tsutil/ts_errata.h

/** @file Diagnostic definitions and functions.

@section license License

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you 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 <utility>
#include <unordered_map>

#include "tsutil/ts_diag_levels.h"
#include "swoc/TextView.h"
#include "tsutil/ts_bw_format.h"
#include "swoc/Errata.h"

static constexpr swoc::Errata::Severity ERRATA_DIAG{DL_Diag};
static constexpr swoc::Errata::Severity ERRATA_DEBUG{DL_Debug};
static constexpr swoc::Errata::Severity ERRATA_STATUS{DL_Status};
static constexpr swoc::Errata::Severity ERRATA_NOTE{DL_Note};
static constexpr swoc::Errata::Severity ERRATA_WARN{DL_Warning};
static constexpr swoc::Errata::Severity ERRATA_ERROR{DL_Error};
static constexpr swoc::Errata::Severity ERRATA_FATAL{DL_Fatal};
static constexpr swoc::Errata::Severity ERRATA_ALERT{DL_Alert};
static constexpr swoc::Errata::Severity ERRATA_EMERGENCY{DL_Emergency};

inline DiagsLevel
diags_level_of(swoc::Errata::Severity s)
{
  return static_cast<DiagsLevel>(static_cast<int>(s));
}

// This is treated as an array so must numerically match with @c DiagsLevel
static constexpr std::array<swoc::TextView, 9> Severity_Names{
  {"Diag", "Debug", "Status", "Note", "Warn", "Error", "Fatal", "Alert", "Emergency"}
};

namespace ts
{

inline std::error_code
make_errno_code()
{
  return {errno, std::system_category()};
}

inline std::error_code
make_errno_code(int err)
{
  return {err, std::system_category()};
}

template <typename... Args>
void
bw_log(DiagsLevel /* lvl ATS_UNUSED */, swoc::TextView fmt, Args &&...args)
{
  swoc::bwprint_v(ts::bw_dbg, fmt, std::forward_as_tuple(args...));
}

class err_category : public std::error_category
{
  using self_type = err_category;

public:
  /// @return Name of the category.
  char const *name() const noexcept override;

  /** Convert code to condition.
   *
   * @param code Numeric error code.
   * @return The correspodning condition.
   */
  std::error_condition default_error_condition(int code) const noexcept override;

  /** Is numeric error code equivalent to condition.
   *
   * @param code Numeric error code.
   * @param condition Condition object.
   * @return @a true if the arguments are equivalent.
   */
  bool equivalent(int code, std::error_condition const &condition) const noexcept override;

  /** Is error code enumeration value equivalent to error code object.
   *
   * @param ec Condition object.
   * @param code Numeric error code.
   * @return @a true if the arguments are equivalent.
   */
  bool equivalent(std::error_code const &ec, int code) const noexcept override;

  /// @return Text for @c code.
  std::string message(int code) const override;

protected:
  using table_type = std::unordered_map<int, std::string>;
  /// Mapping from numeric error code to message string.
  static table_type const _table;
};

inline char const *
ts::err_category::name() const noexcept
{
  return "trafficserver";
}

inline std::error_condition
err_category::default_error_condition(int code) const noexcept
{
  return {code, *this};
}

inline bool
err_category::equivalent(const std::error_code &ec, int code) const noexcept
{
  return ec.value() == code;
}

inline bool
err_category::equivalent(int code, const std::error_condition &condition) const noexcept
{
  return code == condition.value();
}

} // namespace ts