enforce.h 11.9 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

Y
Yu Yang 已提交
74 75 76 77 78 79
  template <typename... ARGS>
  EnforceNotMet(const char* f, int l, ARGS... args) {
    Init(string::Sprintf(args...), f, l);
  }

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

Y
Yu Yang 已提交
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
 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 已提交
105
      }
Y
Yu Yang 已提交
106 107
    }
    free(symbols);
D
dzhwinter 已提交
108
#else
Y
Yu Yang 已提交
109
    sout << "Windows not support stack backtrace yet.";
D
dzhwinter 已提交
110
#endif
Y
Yu Yang 已提交
111
    err_str_ = sout.str();
112 113 114
  }
};

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

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

L
liaogang 已提交
124 125 126 127 128
// 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 已提交
129
#if !defined(_WIN32)
130
#define UNLIKELY(condition) __builtin_expect(static_cast<bool>(condition), 0)
D
dzhwinter 已提交
131 132
#else
// there is no equivalent intrinsics in msvc.
W
wopeizl 已提交
133
#define UNLIKELY(condition) (condition)
D
dzhwinter 已提交
134
#endif
135

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

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

L
liaogang 已提交
145 146
template <typename... Args>
inline typename std::enable_if<sizeof...(Args) != 0, void>::type throw_on_error(
Y
Yu Yang 已提交
147
    bool stat, const Args&... args) {
148
#ifndef REPLACE_ENFORCE_GLOG
M
minqiyang 已提交
149
  throw std::runtime_error(string::Sprintf(args...));
150
#else
M
minqiyang 已提交
151
  LOG(FATAL) << string::Sprintf(args...);
152
#endif
L
liaogang 已提交
153 154
}

155
#ifdef PADDLE_WITH_CUDA
156

M
minqiyang 已提交
157 158
inline bool is_error(cudaError_t e) { return UNLIKELY(e); }

159
template <typename... Args>
L
liaogang 已提交
160 161
inline typename std::enable_if<sizeof...(Args) != 0, void>::type throw_on_error(
    cudaError_t e, const Args&... args) {
162
#ifndef REPLACE_ENFORCE_GLOG
M
minqiyang 已提交
163 164
  throw thrust::system_error(e, thrust::cuda_category(),
                             string::Sprintf(args...));
165
#else
M
minqiyang 已提交
166
  LOG(FATAL) << string::Sprintf(args...);
167
#endif
M
minqiyang 已提交
168 169 170 171
}

inline bool is_error(curandStatus_t stat) {
  return stat != CURAND_STATUS_SUCCESS;
172 173 174
}

template <typename... Args>
L
liaogang 已提交
175 176
inline typename std::enable_if<sizeof...(Args) != 0, void>::type throw_on_error(
    curandStatus_t stat, const Args&... args) {
177
#ifndef REPLACE_ENFORCE_GLOG
M
minqiyang 已提交
178 179
  throw thrust::system_error(cudaErrorLaunchFailure, thrust::cuda_category(),
                             string::Sprintf(args...));
180
#else
M
minqiyang 已提交
181
  LOG(FATAL) << string::Sprintf(args...);
182
#endif
M
minqiyang 已提交
183 184 185 186
}

inline bool is_error(cudnnStatus_t stat) {
  return stat != CUDNN_STATUS_SUCCESS;
187 188 189
}

template <typename... Args>
L
liaogang 已提交
190 191
inline typename std::enable_if<sizeof...(Args) != 0, void>::type throw_on_error(
    cudnnStatus_t stat, const Args&... args) {
192
#ifndef REPLACE_ENFORCE_GLOG
M
minqiyang 已提交
193 194
  throw std::runtime_error(platform::dynload::cudnnGetErrorString(stat) +
                           string::Sprintf(args...));
195
#else
M
minqiyang 已提交
196
  LOG(FATAL) << string::Sprintf(args...);
197
#endif
M
minqiyang 已提交
198 199 200 201
}

inline bool is_error(cublasStatus_t stat) {
  return stat != CUBLAS_STATUS_SUCCESS;
202 203 204
}

template <typename... Args>
L
liaogang 已提交
205 206
inline typename std::enable_if<sizeof...(Args) != 0, void>::type throw_on_error(
    cublasStatus_t stat, const Args&... args) {
L
liaogang 已提交
207
  std::string err;
M
minqiyang 已提交
208
  if (stat == CUBLAS_STATUS_NOT_INITIALIZED) {
L
liaogang 已提交
209
    err = "CUBLAS: not initialized, ";
210
  } else if (stat == CUBLAS_STATUS_ALLOC_FAILED) {
L
liaogang 已提交
211
    err = "CUBLAS: alloc failed, ";
212
  } else if (stat == CUBLAS_STATUS_INVALID_VALUE) {
L
liaogang 已提交
213
    err = "CUBLAS: invalid value, ";
214
  } else if (stat == CUBLAS_STATUS_ARCH_MISMATCH) {
L
liaogang 已提交
215
    err = "CUBLAS: arch mismatch, ";
216
  } else if (stat == CUBLAS_STATUS_MAPPING_ERROR) {
L
liaogang 已提交
217
    err = "CUBLAS: mapping error, ";
218
  } else if (stat == CUBLAS_STATUS_EXECUTION_FAILED) {
L
liaogang 已提交
219
    err = "CUBLAS: execution failed, ";
220
  } else if (stat == CUBLAS_STATUS_INTERNAL_ERROR) {
L
liaogang 已提交
221
    err = "CUBLAS: internal error, ";
222
  } else if (stat == CUBLAS_STATUS_NOT_SUPPORTED) {
L
liaogang 已提交
223
    err = "CUBLAS: not supported, ";
224
  } else if (stat == CUBLAS_STATUS_LICENSE_ERROR) {
L
liaogang 已提交
225
    err = "CUBLAS: license error, ";
226
  }
227
#ifndef REPLACE_ENFORCE_GLOG
228
  throw std::runtime_error(err + string::Sprintf(args...));
229 230 231
#else
  LOG(FATAL) << err << string::Sprintf(args...);
#endif
232 233
}

