opal-webassembly 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 777a9c8adbfc32598b84812cd1a761e23237fd8c79555f1ae6e7dc251cf7d73c
+  data.tar.gz: d2f49898aeffc50769fc5f3cd6c8b038ec771844d49530f568322ada6a8e56df
+SHA512:
+  metadata.gz: 12db815d8bae8d32335b243d01ff677b47cc49d9dbfc648f0c26b5ad2b99706fc8277dfa5e801d8ee621bc271bfd0353f40867dae89a595675059b02a4866430
+  data.tar.gz: 364cbc01b4a86e4c82cc66af0f808c6b9dce6dce3f023a28bf154a380fa24af090b6cdd901c2f3c64aa5698df510b6081e9eaf2509172fad8ce98a411461b755

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock
+
+/examples/simple_ffi/simple.out.js

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rspec-opal

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+-I ./opal

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,25 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in opal-webassembly.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+
+gem "pry"
+
+if File.directory? __dir__+"/../opal"
+  gem "opal", path: __dir__+"/../opal"
+else
+  gem "opal"
+end
+
+gem "opal-rspec"
+
+if File.directory? __dir__+"/../opal-sprockets"
+  gem "opal-sprockets", path: __dir__+"/../opal-sprockets"
+else
+  gem "opal-sprockets"
+end
+
+gem "mini_racer"

data/LICENSE.adoc

@@ -0,0 +1,31 @@
+= Licenses & Copyright
+
+This license file adheres to the formatting guidelines of
+https://github.com/nevir/readable-licenses[readable-licenses].
+
+
+== Ribose BSD 2-Clause License
+
+Copyright (c) 2019-, https://www.ribose.com[Ribose Inc].
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+1.  Redistributions of source code must retain the above copyright notice,
+    this list of conditions and the following disclaimer.
+
+2.  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.
+
+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.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.adoc

@@ -0,0 +1,45 @@
+= Opal::Webassembly
+
+WebAssembly support for Opal.
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+[source,ruby]
+----
+gem 'opal-webassembly'
+----
+
+And then execute:
+
+[source,sh]
+----
+$ bundle install
+----
+
+Or install it yourself as:
+
+[source,sh]
+----
+$ gem install opal-onigmo
+----
+
+
+== Usage
+
+Please see `examples/simple_ffi` for basic usage.
+
+== Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to https://rubygems.org[rubygems.org].
+
+== Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hmdne/opal-webassembly.
+
+== License
+
+The gem is available as open source under the terms of the BSD 2-clause license.

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require 'opal/rspec/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+Opal::RSpec::RakeTask.new("spec-opal") do |server, task|
+  require 'opal/webassembly'
+  require 'opal/webassembly/processor'
+  Opal.append_path __dir__+"/examples/simple_ffi"
+  Opal.append_path __dir__+"/examples/experiment"
+end
+
+task :default => [:spec, "spec-opal"]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "opal/webassembly"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/opal-repl-wasm

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+load "#{__dir__}/../exe/opal-repl-wasm"

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/experiment/Makefile

@@ -0,0 +1,2 @@
+experiment-wasm.wasm: experiment-wasm.c
+	clang --target=wasm32 -Oz -flto -nostdlib -Wl,--no-entry -Wl,--export-all -Wl,--lto-O3 -Wl,-z,stack-size=8388608 -o $@ $<

data/examples/experiment/experiment-wasm.c

@@ -0,0 +1,74 @@
+void *retpointer(void *ptr) {
+  return ptr;
+}
+
+float retfloat(float f) {
+  return -f*2;
+}
+
+double retdouble(double f) {
+  return -f*2;
+}
+
+char *retstring(char *c) {
+  c[3] += 1;
+  c[5] += 1;
+  return c+2;
+}
+
+int longsize(void)       { return sizeof(long); }
+int longlongsize(void)   { return sizeof(long long); }
+int ptrsize(void)        { return sizeof(void*); }
+int floatsize(void)      { return sizeof(float); }
+int doublesize(void)     { return sizeof(double); }
+int longdoublesize(void) { return sizeof(long double); }
+
+struct test_struct {
+  int a;
+  long long b;
+  char c;
+  int d;
+  char e;
+  void *f;
+  char g;
+  long double h;
+} test_struct;
+
+int structalignll(void) { return (long)&test_struct.b - (long)&test_struct.a; }
+int structaligni(void)  { return (long)&test_struct.d - (long)&test_struct.c; }
+int structalignp(void)  { return (long)&test_struct.f - (long)&test_struct.e; }
+int structalignld(void) { return (long)&test_struct.h - (long)&test_struct.g; }
+
+////// BASIC stdlib below:
+extern unsigned char __heap_base;
+
+unsigned int bump_pointer = (unsigned int)&__heap_base;
+
+//// Adapted from: https://github.com/WebAssembly/wasi-libc / musl
+void *memcpy(void *restrict dest, const void *restrict src, unsigned long n)
+{
+	unsigned char *d = dest;
+	const unsigned char *s = src;
+	for (; n; n--) *d++ = *s++;
+	return dest;
+}
+
+// IT LEAKS BY DESIGN; adapted from: https://surma.dev/things/c-to-webassembly/
+void* malloc(unsigned long n) {
+  unsigned int r = bump_pointer;
+  bump_pointer += 4 + ((n|3)+1);
+  unsigned long *ptr = (unsigned long *)r;
+  *ptr = n;
+  return (void *)(ptr + 1);
+}
+
+void free(void* p) {
+  // lol
+}
+
+void *realloc(void *ptr, unsigned long size) {
+  unsigned int cursize = *(int *)(ptr - 4);
+  void *newptr = malloc(size);
+  memcpy(newptr, ptr, cursize);
+  return newptr;
+}

