Remove read_file.h

Differential Revision: D61749168

Pull Request resolved: #4912

Author: dbort

CMakeLists.txt

@@ -693,7 +693,6 @@ if(EXECUTORCH_BUILD_PYBIND)
     util
     ${CMAKE_CURRENT_SOURCE_DIR}/extension/evalue_util/print_evalue.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/extension/aten_util/aten_bridge.cpp
-    ${CMAKE_CURRENT_SOURCE_DIR}/util/read_file.cpp
   )
   target_include_directories(
     util PUBLIC ${_common_include_directories} ${TORCH_INCLUDE_DIRS}

docs/source/sdk-bundled-io.md

@@ -211,21 +211,19 @@ We need the pointer to ExecuTorch program to do the execution. To unify the proc
 
 Here's an example of how to use the `GetProgramData` API:
 ```c++
-std::shared_ptr<char> buff_ptr;
-size_t buff_len;
-
-// FILE_PATH here can be either BundledProgram or Program flatbuffer file.
-Error status = torch::executor::util::read_file_content(
-    FILE_PATH, &buff_ptr, &buff_len);
-ET_CHECK_MSG(
-    status == Error::Ok,
-    "read_file_content() failed with status 0x%" PRIx32,
-    status);
-
+// Assume that the user has read the contents of the file into file_data using
+// whatever method works best for their application. The file could contain
+// either BundledProgram data or Program data.
+void* file_data = ...;
+size_t file_data_len = ...;
+
+// If file_data contains a BundledProgram, GetProgramData() will return a
+// pointer to the Program data embedded inside it. Otherwise it will return
+// file_data, which already pointed to Program data.
 const void* program_ptr;
 size_t program_len;
 status = torch::executor::bundled_program::GetProgramData(
-    buff_ptr.get(), buff_len, &program_ptr, &program_len);
+    file_data, file_data_len, &program_ptr, &program_len);
 ET_CHECK_MSG(
     status == Error::Ok,
     "GetProgramData() failed with status 0x%" PRIx32,

docs/website/docs/tutorials/bundled_program.md

@@ -49,19 +49,15 @@ Error GetProgramData(
 
 Here's an example of how to use the GetProgramData API:
 ```c++
-  std::shared_ptr<char> buff_ptr;
-  size_t buff_len;
-
-// FILE_PATH here can be either BundledProgram or Program flatbuffer file.
-  Error status = torch::executor::util::read_file_content(
-      FILE_PATH, &buff_ptr, &buff_len);
-  ET_CHECK_MSG(
-      status == Error::Ok,
-      "read_file_content() failed with status 0x%" PRIx32,
-      status);
-
-  uint32_t prof_tok = EXECUTORCH_BEGIN_PROF("de-serialize model");
-
+  // Assume that the user has read the contents of the file into file_data using
+  // whatever method works best for their application. The file could contain
+  // either BundledProgram data or Program data.
+  void* file_data = ...;
+  size_t file_data_len = ...;
+
+  // If file_data contains a BundledProgram, GetProgramData() will return a
+  // pointer to the Program data embedded inside it. Otherwise it will return
+  // file_data, which already pointed to Program data.
   const void* program_ptr;
   size_t program_len;
   status = torch::executor::bundled_program::GetProgramData(
@@ -122,14 +118,13 @@ ET_NODISCARD Error VerifyResultWithBundledExpectedOutput(
 
 ### Example
 
-Here we provide an example about how to run the bundled program step by step. Most of the code are borrowed from "fbcode/executorch/devtools/fb/runners/executor_runner.cpp" and please review that file if you need more info and context:
+Here we provide an example about how to run the bundled program step by step.
 
 ```c++
     // method_name is the name for the method we want to test
     // memory_manager is the executor::MemoryManager variable for executor memory allocation.
     // program is the executorch program.
     Result<Method> method = program->load_method(method_name, &memory_manager);
-    EXECUTORCH_END_PROF(prof_tok);
     ET_CHECK_MSG(
         method.ok(),
         "load_method() failed with status 0x%" PRIx32,

extension/pybindings/pybindings.cpp

@@ -31,7 +31,6 @@
 #include <executorch/runtime/platform/platform.h>
 #include <executorch/runtime/platform/profiler.h>
 #include <executorch/runtime/platform/runtime.h>
-#include <executorch/util/read_file.h>
 
 #include <ATen/Functions.h>
 #include <ATen/Tensor.h>

shim/xplat/executorch/extension/pybindings/pybindings.bzl

@@ -29,7 +29,6 @@ ATEN_MODULE_DEPS = [
     "//executorch/extension/data_loader:buffer_data_loader",
     "//executorch/extension/data_loader:mmap_data_loader",
     "//executorch/extension/memory_allocator:malloc_memory_allocator",
-    "//executorch/util:read_file",
     "//executorch/devtools/bundled_program:runtime_aten",
     "//executorch/runtime/executor/test:test_backend_compiler_lib_aten",
     "//executorch/devtools/etdump:etdump_flatcc",
@@ -55,7 +54,6 @@ def executorch_pybindings(python_module_name, srcs = [], cppdeps = [], visibilit
         ],
         deps = [
             "//executorch/runtime/core:core",
-            "//executorch/util:read_file",
         ] + cppdeps,
         external_deps = [
             "pybind11",

util/read_file.cpp

@@ -7,20 +7,6 @@ def define_common_targets():
     TARGETS and BUCK files that call this function.
     """
 
-    runtime.cxx_library(
-        name = "read_file",
-        srcs = ["read_file.cpp"],
-        exported_headers = ["read_file.h"],
-        visibility = [
-            "//executorch/...",
-            "@EXECUTORCH_CLIENTS",
-        ],
-        exported_deps = [
-            "//executorch/runtime/core:core",
-            "//executorch/runtime/platform:compiler",
-        ],
-    )
-
     for aten_mode in (True, False):
         aten_suffix = ("_aten" if aten_mode else "")