enforce.h 11.0 KB
Newer Older
1
/* Copyright (c) 2016 PaddlePaddle Authors. All Rights Reserved.
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16

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

17 18 19 20 21 22 23 24 25 26 27 28
#ifdef __GNUC__
#include <cxxabi.h>  // for __cxa_demangle
#endif               // __GNUC__

#ifdef PADDLE_WITH_CUDA
#include <cublas_v2.h>
#include <cudnn.h>
#include <curand.h>
#include <thrust/system/cuda/error.h>
#include <thrust/system_error.h>
#endif  // PADDLE_WITH_CUDA

Y
Yu Yang 已提交
29
#include <iomanip>
L
liaogang 已提交
30
#include <memory>
31 32 33
#include <sstream>
#include <stdexcept>
#include <string>
34

35
#include "glog/logging.h"
Y
Yi Wang 已提交
36
#include "paddle/fluid/platform/macros.h"
D
dzhwinter 已提交
37
#include "paddle/fluid/platform/port.h"
38 39
#include "paddle/fluid/string/printf.h"
#include "paddle/fluid/string/to_string.h"
40

41
#ifdef PADDLE_WITH_CUDA
Y
Yi Wang 已提交
42 43 44
#include "paddle/fluid/platform/dynload/cublas.h"
#include "paddle/fluid/platform/dynload/cudnn.h"
#include "paddle/fluid/platform/dynload/curand.h"
D
dzhwinter 已提交
45
#if !defined(__APPLE__) && !defined(_WIN32)
Y
Yi Wang 已提交
46
#include "paddle/fluid/platform/dynload/nccl.h"
Y
Yi Wang 已提交
47 48
#endif  // __APPLE__
#endif  // PADDLE_WITH_CUDA
49 50 51 52

namespace paddle {
namespace platform {

L
liaogang 已提交
53 54 55 56 57 58 59 60 61 62 63
#ifdef __GNUC__
inline std::string demangle(std::string name) {
  int status = -4;  // some arbitrary value to eliminate the compiler warning
  std::unique_ptr<char, void (*)(void*)> res{
      abi::__cxa_demangle(name.c_str(), NULL, NULL, &status), std::free};
  return (status == 0) ? res.get() : name;
}
#else
inline std::string demangle(std::string name) { return name; }
#endif

64 65
struct EnforceNotMet : public std::exception {
  std::string err_str_;
Y
Yu Yang 已提交
66
  EnforceNotMet(std::exception_ptr e, const char* f, int l) {
67
    try {
Y
Yu Yang 已提交
68 69 70 71 72
      std::rethrow_exception(e);
    } catch (std::exception& e) {
      Init(e.what(), f, l);
    }
  }
73

S
sneaxiy 已提交
74 75
  EnforceNotMet(const std::string& str, const char* f, int l) {
    Init(str, f, l);
Y
Yu Yang 已提交
76 77 78
  }

  const char* what() const noexcept override { return err_str_.c_str(); }
79

Y
Yu Yang 已提交
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
 private:
  template <typename StrType>
  inline void Init(StrType what, const char* f, int l) {
    static constexpr int TRACE_STACK_LIMIT = 100;
    std::ostringstream sout;

    sout << string::Sprintf("%s at [%s:%d]", what, f, l) << std::endl;
    sout << "PaddlePaddle Call Stacks: " << std::endl;
#if !defined(_WIN32)
    void* call_stack[TRACE_STACK_LIMIT];
    auto size = backtrace(call_stack, TRACE_STACK_LIMIT);
    auto symbols = backtrace_symbols(call_stack, size);
    Dl_info info;
    for (int i = 0; i < size; ++i) {
      if (dladdr(call_stack[i], &info) && info.dli_sname) {
        auto demangled = demangle(info.dli_sname);
        auto addr_offset = static_cast<char*>(call_stack[i]) -
                           static_cast<char*>(info.dli_saddr);
        sout << string::Sprintf("%-3d %*0p %s + %zd\n", i,
                                2 + sizeof(void*) * 2, call_stack[i], demangled,
                                addr_offset);
      } else {
        sout << string::Sprintf("%-3d %*0p\n", i, 2 + sizeof(void*) * 2,
                                call_stack[i]);
Y
Yu Yang 已提交
104
      }
Y
Yu Yang 已提交
105 106
    }
    free(symbols);
D
dzhwinter 已提交
107
#else
Y
Yu Yang 已提交
108
    sout << "Windows not support stack backtrace yet.";
D
dzhwinter 已提交
109
#endif
Y
Yu Yang 已提交
110
    err_str_ = sout.str();
111 112 113
  }
};

114 115 116
struct EOFException : public std::exception {
  std::string err_str_;
  EOFException(const char* err_msg, const char* f, int l) {
F
fengjiayi 已提交
117
    err_str_ = string::Sprintf("%s at [%s:%d]", err_msg, f, l);
118 119 120 121 122
  }

  const char* what() const noexcept { return err_str_.c_str(); }
};

L
liaogang 已提交
123 124 125 126 127
// Because most enforce conditions would evaluate to true, we can use
// __builtin_expect to instruct the C++ compiler to generate code that
// always forces branch prediction of true.
// This generates faster binary code. __builtin_expect is since C++11.
// For more details, please check https://stackoverflow.com/a/43870188/724872.
D
dzhwinter 已提交
128
#if !defined(_WIN32)
129
#define UNLIKELY(condition) __builtin_expect(static_cast<bool>(condition), 0)
D
dzhwinter 已提交
130 131
#else
// there is no equivalent intrinsics in msvc.
W
wopeizl 已提交
132
#define UNLIKELY(condition) (condition)
D
dzhwinter 已提交
133
#endif
134

135 136 137 138
#if !defined(_WIN32)
#define LIKELY(condition) __builtin_expect(static_cast<bool>(condition), 1)
#else
// there is no equivalent intrinsics in msvc.
W
wopeizl 已提交
139
#define LIKELY(condition) (condition)
140 141
#endif

M
minqiyang 已提交
142 143
inline bool is_error(bool stat) { return !stat; }

S
sneaxiy 已提交
144
inline void throw_on_error(bool stat, const std::string& msg) {
145
#ifndef REPLACE_ENFORCE_GLOG
S
sneaxiy 已提交
146
  throw std::runtime_error(msg);
147
#else
S
sneaxiy 已提交
148
  LOG(FATAL) << msg;
149
#endif
L
liaogang 已提交
150 151
}

152
#ifdef PADDLE_WITH_CUDA
153

S
sneaxiy 已提交
154
inline bool is_error(cudaError_t e) { return e != cudaSuccess; }
M
minqiyang 已提交
155

S
sneaxiy 已提交
156
inline void throw_on_error(cudaError_t e, const std::string& msg) {
157
#ifndef REPLACE_ENFORCE_GLOG
S
sneaxiy 已提交
158
  throw thrust::system_error(e, thrust::cuda_category(), msg);
159
#else
S
sneaxiy 已提交
160
  LOG(FATAL) << msg;
161
#endif
M
minqiyang 已提交
162 163 164 165
}

inline bool is_error(curandStatus_t stat) {
  return stat != CURAND_STATUS_SUCCESS;
166 167
}

S
sneaxiy 已提交
168
inline void throw_on_error(curandStatus_t stat, const std::string& msg) {
169
#ifndef REPLACE_ENFORCE_GLOG
M
minqiyang 已提交
170
  throw thrust::system_error(cudaErrorLaunchFailure, thrust::cuda_category(),
S
sneaxiy 已提交
171
                             msg);
172
#else
S
sneaxiy 已提交
173
  LOG(FATAL) << msg;
174
#endif
M
minqiyang 已提交
175 176 177 178
}

inline bool is_error(cudnnStatus_t stat) {
  return stat != CUDNN_STATUS_SUCCESS;
179 180
}

S
sneaxiy 已提交
181
inline void throw_on_error(cudnnStatus_t stat, const std::string& msg) {
182
#ifndef REPLACE_ENFORCE_GLOG
S
sneaxiy 已提交
183
  throw std::runtime_error(platform::dynload::cudnnGetErrorString(stat) + msg);
184
#else
S
sneaxiy 已提交
185
  LOG(FATAL) << platform::dynload::cudnnGetErrorString(stat) << msg;
186
#endif
M
minqiyang 已提交
187 188 189 190
}

inline bool is_error(cublasStatus_t stat) {
  return stat != CUBLAS_STATUS_SUCCESS;
191 192
}

S
sneaxiy 已提交
193
inline void throw_on_error(cublasStatus_t stat, const std::string& msg) {
L
liaogang 已提交
194
  std::string err;
M
minqiyang 已提交
195
  if (stat == CUBLAS_STATUS_NOT_INITIALIZED) {
L
liaogang 已提交
196
    err = "CUBLAS: not initialized, ";
197
  } else if (stat == CUBLAS_STATUS_ALLOC_FAILED) {
L
liaogang 已提交
198
    err = "CUBLAS: alloc failed, ";
199
  } else if (stat == CUBLAS_STATUS_INVALID_VALUE) {
L
liaogang 已提交
200
    err = "CUBLAS: invalid value, ";
201
  } else if (stat == CUBLAS_STATUS_ARCH_MISMATCH) {
L
liaogang 已提交
202
    err = "CUBLAS: arch mismatch, ";
203
  } else if (stat == CUBLAS_STATUS_MAPPING_ERROR) {
L
liaogang 已提交
204
    err = "CUBLAS: mapping error, ";
205
  } else if (stat == CUBLAS_STATUS_EXECUTION_FAILED) {
L
liaogang 已提交
206
    err = "CUBLAS: execution failed, ";
207
  } else if (stat == CUBLAS_STATUS_INTERNAL_ERROR) {
L
liaogang 已提交
208
    err = "CUBLAS: internal error, ";
209
  } else if (stat == CUBLAS_STATUS_NOT_SUPPORTED) {
L
liaogang 已提交
210
    err = "CUBLAS: not supported, ";
211
  } else if (stat == CUBLAS_STATUS_LICENSE_ERROR) {
L
liaogang 已提交
212
    err = "CUBLAS: license error, ";
213
  }
214
#ifndef REPLACE_ENFORCE_GLOG
S
sneaxiy 已提交
215
  throw std::runtime_error(err + msg);
216
#else
S
sneaxiy 已提交
217
  LOG(FATAL) << err << msg;
218
#endif
219 220
}

D
done  
dzhwinter 已提交
221
#if !defined(__APPLE__) && !defined(_WIN32)
S
sneaxiy 已提交
222 223 224 225 226
inline bool is_error(ncclResult_t nccl_result) {
  return nccl_result != ncclSuccess;
}

inline void throw_on_error(ncclResult_t stat, const std::string& msg) {
227
#ifndef REPLACE_ENFORCE_GLOG
S
sneaxiy 已提交
228
  throw std::runtime_error(platform::dynload::ncclGetErrorString(stat) + msg);
229
#else
S
sneaxiy 已提交
230
  LOG(FATAL) << platform::dynload::ncclGetErrorString(stat) << msg;
231
#endif
Y
Yu Yang 已提交
232
}
D
dzhwinter 已提交
233
#endif  // __APPLE__ and windows
234
#endif  // PADDLE_WITH_CUDA
235

S
sneaxiy 已提交
236 237 238 239 240
#define PADDLE_THROW(...)                                            \
  do {                                                               \
    throw ::paddle::platform::EnforceNotMet(                         \
        ::paddle::string::Sprintf(__VA_ARGS__), __FILE__, __LINE__); \
  } while (0)
S
sneaxiy 已提交
241 242 243 244 245 246 247 248 249 250 251 252 253

#define PADDLE_ENFORCE(COND, ...)                                         \
  do {                                                                    \
    auto __cond__ = (COND);                                               \
    if (UNLIKELY(::paddle::platform::is_error(__cond__))) {               \
      try {                                                               \
        ::paddle::platform::throw_on_error(                               \
            __cond__, ::paddle::string::Sprintf(__VA_ARGS__));            \
      } catch (...) {                                                     \
        throw ::paddle::platform::EnforceNotMet(std::current_exception(), \
                                                __FILE__, __LINE__);      \
      }                                                                   \
    }                                                                     \
M
minqiyang 已提交
254
  } while (0)
M
minqiyang 已提交
255

D
dzhwinter 已提交
256 257 258 259 260 261
#define PADDLE_THROW_EOF()                                                     \
  do {                                                                         \
    throw ::paddle::platform::EOFException("There is no next data.", __FILE__, \
                                           __LINE__);                          \
  } while (false)

S
Superjom 已提交
262 263 264 265 266 267 268
/*
 * Some enforce helpers here, usage:
 *    int a = 1;
 *    int b = 2;
 *    PADDLE_ENFORCE_EQ(a, b);
 *
 *    will raise an expression described as follows:
C
chenweihang 已提交
269
 *    "Enforce failed. Expected input a == b, but received a(1) != b(2)."
270
 *      with detailed stack information.
S
Superjom 已提交
271 272 273 274
 *
 *    extra messages is also supported, for example:
 *    PADDLE_ENFORCE(a, b, "some simple enforce failed between %d numbers", 2)
 */
