dynamic_loader.cc 7.9 KB
Newer Older
1
/* Copyright (c) 2016 PaddlePaddle Authors. All Rights Reserved.
Q
qijun 已提交
2 3 4 5 6 7 8 9 10 11 12 13

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. */
Y
Yi Wang 已提交
14
#include "paddle/fluid/platform/dynload/dynamic_loader.h"
15

Q
qijun 已提交
16
#include <memory>
17
#include <mutex>  // NOLINT
Q
qijun 已提交
18
#include <string>
19

Q
qijun 已提交
20 21
#include "gflags/gflags.h"
#include "glog/logging.h"
22
#include "paddle/fluid/platform/dynload/cupti_lib_path.h"
Y
Yi Wang 已提交
23
#include "paddle/fluid/platform/enforce.h"
D
dzhwinter 已提交
24
#include "paddle/fluid/platform/port.h"
Q
qijun 已提交
25 26 27 28 29 30 31 32 33 34 35 36 37

DEFINE_string(cudnn_dir, "",
              "Specify path for loading libcudnn.so. For instance, "
              "/usr/local/cudnn/lib. If empty [default], dlopen "
              "will search cudnn from LD_LIBRARY_PATH");

DEFINE_string(cuda_dir, "",
              "Specify path for loading cuda library, such as libcublas, "
              "libcurand. For instance, /usr/local/cuda/lib64. If default, "
              "dlopen will search cuda from LD_LIBRARY_PATH");

DEFINE_string(warpctc_dir, "", "Specify path for loading libwarpctc.so.");

Y
Yu Yang 已提交
38 39 40 41 42
DEFINE_string(nccl_dir, "",
              "Specify path for loading nccl library, such as libcublas, "
              "libcurand. For instance, /usr/local/cuda/lib64. If default, "
              "dlopen will search cuda from LD_LIBRARY_PATH");

43 44
DEFINE_string(cupti_dir, "", "Specify path for loading cupti.so.");

Y
Yan Chunwei 已提交
45 46 47 48
DEFINE_string(
    tensorrt_dir, "",
    "Specify path for loading tensorrt library, such as libnvinfer.so.");

49 50
DEFINE_string(mklml_dir, "", "Specify path for loading libmklml_intel.so.");

