Skip to content

Fix native library loading for osx-arm64#17365

Merged
iSazonov merged 1 commit intoPowerShell:masterfrom
awakecoding:native-dll-osx-arm64-fix
Jun 4, 2022
Merged

Fix native library loading for osx-arm64#17365
iSazonov merged 1 commit intoPowerShell:masterfrom
awakecoding:native-dll-osx-arm64-fix

Conversation

@awakecoding
Copy link
Copy Markdown
Contributor

@awakecoding awakecoding commented May 17, 2022

PR Summary

The current native library loader on macOS is hardcoded to use "osx-x64", which breaks loading native libraries under the "osx-arm64" directory.

PR Context

We've been fighting for days trying to figure out why PowerShell wouldn't load our arm64 native libraries for our PowerShell module on macOS. The reason why was quite obvious when looking at the source code.

Rather than hardcode "osx-x64" we should just use "osx-" + the process architecture like for other platforms. This is a really simple fix.

@ghost ghost assigned TravisEz13 May 17, 2022
@SteveL-MSFT SteveL-MSFT requested a review from iSazonov May 17, 2022 21:05
@awakecoding awakecoding force-pushed the native-dll-osx-arm64-fix branch from 50e9abc to e892dd2 Compare May 18, 2022 14:05
@pull-request-quantifier-deprecated
Copy link
Copy Markdown

pull-request-quantifier-deprecated bot commented May 18, 2022

This PR has 2 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!

Quantification details 

Label      : Extra Small
Size       : +1 -1
Percentile : 0.8%

Total files changed: 1

Change summary by file extension:
.cs : +1 -1

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

  • Fast and predictable releases to production:
    • Optimal size changes are more likely to be reviewed faster with fewer
      iterations.
    • Similarity in low PR complexity drives similar review times.
  • Review quality is likely higher as complexity is lower:
    • Bugs are more likely to be detected.
    • Code inconsistencies are more likely to be detetcted.
  • Knowledge sharing is improved within the participants:
    • Small portions can be assimilated better.
  • Better engineering practices are exercised:
    • Solving big problems by dividing them in well contained, smaller problems.
    • Exercising separation of concerns within the code changes.

What can I do to optimize my changes

  • Use the PullRequestQuantifier to quantify your PR accurately
    • Create a context profile for your repo using the context generator
    • Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
    • Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
    • Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
  • Change your engineering behaviors
    • For PRs that fall outside of the desired spectrum, review the details and check if:
      • Your PR could be split in smaller, self-contained PRs instead
      • Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

  • One line was added: +1 -0
  • One line was deleted: +0 -1
  • One line was modified: +1 -1 (git diff doesn't know about modified, it will
    interpret that line like one addition plus one deletion)
  • Change percentiles: Change characteristics (addition, deletion, modification)
    of this PR in relation to all other PRs within the repository.

Was this comment helpful? 👍  :ok_hand:  :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

@awakecoding
Copy link
Copy Markdown
Contributor Author

awakecoding commented May 18, 2022

@SteveL-MSFT we've confirmed that the fix does work for us, but we also noticed something quite annoying that wasn't so obvious: to get automatic library loading in .NET, you have to use just the library name without the "lib" prefix and file extension. However, .NET normally expects to find "libname.dylib" on macOS, "libname.so" on Linux, and "name.dll" for pinvoke on library "name", while PowerShell apparently always assumes prefix-less library names ("name.dylib", "name.so", "name.dll"). Taking a second look at that comment block, I can see that all library names don't use the lib prefix, so I guess it's documented, but none of us had understood it was probably intentional.

In any case, the fix does work for us, we can correctly load both osx-x64 and osx-arm64 native libraries. Now the real question is: do we wait until this makes it into the next PowerShell release, and when would that likely be? I'm trying to judge if we still need a temporary workaround, or if we can tell our customers to wait until the next PowerShell release for Apple M1 support.

@awakecoding
Copy link
Copy Markdown
Contributor Author

awakecoding commented May 18, 2022

@SteveL-MSFT we've found a temporary workaround that works: putting a universal library into the osx-x64 folder. This should be good enough until the next PowerShell release containing the fix, after which we could use single-architecture libraries in their respective folders instead

@SteveL-MSFT
Copy link
Copy Markdown
Member

SteveL-MSFT commented May 18, 2022

@awakecoding this will probably not make it into this month's preview release, but should make it into June.

@TravisEz13 TravisEz13 added the CL-Engine Indicates that a PR should be marked as an engine change in the Change Log label May 19, 2022
@TravisEz13
Copy link
Copy Markdown
Member

TravisEz13 commented May 19, 2022

/azp run powershell-ci-macos

@azure-pipelines
Copy link
Copy Markdown

azure-pipelines bot commented May 19, 2022

Azure Pipelines successfully started running 1 pipeline(s).

daxian-dbw
daxian-dbw approved these changes May 20, 2022
View reviewed changes
Copy link
Copy Markdown
Member

@daxian-dbw daxian-dbw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ghost ghost added the Review - Needed The PR is being reviewed label May 28, 2022
@ghost
Copy link
Copy Markdown

ghost commented May 28, 2022

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

@iSazonov
Copy link
Copy Markdown
Collaborator

iSazonov commented May 28, 2022

@TravisEz13 Friendly ping.

@ghost ghost removed the Review - Needed The PR is being reviewed label May 28, 2022
@ghost ghost added the Review - Needed The PR is being reviewed label Jun 4, 2022
@ghost
Copy link
Copy Markdown

ghost commented Jun 4, 2022

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

@iSazonov iSazonov merged commit c798f74 into PowerShell:master Jun 4, 2022
@ghost ghost removed the Review - Needed The PR is being reviewed label Jun 4, 2022
@TravisEz13
Copy link
Copy Markdown
Member

TravisEz13 commented Jun 7, 2022

/backport to release/v7.2.5

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Jun 7, 2022 •
edited by unfurl-links bot
Loading

Started backporting to release/v7.2.5: https://github.com/PowerShell/PowerShell/actions/runs/2456295092

GitHub
PowerShell for every system! Contribute to PowerShell/PowerShell development by creating an account on GitHub.

@github-actions github-actions bot mentioned this pull request Jun 7, 2022
Merged
1 task
@ghost
Copy link
Copy Markdown

ghost commented Jun 22, 2022

🎉v7.3.0-preview.5 has been released which incorporates this pull request.:tada:

Handy links:

@TravisEz13 TravisEz13 mentioned this pull request Sep 30, 2022
Merged
22 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@daxian-dbw daxian-dbw daxian-dbw approved these changes

@SteveL-MSFT SteveL-MSFT SteveL-MSFT approved these changes

@iSazonov iSazonov iSazonov approved these changes

Assignees

@TravisEz13 TravisEz13

Labels

Backport-7.2.x-Done CL-Engine Indicates that a PR should be marked as an engine change in the Change Log Extra Small

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@awakecoding @SteveL-MSFT @TravisEz13 @iSazonov @daxian-dbw @mamoreau-devolutions