react-native-executorch 0.5.2 → 0.5.4

package/third-party/ios/ExecutorchLib/frameworks/executorch.xcframework/ios-arm64/Headers/executorch/runtime/executor/program.h

@@ -1,320 +0,0 @@
-/*
- * Copyright (c) Meta Platforms, Inc. and affiliates.
- * All rights reserved.
- *
- * This source code is licensed under the BSD-style license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-#pragma once
-
-#ifdef __GNUC__
-// Disable -Wdeprecated-declarations, as some builds use 'Werror'.
-#pragma GCC diagnostic push
-#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
-#endif
-
-#include <cinttypes>
-#include <cstdint>
-#include <optional>
-
-#include <executorch/runtime/core/data_loader.h>
-#include <executorch/runtime/core/error.h>
-#include <executorch/runtime/core/event_tracer.h>
-#include <executorch/runtime/core/freeable_buffer.h>
-#include <executorch/runtime/core/result.h>
-#include <executorch/runtime/executor/memory_manager.h>
-#include <executorch/runtime/executor/method.h>
-#include <executorch/runtime/executor/method_meta.h>
-#include <executorch/runtime/executor/pte_data_map.h>
-#include <executorch/runtime/platform/compiler.h>
-
-// Forward declare flatbuffer types. This is a public header and must not
-// include the generated flatbuffer header.
-namespace executorch_flatbuffer {
-struct Program;
-} // namespace executorch_flatbuffer
-
-namespace executorch {
-namespace runtime {
-
-namespace testing {
-// Provides test access to private Program methods.
-class ProgramTestFriend;
-} // namespace testing
-
-namespace deserialization {
-// Provides Tensor deserializaiton access to private Program methods.
-class TensorParser;
-} // namespace deserialization
-
-/**
- * A deserialized ExecuTorch program binary.
- */
-class Program final {
-public:
-  /**
-   * Types of validation that the Program can do before parsing the data.
-   */
-  enum class Verification : uint8_t {
-    /**
-     * Do minimal verification of the data, ensuring that the header appears
-     * correct.
-     *
-     * Has minimal runtime overhead.
-     */
-    Minimal,
-    /**
-     * Do full verification of the data, ensuring that internal pointers are
-     * self-consistent and that the data has not been truncated or obviously
-     * corrupted. May not catch all types of corruption, but should guard
-     * against illegal memory operations during parsing.
-     *
-     * Will have higher runtime overhead, scaling with the complexity of the
-     * proram data.
-     */
-    InternalConsistency,
-  };
-
-  /**
-   * Loads a Program from the provided loader. The Program will hold a pointer
-   * to the loader, which must outlive the returned Program instance.
-   *
-   * @param[in] loader The source to load program data from. The Program will
-   *     hold a pointer to this loader, which must outlive the returned Program
-   *     instance.
-   * @param[in] verification The type of verification to do before returning
-   *     success.
-   */
-  ET_NODISCARD static Result<Program>
-  load(DataLoader *loader, Verification verification = Verification::Minimal);
-
-  /// DEPRECATED: Use the lowercase `load()` instead.
-  ET_DEPRECATED ET_NODISCARD static Result<Program>
-  Load(DataLoader *loader, Verification verification = Verification::Minimal) {
-    return load(loader, verification);
-  }
-
-  // Movable, to be compatible with Result.
-  Program(Program &&) noexcept = default;
-  ~Program() = default;
-
-  /**
-   * Get the constant buffer inside Program with index buffer_idx.
-   * @param[in] buffer_idx the index of the buffer in the constant_buffer.
-   * @param[in] nbytes the number of bytes to read from the buffer.
-   * @return The buffer with corresponding index.
-   */
-  Result<const void *> get_constant_buffer_data(size_t buffer_idx,
-                                                size_t nbytes) const;
-
-  /**
-   * Get the named data map from the program.
-   * @return The named data map.
-   */
-  Result<const NamedDataMap *> get_named_data_map() const;
-
-  /**
-   * Returns the number of methods in the program.
-   */
-  size_t num_methods() const;
-
-  /**
-   * Returns the name of the method at particular index.
-   *
-   * @param[in] method_index The index of the method name to retrieve. Must be
-   * less than the value returned by `num_methods()`.
-   *
-   * @returns The name of the requested method. The pointer is owned by the
-   * Program, and has the same lifetime as the Program.
-   */
-  Result<const char *> get_method_name(size_t method_index) const;
-
-  /**
-   * Loads the named method and prepares it for execution.
-   *
-   * @param[in] method_name The name of the method to load.
-   * @param[in] memory_manager The allocators to use during initialization and
-   *     execution of the loaded method. If `memory_manager.temp_allocator()` is
-   *     null, the runtime will allocate temp memory using `et_pal_allocate()`.
-   * @param[in] event_tracer The event tracer to use for this method run.
-   * @param[in] named_data_map An optional map of {name, blob} used to resolve
-   *     data that is external to the PTE, if any.
-   *
-   * @returns The loaded method on success, or an error on failure.
-   */
-  Result<Method>
-  load_method(const char *method_name, MemoryManager *memory_manager,
-              EventTracer *event_tracer = nullptr,
-              const NamedDataMap *named_data_map = nullptr) const;
-
-  /**
-   * Gathers metadata for the named method.
-   *
-   * @param[in] method_name The name of the method to get metadata for.
-   */
-  Result<MethodMeta> method_meta(const char *method_name) const;
-
-  /**
-   * DEPRECATED: Get the pytree encoding string for the output. Deprecated as
-   * this functionality will eventually move out of the core program into a
-   * higher level structure, but that does not exist at this time.
-   * @param[in] method_name The name of the method to get the encoding for.
-   *
-   * @return The pytree encoding string for the output
-   */
-  ET_DEPRECATED Result<const char *>
-  get_output_flattening_encoding(const char *method_name = "forward") const;
-
-  /**
-   * Describes the presence of an ExecuTorch program header.
-   */
-  enum HeaderStatus {
-    /**
-     * An ExecuTorch program header is present, and its version is compatible
-     * with this version of the runtime.
-     */
-    CompatibleVersion,
-
-    /**
-     * An ExecuTorch program header is present, but its version is not
-     * compatible with this version of the runtime.
-     */
-    IncompatibleVersion,
-
-    /**
-     * An ExecuTorch program header is not present.
-     */
-    NotPresent,
-
-    /**
-     * The data provided was too short to find the program header.
-     */
-    ShortData,
-  };
-
-  /**
-   * The minimum number of bytes necessary for calls to `check_header`.
-   */
-  static constexpr size_t kMinHeadBytes = 64;
-
-  /**
-   * Looks for an ExecuTorch program header in the provided data.
-   *
-   * @param[in] data The data from the beginning of a file that might contain
-   *     an ExecuTorch program.
-   * @param[in] size The size of `data` in bytes. Must be >= `kMinHeadBytes`.
-   *
-   * @returns A value describing the presence of a header in the data.
-   */
-  static HeaderStatus check_header(const void *data, size_t size);
-
-private:
-  // Let some classes call these private methods.
-  friend class BackendDelegate;
-  friend class Executor;
-  friend class Method;
-  friend class deserialization::TensorParser;
-  friend class testing::ProgramTestFriend;
-
-  const executorch_flatbuffer::Program *get_internal_program() const {
-    return internal_program_;
-  }
-
-  // Used by Method to look up entries in the delegate data table.
-  Error get_backend_delegate_data(size_t index, const void **out_data,
-                                  size_t *out_size) const;
-
-  /**
-   * Loads a segment by index.
-   *
-   * @param[in] segment_info Struct containing an index to load from the
-   * Program.segments list. The other fields of the struct, such as
-   * `segment_type` and `descriptor`, need to also be correct.
-   *
-   * @returns The data as a FreeableBuffer, if the index is valid.
-   * @retval Error::NotFound The program does not contain any segments or the
-   *     index is out of range.
-   * @returns Other errors depending on the implementation of
-   *     DataLoader: The Program.segment table is inconsistent, or the
-   *     data cannot be accessed.
-   */
-  ET_NODISCARD Result<FreeableBuffer>
-  LoadSegment(const DataLoader::SegmentInfo &segment_info) const;
-
-  /**
-   * Loads a portion of a mutable segment into the provided buffer.
-   *
-   * @param[in] mutable_data_segments_index The index into the
-   * mutable_data_segments_array.
-   * @param[in] offset_index The index into the segment's offsets array.
-   * @param[in] size The number of bytes to load.
-   * @param[in] buffer The buffer to load data into. Must point to at least
-   * `size` bytes of memory.
-   *
-   * @returns An error code on if the load was successful.
-   * @retval Error::Ok The load was successful.
-   * @retval Error::NotFound The program does not contain any segments or the
-   *     indices are out of range.
-   * @returns Other errors depending on the implementation of
-   *     DataLoader: The Program.segment table is inconsistent, or the
-   *     data cannot be accessed.
-   */
-  ET_NODISCARD Error load_mutable_subsegment_into(
-      size_t mutable_data_segments_index, size_t offset_index, size_t size,
-      void *buffer) const;
-
-private:
-  Program(DataLoader *loader, size_t segment_base_offset,
-          FreeableBuffer &&program_data,
-          const executorch_flatbuffer::Program *internal_program,
-          FreeableBuffer &&constant_segment_data,
-          std::optional<internal::PteDataMap> &&pte_data_map)
-      : program_data_(std::move(program_data)),
-        // Don't need the loader if there are no segments.
-        loader_(segment_base_offset > 0 ? loader : nullptr),
-        internal_program_(internal_program),
-        segment_base_offset_(segment_base_offset),
-        constant_segment_data_(std::move(constant_segment_data)),
-        pte_data_map_(std::move(pte_data_map)) {}
-
-  // Not copyable or assignable.
-  Program(const Program &rhs) = delete;
-  Program &operator=(Program &&rhs) noexcept = delete;
-  Program &operator=(const Program &rhs) = delete;
-
-  /// The serialized program data. Tensors will point directly into this buffer.
-  FreeableBuffer program_data_;
-
-  /// Used to load segment data. Null if there are no segments.
-  DataLoader *loader_;
-
-  /// The flatbuffer representation of the program. Must not be exposed to
-  /// users.
-  const executorch_flatbuffer::Program *internal_program_;
-
-  /// The offset to the first segment, in bytes. If zero, no segments should
-  /// be present in internal_program_.
-  size_t segment_base_offset_;
-
-  /// Constant segment data.
-  FreeableBuffer constant_segment_data_;
-
-  /// NamedDataMap holding named data from the program.
-  std::optional<internal::PteDataMap> pte_data_map_;
-};
-
-} // namespace runtime
-} // namespace executorch
-
-namespace torch {
-namespace executor {
-// TODO(T197294990): Remove these deprecated aliases once all users have moved
-// to the new `::executorch` namespaces.
-using ::executorch::runtime::Program;
-} // namespace executor
-} // namespace torch
-
-#ifdef __GNUC__
-#pragma GCC diagnostic pop
-#endif

