rubycc 1.0.0

data/lib/rubycc/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Rubycc
+  VERSION = "1.0.0"
+end

data/lib/rubycc.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "rubycc/version"
+
+module Rubycc
+  class Error < StandardError; end
+end
+
+require_relative "rubycc/compile_error"
+require_relative "rubycc/type"
+require_relative "rubycc/front/token"
+require_relative "rubycc/front/lexeme_reader"
+require_relative "rubycc/front/lexer"
+require_relative "rubycc/preprocess/pp_token"
+require_relative "rubycc/preprocess/scanner"
+require_relative "rubycc/preprocess/token_converter"
+require_relative "rubycc/front/ast"
+require_relative "rubycc/front/constant_evaluator"
+require_relative "rubycc/preprocess/constant_expression"
+require_relative "rubycc/preprocess/preprocessor"
+require_relative "rubycc/front/parser"
+require_relative "rubycc/ir/ir"
+require_relative "rubycc/ir/generator"
+require_relative "rubycc/backend/x86_64"
+require_relative "rubycc/backend/aarch64"
+require_relative "rubycc/objfile/elf_writer"
+require_relative "rubycc/objfile/elf_reader"
+require_relative "rubycc/objfile/relocatable_writer"
+require_relative "rubycc/objfile/ar_archive"
+require_relative "rubycc/link/errors"
+require_relative "rubycc/link/partial_linker"
+require_relative "rubycc/link/shared_linker"
+require_relative "rubycc/link/executable_linker"
+require_relative "rubycc/link/library_resolver"
+require_relative "rubycc/compiler"
+require_relative "rubycc/driver"

data/lib/rubygems_plugin.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+# RubyGems auto-loads every installed gem's `rubygems_plugin.rb` at startup
+# (Gem.load_plugins), so this file runs in the `gem install <native-ext-gem>`
+# process before any extension is built. Its whole job is to decide whether the
+# build should go through rubycc and, if so, to inject the environment that makes
+# RubyGems' extension build route to rubycc's toolchain instead of gcc/make —
+# without the user passing any flags (DESIGN 5.4, ROADMAP §6 B6).
+#
+# The decision:
+#   * ENV["RUBYCC"] == "1"  -> force on;
+#   * ENV["RUBYCC"] == "0"  -> force off;
+#   * unset                 -> on only when neither `cc`, `gcc` nor `make` is on
+#                              PATH (a toolchain-less host that needs rubycc).
+#
+# When off, the plugin must be inert — it is loaded on *every* `gem` command, so
+# the disabled path does no work and touches no state. When on it rewrites four
+# environment variables the RubyGems build inherits:
+#   * MAKE       -> exe/rmake, which RubyGems runs as `$(MAKE)`; rmake builds the
+#                   generated Makefile with rubycc always substituted for $(CC);
+#   * PKG_CONFIG -> exe/rubycc-pkgconf, the pkg-config shim;
+#   * RUBYLIB    <- gains this gem's lib/ so the extconf child can require rubycc;
+#   * RUBYOPT    <- gains `-rrubycc/mkmf_shim` so the extconf child's mkmf issues
+#                   its conftests through rubycc and writes a `CC = <rubycc>`
+#                   Makefile.
+# Every rewrite is idempotent: re-running install! adds no duplicate PATH/RUBYOPT
+# entries and re-assigns the same MAKE/PKG_CONFIG values.
+module Rubycc
+  module GemPlugin
+    # This file lives at lib/rubygems_plugin.rb, so __dir__ is the gem's lib/ and
+    # the executables sit at ../exe relative to it.
+    LIB_DIR     = __dir__
+    RMAKE_EXE   = File.expand_path("../exe/rmake", __dir__)
+    PKGCONF_EXE = File.expand_path("../exe/rubycc-pkgconf", __dir__)
+
+    # The require the extconf child needs so mkmf's conftests route to rubycc.
+    MKMF_SHIM_FEATURE = "rubycc/mkmf_shim"
+
+    # The external programs whose absence (all three) turns rubycc on by default:
+    # a host with no C compiler and no make is one that cannot build extensions
+    # the conventional way, which is exactly where rubycc takes over.
+    AUTO_ENABLE_ABSENT_TOOLS = %w[cc gcc make].freeze
+
+    module_function
+
+    # Whether the rubycc build path should be active for this process.
+    def enabled?
+      case ENV["RUBYCC"]
+      when "1" then true
+      when "0" then false
+      else auto_enable?
+      end
+    end
+
+    # The unset-RUBYCC default: on only when none of the conventional tools is
+    # available, so a host that already has gcc/make is left completely alone.
+    def auto_enable?
+      AUTO_ENABLE_ABSENT_TOOLS.none? { |tool| on_path?(tool) }
+    end
+
+    # Inject the environment that makes the RubyGems extension build use rubycc.
+    def install!
+      ENV["MAKE"] = RMAKE_EXE
+      ENV["PKG_CONFIG"] = PKGCONF_EXE
+      prepend_path_entry("RUBYLIB", LIB_DIR)
+      prepend_ruby_require(MKMF_SHIM_FEATURE)
+    end
+
+    # A PATH lookup that spawns nothing: scan the PATH directories for an
+    # executable file of that name (the same resolution `command -v` performs).
+    def on_path?(name)
+      ENV["PATH"].to_s.split(File::PATH_SEPARATOR).any? do |dir|
+        next false if dir.empty?
+
+        candidate = File.join(dir, name)
+        File.file?(candidate) && File.executable?(candidate)
+      end
+    end
+
+    # Prepend +dir+ to a PATH-style environment variable (RUBYLIB) unless it is
+    # already the leading entry — so the extconf child can require rubycc from
+    # this gem's lib/.
+    def prepend_path_entry(var, dir)
+      entries = ENV[var].to_s.split(File::PATH_SEPARATOR)
+      return if entries.first == dir
+
+      ENV[var] = [dir, *entries].join(File::PATH_SEPARATOR)
+    end
+
+    # Add `-r<feature>` to RUBYOPT (at the front, so the shim loads before the
+    # extconf script's own requires) unless it is already present.
+    def prepend_ruby_require(feature)
+      flag = "-r#{feature}"
+      current = ENV["RUBYOPT"].to_s
+      return if current.split(/\s+/).include?(flag)
+
+      ENV["RUBYOPT"] = current.empty? ? flag : "#{flag} #{current}"
+    end
+  end
+end
+
+Rubycc::GemPlugin.install! if Rubycc::GemPlugin.enabled?

