Skip to content

Clarify P/Invoke shims guidance for OOB assemblies #63470

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.

Sign up for GitHub

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
stephentoub merged 2 commits into from
Jan 7, 2022
Merged

Clarify P/Invoke shims guidance for OOB assemblies #63470

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
84a63da
Clarify P/Invoke shims guidance for OOB assemblies
MattKotsenas Jan 6, 2022
015ba25
Update docs/coding-guidelines/interop-guidelines.md
MattKotsenas Jan 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/coding-guidelines/interop-guidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,10 @@ This leaves us with a situation where we can't write portable P/Invoke declarati

To address this, we're moving to a model where all UNIX interop from dotnet/runtime starts with a P/Invoke to a C++ lib written specifically for dotnet/runtime. These libs -- System.*.Native.so (aka "shims") -- are intended to be very thin layers over underlying platform libraries. Generally, they are not there to add any significant abstraction, but to create a stable ABI such that the same IL assembly can work across UNIX flavors.

Note that System.Native shims can only be used for assemblies that are in the Microsoft.NETCore.App shared framework.
Assemblies that ship out-of-the-box, (e.g. Microsoft.Extensions.*) may target netfx, where the System.Native shim isn't present,
or older .NET Core versions where the shim itself it present, but won't have the new shim method.

Guidelines for shim C++ API:

- Keep them as "thin"/1:1 as possible.
Expand Down