package/third-party/ios/ExecutorchLib/frameworks/executorch.xcframework/ios-arm64/Headers/executorch/runtime/executor/pte_data_map.h

@@ -1,144 +0,0 @@
-/*
- * Copyright (c) Meta Platforms, Inc. and affiliates.
- * All rights reserved.
- *
- * This source code is licensed under the BSD-style license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-#pragma once
-
-#include <executorch/runtime/core/data_loader.h>
-#include <executorch/runtime/core/named_data_map.h>
-
-// Forward declare flatbuffer types. This is a public header and must not
-// include the generated flatbuffer header.
-namespace executorch_flatbuffer {
-struct NamedData;
-struct DataSegment;
-} // namespace executorch_flatbuffer
-
-namespace flatbuffers {
-template <typename T> struct Offset;
-} // namespace flatbuffers
-
-// @lint-ignore CLANGTIDY facebook-modularize-issue-check
-#if EXECUTORCH_INTERNAL_FLATBUFFERS == 1
-// TODO(T216992074): update internal flatbuffers (v1.12) to match OSS (v24.3.5).
-namespace flatbuffers {
-template <typename T> class Vector;
-using FlatbufferNamedData =
-    flatbuffers::Vector<flatbuffers::Offset<executorch_flatbuffer::NamedData>>;
-using FlatbufferDataSegment = flatbuffers::Vector<
-    flatbuffers::Offset<executorch_flatbuffer::DataSegment>>;
-} // namespace flatbuffers
-#else
-namespace flatbuffers {
-template <typename T, typename SizeT> class Vector;
-using FlatbufferNamedData =
-    flatbuffers::Vector<flatbuffers::Offset<executorch_flatbuffer::NamedData>,
-                        uint32_t>;
-using FlatbufferDataSegment =
-    flatbuffers::Vector<flatbuffers::Offset<executorch_flatbuffer::DataSegment>,
-                        uint32_t>;
-} // namespace flatbuffers
-#endif
-
-namespace executorch {
-namespace runtime {
-namespace internal {
-
-/**
- * A NamedDataMap implementation for Flatbuffer-serialized named data
- * originating from a PTE file.
- */
-class PteDataMap final : public NamedDataMap {
-public:
-  /**
-   * Creates a new DataMap that wraps named_data from the PTE file.
-   *
-   * @param[in] loader The DataLoader that accesses the PTE file.
-   * Note: the loader must outlive the PteDataMap instance.
-   * @param[in] segment_base_offset The offset to the first segment in the PTE
-   * file, in bytes.
-   * @param[in] named_data The named_data from the PTE file. Note: the pointer
-   * passed here must outlive the PteDataMap instance.
-   * @param[in] segments The segments from the PTE file. Note: the pointer
-   * passed here must outlive the PteDataMap instance.
-   */
-  static Result<PteDataMap>
-  create(DataLoader *loader, size_t segment_base_offset,
-         const flatbuffers::FlatbufferNamedData *named_data,
-         const flatbuffers::FlatbufferDataSegment *segments);
-
-  /**
-   * The PteDataMap currently only handles opaque data that does not contain
-   * tensor-specific metadata.
-   */
-  ET_NODISCARD
-  Result<const TensorLayout>
-  get_metadata(ET_UNUSED const char *key) const override {
-    return Error::NotImplemented;
-  }
-
-  /**
-   * Retrieve read-only data for the specified key.
-   *
-   * @param[in] key The name of the blob to get data on.
-   *
-   * @return error if the key is not present or data cannot be loaded.
-   */
-  ET_NODISCARD
-  Result<FreeableBuffer> get_data(const char *key) const override;
-
-  /**
-   * The PteDataMap currently does not implement load_into.
-   */
-  ET_NODISCARD Error load_data_into(ET_UNUSED const char *key,
-                                    ET_UNUSED void *buffer,
-                                    ET_UNUSED size_t size) const override {
-    return Error::NotImplemented;
-  }
-
-  /**
-   * @returns The number of keys in the map.
-   */
-  ET_NODISCARD Result<size_t> get_num_keys() const override;
-
-  /**
-   * @returns The key at the specified index, error if index out of bounds.
-   */
-  ET_NODISCARD Result<const char *> get_key(size_t index) const override;
-
-  // Moveable, to be compatible with Result.
-  PteDataMap(PteDataMap &&) noexcept = default;
-  ~PteDataMap() override = default;
-
-private:
-  PteDataMap(DataLoader *loader, size_t segment_base_offset,
-             const flatbuffers::FlatbufferNamedData *named_data,
-             const flatbuffers::FlatbufferDataSegment *segments)
-      : loader_(loader), segment_base_offset_(segment_base_offset),
-        named_data_(named_data), segments_(segments) {}
-
-  // Not copyable or assignable.
-  PteDataMap(const PteDataMap &rhs) = delete;
-  PteDataMap &operator=(PteDataMap &&rhs) noexcept = delete;
-  PteDataMap &operator=(const PteDataMap &rhs) = delete;
-
-  // Data loader, used to load segment data.
-  DataLoader *loader_;
-
-  // The offset to the first segment in the PTE file, in bytes.
-  size_t segment_base_offset_;
-
-  // Named data, containing name and segment index.
-  const flatbuffers::FlatbufferNamedData *named_data_;
-
-  // Segments, to retrieve offset and size for the loader.
-  const flatbuffers::FlatbufferDataSegment *segments_;
-};
-
-} // namespace internal
-} // namespace runtime
-} // namespace executorch

