Skip to content

[microTVM] additional refactoring for enabling USE_MICRO in more builds #13909

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Feb 14, 2023
Merged

[microTVM] additional refactoring for enabling USE_MICRO in more builds #13909

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
67d948b
remove standalone crt special case for windows build
alanmacd Feb 3, 2023
b840717
add ssize_t header
alanmacd Feb 3, 2023
46a18ad
enable USE_MICRO by default
alanmacd Feb 3, 2023
f46b47a
disable USE_MICRO for hexagon builds
alanmacd Feb 8, 2023
d5d5184
build microtvm rpc common from sources
alanmacd Feb 9, 2023
5224bda
revert to USE_MICRO being off by default
alanmacd Feb 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ tvm_option(USE_OPENMP "Build with OpenMP thread pool implementation" OFF)
tvm_option(USE_RELAY_DEBUG "Building Relay in debug mode..." OFF)
tvm_option(USE_RTTI "Build with RTTI" ON)
tvm_option(USE_MSVC_MT "Build with MT" OFF)
tvm_option(USE_MICRO "Build with Micro TVM support" OFF)
tvm_option(USE_MICRO "Build with Micro TVM support" ON)
tvm_option(INSTALL_DEV "Install compiler infrastructure" OFF)
tvm_option(HIDE_PRIVATE_SYMBOLS "Compile with -fvisibility=hidden." OFF)
tvm_option(USE_TF_TVMDSOOP "Build with TensorFlow TVMDSOOp" OFF)
Expand Down Expand Up @@ -264,6 +264,12 @@ else(MSVC)
endif()
endif(MSVC)

# USE_MICRO is on by default, but it is not needed for Hexagon builds nor will
# it function properly with USE_RPC disabled.
if(USE_HEXAGON OR NOT USE_RPC)
set(USE_MICRO OFF)
endif()

# Hexagon has dlopen built into QuRT (no need for static library).
if(NOT BUILD_FOR_HEXAGON)
list(APPEND TVM_RUNTIME_LINKER_LIBS ${CMAKE_DL_LIBS})
Expand Down Expand Up @@ -577,16 +583,10 @@ include(cmake/modules/contrib/PAPI.cmake)
if(USE_MICRO)
# NOTE: cmake doesn't track dependencies at the file level across subdirectories. For the
# Unix Makefiles generator, need to add these explicit target-level dependency)
add_dependencies(tvm_runtime arduino)
add_dependencies(tvm_runtime crt)
add_dependencies(tvm_runtime host_standalone_crt)
add_dependencies(tvm_runtime zephyr)
add_dependencies(tvm_runtime arduino)
if(MSVC)
target_link_libraries(tvm PRIVATE host_standalone_crt )
target_link_libraries(tvm_runtime PRIVATE host_standalone_crt)
else()
add_dependencies(tvm host_standalone_crt)
add_dependencies(tvm_runtime host_standalone_crt)
endif()
endif()

if(USE_CPP_RPC)
Expand Down
3 changes: 0 additions & 3 deletions cmake/config.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,9 +101,6 @@ set(USE_SPIRV_KHR_INTEGER_DOT_PRODUCT OFF)
# Whether enable OpenGL runtime
set(USE_OPENGL OFF)

# Whether enable MicroTVM runtime
set(USE_MICRO OFF)

# Whether enable RPC runtime
set(USE_RPC ON)

Expand Down
93 changes: 37 additions & 56 deletions cmake/modules/StandaloneCrt.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,41 +15,29 @@
# specific language governing permissions and limitations
# under the License.


if(USE_MICRO)

if(MSVC)

# When building for Windows, use standard CMake for compatibility with
# Visual Studio build tools and not require Make to be on the system.

# TODO: test building with this MSVC conditional code removed
# when USE_MICRO is enabled
message(STATUS "Build microTVM RPC common")

set(CRT_CONFIG, "src/runtime/micro/crt_config.h")
# add microTVM RPC common files to TVM runtime build
list(APPEND TVM_CRT_SOURCES
3rdparty/libcrc/src/crcccitt.c
src/runtime/crt/microtvm_rpc_common/frame_buffer.cc
src/runtime/crt/microtvm_rpc_common/framing.cc
src/runtime/crt/microtvm_rpc_common/session.cc
src/runtime/crt/microtvm_rpc_common/write_stream.cc)

add_library(host_standalone_crt
STATIC
3rdparty/libcrc/src/crcccitt.c
src/runtime/crt/microtvm_rpc_common/frame_buffer.cc
src/runtime/crt/microtvm_rpc_common/framing.cc
src/runtime/crt/microtvm_rpc_common/session.cc
src/runtime/crt/microtvm_rpc_common/write_stream.cc)
list(APPEND RUNTIME_SRCS ${TVM_CRT_SOURCES})
include_directories(SYSTEM src/runtime/micro)
Copy link
Member