metadata

@@ -0,0 +1,219 @@
+--- !ruby/object:Gem::Specification
+name: rubycc
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- DATE Ken
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: |
+  rubycc builds Ruby C extensions on a machine that has no gcc, no binutils, no make
+  and no shell. It is a C11-subset compiler, an assembler-free ELF writer, a linker,
+  an ar, a make, a pkg-config shim and a preprocessor, written in Ruby, plus the libc
+  headers a build needs -- so a distroless image with no libc development package
+  still compiles ruby.h.
+
+  Targets x86-64 and AArch64 Linux (ELF64) against glibc and musl. Generated code is
+  unoptimized: the point is that the extension builds and its own test suite passes,
+  which is the level at which every gem recorded in data/verified_gems.json was
+  verified. See the README for the verified gems, the measured limits, and what is
+  out of scope.
+email:
+- itacchi@gmail.com
+executables:
+- rmake
+- rubycc
+- rubycc-ar
+- rubycc-doctor
+- rubycc-pkgconf
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- NOTICE
+- README.md
+- data/README.md
+- data/r10_corpus_scan.json
+- data/r10_manual_classification.json
+- data/r10_verification_m4a.json
+- data/r10_verification_m4b.json
+- data/r10_verification_m4c.json
+- data/r10_verification_m4d.json
+- data/r10_verification_rbs.json
+- data/verified_gems.json
+- exe/rmake
+- exe/rubycc
+- exe/rubycc-ar
+- exe/rubycc-doctor
+- exe/rubycc-pkgconf
+- include/float.h
+- include/iso646.h
+- include/libc/alloca.h
+- include/libc/arpa/inet.h
+- include/libc/assert.h
+- include/libc/dirent.h
+- include/libc/dlfcn.h
+- include/libc/features.h
+- include/libc/glibc/aarch64/ctype.h
+- include/libc/glibc/aarch64/endian.h
+- include/libc/glibc/aarch64/errno.h
+- include/libc/glibc/aarch64/fcntl.h
+- include/libc/glibc/aarch64/inttypes.h
+- include/libc/glibc/aarch64/limits.h
+- include/libc/glibc/aarch64/pthread.h
+- include/libc/glibc/aarch64/setjmp.h
+- include/libc/glibc/aarch64/stdint.h
+- include/libc/glibc/aarch64/sys/epoll.h
+- include/libc/glibc/aarch64/sys/fcntl.h
+- include/libc/glibc/aarch64/sys/select.h
+- include/libc/glibc/aarch64/sys/stat.h
+- include/libc/glibc/aarch64/sys/syscall.h
+- include/libc/glibc/aarch64/sys/time.h
+- include/libc/glibc/aarch64/sys/types.h
+- include/libc/glibc/aarch64/time.h
+- include/libc/glibc/x86_64/ctype.h
+- include/libc/glibc/x86_64/endian.h
+- include/libc/glibc/x86_64/errno.h
+- include/libc/glibc/x86_64/fcntl.h
+- include/libc/glibc/x86_64/inttypes.h
+- include/libc/glibc/x86_64/limits.h
+- include/libc/glibc/x86_64/pthread.h
+- include/libc/glibc/x86_64/setjmp.h
+- include/libc/glibc/x86_64/stdint.h
+- include/libc/glibc/x86_64/sys/epoll.h
+- include/libc/glibc/x86_64/sys/fcntl.h
+- include/libc/glibc/x86_64/sys/select.h
+- include/libc/glibc/x86_64/sys/stat.h
+- include/libc/glibc/x86_64/sys/syscall.h
+- include/libc/glibc/x86_64/sys/time.h
+- include/libc/glibc/x86_64/sys/types.h
+- include/libc/glibc/x86_64/time.h
+- include/libc/grp.h
+- include/libc/langinfo.h
+- include/libc/link.h
+- include/libc/locale.h
+- include/libc/math.h
+- include/libc/netinet/in.h
+- include/libc/netinet/tcp.h
+- include/libc/poll.h
+- include/libc/pwd.h
+- include/libc/regex.h
+- include/libc/sched.h
+- include/libc/signal.h
+- include/libc/stdio.h
+- include/libc/stdlib.h
+- include/libc/string.h
+- include/libc/strings.h
+- include/libc/sys/cdefs.h
+- include/libc/sys/inotify.h
+- include/libc/sys/ioctl.h
+- include/libc/sys/mman.h
+- include/libc/sys/param.h
+- include/libc/sys/resource.h
+- include/libc/sys/socket.h
+- include/libc/sys/statfs.h
+- include/libc/sys/timerfd.h
+- include/libc/sys/uio.h
+- include/libc/sys/un.h
+- include/libc/sys/utsname.h
+- include/libc/sys/wait.h
+- include/libc/termios.h
+- include/libc/unistd.h
+- include/stdalign.h
+- include/stdarg.h
+- include/stdatomic.h
+- include/stdbool.h
+- include/stdckdint.h
+- include/stddef.h
+- include/stdnoreturn.h
+- include/x86intrin.h
+- lib/rubycc.rb
+- lib/rubycc/backend/aarch64.rb
+- lib/rubycc/backend/x86_64.rb
+- lib/rubycc/compile_error.rb
+- lib/rubycc/compiler.rb
+- lib/rubycc/doctor.rb
+- lib/rubycc/doctor/builder.rb
+- lib/rubycc/doctor/cli.rb
+- lib/rubycc/doctor/fetcher.rb
+- lib/rubycc/doctor/gemfile.rb
+- lib/rubycc/doctor/verified_gems.rb
+- lib/rubycc/driver.rb
+- lib/rubycc/front/ast.rb
+- lib/rubycc/front/constant_evaluator.rb
+- lib/rubycc/front/initializer_resolver.rb
+- lib/rubycc/front/lexeme_reader.rb
+- lib/rubycc/front/lexer.rb
+- lib/rubycc/front/parser.rb
+- lib/rubycc/front/token.rb
+- lib/rubycc/ir/call_convention.rb
+- lib/rubycc/ir/generator.rb
+- lib/rubycc/ir/ir.rb
+- lib/rubycc/link/compat_runtime.rb
+- lib/rubycc/link/errors.rb
+- lib/rubycc/link/executable_linker.rb
+- lib/rubycc/link/library_resolver.rb
+- lib/rubycc/link/partial_linker.rb
+- lib/rubycc/link/shared_linker.rb
+- lib/rubycc/mkmf_shim.rb
+- lib/rubycc/objfile/ar_archive.rb
+- lib/rubycc/objfile/elf_reader.rb
+- lib/rubycc/objfile/elf_writer.rb
+- lib/rubycc/objfile/relocatable_writer.rb
+- lib/rubycc/pkgconf/cli.rb
+- lib/rubycc/pkgconf/errors.rb
+- lib/rubycc/pkgconf/model.rb
+- lib/rubycc/pkgconf/parser.rb
+- lib/rubycc/pkgconf/pkgconf.rb
+- lib/rubycc/pkgconf/resolver.rb
+- lib/rubycc/pkgconf/search_path.rb
+- lib/rubycc/pkgconf/system_path_filter.rb
+- lib/rubycc/preprocess/constant_expression.rb
+- lib/rubycc/preprocess/glibc_version.rb
+- lib/rubycc/preprocess/pp_token.rb
+- lib/rubycc/preprocess/preprocessor.rb
+- lib/rubycc/preprocess/scanner.rb
+- lib/rubycc/preprocess/token_converter.rb
+- lib/rubycc/rmake/cli.rb
+- lib/rubycc/rmake/errors.rb
+- lib/rubycc/rmake/executor.rb
+- lib/rubycc/rmake/expander.rb
+- lib/rubycc/rmake/makefile.rb
+- lib/rubycc/rmake/model.rb
+- lib/rubycc/rmake/parser.rb
+- lib/rubycc/rmake/rmake.rb
+- lib/rubycc/type.rb
+- lib/rubycc/version.rb
+- lib/rubygems_plugin.rb
+homepage: https://github.com/nuna/rubycc
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/nuna/rubycc
+  changelog_uri: https://github.com/nuna/rubycc/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/nuna/rubycc/issues
+  documentation_uri: https://github.com/nuna/rubycc/blob/master/README.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Almost Pure Ruby C toolchain for building Ruby native extensions without
+  gcc/binutils
+test_files: []