Add MacOS platform support to onnxruntime-c pod

cmake/onnxruntime.cmake

@@ -88,9 +88,15 @@ elseif(onnxruntime_BUILD_APPLE_FRAMEWORK)
   endif()
   set(INFO_PLIST_PATH "${CMAKE_CURRENT_BINARY_DIR}/Info.plist")
   configure_file(${REPO_ROOT}/cmake/Info.plist.in ${INFO_PLIST_PATH})
-  configure_file(
-    ${REPO_ROOT}/tools/ci_build/github/apple/framework_info.json.template
-    ${CMAKE_CURRENT_BINARY_DIR}/framework_info.json)
+  if (${CMAKE_SYSTEM_NAME} STREQUAL "iOS")
+    configure_file(
+      ${REPO_ROOT}/tools/ci_build/github/apple/framework_info_ios.json.template
+      ${CMAKE_CURRENT_BINARY_DIR}/framework_info.json)
+  else() #macos
+    configure_file(
+      ${REPO_ROOT}/tools/ci_build/github/apple/framework_info_macos.json.template
+      ${CMAKE_CURRENT_BINARY_DIR}/framework_info_macos.json)
+  endif()
   set_target_properties(onnxruntime PROPERTIES
     FRAMEWORK TRUE
     FRAMEWORK_VERSION A

tools/ci_build/build.py

@@ -1749,7 +1749,12 @@ def run_ios_tests(args, source_dir, config, cwd):
 
     if args.build_apple_framework:
         package_test_py = os.path.join(source_dir, "tools", "ci_build", "github", "apple", "test_ios_packages.py")
-        framework_info_file = os.path.join(cwd, "framework_info.json")
+        framework_info_file_path = os.path.join(cwd, "framework_info.json")
+        framework_info_file = ""
+        if os.path.exists(framework_info_file_path):
+            framework_info_file = os.path.join(cwd, "framework_info.json")
+        else:
+            framework_info_file = os.path.join(cwd, "framework_info_macos.json")
         dynamic_framework_dir = os.path.join(cwd, config + "-" + args.ios_sysroot)
         static_framework_dir = os.path.join(cwd, config + "-" + args.ios_sysroot, "static_framework")
         # test dynamic framework

tools/ci_build/github/apple/build_and_assemble_ios_pods.py

@@ -64,6 +64,7 @@ def parse_args():
     )
 
     build_framework_group.add_argument("--include-ops-by-config")
+    build_framework_group.add_argument("--build-for-macosx")
     build_framework_group.add_argument(
         "--build-settings-file", required=True, help="The positional argument of build_ios_framework.py."
     )
@@ -114,6 +115,11 @@ def main():
     if args.include_ops_by_config is not None:
         build_ios_framework_args += ["--include_ops_by_config", args.include_ops_by_config]
 
+    framework_info_macos_file = None
+    if args.build_for_macosx:
+        framework_info_macos_file = build_dir / "framework_info_macos.json"
+        build_ios_framework_args += ["--build_for_macosx"]
+
     build_ios_framework_args += ["--build_dir", str(build_dir), args.build_settings_file]
 
     run(build_ios_framework_args)
@@ -148,6 +154,7 @@ def main():
             framework_dir=build_dir / "framework_out" / "onnxruntime.xcframework",
             public_headers_dir=build_dir / "framework_out" / "Headers",
             package_variant=package_variant,
+            framework_info_macos_file=framework_info_macos_file,
         )
 
         if args.test:

tools/ci_build/github/apple/build_ios_framework.py

@@ -36,7 +36,16 @@
     else:
         raise ValueError("build_params is required in the build config file")
 
+    build_params_for_macos = []
+    if "macosx" in build_settings["build_osx_archs"]:
+        if "build_params_for_macos" in build_settings_data:
+            build_params_for_macos += build_settings_data["build_params_for_macos"]
+        else:
+            raise ValueError("build_params_for_macos is required  when macosx arch is specified in the build config")
+
     build_settings["build_params"] = build_params
+    build_settings["build_params_for_macos"] = build_params_for_macos
+
     return build_settings
 
 
@@ -63,20 +72,31 @@
         subprocess.run(build_command, shell=False, check=True, cwd=REPO_DIR)
 
         # get the compiled lib path
-        framework_dir = os.path.join(
-            build_dir_current_arch,
-            build_config,
-            build_config + "-" + sysroot,
-            "onnxruntime.framework"
-            if build_dynamic_framework
-            else os.path.join("static_framework", "onnxruntime.framework"),
-        )
+        framework_dir = pathlib.Path("")
+        if sysroot == "macosx":
+            framework_dir = os.path.join(
+                build_dir_current_arch,
+                build_config,
+                "onnxruntime.framework"
+                if build_dynamic_framework
+                else os.path.join("static_framework", "onnxruntime.framework"),
+            )
+        else:
+            framework_dir = os.path.join(
+                build_dir_current_arch,
+                build_config,
+                build_config + "-" + sysroot,
+                "onnxruntime.framework"
+                if build_dynamic_framework
+                else os.path.join("static_framework", "onnxruntime.framework"),
+            )
         ort_libs.append(os.path.join(framework_dir, "onnxruntime"))
 
         # We only need to copy Info.plist, framework_info.json, and headers once since they are the same
+        framework_info_json_file_name = "framework_info_macos.json" if sysroot == "macosx" else "framework_info.json"
         if not info_plist_path:
             info_plist_path = os.path.join(build_dir_current_arch, build_config, "Info.plist")
-            framework_info_path = os.path.join(build_dir_current_arch, build_config, "framework_info.json")
+            framework_info_path = os.path.join(build_dir_current_arch, build_config, framework_info_json_file_name)
             headers = glob.glob(os.path.join(framework_dir, "Headers", "*.h"))
 
     # manually create the fat framework
@@ -110,7 +130,12 @@
     # Temp dirs to hold building results
     intermediates_dir = os.path.join(build_dir, "intermediates")
     build_config = args.config
-    base_build_command = [sys.executable, BUILD_PY] + build_settings["build_params"] + ["--config=" + build_config]
+
+    base_build_command = []
+    if args.build_for_macosx:
+        base_build_command += [sys.executable, BUILD_PY] + build_settings["build_params_for_macos"] + ["--config=" + build_config]
+    else:
+        base_build_command += [sys.executable, BUILD_PY] + build_settings["build_params"] + ["--config=" + build_config]
 
     if args.include_ops_by_config is not None:
         base_build_command += ["--include_ops_by_config=" + str(args.include_ops_by_config.resolve())]
@@ -134,7 +159,8 @@
         framework_dirs.append(framework_dir)
         # podspec and headers for each sysroot are the same, pick one of them
         if not framework_info_path:
-            framework_info_path = os.path.join(os.path.dirname(framework_dir), "framework_info.json")
+            framework_info_json_file_name = "framework_info_macos.json" if sysroot == "macosx" else "framework_info.json"
+            framework_info_path = os.path.join(os.path.dirname(framework_dir), framework_info_json_file_name)
             public_headers_path = os.path.join(os.path.dirname(framework_dir), "onnxruntime.framework", "Headers")
 
     # create the folder for xcframework and copy the LICENSE and podspec file
@@ -201,6 +227,8 @@
 
     parser.add_argument("--path_to_protoc_exe", type=pathlib.Path, help="Path to protoc exe.")
 
+    parser.add_argument("--build_for_macosx", action="store_true", help="Enable macos build in pods.")
+
     args = parser.parse_args()
 
     if not args.build_settings_file.resolve().is_file():

tools/ci_build/github/apple/c/assemble_c_pod_package.py

@@ -43,6 +43,7 @@ def assemble_c_pod_package(
     public_headers_dir: pathlib.Path,
     framework_dir: pathlib.Path,
     package_variant: PackageVariant,
+    framework_info_macos_file=None,
 ):
     """
     Assembles the files for the C/C++ pod package in a staging directory.
@@ -53,6 +54,7 @@ def assemble_c_pod_package(
     :param public_headers_dir Path to the public headers directory to include in the pod.
     :param framework_dir Path to the onnxruntime framework directory to include in the pod.
     :param package_variant The pod package variant.
+    :param Optional framework_info_macos_file Path to the framework_info_macos.json file containing additional values for the podspec.
     :return Tuple of (package name, path to the podspec file).
     """
     staging_dir = staging_dir.resolve()
