Nuget .NET changes for Mac Catalyst (#19923)

### Description  Add Nuget package changes for adding new 'net6.0-maccatalyst' platform. The output ORT Nuget package was manually tested and verified in a .NET MAUI app setup. ### Motivation and Context  --------- Co-authored-by: rachguo <[email protected]> Co-authored-by: Yi Zhang <[email protected]> Co-authored-by: rachguo <[email protected]>
microsoft · Apr 19, 2024 · f396748 · f396748
1 parent 497a627
commit f396748
Show file tree

Hide file tree

Showing 20 changed files with 112 additions and 74 deletions.
diff --git a/csharp/ApiDocs/ApiDocs.csproj b/csharp/ApiDocs/ApiDocs.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFramework>net7.0</TargetFramework>
     <Nullable>enable</Nullable>
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
   </PropertyGroup>

diff --git a/csharp/ApiDocs/docfx.json b/csharp/ApiDocs/docfx.json
@@ -14,7 +14,7 @@
       "disableDefaultFilter": false,
       "properties": {
         "AllowUnsafeBlocks": true,
-        "TargetFramework" : "net6.0",
+        "TargetFramework" : "net7.0",
         "Nullable" : "enable",
         "LangVersion": "8.0",
         "EnableTrainingApis": "true"

diff --git a/csharp/readme.md b/csharp/readme.md
@@ -101,8 +101,8 @@ For example, to build a CUDA GPU package, just run:
     --cudnn_home=/usr \
   --build_nuget \
   --msbuild_extra_options \
-    /p:SelectedTargets=Net6 \
-    /p:Net6Targets=net6.0 \
+    /p:SelectedTargets=Net7 \
+    /p:Net6Targets=net7.0 \
     /p:TargetFrameworks=netstandard2.0 \
     /p:IsLinuxBuild=true
 ```

diff --git a/....ML.OnnxRuntime.InferenceSample.Maui/Microsoft.ML.OnnxRuntime.InferenceSample.Maui.csproj b/....ML.OnnxRuntime.InferenceSample.Maui/Microsoft.ML.OnnxRuntime.InferenceSample.Maui.csproj
@@ -1,9 +1,9 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
 	<PropertyGroup>
-		<!-- note net6.0-maccatalyst is not supported currently. requires a new native build to be added. -->
-		<TargetFrameworks>net6.0-android;net6.0-ios</TargetFrameworks>
-		<TargetFrameworks Condition="$([MSBuild]::IsOSPlatform('windows'))">$(TargetFrameworks);net6.0-windows10.0.19041.0</TargetFrameworks>
+		<!-- note net7.0-maccatalyst is not supported currently. requires a new native build to be added. -->
+		<TargetFrameworks>net7.0-android;net7.0-ios</TargetFrameworks>
+		<TargetFrameworks Condition="$([MSBuild]::IsOSPlatform('windows'))">$(TargetFrameworks);net7.0-windows10.0.19041.0</TargetFrameworks>
 		<OutputType>Exe</OutputType>
 		<RootNamespace>Microsoft.ML.OnnxRuntime.InferenceSample.Maui</RootNamespace>
 		<UseMaui>true</UseMaui>
@@ -36,7 +36,7 @@
 	</PropertyGroup>
 
 	<ItemGroup>
-		<!-- NOTE: 
+		<!-- NOTE:
 		You need to manually put builds from other platforms such as Android in the correct place for this to work for cross-platform
 		builds such as running in the Android simulator.
 		The 'correct' place is defined by the OnnxRuntimeBuildDirectory property in Microsoft.ML.OnnxRuntime.csproj

diff --git a/csharp/src/Microsoft.ML.OnnxRuntime/Microsoft.ML.OnnxRuntime.csproj b/csharp/src/Microsoft.ML.OnnxRuntime/Microsoft.ML.OnnxRuntime.csproj
@@ -6,7 +6,7 @@
 
   <PropertyGroup>
     <IncludeMobileTargets>true</IncludeMobileTargets>
-    <BaseTargets>netstandard2.0;netcoreapp3.1;net6.0</BaseTargets>
+    <BaseTargets>netstandard2.0;netcoreapp3.1;net7.0</BaseTargets>
     <MobileTargets></MobileTargets>
   </PropertyGroup>
 
@@ -39,12 +39,12 @@
   <PropertyGroup Condition="('$(OrtPackageId)' == 'Microsoft.ML.OnnxRuntime' OR
                              '$(OrtPackageId)' == 'Microsoft.ML.OnnxRuntime.Azure') AND
                             '$(IncludeMobileTargets)' == 'true'">
-    <MobileTargets>$(MobileTargets);net6.0-android;net6.0-ios</MobileTargets>
+    <MobileTargets>$(MobileTargets);net7.0-android;net7.0-ios;net7.0-maccatalyst</MobileTargets>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(OrtPackageId)' == 'Microsoft.ML.OnnxRuntime.Training' AND
                             '$(IncludeMobileTargets)' == 'true'">
-    <MobileTargets>$(MobileTargets);net6.0-android</MobileTargets>
+    <MobileTargets>$(MobileTargets);net7.0-android</MobileTargets>
   </PropertyGroup>
 
   <PropertyGroup>
@@ -121,9 +121,9 @@
     <IsAndroidTarget Condition="$([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) == 'android' OR
                                 $(TargetFramework.StartsWith('monoandroid'))">true</IsAndroidTarget>
     <IsIOSTarget Condition="$([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) == 'ios' OR
+                            $([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) == 'maccatalyst' OR
                             $(TargetFramework.StartsWith('xamarinios'))">true</IsIOSTarget>
-    <IsMacTarget Condition="$([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) == 'macos' OR
-                            $([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) == 'maccatalyst'">true</IsMacTarget>
+    <IsMacTarget Condition="$([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) == 'macos'">true</IsMacTarget>
   </PropertyGroup>
 
   <!-- Enable training APIs for the build. The native package must be
@@ -175,7 +175,7 @@
   </PropertyGroup>
 
   <!-- CoreML may be valid for one of these targets as they support macOS. we do a runtime check that the OS is
-       macOS before attempting to enable CoreML. This includes netcoreapp3.1 and net6.0
+       macOS before attempting to enable CoreML. This includes netcoreapp3.1 and net7.0
        NOTE: $(TargetFrameworkIdentitier) may not be set yet, so we need to call GetTargetFrameworkIdentifier
   -->
   <PropertyGroup Condition="$([MSBuild]::GetTargetFrameworkIdentifier('$(TargetFramework)'))=='.NETCoreApp' AND

diff --git a/...untime/targets/net6.0-android/targets.xml → ...untime/targets/net7.0-android/targets.xml b/...untime/targets/net6.0-android/targets.xml → ...untime/targets/net7.0-android/targets.xml
diff --git a/...nnxRuntime/targets/net6.0-ios/targets.xml → ...nnxRuntime/targets/net7.0-ios/targets.xml b/...nnxRuntime/targets/net6.0-ios/targets.xml → ...nnxRuntime/targets/net7.0-ios/targets.xml
diff --git a/csharp/src/Microsoft.ML.OnnxRuntime/targets/net7.0-maccatalyst/README.md b/csharp/src/Microsoft.ML.OnnxRuntime/targets/net7.0-maccatalyst/README.md
@@ -0,0 +1,3 @@
+### Notes for maccatalyst .NET targets:
+
+We only add a blank file for the target framework folder here and thus will be including blank TFM under build/ and buildTransitive/ in the Nuget package. The reason is for Mac Catalyst platform, it directly will resolve the xcframework from the runtimes/native/ios folder based on this [RuntimeidentifierGraph](https://github.com/dotnet/sdk/blob/main/src/Layout/redist/PortableRuntimeIdentifierGraph.json#L300-L304)
diff --git a/csharp/src/Microsoft.ML.OnnxRuntime/targets/net7.0-maccatalyst/_._ b/csharp/src/Microsoft.ML.OnnxRuntime/targets/net7.0-maccatalyst/_._
diff --git a/...xRuntime/targets/net6.0-macos/targets.xml → ...xRuntime/targets/net7.0-macos/targets.xml b/...xRuntime/targets/net6.0-macos/targets.xml → ...xRuntime/targets/net7.0-macos/targets.xml
diff --git a/...test/Microsoft.ML.OnnxRuntime.EndToEndTests/Microsoft.ML.OnnxRuntime.EndToEndTests.csproj b/...test/Microsoft.ML.OnnxRuntime.EndToEndTests/Microsoft.ML.OnnxRuntime.EndToEndTests.csproj
@@ -15,7 +15,7 @@
     <AllowUnsafeBlocks>True</AllowUnsafeBlocks>
     <SignAssembly>true</SignAssembly>
     <AssemblyOriginatorKeyFile>..\..\OnnxRuntime.snk</AssemblyOriginatorKeyFile>
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFramework>net7.0</TargetFramework>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(IsLinuxBuild)'=='true'">

diff --git a/...p/test/Microsoft.ML.OnnxRuntime.Tests.Common/Microsoft.ML.OnnxRuntime.Tests.Common.csproj b/...p/test/Microsoft.ML.OnnxRuntime.Tests.Common/Microsoft.ML.OnnxRuntime.Tests.Common.csproj
@@ -2,8 +2,8 @@
 
   <PropertyGroup>
     <!-- netstandard2.0 is required by xamarin and used by most platforms.
-         net6.0 is required for linux. -->
-    <TargetFrameworks>netstandard2.0;net6.0</TargetFrameworks>
+         net7.0 is required for linux. -->
+    <TargetFrameworks>netstandard2.0;net7.0</TargetFrameworks>
     <IsPackable>false</IsPackable>
     <OnnxRuntimeCsharpRoot>$(ProjectDir)..\..</OnnxRuntimeCsharpRoot>
     <Platforms>AnyCPU</Platforms>

diff --git a/...icrosoft.ML.OnnxRuntime.Tests.NetCoreApp/Microsoft.ML.OnnxRuntime.Tests.NetCoreApp.csproj b/...icrosoft.ML.OnnxRuntime.Tests.NetCoreApp/Microsoft.ML.OnnxRuntime.Tests.NetCoreApp.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFramework>net7.0</TargetFramework>
     <IsPackable>false</IsPackable>
     <OnnxRuntimeCsharpRoot>$(ProjectDir)..\..</OnnxRuntimeCsharpRoot>
     <Platforms>AnyCPU;x86</Platforms>

diff --git a/tools/ci_build/github/azure-pipelines/c-api-noopenmp-packaging-pipelines.yml b/tools/ci_build/github/azure-pipelines/c-api-noopenmp-packaging-pipelines.yml
@@ -594,8 +594,8 @@ stages:
   - job:
     workspace:
       clean: all
-    # we need to use the 2022 pool to create the nuget package with both pre-net6+Xamarin and net6 targets.
-    # VS2019 has no support for net6 and we need to use msbuild (from the VS install) to do the packing
+    # we need to use the 2022 pool to create the nuget package with both pre-net7+Xamarin and net7 targets.
+    # VS2019 has no support for net7 and we need to use msbuild (from the VS install) to do the packing
     pool: 'Onnxruntime-Win-CPU-2022'
     variables:
       breakCodesignValidationInjection: ${{ parameters.DoEsrp }}
@@ -675,7 +675,7 @@ stages:
       inputs:
         targetType: 'inline'
         script: |
-          dotnet workload install android ios
+          dotnet workload install android ios maccatalyst
         workingDirectory: '$(Build.SourcesDirectory)\csharp'
 
     - task: MSBuild@1
@@ -811,8 +811,8 @@ stages:
   - job:
     workspace:
       clean: all
-    # we need to use the 2022 pool to create the nuget package with both pre-net6+Xamarin and net6 targets.
-    # VS2019 has no support for net6 and we need to use msbuild (from the VS install) to do the packing
+    # we need to use the 2022 pool to create the nuget package with both pre-net7+Xamarin and net7 targets.
+    # VS2019 has no support for net7 and we need to use msbuild (from the VS install) to do the packing
     pool: 'Onnxruntime-Win-CPU-2022'
     variables:
       breakCodesignValidationInjection: ${{ parameters.DoEsrp }}
@@ -876,20 +876,20 @@ stages:
         versionSpec: 6.2.1
 
     - task: PowerShell@2
-      displayName: Build .NET 6 targets using dotnet
+      displayName: Build .NET 7 targets using dotnet
       inputs:
         targetType: 'inline'
         # we don't specify 'Any CPU' as the platform here because if we do it gets added to the output path
-        #   e.g. csharp\src\Microsoft.ML.OnnxRuntime\bin\Any CPU\RelWithDebInfo\net6.0-ios\
-        # which is inconsistent with the msbuild output path for the pre-.net6 targets
+        #   e.g. csharp\src\Microsoft.ML.OnnxRuntime\bin\Any CPU\RelWithDebInfo\net7.0-ios\
+        # which is inconsistent with the msbuild output path for the pre-.net7 targets
         #   e.g. csharp\src\Microsoft.ML.OnnxRuntime\bin\RelWithDebInfo\monoandroid11.0
         # and makes it harder to do the packing
         #
         # 'Any CPU' is the default (first 'mixed' platform specified in the csproj) so this should be fine.
         script: |
           dotnet build .\src\Microsoft.ML.OnnxRuntime\Microsoft.ML.OnnxRuntime.csproj `
-            -p:SelectedTargets=Net6 `
-            /p:Net6Targets=net6.0 `
+            -p:SelectedTargets=Net7 `
+            /p:Net7Targets=net7.0 `
             -p:Configuration=RelWithDebInfo `
             -p:OnnxRuntimeBuildDirectory="$(Build.BinariesDirectory)" `
             -p:OrtPackageId="Microsoft.ML.OnnxRuntime.ROCm" `
@@ -898,22 +898,22 @@ stages:
         workingDirectory: '$(Build.SourcesDirectory)\csharp'
 
     - task: MSBuild@1
-      displayName: 'Restore NuGet Packages and create project.assets.json for pre-.net6 targets'
+      displayName: 'Restore NuGet Packages and create project.assets.json for pre-.net7 targets'
       inputs:
         solution: '$(Build.SourcesDirectory)\csharp\OnnxRuntime.CSharp.sln'
         platform: 'Any CPU'
         configuration: RelWithDebInfo
-        msbuildArguments: '-t:restore -p:SelectedTargets=PreNet6 -p:OrtPackageId="Microsoft.ML.OnnxRuntime.ROCm"'
+        msbuildArguments: '-t:restore -p:SelectedTargets=PreNet7 -p:OrtPackageId="Microsoft.ML.OnnxRuntime.ROCm"'
         workingDirectory: '$(Build.SourcesDirectory)\csharp'
 
     - task: MSBuild@1
-      displayName: 'Build C# for pre-.net6 targets'
+      displayName: 'Build C# for pre-.net7 targets'
       inputs:
         solution: '$(Build.SourcesDirectory)\csharp\OnnxRuntime.CSharp.sln'
         configuration: RelWithDebInfo
         platform: 'Any CPU'
         msbuildArguments: >
-          -p:SelectedTargets=PreNet6
+          -p:SelectedTargets=PreNet7
           -p:OnnxRuntimeBuildDirectory="$(Build.BinariesDirectory)"
           -p:OrtPackageId="Microsoft.ML.OnnxRuntime.ROCm"
           -p:IsReleaseBuild=${{ parameters.IsReleaseBuild }}

diff --git a/tools/ci_build/github/azure-pipelines/linux-ci-pipeline.yml b/tools/ci_build/github/azure-pipelines/linux-ci-pipeline.yml
@@ -262,7 +262,7 @@ stages:
               pushd /onnxruntime_src/csharp; \
               dotnet restore /onnxruntime_src/csharp/OnnxRuntime.DesktopOnly.CSharp.sln; \
               dotnet build /onnxruntime_src/csharp/OnnxRuntime.DesktopOnly.CSharp.sln -c Release; \
-              dotnet test /onnxruntime_src/csharp/OnnxRuntime.DesktopOnly.CSharp.sln -c Release -f net6.0 --no-build -l \"console;verbosity=normal\"; \
+              dotnet test /onnxruntime_src/csharp/OnnxRuntime.DesktopOnly.CSharp.sln -c Release -f net7.0 --no-build -l \"console;verbosity=normal\"; \
               popd
               "
         displayName: 'Dotnet build C# sln and Test'

diff --git a/tools/ci_build/github/azure-pipelines/stages/nuget-combine-cuda-stage.yml b/tools/ci_build/github/azure-pipelines/stages/nuget-combine-cuda-stage.yml
@@ -98,12 +98,12 @@ stages:
             workingDirectory: '$(Build.SourcesDirectory)\csharp'
 
         - task: PowerShell@2
-          displayName: Build .NET 6 targets using dotnet
+          displayName: Build .NET 7 targets using dotnet
           inputs:
             targetType: 'inline'
             # we don't specify 'Any CPU' as the platform here because if we do it gets added to the output path
-            #   e.g. csharp\src\Microsoft.ML.OnnxRuntime\bin\Any CPU\RelWithDebInfo\net6.0-ios\
-            # which is inconsistent with the msbuild output path for the pre-.net6 targets
+            #   e.g. csharp\src\Microsoft.ML.OnnxRuntime\bin\Any CPU\RelWithDebInfo\net7.0-ios\
+            # which is inconsistent with the msbuild output path for the pre-.net7 targets
             #   e.g. csharp\src\Microsoft.ML.OnnxRuntime\bin\RelWithDebInfo\monoandroid11.0
             # and makes it harder to do the packing
             #

diff --git a/tools/ci_build/github/azure-pipelines/templates/c-api-cpu.yml b/tools/ci_build/github/azure-pipelines/templates/c-api-cpu.yml
@@ -409,7 +409,7 @@ stages:
       inputs:
         targetType: 'inline'
         script: |
-          dotnet workload install android ios
+          dotnet workload install android ios maccatalyst
         workingDirectory: '$(Build.SourcesDirectory)\csharp'
 
     - task: MSBuild@1

diff --git a/tools/ci_build/github/azure-pipelines/templates/jobs/win-ci-vs-2022-job.yml b/tools/ci_build/github/azure-pipelines/templates/jobs/win-ci-vs-2022-job.yml
@@ -96,6 +96,13 @@ jobs:
       WithCache: ${{parameters.WITH_CACHE}}
       Today: $(Today)
 
+  - task: UseDotNet@2
+    inputs:
+      version: '7.x'
+    ${{ if eq(parameters.isX86, true) }}:
+      env:
+          PROCESSOR_ARCHITECTURE: 'x86'
+
   - task: NodeTool@0
     inputs:
       versionSpec: '18.x'
@@ -240,4 +247,4 @@ jobs:
     condition: and(failed(), eq(variables['DocUpdateNeeded'], 'true'))
     inputs:
       pathtoPublish: '$(Build.SourcesDirectory)/docs/ContribOperators.md'
-      artifactName: 'ContribOperators.md'
+      artifactName: 'ContribOperators.md'
diff --git a/tools/ci_build/github/linux/docker/scripts/install_dotnet.sh b/tools/ci_build/github/linux/docker/scripts/install_dotnet.sh
@@ -4,7 +4,7 @@ set -e -x
 if [ -f /etc/redhat-release ]; then
   # If you found the following command went successfully but dotnet command still reports no sdk was found, most likely
   # it was because the dotnet packages were installed from more than one dnf repos.
-  dnf install -y dotnet-sdk-6.0 dotnet-runtime-6.0
+  dnf install -y dotnet-sdk-7.0 dotnet-runtime-7.0
 elif [ -f /etc/os-release ]; then
   # Get Ubuntu version
   declare repo_version
@@ -16,7 +16,7 @@ elif [ -f /etc/os-release ]; then
   # Clean up
   rm packages-microsoft-prod.deb
   # Update packages
-  apt-get update && apt-get install -y dotnet-sdk-6.0
+  apt-get update && apt-get install -y dotnet-sdk-7.0
 else
   echo "Unsupported OS"
   exit 1
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		### Notes for maccatalyst .NET targets:

		We only add a blank file for the target framework folder here and thus will be including blank TFM under build/ and buildTransitive/ in the Nuget package. The reason is for Mac Catalyst platform, it directly will resolve the xcframework from the runtimes/native/ios folder based on this [RuntimeidentifierGraph](https://github.com/dotnet/sdk/blob/main/src/Layout/redist/PortableRuntimeIdentifierGraph.json#L300-L304)