Merge branch 'develop' of https://github.com/PaddlePaddle/Paddle into pad_op
dangqingqing
8 years ago
commit
f56084b451
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,33 @@
|
||||
/* Copyright (c) 2016 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
|
||||
/**
|
||||
* This header defines some useful attribute by each compiler. It is the
|
||||
* abstract layer of compilers.
|
||||
*/
|
||||
#ifdef __GNUC__
|
||||
#define GCC_VERSION \
|
||||
(__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__)
|
||||
#else
|
||||
#define GCC_VERSION
|
||||
#endif
|
||||
|
||||
/**
|
||||
* __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.
|
||||
*/
|
||||
#if GCC_VERSION >= 30400
|
||||
#define __must_check __attribute__((warn_unused_result))
|
||||
#else
|
||||
#define __must_check
|
||||
#endif
|
||||
@ -0,0 +1,130 @@
|
||||
/* 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>
|
||||
#include "Compiler.h"
|
||||
|
||||
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.
|
||||
* Status s = foo(); // invoke other method return status.
|
||||
* if (!s) return s;
|
||||
* // do something else.
|
||||
* return Status();
|
||||
* }
|
||||
* @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 s = bar();
|
||||
* if (!s) {
|
||||
* *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 s;
|
||||
* // do something.
|
||||
* foo(&s);
|
||||
* if (!s) return s;
|
||||
* }
|
||||
* @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 operator bool, return True if there is no error.
|
||||
*/
|
||||
operator bool() const { return msg_ == 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) << msg(); }
|
||||
|
||||
private:
|
||||
std::shared_ptr<std::string> msg_;
|
||||
};
|
||||
|
||||
} // namespace paddle
|
||||
@ -0,0 +1,34 @@
|
||||
/* 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. */
|
||||
|
||||
#include "paddle/utils/Error.h"
|
||||
|
||||
#include <gtest/gtest.h>
|
||||
|
||||
TEST(Error, testAll) {
|
||||
paddle::Error error;
|
||||
ASSERT_TRUE(error);
|
||||
error = paddle::Error("I'm the error");
|
||||
ASSERT_FALSE(error);
|
||||
ASSERT_STREQ("I'm the error", error.msg());
|
||||
|
||||
error = paddle::Error("error2");
|
||||
ASSERT_FALSE(error);
|
||||
ASSERT_STREQ("error2", error.msg());
|
||||
|
||||
int i = 3;
|
||||
auto error3 = paddle::Error("error%d", i);
|
||||
ASSERT_FALSE(error3);
|
||||
ASSERT_STREQ("error3", error3.msg());
|
||||
}
|
||||
Loading…
Reference in new issue