-
Notifications
You must be signed in to change notification settings - Fork 508
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[xla:cpu] Implement XLA FFI handlers for CPU Jax callbacks.
PiperOrigin-RevId: 726185954
- Loading branch information
1 parent
ae9d50a
commit 8332b0c
Showing
6 changed files
with
265 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,136 @@ | ||
| /* Copyright 2025 The OpenXLA Authors. | ||
| 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 "xla/python/py_client_cpu.h" | ||
|
|
||
| #include <cstddef> | ||
| #include <cstdint> | ||
| #include <cstring> | ||
| #include <memory> | ||
| #include <optional> | ||
| #include <string> | ||
| #include <utility> | ||
| #include <vector> | ||
|
|
||
| #include "absl/algorithm/container.h" | ||
| #include "absl/container/inlined_vector.h" | ||
| #include "absl/status/status.h" | ||
| #include "absl/status/statusor.h" | ||
| #include "absl/types/span.h" | ||
| #include "llvm/Support/Casting.h" | ||
| #include "nanobind/nanobind.h" | ||
| #include "xla/ffi/ffi.h" | ||
| #include "xla/ffi/ffi_api.h" | ||
| #include "xla/pjrt/host_callback.h" | ||
| #include "xla/pjrt/transpose.h" | ||
| #include "xla/primitive_util.h" | ||
| #include "xla/python/callback.h" | ||
| #include "xla/python/ifrt/host_callback.h" | ||
| #include "xla/python/nb_numpy.h" | ||
| #include "xla/python/py_host_callback.h" | ||
| #include "xla/python/types.h" | ||
| #include "xla/shape_util.h" | ||
| #include "xla/tsl/concurrency/ref_count.h" | ||
| #include "xla/tsl/platform/statusor.h" | ||
|
|
||
| namespace nb = nanobind; | ||
|
|
||
| namespace xla { | ||
|
|
||
| absl::Status XlaFfiPythonCpuCallback( | ||
| std::vector<tsl::RCReference<ifrt::LoadedHostCallback>>* callbacks, | ||
| uint64_t index, ffi::RemainingArgs args, ffi::RemainingRets rets) { | ||
| auto loaded_callback = llvm::dyn_cast_or_null<PyCpuLoadedHostCallback>( | ||
| callbacks->at(index).get()); | ||
| if (loaded_callback == nullptr) { | ||
| return absl::InternalError( | ||
| "Expected a PyCpuLoadedHostCallback, got something else."); | ||
| } | ||
| CpuCallback* callback = loaded_callback->cpu_callback(); | ||
|
|
||
| nb::gil_scoped_acquire gil; | ||
| auto nb_args = nb::steal<nb::tuple>(PyTuple_New(args.size())); | ||
| for (size_t i = 0; i < args.size(); ++i) { | ||
| auto arg = args.get<ffi::AnyBuffer>(i); | ||
| auto ptype = arg->element_type(); | ||
| if (ptype == TOKEN) { | ||
| PyTuple_SET_ITEM(nb_args.ptr(), i, nb::none().release().ptr()); | ||
| } else { | ||
| TF_ASSIGN_OR_RETURN(auto dtype, PrimitiveTypeToNbDtype(ptype)); | ||
| // We pass in data using default numpy layout i.e., std::nullopt. | ||
| auto array = nb_numpy_ndarray(dtype, arg->dimensions(), std::nullopt, | ||
| arg.value().untyped_data()); | ||
| array.attr("flags").attr("writeable") = nb::bool_(false); | ||
| PyTuple_SET_ITEM(nb_args.ptr(), i, array.release().ptr()); | ||
| } | ||
| } | ||
|
|
||
| EnterHostCallback(); | ||
| // TODO(dsuo): Change this to use the Python vectorcall protocol, which allows | ||
| // you to avoid constructing a tuple for the arguments. | ||
| absl::StatusOr<nb::tuple> maybe_result_tuple = | ||
| callback->FfiCall(std::move(nb_args)); | ||
| LeaveHostCallback(); | ||
| TF_ASSIGN_OR_RETURN(auto result_tuple, maybe_result_tuple); | ||
|
|
||
| for (size_t i = 0; i < rets.size(); ++i) { | ||
| auto arg = rets.get<ffi::AnyBuffer>(i).value(); | ||
| auto ptype = arg->element_type(); | ||
| if (ptype == TOKEN) continue; | ||
| nb::object output = | ||
| nb::borrow<nb::object>(PyTuple_GetItem(result_tuple.ptr(), i)); | ||
| nb_numpy_ndarray array = nb_numpy_ndarray::ensure(std::move(output)); | ||
| absl::Span<int64_t const> strides( | ||
| reinterpret_cast<const int64_t*>(array.strides()), array.ndim()); | ||
| // We expect the output to be in default numpy layout. | ||
| TF_ASSIGN_OR_RETURN(auto expected_shape, ShapeUtil::MakeValidatedShape( | ||
| ptype, arg->dimensions())); | ||
| auto expected_strides = ByteStridesForShape(expected_shape); | ||
| if (strides == expected_strides) { | ||
| std::memcpy(arg->untyped_data(), array.data(), arg->size_bytes()); | ||
| } else { | ||
| xla::TransposePlan::Options options; | ||
| options.elem_size_in_bytes = xla::primitive_util::ByteWidth(ptype); | ||
| absl::Span<int64_t const> dims( | ||
| reinterpret_cast<const int64_t*>(array.shape()), array.ndim()); | ||
| options.dims = dims; | ||
| absl::InlinedVector<int64_t, 4> reversed_layout; | ||
| reversed_layout.resize(expected_shape.dimensions_size()); | ||
| absl::c_reverse_copy(expected_shape.layout().minor_to_major(), | ||
| reversed_layout.begin()); | ||
| options.permutation = reversed_layout; | ||
| options.input_layout = xla::TransposePlan::Striding{strides}; | ||
| TF_ASSIGN_OR_RETURN(auto plan, | ||
| callback->transpose_cache().GetOrCreate(options)); | ||
| plan->Execute(array.data(), arg->untyped_data()); | ||
| } | ||
| } | ||
|
|
||
| return absl::OkStatus(); | ||
| } | ||
|
|
||
| XLA_FFI_DEFINE_HANDLER_SYMBOL( | ||
| kXlaFfiPythonCpuCallback, XlaFfiPythonCpuCallback, | ||
| ffi::Ffi::Bind() | ||
| .Ctx<ffi::UserData< | ||
| std::vector<tsl::RCReference<ifrt::LoadedHostCallback>>>>() | ||
| .Attr<uint64_t>("index") | ||
| .RemainingArgs() | ||
| .RemainingRets()); | ||
|
|
||
| XLA_FFI_REGISTER_HANDLER(ffi::GetXlaFfiApi(), "xla_ffi_python_cpu_callback", | ||
| "HOST", kXlaFfiPythonCpuCallback); | ||
|
|
||
| } // namespace xla |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| /* Copyright 2025 The OpenXLA Authors. | ||
| 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. | ||
| ==============================================================================*/ | ||
|
|
||
| #ifndef XLA_PYTHON_PY_CLIENT_CPU_H_ | ||
| #define XLA_PYTHON_PY_CLIENT_CPU_H_ | ||
|
|
||
| #include "xla/ffi/ffi.h" | ||
|
|
||
| namespace xla { | ||
|
|
||
| XLA_FFI_DECLARE_HANDLER_SYMBOL(kXlaFfiPythonCpuCallback); | ||
|
|
||
| } // namespace xla | ||
|
|
||
| #endif // XLA_PYTHON_PY_CLIENT_CPU_H_ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters