You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tvm.apache.org by GitBox <gi...@apache.org> on 2023/01/18 01:08:26 UTC
[GitHub] [tvm] mehrdadh commented on a diff in pull request #13770: [microTVM]Gemmini code generation using microTVM
mehrdadh commented on code in PR #13770:
URL: https://github.com/apache/tvm/pull/13770#discussion_r1072913504
##########
apps/microtvm/gemmini/template_project/src/makefiles/conv2d/Makefile:
##########
@@ -0,0 +1,68 @@
+include $(abs_top_srcdir)/Makefrag
Review Comment:
Could you consolidate all the Makefiles to a Makefile.template and modify it based on the project type in `generate_project` step?
##########
apps/microtvm/gemmini/template_project/microtvm_api_server.py:
##########
@@ -0,0 +1,386 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+"""
+MicroTVM API Server for Gemmini baremetal tests on the Spike simulator
+=====================
+**Author**: `Federico Peccia <https://fPecc.github.io/>`_
+"""
+
+import atexit
+import collections
+import functools
+import json
+import logging
+import os
+import os.path
+import pathlib
+import re
+import shlex
+import shutil
+import shlex, subprocess
+import sys
+import tarfile
+import tempfile
+import time
+from string import Template
+import re
+from distutils.dir_util import copy_tree
+import subprocess
+import serial
+
+# import serial.tools.list_ports
+from tvm.micro.project_api import server
+
+from subprocess import PIPE
+
+_LOG = logging.getLogger(__name__)
+
+MODEL_LIBRARY_FORMAT_RELPATH = pathlib.Path("src") / "model" / "model.tar"
+API_SERVER_DIR = pathlib.Path(os.path.dirname(__file__) or os.path.getcwd())
+BUILD_DIR = API_SERVER_DIR / "build"
+MODEL_LIBRARY_FORMAT_PATH = API_SERVER_DIR / MODEL_LIBRARY_FORMAT_RELPATH
+
+IS_TEMPLATE = not (API_SERVER_DIR / MODEL_LIBRARY_FORMAT_RELPATH).exists()
+
+PROJECT_TYPES = [
+ "dense_example",
+ "conv2d_example",
+ "dwconv2d_example",
+ "add_example",
+ "maxpool2d_example",
+ "mobilenet_example",
+]
+
+PROJECT_OPTIONS = [
+ server.ProjectOption(
+ "project_type",
+ required=["generate_project"],
+ choices=tuple(PROJECT_TYPES),
+ type="str",
+ help="Type of project to generate.",
+ )
+]
+
+
+class Handler(server.ProjectAPIHandler):
+ def __init__(self):
+ super(Handler, self).__init__()
+ self._proc = None
+ self._port = None
+ self._transport = None
+ self._project_dir = None
+ self._qemu_instance = None
+
+ def server_info_query(self, tvm_version):
+ return server.ServerInfo(
+ platform_name="gemmini",
+ is_template=IS_TEMPLATE,
+ model_library_format_path="" if IS_TEMPLATE else MODEL_LIBRARY_FORMAT_PATH,
+ project_options=PROJECT_OPTIONS,
+ )
+
+ def _copy_project_files(self, api_server_dir, project_dir, project_type):
+ """Copies the files for project_type into project_dir.
+
+ Notes
+ -----
+ template_dir is NOT a project type, and that directory is never copied
+ in this function. template_dir only holds this file and its unit tests,
+ so this file is copied separately in generate_project.
+
+ """
+ for item in (API_SERVER_DIR / "src" / project_type).iterdir():
+ dest = project_dir / "src" / item.name
+ if item.is_dir():
+ shutil.copytree(item, dest)
+ else:
+ shutil.copy2(item, dest)
+
+ CRT_COPY_ITEMS = ("include", "src")
+
+ def _copy_standalone_crt(self, source_dir, standalone_crt_dir):
+ output_crt_dir = source_dir / "standalone_crt"
+ for item in self.CRT_COPY_ITEMS:
+ src_path = os.path.join(standalone_crt_dir, item)
+ dst_path = output_crt_dir / item
+ if os.path.isdir(src_path):
+ shutil.copytree(src_path, dst_path)
+ else:
+ shutil.copy2(src_path, dst_path)
+
+ # Example project is the "minimum viable project",
+ # and doesn't need a fancy RPC server
+ EXAMPLE_PROJECT_UNUSED_COMPONENTS = []
+
+ def _remove_unused_components(self, source_dir, project_type):
+ unused_components = []
+ if project_type == "example_project":
+ unused_components = self.EXAMPLE_PROJECT_UNUSED_COMPONENTS
+
+ for component in unused_components:
+ shutil.rmtree(source_dir / "standalone_crt" / component)
+
+ def _disassemble_mlf(self, mlf_tar_path, source_dir):
+ with tempfile.TemporaryDirectory() as mlf_unpacking_dir_str:
+ mlf_unpacking_dir = pathlib.Path(mlf_unpacking_dir_str)
+ with tarfile.open(mlf_tar_path, "r:") as tar:
+ tar.extractall(mlf_unpacking_dir)
+
+ model_dir = source_dir / "model"
+ model_dir.mkdir()
+
+ # Copy C files from model. The filesnames and quantity
+ # depend on the target string, so we just copy all c files
+ source_dir = mlf_unpacking_dir / "codegen" / "host" / "src"
+ for file in source_dir.rglob(f"*.c"):
+ shutil.copy(file, model_dir)
+
+ source_dir = mlf_unpacking_dir / "codegen" / "host" / "include"
+ for file in source_dir.rglob(f"*.h"):
+ shutil.copy(file, model_dir)
+
+ # Return metadata.json for use in templating
+ with open(os.path.join(mlf_unpacking_dir, "metadata.json")) as f:
+ metadata = json.load(f)
+ return metadata
+
+ def _template_model_header(self, source_dir, metadata):
+ with open(source_dir / "model.h", "r") as f:
+ model_h_template = Template(f.read())
+
+ assert (
+ metadata["style"] == "full-model"
+ ), "when generating AOT, expect only full-model Model Library Format"
+
+ template_values = {
+ "workspace_size_bytes": metadata["memory"]["functions"]["main"][0][
+ "workspace_size_bytes"
+ ],
+ }
+
+ with open(source_dir / "model.h", "w") as f:
+ f.write(model_h_template.substitute(template_values))
+
+ # Arduino ONLY recognizes .ino, .ccp, .c, .h
Review Comment:
remove?
##########
cmake/modules/contrib/Gemmini.cmake:
##########
@@ -0,0 +1,117 @@
+if(USE_MICRO)
Review Comment:
I think this should be a separate flag which is disabled by default, maybe use `USE_GEMMINI`
##########
apps/microtvm/gemmini/README.md:
##########
@@ -0,0 +1,3 @@
+This directory contains code to create code for the Gemmini accelerator using microTVM. These tests are then executed on the Spike RISC-V ISA simulator.
+
+In order to use this correctly, the Spike simulator has to be installed. This can be done by following the steps found on the Chipyard repository.
Review Comment:
Link to instruction is missing
##########
python/tvm/contrib/gemmini/tutorials/single_operators/add-tutorial.ipynb:
##########
@@ -0,0 +1,395 @@
+{
Review Comment:
tutorial files should move to somewhere under `gallery/how_to/`. Also you need to change the format to .py file and write it in sphinx format. Now we support notebook generation and google colab, so you can even add cells to install all the dependencies and run it in google colab
##########
apps/microtvm/gemmini/template_project/microtvm_api_server.py:
##########
@@ -0,0 +1,386 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+"""
+MicroTVM API Server for Gemmini baremetal tests on the Spike simulator
+=====================
+**Author**: `Federico Peccia <https://fPecc.github.io/>`_
+"""
+
+import atexit
+import collections
+import functools
+import json
+import logging
+import os
+import os.path
+import pathlib
+import re
+import shlex
+import shutil
+import shlex, subprocess
+import sys
+import tarfile
+import tempfile
+import time
+from string import Template
+import re
+from distutils.dir_util import copy_tree
+import subprocess
+import serial
+
+# import serial.tools.list_ports
+from tvm.micro.project_api import server
+
+from subprocess import PIPE
+
+_LOG = logging.getLogger(__name__)
+
+MODEL_LIBRARY_FORMAT_RELPATH = pathlib.Path("src") / "model" / "model.tar"
+API_SERVER_DIR = pathlib.Path(os.path.dirname(__file__) or os.path.getcwd())
+BUILD_DIR = API_SERVER_DIR / "build"
+MODEL_LIBRARY_FORMAT_PATH = API_SERVER_DIR / MODEL_LIBRARY_FORMAT_RELPATH
+
+IS_TEMPLATE = not (API_SERVER_DIR / MODEL_LIBRARY_FORMAT_RELPATH).exists()
+
+PROJECT_TYPES = [
+ "dense_example",
+ "conv2d_example",
+ "dwconv2d_example",
+ "add_example",
+ "maxpool2d_example",
+ "mobilenet_example",
+]
+
+PROJECT_OPTIONS = [
+ server.ProjectOption(
+ "project_type",
+ required=["generate_project"],
+ choices=tuple(PROJECT_TYPES),
+ type="str",
+ help="Type of project to generate.",
+ )
+]
+
+
+class Handler(server.ProjectAPIHandler):
+ def __init__(self):
+ super(Handler, self).__init__()
+ self._proc = None
+ self._port = None
+ self._transport = None
+ self._project_dir = None
+ self._qemu_instance = None
+
+ def server_info_query(self, tvm_version):
+ return server.ServerInfo(
+ platform_name="gemmini",
+ is_template=IS_TEMPLATE,
+ model_library_format_path="" if IS_TEMPLATE else MODEL_LIBRARY_FORMAT_PATH,
+ project_options=PROJECT_OPTIONS,
+ )
+
+ def _copy_project_files(self, api_server_dir, project_dir, project_type):
+ """Copies the files for project_type into project_dir.
+
+ Notes
+ -----
+ template_dir is NOT a project type, and that directory is never copied
+ in this function. template_dir only holds this file and its unit tests,
+ so this file is copied separately in generate_project.
+
+ """
+ for item in (API_SERVER_DIR / "src" / project_type).iterdir():
+ dest = project_dir / "src" / item.name
+ if item.is_dir():
+ shutil.copytree(item, dest)
+ else:
+ shutil.copy2(item, dest)
+
+ CRT_COPY_ITEMS = ("include", "src")
+
+ def _copy_standalone_crt(self, source_dir, standalone_crt_dir):
+ output_crt_dir = source_dir / "standalone_crt"
+ for item in self.CRT_COPY_ITEMS:
+ src_path = os.path.join(standalone_crt_dir, item)
+ dst_path = output_crt_dir / item
+ if os.path.isdir(src_path):
+ shutil.copytree(src_path, dst_path)
+ else:
+ shutil.copy2(src_path, dst_path)
+
+ # Example project is the "minimum viable project",
+ # and doesn't need a fancy RPC server
+ EXAMPLE_PROJECT_UNUSED_COMPONENTS = []
+
+ def _remove_unused_components(self, source_dir, project_type):
+ unused_components = []
+ if project_type == "example_project":
+ unused_components = self.EXAMPLE_PROJECT_UNUSED_COMPONENTS
+
+ for component in unused_components:
+ shutil.rmtree(source_dir / "standalone_crt" / component)
+
+ def _disassemble_mlf(self, mlf_tar_path, source_dir):
+ with tempfile.TemporaryDirectory() as mlf_unpacking_dir_str:
+ mlf_unpacking_dir = pathlib.Path(mlf_unpacking_dir_str)
+ with tarfile.open(mlf_tar_path, "r:") as tar:
+ tar.extractall(mlf_unpacking_dir)
+
+ model_dir = source_dir / "model"
+ model_dir.mkdir()
+
+ # Copy C files from model. The filesnames and quantity
+ # depend on the target string, so we just copy all c files
+ source_dir = mlf_unpacking_dir / "codegen" / "host" / "src"
+ for file in source_dir.rglob(f"*.c"):
+ shutil.copy(file, model_dir)
+
+ source_dir = mlf_unpacking_dir / "codegen" / "host" / "include"
+ for file in source_dir.rglob(f"*.h"):
+ shutil.copy(file, model_dir)
+
+ # Return metadata.json for use in templating
+ with open(os.path.join(mlf_unpacking_dir, "metadata.json")) as f:
+ metadata = json.load(f)
+ return metadata
+
+ def _template_model_header(self, source_dir, metadata):
+ with open(source_dir / "model.h", "r") as f:
+ model_h_template = Template(f.read())
+
+ assert (
+ metadata["style"] == "full-model"
+ ), "when generating AOT, expect only full-model Model Library Format"
+
+ template_values = {
+ "workspace_size_bytes": metadata["memory"]["functions"]["main"][0][
+ "workspace_size_bytes"
+ ],
+ }
+
+ with open(source_dir / "model.h", "w") as f:
+ f.write(model_h_template.substitute(template_values))
+
+ # Arduino ONLY recognizes .ino, .ccp, .c, .h
+
+ CPP_FILE_EXTENSION_SYNONYMS = ("cc", "cxx")
+
+ def _change_cpp_file_extensions(self, source_dir):
+ for ext in self.CPP_FILE_EXTENSION_SYNONYMS:
+ for filename in source_dir.rglob(f"*.{ext}"):
+ filename.rename(filename.with_suffix(".cpp"))
+
+ for filename in source_dir.rglob(f"*.inc"):
+ filename.rename(filename.with_suffix(".h"))
+
+ def _convert_includes(self, project_dir, source_dir):
+ """Changes all #include statements in project_dir to be relevant to their
+ containing file's location.
+
+ Arduino only supports includes relative to a file's location, so this
Review Comment:
fix the function description
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tvm.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org