paddlepaddle--paddle/paddle/utils/pybind.h

// Copyright (c) 2023 PaddlePaddle 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.

#pragma once

#if defined(PADDLE_WITH_CUDA) || defined(PADDLE_WITH_HIP)
#include <ATen/core/TensorBody.h>
#endif
#include "paddle/phi/api/include/tensor.h"
#ifdef PADDLE_WITH_DISTRIBUTE
#include "paddle/phi/core/distributed/auto_parallel/dist_tensor.h"
#endif
#include "paddle/utils/optional.h"
#include "pybind11/pybind11.h"
#include "pybind11/stl.h"

namespace py = pybind11;

namespace paddle {
namespace pybind {

typedef struct {
  PyObject_HEAD paddle::Tensor tensor;
  // Dynamic attributes
  PyObject* dict;
  // Weak references
  PyObject* weakrefs;
} TensorObject;

#define RETURN_PY_NONE \
  Py_INCREF(Py_None);  \
  return Py_None;

// Internal use only, to expose the Tensor type to Python.
bool PyCheckTensor(PyObject* obj);

// Share Tensor for inplace.
void ShareTensor(PyObject* src, PyObject* dst);

// Internal use only, to expose the Tensor type to Python.
paddle::Tensor& CastPyArg2Tensor(PyObject* obj, Py_ssize_t arg_pos);

// Internal use only, to expose the Tensor type to Python.
PyObject* ToPyObject(const paddle::Tensor& value,
                     bool return_py_none_if_not_initialize = false);

// Internal use only, switch tensor_operants_mode to phi
void EnableTensorOperantsToPhiMode();

PyObject* ToPyObject(const phi::DataType& dtype);

}  // namespace pybind
}  // namespace paddle

namespace pybind11 {
namespace detail {

template <>
struct type_caster<paddle::Tensor> {
 public:
  PYBIND11_TYPE_CASTER(paddle::Tensor, _("paddle::Tensor"));

  bool load(handle src, bool) {
    paddle::pybind::EnableTensorOperantsToPhiMode();
    PyObject* obj = src.ptr();
    if (paddle::pybind::PyCheckTensor(obj)) {
      value = paddle::pybind::CastPyArg2Tensor(obj, 0);
      return true;
    }
    return false;
  }

  static handle cast(const paddle::Tensor& src,
                     return_value_policy /* policy */,
                     handle /* parent */) {
    // TODO(GhostScreaming): pipeline parallel may return a uninitialized
    // DistTensor, it should not return None.
#ifdef PADDLE_WITH_DISTRIBUTE
    bool return_none =
        phi::distributed::DistTensor::classof(src.impl().get()) ? false : true;
#else
    bool return_none = true;
#endif
    return handle(paddle::pybind::ToPyObject(
        src, return_none /* return_py_none_if_not_initialize */));
  }
};

template <>
struct optional_caster<paddle::optional<paddle::Tensor>> {
  using value_conv = make_caster<paddle::Tensor>;

  template <typename T>
  static handle cast(T&& src, return_value_policy policy, handle parent) {
    if (!src) {
      return none().release();
    }
    if (!std::is_lvalue_reference<T>::value) {
      policy = return_value_policy_override<paddle::Tensor>::policy(policy);
    }
    return value_conv::cast(*std::forward<T>(src), policy, parent);
  }

  bool load(handle src, bool convert) {
    if (!src) {
      return false;
    }
    if (src.is_none()) {
      return true;  // default-constructed value is already empty
    }
    value_conv inner_caster;
    if (!inner_caster.load(src, convert)) {
      return false;
    }

    value = paddle::make_optional(
        cast_op<paddle::Tensor&&>(std::move(inner_caster)));
    return true;
  }

  PYBIND11_TYPE_CASTER(paddle::optional<paddle::Tensor>,
                       const_name("Optional[paddle::Tensor]"));
};

#if defined(PADDLE_WITH_CUDA) || defined(PADDLE_WITH_HIP)
template <>
struct type_caster<at::Tensor> {
 public:
  PYBIND11_TYPE_CASTER(at::Tensor, _("at::Tensor"));

  bool load(handle src, bool) {
    paddle::pybind::EnableTensorOperantsToPhiMode();
    PyObject* obj = src.ptr();
    if (paddle::pybind::PyCheckTensor(obj)) {
      value = paddle::pybind::CastPyArg2Tensor(obj, 0);
      return true;
    }
    return false;
  }

  static handle cast(const at::Tensor& src,
                     return_value_policy /* policy */,
                     handle /* parent */) {
    const auto& src_pd_tensor = src._PD_GetInner();

#ifdef PADDLE_WITH_DISTRIBUTE
    bool return_none =
        phi::distributed::DistTensor::classof(src_pd_tensor.impl().get())
            ? false
            : true;
#else
    bool return_none = true;
#endif
    return handle(paddle::pybind::ToPyObject(
        src_pd_tensor, return_none /* return_py_none_if_not_initialize */));
  }
};
#endif
// Pybind11 bindings for optional types.
// http://pybind11.readthedocs.io/en/stable/advanced/cast/stl.html#c-17-library-containers
template <typename T>
struct type_caster<paddle::optional<T>> : optional_caster<paddle::optional<T>> {
};

}  // namespace detail
}  // namespace pybind11