Page MenuHomeFreeBSD
Differential D50956

src.conf: Add WITH_LLVM_STATIC build knob
ClosedPublic
Actions

Authored by dim on Jun 20 2025, 5:22 PM.
Tags
None
Referenced Files
Unknown Object (File)
Wed, Dec 24, 1:50 PM
Unknown Object (File)
Tue, Dec 23, 11:18 PM
Unknown Object (File)
Tue, Dec 23, 9:14 PM
Unknown Object (File)
Tue, Dec 23, 7:37 PM
Unknown Object (File)
Tue, Dec 23, 4:41 AM
Unknown Object (File)
Tue, Dec 23, 4:41 AM
Unknown Object (File)
Tue, Dec 23, 4:41 AM
Unknown Object (File)
Tue, Dec 23, 4:41 AM
View All 71 Files
Subscribers
bdrewery
des
rozhuk.im-gmail.com
ziaee

Details

Reviewers
brooks
emaste
imp
jrtc27
Commits
rG8d5a11cd0137: src.conf: Add WITH_LLVM_LINK_STATIC_LIBRARIES build knob
Summary

In commit 2e47f35be5dc libllvm, libclang and liblldb were converted into
private shared libraries. This allowed clang, lld, lldb, and other llvm
tools to be linked against these shared libraries, which makes them
smaller and avoids duplication.

However, this also comes at the cost of some performance, since the
dynamic libraries are quite large, and contain lots of long symbols
(mangled C++ identifiers).

Add a WITH_LLVM_STATIC build knob that can be used to go back to the
previous behavior: libllvm, libclang and liblldb are built as internal
static libraries, i.e. only available during buildworld, and fully
linked into the various executables such as clang, lld, etc.

PR: 287447
MFC after: 1 week

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Passed
Unit
No Test Coverage
Build Status
Buildable 65120
Build 62003: arc lint + arc unit

Event Timeline

dim created this revision.Jun 20 2025, 5:22 PM
Herald added subscribers: ziaee, bdrewery. · View Herald TranscriptJun 20 2025, 5:22 PM
dim requested review of this revision.Jun 20 2025, 5:22 PM
Harbormaster completed remote builds in B65000: Diff 157391.Jun 20 2025, 5:22 PM
dim updated this revision to Diff 157392.Jun 20 2025, 5:25 PM

Also include src.opts.mk in libllvm's and liblldb's Makefiles, otherwise
MK_ variables might not be defined.

Harbormaster completed remote builds in B65001: Diff 157392.Jun 20 2025, 5:25 PM
emaste added a comment.Jun 20 2025, 5:42 PM

IMO we should expand on the user-facing effect in the option descriptions - i.e., for WITH_LLVM_STATIC the Clang/LLVM toolchain binaries will be much larger but start more quickly. WITHOUT_LLVM_STATIC the Clang/LLVM binaries will be smaller, but will take longer to start.

lib/clang/liblldb/Makefile
4

Makes sense for consistency but I assume we don't actually build liblldb as a cross-tool?

dim added a comment.Jun 20 2025, 7:28 PM
In D50956#1163146, @emaste wrote:

IMO we should expand on the user-facing effect in the option descriptions - i.e., for WITH_LLVM_STATIC the Clang/LLVM toolchain binaries will be much larger but start more quickly. WITHOUT_LLVM_STATIC the Clang/LLVM binaries will be smaller, but will take longer to start.

I looked at a few other WITH/WITHOUT descriptions and they're usually rather terse, but you're probably right. Better to to explicit about the purpose of the knob.

lib/clang/liblldb/Makefile
4

Makes sense for consistency but I assume we don't actually build liblldb as a cross-tool?

You're right, this is a copy/pasted pair of lines from the other two Makefiles. TOOLS_PREFIX is only defined when bootstrapping the compiler, and indeed we never build lldb during that phase.

dim updated this revision to Diff 157397.Jun 20 2025, 7:42 PM
  • Adjust comment in liblldb Makefile
  • Expand descriptions in WITH/WITHOUT fragments
Harbormaster completed remote builds in B65004: Diff 157397.Jun 20 2025, 7:42 PM
dim added a comment.Jun 20 2025, 7:44 PM

Btw there is still one rather nasty fly in the ointment for this patch: in tools/build/depend-cleanup.sh we have a hack to delete libllvm.a, libclang.a and liblldb.a from the obj tree. I don't know of a way to get at the MK_LLVM_STATIC option value in that shell script though. Does anybody have any good idea for that? Run ${MAKE} in some form that spits out the value?

dim updated this revision to Diff 157709.Jun 27 2025, 4:30 PM

Add hack to ensure depend-cleanup.sh does not inadvertently delete static llvm/clang etc libraries.

