Update on "[devtool] introduce datasink class to etdump"

this diff introduce datasink class, the class for managing the customized debug data storage pipeline.

Detials can be found in https://docs.google.com/document/d/1y_m32mKdj-OgLcLUz9TKhBW3PC3bBDYSBbeAH544EfM/edit?tab=t.0

Differential Revision: [D69583422](https://our.internmc.facebook.com/intern/diff/D69583422/)

[ghstack-poisoned]

Author: Gasoonjia

devtools/etdump/buffer_data_sink.cpp

@@ -37,11 +37,6 @@ Result<size_t> BufferDataSink::write(const void* ptr, size_t length) {
   return (size_t)(offset_ptr - debug_buffer_.data());
 }
 
-Result<size_t> BufferDataSink::write_tensor(
-    const executorch::aten::Tensor& tensor) {
-  return write(tensor.const_data_ptr(), tensor.nbytes());
-}
-
 Result<size_t> BufferDataSink::get_storage_size() const {
   return debug_buffer_.size();
 }

devtools/etdump/buffer_data_sink.h

@@ -35,35 +35,24 @@ class BufferDataSink : public DataSinkBase {
 
   BufferDataSink(const BufferDataSink&) = delete;
   BufferDataSink& operator=(const BufferDataSink&) = delete;
+  BufferDataSink(BufferDataSink&&) = default;
+  BufferDataSink& operator=(BufferDataSink&&) = default;
 
   /**
    * Write data into the debug buffer and return the offset of the starting
    * location of the data within the buffer.
    *
    * @param[in] ptr A pointer to the data to be written into the storage.
-   * @param[in] length The size of the data in bytes.
+   * @param[in] size The size of the data in bytes.
    * @return A Result object containing either:
    *         - The offset of the starting location of the data within the
    *           debug buffer, or
    *         - An error code indicating the failure reason, if any issue
    *           occurs during the write process.
    */
-  ::executorch::runtime::Result<size_t> write(const void* ptr, size_t length)
+  ::executorch::runtime::Result<size_t> write(const void* ptr, size_t size)
       override;
 
-  /**
-   * Write tensor into the debug buffer and return the offset of the starting
-   * location of the data within the buffer.
-   * @param[in] tensor A reference to the tensor whose data is to be written.
-   * @return A Result object containing either:
-   *         - The offset of the starting location of the data within the
-   *           debug buffer, or
-   *         - An error code indicating the failure reason, if any issue
-   *           occurs during the write process.
-   */
-  ::executorch::runtime::Result<size_t> write_tensor(
-      const executorch::aten::Tensor& tensor);
-
   /**
    * Retrieves the total size of the buffer.
    *

devtools/etdump/tests/buffer_data_sink_test.cpp

@@ -54,7 +54,8 @@ TEST_F(BufferDataSinkTest, WriteOneTensorAndCheckData) {
   TensorFactory<ScalarType::Float> tf;
   Tensor tensor = tf.make({1, 4}, {1.0, 2.0, 3.0, 4.0});
 
-  Result<size_t> ret = data_sink_->write_tensor(tensor);
+  Result<size_t> ret =
+      data_sink_->write(tensor.const_data_ptr(), tensor.nbytes());
   ASSERT_EQ(ret.error(), Error::Ok);
 
   size_t offset = ret.get();
@@ -75,7 +76,8 @@ TEST_F(BufferDataSinkTest, WriteMultiTensorsAndCheckData) {
       tf.make({1, 4}, {1.0, 2.0, 3.0, 4.0}),
       tf.make({1, 4}, {5.0, 6.0, 7.0, 8.0})};
   for (const auto& tensor : tensors) {
-    Result<size_t> ret = data_sink_->write_tensor(tensor);
+    Result<size_t> ret =
+        data_sink_->write(tensor.const_data_ptr(), tensor.nbytes());
     ASSERT_EQ(ret.error(), Error::Ok);
 
     size_t offset = ret.get();
@@ -92,7 +94,8 @@ TEST_F(BufferDataSinkTest, WriteMultiTensorsAndCheckData) {
 TEST_F(BufferDataSinkTest, PointerAlignmentCheck) {
   TensorFactory<ScalarType::Float> tf;
   Tensor tensor = tf.make({1, 4}, {1.0, 2.0, 3.0, 4.0});
-  Result<size_t> ret = data_sink_->write_tensor(tensor);
+  Result<size_t> ret =
+      data_sink_->write(tensor.const_data_ptr(), tensor.nbytes());
   ASSERT_EQ(ret.error(), Error::Ok);
 
   size_t offset = ret.get();
@@ -108,11 +111,13 @@ TEST_F(BufferDataSinkTest, WriteUntilOverflow) {
 
   // Write tensors until we run out of space
   for (size_t i = 0; i < 2; i++) {
-    Result<size_t> ret = data_sink_->write_tensor(tensor);
+    Result<size_t> ret =
+        data_sink_->write(tensor.const_data_ptr(), tensor.nbytes());
     ASSERT_EQ(ret.error(), Error::Ok);
   }
 
   // Attempting to write another tensor should raise an error
-  Result<size_t> ret = data_sink_->write_tensor(tensor);
+  Result<size_t> ret =
+      data_sink_->write(tensor.const_data_ptr(), tensor.nbytes());
   ASSERT_EQ(ret.error(), Error::AccessFailed);
 }