schema.fbs -> program.fbs

Summary: schema.flatbuffer_schema is a poor name. Program is more specific (in the context of the full path)

Reviewed By: dbort

Differential Revision: D47969015

fbshipit-source-id: 0fa6777b1845406438582ad85d6d2292dc56c944

Author: JacobSzwejbka

.gitignore

@@ -3,4 +3,4 @@ executorch.egg-info
 __pycache__/
 build/lib/
 exir/serialize/scalar_type.fbs
-exir/serialize/schema.fbs
+exir/serialize/program.fbs

backends/compile_spec_schema.py

@@ -7,7 +7,7 @@
 from dataclasses import dataclass
 
 """
-Please refer to executorch/schema/schema.fbs for source of truth.
+Please refer to executorch/schema/program.fbs for source of truth.
 """
 
 

docs/website/docs/contributors/program_file_format.md

@@ -84,7 +84,7 @@ Example:
 
 ## Program data
 
-See `//executorch/schema/schema.fbs` for the Program flatbuffer schema.
+See `//executorch/schema/program.fbs` for the Program flatbuffer schema.
 
 The flatbuffer-encoded program data follows the headers. By embedding the size
 of this region in the extended header, clients can read only the program data

exir/scripts/TARGETS

@@ -29,7 +29,7 @@ python_library(
         "__init__.py",
     ],
     resources = {
-        "//executorch/schema:schema.fbs": "schema.fbs",
+        "//executorch/schema:program.fbs": "program.fbs",
     },
     deps = [
         "//libfb/py:fbpkg",

exir/serialize/TARGETS

@@ -34,8 +34,8 @@ runtime.python_library(
         "_program.py",
     ],
     resources = {
+        "//executorch/schema:program.fbs": "program.fbs",
         "//executorch/schema:scalar_type.fbs": "scalar_type.fbs",
-        "//executorch/schema:schema.fbs": "schema.fbs",
         "fbsource//third-party/flatbuffers:flatc-host": "flatbuffers-flatc",
     },
     # Currently serialization API should only be used in some dedicated targets,

exir/serialize/_flatbuffer.py

@@ -135,7 +135,7 @@ def _prepare_schema(
     into out_dir. May patch the schema contents depending on the parameters to
     this function.
     """
-    program_schema = "schema.fbs"
+    program_schema = "program.fbs"
     # Included by the root program schema; must also be present.
     deps = ["scalar_type.fbs"]
 
@@ -247,7 +247,7 @@ def _program_json_to_flatbuffer(
 
     Args:
         program_json: The JSON to convert. Must be compatible with the root
-            table type of //executorch/schema/schema.fbs.
+            table type of //executorch/schema/program.fbs.
         constant_tensor_alignment: If provided, the alignment to use for tensor
             data embedded in the output flatbuffer data. If not provided, uses
             the alignment in the schema.
@@ -280,7 +280,7 @@ def _program_json_to_flatbuffer(
 def _program_flatbuffer_to_json(program_flatbuffer: bytes) -> bytes:
     """Converts binary flatbuffer data into Program-compatible JSON.
 
-    The binary is parsed using the schema in //executorch/schema/schema.fbs.
+    The binary is parsed using the schema in //executorch/schema/program.fbs.
     """
     with tempfile.TemporaryDirectory() as temp_dir:
         # No need to patch the alignment when reading. "force_align" is only

exir/serialize/test/test_flatbuffer.py

@@ -68,7 +68,7 @@ def test_load_patch_and_write(self) -> None:
 
 # Fake resource files to use when testing alignment-patching.
 SCHEMA_FILES: Dict[str, bytes] = {
-    "schema.fbs": b"\n".join(
+    "program.fbs": b"\n".join(
         [
             b"table Program {",
             # Space after the colon.
@@ -122,7 +122,7 @@ def call_prepare_schema(
     def test_unmodified(self) -> None:
         with tempfile.TemporaryDirectory() as out_dir:
             info: _SchemaInfo = self.call_prepare_schema(SCHEMA_FILES, out_dir)
-            self.assertEqual(info.root_path, os.path.join(out_dir, "schema.fbs"))
+            self.assertEqual(info.root_path, os.path.join(out_dir, "program.fbs"))
             # Files should not have been modified.
             for fname in SCHEMA_FILES.keys():
                 self.assertEqual(read_file(out_dir, fname), SCHEMA_FILES[fname])
@@ -134,10 +134,10 @@ def test_update_tensor_alignment(self) -> None:
             info: _SchemaInfo = self.call_prepare_schema(
                 SCHEMA_FILES, out_dir, constant_tensor_alignment=128
             )
-            self.assertEqual(info.root_path, os.path.join(out_dir, "schema.fbs"))
+            self.assertEqual(info.root_path, os.path.join(out_dir, "program.fbs"))
             # Only the tensor alignment lines should have been modified.
             self.assertEqual(
-                read_file(out_dir, "schema.fbs"),
+                read_file(out_dir, "program.fbs"),
                 b"\n".join(
                     [
                         b"table Program {",
@@ -170,10 +170,10 @@ def test_update_delegate_alignment(self) -> None:
             info: _SchemaInfo = self.call_prepare_schema(
                 SCHEMA_FILES, out_dir, delegate_alignment=256
             )
-            self.assertEqual(info.root_path, os.path.join(out_dir, "schema.fbs"))
+            self.assertEqual(info.root_path, os.path.join(out_dir, "program.fbs"))
             # Only the delegate alignment lines should have been modified.
             self.assertEqual(
-                read_file(out_dir, "schema.fbs"),
+                read_file(out_dir, "program.fbs"),
                 b"\n".join(
                     [
                         b"table Program {",
@@ -209,10 +209,10 @@ def test_update_tensor_and_delegate_alignment(self) -> None:
                 constant_tensor_alignment=1,
                 delegate_alignment=2,
             )
-            self.assertEqual(info.root_path, os.path.join(out_dir, "schema.fbs"))
+            self.assertEqual(info.root_path, os.path.join(out_dir, "program.fbs"))
             # Only the delegate alignment lines should have been modified.
             self.assertEqual(
-                read_file(out_dir, "schema.fbs"),
+                read_file(out_dir, "program.fbs"),
                 b"\n".join(
                     [
                         b"table Program {",

extension/pybindings/TARGETS

@@ -34,7 +34,7 @@ executorch_pybindings(
         "//executorch/runtime/executor:executor_aten",
         "//executorch/runtime/core/exec_aten:lib",
         "//executorch/schema:bundled_program_schema",
-        "//executorch/schema:schema",
+        "//executorch/schema:program",
         "//executorch/extension/data_loader:buffer_data_loader",
         "//executorch/extension/data_loader:mmap_data_loader",
         "//executorch/util:read_file",

extension/pybindings/module.cpp

@@ -23,7 +23,7 @@
 #include <executorch/runtime/platform/profiler.h>
 #include <executorch/runtime/platform/runtime.h>
 #include <executorch/schema/bundled_program_schema_generated.h>
-#include <executorch/schema/schema_generated.h>
+#include <executorch/schema/program_generated.h>
 #include <executorch/util/TestMemoryConfig.h>
 #include <executorch/util/bundled_program_verification.h>
 #include <executorch/util/read_file.h>

extension/pybindings/pybindings.cpp

@@ -10,7 +10,7 @@
 #include <pybind11/stl.h>
 
 #include <executorch/runtime/platform/assert.h>
-#include <executorch/schema/schema_generated.h>
+#include <executorch/schema/program_generated.h>
 #include <executorch/util/read_file.h>
 
 namespace py = pybind11;

extension/pybindings/targets.bzl

@@ -13,7 +13,7 @@ MODULE_DEPS = [
     "//executorch/runtime/kernel:operator_registry",
     "//executorch/runtime/executor:executor",
     "//executorch/schema:bundled_program_schema",
-    "//executorch/schema:schema",
+    "//executorch/schema:program",
     "//executorch/extension/aten_util:aten_bridge",
     "//executorch/util:bundled_program_verification",
     "//executorch/extension/data_loader:buffer_data_loader",
@@ -41,7 +41,7 @@ def executorch_pybindings(python_module_name, srcs = [], cppdeps = [], visibilit
         ],
         deps = [
             "//executorch/runtime/core:core",
-            "//executorch/schema:schema",
+            "//executorch/schema:program",
             "//executorch/util:read_file",
         ] + cppdeps,
         external_deps = [

runtime/core/portable_type/tensor_impl.h

@@ -55,7 +55,7 @@ class TensorImpl {
    * The type used for elements of `sizes()`.
    *
    * This must match the size/signedness of the type used for `Tensor.sizes` in
-   * //executorch/schema/schema.fbs.
+   * //executorch/schema/program.fbs.
    *
    * Note that at::TensorImpl uses `int64_t` for this type. Executorch uses
    * `int32_t` to save memory, since no single size value will ever be larger
@@ -67,15 +67,15 @@ class TensorImpl {
    * The type used for elements of `dim_order()`.
    *
    * This must match the size/signedness of the type used for `Tensor.dim_order`
-   * in //executorch/schema/schema.fbs.
+   * in //executorch/schema/program.fbs.
    */
   using DimOrderType = uint8_t;
 
   /**
    * The type used for elements of `strides()`.
    *
    * This must match the size/signedness of the type used for `Tensor.strides`
-   * in //executorch/schema/schema.fbs.
+   * in //executorch/schema/program.fbs.
    *
    * Note that at::TensorImpl uses `int64_t` for this type. Executorch uses
    * `int32_t` to save memory, since no single stride value will ever be larger

runtime/executor/executor.cpp

@@ -15,7 +15,7 @@
 #include <executorch/runtime/executor/memory_manager.h>
 #include <executorch/runtime/executor/program.h>
 #include <executorch/runtime/platform/profiler.h>
-#include <executorch/schema/schema_generated.h>
+#include <executorch/schema/program_generated.h>
 
 namespace torch {
 namespace executor {

runtime/executor/method.cpp

@@ -25,7 +25,7 @@
 #include <executorch/runtime/platform/assert.h>
 #include <executorch/runtime/platform/log.h>
 #include <executorch/runtime/platform/profiler.h>
-#include <executorch/schema/schema_generated.h>
+#include <executorch/schema/program_generated.h>
 
 namespace torch {
 namespace executor {
@@ -379,7 +379,7 @@ Error Method::parse_values(
         ET_CHECK_MSG(
             false,
             "Enum KernelTypes type: %" PRIu32
-            " not supported. Please look in executorch/schema/schema.fbs "
+            " not supported. Please look in executorch/schema/program.fbs "
             "to see which type this is.",
             static_cast<uint32_t>(serialization_value->val_type()) - 1);
     }

runtime/executor/program.cpp

@@ -15,7 +15,7 @@
 #include <executorch/runtime/executor/method.h>
 #include <executorch/runtime/platform/profiler.h>
 #include <executorch/schema/extended_header.h>
-#include <executorch/schema/schema_generated.h>
+#include <executorch/schema/program_generated.h>
 
 /*
  * Program verification can increase code size by ~30k. Targets that need to

runtime/executor/targets.bzl

@@ -70,7 +70,7 @@ def define_common_targets():
                 "//executorch/runtime/kernel:operator_registry",
                 "//executorch/runtime/platform:platform",
                 "//executorch/schema:extended_header",
-                "//executorch/schema:schema",
+                "//executorch/schema:program",
                 ":memory_manager",
             ],
             preprocessor_flags = _program_preprocessor_flags(),
@@ -94,7 +94,7 @@ def define_common_targets():
             ],
             deps = [
                 "//executorch/runtime/core:core",
-                "//executorch/schema:schema",
+                "//executorch/schema:program",
             ],
             exported_deps = [
                 "//executorch/runtime/platform:platform",

runtime/executor/tensor_parser.cpp

@@ -14,7 +14,7 @@
 #include <executorch/runtime/executor/memory_manager.h>
 #include <executorch/runtime/executor/program.h>
 #include <executorch/runtime/platform/profiler.h>
-#include <executorch/schema/schema_generated.h>
+#include <executorch/schema/program_generated.h>
 
 namespace torch {
 namespace executor {

runtime/executor/tensor_parser.h

@@ -12,7 +12,7 @@
 #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/schema_generated.h>
+#include <executorch/schema/program_generated.h>
 
 namespace torch {
 namespace executor {

runtime/executor/tensor_parser_aten.cpp

@@ -12,7 +12,7 @@
 #include <executorch/runtime/executor/memory_manager.h>
 #include <executorch/runtime/executor/program.h>
 #include <executorch/runtime/platform/profiler.h>
-#include <executorch/schema/schema_generated.h>
+#include <executorch/schema/program_generated.h>
 
 #include <ATen/ATen.h> // @manual=//caffe2/aten:ATen-core
 

schema/schema.fbs renamed to schema/program.fbs

@@ -1,7 +1,7 @@
 load("@fbsource//xplat/executorch/build:runtime_wrapper.bzl", "runtime")
 
 # Construct the input and output file names. All input and output files rely on scalar_type file.
-PROGRAM_STEM = "schema"
+PROGRAM_STEM = "program"
 BUNLDED_STEM = "bundled_program_schema"
 SCALAR_TYPE_STEM = "scalar_type"
 

schema/targets.bzl

@@ -16,7 +16,7 @@
 def custom_command():
     src_dst_list = [
         ("schema/scalar_type.fbs", "exir/serialize/scalar_type.fbs"),
-        ("schema/schema.fbs", "exir/serialize/schema.fbs"),
+        ("schema/schema.fbs", "exir/serialize/program.fbs"),
     ]
     for src, dst in src_dst_list:
         print(f"copying from {src} to {dst}")

setup.py

@@ -21,7 +21,7 @@
 #include <executorch/runtime/executor/method.h>
 #include <executorch/runtime/platform/log.h>
 #include <executorch/schema/bundled_program_schema_generated.h>
-#include <executorch/schema/schema_generated.h>
+#include <executorch/schema/program_generated.h>
 
 namespace torch {
 namespace executor {

util/bundled_program_verification.cpp

@@ -78,7 +78,7 @@ def define_common_targets():
                 "//executorch/runtime/core/exec_aten/testing_util:tensor_util" + aten_suffix,
                 "//executorch/runtime/core/exec_aten/util:dim_order_util" + aten_suffix,
                 "//executorch/schema:bundled_program_schema",
-                "//executorch/schema:schema",
+                "//executorch/schema:program",
             ],
             exported_deps = [
                 "//executorch/runtime/core:memory_allocator",