Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Disable GNU make implicit variables and Quiet ar with ARFLAGS rather than > null #2711

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

Disable GNU make implicit variables and Quiet ar with ARFLAGS rather than > null #2711

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ba82ce9
Quiet `ar` with `ARFLAGS` rather than `> null`
ParadoxV5 May 25, 2024
0779fa9
`make` with `--no-builtin-variables`
ParadoxV5 May 25, 2024
9bb8710
Search the PATH for `CC`/`AR` checks
ParadoxV5 May 25, 2024
7ce2a66
Merge branch 'ruby:main' into gnu-make-implicit-vars
ParadoxV5 Jun 15, 2024
469487f
Merge branch 'main' into gnu-make-implicit-vars
ParadoxV5 Aug 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ CPPFLAGS := -Iinclude $(CPPFLAGS)
CFLAGS := -g -O2 -std=c99 -Wall -Werror -Wextra -Wpedantic -Wundef -Wconversion -Wno-missing-braces -fPIC -fvisibility=hidden $(CFLAGS)
CC ?= cc
AR ?= ar
ARFLAGS ?= -r$(V0:1=v)
Comment on lines 15 to +17
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

According to #2716, the original ?=s were once a workaround for #2716.
That issue’s root cause’s separately fixed and 7c2461f purged its related extconf.rb code. Like this PR, I wonder if those lines are still necessary?

WASI_SDK_PATH := /opt/wasi-sdk

MAKEDIRS ?= mkdir -p
Expand All @@ -37,7 +38,7 @@ build/libprism.$(SOEXT): $(SHARED_OBJECTS)

build/libprism.a: $(STATIC_OBJECTS)
$(ECHO) "building $@ with $(AR)"
$(Q) $(AR) $(ARFLAGS) $@ $(STATIC_OBJECTS) $(Q1:0=>/dev/null)
$(Q) $(AR) $(ARFLAGS) $@ $(STATIC_OBJECTS)
Copy link
Contributor Author

@ParadoxV5 ParadoxV5 Apr 18, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A quick text find shows that this was the only recipe where Q1 is used, and the only other use of Q1 is

prism/Makefile

Line 6 in 17762fa

Q = $(Q1:0=@)
, which may now be flattenend.
(I’m a novice in C-land; if the entire set of Vs and Qs is a convention, introduce them to me.)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For this matter, ba82ce9 introduces an acutal use for V0:

prism/Makefile

Line 17 in ba82ce9

ARFLAGS ?= -r$(V0:1=v)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Writing to Null has always been questionable as we could simply not supply -v to ar.
As stated in OP, this workaround exists because ARFLAGS defaults to -rv, unless forcefully replaced.

Alternate approaches include:

  • use RbConfig::CONFIG for those (i.e., all rbconfig.rb cases) as well
    • tricking create_makefile also counts
  • Do those still need a separate .a and ar steps?
    Most C projects (mkmf or not) builds .cs to .os and .os to .so/.dll; there’s no .a step after .os.


javascript/src/prism.wasm: Makefile $(SOURCES) $(HEADERS)
$(ECHO) "building $@"
Expand Down
9 changes: 5 additions & 4 deletions ext/prism/extconf.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ def make(env, target)
system(
env,
RUBY_PLATFORM.match?(/openbsd|freebsd/) ? "gmake" : "make",
"--no-builtin-variables", # don't let GNU make implicit variables override variable fallbacks in the Makefile
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure I understand what this is doing. Could you explain why we need this?

Copy link
Contributor Author

@ParadoxV5 ParadoxV5 May 28, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As noted on the previous posts, this flag disables implicit variables for GNU make (updated top post).
GNU make takes those implicit variables precedence over our ?=s, especially the new ARFLAGS ?= -r$(V0:1=v) (PR thread), meaning they aren’t applied without this flag.

prism/Makefile

Lines 15 to 17 in 9bb8710

CC ?= cc
AR ?= ar
ARFLAGS ?= -r$(V0:1=v)

target,
exception: true
)
Expand All @@ -76,22 +77,22 @@ def make(env, target)
# The C extension uses RbConfig, which contains values from the toolchain that built the running Ruby.
env = RbConfig::CONFIG.slice("SOEXT", "CPPFLAGS", "CFLAGS", "CC", "AR", "ARFLAGS", "MAKEDIRS", "RMALL")

require "mkmf"

# It's possible that the Ruby that is being run wasn't actually compiled on this
# machine, in which case parts of RbConfig might be incorrect. In this case
# we'll need to do some additional checks and potentially fall back to defaults.
if env.key?("CC") && !File.exist?(env["CC"])
if env.key?("CC") && !find_executable(env["CC"])
env.delete("CC")
env.delete("CFLAGS")
env.delete("CPPFLAGS")
end

if env.key?("AR") && !File.exist?(env["AR"])
if env.key?("AR") && !find_executable(env["AR"])
env.delete("AR")
env.delete("ARFLAGS")
end

require "mkmf"

# First, ensure that we can find the header for the prism library.
generate_templates # Templates should be generated before find_header.
unless find_header("prism.h", File.expand_path("../../include", __dir__))
Expand Down
Loading