Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork34.3k
gh-138451: Support custom LLVM installation path#138452
gh-138451: Support custom LLVM installation path#138452xhochy wants to merge 11 commits intopython:mainfrom
Conversation
python-cla-botbot commentedSep 3, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
Most changes to Pythonrequire a NEWS entry. Add one using theblurb_it web app or theblurb command-line tool. If this change has little impact on Python users, wait for a maintainer to apply the |
Tools/jit/_llvm.py Outdated
| async def _find_tool(tool: str, *, echo: bool = False) -> str | None: | ||
| # Explicitly defined LLVM installation location | ||
| if (llvm_root := os.getenv("LLVM_ROOT")) is not None: | ||
| path = os.path.join(llvm_root, "bin", tool) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Are all LLVM installation folders guaranteed to have the tool located in the$LLVM_ROOT/bin directory? I think it's somewhat risky to assume that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Actually there is aLLVM_TOOLS_INSTALL_DIR in the CMakeLists to customize this:https://github.com/llvm/llvm-project/blob/74ec38fad0a1289f936e5388fa8bbe74653c55d9/llvm/CMakeLists.txt#L494
I should probably use that instead?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Yeah that seems better
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
IsLLVM_TOOLS_INSTALL_DIR (orLLVM_ROOT for that matter) documented anywhere?
It seems like an env var used for building/installing LLVM itself, not necessarily something meant to be used after-the-fact by people trying to find LLVM. Or am I misunderstanding?
Tools/jit/_llvm.py Outdated
| @_async_cache | ||
| async def _find_tool(tool: str, *, echo: bool = False) -> str | None: | ||
| # Explicitly defined LLVM installation location | ||
| if (llvm_tools_dir := os.getenv("LLVM_TOOLS_INSTALL_DIR")) is not None: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Should we document this somewhere? If it gets a NEWS entry, then we probably have (or need) a list of environment variables that may need to be set when building.
I'd expect the list to be in the devguide, really, which is a different repo. But do we have one in the main repo?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Also:
| if(llvm_tools_dir:=os.getenv("LLVM_TOOLS_INSTALL_DIR"))isnotNone: | |
| ifllvm_tools_dir:=os.getenv("LLVM_TOOLS_INSTALL_DIR")): |
We shouldn't join to an empty value either (since that's interchangeable with "not set"). And possibly we should make sure it's an absolute path as well, though that may not matter so much.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Considering the JIT is still experimental, I don't think we should document this in the CPython docs. I agree that it should be in the devguide.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
As I did not know about the devguide before this review: Where should I add something? On first sight there was no section obvious to me.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I assume it's somewhere on this page, but to be honest I didn't read the whole thing:https://github.com/python/devguide/blob/main/getting-started/setup-building.rst
Possibly we need a new section here anyway for building the JIT?@savannahostrowski@brandtbucher are there JIT-specific build docs somewhere to document a relevant environment variable?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
We have docs for building inhttps://github.com/python/cpython/blob/main/Tools/jit/README.md#building. We'd probably want to update this for now.
xhochy commentedOct 26, 2025
Rebased and added documentation to the mentioned README. Is there anything more I can do here to get it merged? |
Misc/NEWS.d/next/Build/2025-09-03-14-55-59.gh-issue-138451.-Qzh2S.rst OutdatedShow resolvedHide resolved
Uh oh!
There was an error while loading.Please reload this page.
savannahostrowski left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I'm wondering if we should make this a configure flag instead, like we did with#138498. That way, you can pass the flag into configure once (e.g.,./configure --with-llvm-tools-dir=/opt/homebrew/opt/llvm...) and then just runmake without remembering to passLLVM_TOOLS_INSTALL_DIR each time. That'd make it more consistent with other build options.
A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated. Once you have made the requested changes, please leave a comment on this pull request containing the phrase |
xhochy commentedOct 27, 2025
I have made the requested changes; please review again |
Thanks for making the requested changes! @savannahostrowski: please review the changes made to this pull request. |
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
savannahostrowski left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
One comment but I think this looks good.
Misc/NEWS.d/next/Build/2025-09-03-14-55-59.gh-issue-138451.-Qzh2S.rst OutdatedShow resolvedHide resolved
Uh oh!
There was an error while loading.Please reload this page.
chris-eibl commentedDec 2, 2025
I think this is the same problem I've faced in#141967 (comment), so thanks for doing this! I've noticed there, that e.g. running will smuggle in the include path of the clang specified on the command line in front of the environment variable which the hard coded (and maybe different) clang version used in the jit builds doesn't like depending on the version mismatch ... |
chris-eibl commentedDec 2, 2025
Lines 23 to 31 in8801c6d
Lines 69 to 73 in8801c6d
Does that mean that we have to specify the additional |
zooba commentedDec 3, 2025
There's no strict requirement for make/configure variables to match pcbuild.proj variables, but if it's specified as an environment variable then we should probably detect if it's set and copy it over the actual variable. That's one line in |
chris-eibl commentedDec 3, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
IIUC, you mean setting I think it might be "too late", since AFAIR internally this is used by MS when preparing the environment according to "their" variable names, but we'll see. What's definitely easy: just use the MS variable names here because, as you said
and just update the jit readme accordingly if we cannot map the variables easily "early" enough ... Or we do it in |
zooba commentedDec 3, 2025
Any file that sets |
xhochy commentedDec 16, 2025
@zooba@chris-eibl I'm a bit unsure what I need to do here to get this merged. Is there anything from your side that I should address in my code for windows builds? |
chris-eibl commentedDec 16, 2025
First I thought we have these choices:
|
chris-eibl commentedDec 16, 2025
I've first tried option 4 via adding to Lines 122 to 127 in8c87bcd
This would have been my preferred choice, because then we would not have to "teach something new" and could have the same variables on Windows / Linux. However, if during installing of Visual Studio the bundled clang-cl is chosen to be installed, it turned out that |
chris-eibl commentedDec 16, 2025
Implementing option 3 is easy, too: just add after Lines 30 to 32 in8c87bcd
Now we'd have to document that when overriding the clang used to build the jit stencils will chose that clang for building Python, too, if built with So option 1 gives more flexibility, but needs (?) a warning and "specifying the same thing twice" might feel like a wart. I am unsure what to do best, but considering the jit is maybe no longer experimental, we should care to find a good solution here? |
Fidget-Spinner commentedDec 16, 2025
The JIT is still experimental, but Python build flags and in general build.bat flags are bound by backwards compatibility, so when adding things we have to treat it as non-experimental. |
savannahostrowski commentedJan 26, 2026
Just checking in here, is there anything else required for this one? |
chris-eibl commentedJan 26, 2026 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
Sorry, seems I've stalled this. IMHO we can handle the "clang version to build python" vs "clang version to build the jit" quirk in a follow-up PR? Especially since the first seems to be niche on Windows? |
savannahostrowski commentedFeb 6, 2026
I think that's reasonable but I'd defer to@zooba on how he feels about that. I also don't want the follow up to get lost in the ether. |
chris-eibl commentedMar 20, 2026
I've furthermore tested this PR now locally successfully, too, in addition to my initial review(s).
I've created#146210. |
Uh oh!
There was an error while loading.Please reload this page.
Fixes#138451
Add support for explicitly defined LLVM installation location.
This is necessary as MSVC now comes with its own LLVM installation and activating MSVC via vcvars.bat will put LLVM tools on the
PATHbefore the local ones.You can see this in usage in conda-forge's latest Python 3.13 build:conda-forge/python-feedstock#807