1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 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 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407
|
#include <c10/cuda/CUDACachingAllocator.h>
#include <c10/cuda/CUDAGuard.h>
#include <mutex>
#include <unordered_map>
#include <utility>
#include <torch/csrc/cuda/CUDAPluggableAllocator.h>
namespace torch::cuda::CUDAPluggableAllocator {
CUDAPluggableAllocatorDeleterContext::CUDAPluggableAllocatorDeleterContext(
std::function<FreeFuncType> free_fn,
void* data,
size_t size,
int device,
cudaStream_t stream)
: free_fn_(std::move(free_fn)),
data_(data),
size_(size),
device_(device),
stream_(stream) {}
void CUDAPluggableAllocatorDeleterContext::free() {
free_fn_(data_, size_, device_, stream_);
delete this;
}
int device_count = 0;
void custom_raw_deleter(void* ptr);
_AllocationMetadata::_AllocationMetadata()
: size(0), device_idx(-1), stream{} {}
_AllocationMetadata::_AllocationMetadata(
size_t size,
c10::DeviceIndex device_idx,
cudaStream_t stream)
: size(size), device_idx(device_idx), stream(stream) {}
// This is a fast API to just register allocators
// based on function pointers (ie. external .so libraries)
// This avoids having to link against libtorch for C++ based custom allocators
// And also use this from python
CUDAPluggableAllocator::CUDAPluggableAllocator(
std::function<MallocFuncType> alloc_fn,
std::function<FreeFuncType> free_fn)
: alloc_fn_(std::move(alloc_fn)), free_fn_(std::move(free_fn)) {}
CUDAPluggableAllocator::CUDAPluggableAllocator(CUDAPluggableAllocator& other)
: alloc_fn_(other.alloc_fn_),
free_fn_(other.free_fn_),
init_fn_(other.init_fn_),
reset_fn_(other.reset_fn_),
memory_fraction_fn_(other.memory_fraction_fn_),
base_alloc_fn_(other.base_alloc_fn_),
record_stream_fn_(other.record_stream_fn_),
begin_allocate_to_pool_fn_(other.begin_allocate_to_pool_fn_),
end_allocate_to_pool_fn_(other.end_allocate_to_pool_fn_),
relase_pool_fn_(other.relase_pool_fn_) {}
void CUDAPluggableAllocator::set_init_fn(std::function<void(int)> init_fn) {
init_fn_ = std::move(init_fn);
}
void CUDAPluggableAllocator::set_reset_fn(std::function<void()> reset_fn) {
reset_fn_ = std::move(reset_fn);
}
void CUDAPluggableAllocator::set_memory_fraction_fn(
std::function<void(double, int)> memory_fraction_fn) {
memory_fraction_fn_ = std::move(memory_fraction_fn);
}
void CUDAPluggableAllocator::set_base_alloc_fn(
std::function<void*(void*, size_t*)> base_alloc_fn) {
base_alloc_fn_ = std::move(base_alloc_fn);
}
void CUDAPluggableAllocator::set_record_stream_fn(
std::function<void(void* ptr, cudaStream_t stream)> record_stream_fn) {
record_stream_fn_ = std::move(record_stream_fn);
}
void CUDAPluggableAllocator::set_begin_allocate_to_pool(
std::function<
void(int, c10::cuda::MempoolId_t, std::function<bool(cudaStream_t)>)>
capture_begin_fn) {
begin_allocate_to_pool_fn_ = std::move(capture_begin_fn);
}
void CUDAPluggableAllocator::set_end_allocate_to_pool_fn(
std::function<void(int, c10::cuda::MempoolId_t)> capture_about_to_end_fn) {
end_allocate_to_pool_fn_ = std::move(capture_about_to_end_fn);
}
void CUDAPluggableAllocator::set_release_pool(
std::function<void(int, c10::cuda::MempoolId_t)> capture_destroy_fn) {
relase_pool_fn_ = std::move(capture_destroy_fn);
}
void* CUDAPluggableAllocator::malloc(
size_t size,
c10::DeviceIndex device,
cudaStream_t stream) {
void* r = alloc_fn_(size, device, stream);
{
const std::lock_guard<std::mutex> lock(allocator_mutex_);
allocation_metadata_.emplace(r, _AllocationMetadata(size, device, stream));
}
return r;
}
c10::DataPtr CUDAPluggableAllocator::allocate(size_t size) {
c10::DeviceIndex device = -1;
C10_CUDA_CHECK(c10::cuda::GetDevice(&device));
cudaStream_t stream = c10::cuda::getCurrentCUDAStream(device);
void* r = this->malloc(size, device, stream);
auto* ctx = new CUDAPluggableAllocatorDeleterContext(
free_fn_, r, size, device, stream);
c10::DataPtr data_ptr = {
r, ctx, raw_deleter(), c10::Device(c10::DeviceType::CUDA, device)};
return data_ptr;
}
c10::DeleterFnPtr CUDAPluggableAllocator::raw_deleter() const {
return &custom_raw_deleter;
}
void* CUDAPluggableAllocator::raw_alloc(size_t nbytes) {
c10::DeviceIndex device = -1;
C10_CUDA_CHECK(c10::cuda::GetDevice(&device));
cudaStream_t stream = c10::cuda::getCurrentCUDAStream(device);
return malloc(nbytes, device, stream);
}
void* CUDAPluggableAllocator::raw_alloc_with_stream(
size_t nbytes,
cudaStream_t stream) {
c10::DeviceIndex device = -1;
C10_CUDA_CHECK(c10::cuda::GetDevice(&device));
return malloc(nbytes, device, stream);
}
void CUDAPluggableAllocator::raw_delete(void* ptr) {
cudaStream_t stream{};
c10::DeviceIndex device_idx = -1;
size_t size = 0;
{
const std::lock_guard<std::mutex> lock(allocator_mutex_);
TORCH_CHECK(
allocation_metadata_.count(ptr),
"Trying to free a pointer not allocated here");
_AllocationMetadata& metadata = allocation_metadata_[ptr];
size = metadata.size;
device_idx = metadata.device_idx;
stream = metadata.stream;
allocation_metadata_.erase(ptr);
}
free_fn_(ptr, size, device_idx, stream);
}
void CUDAPluggableAllocator::init(int device_count) {
if (init_fn_) {
init_fn_(device_count);
}
initialized_ = true;
}
bool CUDAPluggableAllocator::initialized() {
return initialized_;
}
double CUDAPluggableAllocator::getMemoryFraction(c10::DeviceIndex device) {
TORCH_CHECK(
false,
"CUDAPluggableAllocator does not yet support getMemoryFraction. "
"If you need it, please file an issue describing your use case.");
}
void CUDAPluggableAllocator::setMemoryFraction(
double fraction,
c10::DeviceIndex device) {
if (memory_fraction_fn_) {
memory_fraction_fn_(fraction, device);
}
}
void CUDAPluggableAllocator::emptyCache() {
if (reset_fn_) {
return reset_fn_();
}
}
void CUDAPluggableAllocator::cacheInfo(
c10::DeviceIndex device,
size_t* largestBlock) {
TORCH_CHECK(
false,
"CUDAPluggableAllocator does not yet support cacheInfo. "
"If you need it, please file an issue describing your use case.");
}
void* CUDAPluggableAllocator::getBaseAllocation(void* ptr, size_t* size) {
if (base_alloc_fn_) {
return base_alloc_fn_(ptr, size);
} else {
return ptr;
}
}
void CUDAPluggableAllocator::recordStream(
const c10::DataPtr& ptr,
streamType stream) {
if (record_stream_fn_) {
record_stream_fn_(ptr.get(), stream);
}
}
c10::CachingDeviceAllocator::DeviceStats CUDAPluggableAllocator::getDeviceStats(
c10::DeviceIndex device) {
TORCH_CHECK(
false,
"CUDAPluggableAllocator does not yet support getDeviceStats. "
"If you need it, please file an issue describing your use case.");
}
void CUDAPluggableAllocator::resetAccumulatedStats(c10::DeviceIndex device) {
TORCH_CHECK(
false,
"CUDAPluggableAllocator does not yet support resetAccumulatedStats. "
"If you need it, please file an issue describing your use case.");
}
void CUDAPluggableAllocator::resetPeakStats(c10::DeviceIndex device) {
TORCH_CHECK(
false,
"CUDAPluggableAllocator does not yet support resetPeakStats. "
"If you need it, please file an issue describing your use case.");
}
c10::cuda::CUDACachingAllocator::SnapshotInfo CUDAPluggableAllocator::
snapshot() {
TORCH_CHECK(
false,
"CUDAPluggableAllocator does not yet support snapshot. "
"If you need it, please file an issue describing your use case.");
}
c10::cuda::CUDACachingAllocator::ShareableHandle CUDAPluggableAllocator::
shareIpcHandle(void* ptr) {
TORCH_CHECK(
false,
"CUDAPluggableAllocator does not yet support shareIPcHandle. "
"If you need it, please file an issue describing your use case.");
}
std::shared_ptr<void> CUDAPluggableAllocator::getIpcDevPtr(std::string handle) {
TORCH_CHECK(
false,
"CUDAPluggableAllocator does not yet support getIpcDevPtr. "
"If you need it, please file an issue describing your use case.");
}
// CUDAGraph interactions
void CUDAPluggableAllocator::beginAllocateToPool(
c10::DeviceIndex device,
c10::cuda::MempoolId_t mempool_id,
std::function<bool(cudaStream_t)> filter) {
if (begin_allocate_to_pool_fn_) {
begin_allocate_to_pool_fn_(device, mempool_id, std::move(filter));
}
}
void CUDAPluggableAllocator::endAllocateToPool(
c10::DeviceIndex device,
c10::cuda::MempoolId_t mempool_id) {
if (end_allocate_to_pool_fn_) {
end_allocate_to_pool_fn_(device, mempool_id);
}
}
void CUDAPluggableAllocator::releasePool(
c10::DeviceIndex device,
c10::cuda::MempoolId_t mempool_id) {
if (relase_pool_fn_) {
relase_pool_fn_(device, mempool_id);
}
}
void CUDAPluggableAllocator::recordHistory(
bool enabled,
c10::cuda::CUDACachingAllocator::CreateContextFn context_recorder,
size_t alloc_trace_max_entries,
c10::cuda::CUDACachingAllocator::RecordContext when) {
TORCH_CHECK(
false,
"CUDAPluggableAllocator does not yet support recordHistory. "
"If you need it, please file an issue describing your use case.");
}
void CUDAPluggableAllocator::attachOutOfMemoryObserver(
c10::cuda::CUDACachingAllocator::OutOfMemoryObserver observer) {
TORCH_CHECK(
false,
"CUDAPluggableAllocator does not yet support attachOutOfMemoryObserver. "
"If you need it, please file an issue describing your use case.");
}
void CUDAPluggableAllocator::attachAllocatorTraceTracker(
c10::cuda::CUDACachingAllocator::AllocatorTraceTracker tracker) {
TORCH_CHECK(
false,
"CUDAPluggableAllocator does not support attachAllocatorTraceTracker. "
"attachAllocatorTraceTracker is only used inside Pytorch.");
}
std::shared_ptr<c10::cuda::CUDACachingAllocator::AllocatorState>
CUDAPluggableAllocator::getCheckpointState(
c10::DeviceIndex device,
at::cuda::MempoolId_t id) {
TORCH_CHECK(
false,
"CUDAPluggableAllocator does not yet support getCheckpointState. "
"If you need it, please file an issue describing your use case.");
}
c10::cuda::CUDACachingAllocator::CheckpointDelta CUDAPluggableAllocator::
setCheckpointPoolState(
c10::DeviceIndex device,
std::shared_ptr<c10::cuda::CUDACachingAllocator::AllocatorState> pps) {
TORCH_CHECK(
false,
"CUDAPluggableAllocator does not yet support setCheckpointPoolState. "
"If you need it, please file an issue describing your use case.");
}
void CUDAPluggableAllocator::enablePeerAccess(
c10::DeviceIndex dev,
c10::DeviceIndex dev_to_access) {
c10::cuda::CUDAGuard device_guard(dev);
cudaError_t err = cudaDeviceEnablePeerAccess(dev_to_access, 0);
if (err == cudaErrorPeerAccessAlreadyEnabled) {
// ignore and clear the error if access was already enabled
(void)cudaGetLastError();
} else {
C10_CUDA_CHECK(err);
}
}
cudaError_t CUDAPluggableAllocator::memcpyAsync(
void* dst,
int dstDevice,
const void* src,
int srcDevice,
size_t count,
cudaStream_t stream,
bool p2p_enabled) {
return cudaMemcpyAsync(dst, src, count, cudaMemcpyDeviceToDevice, stream);
}
std::string CUDAPluggableAllocator::name() {
return "pluggable";
}
void CUDAPluggableAllocator::copy_data(
void* dest,
const void* src,
std::size_t count) const {
C10_CUDA_CHECK(
cudaMemcpy(dest, src, count, cudaMemcpyKind::cudaMemcpyDeviceToDevice));
}
std::shared_ptr<c10::cuda::CUDACachingAllocator::CUDAAllocator>
current_custom_allocator;
std::shared_ptr<c10::cuda::CUDACachingAllocator::CUDAAllocator>
getCurrentAllocator() {
return current_custom_allocator;
}
// TODO: add more functions in the argument
std::shared_ptr<c10::cuda::CUDACachingAllocator::CUDAAllocator>
createCustomAllocator(
std::function<MallocFuncType> alloc_fn,
std::function<FreeFuncType> free_fn) {
std::shared_ptr<CUDAPluggableAllocator> allocator(
new CUDAPluggableAllocator(std::move(alloc_fn), std::move(free_fn)));
allocator->init(device_count);
return allocator;
}
void changeCurrentAllocator(
const std::shared_ptr<c10::cuda::CUDACachingAllocator::CUDAAllocator>&
allocator) {
TORCH_CHECK(
!c10::cuda::CUDACachingAllocator::allocator.load()->initialized(),
"Can't swap an already initialized allocator");
c10::cuda::CUDACachingAllocator::allocator.store(allocator.get());
current_custom_allocator = allocator;
}
void custom_raw_deleter(void* ctx) {
reinterpret_cast<CUDAPluggableAllocatorDeleterContext*>(ctx)->free();
}
} // namespace torch::cuda::CUDAPluggableAllocator
|