xref: /aosp_15_r20/external/pytorch/scripts/build_ios.sh (revision da0073e96a02ea20f0ac840b70461e3646d07c45)
1#!/bin/bash -xe
2##############################################################################
3# Example command to build the iOS target.
4##############################################################################
5#
6# This script shows how one can build a Caffe2 binary for the iOS platform
7# using ios-cmake. This is very similar to the android-cmake - see
8# build_android.sh for more details.
9
10CAFFE2_ROOT="$( cd "$(dirname "$0")"/.. ; pwd -P)"
11
12if [ -z "$PYTHON" ]; then
13  PYTHON=python
14  PYTHON_VERSION_MAJOR=$($PYTHON -c 'import sys; print(sys.version_info[0])')
15  if [ "${PYTHON_VERSION_MAJOR}" -le 2 ]; then
16    echo "Default python executable is Python-2, trying to use python3 alias"
17    PYTHON=python3
18  fi
19fi
20
21echo "Bash: $(/bin/bash --version | head -1)"
22echo "Python: $($PYTHON -c 'import sys; print(sys.version)')"
23echo "Caffe2 path: $CAFFE2_ROOT"
24
25CMAKE_ARGS=()
26
27# Build PyTorch mobile
28CMAKE_ARGS+=("-DCMAKE_PREFIX_PATH=$($PYTHON -c 'import sysconfig; print(sysconfig.get_path("purelib"))')")
29CMAKE_ARGS+=("-DPython_EXECUTABLE=$($PYTHON -c 'import sys; print(sys.executable)')")
30CMAKE_ARGS+=("-DBUILD_CUSTOM_PROTOBUF=OFF")
31
32# custom build with selected ops
33if [ -n "${SELECTED_OP_LIST}" ]; then
34  SELECTED_OP_LIST="$(cd $(dirname $SELECTED_OP_LIST); pwd -P)/$(basename $SELECTED_OP_LIST)"
35  echo "Choose SELECTED_OP_LIST file: $SELECTED_OP_LIST"
36  if [ ! -r ${SELECTED_OP_LIST} ]; then
37    echo "Error: SELECTED_OP_LIST file ${SELECTED_OP_LIST} not found."
38    exit 1
39  fi
40  CMAKE_ARGS+=("-DSELECTED_OP_LIST=${SELECTED_OP_LIST}")
41fi
42
43# bitcode
44if [ "${ENABLE_BITCODE:-}" == '1' ]; then
45  CMAKE_ARGS+=("-DCMAKE_C_FLAGS=-fembed-bitcode")
46  CMAKE_ARGS+=("-DCMAKE_CXX_FLAGS=-fembed-bitcode")
47fi
48
49# Use ios-cmake to build iOS project from CMake.
50# This projects sets CMAKE_C_COMPILER to /usr/bin/gcc and
51# CMAKE_CXX_COMPILER to /usr/bin/g++. In order to use ccache (if it is available) we
52# must override these variables via CMake arguments.
53CMAKE_ARGS+=("-DCMAKE_TOOLCHAIN_FILE=$CAFFE2_ROOT/cmake/iOS.cmake")
54if [ -n "${CCACHE_WRAPPER_PATH:-}"]; then
55  CCACHE_WRAPPER_PATH=/usr/local/opt/ccache/libexec
56fi
57if [ -d "$CCACHE_WRAPPER_PATH" ]; then
58  CMAKE_ARGS+=("-DCMAKE_C_COMPILER=$CCACHE_WRAPPER_PATH/gcc")
59  CMAKE_ARGS+=("-DCMAKE_CXX_COMPILER=$CCACHE_WRAPPER_PATH/g++")
60fi
61
62# IOS_PLATFORM controls type of iOS platform (see ios-cmake)
63if [ -n "${IOS_PLATFORM:-}" ]; then
64  CMAKE_ARGS+=("-DIOS_PLATFORM=${IOS_PLATFORM}")
65  if [ "${IOS_PLATFORM}" == "WATCHOS" ]; then
66      # enable bitcode by default for watchos
67      CMAKE_ARGS+=("-DCMAKE_C_FLAGS=-fembed-bitcode")
68      CMAKE_ARGS+=("-DCMAKE_CXX_FLAGS=-fembed-bitcode")
69      # disable the QNNPACK
70      CMAKE_ARGS+=("-DUSE_PYTORCH_QNNPACK=OFF")
71  fi
72else
73  # IOS_PLATFORM is not set, default to OS, which builds iOS.
74  CMAKE_ARGS+=("-DIOS_PLATFORM=OS")
75fi
76
77if [ -n "${IOS_ARCH:-}" ]; then
78  CMAKE_ARGS+=("-DIOS_ARCH=${IOS_ARCH}")
79fi
80
81if [ "${BUILD_LITE_INTERPRETER}" == 0 ]; then
82  CMAKE_ARGS+=("-DBUILD_LITE_INTERPRETER=OFF")
83else
84  CMAKE_ARGS+=("-DBUILD_LITE_INTERPRETER=ON")
85fi
86if [ "${TRACING_BASED}" == 1 ]; then
87  CMAKE_ARGS+=("-DTRACING_BASED=ON")
88else
89  CMAKE_ARGS+=("-DTRACING_BASED=OFF")
90fi
91if [ "${USE_LIGHTWEIGHT_DISPATCH}" == 1 ]; then
92  CMAKE_ARGS+=("-DUSE_LIGHTWEIGHT_DISPATCH=ON")
93  CMAKE_ARGS+=("-DSTATIC_DISPATCH_BACKEND=CPU")
94else
95  CMAKE_ARGS+=("-DUSE_LIGHTWEIGHT_DISPATCH=OFF")
96fi
97
98CMAKE_ARGS+=("-DUSE_LITE_INTERPRETER_PROFILER=OFF")
99
100# Don't build binaries or tests (only the library)
101CMAKE_ARGS+=("-DBUILD_TEST=OFF")
102CMAKE_ARGS+=("-DBUILD_BINARY=OFF")
103CMAKE_ARGS+=("-DBUILD_PYTHON=OFF")
104
105# Disable unused dependencies
106CMAKE_ARGS+=("-DUSE_CUDA=OFF")
107CMAKE_ARGS+=("-DUSE_ITT=OFF")
108CMAKE_ARGS+=("-DUSE_GFLAGS=OFF")
109CMAKE_ARGS+=("-DUSE_OPENCV=OFF")
110CMAKE_ARGS+=("-DUSE_MPI=OFF")
111CMAKE_ARGS+=("-DUSE_NUMPY=OFF")
112CMAKE_ARGS+=("-DUSE_NNPACK=OFF")
113CMAKE_ARGS+=("-DUSE_MKLDNN=OFF")
114
115# Metal
116if [ "${USE_PYTORCH_METAL:-}" == "1" ]; then
117  CMAKE_ARGS+=("-DUSE_PYTORCH_METAL=ON")
118fi
119
120# Core ML
121if [ "${USE_COREML_DELEGATE}" == "1" ]; then
122  CMAKE_ARGS+=("-DUSE_COREML_DELEGATE=ON")
123fi
124
125# pthreads
126CMAKE_ARGS+=("-DCMAKE_THREAD_LIBS_INIT=-lpthread")
127CMAKE_ARGS+=("-DCMAKE_HAVE_THREADS_LIBRARY=1")
128CMAKE_ARGS+=("-DCMAKE_USE_PTHREADS_INIT=1")
129
130# Only toggle if VERBOSE=1
131if [ "${VERBOSE:-}" == '1' ]; then
132  CMAKE_ARGS+=("-DCMAKE_VERBOSE_MAKEFILE=1")
133fi
134
135# enable ARC
136CMAKE_ARGS+=("-DCMAKE_CXX_FLAGS=-fobjc-arc")
137
138# Now, actually build the iOS target.
139BUILD_ROOT=${BUILD_ROOT:-"$CAFFE2_ROOT/build_ios"}
140INSTALL_PREFIX=${BUILD_ROOT}/install
141mkdir -p $BUILD_ROOT
142cd $BUILD_ROOT
143cmake "$CAFFE2_ROOT" \
144    -DCMAKE_INSTALL_PREFIX=$INSTALL_PREFIX \
145    -DCMAKE_BUILD_TYPE=MinSizeRel \
146    -DBUILD_SHARED_LIBS=OFF \
147    ${CMAKE_ARGS[@]} \
148    $@
149
150cmake --build . -- "-j$(sysctl -n hw.ncpu)"
151
152# copy headers and libs to install directory
153echo "Will install headers and libs to $INSTALL_PREFIX for further Xcode project usage."
154make install
155echo "Installation completed, now you can copy the headers/libs from $INSTALL_PREFIX to your Xcode project directory."
156