Failed to install ruby 3.1.0 on M1

[ihomway]

Tried to install ruby 3.1.0 via rbenv, but it returns failed.

It said ld: library not found for -lcapstone, but I can find the capstone library, which was installed via Homebrew.

Output

$ rbenv install 3.1.0

Downloading openssl-1.1.1l.tar.gz...
-> https://www.openssl.org/source/openssl-1.1.1l.tar.gz
Installing openssl-1.1.1l...
Installed openssl-1.1.1l to /Users/puer/.rbenv/versions/3.1.0

Downloading ruby-3.1.0.tar.gz...
-> https://cache.ruby-lang.org/pub/ruby/3.1/ruby-3.1.0.tar.gz
Installing ruby-3.1.0...
ruby-build: using readline from homebrew

BUILD FAILED (macOS 12.2 using ruby-build 20220125)

Inspect or clean up the working tree at /var/folders/p7/bg9zlhk97dd0kydc9ss7w_9h0000gn/T/ruby-build.20220208143322.15659.B7yYav
Results logged to /var/folders/p7/bg9zlhk97dd0kydc9ss7w_9h0000gn/T/ruby-build.20220208143322.15659.log

Last 10 log lines:
linking shared-library libruby.3.1.dylib
ld: library not found for -lcapstone
clang: error: linker command failed with exit code 1 (use -v to see invocation)
make: *** [libruby.3.1.dylib] Error 1
make: *** Waiting for unfinished jobs....
transdb.h updated
transform_mjit_header: making external definition static inline: rb_vm_lvar_exposed, Init_vm_stack_canary, rb_vm_opt_cfunc_p, rb_vm_opt_mod, rb_vm_ic_hit_p, rb_vm_splat_array, rb_vm_defined, rb_vm_cc_general, rb_aliased_callable_method_entry, rb_find_defined_class_by_owner, rb_vm_call_ivar_attrset_p, rb_iseq_only_kwparam_p, rb_iseq_only_optparam_p, rb_vm_set_ivar_idx, rb_vm_setinstancevariable, rb_vm_setclassvariable, rb_vm_getclassvariable, rb_vm_rewrite_cref, rb_vm_get_cref, rb_vm_block_ep_update, rb_vm_cref_new_toplevel, rb_vm_cref_dup_without_refinements, rb_vm_frame_block_handler, rb_vm_cframe_keyword_p, rb_vm_ep_local_ep
transform_mjit_header: making declaration static inline: rb_vm_lvar_exposed, rb_vm_lvar_exposed, Init_vm_stack_canary, rb_vm_rewrite_cref, rb_vm_frame_block_handler, rb_vm_block_ep_update, rb_vm_ep_local_ep
transform_mjit_header: SKIPPED to transform: __sigbits, isspecial, isrune, isphonogram, isnumber, isideogram, ishexnumber, digittoint, toupper, tolower, toascii, isxdigit, isupper, isspace, ispunct, isprint, islower, isgraph, isdigit, iscntrl, isblank, isalpha, isalnum, __wcwidth, __isctype, __istype, isascii, __sincospi, __sincospif, __sincos, __sincosf, __inline_isnormall, __inline_isnormald, __inline_isnormalf, __inline_signbitl, __inline_signbitd, __inline_signbitf, __inline_isnanl, __inline_isnand, __inline_isnanf, __inline_isinfl, __inline_isinfd, __inline_isinff, __inline_isfinitel, __inline_isfinited, __inline_isfinitef, __darwin_fd_clr, __darwin_fd_set, __darwin_fd_isset, __darwin_check_fd_set, __sputc
ln -sf ../../../.ext/include/arm64-darwin21/rb_mjit_min_header-3.1.0.h include/ruby-3.1.0/arm64-darwin21/rb_mjit_min_header-3.1.0.h

Environment

rbenv was installed via Homebrew

$ rbenv --version

rbenv 1.2.0

$ uname -a

Darwin xxx 21.3.0 Darwin Kernel Version 21.3.0: Wed Jan  5 21:37:58 PST 2022; root:xnu-8019.80.24~20/RELEASE_ARM64_T8101 arm64

$ curl -fsSL https://github.com/rbenv/rbenv-installer/raw/main/bin/rbenv-doctor | bash

