[Custom OP]add PD_THROW and PD_CHECK for User Error message (#31253)
* [Custom OP]add PD_THROW and PD_CHECK for User error message * PD_THROW and PD_CHECK, fix comment * fix Windows error message * fix Windows error message * fix CItest_model_benchmark_ci
Zhou Wei
5 years ago
committed by
GitHub
parent
8c94d8cb4c
commit
af9066e89c
@ -0,0 +1,108 @@
|
||||
/* Copyright (c) 2021 PaddlePaddle Authors. All Rights Reserved.
|
||||
|
||||
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. */
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <iostream>
|
||||
#include <sstream>
|
||||
#include <string>
|
||||
|
||||
namespace paddle {
|
||||
|
||||
//////////////// Exception handling and Error Message /////////////////
|
||||
#if !defined(_WIN32)
|
||||
#define PD_UNLIKELY(expr) (__builtin_expect(static_cast<bool>(expr), 0))
|
||||
#define PD_LIKELY(expr) (__builtin_expect(static_cast<bool>(expr), 1))
|
||||
#else
|
||||
#define PD_UNLIKELY(expr) (expr)
|
||||
#define PD_LIKELY(expr) (expr)
|
||||
#endif
|
||||
|
||||
struct PD_Exception : public std::exception {
|
||||
public:
|
||||
template <typename... Args>
|
||||
explicit PD_Exception(const std::string& msg, const char* file, int line,
|
||||
const char* default_msg) {
|
||||
std::ostringstream sout;
|
||||
if (msg.empty()) {
|
||||
sout << default_msg << "\n [" << file << ":" << line << "]";
|
||||
} else {
|
||||
sout << msg << "\n [" << file << ":" << line << "]";
|
||||
}
|
||||
err_msg_ = sout.str();
|
||||
}
|
||||
|
||||
const char* what() const noexcept override { return err_msg_.c_str(); }
|
||||
|
||||
private:
|
||||
std::string err_msg_;
|
||||
};
|
||||
|
||||
class ErrorMessage {
|
||||
public:
|
||||
template <typename... Args>
|
||||
explicit ErrorMessage(const Args&... args) {
|
||||
build_string(args...);
|
||||
}
|
||||
|
||||
void build_string() { oss << ""; }
|
||||
|
||||
template <typename T>
|
||||
void build_string(const T& t) {
|
||||
oss << t;
|
||||
}
|
||||
|
||||
template <typename T, typename... Args>
|
||||
void build_string(const T& t, const Args&... args) {
|
||||
build_string(t);
|
||||
build_string(args...);
|
||||
}
|
||||
|
||||
std::string to_string() { return oss.str(); }
|
||||
|
||||
private:
|
||||
std::ostringstream oss;
|
||||
};
|
||||
|
||||
#if defined _WIN32
|
||||
#define HANDLE_THE_ERROR try {
|
||||
#define END_HANDLE_THE_ERROR \
|
||||
} \
|
||||
catch (const std::exception& e) { \
|
||||
std::cerr << e.what() << std::endl; \
|
||||
throw e; \
|
||||
}
|
||||
#else
|
||||
#define HANDLE_THE_ERROR
|
||||
#define END_HANDLE_THE_ERROR
|
||||
#endif
|
||||
|
||||
#define PD_CHECK(COND, ...) \
|
||||
do { \
|
||||
if (PD_UNLIKELY(!(COND))) { \
|
||||
auto __message__ = ::paddle::ErrorMessage(__VA_ARGS__).to_string(); \
|
||||
throw ::paddle::PD_Exception(__message__, __FILE__, __LINE__, \
|
||||
"Expected " #COND \
|
||||
", but it's not satisfied."); \
|
||||
} \
|
||||
} while (0)
|
||||
|
||||
#define PD_THROW(...) \
|
||||
do { \
|
||||
auto __message__ = ::paddle::ErrorMessage(__VA_ARGS__).to_string(); \
|
||||
throw ::paddle::PD_Exception(__message__, __FILE__, __LINE__, \
|
||||
"An error occured."); \
|
||||
} while (0)
|
||||
|
||||
} // namespace paddle
|
||||
@ -0,0 +1,169 @@
|
||||
/* Copyright (c) 2021 PaddlePaddle Authors. All Rights Reserved.
|
||||
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. */
|
||||
|
||||
#include <iostream>
|
||||
#include <string>
|
||||
#include "gtest/gtest.h"
|
||||
#include "paddle/fluid/extension/include/ext_exception.h"
|
||||
|
||||
TEST(PD_THROW, empty) {
|
||||
bool caught_exception = false;
|
||||
try {
|
||||
PD_THROW();
|
||||
} catch (const std::exception& e) {
|
||||
caught_exception = true;
|
||||
std::string err_msg = e.what();
|
||||
EXPECT_TRUE(err_msg.find("An error occured.") != std::string::npos);
|
||||
#if _WIN32
|
||||
EXPECT_TRUE(err_msg.find("tests\\custom_op\\test_check_error.cc:20") !=
|
||||
std::string::npos);
|
||||
#else
|
||||
EXPECT_TRUE(
|
||||
err_msg.find(
|
||||
"python/paddle/fluid/tests/custom_op/test_check_error.cc:20") !=
|
||||
std::string::npos);
|
||||
#endif
|
||||
}
|
||||
EXPECT_TRUE(caught_exception);
|
||||
}
|
||||
|
||||
TEST(PD_THROW, non_empty) {
|
||||
bool caught_exception = false;
|
||||
try {
|
||||
PD_THROW("PD_THROW returns ",
|
||||
false,
|
||||
". DataType of ",
|
||||
1,
|
||||
" is INT. ",
|
||||
"DataType of ",
|
||||
0.23,
|
||||
" is FLOAT. ");
|
||||
} catch (const std::exception& e) {
|
||||
caught_exception = true;
|
||||
std::string err_msg = e.what();
|
||||
EXPECT_TRUE(err_msg.find("PD_THROW returns 0. DataType of 1 is INT. ") !=
|
||||
std::string::npos);
|
||||
#if _WIN32
|
||||
EXPECT_TRUE(err_msg.find("tests\\custom_op\\test_check_error.cc") !=
|
||||
std::string::npos);
|
||||
#else
|
||||
EXPECT_TRUE(
|
||||
err_msg.find(
|
||||
"python/paddle/fluid/tests/custom_op/test_check_error.cc") !=
|
||||
std::string::npos);
|
||||
#endif
|
||||
}
|
||||
EXPECT_TRUE(caught_exception);
|
||||
}
|
||||
|
||||
TEST(PD_CHECK, OK) {
|
||||
PD_CHECK(true);
|
||||
PD_CHECK(true, "PD_CHECK returns ", true, "now");
|
||||
|
||||
const size_t a = 1;
|
||||
const size_t b = 10;
|
||||
PD_CHECK(a < b);
|
||||
PD_CHECK(a < b, "PD_CHECK returns ", true, a, "should < ", b);
|
||||
}
|
||||
|
||||
TEST(PD_CHECK, FAILED) {
|
||||
bool caught_exception = false;
|
||||
try {
|
||||
PD_CHECK(false);
|
||||
} catch (const std::exception& e) {
|
||||
caught_exception = true;
|
||||
std::string err_msg = e.what();
|
||||
EXPECT_TRUE(err_msg.find("Expected false, but it's not satisfied.") !=
|
||||
std::string::npos);
|
||||
#if _WIN32
|
||||
EXPECT_TRUE(err_msg.find("tests\\custom_op\\test_check_error.cc") !=
|
||||
std::string::npos);
|
||||
#else
|
||||
EXPECT_TRUE(
|
||||
err_msg.find(
|
||||
"python/paddle/fluid/tests/custom_op/test_check_error.cc") !=
|
||||
std::string::npos);
|
||||
#endif
|
||||
}
|
||||
EXPECT_TRUE(caught_exception);
|
||||
|
||||
caught_exception = false;
|
||||
try {
|
||||
PD_CHECK(false,
|
||||
"PD_CHECK returns ",
|
||||
false,
|
||||
". DataType of ",
|
||||
1,
|
||||
" is INT. ",
|
||||
"DataType of ",
|
||||
0.23,
|
||||
" is FLOAT. ");
|
||||
} catch (const std::exception& e) {
|
||||
caught_exception = true;
|
||||
std::string err_msg = e.what();
|
||||
EXPECT_TRUE(err_msg.find("PD_CHECK returns 0. DataType of 1 is INT. ") !=
|
||||
std::string::npos);
|
||||
#if _WIN32
|
||||
EXPECT_TRUE(err_msg.find("tests\\custom_op\\test_check_error.cc") !=
|
||||
std::string::npos);
|
||||
#else
|
||||
EXPECT_TRUE(
|
||||
err_msg.find(
|
||||
"python/paddle/fluid/tests/custom_op/test_check_error.cc") !=
|
||||
std::string::npos);
|
||||
#endif
|
||||
}
|
||||
EXPECT_TRUE(caught_exception);
|
||||
|
||||
const size_t a = 1;
|
||||
const size_t b = 10;
|
||||
caught_exception = false;
|
||||
try {
|
||||
PD_CHECK(a > b);
|
||||
} catch (const std::exception& e) {
|
||||
caught_exception = true;
|
||||
std::string err_msg = e.what();
|
||||
EXPECT_TRUE(err_msg.find("Expected a > b, but it's not satisfied.") !=
|
||||
std::string::npos);
|
||||
#if _WIN32
|
||||
EXPECT_TRUE(err_msg.find("tests\\custom_op\\test_check_error.cc") !=
|
||||
std::string::npos);
|
||||
#else
|
||||
EXPECT_TRUE(
|
||||
err_msg.find(
|
||||
"python/paddle/fluid/tests/custom_op/test_check_error.cc") !=
|
||||
std::string::npos);
|
||||
#endif
|
||||
}
|
||||
EXPECT_TRUE(caught_exception);
|
||||
|
||||
const size_t c = 123;
|
||||
const float d = 0.345;
|
||||
caught_exception = false;
|
||||
try {
|
||||
PD_CHECK(c < d, "PD_CHECK returns ", false, ", because ", c, " > ", d);
|
||||
} catch (const std::exception& e) {
|
||||
caught_exception = true;
|
||||
std::string err_msg = e.what();
|
||||
EXPECT_TRUE(err_msg.find("PD_CHECK returns 0, because 123 > 0.345") !=
|
||||
std::string::npos);
|
||||
#if _WIN32
|
||||
EXPECT_TRUE(err_msg.find("tests\\custom_op\\test_check_error.cc") !=
|
||||
std::string::npos);
|
||||
#else
|
||||
EXPECT_TRUE(
|
||||
err_msg.find(
|
||||
"python/paddle/fluid/tests/custom_op/test_check_error.cc") !=
|
||||
std::string::npos);
|
||||
#endif
|
||||
}
|
||||
EXPECT_TRUE(caught_exception);
|
||||
}
|
||||
Loading…
Reference in new issue