-
Notifications
You must be signed in to change notification settings - Fork 6.1k
[docs] Add building iOS-like native libraries with NativeAOT #43397
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
ivanpovazan
merged 15 commits into
dotnet:main
from
ivanpovazan:nativeaot-ios-library-mode
Nov 24, 2024
Merged
Changes from 13 commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
665aaa7
Add building iOS-like native libraries with NativeAOT documentation
ivanpovazan 1a6cd9a
Add redirect url
ivanpovazan 48df885
Avoid using term: desktop platforms
ivanpovazan 64973cb
Clarify the use case
ivanpovazan a5b3f3c
Feedback
ivanpovazan 41ba639
Simplify publish instructions
ivanpovazan 6316f47
Apply grammatical suggestions from code review
ivanpovazan d7af207
Fix indent in source code sample
ivanpovazan 8cb303a
wip: Restructuring
ivanpovazan 6fda5dd
wip: Update TOC
ivanpovazan 2c882a8
wip: Restructure clean up
ivanpovazan ec65ba0
wip: Adding overview page
ivanpovazan b7df7aa
wip: clean up
ivanpovazan 86cace4
Feedback
ivanpovazan 33db811
Wording
ivanpovazan File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Binary file added
BIN
+184 KB
...deploying/media/native-aot-ios-like-platforms/xcode-add-framework-reference.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+230 KB
...ploying/media/native-aot-ios-like-platforms/xcode-add-framework-search-path.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
245 changes: 245 additions & 0 deletions
245
...oying/native-aot/ios-like-platforms/creating-and-consuming-custom-frameworks.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,245 @@ | ||
| --- | ||
| title: Create and consume custom frameworks for iOS-like platforms | ||
| description: How to create and consume custom frameworks with Native AOT for iOS-like platforms | ||
| author: ivanpovazan | ||
| ms.author: ivanpovazan | ||
| ms.date: 11/21/2024 | ||
| --- | ||
|
|
||
| # Create and consume custom frameworks for iOS-like platforms | ||
|
|
||
| Starting from .NET 9, Native AOT supports publishing .NET class libraries that don't depend on iOS workloads for iOS-like platforms. | ||
| This support enables you to create self-contained native libraries that can be consumed from iOS, Mac Catalyst, and tvOS applications. | ||
|
|
||
| > [!IMPORTANT] | ||
| > This approach does not come with the built-in Objective-C interoperability support and additional code adaptations might be required (such as marshalling reference type arguments) to achieve interoperability. | ||
|
|
||
| ## Build shared libraries | ||
|
|
||
| This section describes steps to create a simple .NET Class Library project with NativeAOT support and produce a native library for iOS-like platforms from it. | ||
|
|
||
| 1. Download .NET 9 SDK | ||
| 2. Create a class library project | ||
|
|
||
| ```bash | ||
| dotnet new classlib -n "MyNativeAOTLibrary" | ||
| ``` | ||
|
|
||
| 3. Add the following properties into the project file `MyNativeAOTLibrary.csproj` | ||
|
|
||
| ```xml | ||
| <PublishAot>true</PublishAot> | ||
| <PublishAotUsingRuntimePack>true</PublishAotUsingRuntimePack> | ||
| ``` | ||
|
|
||
| 4. Edit the `MyNativeAOTLibrary/Class1.cs` source code to expose a managed method to the native world as `aotsample_add`. For example: | ||
|
|
||
| ```cs | ||
| using System.Runtime.InteropServices; | ||
| namespace NaotLib; | ||
|
|
||
| public class Class1 | ||
| { | ||
| [UnmanagedCallersOnly(EntryPoint = "aotsample_add")] | ||
| public static int Add(int a, int b) | ||
| { | ||
| return a + b; | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| 5. Publish the class library and target the desired iOS-like platform by specifying the appropriate runtime identifier (referenced below as `<rid>`): | ||
|
|
||
| ```bash | ||
| dotnet publish -r <rid> MyNativeAOTLibrary/MyNativeAOTLibrary.csproj | ||
| ``` | ||
|
|
||
| Successful completion of the previous step produces a pair of files: a shared library `MyNativeAOTLibrary.dylib` and its debug symbols `MyNativeAOTLibrary.dylib.dSYM`, which are located at: `MyNativeAOTLibrary/bin/Release/net9.0/<rid>/publish/`. | ||
|
|
||
| > [!NOTE] | ||
| > For creating universal frameworks, it is required to publish the class library for both `Arm64` and `x64` architectures for a given platform. | ||
| > This means that you need to repeat step 5 with a different runtime identifier. | ||
| > For example, you'd publish the class library with both `maccatalyst-arm64` and `maccatalyst-x64` runtime identifiers as a prerequisite for [Packaging the shared library into a custom MacCatalyst universal framework](#package-the-shared-library-into-a-custom-maccatalyst-universal-framework). | ||
|
|
||
| ## Create and consume a custom framework | ||
|
|
||
| Apple imposes a requirement that shared libraries (.dylibs) need to be packaged into frameworks in order to be consumed from applications. | ||
|
|
||
| This section describes all required steps to achieve this and a simple scenario of a iOS/MacCatalyst application consuming a shared NativeAOT library/framework. | ||
|
|
||
| > [!NOTE] | ||
| > The described steps are just for demonstration purposes. The actual requirements might differ depending on the exact use case. | ||
|
|
||
| ### Package the shared library into custom iOS framework | ||
|
|
||
| 1. Create a framework folder: | ||
|
|
||
| ```bash | ||
| mkdir MyNativeAOTLibrary.framework | ||
| ``` | ||
|
|
||
| 2. Adjust load commands: | ||
|
|
||
| - `LC_RPATH` load command | ||
|
|
||
| ```bash | ||
| install_name_tool -rpath @executable_path @executable_path/Frameworks MyNativeAOTLibrary/bin/Release/net9.0/ios-arm64/publish/MyNativeAOTLibrary.dylib | ||
| ``` | ||
|
|
||
| - `LC_ID_DYLIB` load command | ||
|
|
||
| ```bash | ||
| install_name_tool -id @rpath/MyNativeAOTLibrary.framework/MyNativeAOTLibrary MyNativeAOTLibrary/bin/Release/net9.0/ios-arm64/publish/MyNativeAOTLibrary.dylib | ||
| ``` | ||
|
|
||
| 3. Manually package the binary into a universal file: | ||
|
|
||
| ```bash | ||
| lipo -create MyNativeAOTLibrary/bin/Release/net9.0/ios-arm64/publish/MyNativeAOTLibrary.dylib -output MyNativeAOTLibrary.framework/MyNativeAOTLibrary | ||
| ``` | ||
|
|
||
| 4. Add a property list file to your framework: | ||
|
|
||
| - Create a `Info.plist` file | ||
|
|
||
| ```bash | ||
| touch MyNativeAOTLibrary.framework/Info.plist | ||
| ``` | ||
|
|
||
| - Add the contents from the [appendix](#appendix-infoplist-contents) into the created `Info.plist` file | ||
|
|
||
| After the final step, the framework structure should look like this: | ||
|
|
||
| ``` | ||
| MyNativeAOTLibrary.framework | ||
| |_ MyNativeAOTLibrary | ||
| |_ Info.plist | ||
| ``` | ||
|
|
||
| ### Package the shared library into a custom MacCatalyst universal framework | ||
|
|
||
| Universal frameworks require binaries for both `Arm64` and `x64` architecture. | ||
| For this reason, you must publish native libraries targeting both of the following RIDs beforehand: `maccatalyst-arm64` and `maccatalyst-x64`. | ||
|
|
||
| 1. Create a framework folder structure: | ||
|
|
||
| ```bash | ||
| mkdir -p MyNativeAOTLibrary.framework/Versions/A/Resources | ||
| ln -sfh Versions/Current/MyNativeAOTLibrary MyNativeAOTLibrary.framework/MyNativeAOTLibrary | ||
| ln -sfh Versions/Current/Resources MyNativeAOTLibrary.framework/Resources | ||
| ln -sfh A MyNativeAOTLibrary.framework/Versions/Current | ||
| ``` | ||
|
|
||
| 2. Adjust load commands: | ||
|
|
||
| - `LC_RPATH` load command | ||
|
|
||
| ```bash | ||
| install_name_tool -rpath @executable_path @executable_path/../Frameworks MyNativeAOTLibrary/bin/Release/net9.0/maccatalyst-arm64/publish/MyNativeAOTLibrary.dylib | ||
| install_name_tool -rpath @executable_path @executable_path/../Frameworks MyNativeAOTLibrary/bin/Release/net9.0/maccatalyst-x64/publish/MyNativeAOTLibrary.dylib | ||
| ``` | ||
|
|
||
| - `LC_ID_DYLIB` load command | ||
|
|
||
| ```bash | ||
| install_name_tool -id @rpath/MyNativeAOTLibrary.framework/Versions/A/MyNativeAOTLibrary MyNativeAOTLibrary/bin/Release/net9.0/maccatalyst-arm64/publish/MyNativeAOTLibrary.dylib | ||
| install_name_tool -id @rpath/MyNativeAOTLibrary.framework/Versions/A/MyNativeAOTLibrary MyNativeAOTLibrary/bin/Release/net9.0/maccatalyst-x64/publish/MyNativeAOTLibrary.dylib | ||
| ``` | ||
|
|
||
| 3. Manually package the binary into a universal file: | ||
|
|
||
| ```bash | ||
| lipo -create MyNativeAOTLibrary/bin/Release/net9.0/maccatalyst-arm64/publish/MyNativeAOTLibrary.dylib MyNativeAOTLibrary/bin/Release/net9.0/maccatalyst-x64/publish/MyNativeAOTLibrary.dylib -output MyNativeAOTLibrary.framework/Versions/A/MyNativeAOTLibrary | ||
| ``` | ||
|
|
||
| 4. Add a property list file to your framework: | ||
|
|
||
| - Create a `Info.plist` file | ||
|
|
||
| ```bash | ||
| touch MyNativeAOTLibrary.framework/Versions/A/Resources/Info.plist | ||
| ``` | ||
|
|
||
| - Add the contents from the [appendix](#appendix-infoplist-contents) into the created `Info.plist` file | ||
|
|
||
| After the final step, the framework structure should look like this: | ||
|
|
||
| ``` | ||
| MyNativeAOTLibrary.framework | ||
| |_ MyNativeAOTLibrary -> Versions/Current/MyNativeAOTLibrary | ||
| |_ Resources -> Versions/Current/Resources | ||
| |_ Versions | ||
| |_ A | ||
| | |_ Resources | ||
| | | |_ Info.plist | ||
| | |_ MyNativeAOTLibrary | ||
| |_ Current -> A | ||
| ``` | ||
|
|
||
| ### Consume custom frameworks | ||
|
|
||
| 1. Open `Xcode` (in this example `Xcode 16.0` is used) | ||
| 2. Create a new `App` project | ||
| 3. Choose the name for your app (for example, `MyiOSApp`) and choose Objective-C as the source language | ||
| 4. Add a reference to the `MyNativeAOTLibrary` framework | ||
| - In the `MyiOSApp` targets **General** tab, under **Frameworks, Libraries and Embedded Content**, select **+** to add `MyNativeAOTLibrary` as the referenced framework | ||
| - In the dialog, choose **Add Other** -> **Add Files** and then browse to the location of `MyNativeAOTLibrary.framework` and select it | ||
| - Once selected, set `Embed and Sign` option for `MyNativeAOTLibrary` framework | ||
|
|
||
|  | ||
|
|
||
| 5. Add `MyNativeAOTLibrary.framework` location to the list of **Framework Search Paths** in the **Build Settings** tab | ||
|
|
||
|  | ||
|
|
||
| 6. Edit `main.m` by calling the exposed managed method `aotsample_add` and printing the result | ||
|
|
||
| ```objc | ||
| extern int aotsample_add(int a, int b); | ||
| int main(int argc, char * argv[]) { | ||
| ... | ||
| NSLog(@"2 + 5 = %d", aotsample_add(2, 5)); | ||
| ... | ||
| } | ||
| ``` | ||
|
|
||
| 7. Select your physical iOS device and build/run the app | ||
| 8. Inspect the logs after the app has successfully launched. The app should print out: `2 + 5 = 7` | ||
|
|
||
| > [!NOTE] | ||
| > For MacCatalyst, use the same steps except for step 7, where the Run Destination needs to be set as: `Mac (Mac Catalyst)`. | ||
|
|
||
| ## Build static libraries with NativeAOT for iOS-like platforms | ||
|
|
||
| As described in [building native libraries overview](../libraries.md#building-native-libraries), it's better to build shared libraries over static ones due to several limitations. | ||
|
|
||
| However, if desired, you can build a static library by following the steps for building a shared one and including an additional property in the project file: | ||
|
|
||
| ```xml | ||
| <NativeLib>Static</NativeLib> | ||
| ``` | ||
|
|
||
| After the project has been published, the static library `MyNativeAOTLibrary.a` can be found at: `MyNativeAOTLibrary/bin/Release/net9.0/<rid>/publish`. | ||
|
|
||
| This article doesn't cover how to consume the static library and configure the consumer project. | ||
|
|
||
| ## Appendix Info.plist contents | ||
|
|
||
| ```xml | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd"> | ||
| <plist version="1.0"> | ||
| <dict> | ||
| <key>CFBundleName</key> | ||
| <string>MyNativeAOTLibrary</string> | ||
| <key>CFBundleIdentifier</key> | ||
| <string>com.companyname.MyNativeAOTLibrary</string> | ||
| <key>CFBundleVersion</key> | ||
| <string>1.0</string> | ||
| <key>CFBundleExecutable</key> | ||
| <string>MyNativeAOTLibrary</string> | ||
| <key>CFBundlePackageType</key> | ||
| <string>FMWK</string> | ||
| </dict> | ||
| </plist> | ||
| ``` |
51 changes: 51 additions & 0 deletions
51
docs/core/deploying/native-aot/ios-like-platforms/index.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| --- | ||
| title: Native AOT support for iOS-like platforms overview | ||
| description: Learn how Native AOT supports iOS-like platforms | ||
| author: ivanpovazan | ||
| ms.author: ivanpovazan | ||
| ms.date: 11/21/2024 | ||
| --- | ||
|
|
||
| # Native AOT support for iOS-like platforms | ||
|
|
||
| Starting from .NET 8, Native AOT supports targeting iOS-like platforms. The term *iOS-like platforms* refers to Apple platforms that use similar APIs such as: iOS, MacCatalyst and tvOS. | ||
|
|
||
| In the first release, the support was experimental, while in .NET 9 these platforms received full support with Native AOT. | ||
|
|
||
| Based on the use case, the support can be divided into: | ||
|
|
||
| - support for applications and libraries without OS-specific API dependencies | ||
| - support for applications and libraries referencing OS-specific APIs | ||
|
|
||
| ## Support for applications and libraries without OS-specific API dependencies | ||
|
|
||
| This refers to .NET projects targeting the general or non-OS-specific target framework (like: `net9.0`), for which Native AOT can be enabled in the following way: | ||
|
|
||
| 1. Include the following properties in your project file: | ||
|
|
||
| ```xml | ||
| <PublishAot>true</PublishAot> | ||
| <PublishAotUsingRuntimePack>true</PublishAotUsingRuntimePack> | ||
| ``` | ||
|
|
||
| 2. Publish the project for the desired iOS-like target platform by specifying adequate runtime identifier (later referred to as `<rid>`): | ||
|
|
||
| - `ios-arm64`, for iOS physical devices | ||
| - `iossimulator-arm64` or `iossimulator-x64`, for iOS simulators | ||
| - `maccatalyst-arm64` or `maccatalyst-x64`, for Mac Catalyst | ||
| - `tvos-arm64`, for tvOS physical devices | ||
| - `tvossimulator-arm64` or `tvossimulator-x64`, for tvOS simulators | ||
|
|
||
| and execute the following command: | ||
|
|
||
| ``` | ||
| dotnet publish -r <rid> | ||
| ``` | ||
|
|
||
| For specifics of building and consuming native libraries on iOS-like platforms, see [How to create and consume custom frameworks with Native AOT for iOS-like platforms](./creating-and-consuming-custom-frameworks.md). | ||
|
|
||
| ## Support for applications and libraries referencing OS-specific APIs | ||
ivanpovazan marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| This refers to .NET MAUI projects targeting OS-specific target frameworks (like: `net9.0-ios`). | ||
|
|
||
| How Native AOT can be enabled for .NET MAUI apps, see [Native AOT deployment on iOS and Mac Catalyst](/dotnet/maui/deployment/nativeaot). | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.