Skip to content

Commit 2143b79

Browse files
GasoonjiaGasoonjia
committed
[devtool] introduce datasink class to etdump
Pull Request resolved: #8496 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 ghstack-source-id: 267495369 Differential Revision: [D69583422](https://our.internmc.facebook.com/intern/diff/D69583422/)
1 parent 9de9ed4 commit 2143b79

File tree

9 files changed

+432
-14
lines changed

9 files changed

+432
-14
lines changed

‎devtools/etdump/buffer_data_sink.cpp‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
/*
2+
* Copyright (c) Meta Platforms, Inc. and affiliates.
3+
* All rights reserved.
4+
*
5+
* This source code is licensed under the BSD-style license found in the
6+
* LICENSE file in the root directory of this source tree.
7+
*/
8+
9+
#include <executorch/devtools/etdump/buffer_data_sink.h>
10+
#include <executorch/devtools/etdump/utils.h>
11+
12+
using ::executorch::runtime::Error;
13+
using ::executorch::runtime::Result;
14+
15+
namespace executorch {
16+
namespace etdump {
17+
18+
Result<size_t> BufferDataSink::write(const void* ptr, size_t length) {
19+
if (length == 0) {
20+
return static_cast<size_t>(-1);
21+
}
22+
23+
uint8_t* last_data_end = debug_buffer_.data() + offset_;
24+
25+
// The beginning of the next data blob must be aligned to the alignment
26+
uint8_t* cur_data_begin = internal::align_pointer(last_data_end, alighment_);
27+
uint8_t* cur_data_end = cur_data_begin + length;
28+
29+
// Raise OutOfResources error if the end of current data blob is out of range.
30+
if (cur_data_end > debug_buffer_.data() + debug_buffer_.size()) {
31+
return Error::OutOfResources;
32+
}
33+
34+
memcpy(cur_data_begin, ptr, length);
35+
36+
offset_ = cur_data_end - debug_buffer_.data();
37+
38+
return (size_t)(cur_data_begin - debug_buffer_.data());
39+
}
40+
41+
Result<size_t> BufferDataSink::get_storage_size() const {
42+
return debug_buffer_.size();
43+
}
44+
45+
size_t BufferDataSink::get_used_bytes() const {
46+
return offset_;
47+
}
48+
49+
} // namespace etdump
50+
} // namespace executorch

‎devtools/etdump/buffer_data_sink.h‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
/*
2+
* Copyright (c) Meta Platforms, Inc. and affiliates.
3+
* All rights reserved.
4+
*
5+
* This source code is licensed under the BSD-style license found in the
6+
* LICENSE file in the root directory of this source tree.
7+
*/
8+
9+
#pragma once
10+
11+
#include <executorch/devtools/etdump/data_sink_base.h>
12+
#include <executorch/runtime/core/exec_aten/exec_aten.h>
13+
#include <executorch/runtime/core/span.h>
14+
15+
namespace executorch {
16+
namespace etdump {
17+
18+
/**
19+
* BufferDataSink is a concrete implementation of the DataSinkBase class,
20+
* designed to store debug data in a pre-allocated, user-owned buffer. This
21+
* class provides methods to write raw data and tensor data into the buffer,
22+
* ensuring proper alignment and managing padding as needed. It is the standard
23+
* DataSink used by ETDumpGen.
24+
*/
25+
class BufferDataSink : public DataSinkBase {
26+
public:
27+
/**
28+
* Constructs a BufferDataSink with a given buffer.
29+
*
30+
* @param[in] buffer A Span object representing the buffer where data will be
31+
* stored.
32+
*/
33+
explicit BufferDataSink(::executorch::runtime::Span<uint8_t> buffer)
34+
: debug_buffer_(buffer), offset_(0), alighment_(64) {}
35+
36+
// Uncopiable and unassignable to avoid double assignment and free of the
37+
// internal buffer.
38+
BufferDataSink(const BufferDataSink&) = delete;
39+
BufferDataSink& operator=(const BufferDataSink&) = delete;
40+
41+
// Movable to be compatible with Result.
42+
BufferDataSink(BufferDataSink&&) = default;
43+
BufferDataSink& operator=(BufferDataSink&&) = default;
44+
45+
~BufferDataSink() override = default;
46+
47+
/**
48+
* Write data into the debug buffer and return the offset of the starting
49+
* location of the data within the buffer.
50+
*
51+
* @param[in] ptr A pointer to the data to be written into the storage.
52+
* @param[in] size The size of the data in bytes.
53+
* @return A Result object containing either:
54+
* - The offset of the starting location of the data within the
55+
* debug buffer, or
56+
* - An error code indicating the failure reason, if any issue
57+
* occurs during the write process.
58+
*/
59+
::executorch::runtime::Result<size_t> write(const void* ptr, size_t size)
60+
override;
61+
62+
/**
63+
* Retrieves the total size of the buffer.
64+
*
65+
* @return A Result object containing the total size of the buffer in bytes.
66+
*/
67+
::executorch::runtime::Result<size_t> get_storage_size() const override;
68+
69+
/**
70+
* Retrieves the number of bytes currently used in the buffer.
71+
*
72+
* @return The amount of data currently stored in the buffer in bytes.
73+
*/
74+
size_t get_used_bytes() const override;
75+
76+
private:
77+
// A Span object representing the buffer used for storing debug data.
78+
::executorch::runtime::Span<uint8_t> debug_buffer_;
79+
80+
// The offset of the next available location in the buffer.
81+
size_t offset_;
82+
83+
// The alignment of the buffer.
84+
size_t alighment_;
85+
};
86+
87+
} // namespace etdump
88+
} // namespace executorch

