You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
146 lines
3.5 KiB
146 lines
3.5 KiB
/* Copyright (c) 2016 PaddlePaddle Authors. All Rights Reserve.
|
|
|
|
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 <glog/logging.h>
|
|
#include <stdarg.h>
|
|
#include <stdio.h>
|
|
#include <memory>
|
|
#include <string>
|
|
|
|
/**
|
|
* __must_check macro. It make the function's return value must be used,
|
|
* otherwise it will raise a compile warning. And also Paddle treat all compile
|
|
* warnings as errors.
|
|
*/
|
|
#ifdef __GNUC__
|
|
#if (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__) >= 30400
|
|
#define __must_check __attribute__((warn_unused_result))
|
|
#else
|
|
#define __must_check
|
|
#endif
|
|
#else
|
|
#define __must_check
|
|
#endif
|
|
|
|
namespace paddle {
|
|
|
|
/**
|
|
* Error is Paddle error code. It only contain a std::string as error message.
|
|
*
|
|
*
|
|
* There are two styles to return error in Paddle.
|
|
*
|
|
* 1. Return Error
|
|
* When method return a status, the return must use `__must_check` attribute.
|
|
* Example as below.
|
|
* @code{cpp}
|
|
* Error __must_check foo();
|
|
*
|
|
* Error __must_check bar() {
|
|
* // do something.
|
|
* Error err = foo(); // invoke other method return status.
|
|
* if (err) return err;
|
|
* // do something else.
|
|
* return Error();
|
|
* }
|
|
* @endcode{cpp}
|
|
*
|
|
* 2. Return by parameter.
|
|
* It is another way to return an error, by using a pointer parameter.
|
|
* Example as below.
|
|
*
|
|
* @code{cpp}
|
|
* Error bar();
|
|
*
|
|
* int foo(Error* error) {
|
|
* // Do something.
|
|
* Error err = bar();
|
|
* if (err) {
|
|
* *error = s;
|
|
* return 0;
|
|
* }
|
|
* // Do something else.
|
|
* if (someInternalErrorHappend) {
|
|
* *error = Error("Some dimension is too large, %d", dimension);
|
|
* return 0;
|
|
* }
|
|
* // End of method.
|
|
* return someValue;
|
|
* }
|
|
*
|
|
* Error foobar() {
|
|
* Error err;
|
|
* // do something.
|
|
* foo(&err);
|
|
* if (err) return err;
|
|
* }
|
|
* @endcode{cpp}
|
|
*
|
|
*
|
|
* Currently there is a helper method 'check' in status, because Paddle always
|
|
* use log(FATAL) or CHECK to make program exit before. When we clean all
|
|
* log(FATAL) and CHECK in Paddle, 'check' method will be removed.
|
|
*/
|
|
class Error {
|
|
public:
|
|
/**
|
|
* Construct a no-error value.
|
|
*/
|
|
Error() {}
|
|
|
|
/**
|
|
* @brief Create an Error use printf syntax.
|
|
*/
|
|
explicit Error(const char* fmt, ...) {
|
|
va_list ap;
|
|
va_start(ap, fmt);
|
|
constexpr size_t kBufferSize = 1024;
|
|
char buffer[kBufferSize];
|
|
vsnprintf(buffer, kBufferSize, fmt, ap);
|
|
this->msg_.reset(new std::string(buffer));
|
|
va_end(ap);
|
|
}
|
|
|
|
/**
|
|
* @brief msg will return the error message. If no error, return nullptr.
|
|
*/
|
|
const char* msg() const {
|
|
if (msg_) {
|
|
return msg_->c_str();
|
|
} else {
|
|
return nullptr;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @brief check this status by glog.
|
|
* @note It is a temp method used during cleaning Paddle code. It will be
|
|
* removed later.
|
|
*/
|
|
void check() const { CHECK(this->isOK()) << msg(); }
|
|
|
|
/**
|
|
* @brief isOK return True if there is no error.
|
|
* @return True if no error.
|
|
*/
|
|
bool isOK() const { return msg_ == nullptr; }
|
|
|
|
private:
|
|
std::shared_ptr<std::string> msg_;
|
|
};
|
|
|
|
} // namespace paddle
|