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
|
#include <torch/csrc/distributed/rpc/request_callback_impl.h>
#include <c10/util/C++17.h>
#include <torch/csrc/autograd/profiler.h>
#include <torch/csrc/distributed/autograd/context/container.h>
#include <torch/csrc/distributed/autograd/context/context.h>
#include <torch/csrc/distributed/autograd/engine/dist_engine.h>
#include <torch/csrc/distributed/autograd/rpc_messages/cleanup_autograd_context_req.h>
#include <torch/csrc/distributed/autograd/rpc_messages/cleanup_autograd_context_resp.h>
#include <torch/csrc/distributed/autograd/rpc_messages/propagate_gradients_req.h>
#include <torch/csrc/distributed/autograd/rpc_messages/propagate_gradients_resp.h>
#include <torch/csrc/distributed/autograd/rpc_messages/rpc_with_autograd.h>
#include <torch/csrc/distributed/autograd/rpc_messages/rpc_with_profiling_req.h>
#include <torch/csrc/distributed/autograd/rpc_messages/rpc_with_profiling_resp.h>
#include <torch/csrc/distributed/autograd/rpc_messages/rref_backward_req.h>
#include <torch/csrc/distributed/autograd/rpc_messages/rref_backward_resp.h>
#include <torch/csrc/distributed/autograd/utils.h>
#include <torch/csrc/distributed/rpc/profiler/server_process_global_profiler.h>
#include <torch/csrc/distributed/rpc/py_rref.h>
#include <torch/csrc/distributed/rpc/python_call.h>
#include <torch/csrc/distributed/rpc/python_remote_call.h>
#include <torch/csrc/distributed/rpc/python_resp.h>
#include <torch/csrc/distributed/rpc/python_rpc_handler.h>
#include <torch/csrc/distributed/rpc/rref_context.h>
#include <torch/csrc/distributed/rpc/rref_impl.h>
#include <torch/csrc/distributed/rpc/rref_proto.h>
#include <torch/csrc/distributed/rpc/script_call.h>
#include <torch/csrc/distributed/rpc/script_remote_call.h>
#include <torch/csrc/distributed/rpc/script_resp.h>
#include <torch/csrc/distributed/rpc/unpickled_python_call.h>
#include <torch/csrc/distributed/rpc/unpickled_python_remote_call.h>
#include <torch/csrc/distributed/rpc/utils.h>
#include <torch/csrc/jit/python/python_ivalue.h>
namespace torch {
namespace distributed {
namespace rpc {
using namespace torch::distributed::autograd;
namespace {
std::unique_ptr<RpcCommandBase> deserializePythonRpcCommandReference(
RpcCommandBase& rpc,
const MessageType& messageType) {
switch (messageType) {
case MessageType::PYTHON_CALL: {
auto& pc = static_cast<PythonCall&>(rpc);
return std::make_unique<UnpickledPythonCall>(
pc.serializedPyObj(), pc.isAsyncExecution());
}
case MessageType::PYTHON_REMOTE_CALL: {
auto& prc = static_cast<PythonRemoteCall&>(rpc);
return std::make_unique<UnpickledPythonRemoteCall>(
prc.serializedPyObj(),
prc.retRRefId(),
prc.retForkId(),
prc.isAsyncExecution());
}
case MessageType::FORWARD_AUTOGRAD_REQ: {
// Deserialize the wrapped RPC if it contains Python UDF
auto& rwa = static_cast<RpcWithAutograd&>(rpc);
auto& wrappedRpc = rwa.wrappedRpc();
auto pythonRpc = deserializePythonRpcCommandReference(
wrappedRpc, rwa.wrappedMessageType());
if (pythonRpc) {
rwa.setWrappedRpc(std::move(pythonRpc));
}
return nullptr;
}
case MessageType::RUN_WITH_PROFILING_REQ: {
// Deserialize wrapped RPC if it contains python call
auto& rpcWithProfilingReq = static_cast<RpcWithProfilingReq&>(rpc);
auto& wrappedRpc = rpcWithProfilingReq.wrappedRpc();
auto pythonRpc = deserializePythonRpcCommandReference(
wrappedRpc, rpcWithProfilingReq.wrappedMessageType());
if (pythonRpc) {
rpcWithProfilingReq.setWrappedRpc(std::move(pythonRpc));
}
return nullptr;
}
default: {
return nullptr;
}
}
}
SerializedPyObj serializePyObject(IValue value) {
auto& pythonRpcHandler = PythonRpcHandler::getInstance();
// Need this GIL to guard jit::toPyObj and destruct its returned
// py::object
py::gil_scoped_acquire acquire;
try {
return pythonRpcHandler.serialize(jit::toPyObject(value));
} catch (py::error_already_set& e) {
// py::error_already_set requires GIL to destruct, take special care.
auto err = std::runtime_error(e.what());
e.restore();
PyErr_Clear();
throw err;
}
}
} // anonymous namespace
c10::intrusive_ptr<JitFuture> RequestCallbackImpl::runPythonFunction(
const py::object& function,
std::vector<c10::Stream> streams,
bool isAsyncExecution) const {
c10::MultiStreamGuard guard(streams);
auto& pythonRpcHandler = PythonRpcHandler::getInstance();
py::gil_scoped_acquire acquire;
py::object result;
try {
result = pythonRpcHandler.runPythonUdf(function);
} catch (py::error_already_set& e) {
// py::error_already_set requires GIL to destruct, take special care.
auto future =
asFuture(std::make_exception_ptr(std::runtime_error(e.what())));
e.restore();
PyErr_Clear();
return future;
} catch (std::exception& e) {
return asFuture(std::current_exception());
}
// After sync exection or failed async execution return the value as-is.
if (pythonRpcHandler.isRemoteException(result) || !isAsyncExecution) {
return asFuture(
c10::ivalue::ConcretePyObjectHolder::create(result),
at::PyObjectType::get());
}
try {
return result.cast<jit::PythonFutureWrapper&>().fut;
} catch (const py::cast_error& e) {
auto type = result.get_type();
auto errMsg = c10::str(
e.what(),
". Functions decorated with @rpc.async_function must return a "
"torch.futures.Future object, but got ",
type.attr("__module__").cast<std::string>(),
".",
type.attr("__qualname__").cast<std::string>());
return asFuture(std::make_exception_ptr(std::runtime_error(errMsg)));
}
}
std::unique_ptr<RpcCommandBase> RequestCallbackImpl::
deserializePythonRpcCommand(
std::unique_ptr<RpcCommandBase> rpc,
const MessageType& messageType) const {
auto pythonRpc = deserializePythonRpcCommandReference(*rpc, messageType);
return pythonRpc ? std::move(pythonRpc) : std::move(rpc);
}
c10::intrusive_ptr<JitFuture> RequestCallbackImpl::processScriptCall(
RpcCommandBase& rpc,
std::vector<c10::Stream> streams) const {
auto& scriptCall = static_cast<ScriptCall&>(rpc);
c10::intrusive_ptr<JitFuture> future;
if (scriptCall.hasOp()) {
future = runJitOperator(
*scriptCall.op(), scriptCall.stackRef(), std::move(streams));
} else {
future = runJitFunction(
scriptCall.qualifiedName(),
scriptCall.stackRef(),
std::move(streams),
scriptCall.isAsyncExecution());
}
return future->then(
[](JitFuture& jitFuture) {
return withStorages(ScriptResp(jitFuture.value()).toMessage());
},
c10::getCustomClassType<c10::intrusive_ptr<Message>>());
}
c10::intrusive_ptr<JitFuture> RequestCallbackImpl::processPythonCall(
RpcCommandBase& rpc,
std::vector<c10::Stream> streams) const {
auto& upc = static_cast<UnpickledPythonCall&>(rpc);
auto future = runPythonFunction(
upc.pythonUdf(), std::move(streams), upc.isAsyncExecution());
return future->then(
[](JitFuture& future) {
return withStorages(
PythonResp(serializePyObject(future.value())).toMessage());
},
c10::getCustomClassType<c10::intrusive_ptr<Message>>());
}
c10::intrusive_ptr<JitFuture> RequestCallbackImpl::processScriptRemoteCall(
RpcCommandBase& rpc,
std::vector<c10::Stream> streams) const {
auto& scriptRemoteCall = static_cast<ScriptRemoteCall&>(rpc);
c10::intrusive_ptr<JitFuture> future;
if (scriptRemoteCall.hasOp()) {
future = runJitOperator(
*scriptRemoteCall.op(),
scriptRemoteCall.stackRef(),
std::move(streams));
} else {
future = runJitFunction(
scriptRemoteCall.qualifiedName(),
scriptRemoteCall.stackRef(),
std::move(streams),
scriptRemoteCall.isAsyncExecution());
}
return assignOwnerRRef(
scriptRemoteCall.retRRefId(),
scriptRemoteCall.retForkId(),
std::move(future));
}
c10::intrusive_ptr<JitFuture> RequestCallbackImpl::processPythonRemoteCall(
RpcCommandBase& rpc,
std::vector<c10::Stream> streams) const {
auto& uprc = static_cast<UnpickledPythonRemoteCall&>(rpc);
auto future = runPythonFunction(
uprc.pythonUdf(), std::move(streams), uprc.isAsyncExecution());
return assignOwnerRRef(uprc.rrefId(), uprc.forkId(), std::move(future));
}
c10::intrusive_ptr<JitFuture> RequestCallbackImpl::processPythonRRefFetchCall(
RpcCommandBase& rpc) const {
auto& prf = static_cast<PythonRRefFetchCall&>(rpc);
auto future = retrieveOwnerRRef(prf.rrefId());
return future->then(
[](JitFuture& future) {
SerializedPyObj result = serializePyObject(future.value());
return withStorages(
PythonRRefFetchRet(std::move(result).toIValues()).toMessage());
},
c10::getCustomClassType<c10::intrusive_ptr<Message>>());
}
void RequestCallbackImpl::handleRRefDelete(
c10::intrusive_ptr<RRef>& rref) const {
if (rref && rref->isPyObj()) {
py::gil_scoped_acquire acquire;
rref.reset();
}
}
c10::intrusive_ptr<JitFuture> RequestCallbackImpl::processRpcWithErrors(
RpcCommandBase& rpc,
const MessageType& messageType,
std::vector<c10::Stream> streams) const {
try {
return processRpc(rpc, messageType, std::move(streams));
} catch (py::error_already_set& e) {
// Pass a dummy message ID since it will be overwritten anyways.
auto future = asFuture(handleError(e, messageType, -1));
// There are request callback impls in Python, where Python
// exceptions could be thrown. For releasing Python exception
// py::objects, GIL must be held.
py::gil_scoped_acquire acquire;
e.restore(); // Release ownership on py::objects and also restore
// Python Error Indicator.
PyErr_Clear(); // Clear the Python Error Indicator as we has
// recorded the exception in the response message.
return future;
} catch (std::exception& e) {
// Pass a dummy message ID since it will be overwritten anyways.
return asFuture(handleError(e, messageType, -1));
}
}
bool RequestCallbackImpl::cudaAvailable() const {
#ifdef USE_CUDA
return true;
#else
return false;
#endif
}
c10::intrusive_ptr<JitFuture> RequestCallbackImpl::processRRefBackward(
RpcCommandBase& rpc) const {
auto& rrefBackwardReq = static_cast<RRefBackwardReq&>(rpc);
auto future = retrieveOwnerRRef(rrefBackwardReq.getRRefId());
return future->then(
[autogradContextId = rrefBackwardReq.getAutogradContextId(),
retainGraph = rrefBackwardReq.retainGraph()](JitFuture& future) {
// Run backward (TODO: make this async?).
PyRRef::backwardOwnerRRef(
autogradContextId, retainGraph, future.value());
return withStorages(RRefBackwardResp().toMessage());
},
c10::getCustomClassType<c10::intrusive_ptr<Message>>());
}
c10::intrusive_ptr<JitFuture> RequestCallbackImpl::runJitFunction(
const c10::QualifiedName& name,
std::vector<at::IValue>& stack,
std::vector<c10::Stream> streams,
bool isAsyncExecution) const {
c10::MultiStreamGuard guard(streams);
c10::intrusive_ptr<JitFuture> future;
try {
// runAsync() starts in the calling thread, but may return an uncompleted
// future (though for non-async code, it will typically be completed).
// If it was async, our callback will typically be invoked by the
// continuation on an at::launch() thread.
future = PythonRpcHandler::getInstance()
.jitCompilationUnit()
->get_function(name)
.runAsync(stack);
} catch (const std::exception&) {
return asFuture(std::current_exception());
}
if (isAsyncExecution) {
at::TypePtr type = future->elementType();
if (type->kind() != at::FutureType::Kind) {
return asFuture(std::make_exception_ptr(std::runtime_error(c10::str(
"Async functions must return an IValue of Future type, but got ",
type->str()))));
}
future = future->thenAsync(
[](JitFuture& future) { return future.value().toFuture(); },
type->cast<at::FutureType>()->getElementType());
}
return future;
}
} // namespace rpc
} // namespace distributed
} // namespace torch
|