enforce.h 13.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
#ifdef __GNUC__
#include <cxxabi.h>  // for __cxa_demangle
#endif               // __GNUC__

D
dzhwinter 已提交
21 22 23
#if defined(_WIN32)
#define NOMINMAX  // msvc max/min macro conflict with std::min/max
#define GLOG_NO_ABBREVIATED_SEVERITIES  // msvc conflict logging with windows.h
D
dzhwinter 已提交
24
#define GOOGLE_GLOG_DLL_DECL
D
dzhwinter 已提交
25 26
#endif

27 28 29 30 31 32 33 34
#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 已提交
35
#include <iomanip>
L
liaogang 已提交
36
#include <memory>
37 38 39
#include <sstream>
#include <stdexcept>
#include <string>
40

41
#include "glog/logging.h"
Y
Yi Wang 已提交
42
#include "paddle/fluid/platform/macros.h"
D
dzhwinter 已提交
43
#include "paddle/fluid/platform/port.h"
44 45
#include "paddle/fluid/string/printf.h"
#include "paddle/fluid/string/to_string.h"
46

47
#ifdef PADDLE_WITH_CUDA
Y
Yi Wang 已提交
48 49 50
#include "paddle/fluid/platform/dynload/cublas.h"
#include "paddle/fluid/platform/dynload/cudnn.h"
#include "paddle/fluid/platform/dynload/curand.h"
D
dzhwinter 已提交
51
#if !defined(__APPLE__) && !defined(_WIN32)
Y
Yi Wang 已提交
52
#include "paddle/fluid/platform/dynload/nccl.h"
Y
Yi Wang 已提交
53 54
#endif  // __APPLE__
#endif  // PADDLE_WITH_CUDA
55 56 57 58

namespace paddle {
namespace platform {

L
liaogang 已提交
59 60 61 62 63 64 65 66 67 68 69
#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

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

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

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

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

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

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

L
liaogang 已提交
133 134
template <typename... Args>
inline typename std::enable_if<sizeof...(Args) != 0, void>::type throw_on_error(
Y
Yu Yang 已提交
135
    bool stat, const Args&... args) {
L
liaogang 已提交
136
  if (UNLIKELY(!(stat))) {
137
#ifndef REPLACE_ENFORCE_GLOG
138
    throw std::runtime_error(string::Sprintf(args...));
139 140 141
#else
    LOG(FATAL) << string::Sprintf(args...);
#endif
L
liaogang 已提交
142 143 144
  }
}

145
#ifdef PADDLE_WITH_CUDA
146 147

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

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

template <typename... Args>
L
liaogang 已提交
174 175
inline typename std::enable_if<sizeof...(Args) != 0, void>::type throw_on_error(
    cudnnStatus_t stat, const Args&... args) {
176 177 178
  if (stat == CUDNN_STATUS_SUCCESS) {
    return;
  } else {
179
#ifndef REPLACE_ENFORCE_GLOG
180 181
    throw std::runtime_error(platform::dynload::cudnnGetErrorString(stat) +
                             string::Sprintf(args...));
182 183 184
#else
    LOG(FATAL) << string::Sprintf(args...);
#endif
185 186 187 188
  }
}

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

D
done  
dzhwinter 已提交
220
#if !defined(__APPLE__) && !defined(_WIN32)
Y
Yu Yang 已提交
221 222 223 224 225 226
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 {
227
#ifndef REPLACE_ENFORCE_GLOG
Y
Yu Yang 已提交
228 229
    throw std::runtime_error(platform::dynload::ncclGetErrorString(stat) +
                             string::Sprintf(args...));
230 231 232 233
#else
    LOG(FATAL) << platform::dynload::ncclGetErrorString(stat)
               << string::Sprintf(args...);
#endif
Y
Yu Yang 已提交
234 235
  }
}
D
dzhwinter 已提交
236
#endif  // __APPLE__ and windows
237
#endif  // PADDLE_WITH_CUDA
238

L
liaogang 已提交
239 240 241 242 243
template <typename T>
inline void throw_on_error(T e) {
  throw_on_error(e, "");
}

D
dzhwinter 已提交
244
#if !defined(_WIN32)
Q
qijun 已提交
245 246 247 248 249 250
#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 已提交
251
  } while (false)
L
liaogang 已提交
252