S
sneaxiy 已提交
275 276 277 278 279 280
#define PADDLE_ENFORCE_NOT_NULL(__VAL, ...)                 \
  do {                                                      \
    if (UNLIKELY(nullptr == (__VAL))) {                     \
      PADDLE_THROW(#__VAL " should not be null\n%s",        \
                   ::paddle::string::Sprintf(__VA_ARGS__)); \
    }                                                       \
281 282 283 284
  } while (0)

#define __PADDLE_BINARY_COMPARE(__VAL0, __VAL1, __CMP, __INV_CMP, ...)  \
  do {                                                                  \
S
sneaxiy 已提交
285 286 287
    auto __cond1__ = (__VAL0);                                          \
    auto __cond2__ = (__VAL1);                                          \
    if (UNLIKELY(!((__cond1__)__CMP(__cond2__)))) {                     \
C
chenweihang 已提交
288
      PADDLE_THROW("Enforce failed. Expected %s " #__CMP                \
289 290
                   " %s, but received %s:%s " #__INV_CMP " %s:%s.\n%s", \
                   #__VAL0, #__VAL1, #__VAL0,                           \
S
sneaxiy 已提交
291 292 293
                   ::paddle::string::to_string(__cond1__), #__VAL1,     \
                   ::paddle::string::to_string(__cond2__),              \
                   ::paddle::string::Sprintf(__VA_ARGS__));             \
294 295
    }                                                                   \
  } while (0)