@driazati driazati Feb 15, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why the SYSTEM here?

Copy link
Contributor Author

@alanmacd alanmacd Feb 15, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it needs a header in that directory to build those files that are in TVM_CRT_SOURCES, it's the same pattern used in other .cmake and CmakeLists.txt


target_include_directories(host_standalone_crt
PRIVATE
3rdparty/libcrc/include
src/runtime/micro)

else()

function(create_crt_library CRT_LIBRARY)

set(CRT_LIBRARY_NAME host_standalone_crt_${CRT_LIBRARY})
set(CRT_LIBRARY_SOURCES "")

foreach(FILE_NAME IN LISTS ARGN)
list(APPEND CRT_LIBRARY_SOURCES ${FILE_NAME})
list(APPEND CRT_LIBRARY_SOURCES ${FILE_NAME})
endforeach()

add_library(${CRT_LIBRARY_NAME}
Expand All @@ -60,9 +48,9 @@ else()
set(CRT_LIBRARIES ${CRT_LIBRARIES} ${CRT_LIBRARY_NAME} PARENT_SCOPE)

target_include_directories(${CRT_LIBRARY_NAME}
PUBLIC
${CMAKE_CURRENT_SOURCE_DIR}/src/runtime/micro/
${STANDALONE_CRT_BASE}/include)
PUBLIC
${CMAKE_CURRENT_SOURCE_DIR}/src/runtime/micro/
${STANDALONE_CRT_BASE}/include)

set_target_properties(${CRT_LIBRARY_NAME}
PROPERTIES
Expand All @@ -75,7 +63,7 @@ else()

endfunction()

message(STATUS "Build standalone CRT for microTVM")
message(STATUS "Build microTVM standalone CRT")

# Build an isolated build directory, separate from the TVM tree.
list(APPEND CRT_FILE_COPY_JOBS
Expand Down Expand Up @@ -147,32 +135,36 @@ else()
${RUNTIME_CRT_SOURCE_DIR}/aot_executor_module/aot_executor_module.c)

create_crt_library(graph_executor
${RUNTIME_CRT_SOURCE_DIR}/graph_executor/graph_executor.c
${RUNTIME_CRT_SOURCE_DIR}/graph_executor/load_json.c)
${RUNTIME_CRT_SOURCE_DIR}/graph_executor/graph_executor.c
${RUNTIME_CRT_SOURCE_DIR}/graph_executor/load_json.c)

create_crt_library(graph_executor_module
${RUNTIME_CRT_SOURCE_DIR}/graph_executor_module/graph_executor_module.c)
${RUNTIME_CRT_SOURCE_DIR}/graph_executor_module/graph_executor_module.c)

create_crt_library(memory
${RUNTIME_CRT_SOURCE_DIR}/memory/page_allocator.c
${RUNTIME_CRT_SOURCE_DIR}/memory/stack_allocator.c)
${RUNTIME_CRT_SOURCE_DIR}/memory/page_allocator.c
${RUNTIME_CRT_SOURCE_DIR}/memory/stack_allocator.c)

create_crt_library(microtvm_rpc_common
${RUNTIME_CRT_SOURCE_DIR}/microtvm_rpc_common/crcccitt.c
${RUNTIME_CRT_SOURCE_DIR}/microtvm_rpc_common/frame_buffer.cc
${RUNTIME_CRT_SOURCE_DIR}/microtvm_rpc_common/framing.cc
${RUNTIME_CRT_SOURCE_DIR}/microtvm_rpc_common/session.cc
${RUNTIME_CRT_SOURCE_DIR}/microtvm_rpc_common/write_stream.cc)
${RUNTIME_CRT_SOURCE_DIR}/microtvm_rpc_common/crcccitt.c
${RUNTIME_CRT_SOURCE_DIR}/microtvm_rpc_common/frame_buffer.cc
${RUNTIME_CRT_SOURCE_DIR}/microtvm_rpc_common/framing.cc
${RUNTIME_CRT_SOURCE_DIR}/microtvm_rpc_common/session.cc
${RUNTIME_CRT_SOURCE_DIR}/microtvm_rpc_common/write_stream.cc)

create_crt_library(microtvm_rpc_server
${RUNTIME_CRT_SOURCE_DIR}/microtvm_rpc_server/rpc_server.cc)

