-
Notifications
You must be signed in to change notification settings - Fork 341
Refactor library lookup #968
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
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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
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,89 @@ | ||
| # | ||
| # Copyright (C) 2008-2010 Wayne Meissner | ||
| # | ||
| # This file is part of ruby-ffi. | ||
| # | ||
| # All rights reserved. | ||
| # | ||
| # Redistribution and use in source and binary forms, with or without | ||
| # modification, are permitted provided that the following conditions are met: | ||
| # | ||
| # * Redistributions of source code must retain the above copyright notice, this | ||
| # list of conditions and the following disclaimer. | ||
| # * Redistributions in binary form must reproduce the above copyright notice | ||
| # this list of conditions and the following disclaimer in the documentation | ||
| # and/or other materials provided with the distribution. | ||
| # * Neither the name of the Ruby FFI project nor the names of its contributors | ||
| # may be used to endorse or promote products derived from this software | ||
| # without specific prior written permission. | ||
| # | ||
| # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | ||
| # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
| # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
| # DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE | ||
| # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | ||
| # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR | ||
| # SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER | ||
| # CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, | ||
| # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
| # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.# | ||
|
|
||
| module FFI | ||
| class DynamicLibrary | ||
| SEARCH_PATH = %w[/usr/lib /usr/local/lib /opt/local/lib] | ||
| if FFI::Platform::ARCH == 'aarch64' && FFI::Platform.mac? | ||
| SEARCH_PATH << '/opt/homebrew/lib' | ||
| end | ||
|
|
||
| SEARCH_PATH_MESSAGE = "Searched in <system library path>, #{SEARCH_PATH.join(', ')}" | ||
|
|
||
| def self.load_library(name, flags) | ||
| if name == FFI::CURRENT_PROCESS | ||
| FFI::DynamicLibrary.open(nil, RTLD_LAZY | RTLD_LOCAL) | ||
| else | ||
| flags ||= RTLD_LAZY | RTLD_LOCAL | ||
|
|
||
| libnames = (name.is_a?(::Array) ? name : [name]) | ||
| libnames = libnames.map(&:to_s).map { |n| [n, FFI.map_library_name(n)].uniq }.flatten.compact | ||
| errors = [] | ||
|
|
||
| libnames.each do |libname| | ||
| lib = try_load(libname, flags, errors) | ||
| return lib if lib | ||
|
|
||
| unless libname.start_with?("/") || FFI::Platform.windows? | ||
| SEARCH_PATH.each do |prefix| | ||
| path = "#{prefix}/#{libname}" | ||
| if File.exist?(path) | ||
| lib = try_load(path, flags, errors) | ||
| return lib if lib | ||
| end | ||
| end | ||
| end | ||
| end | ||
|
|
||
| raise LoadError, [*errors, SEARCH_PATH_MESSAGE].join(".\n") | ||
| end | ||
| end | ||
| private_class_method :load_library | ||
|
|
||
| def self.try_load(libname, flags, errors) | ||
| begin | ||
| lib = FFI::DynamicLibrary.open(libname, flags) | ||
| return lib if lib | ||
|
|
||
| # LoadError for C ext & JRuby, RuntimeError for TruffleRuby | ||
| rescue LoadError, RuntimeError => ex | ||
| if ex.message =~ /(([^ \t()])+\.so([^ \t:()])*):([ \t])*(invalid ELF header|file too short|invalid file format)/ | ||
| if File.binread($1) =~ /(?:GROUP|INPUT) *\( *([^ \)]+)/ | ||
| return try_load($1, flags, errors) | ||
| end | ||
| end | ||
|
|
||
| errors << ex | ||
| nil | ||
| end | ||
| end | ||
| private_class_method :try_load | ||
| end | ||
| end | ||
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
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.
Not sure if this is something you want to handle (and I wouldn't blame you if you don't):
Some Homebrew users install
brewto a path that is neither/usr/localnor/opt/homebrew(e.g. they have nosudoaccess so use their$HOME). For these cases, one approach that works is to check ifbrewis inPATHand then check the output ofbrew --prefix.Uh oh!
There was an error while loading. Please reload this page.
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.
That seems an orthogonal issue to me.
Shelling out to
brew --prefixseems quite expensive (e.g. while loading the ffi gem), maybe there should be a standardHOMEBREW_PREFIXenv var exported by default or so, so we could read it without the cost of a subprocess.Could you file a separate issue if you need that? (or maybe there is already one?)
Uh oh!
There was an error while loading. Please reload this page.
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.
@eregon
brew --prefixis the correct way to detect the homebrew location. or we need a configure flag for prepending an include dir to the initial build of the gem so that people can set their own configurations appropriately./opt/homebrewand/usr/localare standard locations, but not the only options. However, this shouldn't be a blocker to get the standard fix out to the majority. people have been waiting for months and months. this is a serious breakage for rosetta and arm users.Fix the easy standard way for the majority of users first, then we can come up with a way for the people who are in the outliers
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.
Yes I agree this is not a blocker. I think
brew --prefixis too much of a cost onrequire, but maybe it's OK to compute it once lazily onffi_libon macOS.What we need is @larskanis to review this PR and then make a release.
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.
Thinking more about it, it sounds really complicated to support Homebrew not in a default location.
For instance if Homebrew is installed both in amd64 and aarch64, how do we even call the "right"
brewexecutable? It all sounds extremely messy and easy to mess up.Anyway, if someone needs this they can make a PR.