Harbormaster completed remote builds in B65120: Diff 157709.Jun 27 2025, 4:30 PM
dim updated this revision to Diff 167656.Sun, Dec 7, 2:00 PM

Rebase, and remove depend-cleanup.sh stuff, which was flaky anyway. Any MK_ option change should always be done via a full rebuild.

Harbormaster completed remote builds in B69107: Diff 167656.Sun, Dec 7, 2:01 PM
des added a subscriber: des.Sun, Dec 7, 2:03 PM

Don't worry about depend-cleanup.sh, D52011 will take care of it.

des added inline comments.Sun, Dec 7, 5:30 PM
tools/build/options/WITHOUT_LLVM_STATIC
3

This is mandoc code, sentences should start on a new line.

tools/build/options/WITH_LLVM_STATIC
3

This is mandoc code, sentences should start on a new line.

des added inline comments.Sun, Dec 7, 5:31 PM
tools/build/options/WITHOUT_LLVM_STATIC
3

BTW, you don't need to provide both files. Since this option defaults to no, you only need to provide the WITH_ variant.

emaste added inline comments.Sun, Dec 7, 6:18 PM
tools/build/options/WITHOUT_LLVM_STATIC
3

I think it's fine to keep both for the benefit of downstream projects who might use a different default.

des added inline comments.Sun, Dec 7, 6:45 PM
tools/build/options/WITHOUT_LLVM_STATIC
3

I'm not going to insist, it doesn't hurt to have both, as long as they're kept in sync.

emaste added a comment.Wed, Dec 10, 2:54 PM

I'm not sure about the option name and descriptions; WITH_LLVM_STATIC suggests that these will be statically linked binaries. And, Build LLVM libraries (libllvm, libclang, liblldb) as internal static libraries. isn't a great user-facing description because it's just an artifact of the build process and the user doesn't see the result. Maybe "Link LLVM libraries (libllvm, libclang, liblldb) directly into each of the binaries that use them."? What do you think about calling it WITH_LLVM_LIBRARIES?

lib/clang/libclang/Makefile
869–874

Not new in your change, but what about combining this section with the same test above?

dim updated this revision to Diff 168499.Sun, Dec 21, 7:07 PM
  • Rename option to WITH_LLVM_LINK_STATIC_LIBRARIES
  • Drop tools/build/options/WITHOUT_LLVM_STATIC
  • Update tools/build/options/WITH_LLVM_LINK_STATIC_LIBRARIES text
Harbormaster completed remote builds in B69430: Diff 168499.Sun, Dec 21, 7:07 PM
dim updated this revision to Diff 168544.Tue, Dec 23, 3:43 PM

Move setting of -DLLVM_BUILD_LLVM_DYLIB to the right place.

Harbormaster completed remote builds in B69453: Diff 168544.Tue, Dec 23, 3:43 PM
emaste accepted this revision.Tue, Dec 23, 5:01 PM
This revision is now accepted and ready to land.Tue, Dec 23, 5:01 PM
Closed by commit rG8d5a11cd0137: src.conf: Add WITH_LLVM_LINK_STATIC_LIBRARIES build knob (authored by dim). · Explain WhyTue, Dec 23, 9:05 PM
This revision was automatically updated to reflect the committed changes.
dim added a commit: rG8d5a11cd0137: src.conf: Add WITH_LLVM_LINK_STATIC_LIBRARIES build knob.

Revision Contents
Changeset List

PathSize
1 line
lib/
clang/
libclang/
8 lines
liblldb/
13 lines
libllvm/
6 lines
share/
man/
man5/
mk/
1 line
tools/
build/
24 lines
mk/
11 lines
options/
4 lines
4 lines
usr.bin/
clang/
2 lines
2 lines
lld/
2 lines
lldb-server/
5 lines
lldb/
5 lines
5 lines

Diff 157709

View Options

Makefile.inc1

Loading...
View Options

lib/clang/libclang/Makefile

Loading...
View Options

lib/clang/liblldb/Makefile

Loading...
View Options

lib/clang/libllvm/Makefile

Loading...
View Options

share/man/man5/src.conf.5

Loading...
View Options

share/mk/src.opts.mk

Loading...
View Options

tools/build/depend-cleanup.sh

Loading...
View Options

tools/build/mk/OptionalObsoleteFiles.inc

Loading...
View Options

tools/build/options/WITHOUT_LLVM_STATIC

Loading...
View Options

tools/build/options/WITH_LLVM_STATIC

Loading...
View Options

usr.bin/clang/Makefile.inc

Loading...
View Options

usr.bin/clang/clang.prog.mk

Loading...
View Options

usr.bin/clang/lld/Makefile

Loading...
View Options

usr.bin/clang/lldb-server/Makefile

Loading...
View Options

usr.bin/clang/lldb/Makefile

Loading...
View Options

usr.bin/clang/llvm.prog.mk

Loading...