‎devtools/etdump/data_sink_base.h‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
/*
2+
* Copyright (c) Meta Platforms, Inc. and affiliates.
3+
* All rights reserved.
4+
*
5+
* This source code is licensed under the BSD-style license found in the
6+
* LICENSE file in the root directory of this source tree.
7+
*/
8+
9+
#pragma once
10+
11+
#include <executorch/runtime/core/exec_aten/exec_aten.h>
12+
#include <executorch/runtime/core/result.h>
13+
14+
namespace executorch {
15+
namespace etdump {
16+
17+
/**
18+
* DataSinkBase is an abstract class that users can inherit and implement
19+
* to customize the storage and management of debug data in ETDumpGen. This
20+
* class provides a basic and essential interface for writing datablob to a
21+
* user-defined storage, retrieving storage capacity, and tracking the amount of
22+
* data stored.
23+
*/
24+
class DataSinkBase {
25+
public:
26+
/**
27+
* Virtual destructor to ensure proper cleanup of derived classes.
28+
*/
29+
virtual ~DataSinkBase() = default;
30+
/**
31+
* Write data into the debug storage. This method should be implemented
32+
* by derived classes to handle the specifics of data storage.
33+
*
34+
* This function should return the offset of the starting location of the
35+
* data within the debug storage if the write operation succeeds, or an
36+
* Error code if any issue occurs during the write process.
37+
*
38+
* @param[in] ptr A pointer to the data to be written into the storage.
39+
* @param[in] length The size of the data in bytes.
40+
* @return A Result object containing either:
41+
* - The offset of the starting location of the data within the
42+
* debug storage, which will be recorded in the corresponding
43+
* metadata of ETDump, or
44+
* - An error code indicating the failure reason, if any issue
45+
* occurs during the write process.
46+
*/
47+
virtual ::executorch::runtime::Result<size_t> write(
48+
const void* ptr,
49+
size_t length) = 0;
50+
/**
51+
* Get the maximum capacity of the debug storage in bytes.
52+
* Should return Error::NotSupported if the capacity is not available
53+
* (e.g. unbounded storage like internet or file)
54+
*
55+
* @return A Result object containing either:
56+
* - The total size of the debug storage, or
57+
* - An error code indicating the failure reason, if any issue
58+
* occurs when retrieving the storage capacity.
59+
*/
60+
virtual ::executorch::runtime::Result<size_t> get_storage_size() const = 0;
61+
/**
62+
* Get the number of bytes currently used in the debug storage.
63+
*
64+
* @return The amount of data currently stored in bytes.
65+
*/
66+
virtual size_t get_used_bytes() const = 0;
67+
};
68+
69+
} // namespace etdump
70+
} // namespace executorch

‎devtools/etdump/etdump_flatcc.cpp‎

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
#include <executorch/devtools/etdump/emitter.h>
1414
#include <executorch/devtools/etdump/etdump_schema_flatcc_builder.h>
1515
#include <executorch/devtools/etdump/etdump_schema_flatcc_reader.h>
16+
#include <executorch/devtools/etdump/utils.h>
1617
#include <executorch/runtime/core/exec_aten/exec_aten.h>
1718
#include <executorch/runtime/core/exec_aten/util/scalar_type_util.h>
1819
#include <executorch/runtime/platform/assert.h>
@@ -94,16 +95,6 @@ etdump_Tensor_ref_t add_tensor_entry(
9495
return etdump_Tensor_end(builder_);
9596
}
9697

