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

Y
Yu Yang 已提交
17 18
#include <execinfo.h>
#include <iomanip>
19 20 21
#include <sstream>
#include <stdexcept>
#include <string>
22 23
#include "paddle/string/printf.h"
#include "paddle/string/to_string.h"
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41

#ifndef PADDLE_ONLY_CPU

#include "paddle/platform/dynload/cublas.h"
#include "paddle/platform/dynload/cudnn.h"
#include "paddle/platform/dynload/curand.h"

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

#endif  // PADDLE_ONLY_CPU

namespace paddle {
namespace platform {

42 43 44 45
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 已提交
46
    static constexpr int TRACE_STACK_LIMIT = 100;
47 48 49
    try {
      std::rethrow_exception(exp_);
    } catch (const std::exception& exp) {
Y
Yu Yang 已提交
50 51 52 53 54 55 56 57 58 59 60
      std::ostringstream sout;
      sout << string::Sprintf("%s at [%s:%d]", exp.what(), f, l) << std::endl;
      sout << "Call Stacks: " << std::endl;
      void* call_stack[TRACE_STACK_LIMIT];
      int sz = backtrace(call_stack, TRACE_STACK_LIMIT);
      auto line = backtrace_symbols(call_stack, sz);
      for (int i = 0; i < sz; ++i) {
        sout << line[i] << std::endl;
      }
      free(line);
      err_str_ = sout.str();
61 62 63 64 65 66
    }
  }

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

L
liaogang 已提交
67 68 69 70 71
// 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.
72 73
#define UNLIKELY(condition) __builtin_expect(static_cast<bool>(condition), 0)

L
liaogang 已提交
74 75 76 77
template <typename... Args>
inline typename std::enable_if<sizeof...(Args) != 0, void>::type throw_on_error(
    int stat, const Args&... args) {
  if (UNLIKELY(!(stat))) {
78
    throw std::runtime_error(string::Sprintf(args...));
L
liaogang 已提交
79 80 81
  }
}

82 83 84
#ifndef PADDLE_ONLY_CPU

template <typename... Args>
L
liaogang 已提交
85 86
inline typename std::enable_if<sizeof...(Args) != 0, void>::type throw_on_error(
    cudaError_t e, const Args&... args) {
L
liaogang 已提交
87
  if (UNLIKELY(e)) {
88 89
    throw thrust::system_error(e, thrust::cuda_category(),
                               string::Sprintf(args...));
90 91 92 93
  }
}

template <typename... Args>
L
liaogang 已提交
94 95
inline typename std::enable_if<sizeof...(Args) != 0, void>::type throw_on_error(
    curandStatus_t stat, const Args&... args) {
96
  if (stat != CURAND_STATUS_SUCCESS) {
97 98
    throw thrust::system_error(cudaErrorLaunchFailure, thrust::cuda_category(),
                               string::Sprintf(args...));
99 100 101 102
  }
}

template <typename... Args>
L
liaogang 已提交
103 104
inline typename std::enable_if<sizeof...(Args) != 0, void>::type throw_on_error(
    cudnnStatus_t stat, const Args&... args) {
105 106 107
  if (stat == CUDNN_STATUS_SUCCESS) {
    return;
  } else {
108 109
    throw std::runtime_error(platform::dynload::cudnnGetErrorString(stat) +
                             string::Sprintf(args...));
110 111 112 113
  }
}

template <typename... Args>
L
liaogang 已提交
114 115
inline typename std::enable_if<sizeof...(Args) != 0, void>::type throw_on_error(
    cublasStatus_t stat, const Args&... args) {
L
liaogang 已提交
116
  std::string err;
117 118 119
  if (stat == CUBLAS_STATUS_SUCCESS) {
    return;
  } else if (stat == CUBLAS_STATUS_NOT_INITIALIZED) {
L
liaogang 已提交
120
    err = "CUBLAS: not initialized, ";
121
  } else if (stat == CUBLAS_STATUS_ALLOC_FAILED) {
L
liaogang 已提交
122
    err = "CUBLAS: alloc failed, ";
123
  } else if (stat == CUBLAS_STATUS_INVALID_VALUE) {
L
liaogang 已提交
124
    err = "CUBLAS: invalid value, ";
125
  } else if (stat == CUBLAS_STATUS_ARCH_MISMATCH) {
L
liaogang 已提交
126
    err = "CUBLAS: arch mismatch, ";
127
  } else if (stat == CUBLAS_STATUS_MAPPING_ERROR) {
L
liaogang 已提交
128
    err = "CUBLAS: mapping error, ";
129
  } else if (stat == CUBLAS_STATUS_EXECUTION_FAILED) {
L
liaogang 已提交
130
    err = "CUBLAS: execution failed, ";
131
  } else if (stat == CUBLAS_STATUS_INTERNAL_ERROR) {
L
liaogang 已提交
132
    err = "CUBLAS: internal error, ";
133
  } else if (stat == CUBLAS_STATUS_NOT_SUPPORTED) {
L
liaogang 已提交
134
    err = "CUBLAS: not supported, ";
135
  } else if (stat == CUBLAS_STATUS_LICENSE_ERROR) {
L
liaogang 已提交
136
    err = "CUBLAS: license error, ";
137
  }
138
  throw std::runtime_error(err + string::Sprintf(args...));
139 140 141 142
}

#endif  // PADDLE_ONLY_CPU

L
liaogang 已提交
143 144 145 146 147
template <typename T>
inline void throw_on_error(T e) {
  throw_on_error(e, "");
}

Q
qijun 已提交
148 149 150 151 152 153
#define PADDLE_THROW(...)                                              \
  do {                                                                 \
    throw ::paddle::platform::EnforceNotMet(                           \
        std::make_exception_ptr(                                       \
            std::runtime_error(paddle::string::Sprintf(__VA_ARGS__))), \
        __FILE__, __LINE__);                                           \
L
liaogang 已提交
154 155
  } while (0)

156 157 158 159 160 161 162 163
#define PADDLE_ENFORCE(...)                                             \
  do {                                                                  \
    try {                                                               \
      ::paddle::platform::throw_on_error(__VA_ARGS__);                  \
    } catch (...) {                                                     \
      throw ::paddle::platform::EnforceNotMet(std::current_exception(), \
                                              __FILE__, __LINE__);      \
    }                                                                   \
164 165
  } while (0)

S
Superjom 已提交
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
/*
 * Some enforce helpers here, usage:
 *    int a = 1;
 *    int b = 2;
 *    PADDLE_ENFORCE_EQ(a, b);
 *
 *    will raise an expression described as follows:
 *    "enforce a == b failed, 1 != 2" with detailed stack infomation.
 *
 *    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__)
Y
Yan Chunwei 已提交
191 192 193
#define PADDLE_ENFORCE_NOT_NULL(__VAL, ...)                            \
  PADDLE_ENFORCE(nullptr != (__VAL), #__VAL " should not be null\n%s", \
                 paddle::string::Sprintf("" __VA_ARGS__));
S
Superjom 已提交
194 195

#define __PADDLE_BINARY_COMPARE(__VAL0, __VAL1, __CMP, __INV_CMP, ...)        \
Y
Yan Chunwei 已提交
196
  PADDLE_ENFORCE(__VAL0 __CMP __VAL1,                                         \
S
Superjom 已提交
197
                 "enforce %s " #__CMP " %s failed, %s " #__INV_CMP " %s\n%s", \
198 199
                 #__VAL0, #__VAL1, paddle::string::to_string(__VAL0),         \
                 paddle::string::to_string(__VAL1),                           \
S
Superjom 已提交
200
                 paddle::string::Sprintf("" __VA_ARGS__));
S
add EQ  
Superjom 已提交
201

202 203
}  // namespace platform
}  // namespace paddle