xref: /aosp_15_r20/external/pytorch/cmake/iOS.cmake (revision da0073e96a02ea20f0ac840b70461e3646d07c45)
1# This file is based off of the Platform/Darwin.cmake and Platform/UnixPaths.cmake
2# files which are included with CMake 2.8.4
3# It has been altered for iOS development
4
5# Options:
6#
7# IOS_PLATFORM = OS (default) or SIMULATOR
8#   This decides if SDKS will be selected from the iPhoneOS.platform or iPhoneSimulator.platform folders
9#   OS - the default, used to build for iPhone and iPad physical devices, which have an arm arch.
10#   SIMULATOR - used to build for the Simulator platforms, which now uses arm64 arch.
11#
12# CMAKE_IOS_DEVELOPER_ROOT = automatic(default) or /path/to/platform/Developer folder
13#   By default this location is automatcially chosen based on the IOS_PLATFORM value above.
14#   If set manually, it will override the default location and force the user of a particular Developer Platform
15#
16# CMAKE_IOS_SDK_ROOT = automatic(default) or /path/to/platform/Developer/SDKs/SDK folder
17#   By default this location is automatcially chosen based on the CMAKE_IOS_DEVELOPER_ROOT value.
18#   In this case it will always be the most up-to-date SDK found in the CMAKE_IOS_DEVELOPER_ROOT path.
19#   If set manually, this will force the use of a specific SDK version
20
21# Macros:
22#
23# set_xcode_property (TARGET XCODE_PROPERTY XCODE_VALUE)
24#  A convenience macro for setting xcode specific properties on targets
25#  example: set_xcode_property (myioslib IPHONEOS_DEPLOYMENT_TARGET "3.1")
26#
27# find_host_package (PROGRAM ARGS)
28#  A macro used to find executable programs on the host system, not within the iOS environment.
29#  Thanks to the android-cmake project for providing the command
30
31# Standard settings
32set(CMAKE_SYSTEM_NAME Darwin)
33set(CMAKE_SYSTEM_VERSION 1)
34set(UNIX True)
35set(APPLE True)
36set(IOS True)
37
38# Required as of cmake 2.8.10
39set(CMAKE_OSX_DEPLOYMENT_TARGET "" CACHE STRING "Force unset of the deployment target for iOS" FORCE)
40
41# Determine the cmake host system version so we know where to find the iOS SDKs
42find_program(CMAKE_UNAME uname /bin /usr/bin /usr/local/bin)
43if(CMAKE_UNAME)
44    execute_process(COMMAND uname -r OUTPUT_VARIABLE CMAKE_HOST_SYSTEM_VERSION OUTPUT_STRIP_TRAILING_WHITESPACE)
45    string(REGEX REPLACE "^([0-9]+)\\.([0-9]+).*$" "\\1" DARWIN_MAJOR_VERSION "${CMAKE_HOST_SYSTEM_VERSION}")
46endif(CMAKE_UNAME)
47
48# Force the compilers to gcc for iOS
49set(CMAKE_C_COMPILER /usr/bin/gcc CACHE STRING "")
50set(CMAKE_CXX_COMPILER /usr/bin/g++ CACHE STRING "")
51set(CMAKE_AR ar CACHE FILEPATH "" FORCE)
52set(CMAKE_RANLIB ranlib CACHE FILEPATH "" FORCE)
53set(PKG_CONFIG_EXECUTABLE pkg-config CACHE FILEPATH "" FORCE)
54
55# Setup iOS platform unless specified manually with IOS_PLATFORM
56if(NOT IOS_PLATFORM)
57    set(IOS_PLATFORM "OS")
58endif(NOT IOS_PLATFORM)
59set(IOS_PLATFORM ${IOS_PLATFORM} CACHE STRING "Type of iOS Platform")
60
61# Check the platform selection and setup for developer root
62if(${IOS_PLATFORM} STREQUAL "OS")
63    set(IOS_PLATFORM_LOCATION "iPhoneOS.platform")
64    set(XCODE_IOS_PLATFORM iphoneos)
65
66    # This causes the installers to properly locate the output libraries
67    set(CMAKE_XCODE_EFFECTIVE_PLATFORMS "-iphoneos")
68elseif(${IOS_PLATFORM} STREQUAL "SIMULATOR")
69    set(IOS_PLATFORM_LOCATION "iPhoneSimulator.platform")
70    set(XCODE_IOS_PLATFORM iphonesimulator)
71
72    # This causes the installers to properly locate the output libraries
73    set(CMAKE_XCODE_EFFECTIVE_PLATFORMS "-iphonesimulator")
74elseif(${IOS_PLATFORM} STREQUAL "WATCHOS")
75    set(IOS_PLATFORM_LOCATION "WatchOS.platform")
76    set(XCODE_IOS_PLATFORM watchos)
77
78    # This causes the installers to properly locate the output libraries
79    set(CMAKE_XCODE_EFFECTIVE_PLATFORMS "-watchos")
80else(${IOS_PLATFORM} STREQUAL "OS")
81    message(FATAL_ERROR
82            "Unsupported IOS_PLATFORM value selected. "
83            "Please choose OS, SIMULATOR, or WATCHOS.")
84endif()
85
86# All iOS/Darwin specific settings - some may be redundant
87set(CMAKE_SHARED_LIBRARY_PREFIX "lib")
88set(CMAKE_SHARED_LIBRARY_SUFFIX ".dylib")
89set(CMAKE_SHARED_MODULE_PREFIX "lib")
90set(CMAKE_SHARED_MODULE_SUFFIX ".so")
91set(CMAKE_MODULE_EXISTS 1)
92set(CMAKE_DL_LIBS "")
93
94set(CMAKE_C_OSX_COMPATIBILITY_VERSION_FLAG "-compatibility_version ")
95set(CMAKE_C_OSX_CURRENT_VERSION_FLAG "-current_version ")
96set(CMAKE_CXX_OSX_COMPATIBILITY_VERSION_FLAG "${CMAKE_C_OSX_COMPATIBILITY_VERSION_FLAG}")
97set(CMAKE_CXX_OSX_CURRENT_VERSION_FLAG "${CMAKE_C_OSX_CURRENT_VERSION_FLAG}")
98
99if(IOS_DEPLOYMENT_TARGET)
100  set(XCODE_IOS_PLATFORM_VERSION_FLAGS "-m${XCODE_IOS_PLATFORM}-version-min=${IOS_DEPLOYMENT_TARGET}")
101endif()
102
103# Hidden visibilty is required for cxx on iOS
104set(CMAKE_C_FLAGS_INIT "${XCODE_IOS_PLATFORM_VERSION_FLAGS}")
105set(CMAKE_CXX_FLAGS_INIT "${XCODE_IOS_PLATFORM_VERSION_FLAGS} -fvisibility-inlines-hidden")
106
107set(CMAKE_C_LINK_FLAGS "${XCODE_IOS_PLATFORM_VERSION_FLAGS} -Wl,-search_paths_first ${CMAKE_C_LINK_FLAGS}")
108set(CMAKE_CXX_LINK_FLAGS "${XCODE_IOS_PLATFORM_VERSION_FLAGS} -Wl,-search_paths_first ${CMAKE_CXX_LINK_FLAGS}")
109
110set(CMAKE_PLATFORM_HAS_INSTALLNAME 1)
111set(CMAKE_SHARED_LIBRARY_CREATE_C_FLAGS "-dynamiclib -headerpad_max_install_names")
112set(CMAKE_SHARED_MODULE_CREATE_C_FLAGS "-bundle -headerpad_max_install_names")
113set(CMAKE_SHARED_MODULE_LOADER_C_FLAG "-Wl,-bundle_loader,")
114set(CMAKE_SHARED_MODULE_LOADER_CXX_FLAG "-Wl,-bundle_loader,")
115set(CMAKE_FIND_LIBRARY_SUFFIXES ".dylib" ".so" ".a")
116
117# hack: if a new cmake (which uses CMAKE_INSTALL_NAME_TOOL) runs on an old build tree
118# (where install_name_tool was hardcoded) and where CMAKE_INSTALL_NAME_TOOL isn't in the cache
119# and still cmake didn't fail in CMakeFindBinUtils.cmake (because it isn't rerun)
120# hardcode CMAKE_INSTALL_NAME_TOOL here to install_name_tool, so it behaves as it did before, Alex
121if(NOT CMAKE_INSTALL_NAME_TOOL)
122    find_program(CMAKE_INSTALL_NAME_TOOL install_name_tool)
123endif(NOT CMAKE_INSTALL_NAME_TOOL)
124
125# Setup iOS deployment target
126set(IOS_DEPLOYMENT_TARGET ${IOS_DEPLOYMENT_TARGET} CACHE STRING "Minimum iOS version")
127
128# Setup iOS developer location unless specified manually with CMAKE_IOS_DEVELOPER_ROOT
129# Note Xcode 4.3 changed the installation location, choose the most recent one available
130execute_process(
131    COMMAND /usr/bin/xcode-select -print-path
132    OUTPUT_VARIABLE CMAKE_XCODE_DEVELOPER_DIR
133    OUTPUT_STRIP_TRAILING_WHITESPACE
134)
135set(XCODE_POST_43_ROOT "${CMAKE_XCODE_DEVELOPER_DIR}/Platforms/${IOS_PLATFORM_LOCATION}/Developer")
136set(XCODE_PRE_43_ROOT "/Developer/Platforms/${IOS_PLATFORM_LOCATION}/Developer")
137if(NOT CMAKE_IOS_DEVELOPER_ROOT)
138    if(EXISTS ${XCODE_POST_43_ROOT})
139        set(CMAKE_IOS_DEVELOPER_ROOT ${XCODE_POST_43_ROOT})
140    elseif(EXISTS ${XCODE_PRE_43_ROOT})
141        set(CMAKE_IOS_DEVELOPER_ROOT ${XCODE_PRE_43_ROOT})
142    endif(EXISTS ${XCODE_POST_43_ROOT})
143endif(NOT CMAKE_IOS_DEVELOPER_ROOT)
144set(CMAKE_IOS_DEVELOPER_ROOT ${CMAKE_IOS_DEVELOPER_ROOT} CACHE PATH "Location of iOS Platform")
145
146# Find and use the most recent iOS sdk unless specified manually with CMAKE_IOS_SDK_ROOT
147if(NOT CMAKE_IOS_SDK_ROOT)
148    file(GLOB _CMAKE_IOS_SDKS "${CMAKE_IOS_DEVELOPER_ROOT}/SDKs/*")
149    if(_CMAKE_IOS_SDKS)
150        list(SORT _CMAKE_IOS_SDKS)
151        list(REVERSE _CMAKE_IOS_SDKS)
152        list(GET _CMAKE_IOS_SDKS 0 CMAKE_IOS_SDK_ROOT)
153    else(_CMAKE_IOS_SDKS)
154        message(FATAL_ERROR "No iOS SDK's found in default search path ${CMAKE_IOS_DEVELOPER_ROOT}. Manually set CMAKE_IOS_SDK_ROOT or install the iOS SDK.")
155    endif(_CMAKE_IOS_SDKS)
156    message(STATUS "Toolchain using default iOS SDK: ${CMAKE_IOS_SDK_ROOT}")
157endif(NOT CMAKE_IOS_SDK_ROOT)
158set(CMAKE_IOS_SDK_ROOT ${CMAKE_IOS_SDK_ROOT} CACHE PATH "Location of the selected iOS SDK")
159
160# Set the sysroot default to the most recent SDK
161set(CMAKE_OSX_SYSROOT ${CMAKE_IOS_SDK_ROOT} CACHE PATH "Sysroot used for iOS support")
162
163# set the architecture for iOS
164if(IOS_PLATFORM STREQUAL "OS")
165    set(DEFAULT_IOS_ARCH "arm64")
166elseif(IOS_PLATFORM STREQUAL "SIMULATOR")
167    set(DEFAULT_IOS_ARCH "arm64")
168elseif(IOS_PLATFORM STREQUAL "WATCHOS")
169    set(DEFAULT_IOS_ARCH "armv7k;arm64_32")
170endif()
171
172set(IOS_ARCH ${DEFAULT_IOS_ARCH} CACHE STRING  "Build architecture for iOS")
173set(CMAKE_OSX_ARCHITECTURES ${IOS_ARCH} CACHE STRING  "Build architecture for iOS")
174
175# Set the find root to the iOS developer roots and to user defined paths
176set(CMAKE_FIND_ROOT_PATH ${CMAKE_IOS_DEVELOPER_ROOT} ${CMAKE_IOS_SDK_ROOT} ${CMAKE_PREFIX_PATH} CACHE STRING  "iOS find search path root")
177
178# default to searching for frameworks first
179set(CMAKE_FIND_FRAMEWORK FIRST)
180
181# set up the default search directories for frameworks
182set(CMAKE_SYSTEM_FRAMEWORK_PATH
183    ${CMAKE_IOS_SDK_ROOT}/System/Library/Frameworks
184    ${CMAKE_IOS_SDK_ROOT}/System/Library/PrivateFrameworks
185    ${CMAKE_IOS_SDK_ROOT}/Developer/Library/Frameworks
186)
187
188# only search the iOS sdks, not the remainder of the host filesystem
189set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM ONLY)
190set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY)
191set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY)
192
193# This little macro lets you set any XCode specific property
194macro(set_xcode_property TARGET XCODE_PROPERTY XCODE_VALUE)
195    set_property(TARGET ${TARGET} PROPERTY XCODE_ATTRIBUTE_${XCODE_PROPERTY} ${XCODE_VALUE})
196endmacro(set_xcode_property)
197
198# This macro lets you find executable programs on the host system
199macro(find_host_package)
200    set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER)
201    set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY NEVER)
202    set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE NEVER)
203    set(IOS FALSE)
204
205    find_package(${ARGN})
206
207    set(IOS TRUE)
208    set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM ONLY)
209    set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY)
210    set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY)
211endmacro(find_host_package)
212