parser_error.h

Go to the documentation of this file.

/* Copyright 2013-present Barefoot Networks, Inc.
 *
 * 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.
 */
 
/*
 * Antonin Bas (antonin@barefootnetworks.com)
 *
 */
 
 
#ifndef BM_BM_SIM_PARSER_ERROR_H_
#define BM_BM_SIM_PARSER_ERROR_H_
 
#include <exception>
#include <limits>
#include <string>
#include <unordered_map>
 
namespace bm {
 
class ErrorCode {
  friend class ErrorCodeMap;
 public:
  using type_t = int;
 
  explicit ErrorCode(type_t v)
      : v(v) { }
 
  type_t get() { return v; }
 
  bool operator==(const ErrorCode &other) const {
    return (v == other.v);
  }
 
  bool operator!=(const ErrorCode &other) const {
    return !(*this == other);
  }
 
  static ErrorCode make_invalid() { return ErrorCode(INVALID_V); }
 
 private:
  type_t v;
 
  static constexpr type_t INVALID_V = std::numeric_limits<type_t>::max();
};
 
class ErrorCodeMap {
 public:
  enum class Core {
    NoError,
    PacketTooShort,
    NoMatch,
    StackOutOfBounds,
    HeaderTooShort,
    ParserTimeout,
    ParserInvalidArgument
  };
 
  bool add(const std::string &name, ErrorCode::type_t v);
  bool exists(const std::string &name) const;
  bool exists(ErrorCode::type_t v) const;
  // Add the core error codes to the map, providing they are not already
  // present. If they need to be added, we make sure to use different integral
  // values than for the existing codes.
  void add_core();
 
  ErrorCode from_name(const std::string &name) const;
  ErrorCode from_core(const Core &core) const;
  const std::string &to_name(const ErrorCode &code) const;
 
  static ErrorCodeMap make_with_core();
 
 private:
  static const char *core_to_name(const Core &core);
 
  std::unordered_map<ErrorCode::type_t, std::string> map_v_to_name{};
  std::unordered_map<std::string, ErrorCode::type_t> map_name_to_v{};
};
 
class parser_exception : public std::exception {
 public:
  virtual ~parser_exception() { }
 
  virtual ErrorCode get(const ErrorCodeMap &error_codes) const = 0;
};
 
class parser_exception_arch : public parser_exception {
 public:
  explicit parser_exception_arch(const ErrorCode &code);
 
  ErrorCode get(const ErrorCodeMap &error_codes) const override;
 
 private:
  const ErrorCode code;
};
 
class parser_exception_core : public parser_exception {
 public:
  explicit parser_exception_core(ErrorCodeMap::Core core);
 
  ErrorCode get(const ErrorCodeMap &error_codes) const override;
 
 private:
  ErrorCodeMap::Core core;
};
 
}  // namespace bm
 
#endif  // BM_BM_SIM_PARSER_ERROR_H_