Add cmake Linux build and test job (#52)

Summary:
This adds a build and test workflow using CMake on Linux.  Here are some of my findings:

* The build only works if `executorch` is checked out into a directory called `executorch`.  Otherwise, including `<executorch/...>` would fail (pytorch/test-infra#4465)
* Linking with GNU ld fails with the following error `/usr/bin/ld: -f may not be used without -shared`, which I'm not sure what it means atm, so I switch to LLD by adding `add_link_options("-fuse-ld=lld")` for clang
* I still couldn't make this work on Mac yet because `libprogram_schema.a` is empty and Mac `ar` refuses to link the library.  So that's an issue for another day.

```
/Library/Developer/CommandLineTools/usr/bin/ar qc libprogram_schema.a
ar: no archive members specified
```

Pull Request resolved: #52

Reviewed By: dbort

Differential Revision: D48216923

Pulled By: huydhn

fbshipit-source-id: 0ba751e3e849ec6779b19338253dd73b7ef0f3c8

Author: huydhn

.ci/docker/conda-env-ci.txt

@@ -1,3 +1,4 @@
 # TODO: We might need to update this to install flatbuffers from the pinned commit
 # in fbcode/executorch/third-party/flatbuffers.submodule.txt
 flatbuffers=2.0.0
+cmake=3.22.1

.ci/docker/requirements-ci.txt

@@ -3,4 +3,5 @@ numpy==1.25.2
 PyYAML==6.0.1
 ruamel.yaml==0.17.32
 sympy==1.12
+tomli==2.0.1
 zstd==1.5.5.1

.ci/scripts/test-cmake.sh

@@ -0,0 +1,43 @@
+#!/bin/bash
+# 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.
+
+set -exu
+
+# shellcheck source=/dev/null
+source "$(dirname "${BASH_SOURCE[0]}")/utils.sh"
+
+test_model() {
+  MODEL_NAME=$1
+  python -m examples.export.export_example --model_name="${MODEL_NAME}"
+
+  # Run test model
+  ./"${CMAKE_OUTPUT_DIR}"/executor_runner --model_path "./${MODEL_NAME}.pte"
+}
+
+build_and_test_executorch() {
+  CMAKE_OUTPUT_DIR=cmake-out
+  # Build executorch runtime using cmake
+  rm -rf "${CMAKE_OUTPUT_DIR}" && mkdir "${CMAKE_OUTPUT_DIR}"
+
+  pushd "${CMAKE_OUTPUT_DIR}"
+  cmake -DBUCK2=buck2 ..
+  popd
+
+  if [ "$(uname)" == "Darwin" ]; then
+    CMAKE_JOBS=$(( $(sysctl -n hw.ncpu) - 1 ))
+  else
+    CMAKE_JOBS=$(( $(nproc) - 1 ))
+  fi
+  cmake --build "${CMAKE_OUTPUT_DIR}" -j "${CMAKE_JOBS}"
+
+  which python
+  # Test the example linear model
+  test_model "linear"
+}
+
+install_executorch
+build_and_test_executorch

.ci/scripts/test.sh

@@ -7,24 +7,24 @@
 
 set -exu
 
-install_executorch() {
-  which pip
-  # Install executorch, this assumes that Executorch is checked out in the
-  # current directory
-  pip install .
-  # Just print out the list of packages for debugging
-  pip list
+# shellcheck source=/dev/null
+source "$(dirname "${BASH_SOURCE[0]}")/utils.sh"
+
+test_model() {
+  MODEL_NAME=$1
+  python -m examples.export.export_example --model_name="${MODEL_NAME}"
+
+  # Run test model
+  buck2 run //examples/executor_runner:executor_runner -- --model_path "./${MODEL_NAME}.pte"
 }
 
 build_and_test_executorch() {
   # Build executorch runtime
   buck2 build //examples/executor_runner:executor_runner
 
   which python
-  # Export a test model
-  python -m examples.export.export_example --model_name="linear"
-  # Run test model
-  buck2 run //examples/executor_runner:executor_runner -- --model_path ./linear.pte
+  # Test the example linear model
+  test_model "linear"
 }
 
 install_executorch

.ci/scripts/utils.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+# 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.
+
+install_executorch() {
+  which pip
+  # Install executorch, this assumes that Executorch is checked out in the
+  # current directory
+  pip install .
+  # Just print out the list of packages for debugging
+  pip list
+}

.github/workflows/pull.yml

@@ -30,6 +30,9 @@ jobs:
         # Build and test Executorch
         bash .ci/scripts/test.sh
 
+        # Test custom ops
+        bash examples/custom_ops/test_custom_ops.sh
+
   buck-build-test-macos:
     name: buck-build-test-macos
     uses: pytorch/test-infra/.github/workflows/macos_job.yml@main
@@ -47,3 +50,21 @@ jobs:
         # Build and test Executorch
         bash .ci/scripts/test.sh
         popd
+
+  cmake-build-test-linux:
+    name: cmake-build-test-linux
+    uses: pytorch/test-infra/.github/workflows/linux_job.yml@main
+    with:
+      runner: linux.2xlarge
+      docker-image: executorch-ubuntu-22.04-clang12
+      fetch-depth: 0
+      submodules: 'true'
+      ref: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.sha || github.sha }}
+      script: |
+        PYTHON_VERSION=3.10
+        # TODO: Figure out why /opt/conda/envs/py_$PYTHON_VERSION/bin is not in the path
+        # here, as it's there in the container
+        export PATH="/opt/conda/envs/py_${PYTHON_VERSION}/bin:${PATH}"
+
+        # Build and test Executorch
+        bash .ci/scripts/test-cmake.sh

CMakeLists.txt

@@ -259,19 +259,7 @@ target_link_libraries(portable_kernels_bindings INTERFACE portable_kernels)
 
 # Ensure that the load-time constructor functions run. By default, the linker
 # would remove them since there are no other references to them.
-if(CMAKE_CXX_COMPILER_ID STREQUAL "Clang" OR CMAKE_CXX_COMPILER_ID STREQUAL
-                                             "AppleClang")
-  if(CMAKE_TOOLCHAIN_FILE MATCHES ".*android\.toolchain\.cmake$")
-    # For Android tool chain
-    gcc_kernel_link_options(portable_kernels_bindings)
-  else()
-    # For host tool chain
-    clang_kernel_link_options(portable_kernels_bindings)
-  endif()
-elseif (CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
-  # Using gcc
-  gcc_kernel_link_options(portable_kernels_bindings)
-endif()
+kernel_link_options(portable_kernels_bindings)
 
 #
 # executor_runner: A simple commandline tool that loads and runs a program file.

build/Utils.cmake

@@ -22,20 +22,8 @@ function(executorch_print_configuration_summary)
     message(STATUS "  REGISTER_EXAMPLE_CUSTOM_OPS   : ${REGISTER_EXAMPLE_CUSTOM_OPS}")
 endfunction()
 
-# This is the funtion to use -Wl to link static library, used for clang
-function(clang_kernel_link_options target_name)
-    target_link_options(${target_name}
-        INTERFACE
-        # TODO(dbort): This will cause the .a to show up on the link line twice
-        # for targets that depend on this library; once because CMake will add
-        # it, and once because it's in this list of args. See if there's a way
-        # to avoid that.
-        -Wl,-force_load,$<TARGET_FILE:${target_name}>
-    )
-endfunction()
-
-# This is the funtion to use -Wl, --whole-archive to link static library, used for gcc
-function(gcc_kernel_link_options target_name)
+# This is the funtion to use -Wl, --whole-archive to link static library
+function(kernel_link_options target_name)
     target_link_options(${target_name}
         INTERFACE
         # TODO(dbort): This will cause the .a to show up on the link line twice

examples/custom_ops/CMakeLists.txt

@@ -31,6 +31,9 @@ endif()
 if(NOT TORCH_ROOT)
   set(TORCH_ROOT ${EXECUTORCH_ROOT}/third-party/pytorch)
 endif()
+
+include(${EXECUTORCH_ROOT}/build/Utils.cmake)
+
 # Command to generate selected_operators.yaml from custom_ops.yaml.
 set(_oplist_yaml ${CMAKE_CURRENT_BINARY_DIR}/selected_operators.yaml)
 file(GLOB_RECURSE _codegen_tools_srcs "${EXECUTORCH_ROOT}/codegen/tools/*.py")
@@ -107,16 +110,7 @@ if(REGISTER_EXAMPLE_CUSTOM_OP_2)
 
   # Ensure that the load-time constructor functions run. By default, the linker
   # would remove them since there are no other references to them.
-  if((CMAKE_CXX_COMPILER_ID MATCHES "AppleClang")
-     OR (APPLE AND CMAKE_CXX_COMPILER_ID MATCHES "Clang"))
-    target_link_options(custom_ops_aot_lib INTERFACE
-                        "-Wl,-force_load,$<TARGET_FILE:custom_ops_aot_lib>")
-  elseif(CMAKE_CXX_COMPILER_ID MATCHES "Clang|GNU")
-    target_link_options(
-      custom_ops_aot_lib INTERFACE
-      "-Wl,--whole-archive,$<TARGET_FILE:custom_ops_aot_lib>,--no-whole-archive"
-    )
-  endif()
+  kernel_link_options("custom_ops_aot_lib")
 endif()
 
 # 1. C++ library to register custom ops into Executorch runtime.