enforce.h 11.1 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"
D
dlfnh  
dzhwinter 已提交
36
#include "paddle/fluid/platform/port.h"
Y
Yi Wang 已提交
37
#include "paddle/fluid/platform/macros.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__) and !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 66 67
struct EnforceNotMet : public std::exception {
  std::exception_ptr exp_;
  std::string err_str_;
  EnforceNotMet(std::exception_ptr e, const char* f, int l) : exp_(e) {
Y
Yu Yang 已提交
68
    static constexpr int TRACE_STACK_LIMIT = 100;
69 70 71
    try {
      std::rethrow_exception(exp_);
    } catch (const std::exception& exp) {
Y
Yu Yang 已提交
72
      std::ostringstream sout;
73

F
fengjiayi 已提交
74
      sout << string::Sprintf("%s at [%s:%d]", exp.what(), f, l) << std::endl;
75
      sout << "PaddlePaddle Call Stacks: " << std::endl;
D
dzhwinter 已提交
76
#if !defined(_WIN32)
Y
Yu Yang 已提交
77
      void* call_stack[TRACE_STACK_LIMIT];
78 79 80 81 82
      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) {
L
liaogang 已提交
83 84
        if (dladdr(call_stack[i], &info) && info.dli_sname) {
          auto demangled = demangle(info.dli_sname);
85 86 87 88 89
          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);
90
        } else {
91
          sout << string::Sprintf("%-3d %*0p\n", i, 2 + sizeof(void*) * 2,
92 93
                                  call_stack[i]);
        }
Y
Yu Yang 已提交
94
      }
95
      free(symbols);
D
dzhwinter 已提交
96 97 98
#else
      sout << "Windows not support stack backtrace yet.";
#endif
Y
Yu Yang 已提交
99
      err_str_ = sout.str();
100 101 102 103 104 105
    }
  }

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

106 107 108
struct EOFException : public std::exception {
  std::string err_str_;
  EOFException(const char* err_msg, const char* f, int l) {
F
fengjiayi 已提交
109
    err_str_ = string::Sprintf("%s at [%s:%d]", err_msg, f, l);
110 111 112 113 114
  }

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

L
liaogang 已提交
115 116 117 118 119
// 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.
120 121
#define UNLIKELY(condition) __builtin_expect(static_cast<bool>(condition), 0)

L
liaogang 已提交
122 123
template <typename... Args>
inline typename std::enable_if<sizeof...(Args) != 0, void>::type throw_on_error(
Y
Yu Yang 已提交
124
    bool stat, const Args&... args) {
L
liaogang 已提交
125
  if (UNLIKELY(!(stat))) {
126
#ifndef REPLACE_ENFORCE_GLOG
127
    throw std::runtime_error(string::Sprintf(args...));
128 129 130
#else
    LOG(FATAL) << string::Sprintf(args...);
#endif
L
liaogang 已提交
131 132 133
  }
}

134
#ifdef PADDLE_WITH_CUDA
135 136

template <typename... Args>
L
liaogang 已提交
137 138
inline typename std::enable_if<sizeof...(Args) != 0, void>::type throw_on_error(
    cudaError_t e, const Args&... args) {
L
liaogang 已提交
139
  if (UNLIKELY(e)) {
140
#ifndef REPLACE_ENFORCE_GLOG
141 142
    throw thrust::system_error(e, thrust::cuda_category(),
                               string::Sprintf(args...));
143 144 145
#else
    LOG(FATAL) << string::Sprintf(args...);
#endif
146 147 148 149
  }
}

template <typename... Args>
L
liaogang 已提交
150 151
inline typename std::enable_if<sizeof...(Args) != 0, void>::type throw_on_error(
    curandStatus_t stat, const Args&... args) {
152
  if (stat != CURAND_STATUS_SUCCESS) {
153
#ifndef REPLACE_ENFORCE_GLOG
154 155
    throw thrust::system_error(cudaErrorLaunchFailure, thrust::cuda_category(),
                               string::Sprintf(args...));
156 157 158
#else
    LOG(FATAL) << string::Sprintf(args...);
#endif
159 160 161 162
  }
}

template <typename... Args>
L
liaogang 已提交
163 164
inline typename std::enable_if<sizeof...(Args) != 0, void>::type throw_on_error(
    cudnnStatus_t stat, const Args&... args) {
165 166 167
  if (stat == CUDNN_STATUS_SUCCESS) {
    return;
  } else {
168
#ifndef REPLACE_ENFORCE_GLOG
169 170
    throw std::runtime_error(platform::dynload::cudnnGetErrorString(stat) +
                             string::Sprintf(args...));
171 172 173
#else
    LOG(FATAL) << string::Sprintf(args...);
#endif
174 175 176 177
  }
}

template <typename... Args>
L
liaogang 已提交
178 179
inline typename std::enable_if<sizeof...(Args) != 0, void>::type throw_on_error(
    cublasStatus_t stat, const Args&... args) {
L
liaogang 已提交
180
  std::string err;
181 182 183
  if (stat == CUBLAS_STATUS_SUCCESS) {
    return;
  } else if (stat == CUBLAS_STATUS_NOT_INITIALIZED) {
L
liaogang 已提交
184
    err = "CUBLAS: not initialized, ";
185
  } else if (stat == CUBLAS_STATUS_ALLOC_FAILED) {
L
liaogang 已提交
186
    err = "CUBLAS: alloc failed, ";
187
  } else if (stat == CUBLAS_STATUS_INVALID_VALUE) {
L
liaogang 已提交
188
    err = "CUBLAS: invalid value, ";
189
  } else if (stat == CUBLAS_STATUS_ARCH_MISMATCH) {
L
liaogang 已提交
190
    err = "CUBLAS: arch mismatch, ";
191
  } else if (stat == CUBLAS_STATUS_MAPPING_ERROR) {
L
liaogang 已提交
192
    err = "CUBLAS: mapping error, ";
193
  } else if (stat == CUBLAS_STATUS_EXECUTION_FAILED) {
L
liaogang 已提交
194
    err = "CUBLAS: execution failed, ";
195
  } else if (stat == CUBLAS_STATUS_INTERNAL_ERROR) {
L
liaogang 已提交
196
    err = "CUBLAS: internal error, ";
197
  } else if (stat == CUBLAS_STATUS_NOT_SUPPORTED) {
L
liaogang 已提交
198
    err = "CUBLAS: not supported, ";
199
  } else if (stat == CUBLAS_STATUS_LICENSE_ERROR) {
L
liaogang 已提交
200
    err = "CUBLAS: license error, ";
201
  }
202
#ifndef REPLACE_ENFORCE_GLOG
203
  throw std::runtime_error(err + string::Sprintf(args...));
204 205 206
#else
  LOG(FATAL) << err << string::Sprintf(args...);
#endif
207 208
}

D
dzhwinter 已提交
209
#if !defined(__APPLE__) and !defined(_WIN32)
Y
Yu Yang 已提交
210 211 212 213 214 215
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 {
216
#ifndef REPLACE_ENFORCE_GLOG
Y
Yu Yang 已提交
217 218
    throw std::runtime_error(platform::dynload::ncclGetErrorString(stat) +
                             string::Sprintf(args...));
219 220 221 222
#else
    LOG(FATAL) << platform::dynload::ncclGetErrorString(stat)
               << string::Sprintf(args...);
#endif
Y
Yu Yang 已提交
223 224
  }
}
D
dzhwinter 已提交
225
#endif  // __APPLE__ and windows
226
#endif  // PADDLE_WITH_CUDA
227

