Allow out-of-source build (#43)

* move deps intermediate build directories to build/{triplet}

* reduce use of base_dir

* find extinit.c.erb by relative reference from the current file

* remove unnecessary CrossRubyExtProduct.new

* inject ext source directory from outside

* reduce use of base_dir

* reduce use of base_dir

* remove use of install_dir

* parameterize build_dir and rubies_dir

* install baseruby inside its product build dir

Author: kateinoigakukun

Rakefile

@@ -43,13 +43,16 @@ BUILDS = [
   { src: "head", target: "wasm32-unknown-emscripten", profile: "full" },
 ]
 
+LIB_ROOT = File.dirname(__FILE__)
+
 namespace :build do
   BUILDS.each do |params|
     name = "#{params[:src]}-#{params[:target]}-#{params[:profile]}"
     source = BUILD_SOURCES[params[:src]].merge(name: params[:src])
     toolchain = RubyWasm::Toolchain.get params[:target]
     user_exts = BUILD_PROFILES[params[:profile]][:user_exts].map do |ext|
-      RubyWasm::CrossRubyExtProduct.new(ext, toolchain)
+      srcdir = File.join(LIB_ROOT, "ext", ext)
+      RubyWasm::CrossRubyExtProduct.new(srcdir, toolchain)
     end
     options = params
         .merge(BUILD_PROFILES[params[:profile]])

lib/ruby_wasm/build_system/product/baseruby.rb

@@ -3,45 +3,41 @@
 
 module RubyWasm
   class BaseRubyProduct < BuildProduct
-    attr_reader :base_dir, :source, :install_task
+    attr_reader :source, :install_task
 
-    def initialize(channel, base_dir, source)
-      @channel = channel
-      @base_dir = base_dir
+    def initialize(build_dir, source)
+      @build_dir = build_dir
       @source = source
+      @channel = source.name
+    end
+
+    def product_build_dir
+      File.join(@build_dir, RbConfig::CONFIG["host"], "baseruby-#{@channel}")
     end
 
     def install_dir
-      File.join(
-        base_dir,
-        "/build/deps/#{RbConfig::CONFIG["host"]}/opt/baseruby-#{@channel}"
-      )
+      File.join(product_build_dir, "opt")
     end
 
     def name
       "baseruby-#{@channel}"
     end
 
     def define_task
-      baseruby_build_dir =
-        File.join(
-          base_dir,
-          "/build/deps/#{RbConfig::CONFIG["host"]}/baseruby-#{@channel}"
-        )
 
-      directory baseruby_build_dir
+      directory product_build_dir
 
       desc "build baseruby #{@channel}"
       @install_task =
         task name => [
                source.src_dir,
                source.configure_file,
-               baseruby_build_dir
+               product_build_dir
              ] do
           next if Dir.exist?(install_dir)
           sh "#{source.configure_file} --prefix=#{install_dir} --disable-install-doc",
-             chdir: baseruby_build_dir
-          sh "make install", chdir: baseruby_build_dir
+             chdir: product_build_dir
+          sh "make install", chdir: product_build_dir
         end
     end
   end

lib/ruby_wasm/build_system/product/crossruby.rb

@@ -3,24 +3,24 @@
 
 module RubyWasm
   class CrossRubyExtProduct < BuildProduct
-    attr_reader :name, :toolchain
-    def initialize(name, toolchain)
-      @name, @toolchain = name, toolchain
+    attr_reader :name, :srcdir
+    def initialize(srcdir, toolchain, name: nil)
+      @srcdir, @toolchain = srcdir, toolchain
+      @name = name || File.basename(srcdir)
     end
 
     def define_task(crossruby)
       task "#{crossruby.name}-ext-#{@name}" => [crossruby.configure] do
         make_args = []
-        make_args << "CC=#{toolchain.cc}"
-        make_args << "RANLIB=#{toolchain.ranlib}"
-        make_args << "LD=#{toolchain.ld}"
-        make_args << "AR=#{toolchain.ar}"
+        make_args << "CC=#{@toolchain.cc}"
+        make_args << "LD=#{@toolchain.ld}"
+        make_args << "AR=#{@toolchain.ar}"
+        make_args << "RANLIB=#{@toolchain.ranlib}"
 
         lib = @name
         source = crossruby.source
         objdir = "#{crossruby.ext_build_dir}/#{lib}"
         FileUtils.mkdir_p objdir
-        srcdir = "#{crossruby.base_dir}/ext/#{lib}"
         extconf_args = [
           "--disable=gems",
           # HACK: top_srcdir is required to find ruby headers
@@ -36,9 +36,9 @@ def define_task(crossruby)
           # and we want to insert some hacks before it. But -e and $0 cannot be
           # used together, so we rewrite $0 in -e.
           "-e",
-          %Q('$0="#{srcdir}/extconf.rb"'),
+          %Q('$0="#{@srcdir}/extconf.rb"'),
           "-e",
-          %Q('require_relative "#{srcdir}/extconf.rb"'),
+          %Q('require_relative "#{@srcdir}/extconf.rb"'),
           "-I#{crossruby.build_dir}"
         ]
         sh "#{crossruby.baseruby_path} #{extconf_args.join(" ")}", chdir: objdir
@@ -56,11 +56,12 @@ def define_task(crossruby)
   end
 
   class CrossRubyProduct < BuildProduct
-    attr_reader :base_dir, :source, :toolchain, :build, :configure
+    attr_reader :source, :toolchain, :build, :configure
 
-    def initialize(params, base_dir, baseruby, source, toolchain)
+    def initialize(params, build_dir, rubies_dir, baseruby, source, toolchain)
       @params = params
-      @base_dir = base_dir
+      @rubies_dir = rubies_dir
+      @build_dir = build_dir
       @baseruby = baseruby
       @source = source
       @toolchain = toolchain
@@ -89,14 +90,14 @@ def define_task
       user_ext_products = @params.user_exts
       user_ext_tasks = user_ext_products.map { |prod| prod.define_task(self) }
       user_ext_names = user_ext_products.map(&:name)
-      user_exts =
-        task "#{name}-libs" => [@configure] + user_ext_tasks do
+      extinit_task =
+        task extinit_obj => [@configure, extinit_c_erb] + user_ext_tasks do
           mkdir_p File.dirname(extinit_obj)
-          sh %Q(ruby #{base_dir}/ext/extinit.c.erb #{user_ext_names.join(" ")} | #{toolchain.cc} -c -x c - -o #{extinit_obj})
+          sh %Q(ruby #{extinit_c_erb} #{user_ext_names.join(" ")} | #{toolchain.cc} -c -x c - -o #{extinit_obj})
         end
 
       install =
-        task "#{name}-install" => [@configure, user_exts, dest_dir] do
+        task "#{name}-install" => [@configure, extinit_task, dest_dir] do
           next if File.exist?("#{dest_dir}-install")
           sh "make install DESTDIR=#{dest_dir}-install", chdir: build_dir
         end
@@ -110,10 +111,11 @@ def define_task
         ruby_api_version =
           `#{baseruby_path} -e 'print RbConfig::CONFIG["ruby_version"]'`
         # TODO: move copying logic to ext product
-        user_ext_names.each do |lib|
-          next unless File.exist?("ext/#{lib}/lib")
+        user_ext_products.each do |ext|
+          ext_lib = File.join(ext.srcdir, "lib")
+          next unless File.exist?(ext_lib)
           cp_r(
-            File.join(base_dir, "ext/#{lib}/lib/."),
+            File.join(ext_lib, "."),
             File.join(dest_dir, "usr/local/lib/ruby/#{ruby_api_version}")
           )
         end
@@ -126,11 +128,11 @@ def name
     end
 
     def build_dir
-      "#{@base_dir}/build/build/#{name}"
+      File.join(@build_dir, @params.target, name)
     end
 
     def ext_build_dir
-      "#{@base_dir}/build/ext-build/#{name}"
+      File.join(@build_dir, @params.target, name + "-ext")
     end
 
     def with_libyaml(libyaml)
@@ -144,13 +146,18 @@ def with_zlib(zlib)
     end
 
     def dest_dir
-      "#{@base_dir}/rubies/#{name}"
+      File.join(@rubies_dir, name)
     end
 
     def extinit_obj
       "#{ext_build_dir}/extinit.o"
     end
 
+    def extinit_c_erb
+      lib_root = File.expand_path("../../../../..", __FILE__)
+      File.join(lib_root, "ext", "extinit.c.erb")
+    end
+
     def baseruby_path
       File.join(@baseruby.install_dir, "bin/ruby")
     end

lib/ruby_wasm/build_system/product/libyaml.rb

@@ -3,43 +3,49 @@
 
 module RubyWasm
   class LibYAMLProduct < AutoconfProduct
-    attr_reader :base_dir, :install_dir, :target, :install_task
+    attr_reader :target, :install_task
 
-    def initialize(base_dir, install_dir, target, toolchain)
-      @base_dir = base_dir
-      @install_dir = install_dir
+    LIBYAML_VERSION = "0.2.5"
+
+    def initialize(build_dir, target, toolchain)
+      @build_dir = build_dir
       @target = target
       super(target, toolchain)
     end
 
+    def product_build_dir
+      File.join(@build_dir, target, "yaml-#{LIBYAML_VERSION}")
+    end
+
+    def destdir
+      File.join(product_build_dir, "opt")
+    end
+
     def install_root
-      File.join(install_dir, "usr/local")
+      File.join(destdir, "usr", "local")
     end
 
     def name
       "libyaml-#{target}"
     end
 
     def define_task
-      libyaml_version = "0.2.5"
-      desc "build libyaml #{libyaml_version} for #{target}"
+      desc "build libyaml #{LIBYAML_VERSION} for #{target}"
       @install_task =
         task(name) do
           next if Dir.exist?(install_root)
 
-          build_dir =
-            File.join(base_dir, "/build/deps/#{target}/yaml-#{libyaml_version}")
-          mkdir_p File.dirname(build_dir)
-          rm_rf build_dir
-          sh "curl -L https://github.com/yaml/libyaml/releases/download/#{libyaml_version}/yaml-#{libyaml_version}.tar.gz | tar xz",
-             chdir: File.dirname(build_dir)
+          mkdir_p File.dirname(product_build_dir)
+          rm_rf product_build_dir
+          sh "curl -L https://github.com/yaml/libyaml/releases/download/#{LIBYAML_VERSION}/yaml-#{LIBYAML_VERSION}.tar.gz | tar xz",
+             chdir: File.dirname(product_build_dir)
 
           # obtain the latest config.guess and config.sub for Emscripten and WASI triple support
-          sh "curl -o #{build_dir}/config/config.guess 'https://git.savannah.gnu.org/gitweb/?p=config.git;a=blob_plain;f=config.guess;hb=HEAD'"
-          sh "curl -o #{build_dir}/config/config.sub 'https://git.savannah.gnu.org/gitweb/?p=config.git;a=blob_plain;f=config.sub;hb=HEAD'"
+          sh "curl -o #{product_build_dir}/config/config.guess 'https://git.savannah.gnu.org/gitweb/?p=config.git;a=blob_plain;f=config.guess;hb=HEAD'"
+          sh "curl -o #{product_build_dir}/config/config.sub 'https://git.savannah.gnu.org/gitweb/?p=config.git;a=blob_plain;f=config.sub;hb=HEAD'"
 
-          sh "./configure #{configure_args.join(" ")}", chdir: build_dir
-          sh "make install DESTDIR=#{install_dir}", chdir: build_dir
+          sh "./configure #{configure_args.join(" ")}", chdir: product_build_dir
+          sh "make install DESTDIR=#{destdir}", chdir: product_build_dir
         end
     end
   end

lib/ruby_wasm/build_system/product/ruby_source.rb

@@ -3,21 +3,21 @@
 
 module RubyWasm
   class BuildSource < BuildProduct
-    def initialize(params, base_dir)
+    def initialize(params, build_dir)
       @params = params
-      @base_dir = base_dir
+      @build_dir = build_dir
     end
 
     def name
       @params[:name]
     end
 
     def src_dir
-      "#{@base_dir}/build/src/#{@params[:name]}"
+      File.join(@build_dir, "checkouts", @params[:name])
     end
 
     def configure_file
-      "#{src_dir}/configure"
+      File.join(src_dir, "configure")
     end
 
     def fetch

lib/ruby_wasm/build_system/product/zlib.rb

@@ -3,41 +3,47 @@
 
 module RubyWasm
   class ZlibProduct < AutoconfProduct
-    attr_reader :base_dir, :install_dir, :target, :install_task
+    attr_reader :target, :install_task
 
-    def initialize(base_dir, install_dir, target, toolchain)
-      @base_dir = base_dir
-      @install_dir = install_dir
+    ZLIB_VERSION = "1.2.12"
+
+    def initialize(build_dir, target, toolchain)
+      @build_dir = build_dir
       @target = target
       super(target, toolchain)
     end
 
+    def product_build_dir
+      File.join(@build_dir, target, "zlib-#{ZLIB_VERSION}")
+    end
+
+    def destdir
+      File.join(product_build_dir, "opt")
+    end
+
     def install_root
-      File.join(install_dir, "zlib")
+      File.join(destdir, "usr", "local")
     end
 
     def name
       "zlib-#{target}"
     end
 
     def define_task
-      zlib_version = "1.2.12"
-      desc "build zlib #{zlib_version} for #{target}"
+      desc "build zlib #{ZLIB_VERSION} for #{target}"
       @install_task =
         task(name) do
           next if Dir.exist?(install_root)
 
-          build_dir =
-            File.join(base_dir, "/build/deps/#{target}/zlib-#{zlib_version}")
-          mkdir_p File.dirname(build_dir)
-          rm_rf build_dir
+          mkdir_p File.dirname(product_build_dir)
+          rm_rf product_build_dir
 
-          sh "curl -L https://zlib.net/zlib-#{zlib_version}.tar.gz | tar xz",
-             chdir: File.dirname(build_dir)
+          sh "curl -L https://zlib.net/zlib-#{ZLIB_VERSION}.tar.gz | tar xz",
+             chdir: File.dirname(product_build_dir)
 
-          sh "#{tools_args.join(" ")} ./configure --prefix=#{install_root} --static",
-             chdir: build_dir
-          sh "make install", chdir: build_dir
+          sh "#{tools_args.join(" ")} ./configure --static",
+             chdir: product_build_dir
+          sh "make install DESTDIR=#{destdir}", chdir: product_build_dir
         end
     end
   end

lib/ruby_wasm/rake_task.rb

@@ -3,27 +3,24 @@
 
 class RubyWasm::BuildTask < ::Rake::TaskLib
 
-  def initialize(name, target:, src:, extensions: [], toolchain: nil, **options, &task_block)
-    base_dir = Dir.pwd
-    install_dir = File.join(base_dir, "/build/deps/#{target}/opt")
+  def initialize(name, target:, src:, extensions: [], toolchain: nil, build_dir: nil, rubies_dir: nil, **options, &task_block)
+    build_dir ||= File.join(Dir.pwd, "build")
+    rubies_dir ||= File.join(Dir.pwd, "rubies")
     toolchain ||= RubyWasm::Toolchain.get target
 
-    libyaml = add_product RubyWasm::LibYAMLProduct.new(base_dir, install_dir, target, toolchain)
-    zlib = add_product RubyWasm::ZlibProduct.new(base_dir, install_dir, target, toolchain)
+    libyaml = add_product RubyWasm::LibYAMLProduct.new(build_dir, target, toolchain)
+    zlib = add_product RubyWasm::ZlibProduct.new(build_dir, target, toolchain)
 
-    source = add_product RubyWasm::BuildSource.new(src, base_dir)
-    baseruby = add_product RubyWasm::BaseRubyProduct.new(name, base_dir, source)
+    source = add_product RubyWasm::BuildSource.new(src, build_dir)
+    baseruby = add_product RubyWasm::BaseRubyProduct.new(build_dir, source)
 
     build_params = RubyWasm::BuildParams.new(
       options.merge(
         name: name, src: source, target: target, user_exts: extensions
       )
     )
 
-    exts = extensions.map do |ext|
-      RubyWasm::CrossRubyExtProduct.new(ext, toolchain)
-    end
-    product = RubyWasm::CrossRubyProduct.new(build_params, base_dir, baseruby, source, toolchain)
+    product = RubyWasm::CrossRubyProduct.new(build_params, build_dir, rubies_dir, baseruby, source, toolchain)
     product.with_libyaml libyaml
     product.with_zlib zlib
     product.define_task