W
wopeizl 已提交
296 297 298 299 300 301 302 303 304 305 306 307 308

#define PADDLE_ENFORCE_EQ(__VAL0, __VAL1, ...) \
  __PADDLE_BINARY_COMPARE(__VAL0, __VAL1, ==, !=, __VA_ARGS__)
#define PADDLE_ENFORCE_NE(__VAL0, __VAL1, ...) \
  __PADDLE_BINARY_COMPARE(__VAL0, __VAL1, !=, ==, __VA_ARGS__)
#define PADDLE_ENFORCE_GT(__VAL0, __VAL1, ...) \
  __PADDLE_BINARY_COMPARE(__VAL0, __VAL1, >, <=, __VA_ARGS__)
#define PADDLE_ENFORCE_GE(__VAL0, __VAL1, ...) \
  __PADDLE_BINARY_COMPARE(__VAL0, __VAL1, >=, <, __VA_ARGS__)
#define PADDLE_ENFORCE_LT(__VAL0, __VAL1, ...) \
  __PADDLE_BINARY_COMPARE(__VAL0, __VAL1, <, >=, __VA_ARGS__)
#define PADDLE_ENFORCE_LE(__VAL0, __VAL1, ...) \
  __PADDLE_BINARY_COMPARE(__VAL0, __VAL1, <=, >, __VA_ARGS__)
S
add EQ  
Superjom 已提交
309

310 311
}  // namespace platform
}  // namespace paddle