forked from pytorch/pytorch
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add source location information to error messages (pytorch#6059)
- Loading branch information
1 parent
7ffcb20
commit d42fcdb
Showing
35 changed files
with
286 additions
and
195 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| #pragma once | ||
|
|
||
| #include <ATen/ATenGeneral.h> // for AT_API | ||
|
|
||
| #include <cstdint> | ||
| #include <cstdio> | ||
| #include <exception> | ||
| #include <stdexcept> | ||
| #include <string> | ||
| #include <type_traits> | ||
|
|
||
| #include <stdarg.h> | ||
|
|
||
| namespace at { | ||
| namespace detail { | ||
| /// A tiny implementation of static `all_of`. | ||
| template <bool...> | ||
| struct pack; | ||
| template <bool... values> | ||
| struct all_of : std::is_same<pack<values..., true>, pack<true, values...>> {}; | ||
|
|
||
| /// A printf wrapper that returns an std::string. | ||
| inline std::string format(const char* format_string, ...) { | ||
| static constexpr size_t kMaximumStringLength = 4096; | ||
| char buffer[kMaximumStringLength]; | ||
|
|
||
| va_list format_args; | ||
| va_start(format_args, format_string); | ||
| vsnprintf(buffer, sizeof(buffer), format_string, format_args); | ||
| va_end(format_args); | ||
|
|
||
| return buffer; | ||
| } | ||
|
|
||
| /// Represents a location in source code (for debugging). | ||
| struct SourceLocation { | ||
| std::string toString() const { | ||
| return format("%s at %s:%d", function, file, line); | ||
| } | ||
|
|
||
| const char* function; | ||
| const char* file; | ||
| uint32_t line; | ||
| }; | ||
| } // namespace detail | ||
|
|
||
| /// The primary ATen error class. | ||
| /// Provides a complete error message with source location information via | ||
| /// `what()`, and a more concise message via `what_without_location()`. Should | ||
| /// primarily be used with the `AT_ERROR` macro. | ||
| struct AT_API Error : public std::exception { | ||
| template <typename... FormatArgs> | ||
| Error( | ||
| detail::SourceLocation source_location, | ||
| const char* format_string, | ||
| FormatArgs&&... format_args) | ||
| : what_without_location_(detail::format( | ||
| format_string, | ||
| std::forward<FormatArgs>(format_args)...)), | ||
| what_( | ||
| what_without_location_ + " (" + source_location.toString() + ")") { | ||
| // NOTE: A "literal type" | ||
| // (http://en.cppreference.com/w/cpp/concept/LiteralType) could also be a | ||
| // constexpr struct, so it's not 100% guaranteed that the `printf` call | ||
| // inside `format` is safe, but it will catch 99.9% of all errors we'll run | ||
| // into, such as passing `std::string`. | ||
| static_assert( | ||
| detail::all_of<std::is_literal_type<FormatArgs>::value...>::value, | ||
| "arguments to `format` must be literal types!"); | ||
| } | ||
|
|
||
| /// Returns the complete error message including the source location. | ||
| const char* what() const noexcept override { | ||
| return what_.c_str(); | ||
| } | ||
|
|
||
| /// Returns only the error message string, without source location. | ||
| const char* what_without_location() const noexcept { | ||
| return what_without_location_.c_str(); | ||
| } | ||
|
|
||
| private: | ||
| std::string what_without_location_; | ||
| std::string what_; | ||
| }; | ||
| } // namespace at | ||
|
|
||
| #define AT_ERROR(...) \ | ||
| throw at::Error({__func__, __FILE__, __LINE__}, __VA_ARGS__) | ||
|
|
||
| #define AT_ASSERT(cond, ...) \ | ||
| if (!(cond)) { \ | ||
| AT_ERROR(__VA_ARGS__); \ | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.