[Eager][PHI] Fix eager Tensor deepcopy for 0 size Tensor (#68862)

SigureMo · web-flow · commit d711d9ed5208 · 2024-10-24T10:34:16.000+08:00
diff --git a/paddle/fluid/eager/eager_tensor.h b/paddle/fluid/eager/eager_tensor.h
@@ -130,6 +130,8 @@ class VariableCompatTensor
 
   bool valid() const override { return IsInitialized(); }
 
+  bool has_allocation() const override { return IsInitialized(); }
+
   bool initialized() const override { return IsInitialized(); }
 
   void* AllocateFrom(phi::Allocator* allocator UNUSED,
diff --git a/paddle/fluid/pir/dialect/operator/ir/ir_selected_rows.h b/paddle/fluid/pir/dialect/operator/ir/ir_selected_rows.h
@@ -74,6 +74,11 @@ class IrSelectedRows
 
   bool valid() const noexcept override { return true; }
 
+  bool has_allocation() const override {
+    PADDLE_THROW(::common::errors::Unavailable(
+        "`has_allocation` is only available at runtime"));
+  }
+
   bool initialized() const override { return true; }
 
   void* AllocateFrom(phi::Allocator* allocator,
diff --git a/paddle/fluid/pir/dialect/operator/ir/ir_sparse_tensor.h b/paddle/fluid/pir/dialect/operator/ir/ir_sparse_tensor.h
@@ -75,6 +75,11 @@ class IrSparseCooTensor
 
   bool valid() const noexcept override { return true; }
 
+  bool has_allocation() const override {
+    PADDLE_THROW(::common::errors::Unavailable(
+        "`has_allocation` is only available at runtime"));
+  }
+
   bool initialized() const override { return true; }
 
   void* AllocateFrom(phi::Allocator* allocator,
@@ -151,6 +156,8 @@ class IrSparseCsrTensor
 
   bool valid() const noexcept override { return true; }
 
+  bool has_allocation() const override { return true; }
+
   bool initialized() const override { return true; }
 
   void* AllocateFrom(phi::Allocator* allocator,
diff --git a/paddle/fluid/pir/dialect/operator/ir/ir_tensor.h b/paddle/fluid/pir/dialect/operator/ir/ir_tensor.h
@@ -73,6 +73,11 @@ class IrTensor : public phi::TensorBase,
 
   bool valid() const noexcept override { return true; }
 
+  bool has_allocation() const override {
+    PADDLE_THROW(::common::errors::Unavailable(
+        "`has_allocation` is only available at runtime"));
+  }
+
   bool initialized() const override { return true; }
 
   void* AllocateFrom(phi::Allocator* allocator,
diff --git a/paddle/fluid/pybind/eager_method.cc b/paddle/fluid/pybind/eager_method.cc
@@ -693,11 +693,11 @@ static PyObject* tensor_method_copy_(TensorObject* self,
     egr::EagerUtils::autograd_meta(&(self->tensor))
         ->SetPersistable(
             egr::EagerUtils::autograd_meta(&(src_tensor))->Persistable());
-    if (src_tensor.initialized()) {
+    if (src_tensor.has_allocation()) {
       self->tensor.copy_(src_tensor, src_tensor.place(), blocking);
     }
   } else {
-    if (src_tensor.initialized()) {
+    if (src_tensor.has_allocation()) {
       eager_gil_scoped_release guard;
       self->tensor.copy_(src_tensor, self->tensor.place(), blocking);
     }
diff --git a/paddle/phi/api/include/tensor.h b/paddle/phi/api/include/tensor.h
@@ -498,6 +498,13 @@ class PADDLE_API Tensor final {
    */
   bool defined() const;
 
+  /**
+   * @brief Determine whether Tensor has allocation
+   *
+   * @return bool
+   */
+  bool has_allocation() const;
+
   /**
    * @brief Determine whether Tensor is initialized.
    *
diff --git a/paddle/phi/api/lib/tensor.cc b/paddle/phi/api/lib/tensor.cc
@@ -411,6 +411,10 @@ void Tensor::set_name(const std::string &name) { name_ = name; }
 
 bool Tensor::defined() const { return impl_ != nullptr; }
 
+bool Tensor::has_allocation() const {
+  return defined() && impl_->has_allocation();
+}
+
 bool Tensor::initialized() const { return defined() && impl_->initialized(); }
 
 bool Tensor::is_initialized() const {
diff --git a/paddle/phi/api/lib/tensor_method.cc b/paddle/phi/api/lib/tensor_method.cc
@@ -87,7 +87,7 @@ Tensor::copy_to<phi::dtype::float16>(const Place &target_place) const;
 void Tensor::copy_(const Tensor &src,
                    const phi::Place &target_place,
                    bool blocking) {
-  if (!src.initialized()) {
+  if (!src.has_allocation()) {
     VLOG(8) << "Src is empty, skip copy";
     return;
   }
diff --git a/paddle/phi/core/dense_tensor.h b/paddle/phi/core/dense_tensor.h
@@ -128,6 +128,10 @@ class TEST_API DenseTensor : public TensorBase,
   /// return Whether the allocation is allocated.
   bool initialized() const override { return holder_ && holder_->ptr(); }
 
+  /// \brief Test whether the holder is created.
+  /// \return Whether the holder is created.
+  bool has_allocation() const override { return holder_ != nullptr; }
+
   /// \brief Allocate memory with requested size from allocator.
   /// \return The mutable data pointer value of type T.
   void* AllocateFrom(Allocator* allocator,
diff --git a/paddle/phi/core/distributed/auto_parallel/dist_tensor.cc b/paddle/phi/core/distributed/auto_parallel/dist_tensor.cc
@@ -273,6 +273,10 @@ bool DistTensor::valid() const {
 
 bool DistTensor::defined() const { return value_->holder_ != nullptr; }
 
+bool DistTensor::has_allocation() const {
+  return value_->holder_ != nullptr && (value_->holder_->ptr() || numel() != 0);
+}
+
 bool DistTensor::initialized() const {
   return value_->holder_ != nullptr && value_->holder_->ptr();
 }
diff --git a/paddle/phi/core/distributed/auto_parallel/dist_tensor.h b/paddle/phi/core/distributed/auto_parallel/dist_tensor.h
@@ -147,6 +147,10 @@ class DistTensor final
   /// \return The global dims of the dist tensor.
   const DDim& local_dims() const;
 
+  /// \brief Test whether the holder is created.
+  /// \return Whether the holder is created.
+  bool has_allocation() const override;
+
   /// \brief Returns the global number of elements contained in tensor.
   /// \return The number of elements contained in tensor.
   int64_t numel() const override;
diff --git a/paddle/phi/core/extended_tensor.cc b/paddle/phi/core/extended_tensor.cc
@@ -47,6 +47,11 @@ bool ExtendedTensor::valid() const {
       "ExtendedTensor does not support `valid` method."));
 }
 
+bool ExtendedTensor::has_allocation() const {
+  PADDLE_THROW(common::errors::Unavailable(
+      "ExtendedTensor does not support `has_allocation` method."));
+}
+
 bool ExtendedTensor::initialized() const {
   PADDLE_THROW(common::errors::Unavailable(
       "ExtendedTensor does not support `initialized` method."));
diff --git a/paddle/phi/core/extended_tensor.h b/paddle/phi/core/extended_tensor.h
@@ -47,6 +47,8 @@ class TEST_API ExtendedTensor : public TensorBase {
 
   bool valid() const override;
 
+  bool has_allocation() const override;
+
   bool initialized() const override;
 
   void* AllocateFrom(Allocator* allocator,
diff --git a/paddle/phi/core/selected_rows.h b/paddle/phi/core/selected_rows.h
@@ -160,6 +160,10 @@ class SelectedRows : public TensorBase,
   /// \return Whether the metadata is valid.
   bool valid() const noexcept override { return impl_->valid(); }
 
+  /// \brief Test whether the holder is created.
+  /// \return Whether the holder is created.
+  bool has_allocation() const override { return impl_->has_allocation(); }
+
   /// \brief Test whether the storage is allocated.
   /// return Whether the storage is allocated.
   bool initialized() const override { return impl_->initialized(); }
diff --git a/paddle/phi/core/selected_rows_impl.h b/paddle/phi/core/selected_rows_impl.h
@@ -179,6 +179,10 @@ class SelectedRowsImpl {
   /// \return Whether the metadata is valid.
   bool valid() const noexcept { return value_->valid(); }
 
+  /// \brief Test whether the holder is created.
+  /// \return Whether the holder is created.
+  bool has_allocation() const { return value_->has_allocation(); }
+
   /// \brief Test whether the storage is allocated.
   /// return Whether the storage is allocated.
   bool initialized() const { return value_->initialized(); }
diff --git a/paddle/phi/core/sparse_coo_tensor.h b/paddle/phi/core/sparse_coo_tensor.h
@@ -126,6 +126,10 @@ class SparseCooTensor : public TensorBase,
   /// \return Whether the non_zero_elements_ metadata is valid.
   bool valid() const noexcept override { return non_zero_elements_.valid(); }
 
+  /// \brief Test whether the holder is created.
+  /// \return Whether the holder is created.
+  bool has_allocation() const override { return values().has_allocation(); }
+
   /// \brief Test whether the non_zero_elements_ storage is allocated.
   /// In special cases, when nnz=0, non_zero_elements_ will not need to be
   /// initialized, but it is necessary to return true here, otherwise the
diff --git a/paddle/phi/core/sparse_csr_tensor.h b/paddle/phi/core/sparse_csr_tensor.h
@@ -130,6 +130,10 @@ class SparseCsrTensor : public TensorBase,
   /// \return Whether the non_zero_elements_ metadata is valid.
   bool valid() const noexcept override { return non_zero_elements_.valid(); }
 
+  /// \brief Test whether the holder is created.
+  /// \return Whether the holder is created.
+  bool has_allocation() const override { return values().has_allocation(); }
+
   /// \brief Test whether the non_zero_elements_ storage is allocated.
   /// In special cases, when nnz=0, non_zero_elements_ will not need to be
   /// initialized, but it is necessary to return true here, otherwise the
diff --git a/paddle/phi/core/string_tensor.h b/paddle/phi/core/string_tensor.h
@@ -97,6 +97,10 @@ class StringTensor : public TensorBase,
   /// \return Whether the metadata is valid.
   bool valid() const noexcept override { return meta_.valid(); }
 
+  /// \brief Test whether the holder is created.
+  /// \return Whether the holder is created.
+  bool has_allocation() const override { return holder_ != nullptr; }
+
   /// \brief Test whether the storage is allocated.
   /// return Whether the storage is allocated.
   bool initialized() const override { return holder_ && holder_->ptr(); }
diff --git a/paddle/phi/core/tensor_array.cc b/paddle/phi/core/tensor_array.cc
@@ -21,6 +21,21 @@ TensorArray::TensorArray(const std::vector<DenseTensor>& vec) {
   tensors_ = vec;
 }
 
+/// \brief Test whether the holder is created.
+/// \return Whether the holder is created.
+bool TensorArray::has_allocation() const {
+  if (tensors_.empty()) {
+    return false;
+  }
+
+  for (auto const& tensor : tensors_) {
+    if (!tensor.has_allocation()) {
+      return false;
+    }
+  }
+  return true;
+}
+
 /// \brief Test whether the tensor's storage in TensorArray is allocated.
 /// return Whether all tensors in TensorArray is allocated.
 bool TensorArray::initialized() const {
diff --git a/paddle/phi/core/tensor_array.h b/paddle/phi/core/tensor_array.h
@@ -78,6 +78,10 @@ class TensorArray : public TensorBase,
   /// \brief This overridden function is not used in TensorArray.
   TEST_API bool valid() const override;
 
+  /// \brief Test whether the holder is created.
+  /// \return Whether the holder is created.
+  TEST_API bool has_allocation() const override;
+
   /// \brief Test whether the tensor's storage in TensorArray is allocated.
   /// return Whether all tensors in TensorArray is allocated.
   TEST_API bool initialized() const override;
diff --git a/paddle/phi/core/tensor_base.h b/paddle/phi/core/tensor_base.h
@@ -52,6 +52,10 @@ class TensorBase {
   /// \return Whether the metadata is valid.
   virtual bool valid() const = 0;
 
+  /// \brief Test whether the holder is created.
+  /// \return Whether the holder is created.
+  virtual bool has_allocation() const = 0;
+
   /// \brief Test whether the storage is allocated.
   /// \return Whether the storage is allocated.
   virtual bool initialized() const = 0;
diff --git a/test/legacy_test/test_eager_tensor.py b/test/legacy_test/test_eager_tensor.py
@@ -542,6 +542,17 @@ def test_deep_copy(self):
                 np.array(selected_rows.get_tensor()),
             )
 
+    def test_deep_copy_0size_tensor(self):
+        x = paddle.to_tensor(np.array([]))
+        x_copy = copy.deepcopy(x)
+        self.assertEqual(x_copy.stop_gradient, x.stop_gradient)
+        self.assertEqual(x_copy.persistable, x.persistable)
+        self.assertEqual(x_copy.type, x.type)
+        self.assertEqual(x_copy.dtype, x.dtype)
+        self.assertEqual(x_copy.shape, x.shape)
+        self.assertEqual(str(x_copy.place), str(x.place))
+        np.testing.assert_array_equal(x.numpy(), x_copy.numpy())
+
     # test some patched methods
     def test_set_value(self):
         var = paddle.to_tensor(self.array)

Original file line number	Diff line number	Diff line change
`@@ -693,11 +693,11 @@ static PyObject* tensor_method_copy_(TensorObject* self,`
`693`	`693`	`egr::EagerUtils::autograd_meta(&(self->tensor))`
`694`	`694`	`->SetPersistable(`
`695`	`695`	`egr::EagerUtils::autograd_meta(&(src_tensor))->Persistable());`
`696`		`- if (src_tensor.initialized()) {`
	`696`	`+ if (src_tensor.has_allocation()) {`
`697`	`697`	`self->tensor.copy_(src_tensor, src_tensor.place(), blocking);`
`698`	`698`	`}`
`699`	`699`	`} else {`
`700`		`- if (src_tensor.initialized()) {`
	`700`	`+ if (src_tensor.has_allocation()) {`
`701`	`701`	`eager_gil_scoped_release guard;`
`702`	`702`	`self->tensor.copy_(src_tensor, self->tensor.place(), blocking);`
`703`	`703`	`}`
Original file line number	Diff line number	Diff line change
`@@ -87,7 +87,7 @@ Tensor::copy_to<phi::dtype::float16>(const Place &target_place) const;`
`87`	`87`	`void Tensor::copy_(const Tensor &src,`
`88`	`88`	`const phi::Place &target_place,`
`89`	`89`	`bool blocking) {`
`90`		`- if (!src.initialized()) {`
	`90`	`+ if (!src.has_allocation()) {`
`91`	`91`	`VLOG(8) << "Src is empty, skip copy";`
`92`	`92`	`return;`
`93`	`93`	`}`
Original file line number	Diff line number	Diff line change
`@@ -273,6 +273,10 @@ bool DistTensor::valid() const {`
`273`	`273`
`274`	`274`	`bool DistTensor::defined() const { return value_->holder_ != nullptr; }`
`275`	`275`
	`276`	`+bool DistTensor::has_allocation() const {`
	`277`	`+ return value_->holder_ != nullptr && (value_->holder_->ptr() \|\| numel() != 0);`
	`278`	`+}`
	`279`	`+`
`276`	`280`	`bool DistTensor::initialized() const {`
`277`	`281`	`return value_->holder_ != nullptr && value_->holder_->ptr();`
`278`	`282`	`}`