Checking for `rbenv' in PATH: /opt/homebrew/bin/rbenv
Checking for rbenv shims in PATH: OK
Checking `rbenv install` support: /opt/homebrew/bin/rbenv-install (ruby-build 20220125)
Counting installed Ruby versions: none
  There aren't any Ruby versions installed under '/Users/puer/.rbenv/versions'.
  You can install Ruby versions like so: rbenv install 3.1.0
Checking RubyGems settings: OK
Auditing installed plugins: OK

[ihomway]

I have solved this issue by export capstone library (I'm using Fish shell).

$ set -gx LDFLAGS "-L/opt/homebrew/opt/capstone/lib"
$ set -gx CPPFLAGS "-I/opt/homebrew/opt/capstone/include"
$ rbenv install 3.1.0

Downloading openssl-1.1.1l.tar.gz...
-> https://www.openssl.org/source/openssl-1.1.1l.tar.gz
Installing openssl-1.1.1l...
Installed openssl-1.1.1l to /Users/puer/.rbenv/versions/3.1.0

Downloading ruby-3.1.0.tar.gz...
-> https://cache.ruby-lang.org/pub/ruby/3.1/ruby-3.1.0.tar.gz
Installing ruby-3.1.0...
ruby-build: using readline from homebrew
Installed ruby-3.1.0 to /Users/puer/.rbenv/versions/3.1.0

But I don't if this is the best solution.

[sungpeo]

Thanks. I use below environment variables. (I'm using Zsh)

export LDFLAGS="-L/opt/homebrew/opt/capstone/lib"
export CPPFLAGS="-I/opt/homebrew/opt/capstone/include"

[maximecb]

Normally capstone is optional. We use it in YJIT but only when cppflags="-DRUBY_DEBUG" is specified. Are you building in debug mode?

@XrXr

[jez]

I have the same problem as @ihomway, and I'm not passing any special flags to rbenv install or in my environment. If you're curious, I've attached a build log file. Here's the configuration summary from the log file:

Configuration summary for ruby version 3.1.0

   * Installation prefix: /home/jez/.rbenv/versions/3.1.0
   * exec prefix:         ${prefix}
   * arch:                x86_64-linux
   * site arch:           ${arch}
   * RUBY_BASE_NAME:      ruby
   * enable shared:       yes
   * ruby lib prefix:     ${libdir}/${RUBY_BASE_NAME}
   * site libraries path: ${rubylibprefix}/${sitearch}
   * vendor path:         ${rubylibprefix}/vendor_ruby
   * target OS:           linux
   * compiler:            gcc
   * with pthread:        yes
   * with coroutine:      amd64
   * enable shared libs:  yes
   * dynamic library ext: so
   * CFLAGS:              ${optflags} ${debugflags} ${warnflags}
   * LDFLAGS:             -L. -L/home/jez/.rbenv/versions/3.1.0/lib  \
                          -fstack-protector-strong \
                          -L/home/linuxbrew/.linuxbrew/Cellar/capstone/4.0.2\
                          /lib -rdynamic -Wl,-export-dynamic \
                          -Wl,--no-as-needed
   * DLDFLAGS:            -L/home/jez/.rbenv/versions/3.1.0/lib  \
                          -Wl,--compress-debug-sections=zlib
   * optflags:            -O3 -fno-fast-math
   * debugflags:          -ggdb3
   * warnflags:           -Wall -Wextra -Wdeprecated-declarations \
                          -Wduplicated-cond -Wimplicit-function-declaration \
                          -Wimplicit-int -Wmisleading-indentation \
                          -Wpointer-arith -Wwrite-strings \
                          -Wimplicit-fallthrough=0 -Wmissing-noreturn \
                          -Wno-cast-function-type \
                          -Wno-constant-logical-operand -Wno-long-long \
                          -Wno-missing-field-initializers \
                          -Wno-overlength-strings \
                          -Wno-packed-bitfield-compat \
                          -Wno-parentheses-equality -Wno-self-assign \
                          -Wno-tautological-compare -Wno-unused-parameter \
                          -Wno-unused-value -Wsuggest-attribute=format \
                          -Wsuggest-attribute=noreturn -Wunused-variable \
                          -Wundef
   * strip command:       strip -S -x
   * install doc:         rdoc
   * JIT support:         yes
   * man page type:       doc
   * BASERUBY -v:         ruby 2.7.2p137 (2020-10-01 revision 5445e04352) \
                          [x86_64-linux]

ruby-build.20220324132034.301370.log

[jez]

I was able to work around the problem by uninstalling capstone on my system:

❯ brew uninstall capstone
Error: Refusing to uninstall /home/linuxbrew/.linuxbrew/Cellar/capstone/4.0.2
because it is required by bloaty, which is currently installed.
You can override this and force removal with:
  brew uninstall --ignore-dependencies capstone

❯ brew uninstall bloaty
Uninstalling /home/linuxbrew/.linuxbrew/Cellar/bloaty/1.1_6... (8 files, 752.8KB)

❯ brew uninstall capstone
Uninstalling /home/linuxbrew/.linuxbrew/Cellar/capstone/4.0.2... (25 files, 19.1MB)

When I did that, it looks like the ./configure script failed to detect capstone installed on my system, and decided to not compile it. The configuration summary for me changed to this:

Configuration summary for ruby version 3.1.0

   * Installation prefix: /home/jez/.rbenv/versions/3.1.0
   * exec prefix:         ${prefix}
   * arch:                x86_64-linux
   * site arch:           ${arch}
   * RUBY_BASE_NAME:      ruby
   * enable shared:       yes
   * ruby lib prefix:     ${libdir}/${RUBY_BASE_NAME}
   * site libraries path: ${rubylibprefix}/${sitearch}
   * vendor path:         ${rubylibprefix}/vendor_ruby
   * target OS:           linux
   * compiler:            gcc
   * with pthread:        yes
   * with coroutine:      amd64
   * enable shared libs:  yes
   * dynamic library ext: so
   * CFLAGS:              ${optflags} ${debugflags} ${warnflags}
   * LDFLAGS:             -L. -L/home/jez/.rbenv/versions/3.1.0/lib  \
                          -fstack-protector-strong -rdynamic \
                          -Wl,-export-dynamic -Wl,--no-as-needed
   * DLDFLAGS:            -L/home/jez/.rbenv/versions/3.1.0/lib  \
                          -Wl,--compress-debug-sections=zlib
   * optflags:            -O3 -fno-fast-math
   * debugflags:          -ggdb3
   * warnflags:           -Wall -Wextra -Wdeprecated-declarations \
                          -Wduplicated-cond -Wimplicit-function-declaration \
                          -Wimplicit-int -Wmisleading-indentation \
                          -Wpointer-arith -Wwrite-strings \
                          -Wimplicit-fallthrough=0 -Wmissing-noreturn \
                          -Wno-cast-function-type \
                          -Wno-constant-logical-operand -Wno-long-long \
                          -Wno-missing-field-initializers \
                          -Wno-overlength-strings \
                          -Wno-packed-bitfield-compat \
                          -Wno-parentheses-equality -Wno-self-assign \
                          -Wno-tautological-compare -Wno-unused-parameter \
                          -Wno-unused-value -Wsuggest-attribute=format \
                          -Wsuggest-attribute=noreturn -Wunused-variable \
                          -Wundef
   * strip command:       strip -S -x
   * install doc:         rdoc
   * JIT support:         yes
   * man page type:       doc
   * BASERUBY -v:         ruby 2.7.2p137 (2020-10-01 revision 5445e04352) \
                          [x86_64-linux]

I don't know why the configure script was able to find capstone on my system, but gcc was not able to find it when building Ruby file-by-file.

In any case, uninstalling capstone (by also uninstalling bloaty) and then building Ruby allowed me to build Ruby 3.1.0, and I was able to reinstall bloaty afterwards.

Here is the build log from the successful build:
ruby-build.20220324141410.312020.log

[maximecb]

Just to update everybody, we're in the process of porting YJIT to Rust and hoping to upstream that next month. This should fix the capstone issue as the library will only be used when building in dev mode.

[patlux]

I had to remove my ~/.gem folder to make LDFLAGS="-L/opt/homebrew/opt/capstone/lib" CPPFLAGS="-I/opt/homebrew/opt/capstone/include" rtx install to work.

Otherwise I still got:

BUILD FAILED (macOS 13.4 using ruby-build 20230608)

Inspect or clean up the working tree at /var/folders/b3/qq1v4qhj0h94_d12flgnqx840000gn/T/ruby-build.20230613102601.32831.rtxo43
Results logged to /var/folders/b3/qq1v4qhj0h94_d12flgnqx840000gn/T/ruby-build.20230613102601.32831.log

Last 10 log lines:
Configure options used:
  --prefix=/Users/patwoz/.local/share/rtx/installs/ruby/3.1.1
  --with-openssl-dir=/Users/patwoz/.local/share/rtx/installs/ruby/3.1.1/openssl
  --enable-shared
  --with-readline-dir=/opt/homebrew/opt/readline
  --with-libyaml-dir=/opt/homebrew/opt/libyaml
  --with-gmp-dir=/opt/homebrew/opt/gmp
  CC=clang
  LDFLAGS=-L/Users/patwoz/.local/share/rtx/installs/ruby/3.1.1/lib -L/opt/homebrew/opt/capstone/lib
  CPPFLAGS=-I/Users/patwoz/.local/share/rtx/installs/ruby/3.1.1/include -I/opt/homebrew/opt/capstone/include
rtx [email protected] ruby-build: using gmp from homebrew                                                                                                     ✗ 2m rtx ~/.local/share/rtx/plugins/ruby/bin/install exited with non-zero status: exit code 1
rtx Run with RTX_DEBUG=1 for more information

and in the mentioned .log-file:

Building native extensions. This could take a while...
installing bundled gem cache:       /Users/patwoz/.local/share/rtx/installs/ruby/3.1.1/lib/ruby/gems/3.1.0/cache
The Ruby openssl extension was not compiled.
The Ruby readline extension was not compiled.
The Ruby zlib extension was not compiled.
/Users/patwoz/.gem/ruby/3.1.0/gems/yaml-0.2.1/lib/yaml.rb:3: warning: It seems your ruby installation is missing psych (for YAML output).
To eliminate this warning, please install libyaml and reinstall your ruby.
The Ruby yaml extension was not compiled.
ERROR: Ruby install aborted due to missing extensions
Configure options used:
  --prefix=/Users/patwoz/.local/share/rtx/installs/ruby/3.1.1
  --with-openssl-dir=/Users/patwoz/.local/share/rtx/installs/ruby/3.1.1/openssl
  --enable-shared
  --with-readline-dir=/opt/homebrew/opt/readline
  --with-libyaml-dir=/opt/homebrew/opt/libyaml
  --with-gmp-dir=/opt/homebrew/opt/gmp
  CC=clang
  LDFLAGS=-L/Users/patwoz/.local/share/rtx/installs/ruby/3.1.1/lib -L/opt/homebrew/opt/capstone/lib
  CPPFLAGS=-I/Users/patwoz/.local/share/rtx/installs/ruby/3.1.1/include -I/opt/homebrew/opt/capstone/include

[carltonbrown]

My complete working solution below for asdf on Sonoma 14.1.2. Similar to others, but for some reason it was also complaining about not being able to find capstone.

install_jemalloc.sh

export HOMEBREW_PREFIX=$(brew --prefix)
export LDFLAGS="-L${HOMEBREW_PREFIX}/opt/jemalloc/lib -L/opt/homebrew/opt/capstone/lib"
export CPPFLAGS="-I${HOMEBREW_PREFIX}/opt/jemalloc/include -I/opt/homebrew/opt/capstone/include"
export RUBY_CONFIGURE_OPTS="--with-jemalloc=$(brew --prefix jemalloc)"
asdf install ruby 3.1.2 && ruby -r rbconfig -e "puts RbConfig::CONFIG['MAINLIBS']"

output:

bash install_jemalloc.sh
<details>
Installed ruby-3.1.2 to /Users/me/.asdf/installs/ruby/3.1.2
-lpthread -ljemalloc -lcapstone -ldl -lobjc

and

MALLOC_CONF=stats_print:true ruby -e "exit"
___ Begin jemalloc statistics ___
Version: "5.3.0-0-g54eaed1d8b56b1aa528be3bdd1877e59c56fa90c"
<details>
Bytes in small extent cache: 0
HPA shard stats:
  Purge passes: 0 (0 / sec)
  Purges: 0 (0 / sec)
  Hugeifies: 0 (0 / sec)
  Dehugifies: 0 (0 / sec)

  In full slabs:
      npageslabs: 0 huge, 0 nonhuge
      nactive: 0 huge, 0 nonhuge 
      ndirty: 0 huge, 0 nonhuge 
      nretained: 0 huge, 0 nonhuge 
  In empty slabs:
      npageslabs: 0 huge, 0 nonhuge
      nactive: 0 huge, 0 nonhuge 
      ndirty: 0 huge, 0 nonhuge 
      nretained: 0 huge, 0 nonhuge 

                size ind npageslabs_huge    nactive_huge     ndirty_huge  npageslabs_nonhuge     nactive_nonhuge      ndirty_nonhuge   nretained_nonhuge
                     ---
--- End jemalloc statistics ---

[jaydorsey]

I think there might still be something missing with this, but I'm not sure how to triage/debug it and I've resolved the issue for me locally by removing capstone gem before installing ruby.

I tried this on 2 systems, both M3 Max chipsets:

1. One was another engineer who had never installed ruby before, so doesn't have a bunch of crazy configs or anything
2. The other was my system, and I have a bunch of crazy configs (manually specified ld flags, RUBY_YJIT_ENABLED=1, etc.)

It failed for both of us but we fixed it:

1. We both had capstone installed via homebrew, because we had qemu installed, because it's a dependency of colima I believe
2. We both ran into the same/similar issue as reported above where it errors on capstone
3. We both resolved the issue by running brew uninstall capstone and re-building

This was with Ruby 3.1.2, I haven't tried other versions but happy to do additional testing if needed

On my machine, with all my configs, I had installed the same version of ruby a number of times, months ago, before I had colima (and capstone) installed, so I don't think it's directly related to my config.

I didn't try setting the LDFLAG for capstone, but I expect that could actually maybe fix it. I noted in another thread here that I saw similar-ish anomalous behavior with jemalloc where it only works if you set the LDFLAGS, even though the output of the command seems to indicate that jemalloc/capstone are both recognized as being installed by homebrew

Since that issue I've been adding LDFLAGS for every homebrew dependency that suggests to add them in their output/info (which seems overkill tbh)