wasm/README.md: Add a note about the Ruby built for wasm. [ci skip] #6707

junaruga · 2022-11-10T12:55:27Z

Hello,
I would like to update the current document about wasm, WebAssembly. Because I needed extra info to explain to other people that "the WASI feature only works with the WebAssembly runtime, but can't be used like normal Ruby without the WebAssembly runtime" .

The modified README.md is here.

The Ruby built for wasm cannot be executed without a WebAssembly runtime.

$ ruby-wasm32-wasi/usr/local/bin/ruby -e 'puts "a"'
bash: ruby-wasm32-wasi/usr/local/bin/ruby: cannot execute binary file: Exec format error

Because the Ruby's file type is different from the one built normally, that is the /usr/local/ruby-3.2.0-preview2/bin/ruby below.

$ file ruby-wasm32-wasi/usr/local/bin/ruby
ruby-wasm32-wasi/usr/local/bin/ruby: WebAssembly (wasm) binary module version 0x1 (MVP)

$ file /usr/local/ruby-3.2.0-preview2/bin/ruby
/usr/local/ruby-3.2.0-preview2/bin/ruby: ELF 64-bit LSB executable, x86-64, version 1 (SYSV), dynamically linked, interpreter /lib64/ld-linux-x86-64.so.2, BuildID[sha1]=a37822085e285c0971159982e7642dda88cea606, for GNU/Linux 3.2.0, with debug_info, not stripped

Though perhaps this might be for another PR, I think another possible improvement is the following part in the current document - Steps. I have no idea what the --with-ext=ripper,monitor is dong.

$ ./configure LDFLAGS="-Xlinker -zstack-size=16777216" \
  --host wasm32-unknown-wasi \
  --with-destdir=./ruby-wasm32-wasi \
  --with-static-linked-ext \
  --with-ext=ripper,monitor

I did see the explanation.

$ ./configure --help
...
  --with-ext=EXTS         pass to --with-ext option of extmk.rb
...

I think adding one more configure script example as a typically used command example with the minimal configure options in the document is helpful for users. This could be like this?

$ ./configure LDFLAGS="-Xlinker -zstack-size=16777216" \
  --prefix=/path/to/ruby-wasi \
  --host wasm32-unknown-wasi \
  --with-static-linked-ext \

I just checked the current CI for wasm, and the --with-ext is not used.

ruby/.github/workflows/wasm.yml

Lines 88 to 97 in b7e8876

    
                     ../src/configure \ 
        
                       --host wasm32-unknown-wasi \ 
        
                       --with-static-linked-ext \ 
        
                       LDFLAGS=" \ 
        
                         -Xlinker --stack-first \ 
        
                         -Xlinker -z -Xlinker stack-size=16777216 \ 
        
                       " \ 
        
                       optflags="${{ matrix.entry.optflags }}" \ 
        
                       debugflags="${{ matrix.entry.debugflags }}" \ 
        
                       wasmoptflags="${{ matrix.entry.wasmoptflags }} ${{ matrix.entry.debugflags }}"

So, what do you think?

The Ruby built for wasm cannot be execute without a WebAssembly runtime. ``` $ ruby-wasm32-wasi/usr/local/bin/ruby -e 'puts "a"' bash: ruby-wasm32-wasi/usr/local/bin/ruby: cannot execute binary file: Exec format error ``` Because the Ruby's file type is different from the one built normally, that is the `/usr/local/ruby-3.2.0-preview2/bin/ruby` below. ``` $ file ruby-wasm32-wasi/usr/local/bin/ruby ruby-wasm32-wasi/usr/local/bin/ruby: WebAssembly (wasm) binary module version 0x1 (MVP) $ file /usr/local/ruby-3.2.0-preview2/bin/ruby /usr/local/ruby-3.2.0-preview2/bin/ruby: ELF 64-bit LSB executable, x86-64, version 1 (SYSV), dynamically linked, interpreter /lib64/ld-linux-x86-64.so.2, BuildID[sha1]=a37822085e285c0971159982e7642dda88cea606, for GNU/Linux 3.2.0, with debug_info, not stripped ```

kateinoigakukun · 2022-11-10T22:54:43Z

Though perhaps this might be for another PR, I think another possible improvement is the following part in the current document - Steps. I have no idea what the --with-ext=ripper,monitor is dong.

I intentionally selected them to make require "rubygems" succeed at the prelude. Without them, users have to pass --disable-gems. But I think it makes sense to select unavailable exts by --with-out-ext=. As far as I've checked, only pty fails at make-time, so --with-out-ext=pty would be enough as a minimal configuration.

I just checked the current CI for wasm, and the --with-ext is not used.

That's because the current CI only builds miniruby.

junaruga · 2022-11-23T11:54:36Z

Thank you for clarifying your intent!

junaruga requested a review from kateinoigakukun November 10, 2022 13:00

kateinoigakukun merged commit 4c55409 into ruby:master Nov 10, 2022

junaruga deleted the wip/wasm-doc branch November 23, 2022 11:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

wasm/README.md: Add a note about the Ruby built for wasm. [ci skip] #6707

wasm/README.md: Add a note about the Ruby built for wasm. [ci skip] #6707

junaruga commented Nov 10, 2022 •

edited

Loading

kateinoigakukun commented Nov 10, 2022 •

edited

Loading

junaruga commented Nov 23, 2022

	../src/configure \
	--host wasm32-unknown-wasi \
	--with-static-linked-ext \
	LDFLAGS=" \
	-Xlinker --stack-first \
	-Xlinker -z -Xlinker stack-size=16777216 \
	" \
	optflags="${{ matrix.entry.optflags }}" \
	debugflags="${{ matrix.entry.debugflags }}" \
	wasmoptflags="${{ matrix.entry.wasmoptflags }} ${{ matrix.entry.debugflags }}"

wasm/README.md: Add a note about the Ruby built for wasm. [ci skip] #6707

wasm/README.md: Add a note about the Ruby built for wasm. [ci skip] #6707

Conversation

junaruga commented Nov 10, 2022 • edited Loading

kateinoigakukun commented Nov 10, 2022 • edited Loading

junaruga commented Nov 23, 2022

junaruga commented Nov 10, 2022 •

edited

Loading

kateinoigakukun commented Nov 10, 2022 •

edited

Loading