create_crt_library(common
${RUNTIME_CRT_SOURCE_DIR}/common/crt_backend_api.c
${RUNTIME_CRT_SOURCE_DIR}/common/crt_runtime_api.c
${RUNTIME_CRT_SOURCE_DIR}/common/func_registry.c
${RUNTIME_CRT_SOURCE_DIR}/common/ndarray.c
${RUNTIME_CRT_SOURCE_DIR}/common/packed_func.c)
${RUNTIME_CRT_SOURCE_DIR}/microtvm_rpc_server/rpc_server.cc)

if(NOT MSVC)
# TODO: if we want to eventually build standalone_crt for windows
# these files would be needed, but for now don't build them
create_crt_library(common
${RUNTIME_CRT_SOURCE_DIR}/common/crt_backend_api.c
${RUNTIME_CRT_SOURCE_DIR}/common/crt_runtime_api.c
${RUNTIME_CRT_SOURCE_DIR}/common/func_registry.c
${RUNTIME_CRT_SOURCE_DIR}/common/ndarray.c
${RUNTIME_CRT_SOURCE_DIR}/common/packed_func.c)
endif()

add_custom_target(host_standalone_crt DEPENDS ${CRT_LIBRARIES} standalone_crt)

Expand All @@ -188,15 +180,4 @@ else()
gtest_discover_tests(crttest)
endif()

set(TVM_CRT_LINKER_LIB host_standalone_crt_microtvm_rpc_common)
if("${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU")
list(APPEND TVM_RUNTIME_LINKER_LIBS -Wl,--whole-archive ${TVM_CRT_LINKER_LIB} -Wl,--no-whole-archive)
elseif("${CMAKE_CXX_COMPILER_ID}" MATCHES ".*Clang")
list(APPEND TVM_RUNTIME_LINKER_LIBS -Wl,-force_load ${TVM_CRT_LINKER_LIB})
else()
list(APPEND TVM_RUNTIME_LINKER_LIBS ${TVM_CRT_LINKER_LIB})
endif()

endif()

endif()
7 changes: 7 additions & 0 deletions include/tvm/runtime/c_runtime_api.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,13 @@
#define TVM_DLL EMSCRIPTEN_KEEPALIVE
#endif

// helper macro to suppress unused warning
#if defined(__GNUC__)
#define TVM_ATTRIBUTE_UNUSED __attribute__((unused))
#else
#define TVM_ATTRIBUTE_UNUSED
#endif

#ifndef TVM_DLL
#ifdef _WIN32
#ifdef TVM_EXPORTS
Expand Down
2 changes: 2 additions & 0 deletions include/tvm/runtime/crt/microtvm_rpc_server.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@
#include <sys/types.h>
#include <tvm/runtime/crt/error_codes.h>

#include "../../../../src/support/ssize.h"

#ifdef __cplusplus
extern "C" {
#endif
Expand Down
8 changes: 4 additions & 4 deletions src/runtime/crt/common/crt_runtime_api.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ int TVMDeviceAllocDataSpaceWithScope(DLDevice dev, int ndim, const int64_t* shap

int TVMDeviceFreeDataSpace(DLDevice dev, void* ptr) { return TVMPlatformMemoryFree(ptr, dev); }

static bool IsContiguous(const DLTensor* arr) {
TVM_ATTRIBUTE_UNUSED static bool IsContiguous(const DLTensor* arr) {
Copy link
Member

@mehrdadh mehrdadh Feb 14, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you clarify why this was needed? was it for eliminating the warning?

Copy link
Contributor Author

@alanmacd alanmacd Feb 14, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IsContiguous() is only used in an assert() below, so in a non-debug build we get an unused function warning

if (arr->strides == NULL) return true;
int64_t expected_stride = 1;
for (int32_t i = arr->ndim; i != 0; --i) {
Expand Down Expand Up @@ -632,12 +632,12 @@ release_and_return : {
}

// Default implementation, overridden by the platform runtime.
__attribute__((weak)) tvm_crt_error_t TVMPlatformGenerateRandom(uint8_t* buffer, size_t num_bytes) {
TVM_WEAK tvm_crt_error_t TVMPlatformGenerateRandom(uint8_t* buffer, size_t num_bytes) {
return kTvmErrorFunctionCallNotImplemented;
}

// Default implementation, overridden by the platform runtime.
__attribute__((weak)) tvm_crt_error_t TVMPlatformBeforeMeasurement() { return kTvmErrorNoError; }
TVM_WEAK tvm_crt_error_t TVMPlatformBeforeMeasurement() { return kTvmErrorNoError; }

// Default implementation, overridden by the platform runtime.
__attribute__((weak)) tvm_crt_error_t TVMPlatformAfterMeasurement() { return kTvmErrorNoError; }
TVM_WEAK tvm_crt_error_t TVMPlatformAfterMeasurement() { return kTvmErrorNoError; }