D
done  
dzhwinter 已提交
234
#if !defined(__APPLE__) && !defined(_WIN32)
Y
Yu Yang 已提交
235 236 237 238 239 240
template <typename... Args>
inline typename std::enable_if<sizeof...(Args) != 0, void>::type throw_on_error(
    ncclResult_t stat, const Args&... args) {
  if (stat == ncclSuccess) {
    return;
  } else {
241
#ifndef REPLACE_ENFORCE_GLOG
Y
Yu Yang 已提交
242 243
    throw std::runtime_error(platform::dynload::ncclGetErrorString(stat) +
                             string::Sprintf(args...));
244 245 246 247
#else
    LOG(FATAL) << platform::dynload::ncclGetErrorString(stat)
               << string::Sprintf(args...);
#endif
Y
Yu Yang 已提交
248 249
  }
}
D
dzhwinter 已提交
250
#endif  // __APPLE__ and windows
251
#endif  // PADDLE_WITH_CUDA
252

L
liaogang 已提交
253 254 255 256 257
template <typename T>
inline void throw_on_error(T e) {
  throw_on_error(e, "");
}

Y
Yu Yang 已提交
258 259
#define PADDLE_THROW(...) \
  throw ::paddle::platform::EnforceNotMet(__FILE__, __LINE__, __VA_ARGS__)
L
liaogang 已提交
260

M
minqiyang 已提交
261 262
#define PADDLE_JUDGE

M
minqiyang 已提交
263 264 265 266 267 268 269
#define __PADDLE_UNARY_COMPARE(COND, ...)                        \
  do {                                                           \
    auto __cond = COND;                                          \
    if (UNLIKELY(::paddle::platform::is_error(__cond))) {        \
      ::paddle::platform::throw_on_error(__cond, ##__VA_ARGS__); \
    }                                                            \
  } while (0)  // NOLINT
M
minqiyang 已提交
270

271
#ifndef REPLACE_ENFORCE_GLOG
M
minqiyang 已提交
272
#define PADDLE_ENFORCE(COND, ...)                                       \
273 274
  do {                                                                  \
    try {                                                               \
M
minqiyang 已提交
275
      __PADDLE_UNARY_COMPARE(COND, ##__VA_ARGS__);                      \
276 277 278 279
    } catch (...) {                                                     \
      throw ::paddle::platform::EnforceNotMet(std::current_exception(), \
                                              __FILE__, __LINE__);      \
    }                                                                   \
M
minqiyang 已提交
280
  } while (0)  // NOLINT
281

D
dzhwinter 已提交
282
#else
M
minqiyang 已提交
283
#define PADDLE_ENFORCE(COND, ...) __PADDLE_UNARY_COMPARE(COND, ##__VA_ARGS__);
D
dzhwinter 已提交
284 285
#endif  // REPLACE_ENFORCE_GLOG

D
dzhwinter 已提交
286 287 288 289 290 291
#define PADDLE_THROW_EOF()                                                     \
  do {                                                                         \
    throw ::paddle::platform::EOFException("There is no next data.", __FILE__, \
                                           __LINE__);                          \
  } while (false)

S
Superjom 已提交
292 293 294 295 296 297 298
/*
 * 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 已提交
299
 *    "Enforce failed. Expected input a == b, but received a(1) != b(2)."
300
 *      with detailed stack information.
S
Superjom 已提交
301 302 303 304
 *
 *    extra messages is also supported, for example:
 *    PADDLE_ENFORCE(a, b, "some simple enforce failed between %d numbers", 2)
 */
305 306 307 308 309 310 311 312 313 314
#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__)); \
    }                                                        \
  } while (0)

#define __PADDLE_BINARY_COMPARE(__VAL0, __VAL1, __CMP, __INV_CMP, ...)  \
  do {                                                                  \
C
chengduo 已提交
315
    if (UNLIKELY(!((__VAL0)__CMP(__VAL1)))) {                           \
C
chenweihang 已提交
316
      PADDLE_THROW("Enforce failed. Expected %s " #__CMP                \
317 318 319
                   " %s, but received %s:%s " #__INV_CMP " %s:%s.\n%s", \
                   #__VAL0, #__VAL1, #__VAL0,                           \
                   paddle::string::to_string(__VAL0), #__VAL1,          \
320 321 322 323
                   paddle::string::to_string(__VAL1),                   \
                   paddle::string::Sprintf("" __VA_ARGS__));            \
    }                                                                   \
  } while (0)
W
wopeizl 已提交
324 325 326 327 328 329 330 331 332 333 334 335 336

#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 已提交
337

338 339
}  // namespace platform
}  // namespace paddle