253
#ifndef REPLACE_ENFORCE_GLOG
254 255 256 257 258 259 260 261
#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 已提交
262
  } while (false)
263

D
dzhwinter 已提交
264
#else
D
dzhwinter 已提交
265
#define PADDLE_ENFORCE(...) ::paddle::platform::throw_on_error(__VA_ARGS__);
D
dzhwinter 已提交
266 267
#endif  // REPLACE_ENFORCE_GLOG

D
dzhwinter 已提交
268 269 270 271 272 273
#else  // !_WIN32
// disable enforce, caused by the varardic macro exception error
#define PADDLE_THROW(x)                                      \
  do {                                                       \
    throw std::make_exception_ptr(                           \
        std::runtime_error("Windows disable the enforce.")); \
D
dzhwinter 已提交
274 275
  } while (false)

D
dzhwinter 已提交
276
#define PADDLE_ENFORCE(x, ...) x
D
dzhwinter 已提交
277
#endif  // !_WIN32
D
dzhwinter 已提交
278

D
dzhwinter 已提交
279 280 281 282 283 284
#define PADDLE_THROW_EOF()                                                     \
  do {                                                                         \
    throw ::paddle::platform::EOFException("There is no next data.", __FILE__, \
                                           __LINE__);                          \
  } while (false)

S
Superjom 已提交
285 286 287 288 289 290 291
/*
 * 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 已提交
292
 *    "Enforce failed. Expected input a == b, but received a(1) != b(2)."
293
 *      with detailed stack information.
S
Superjom 已提交
294 295 296 297
 *
 *    extra messages is also supported, for example:
 *    PADDLE_ENFORCE(a, b, "some simple enforce failed between %d numbers", 2)
 */
D
dzhwinter 已提交
298
#if !defined(_WIN32)
S
Superjom 已提交
299 300 301 302 303 304 305 306 307 308 309 310
#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__)
D
dzhwinter 已提交
311

312 313 314 315 316 317 318 319 320 321
#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 已提交
322
    if (UNLIKELY(!((__VAL0)__CMP(__VAL1)))) {                           \
C
chenweihang 已提交
323
      PADDLE_THROW("Enforce failed. Expected %s " #__CMP                \
324 325 326
                   " %s, but received %s:%s " #__INV_CMP " %s:%s.\n%s", \
                   #__VAL0, #__VAL1, #__VAL0,                           \
                   paddle::string::to_string(__VAL0), #__VAL1,          \
327 328 329 330
                   paddle::string::to_string(__VAL1),                   \
                   paddle::string::Sprintf("" __VA_ARGS__));            \
    }                                                                   \
  } while (0)
D
dzhwinter 已提交
331
#else
D
dzhwinter 已提交
332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347
#define PADDLE_ENFORCE_EQ(__VAL0, __VAL1, ...) ((__VAL0) == (__VAL1))
#define PADDLE_ENFORCE_NE(__VAL0, __VAL1, ...) ((__VAL0) != (__VAL1))
#define PADDLE_ENFORCE_GT(__VAL0, __VAL1, ...) ((__VAL0) > (__VAL1))
#define PADDLE_ENFORCE_GE(__VAL0, __VAL1, ...) ((__VAL0) >= (__VAL1))
#define PADDLE_ENFORCE_LT(__VAL0, __VAL1, ...) ((__VAL0) < (__VAL1))
#define PADDLE_ENFORCE_LE(__VAL0, __VAL1, ...) ((__VAL0) <= (__VAL1))

#define __PADDLE_BINARY_COMPARE(__VAL0, __VAL1, __CMP, __INV_CMP, ...) \
  do {                                                                 \
    if (!((__VAL0)__CMP(__VAL1))) {                                    \
      PADDLE_THROW("Windows disable the enforce. Enforce failed.");    \
    }                                                                  \
  } while (0)
#define PADDLE_ENFORCE_NOT_NULL(__VAL1, ...)                       \
  do {                                                             \
    if (nullptr == (__VAL1)) {                                     \
D
dzhwinter 已提交
348
      PADDLE_THROW("Windows disable the enforce. Enforce failed"); \
D
dzhwinter 已提交
349 350 351
    }                                                              \
  } while (0)
#endif  // !_WIN32
S
add EQ  
Superjom 已提交
352

353 354
}  // namespace platform
}  // namespace paddle