enforce.h 9.4 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
/* 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

17 18
#include <dlfcn.h>     // for dladdr
#include <execinfo.h>  // for backtrace
Y
Yu Yang 已提交
19
#include <iomanip>
L
liaogang 已提交
20
#include <memory>
21 22 23
#include <sstream>
#include <stdexcept>
#include <string>
24

Y
Yi Wang 已提交
25
#include "paddle/fluid/platform/macros.h"
26 27
#include "paddle/fluid/string/printf.h"
#include "paddle/fluid/string/to_string.h"
28

L
liaogang 已提交
29 30 31 32
#ifdef __GNUC__
#include <cxxabi.h>  // for __cxa_demangle
#endif

Y
Yu Yang 已提交
33 34
#include <glog/logging.h>

35
#ifdef PADDLE_WITH_CUDA
36

Y
Yi Wang 已提交
37 38 39 40
#include "paddle/fluid/platform/dynload/cublas.h"
#include "paddle/fluid/platform/dynload/cudnn.h"
#include "paddle/fluid/platform/dynload/curand.h"
#include "paddle/fluid/platform/dynload/nccl.h"
41 42 43 44 45 46 47

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

L
Luo Tao 已提交
48
#endif
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

Y
Yu Yang 已提交
74
      sout << string::Sprintf("%s at [%s:%d]", exp.what(), f, l) << std::endl;
75 76
      sout << "PaddlePaddle Call Stacks: " << std::endl;

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);
Y
Yu Yang 已提交
96
      err_str_ = sout.str();
97 98 99 100 101 102
    }
  }

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

L
liaogang 已提交
103 104 105 106 107
// 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.
108 109
#define UNLIKELY(condition) __builtin_expect(static_cast<bool>(condition), 0)

L
liaogang 已提交
110 111
template <typename... Args>
inline typename std::enable_if<sizeof...(Args) != 0, void>::type throw_on_error(
Y
Yu Yang 已提交
112
    bool stat, const Args&... args) {
L
liaogang 已提交
113
  if (UNLIKELY(!(stat))) {
114
    throw std::runtime_error(string::Sprintf(args...));
L
liaogang 已提交
115 116 117
  }
}

118
#ifdef PADDLE_WITH_CUDA
119 120

template <typename... Args>
L
liaogang 已提交
121 122
inline typename std::enable_if<sizeof...(Args) != 0, void>::type throw_on_error(
    cudaError_t e, const Args&... args) {
L
liaogang 已提交
123
  if (UNLIKELY(e)) {
124 125
    throw thrust::system_error(e, thrust::cuda_category(),
                               string::Sprintf(args...));
126 127 128 129
  }
}

template <typename... Args>
L
liaogang 已提交
130 131
inline typename std::enable_if<sizeof...(Args) != 0, void>::type throw_on_error(
    curandStatus_t stat, const Args&... args) {
132
  if (stat != CURAND_STATUS_SUCCESS) {
133 134
    throw thrust::system_error(cudaErrorLaunchFailure, thrust::cuda_category(),
                               string::Sprintf(args...));
135 136 137 138
  }
}

template <typename... Args>
L
liaogang 已提交
139 140
inline typename std::enable_if<sizeof...(Args) != 0, void>::type throw_on_error(
    cudnnStatus_t stat, const Args&... args) {
141 142 143
  if (stat == CUDNN_STATUS_SUCCESS) {
    return;
  } else {
144 145
    throw std::runtime_error(platform::dynload::cudnnGetErrorString(stat) +
                             string::Sprintf(args...));
146 147 148 149
  }
}

template <typename... Args>
L
liaogang 已提交
150 151
inline typename std::enable_if<sizeof...(Args) != 0, void>::type throw_on_error(
    cublasStatus_t stat, const Args&... args) {
L
liaogang 已提交
152
  std::string err;
153 154 155
  if (stat == CUBLAS_STATUS_SUCCESS) {
    return;
  } else if (stat == CUBLAS_STATUS_NOT_INITIALIZED) {
L
liaogang 已提交
156
    err = "CUBLAS: not initialized, ";
157
  } else if (stat == CUBLAS_STATUS_ALLOC_FAILED) {
L
liaogang 已提交
158
    err = "CUBLAS: alloc failed, ";
159
  } else if (stat == CUBLAS_STATUS_INVALID_VALUE) {
L
liaogang 已提交
160
    err = "CUBLAS: invalid value, ";
161
  } else if (stat == CUBLAS_STATUS_ARCH_MISMATCH) {
L
liaogang 已提交
162
    err = "CUBLAS: arch mismatch, ";
163
  } else if (stat == CUBLAS_STATUS_MAPPING_ERROR) {
L
liaogang 已提交
164
    err = "CUBLAS: mapping error, ";
165
  } else if (stat == CUBLAS_STATUS_EXECUTION_FAILED) {
L
liaogang 已提交
166
    err = "CUBLAS: execution failed, ";
167
  } else if (stat == CUBLAS_STATUS_INTERNAL_ERROR) {
L
liaogang 已提交
168
    err = "CUBLAS: internal error, ";
169
  } else if (stat == CUBLAS_STATUS_NOT_SUPPORTED) {
L
liaogang 已提交
170
    err = "CUBLAS: not supported, ";
171
  } else if (stat == CUBLAS_STATUS_LICENSE_ERROR) {
L
liaogang 已提交
172
    err = "CUBLAS: license error, ";
173
  }
174
  throw std::runtime_error(err + string::Sprintf(args...));
175 176
}

Y
Yu Yang 已提交
177 178 179 180 181 182 183 184 185 186 187
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 {
    throw std::runtime_error(platform::dynload::ncclGetErrorString(stat) +
                             string::Sprintf(args...));
  }
}

188 189
#endif  // PADDLE_ONLY_CPU

L
liaogang 已提交
190 191 192 193 194
template <typename T>
inline void throw_on_error(T e) {
  throw_on_error(e, "");
}

Q
qijun 已提交
195 196 197 198 199 200
#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 已提交
201
  } while (false)
L
liaogang 已提交
202

203 204 205 206 207 208 209 210
#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 已提交
211
  } while (false)
212

S
Superjom 已提交
213 214 215 216 217 218 219
/*
 * Some enforce helpers here, usage:
 *    int a = 1;
 *    int b = 2;
 *    PADDLE_ENFORCE_EQ(a, b);
 *
 *    will raise an expression described as follows:
220
 *    "enforce a == b failed, 1 != 2" with detailed stack information.
S
Superjom 已提交
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
 *
 *    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__)
238 239 240 241 242 243 244 245 246 247
#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 已提交
248
    if (UNLIKELY(!((__VAL0)__CMP(__VAL1)))) {                           \
249 250 251 252 253 254 255
      PADDLE_THROW("enforce %s " #__CMP " %s failed, %s " #__INV_CMP    \
                   " %s\n%s",                                           \
                   #__VAL0, #__VAL1, paddle::string::to_string(__VAL0), \
                   paddle::string::to_string(__VAL1),                   \
                   paddle::string::Sprintf("" __VA_ARGS__));            \
    }                                                                   \
  } while (0)
S
add EQ  
Superjom 已提交
256

257 258
}  // namespace platform
}  // namespace paddle