Skip to content
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

Jump to bottom

Add linux-musl-x64 Runtime Support #374

Closed
adamrodger opened this issue Mar 2, 2022 · 5 comments · May be fixed by #502
Closed

Add linux-musl-x64 Runtime Support #374

adamrodger opened this issue Mar 2, 2022 · 5 comments · May be fixed by #502

Comments

@adamrodger
Copy link
Contributor

This is required for running PactNet inside Alpine containers, for example.
@adamrodger
Copy link
Contributor Author

Requested in upstream change: pact-foundation/pact-reference#185

@adamrodger
Copy link
Contributor Author

Available in FFI 0.2.3

@adamrodger
Copy link
Contributor Author

I started to add this but it's not going to work. The FFI for musl currently only outputs a static .a library, whereas .Net only supports loading shared libraries (.so, .dll, or .dylib).

I did manage to get the FFI to build a shared library (.so) on a musl target with some additional Rust flags:

RUSTFLAGS="-C target-feature=-crt-static" cargo build

rustup show
Default host: x86_64-unknown-linux-musl
rustup home:  /usr/local/rustup

1.59.0-x86_64-unknown-linux-musl (default)
rustc 1.59.0 (9d1b2106e 2022-02-23)

ls -alh target/debug/*.so
-rwxr-xr-x    2 root     root      207.1M Mar  5 16:54 target/debug/libpact_ffi.so
-rwxr-xr-x    2 root     root      119.1M Mar  5 16:52 target/debug/libpact_verifier.so

However, there are a few problems here:

  1. It's 207MB, which is massive for shipping inside a NuGet
  2. It has the same name as the linux-x64 version, and .Net doesn't have a way to detect musl inside the csproj (unless it's a hack and brittle way like checking the OS string for Alpine or something)
  3. That's a very non-standard build for a musl target with Rust, as mentioned in the issue dylib for target -musl rust-lang/rust#44991

I think, for now, I'm gonna close this one as wontfix unfortunately. I just can't see the effort being worth it at the moment, and by the sounds of things we're likely to have problems even if we could get the packaging working.

@uglyog It may be that we can actually remove the musl FFI build, sorry for the inconvenience. A .a is no use to interop and that's just what the standard musl builds on Rust produce.

@adamrodger
Copy link
Contributor Author

Correction to the above: the release build is actually 25.8MB. The debug build was 207.1MB.

@uglyog
Copy link
Member

uglyog commented Mar 6, 2022

I can look to update the FFI build with those flags

@mefellows mefellows mentioned this issue Apr 26, 2022
Closed
@botondbotos botondbotos mentioned this issue Apr 22, 2024
Open
YOU54F added a commit to YOU54F/pact-net that referenced this issue May 29, 2024
@YOU54F
feat: linux arm64 support & musl detection
5b38f3c 
## Rationale

pact-reference has introduced musl and arm64 based ffi libraries for linux

- pact-foundation/pact-reference#416

Tracking Issue

- pact-foundation/roadmap#30

## Issues Resolved

fixes pact-foundation#498
fixes pact-foundation#496
fixes pact-foundation#500
fixes pact-foundation#374
fixes pact-foundation#387

## Backwards Compatibility

Linux glibc based hosts take precedence, so if any error occurs during musl
detection. I do not anticipate breaking changes for users

## Implementation notes

### .NET notes

- Docs
  - [Uses MSBuild Exec task](https://learn.microsoft.com/en-us/visualstudio/msbuild/exec-task?view=vs-2022)
- MSBuild Blog Posts
  - [Cross-Platform Build Events in .NET Core using MSBuild](https://jeremybytes.blogspot.com/2020/05/cross-platform-build-events-in-net-core.html)
  - [MSBuild 101: Using the exit code from a command](https://www.creepingcoder.com/2020/06/01/msbuild-101-using-the-exit-code-from-a-command/)
- Stack OverFlow
  - [Set PropertyGroup property to Exec output](https://stackoverflow.com/questions/76583824/set-propertygroup-property-to-exec-output)
- .NET runtime musl detection code
  - https://github.com/dotnet/runtime/blob/a50ba0669353893ca8ade8568b0a7d210b5a425f/src/mono/llvm/llvm-init.proj\#L7
  - https://github.com/dotnet/runtime/blob/a50ba0669353893ca8ade8568b0a7d210b5a425f/src/libraries/Common/tests/TestUtilities/System/PlatformDetection.Unix.cs\#L78t

### Conditions for execution

musl detection will run if

- if linux
- if /lib/ld-musl-(x86_64|aarch64).so.1 exists
- if ldd bin/sh | grep musl is true (musl lib is loaded, rather than glibc)

will continue on error, reverting back to glibc based libaries.

### Supported musl targets

should work for multiple musl based distroes if

- /lib/ld-musl-(x86_64|aarch64).so.1 exists
- ldd is available (available by default in alpine images)

Tested on Alpine ARM64 / AMD64.

## Caveats

- [.NET does not run under QEMU](https://github.com/dotnet/core/blob/main/release-notes/8.0/supported-os.md#qemu) affecting the ability to test multi-arch from a single system
- .NET restore can take a long time when running under containers.
  - [Workaround](NuGet/Home#13062 (comment)): Set `DOTNET_NUGET_SIGNATURE_VERIFICATION` to `false`

## Compatibility

### Operating System

Due to using a shared native library instead of C# for the main Pact logic only certain OSs are supported:

| OS           | Arch        | Support                                                            |
| ------------ | ----------- | -------------------------------------------------------------------|
| Windows      | x86         | ❌ No                                                              |
| Windows      | x64         | ✔️ Yes                                                              |
| Linux (libc) | x86         | ❌ No                                                              |
| Linux (libc) | x64         | ✔️ Yes                                                              |
| Linux (musl) | x64         | ✔️ Yes (Tier 2)*                                                    |
| Linux (libc) | ARM         | ✔️ Yes (Tier 3)*                                                    |
| Linux (musl) | ARM         | ✔️ Yes (Tier 3)*                                                    |
| OSX          | x64         | ✔️ Yes                                                              |
| OSX          | ARM (M1/M2) | ✔️ Yes                                                              |

#### Support

- Tier 1
  - Established
  - Full CI/CD support.
  - Users should not encounter issues
  - Full reproducible examples running in CI, should be provided by users raising issues
  - If using musl targets, users should attempt the same test on a libc target (such as debian)
- Tier 2
  - Recently introduced
  - Full CI/CD support.
  - Users may encounter issues
  - Full reproducible examples running in CI, should be provided by users raising issues
  - If using musl targets, users should attempt the same test on a libc target (such as debian)
- Tier 3
  - Recently introduced, No/limited CI/CD support.
  - Users may encounter issues
  - Full reproducible examples which can be run by maintainers locally, should be provided by users raising issues
@YOU54F YOU54F mentioned this issue May 29, 2024
Open
YOU54F added a commit to YOU54F/pact-net that referenced this issue Sep 24, 2024
@YOU54F
feat: linux-musl runtime support
a41c667 
## Rationale

pact-reference has introduced musl and arm64 based ffi libraries for linux

- pact-foundation/pact-reference#416

Tracking Issue

- pact-foundation/roadmap#30

## Issues Resolved

fixes pact-foundation#498
fixes pact-foundation#496
fixes pact-foundation#500
fixes pact-foundation#374
fixes pact-foundation#387

## Backwards Compatibility

Linux glibc based hosts take precedence, so if any error occurs during musl
detection. I do not anticipate breaking changes for users

## Implementation notes

### .NET notes

- Docs
  - [Uses MSBuild Exec task](https://learn.microsoft.com/en-us/visualstudio/msbuild/exec-task?view=vs-2022)
- MSBuild Blog Posts
  - [Cross-Platform Build Events in .NET Core using MSBuild](https://jeremybytes.blogspot.com/2020/05/cross-platform-build-events-in-net-core.html)
  - [MSBuild 101: Using the exit code from a command](https://www.creepingcoder.com/2020/06/01/msbuild-101-using-the-exit-code-from-a-command/)
- Stack OverFlow
  - [Set PropertyGroup property to Exec output](https://stackoverflow.com/questions/76583824/set-propertygroup-property-to-exec-output)
- .NET runtime musl detection code
  - https://github.com/dotnet/runtime/blob/a50ba0669353893ca8ade8568b0a7d210b5a425f/src/mono/llvm/llvm-init.proj\#L7
  - https://github.com/dotnet/runtime/blob/a50ba0669353893ca8ade8568b0a7d210b5a425f/src/libraries/Common/tests/TestUtilities/System/PlatformDetection.Unix.cs\#L78t

### Conditions for execution

musl detection will run if

- if linux
- if /lib/ld-musl-(x86_64|aarch64).so.1 exists
- if ldd bin/sh | grep musl is true (musl lib is loaded, rather than glibc)

will continue on error, reverting back to glibc based libaries.

### Supported musl targets

should work for multiple musl based distroes if

- /lib/ld-musl-(x86_64|aarch64).so.1 exists
- ldd is available (available by default in alpine images)

Tested on Alpine ARM64 / AMD64.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: linux musl detection YOU54F/pact-net
2 participants
@adamrodger @uglyog