Q
qijun 已提交
51 52
namespace paddle {
namespace platform {
Q
qijun 已提交
53
namespace dynload {
54
static constexpr char cupti_lib_path[] = CUPTI_LIB_PATH;
55

Q
qijun 已提交
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
static inline std::string join(const std::string& part1,
                               const std::string& part2) {
  // directory separator
  const char sep = '/';
  if (!part2.empty() && part2.front() == sep) {
    return part2;
  }
  std::string ret;
  ret.reserve(part1.size() + part2.size() + 1);
  ret = part1;
  if (!ret.empty() && ret.back() != sep) {
    ret += sep;
  }
  ret += part2;
  return ret;
}

73 74
static inline void* GetDsoHandleFromDefaultPath(const std::string& dso_path,
                                                int dynload_flags) {
75 76
  VLOG(30) << "Try to find library: " << dso_path
           << " from default system path.";
Q
qijun 已提交
77
  // default search from LD_LIBRARY_PATH/DYLD_LIBRARY_PATH
78
  // and /usr/local/lib path
79
  void* dso_handle = dlopen(dso_path.c_str(), dynload_flags);
Q
qijun 已提交
80 81 82 83 84

// DYLD_LIBRARY_PATH is disabled after Mac OS 10.11 to
// bring System Integrity Projection (SIP), if dso_handle
// is null, search from default package path in Mac OS.
#if defined(__APPLE__) || defined(__OSX__)
85 86 87 88
  if (nullptr == dso_handle) {
    dso_handle =
        dlopen(join("/usr/local/cuda/lib/", dso_path).c_str(), dynload_flags);
    if (nullptr == dso_handle) {
Q
qijun 已提交
89
      if (dso_path == "libcudnn.dylib") {
90 91 92 93 94
        LOG(WARNING) << "Note: [Recommend] copy cudnn into /usr/local/cuda/ \n "
                        "For instance, sudo tar -xzf "
                        "cudnn-7.5-osx-x64-v5.0-ga.tgz -C /usr/local \n sudo "
                        "chmod a+r /usr/local/cuda/include/cudnn.h "
                        "/usr/local/cuda/lib/libcudnn*";
Q
qijun 已提交
95 96 97 98
      }
    }
  }
#endif
99

100 101
  if (nullptr == dso_handle) {
    LOG(WARNING) << "Can not find library: " << dso_path
102
                 << ". Please try to add the lib path to LD_LIBRARY_PATH.";
103
  }
104
  return dso_handle;
Q
qijun 已提交
105 106
}

107 108 109
static inline void* GetDsoHandleFromSearchPath(const std::string& search_root,
                                               const std::string& dso_name,
                                               bool throw_on_error = true) {
D
dzhwinter 已提交
110
#if !defined(_WIN32)
Q
qijun 已提交
111
  int dynload_flags = RTLD_LAZY | RTLD_LOCAL;
D
dzhwinter 已提交
112 113 114
#else
  int dynload_flags = 0;
#endif  // !_WIN32
115
  void* dso_handle = nullptr;
Q
qijun 已提交
116 117 118

  std::string dlPath = dso_name;
  if (search_root.empty()) {
119
    dso_handle = GetDsoHandleFromDefaultPath(dlPath, dynload_flags);
Q
qijun 已提交
120 121 122
  } else {
    // search xxx.so from custom path
    dlPath = join(search_root, dso_name);
123
    dso_handle = dlopen(dlPath.c_str(), dynload_flags);
D
dzhwinter 已提交
124 125 126 127 128
#if !defined(_WIN32)
    auto errorno = dlerror();
#else
    auto errorno = GetLastError();
#endif  // !_WIN32
Q
qijun 已提交
129
    // if not found, search from default path
130
    if (nullptr == dso_handle) {
Q
qijun 已提交
131
      LOG(WARNING) << "Failed to find dynamic library: " << dlPath << " ("
D
dzhwinter 已提交
132
                   << errorno << ")";
J
JiabinYang 已提交
133 134 135 136 137 138
      if (dlPath.find("nccl") != std::string::npos) {
        std::cout
            << "You may need to install 'nccl2' from NVIDIA official website: "
            << "https://developer.nvidia.com/nccl/nccl-download"
            << "before install PaddlePaddle" << std::endl;
      }
Q
qijun 已提交
139
      dlPath = dso_name;
140
      dso_handle = GetDsoHandleFromDefaultPath(dlPath, dynload_flags);
Q
qijun 已提交
141 142
    }
  }
143 144 145 146 147 148 149 150
  auto error_msg =
      "Failed to find dynamic library: %s ( %s ) \n Please specify "
      "its path correctly using following ways: \n Method. set "
      "environment variable LD_LIBRARY_PATH on Linux or "
      "DYLD_LIBRARY_PATH on Mac OS. \n For instance, issue command: "
      "export LD_LIBRARY_PATH=... \n Note: After Mac OS 10.11, "
      "using the DYLD_LIBRARY_PATH is impossible unless System "
      "Integrity Protection (SIP) is disabled.";
D
dzhwinter 已提交
151 152 153 154 155
#if !defined(_WIN32)
  auto errorno = dlerror();
#else
  auto errorno = GetLastError();
#endif  // !_WIN32
156
  if (throw_on_error) {
D
dzhwinter 已提交
157
    PADDLE_ENFORCE(nullptr != dso_handle, error_msg, dlPath, errorno);
158
  } else if (nullptr == dso_handle) {
D
dzhwinter 已提交
159
    LOG(WARNING) << string::Sprintf(error_msg, dlPath, errorno);
160
  }
161 162

  return dso_handle;
Q
qijun 已提交
163 164
}

165
void* GetCublasDsoHandle() {
Q
qijun 已提交
166
#if defined(__APPLE__) || defined(__OSX__)
167
  return GetDsoHandleFromSearchPath(FLAGS_cuda_dir, "libcublas.dylib");
Q
qijun 已提交
168
#else
169
  return GetDsoHandleFromSearchPath(FLAGS_cuda_dir, "libcublas.so");
Q
qijun 已提交
170 171 172
#endif
}

173
void* GetCUDNNDsoHandle() {
Q
qijun 已提交
174
#if defined(__APPLE__) || defined(__OSX__)
175
  return GetDsoHandleFromSearchPath(FLAGS_cudnn_dir, "libcudnn.dylib", false);
Q
qijun 已提交
176
#else
177
  return GetDsoHandleFromSearchPath(FLAGS_cudnn_dir, "libcudnn.so", false);
Q
qijun 已提交
178 179 180
#endif
}

181
void* GetCUPTIDsoHandle() {
182 183 184 185 186
  std::string cupti_path = cupti_lib_path;
  if (!FLAGS_cupti_dir.empty()) {
    cupti_path = FLAGS_cupti_dir;
  }
#if defined(__APPLE__) || defined(__OSX__)
187
  return GetDsoHandleFromSearchPath(cupti_path, "libcupti.dylib", false);
188
#else
189
  return GetDsoHandleFromSearchPath(cupti_path, "libcupti.so", false);
190 191 192
#endif
}

193
void* GetCurandDsoHandle() {
Q
qijun 已提交
194
#if defined(__APPLE__) || defined(__OSX__)
195
  return GetDsoHandleFromSearchPath(FLAGS_cuda_dir, "libcurand.dylib");
Q
qijun 已提交
196
#else
197
  return GetDsoHandleFromSearchPath(FLAGS_cuda_dir, "libcurand.so");
Q
qijun 已提交
198 199 200
#endif
}

201
void* GetWarpCTCDsoHandle() {
Q
qijun 已提交
202
#if defined(__APPLE__) || defined(__OSX__)
203
  return GetDsoHandleFromSearchPath(FLAGS_warpctc_dir, "libwarpctc.dylib");
Q
qijun 已提交
204
#else
205
  return GetDsoHandleFromSearchPath(FLAGS_warpctc_dir, "libwarpctc.so");
Q
qijun 已提交
206 207 208
#endif
}

209
void* GetNCCLDsoHandle() {
Y
Yu Yang 已提交
210
#if defined(__APPLE__) || defined(__OSX__)
211
  return GetDsoHandleFromSearchPath(FLAGS_nccl_dir, "libnccl.dylib");
Y
Yu Yang 已提交
212
#else
213
  return GetDsoHandleFromSearchPath(FLAGS_nccl_dir, "libnccl.so");
Y
Yu Yang 已提交
214 215 216
#endif
}

Y
Yan Chunwei 已提交
217 218 219 220 221 222 223 224
void* GetTensorRtDsoHandle() {
#if defined(__APPLE__) || defined(__OSX__)
  return GetDsoHandleFromSearchPath(FLAGS_tensorrt_dir, "libnvinfer.dylib");
#else
  return GetDsoHandleFromSearchPath(FLAGS_tensorrt_dir, "libnvinfer.so");
#endif
}

225 226 227 228 229 230 231 232
void* GetMKLMLDsoHandle() {
#if defined(__APPLE__) || defined(__OSX__)
  return GetDsoHandleFromSearchPath(FLAGS_mklml_dir, "libmklml_intel.dylib");
#else
  return GetDsoHandleFromSearchPath(FLAGS_mklml_dir, "libmklml_intel.so");
#endif
}

Q
qijun 已提交
233
}  // namespace dynload
Q
qijun 已提交
234 235
}  // namespace platform
}  // namespace paddle