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
#include <dlfcn.h>     // for dladdr
#include <execinfo.h>  // for backtrace
19 20 21 22 23 24 25 26 27 28 29 30 31

#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 已提交
32
#include <iomanip>
L
liaogang 已提交
33
#include <memory>
34 35 36
#include <sstream>
#include <stdexcept>
#include <string>
37

38
#include "glog/logging.h"
Y
Yi Wang 已提交
39
#include "paddle/fluid/platform/macros.h"
40 41
#include "paddle/fluid/string/printf.h"
#include "paddle/fluid/string/to_string.h"
42

43
#ifdef PADDLE_WITH_CUDA
Y
Yi Wang 已提交
44 45 46
#include "paddle/fluid/platform/dynload/cublas.h"
#include "paddle/fluid/platform/dynload/cudnn.h"
#include "paddle/fluid/platform/dynload/curand.h"
Y
Yi Wang 已提交
47
#ifndef __APPLE__
Y
Yi Wang 已提交
48
#include "paddle/fluid/platform/dynload/nccl.h"
Y
Yi Wang 已提交
49 50
#endif  // __APPLE__
#endif  // PADDLE_WITH_CUDA
51 52 53 54

namespace paddle {
namespace platform {

L
liaogang 已提交
55 56 57 58 59 60 61 62 63 64 65
#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

66 67 68 69
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 已提交
70
    static constexpr int TRACE_STACK_LIMIT = 100;
71 72 73
    try {
      std::rethrow_exception(exp_);
    } catch (const std::exception& exp) {
Y
Yu Yang 已提交
74
      std::ostringstream sout;
75

F
fengjiayi 已提交
76
      sout << string::Sprintf("%s at [%s:%d]", exp.what(), f, l) << std::endl;
77 78
      sout << "PaddlePaddle Call Stacks: " << std::endl;

Y
Yu Yang 已提交
79
      void* call_stack[TRACE_STACK_LIMIT];
80 81 82 83 84
      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 已提交
85 86
        if (dladdr(call_stack[i], &info) && info.dli_sname) {
          auto demangled = demangle(info.dli_sname);
87 88 89 90 91
          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);
92
        } else {
93
          sout << string::Sprintf("%-3d %*0p\n", i, 2 + sizeof(void*) * 2,
94 95
                                  call_stack[i]);
        }
Y
Yu Yang 已提交
96
      }
97
      free(symbols);
Y
Yu Yang 已提交
98
      err_str_ = sout.str();
99 100 101 102 103 104
    }
  }

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

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

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

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

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

133
#ifdef PADDLE_WITH_CUDA
134 135

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

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

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

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

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

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

Q
qijun 已提交
232 233 234 235 236 237
#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 已提交
238
  } while (false)
L
liaogang 已提交
239

240
#ifndef REPLACE_ENFORCE_GLOG
241 242 243 244 245 246 247 248
#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 已提交
249
  } while (false)
250 251 252
#else
#define PADDLE_ENFORCE(...) ::paddle::platform::throw_on_error(__VA_ARGS__);
#endif
253

254 255 256 257 258
#define PADDLE_THROW_EOF()                                                     \
  do {                                                                         \
    throw ::paddle::platform::EOFException("There is no next data.", __FILE__, \
                                           __LINE__);                          \
  } while (false)
S
Superjom 已提交
259 260 261 262 263 264 265
/*
 * 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 已提交
266
 *    "Enforce failed. Expected input a == b, but received a(1) != b(2)."
267
 *      with detailed stack information.
S
Superjom 已提交
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
 *
 *    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__)
285 286 287 288 289 290 291 292 293 294
#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 已提交
295
    if (UNLIKELY(!((__VAL0)__CMP(__VAL1)))) {                           \
C
chenweihang 已提交
296
      PADDLE_THROW("Enforce failed. Expected %s " #__CMP                \
297 298 299
                   " %s, but received %s:%s " #__INV_CMP " %s:%s.\n%s", \
                   #__VAL0, #__VAL1, #__VAL0,                           \
                   paddle::string::to_string(__VAL0), #__VAL1,          \
300 301 302 303
                   paddle::string::to_string(__VAL1),                   \
                   paddle::string::Sprintf("" __VA_ARGS__));            \
    }                                                                   \
  } while (0)
S
add EQ  
Superjom 已提交
304

305 306
}  // namespace platform
}  // namespace paddle