@@ -61,6 +63,11 @@ def assemble_c_pod_package(
     framework_dir = framework_dir.resolve(strict=True)
 
     framework_info = load_json_config(framework_info_file)
+    framework_info_macos = None
+    if framework_info_macos_file is not None:
+        framework_info_macos_file = framework_info_macos_file.resolve(strict=True)
+        framework_info_macos = load_json_config(framework_info_macos_file)
+
     pod_config = load_json_config(get_pod_config_file(package_variant))
 
     pod_name = pod_config["name"]
@@ -78,6 +85,7 @@ def assemble_c_pod_package(
     variable_substitutions = {
         "DESCRIPTION": pod_config["description"],
         "IOS_DEPLOYMENT_TARGET": framework_info["IOS_DEPLOYMENT_TARGET"],
+        "MACOSX_DEPLOYMENT_TARGET": framework_info_macos["MACOSX_DEPLOYMENT_TARGET"] if framework_info_macos is not None else "",
         "LICENSE_FILE": "LICENSE",
         "NAME": pod_name,
         "ORT_C_FRAMEWORK": framework_dir.name,
@@ -132,6 +140,13 @@ def parse_args():
     parser.add_argument(
         "--variant", choices=PackageVariant.all_variant_names(), required=True, help="Pod package variant."
     )
+    parser.add_argument(
+        "--framework-info-macos-file",
+        type=pathlib.Path,
+        required=False,
+        help="Path to the framework_info_macos.json file containing additional values for the podspec.(Optional) "
+        "This file should be generated by CMake in the build directory.",
+    )
 
     return parser.parse_args()
 
@@ -146,6 +161,7 @@ def main():
         public_headers_dir=args.public_headers_dir,
         framework_dir=args.framework_dir,
         package_variant=PackageVariant[args.variant],
+        framework_info_macos_file=args.framework_info_macos_file if args.framework_info_macos_file is not None else None,
     )
 
     return 0

tools/ci_build/github/apple/c/c.podspec.template

@@ -6,7 +6,7 @@ Pod::Spec.new do |spec|
     spec.homepage               = "https://github.com/microsoft/onnxruntime"
     spec.source                 = { :http => "file:///http_source_placeholder" }
     spec.summary                = "@SUMMARY@"
-    spec.platform               = :ios, "@IOS_DEPLOYMENT_TARGET@"
+    spec.platform               = { :ios => "@IOS_DEPLOYMENT_TARGET@", :osx => "@MACOSX_DEPLOYMENT_TARGET@" }
     spec.vendored_frameworks    = "@ORT_C_FRAMEWORK@"
     spec.static_framework       = true
     spec.weak_framework         = [ @WEAK_FRAMEWORK@ ]

tools/ci_build/github/apple/default_full_macos_ios_framework_build_settings.json

@@ -0,0 +1,28 @@
+{
+    "build_osx_archs": {
+        "macosx": [
+            "x86_64"
+        ]
+    },
+    "build_params_for_macos": [
+        "--parallel",
+        "--use_xcode",
+        "--build_apple_framework",
+        "--use_coreml",
+        "--use_xnnpack",
+        "--skip_tests",
+        "--cmake_extra_defines=onnxruntime_BUILD_UNIT_TESTS=OFF",
+        "--apple_deploy_target=10.14"
+    ],
+    "build_params": [
+        "--ios",
+        "--parallel",
+        "--use_xcode",
+        "--build_apple_framework",
+        "--use_coreml",
+        "--use_xnnpack",
+        "--skip_tests",
+        "--cmake_extra_defines=onnxruntime_BUILD_UNIT_TESTS=OFF",
+        "--apple_deploy_target=12.0"
+    ]
+}

tools/ci_build/github/apple/framework_info_macos.json.template

@@ -0,0 +1,4 @@
+{
+    "MACOSX_DEPLOYMENT_TARGET": "@CMAKE_OSX_DEPLOYMENT_TARGET@",
+    "WEAK_FRAMEWORK": "@APPLE_WEAK_FRAMEWORK@"
+}

tools/ci_build/github/azure-pipelines/templates/stages/mac-ios-packaging-build-stage.yml

@@ -85,15 +85,16 @@ stages:
     # create and test mobile pods
     - script: |
         python tools/ci_build/github/apple/build_and_assemble_ios_pods.py \
-          --build-dir "$(Build.BinariesDirectory)/ios_framework" \
+          --build-dir "$(Build.BinariesDirectory)/macos_ios_framework" \
           --staging-dir "$(Build.BinariesDirectory)/staging" \
           --pod-version "$(ortPodVersion)" \
           --test \
           --variant ${{ parameters.packageVariant }} \
           --build-settings-file "${{ variables.buildSettingsFile }}" \
+          --build-for-macosx \
           ${{ variables.optionalIncludeOpsByConfigOption }} \
           -b="--path_to_protoc_exe=$(Build.BinariesDirectory)/protobuf_install/bin/protoc"
-      displayName: "Build iOS framework and assemble pod package files"
+      displayName: "Build macOS/iOS framework and assemble pod package files"
 
     - script: |
         python tools/ci_build/github/apple/test_ios_packages.py \