[runtime] Infrastructure to build runtime components using NativeAOT #98565
There are no files selected for viewing
This file contains 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
This file contains 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,45 @@ | ||
| # Infrastructure to import a native aot compiled library into a native build | ||
|
|
||
| # ## Implementation details used by libraryName-config.cmake find_package configuration | ||
| # ## files. Consumers don't need to do this directly. | ||
|
|
||
| # add_imported_nativeaot_library(targetName symbolPrefix [NAMESPACE namespace]) | ||
| # | ||
| # adds a target targetName that can be used to reference a NativeAOTed library. symbolPrefix should | ||
| # be the ALLCAPS prefix of the variables that define the mode and paths for the library. They are | ||
| # typically set in the artifacts/obj/targetName/targetName.cmake fragment which should be included | ||
| # before calling this function. | ||
| function(add_imported_nativeaot_library targetNameIn symbolPrefix) | ||
| cmake_parse_arguments(PARSE_ARGV 2 "add_imported_opt" "" "NAMESPACE" "") | ||
| message(TRACE "${symbolPrefix}_MODE is ${${symbolPrefix}_MODE}") | ||
| set(targetName "${add_imported_opt_NAMESPACE}${targetNameIn}") | ||
| message(TRACE "Adding target ${targetName}") | ||
|
|
||
| if("${${symbolPrefix}_MODE}" STREQUAL "SHARED") | ||
| set(libName "${${symbolPrefix}_NAME}") # typically same as targetName | ||
| set(libPath "${${symbolPrefix}_LIBPATH}") # typically /.../artifacts/bin/<libName>/<config>/<rid>/publish | ||
| set(libFilename "${libName}${${symbolPrefix}_EXT}") # <libName>.dll, <libName>.so or <libName>.dylib | ||
| set(libFullPath "${libPath}/${libFilename}") | ||
|
|
||
| if(CLR_CMAKE_HOST_WIN32) | ||
| set(libPdbFullPath "${libPath}/${libName}.pdb") | ||
| endif() | ||
|
|
||
| # windows import library | ||
| set(libImpLibFullPath "${${symbolPrefix}_IMPLIBPATH}") # typically /.../artifacts/bin/<libName>/<config>/<rid>/native/<libName>.lib | ||
|
|
||
| set(copy_target_name "${targetNameIn}_copy_imported_library") | ||
|
|
||
| add_imported_library_clr(${targetName} COPY_TARGET ${copy_target_name} IMPORTED_LOCATION "${libFullPath}") | ||
| set_property(TARGET ${targetName} PROPERTY CLR_IMPORTED_NATIVEAOT_LIBRARY 1) | ||
|
|
||
| if("${CLR_CMAKE_HOST_WIN32}") | ||
| set_property(TARGET ${targetName} PROPERTY IMPORTED_IMPLIB "${libImpLibFullPath}") | ||
| endif() | ||
|
|
||
| set(libIncludePath "${${symbolPrefix}_INCLUDE}") | ||
| target_include_directories(${targetName} INTERFACE "${libIncludePath}") | ||
| else() | ||
| message(FATAL_ERROR "${symbolPrefix}_MODE must be SHARED") | ||
| endif() | ||
| endfunction() |
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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,3 @@ | ||
| <Project> | ||
| <Import Project="..\..\..\Directory.Build.props" /> | ||
| </Project> |
This file contains 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,53 @@ | ||
| # Native runtime component libraries using NativeAOT | ||
|
|
||
| This directory contains managed libraries that will be compiled using NativeAOT and can be used in runtime components. | ||
|
|
||
| ## Using existing libraries | ||
|
|
||
| In a `CMakeLists.txt` add | ||
|
|
||
| ``` cmake | ||
| find_nativeaot_library(libWhatever REQUIRED) | ||
| ``` | ||
|
|
||
| This will look for a cmake fragment file in | ||
| `artifacts/obj/cmake/find_package/libWhatever-config.cmake` that will import some variables from | ||
| `artifacts/obj/libWhatever/libWhatever.cmake` and defines a new `libWhatever::libWhatever` that can | ||
| be used as a dependency in `target_link_libraries()` or in a `install_clr()` command. | ||
|
|
||
|
|
||
| ## Adding a new managed library | ||
|
|
||
| Add a new subdirectory to `src/native/managed` for your library with a `src` and `inc` subdirectories: | ||
|
|
||
| ``` console | ||
| $ mkdir -p libMyNewLibrary/src libMyNewLibrary/inc | ||
| $ dotnet new classlib -n libMyNewLibrary -o libMyNewLibrary/src | ||
| ``` | ||
|
|
||
| In `src/native/managed/compile-native.proj`, add | ||
| `src/native/managed/libMyNewLibrary/src/libMyNewLibrary.csproj` to the `NativeLibsProjectsToBuild` | ||
| item group. | ||
|
|
||
| In `src/native/managed/libMyNewLibrary/src/libMyNewLibrary.csproj`: | ||
| 1. Near the top, add `<Import Project="..\..\native-library.props" />` | ||
| 2. Near the bottom, add `<Import Project="..\..\native-library.targets" />` | ||
lambdageek marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| The following is recommended: | ||
|
|
||
| 1. The project should be called `libXXXX` - currently the infrastructure expects a `lib` prefix on all platforms. | ||
| 2. The project should just have a single `EntryPoints.cs` that has a `static class` that provides | ||
| `[UnmanagedCallersOnly]` API entrypoints. The bulk of the code should be imported using | ||
| `ProjectReference` from another managed class library project. That managed project can be | ||
| tested using normal managed unit tests, consumed in other managed libraries, etc. | ||
| 3. The `inc` directory if it exists will be added to the include path of any cmake targets that | ||
| depend on the native library. Typically the directory should contain a `libMyNewLibrary.h` header | ||
| file with a C declaration for each entrypoint. If you want ot have more include directories, add | ||
| them all to the `NativeLibraryCmakeFragmentIncludePath` item. In that case `inc` won't be added | ||
| by default. | ||
|
|
||
| Limitations: | ||
|
|
||
| Currently only shared library output is supported. In principle static linking is possible, but the | ||
| infrastructure is not finished yet. Additionally, mixing Debug/Release configurations with static | ||
| linking will not be supported on Windows. | ||
|
There was a problem hiding this comment. How do you feel about inlining these templates in MSBuild (to reduce number of moving parts)? It's just something which we considered in part infra work. e.g. in cmake we need to use the config.in template files, it is a natural fit in that world. In MSBuild, what comes natural is to write bunch of lines from targets directly somewhere under obj/ directory; without introducing some external template system. There was a problem hiding this comment. @am11 an earlier version of this PR used There was a problem hiding this comment. An alternative (to avoid external template and intermediate file writes) is to include |
This file contains 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,10 @@ | ||
| # This is a Config-style package configuration file for cmake's find_package command for ${libArtifactName} | ||
| set(CMAKE_FRAGMENT_PATH "${libArtifactConfigFragment}") | ||
|
|
||
| include("`${CLR_ENG_NATIVE_DIR}/import-nativeaot-library.cmake") | ||
|
|
||
| include("`${CMAKE_FRAGMENT_PATH}") | ||
|
|
||
| # adds a ${libArtifactName}::${libArtifactName} target | ||
| add_imported_nativeaot_library("${libArtifactName}" "${libCmakeName}" NAMESPACE "${libArtifactName}::") | ||
|
|
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think in the future, I'd almost rather have a "CMake module" file produced for the NativeAOT libraries instead of hard-coding it all here. I opened an issue related to this in DNNE a while back, AaronRobinsonMSFT/DNNE#185.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yea, this could be a separate NuGet. it should be possible to generate a cmake config, a rust crate, etc just by hooking something up after NativeAOT's publish target.
right now the cmake config isn't entirely self-contained most obviously it depends on eng/native/configureplatform.cmake but probably also some other of our variables are leaking in. But maybe it's possible to refactor it.
Also I didn't do multi-config generator support, which maybe people care about.