Skip to content

Commit

Permalink
Adding platform/must_check.h
Browse files Browse the repository at this point in the history
__must_check is a macro mark of function return value. It let developer
must check the return value is legal or not.
  • Loading branch information
reyoung committed Jun 26, 2017
1 parent a405e60 commit d76d2fe
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 13 deletions.
1 change: 1 addition & 0 deletions paddle/platform/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@ nv_test(cuda_test SRCS cuda_test.cu)

cc_library(place SRCS place.cc)
cc_test(place_test SRCS place_test.cc DEPS place glog gflags)
cc_test(must_check_test SRCS must_check_test.cc)
17 changes: 5 additions & 12 deletions paddle/utils/Compiler.h → paddle/platform/must_check.h
Original file line number Diff line number Diff line change
Expand Up @@ -10,24 +10,17 @@ 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
#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
10 changes: 10 additions & 0 deletions paddle/platform/must_check_test.cc
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
#include <gtest/gtest.h>
#include <paddle/platform/must_check.h>

int __must_check SomeFunctionMustCheck() { return 0; }

TEST(MustCheck, all) {
// This line should not be compiled, because the
// return value of SomeFunctionMustCheck marked as __must_check
// SomeFunctionMustCheck();
}
2 changes: 1 addition & 1 deletion paddle/utils/Error.h
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ limitations under the License. */
#include <stdio.h>
#include <memory>
#include <string>
#include "Compiler.h"
#include "paddle/platform/must_check.h"

namespace paddle {

Expand Down

0 comments on commit d76d2fe

Please sign in to comment.