L
liaogang 已提交
228 229 230 231 232
template <typename T>
inline void throw_on_error(T e) {
  throw_on_error(e, "");
}

Q
qijun 已提交
233 234 235 236 237 238
#define PADDLE_THROW(...)                                              \
  do {                                                                 \
    throw ::paddle::platform::EnforceNotMet(                           \
        std::make_exception_ptr(                                       \
            std::runtime_error(paddle::string::Sprintf(__VA_ARGS__))), \
        __FILE__, __LINE__);                                           \
Y
Yu Yang 已提交
239
  } while (false)
L
liaogang 已提交
240

241
#ifndef REPLACE_ENFORCE_GLOG
242 243 244 245 246 247 248 249
#define PADDLE_ENFORCE(...)                                             \
  do {                                                                  \
    try {                                                               \
      ::paddle::platform::throw_on_error(__VA_ARGS__);                  \
    } catch (...) {                                                     \
      throw ::paddle::platform::EnforceNotMet(std::current_exception(), \
                                              __FILE__, __LINE__);      \
    }                                                                   \
Y
Yu Yang 已提交
250
  } while (false)
251 252 253
#else
#define PADDLE_ENFORCE(...) ::paddle::platform::throw_on_error(__VA_ARGS__);
#endif
254

255 256 257 258 259
#define PADDLE_THROW_EOF()                                                     \
  do {                                                                         \
    throw ::paddle::platform::EOFException("There is no next data.", __FILE__, \
                                           __LINE__);                          \
  } while (false)
S
Superjom 已提交
260 261 262 263 264 265 266
/*
 * 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 已提交
267
 *    "Enforce failed. Expected input a == b, but received a(1) != b(2)."
268
 *      with detailed stack information.
S
Superjom 已提交
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
 *
 *    extra messages is also supported, for example:
 *    PADDLE_ENFORCE(a, b, "some simple enforce failed between %d numbers", 2)
 */

#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__)
286 287 288 289 290 291 292 293 294 295
#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 已提交
296
    if (UNLIKELY(!((__VAL0)__CMP(__VAL1)))) {                           \
C
chenweihang 已提交
297
      PADDLE_THROW("Enforce failed. Expected %s " #__CMP                \
298 299 300
                   " %s, but received %s:%s " #__INV_CMP " %s:%s.\n%s", \
                   #__VAL0, #__VAL1, #__VAL0,                           \
                   paddle::string::to_string(__VAL0), #__VAL1,          \
301 302 303 304
                   paddle::string::to_string(__VAL1),                   \
                   paddle::string::Sprintf("" __VA_ARGS__));            \
    }                                                                   \
  } while (0)
S
add EQ  
Superjom 已提交
305

306 307
}  // namespace platform
}  // namespace paddle