data/examples/experiment/experiment.rb

@@ -0,0 +1,25 @@
+require 'experiment-wasm'
+require 'ffi'
+
+module Experiment
+  extend FFI::Library
+
+  ffi_lib "experiment-wasm"
+
+  attach_function :retpointer, [:pointer], :pointer
+  attach_function :retfloat, [:float], :float
+  attach_function :retdouble, [:double], :double
+  attach_function :retstring, [:string], :string
+
+  attach_function :longsize, [], :int
+  attach_function :longlongsize, [], :int
+  attach_function :ptrsize, [], :int
+  attach_function :floatsize, [], :int
+  attach_function :doublesize, [], :int
+  attach_function :longdoublesize, [], :int
+
+  attach_function :structalignld, [], :int
+  attach_function :structalignll, [], :int
+  attach_function :structaligni, [], :int
+  attach_function :structalignp, [], :int
+end

data/examples/experiment/experiment.sh

@@ -0,0 +1,2 @@
+#!/bin/sh
+../../bin/opal-repl-wasm experiment.rb

data/examples/onigmo/onigmo.rb

@@ -0,0 +1,4 @@
+require "opal"
+require "onigmo-wasm"
+
+Onigmo = WebAssembly["onigmo-wasm"]

data/examples/onigmo/onigmo.sh

@@ -0,0 +1,2 @@
+#!/bin/sh
+../../bin/opal-repl-wasm onigmo.rb

data/examples/simple_ffi/Rakefile

@@ -0,0 +1,14 @@
+$LOAD_PATH << __dir__+"/../../lib"
+
+file "simple.out.js" => ["simple.rb"] do
+  require 'opal/builder'
+  require 'opal/webassembly'
+  require 'opal/webassembly/processor'
+
+  builder = Opal::Builder.new
+  builder.append_paths(__dir__)
+  out = builder.build("simple")
+  File.write("simple.out.js", out)
+end
+
+task :default => "simple.out.js"

data/examples/simple_ffi/simple-wasm.wat

@@ -0,0 +1,8 @@
+(module
+  (func $exported_func (result i32)
+    i32.const 42
+    return
+  )
+
+  (export "exported_func" (func $exported_func))
+)

data/examples/simple_ffi/simple.rb

@@ -0,0 +1,14 @@
+require 'opal'
+require 'simple-wasm'
+
+puts WebAssembly.libs["simple-wasm"].exported_func
+
+require 'ffi'
+module Simple
+  extend FFI::Library
+
+  ffi_lib "simple-wasm"
+  attach_function :func, :exported_func, []
+end
+
+puts Simple.func

data/exe/opal-repl-wasm

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'opal/repl'
+require 'opal/webassembly'
+require 'opal/webassembly/processor'
+
+Opal.append_paths '.'
+
+repl = Opal::REPL.new.run ARGV.first

data/lib/opal/webassembly.rb

@@ -0,0 +1,9 @@
+require "opal/webassembly/version"
+require "opal"
+
+Opal.append_path File.expand_path('../../../opal', __FILE__)
+
+module Opal
+  module WebAssembly
+  end
+end

data/lib/opal/webassembly/processor.rb

@@ -0,0 +1,49 @@
+require 'base64'
+require 'opal/builder_processors'
+
+module Opal
+  module BuilderProcessors
+    class WASMProcessor < Processor
+      handles :wasm
+
+      # Override the initialization, because we really don't want a new line mangling
+      def initialize(source, filename, options = {})
+        #source += "\n" unless source.end_with?("\n")
+        @source, @filename, @options = source, filename, options
+        @requires = []
+        @required_trees = []
+      end
+
+      def source
+        module_name = ::Opal::Compiler.module_name(@filename)
+        source = Base64.strict_encode64(@source.to_s)
+        <<~END
+          Opal.modules[#{module_name.inspect}] = function() {
+            // WebAssembly module
+            var self = Opal.top;
+            self.$require("webassembly");
+            Opal.WebAssembly.$load_from_base64('#{source}', #{module_name.inspect});
+          };
+        END
+      end
+
+      # No source map support. Required to be mocked for tests.
+      def source_map
+        o = Object.new
+        def o.generated_code; ""; end
+        def o.to_h; {version: 3, sections: nil, sources: [], mappings: []}; end
+        o
+      end
+
+      def requires
+        ['webassembly'] + super
+      end
+    end
+  end
+end
+
+module Opal
+  module WebAssembly
+    Processor = ::Opal::BuilderProcessors::WASMProcessor
+  end
+end