Error.hpp

// Copyright (c) 2021 Graphcore Ltd. All rights reserved.
#ifndef poplar_Error_hpp
#define poplar_Error_hpp
 
#include <iosfwd>
#include <limits>
#include <memory>
#include <unordered_set>
 
#include "poplar/StringRef.hpp"
 
namespace poplar {
 
// Forward declarations.
 
class Engine;
 
namespace core {
 
struct ErrorLocation;
 
} // namespace core
 
enum class ErrorCode : unsigned {
  NONE = 0,
  UNKNOWN,
  TRAP,
  FLOATING_POINT_INVALID_OPERATION,
  FLOATING_POINT_DIVIDE_BY_ZERO,
  FLOATING_POINT_OVERFLOW,
  TILE_MEMORY_BANK_CONFLICT,
  INVALID_EXCHANGE_CONFIGURATION,
  INVALID_ADDRESS,
  INVALID_OPERAND,
  INVALID_PROGRAM_COUNTER,
  INVALID_INSTRUCTION,
  EXCHANGE_ERROR,
  MEMORY_ERROR,
  IPUSOFTERR,
  LINK_DOWN,
  HOST_LINK_DOWN,
  HOST_SYNC_TIMEOUT,
  IPU_MEMORY_FAILURE
};
 
StringRef errorCodeToString(ErrorCode error);
 
ErrorCode errorCodeFromString(StringRef error);
 
std::ostream &operator<<(std::ostream &os, ErrorCode error);
std::istream &operator>>(std::istream &is, ErrorCode &error);
 
struct ErrorLocation {
  explicit operator bool() const noexcept;
 
  unsigned getTile() const noexcept;
 
  bool operator==(const ErrorLocation &rhs) const noexcept;
 
  bool operator!=(const ErrorLocation &rhs) const noexcept;
 
  ErrorLocation() noexcept;
  ErrorLocation(ErrorLocation const &other);
  ErrorLocation(ErrorLocation &&other) noexcept;
  ~ErrorLocation() noexcept;
  ErrorLocation &operator=(ErrorLocation other) noexcept;
 
  // Implementation.
  ErrorLocation(core::ErrorLocation other);
 
private:
  friend class Engine;
  friend struct ErrorLocationHash;
  friend std::ostream &operator<<(std::ostream &os,
                                  const ErrorLocation &location);
 
  std::unique_ptr<core::ErrorLocation> impl;
};
 
std::ostream &operator<<(std::ostream &os, const ErrorLocation &location);
 
struct ErrorLocationHash {
  size_t operator()(const ErrorLocation &location) const noexcept;
};
 
} // namespace poplar
 
#endif // poplar_Error_hpp