97-
static uint8_t* alignPointer(void* ptr, size_t alignment) {
98-
intptr_t addr = reinterpret_cast<intptr_t>(ptr);
99-
if ((addr & (alignment - 1)) == 0) {
100-
// Already aligned.
101-
return reinterpret_cast<uint8_t*>(ptr);
102-
}
103-
addr = (addr | (alignment - 1)) + 1;
104-
return reinterpret_cast<uint8_t*>(addr);
105-
}
106-
10798
} // namespace
10899

109100
// Constructor implementation
@@ -113,9 +104,10 @@ ETDumpGen::ETDumpGen(Span<uint8_t> buffer) {
113104
// Initialize the flatcc builder_ using the buffer and buffer size.
114105

115106
if (buffer.data() != nullptr) {
116-
builder_ = (struct flatcc_builder*)alignPointer(buffer.data(), 64);
117-
uintptr_t buffer_with_builder =
118-
(uintptr_t)alignPointer(builder_ + sizeof(struct flatcc_builder), 64);
107+
builder_ =
108+
(struct flatcc_builder*)internal::align_pointer(buffer.data(), 64);
109+
uintptr_t buffer_with_builder = (uintptr_t)internal::align_pointer(
110+
builder_ + sizeof(struct flatcc_builder), 64);
119111
size_t builder_size =
120112
(size_t)(buffer_with_builder - (uintptr_t)buffer.data());
121113
size_t min_buf_size = max_alloc_buf_size + builder_size;
@@ -513,7 +505,7 @@ size_t ETDumpGen::copy_tensor_to_debug_buffer(executorch::aten::Tensor tensor) {
513505
return static_cast<size_t>(-1);
514506
}
515507
uint8_t* offset_ptr =
516-
alignPointer(debug_buffer_.data() + debug_buffer_offset_, 64);
508+
internal::align_pointer(debug_buffer_.data() + debug_buffer_offset_, 64);
517509
debug_buffer_offset_ = (offset_ptr - debug_buffer_.data()) + tensor.nbytes();
518510
ET_CHECK_MSG(
519511
debug_buffer_offset_ <= debug_buffer_.size(),

‎devtools/etdump/targets.bzl‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,54 @@ def define_common_targets():
8787
exported_external_deps = ["flatccrt"],
8888
)
8989

90+
runtime.cxx_library(
91+
name = "utils",
92+
srcs = [],
93+
exported_headers = [
94+
"utils.h",
95+
],
96+
visibility = [
97+
98+
],
99+
)
100+
90101
for aten_mode in (True, False):
91102
aten_suffix = "_aten" if aten_mode else ""
103+
104+
runtime.cxx_library(
105+
name = "data_sink_base" + aten_suffix,
106+
exported_headers = [
107+
"data_sink_base.h",
108+
],
109+
exported_deps = [
110+
"//executorch/runtime/core/exec_aten/util:scalar_type_util" + aten_suffix,
111+
],
112+
visibility = [
113+
"//executorch/...",
114+
"@EXECUTORCH_CLIENTS",
115+
],
116+
)
117+
118+
runtime.cxx_library(
119+
name = "buffer_data_sink" + aten_suffix,
120+
headers = [
121+
"buffer_data_sink.h",
122+
],
123+
srcs = [
124+
"buffer_data_sink.cpp",
125+
],
126+
deps = [
127+
":utils",
128+
],
129+
exported_deps = [
130+
"//executorch/runtime/core/exec_aten:lib" + aten_suffix,
131+
":data_sink_base" + aten_suffix,
132+
],
133+
visibility = [
134+
"//executorch/...",
135+
"@EXECUTORCH_CLIENTS",
136+
],
137+
)
92138
runtime.cxx_library(
93139
name = "etdump_flatcc" + aten_suffix,
94140
srcs = [
@@ -106,6 +152,7 @@ def define_common_targets():
106152
],
107153
exported_deps = [
108154
":etdump_schema_flatcc",
155+
":utils",
109156
"//executorch/runtime/core:event_tracer" + aten_suffix,
110157
"//executorch/runtime/core/exec_aten/util:scalar_type_util" + aten_suffix,
111158
],

0 commit comments

Comments
 (0)