package/third-party/ios/ExecutorchLib/frameworks/executorch.xcframework/ios-arm64/Headers/executorch/runtime/executor/tensor_parser.h

@@ -1,156 +0,0 @@
-/*
- * Copyright (c) Meta Platforms, Inc. and affiliates.
- * All rights reserved.
- *
- * This source code is licensed under the BSD-style license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-#pragma once
-
-#ifdef __GNUC__
-// Disable -Wdeprecated-declarations, as some builds use 'Werror'.
-#pragma GCC diagnostic push
-#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
-#endif
-
-#include <executorch/runtime/core/evalue.h>
-#include <executorch/runtime/core/exec_aten/exec_aten.h>
-#include <executorch/runtime/executor/memory_manager.h>
-#include <executorch/runtime/executor/program.h>
-#include <executorch/schema/program_generated.h>
-
-namespace executorch {
-namespace runtime {
-namespace deserialization {
-
-/// Data structure to hold key and data buffer for external data used
-/// in a method.
-struct NamedData {
-  const char *key;
-  FreeableBuffer buffer;
-};
-
-NamedData *get_data_by_key(const char *key, Span<NamedData> entries);
-
-ET_NODISCARD Result<executorch::aten::Tensor>
-parseTensor(const Program *program, MemoryManager *memory_manager,
-            const executorch_flatbuffer::Tensor *s_tensor,
-            const NamedDataMap *named_data_map = nullptr,
-            Span<NamedData> external_constants = {});
-
-ET_NODISCARD Result<BoxedEvalueList<executorch::aten::Tensor>>
-parseTensorList(const flatbuffers::Vector<int32_t> *tensor_indices,
-                EValue *values, size_t values_len,
-                MemoryManager *memory_manager);
-
-// Checks that the sizes, dim_order and scalar_type match between tensors
-// stored in the PTE and externally.
-ET_NODISCARD Error
-validateTensorLayout(const executorch_flatbuffer::Tensor *s_tensor,
-                     const TensorLayout &expected_layout);
-
-// Deserializes a List of optional type. The code here is the same between all
-// list of optionals: list of optional Tensor, list of optional float etc, so we
-// just use a template to avoid boilerplate.
-template <typename T>
-ET_NODISCARD Result<BoxedEvalueList<executorch::aten::optional<T>>>
-parseListOptionalType(const flatbuffers::Vector<int32_t> *value_indices,
-                      EValue *values, size_t values_len,
-                      MemoryManager *memory_manager) {
-  auto *evalp_list = memory_manager->method_allocator()->allocateList<EValue *>(
-      value_indices->size());
-  if (evalp_list == nullptr) {
-    return Error::MemoryAllocationFailed;
-  }
-
-  auto *optional_tensor_list =
-      memory_manager->method_allocator()
-          ->allocateList<executorch::aten::optional<T>>(value_indices->size());
-  if (optional_tensor_list == nullptr) {
-    return Error::MemoryAllocationFailed;
-  }
-
-  size_t output_idx = 0;
-  // For each index look up the corresponding EValue (which has been
-  // already allocated) and stick it in the list.
-  for (int32_t index : *value_indices) {
-    // Lists of objects are stored in fbb as list[int] where the ints are
-    // indices into values. Currently serialization is deciding if they want to
-    // put -1 for serialized None type indices, or give us a valid index to a
-    // serialized None. We support either for now.
-    // Placement new as the list elements are not initialized, so calling
-    // copy assignment is not defined if its non trivial.
-    if (index == -1) {
-      new (&optional_tensor_list[output_idx])
-          executorch::aten::optional<T>(executorch::aten::nullopt);
-      // no value to point to. BoxedEvalueList for optional tensor will convert
-      // this to nullopt.
-      // TODO(T161156879): do something less hacky here.
-      evalp_list[output_idx] = nullptr;
-    } else {
-      ET_CHECK_OR_RETURN_ERROR(
-          index >= 0 && static_cast<size_t>(index) < values_len, InvalidProgram,
-          "Invalid value index %" PRId32 " for ListOptional", index);
-      new (&optional_tensor_list[output_idx])
-          executorch::aten::optional<T>(values[index].toOptional<T>());
-      evalp_list[output_idx] = &values[static_cast<size_t>(index)];
-    }
-    output_idx++;
-  }
-  return BoxedEvalueList<executorch::aten::optional<T>>(
-      evalp_list, optional_tensor_list, value_indices->size());
-}
-
-/**
- * Returns the appropriate data pointer for `s_tensor`.
- *
- * Overall, a Tensor is either constant or non-constant, except we differentiate
- * 2 special variants of non-constant Tensor ("input" and control-flow
- * "placeholder") as a special optimization to avoid holding unnecessary
- * AllocationDetails. Thus, s_tensor can be configured as 1 of 3 options:
- * - constant_buffer > 0, allocation_info = Null: Constant Tensor.
- * - constant_buffer = 0, allocation_info = Non Null: Non-constant Tensor.
- * - constant_buffer = 0, allocation_info = Null: Input/placeholder Tensor.
- *
- * @param[in] s_tensor The tensor to find the data pointer for.
- * @param[in] program The Program to use for constant buffer data.
- * @param[in] nbytes The amount of memory to get from the allocator.
- * @param[in] allocator The source of memory for non-constant tensors.
- * @param[in] named_data_map An optional map of {name, blob} used to resolve
- *     data that is mutable and external to the PTE, if any.
- * @param[in] external_constants An optional span containing tensor fqn to
- *     corresponding tensor data. Used to resolve data that is constant and
- *     external to the PTE, if any. Referencing data from external_constants is
- *     safe, as it has the same lifetime as the method.
- *
- * @returns On success, the data pointer to use for the tensor. On failure, a
- *     non-Ok Error.
- */
-ET_NODISCARD Result<void *>
-getTensorDataPtr(const executorch_flatbuffer::Tensor *s_tensor,
-                 const Program *program, size_t nbytes,
-                 HierarchicalAllocator *allocator,
-                 const NamedDataMap *named_data_map = nullptr,
-                 Span<NamedData> external_constants = {});
-
-} // namespace deserialization
-} // namespace runtime
-} // namespace executorch
-
-namespace torch {
-namespace executor {
-namespace deserialization {
-// TODO(T197294990): Remove these deprecated aliases once all users have moved
-// to the new `::executorch` namespaces.
-using ::executorch::runtime::deserialization::getTensorDataPtr;
-using ::executorch::runtime::deserialization::parseListOptionalType;
-using ::executorch::runtime::deserialization::parseTensor;
-using ::executorch::runtime::deserialization::parseTensorList;
-} // namespace deserialization
-} // namespace executor
-} // namespace torch
-
-#ifdef __GNUC__
-#pragma GCC diagnostic pop
-#endif