/* Copyright 2017 The TensorFlow Authors. All Rights Reserved. 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. ==============================================================================*/ #include "tensorflow/compiler/jit/xla_device.h" #include #include #include #include #include "absl/base/call_once.h" #include "absl/memory/memory.h" #include "absl/strings/match.h" #include "tensorflow/compiler/jit/defs.h" #include "tensorflow/compiler/jit/pjrt_device_context.h" #include "tensorflow/compiler/jit/xla_compile_on_demand_op.h" #include "tensorflow/compiler/jit/xla_compile_util.h" #include "tensorflow/compiler/jit/xla_device_context.h" #include "tensorflow/compiler/tf2xla/shape_util.h" #include "tensorflow/compiler/tf2xla/xla_op_registry.h" #include "xla/client/client_library.h" #include "xla/service/stream_pool.h" #include "tensorflow/core/common_runtime/device.h" #include "tensorflow/core/common_runtime/device_factory.h" #include "tensorflow/core/common_runtime/dma_helper.h" #include "tensorflow/core/common_runtime/function.h" #include "tensorflow/core/common_runtime/graph_constructor.h" #include "tensorflow/core/common_runtime/renamed_device.h" #include "tensorflow/core/framework/allocator.h" #include "tensorflow/core/framework/device_base.h" #include "tensorflow/core/framework/function.h" #include "tensorflow/core/framework/kernel_def.pb.h" #include "tensorflow/core/framework/node_def_builder.h" #include "tensorflow/core/framework/op_kernel.h" #include "tensorflow/core/framework/tensor.h" #include "tensorflow/core/framework/tensor.pb.h" #include "tensorflow/core/framework/types.h" #include "tensorflow/core/lib/core/notification.h" #include "tensorflow/core/lib/core/status.h" #include "tensorflow/core/platform/logging.h" #include "tensorflow/core/platform/stream_executor_no_cuda.h" #include "tensorflow/core/profiler/lib/traceme.h" #include "tensorflow/core/public/session_options.h" #include "tensorflow/core/public/version.h" #include "tensorflow/core/tfrt/common/async_value_tensor.h" #include "tensorflow/core/util/device_name_utils.h" #include "tensorflow/core/util/dump_graph.h" #include "tensorflow/core/util/stream_executor_util.h" namespace tensorflow { // Default PaddedShapeFn implementation that simply returns the unpadded // on-device shape. This is accurate for CPU and GPU devices that neither // transpose nor pad tensors. absl::Status DefaultPaddedShapeFn(const Tensor& tensor, xla::Shape* shape) { const tensorflow::XlaTensor* xla_tensor = tensorflow::XlaTensor::FromTensor(&tensor); if (xla_tensor == nullptr) { return TensorShapeToXLAShape(tensor.dtype(), tensor.shape(), shape); } const xla::ShapedBuffer& shaped_buffer = xla_tensor->shaped_buffer(); *shape = shaped_buffer.on_device_shape(); return absl::OkStatus(); } // Caches a XlaDeviceAllocator per pair. A // XlaDeviceAllocator is created on demand and is associated with a // XlaDevice. It outlives the device itself (for instance, the buffer // backing a tensor holds a pointer to the allocator for book-keeping, // and this buffer can outlast the device). class XlaDeviceAllocatorState { public: // Creates or returns a cached XlaDeviceAllocator for a given // backend and device_ordinal. static XlaDeviceAllocator* GetOrCreateXlaDeviceAllocator( const xla::Backend* backend, int device_ordinal); private: // Returns the singleton instance of XlaDeviceAllocatorState. static XlaDeviceAllocatorState& Singleton(); XlaDeviceAllocatorState(); ~XlaDeviceAllocatorState(); mutex allocator_mutex_; // Guards the singleton allocator state. std::unordered_map, std::unique_ptr, hash>> allocators_ TF_GUARDED_BY(allocator_mutex_); XlaDeviceAllocatorState(const XlaDeviceAllocatorState&) = delete; void operator=(const XlaDeviceAllocatorState&) = delete; }; /* static */ XlaDeviceAllocatorState& XlaDeviceAllocatorState::Singleton() { static auto a = new XlaDeviceAllocatorState; return *a; } XlaDeviceAllocatorState::XlaDeviceAllocatorState() = default; XlaDeviceAllocatorState::~XlaDeviceAllocatorState() = default; XlaDeviceAllocator* XlaDeviceAllocatorState::GetOrCreateXlaDeviceAllocator( const xla::Backend* backend, int device_ordinal) { XlaDeviceAllocatorState& state = Singleton(); mutex_lock lock(state.allocator_mutex_); auto it = state.allocators_.find({backend, device_ordinal}); if (it != state.allocators_.end()) { return it->second.get(); } std::unique_ptr alloc = std::make_unique( backend->stream_executors()[device_ordinal]); XlaDeviceAllocator* alloc_ptr = alloc.get(); state.allocators_[{backend, device_ordinal}] = std::move(alloc); return alloc_ptr; } namespace { static DeviceAttributes BuildXlaDeviceAttributes(const std::string& name_prefix, const std::string& device_name, int device_ordinal) { return Device::BuildDeviceAttributes( absl::StrCat(name_prefix, "/device:", device_name, ":", device_ordinal), DeviceType(device_name), Bytes(16ULL << 30), DeviceLocality(), absl::StrCat("device: ", device_name, " device")); } } // namespace XlaDevice::Metadata::Metadata( int device_ordinal, se::Platform* platform, const DeviceType& device_type, std::vector shape_determination_fns, PaddedShapeFn padded_shape_fn, bool use_multiple_streams) : device_ordinal_(device_ordinal), device_type_(device_type), platform_(platform), shape_determination_fns_(std::move(shape_determination_fns)), padded_shape_fn_(std::move(padded_shape_fn)), use_multiple_streams_(use_multiple_streams) {} int XlaDevice::Metadata::device_ordinal() const { return device_ordinal_; } se::Platform* XlaDevice::Metadata::platform() const { return platform_; } xla::LocalClient* XlaDevice::Metadata::client() const { auto client = xla::ClientLibrary::GetOrCreateLocalClient(platform_); return client.value(); } const DeviceType& XlaDevice::Metadata::jit_device_type() const { return device_type_; } /*static*/ absl::Status XlaDevice::GetMetadataFromDevice( DeviceBase* device, const XlaDevice::Metadata** metadata) { *metadata = nullptr; XlaDevice* xla_device = dynamic_cast(device->UnderlyingDevice()); if (xla_device == nullptr) { return absl::InternalError(absl::StrCat( "Cannot get XLA metadata from non-XLA device \"", device->name(), "\". GetMetadata must only be called on an XLA device. Either an " "internal bug has been triggered, or an XLA-specific op has been " "placed on the wrong device.")); } *metadata = &(xla_device->xla_metadata_); return absl::OkStatus(); } /* static */ absl::Status XlaDevice::GetMetadata(OpKernelContext* ctx, const Metadata** metadata) { return GetMetadataFromDevice(ctx->device(), metadata); } /* static */ absl::Status XlaDevice::GetMetadata(OpKernelConstruction* ctx, const Metadata** metadata) { return GetMetadataFromDevice(ctx->device(), metadata); } /* static */ mutex XlaDevice::global_mu_(LINKER_INITIALIZED); /* static */ std::vector>* XlaDevice::global_compute_streams_ = new std::vector>; XlaDevice::XlaDevice(const SessionOptions& session_options, const Options& options) : LocalDevice(session_options, BuildXlaDeviceAttributes(options.device_name_prefix, options.device_name, options.device_ordinal)), xla_metadata_(options.device_ordinal, options.platform, DeviceType(options.compilation_device_name), options.shape_determination_fns, options.padded_shape_fn ? options.padded_shape_fn : DefaultPaddedShapeFn, options.use_multiple_streams), device_ordinal_(options.device_ordinal), device_name_(options.device_name), jit_device_name_(options.compilation_device_name), platform_(options.platform), intra_op_parallelism_threads_( session_options.config.intra_op_parallelism_threads()), use_multiple_streams_(options.use_multiple_streams), shape_determination_fns_(options.shape_determination_fns), allowed_devices_(options.allowed_devices), use_global_compute_stream_(options.use_global_compute_stream) { if (options.shape_determination_fns.empty()) { LOG(ERROR) << "shape_representation_fns must be non-empty."; } VLOG(1) << "Created XLA device " << options.compilation_device_name << " " << options.device_ordinal << " " << this; VLOG(1) << "XlaDevice options: use_multiple_streams: " << options.use_multiple_streams << " use_global_compute_stream: " << options.use_global_compute_stream; thread_pool_.reset(new thread::ThreadPool(session_options.env, "xla_device", /*num_threads=*/1)); // We have multiple device to device streams to allow for some concurrency // between transfers. The particular value of '4' is chosen fairly // arbitrarily. It may be necessary to make this tunable via // XlaDevice::Options. static constexpr int kNumDeviceToDeviceStreams = 4; device_to_device_streams_.resize(kNumDeviceToDeviceStreams); } XlaDevice::~XlaDevice() { VLOG(1) << "Destroying XLA device " << jit_device_name_ << " " << this; mutex_lock lock(mu_); for (const auto& iter : device_contexts_) { iter->Unref(); } } absl::StatusOr XlaDevice::GetOrCreateClient() const { // We lazily create the client because the platform commits to the // details of the host hardware when the client is created, so we // don't want to do it until we get a chance to hook the platform up // to a simulator. xla::LocalClientOptions options; options.set_platform(platform_) .set_allowed_devices(allowed_devices_) .set_intra_op_parallelism_threads(intra_op_parallelism_threads_); return xla::ClientLibrary::GetOrCreateLocalClient(options); } Allocator* XlaDevice::GetAllocator(AllocatorAttributes attr) { mutex_lock lock(mu_); return GetAllocatorLocked(attr); } Allocator* XlaDevice::GetAllocatorLocked(AllocatorAttributes attr) { if (attr.on_host()) { return cpu_allocator(); } if (xla_allocator_ == nullptr) { if (UsePjRtForSingleDeviceCompilation(device_name_)) { VLOG(1) << "XlaDevice " << this << " uses AsyncValueAllocator"; pjrt_allocator_ = std::make_unique(); xla_allocator_ = pjrt_allocator_.get(); } else { // TODO(b/78468222): This can fail, at least when the backend is GPU and // there is no GPU on the host. xla::Backend* backend = GetOrCreateClient().value()->mutable_backend(); xla_allocator_ = XlaDeviceAllocatorState::GetOrCreateXlaDeviceAllocator( backend, device_ordinal_); } } return xla_allocator_; } absl::Status XlaDevice::EnsureDeviceContextOk() { mutex_lock lock(mu_); return GetDeviceContextLocked().status(); } absl::Status XlaDevice::EnsureStreamOkLocked( xla::Backend* backend, const std::string& name, std::shared_ptr* stream, bool* stream_was_changed) { if (!(*stream) || !(*stream)->ok()) { xla::StreamPool::Ptr ptr; TF_ASSIGN_OR_RETURN(ptr, backend->BorrowStream(device_ordinal_)); *stream = std::shared_ptr(std::move(ptr)); VLOG(1) << "XlaDevice " << this << " new " << name << " stream=" << (*stream); *stream_was_changed = true; } return absl::OkStatus(); } absl::StatusOr> XlaDevice::GetDeviceContextLocked() { if (UsePjRtForSingleDeviceCompilation(device_name_)) { if (device_contexts_.empty()) { for (const auto& iter : shape_determination_fns_) { auto device_context = new PjRtDeviceContext(iter); VLOG(1) << "XlaDevice " << this << " new PjRtDeviceContext " << device_context; device_contexts_.emplace_back(device_context); } if (use_accelerator_device_info_) { auto accelerator_device_info = std::make_unique(); accelerator_device_info->default_context = device_contexts_.at(0); set_tensorflow_accelerator_device_info(accelerator_device_info.get()); accelerator_device_info_ = std::move(accelerator_device_info); VLOG(1) << "XlaDevice " << this << " new AcceleratorDeviceInfo " << accelerator_device_info_.get(); } } return device_contexts_; } TF_ASSIGN_OR_RETURN(xla::LocalClient * client, GetOrCreateClient()); xla::Backend* backend = client->mutable_backend(); // Ensure all our streams are valid, borrowing new streams if necessary. bool need_new_device_context = device_contexts_.empty(); if (use_global_compute_stream_) { mutex_lock lock(global_mu_); if (global_compute_streams_->size() <= device_ordinal_) { global_compute_streams_->resize(device_ordinal_ + 1, nullptr); } auto& global_stream = global_compute_streams_->at(device_ordinal_); if (global_stream != nullptr && global_stream->ok()) { stream_ = global_stream; } else { // Directly create the stream here instead of borrowing from the stream // pool to avoid potential lifetime issues. TF_ASSIGN_OR_RETURN( stream_, backend->stream_executors()[device_ordinal_]->CreateStream()); TF_RETURN_IF_ERROR(EnsureStreamOkLocked(backend, "stream", &stream_, &need_new_device_context)); (*global_compute_streams_)[device_ordinal_] = stream_; } } else { TF_RETURN_IF_ERROR(EnsureStreamOkLocked(backend, "stream", &stream_, &need_new_device_context)); } std::shared_ptr host_to_device_stream; std::shared_ptr device_to_host_stream; std::vector> device_to_device_streams; if (use_multiple_streams_) { TF_RETURN_IF_ERROR(EnsureStreamOkLocked(backend, "host_to_device_stream", &host_to_device_stream_, &need_new_device_context)); for (std::shared_ptr& stream : device_to_device_streams_) { TF_RETURN_IF_ERROR( EnsureStreamOkLocked(backend, "device_to_device_stream", &stream, &need_new_device_context)); } host_to_device_stream = host_to_device_stream_; device_to_device_streams = device_to_device_streams_; // The data transfer requests from device to host could arrive out of order, // so a single stream would cause deadlock. For this case, // xla_device_context would borrow a stream for each transfer request. device_to_host_stream = nullptr; } else { host_to_device_stream = stream_; device_to_host_stream = stream_; device_to_device_streams = {stream_}; } if (!need_new_device_context) { return device_contexts_; } // At this point we know we need a new device context. // Call GetAllocator for the side-effect of ensuring the allocator is created. GetAllocatorLocked({}); for (const auto& iter : device_contexts_) { iter->Unref(); } // The XlaDeviceContext keeps a reference count to the streams, and the // XlaDeviceContext remains live for the duration of a Executor run. This // ensures that the streams remain live for the duration of a run, even if // an error is encountered and the streams are replaced with new ones. for (const auto& iter : shape_determination_fns_) { auto device_context = new XlaDeviceContext( stream_, host_to_device_stream, device_to_host_stream, device_to_device_streams, client, iter, thread_pool_.get()); VLOG(1) << "XlaDevice " << this << " new XlaDeviceContext " << device_context; device_contexts_.emplace_back(device_context); } // Create and set a new AcceleratorDeviceInfo, if necessary. // // TODO(b/78232898): This isn't thread-safe; there is a race between the call // to set_tensorflow_accelerator_device_info() with ops that call the getter // tensorflow_accelerator_device_info(). This isn't trivially fixed by adding // locking to those methods; see the bug for details. Our only saving grace at // the moment is that this race doesn't seem to occur in practice. if (use_accelerator_device_info_) { auto accelerator_device_info = std::make_unique(); accelerator_device_info->stream = stream_.get(); accelerator_device_info->default_context = device_contexts_.at(0); set_tensorflow_accelerator_device_info(accelerator_device_info.get()); accelerator_device_info_ = std::move(accelerator_device_info); VLOG(1) << "XlaDevice " << this << " new AcceleratorDeviceInfo " << accelerator_device_info_.get(); } return device_contexts_; } absl::StatusOr XlaDevice::GetDeviceContextWithIndex(int index) { mutex_lock lock(mu_); TF_ASSIGN_OR_RETURN(auto device_contexts, GetDeviceContextLocked()); return device_contexts.at(index); } absl::StatusOr XlaDevice::GetDeviceContextDefault() { return GetDeviceContextWithIndex(0); } absl::Status XlaDevice::UseAcceleratorDeviceInfo() { mutex_lock lock(mu_); use_accelerator_device_info_ = true; return GetDeviceContextLocked().status(); } absl::Status XlaDevice::TryGetDeviceContext(DeviceContext** out_context) { TF_ASSIGN_OR_RETURN(auto device_context, GetDeviceContextDefault()); device_context->Ref(); *out_context = device_context; return absl::OkStatus(); } // Warn about XLA_CPU/XLA_GPU exactly once. static void ShowXlaDeviceDeprecationWarning( absl::string_view compilation_device_name) { static absl::once_flag once; if (absl::StrContains(compilation_device_name, "CPU") || absl::StrContains(compilation_device_name, "GPU")) { absl::call_once(once, [] { LOG(INFO) << "XLA_GPU and XLA_CPU devices are deprecated and will be " "removed in subsequent releases. Instead, use either " "@tf.function(jit_compile=True) for must-compile " "semantics, or run with TF_XLA_FLAGS=--tf_xla_auto_jit=2 " "for auto-clustering best-effort compilation."; }); } } void XlaDevice::Compute(OpKernel* op_kernel, OpKernelContext* context) { VLOG(2) << "XlaDevice::Compute " << op_kernel->name() << ":" << op_kernel->type_string(); ShowXlaDeviceDeprecationWarning(jit_device_name_.type_string()); op_kernel->Compute(context); } void XlaDevice::ComputeAsync(AsyncOpKernel* op_kernel, OpKernelContext* context, AsyncOpKernel::DoneCallback done) { ShowXlaDeviceDeprecationWarning(jit_device_name_.type_string()); VLOG(2) << "XlaDevice::ComputeAsync " << op_kernel->name() << ":" << op_kernel->type_string(); op_kernel->ComputeAsync(context, done); } absl::Status XlaDevice::Sync() { VLOG(1) << "XlaDevice::Sync"; tsl::profiler::TraceMe activity("XlaDevice::Sync", tsl::profiler::TraceMeLevel::kInfo); std::shared_ptr stream; { mutex_lock lock(mu_); stream = stream_; } if (!stream) return absl::OkStatus(); absl::Status status = stream->BlockHostUntilDone(); TF_RETURN_IF_ERROR(status); if (!stream->ok()) { return absl::InternalError("XlaDevice::Sync() failed."); } VLOG(1) << "XlaDevice::Sync completed"; return absl::OkStatus(); } absl::Status XlaDevice::MakeTensorFromProto( DeviceContext* device_context, const TensorProto& tensor_proto, const AllocatorAttributes alloc_attrs, Tensor* tensor) { Tensor parsed(tensor_proto.dtype()); if (!parsed.FromProto(cpu_allocator(), tensor_proto)) { return absl::InvalidArgumentError(absl::StrCat( "Cannot parse tensor from proto: ", tensor_proto.DebugString())); } absl::Status status; if (alloc_attrs.on_host()) { *tensor = parsed; } else { Allocator* allocator; { mutex_lock lock(mu_); allocator = GetAllocatorLocked(alloc_attrs); } Tensor copy(allocator, parsed.dtype(), parsed.shape()); TF_RETURN_IF_ERROR( device_context->CopyCPUTensorToDeviceSync(&parsed, this, ©)); *tensor = copy; } VLOG(2) << "Allocated tensor at " << DMAHelper::base(tensor); return status; } absl::Status XlaDevice::MakeTensorFromProto( const TensorProto& tensor_proto, const AllocatorAttributes alloc_attrs, Tensor* tensor) { VLOG(1) << "XlaDevice::MakeTensorFromProto"; DeviceContext* device_context; TF_ASSIGN_OR_RETURN(device_context, GetDeviceContextDefault()); return MakeTensorFromProto(device_context, tensor_proto, alloc_attrs, tensor); } void XlaDevice::SetAllowsSyncOnCompletion(bool sync_on_completion) { mutex_lock lock(mu_); sync_on_completion_ = sync_on_completion; } bool XlaDevice::AllowsSyncOnCompletion() const { mutex_lock lock(mu_); return sync_on_completion_; } void XlaDevice::SetHandleDeviceErrorCallback( std::function callback) { mutex_lock lock(mu_); device_error_callback_ = callback; } absl::Status XlaDevice::HandleDeviceError() { std::function local_device_error_callback; { mutex_lock lock(mu_); local_device_error_callback = device_error_callback_; } if (local_device_error_callback != nullptr) { return local_device_error_callback(); } return absl::OkStatus(); } absl::Status XlaDevice::RefreshStatus() { std::shared_ptr stream; { mutex_lock lock(mu_); stream = stream_; } if (!stream) { return absl::OkStatus(); } absl::Status status = stream->RefreshStatus(); if (!status.ok()) { // Ignore errors from HandleDeviceError, since by definition the status is // already non-ok, so there's nothing extra to report if HandleDeviceError // itself returns an error. HandleDeviceError().IgnoreError(); } return status; } XlaDeviceOpRegistrations* RegisterXlaDeviceKernels( const char* device, const char* jit_device, OpKernel* (*factory)(OpKernelConstruction*), absl::string_view kernel_class_name) { XlaOpRegistry::RegisterCompilationKernels(); XlaDeviceOpRegistrations* registrations = new XlaDeviceOpRegistrations; for (const KernelDef* jit_def : XlaOpRegistry::DeviceKernels( jit_device, /*include_compilation_only_kernels=*/false)) { KernelDef* def = new KernelDef(*jit_def); const std::unordered_set* constant_inputs = XlaOpRegistry::CompileTimeConstantInputArgNames(def->op()); for (const std::string& arg_name : *constant_inputs) { def->add_host_memory_arg(arg_name); } def->set_device_type(device); registrations->op_kernel_registrars.emplace_back( new kernel_factory::OpKernelRegistrar(def, kernel_class_name, factory)); } return registrations; } XlaDeviceOpRegistrations* RegisterXlaDeviceKernels(const char* device, const char* jit_device) { // Any op assigned to the device that isn't rewritten by the graph rewriter // gets executed by an XlaCompileOnDemandOp, which compiles it and executes // it just-in-time. auto factory = [](OpKernelConstruction* context) -> OpKernel* { return new XlaCompileOnDemandOp(context); }; return RegisterXlaDeviceKernels(device, jit_device, factory, /*kernel_class_name=*/"XlaCompileOnDemandOp"); } } // namespace tensorflow