Skip to content

feat(pkg): use the relocatable compiler#14357

Draft
Alizter wants to merge 3 commits intoocaml:mainfrom
Alizter:push-vkkkwyxwsotw
Draft

feat(pkg): use the relocatable compiler#14357
Alizter wants to merge 3 commits intoocaml:mainfrom
Alizter:push-vkkkwyxwsotw

Conversation

@Alizter
Copy link
Copy Markdown
Collaborator

@Alizter Alizter commented Apr 27, 2026

This PR enables the relocatable compiler by making it the default. It does so by using David's relocatable opam-repository as a second set of overlays.

The order is now overlay, relocatable, upstream.

This is part of the work on:

The following need to be done:

  • changelog
  • documentation
  • testing with:
    • ocamlfind - some warnings but builds and works fine
    • ocamlbuild (once relocatable ocamlbuild #13678 is finished)
    • ocamlformat dev tool
    • ocamllsp devtool
    • utop devtool

In order to test,

  1. clone your favourite OCaml project.
  2. Please set DUNE_TRACE=+cache and DUNE_CACHE=enabled
  3. Run dune build --pkg enabled and wait.
  4. Then when it's finished, backup the _build/trace.sexp file as trace.sexp.old and delete _build/
  5. Run the build again.

If all goes well (and your cache is actually enabled) it should restore from cache.

Any issues please report here together with your first and second trace files. _build/trace.csexp and the backed-up trace.csexp.old.

@Alizter Alizter mentioned this pull request Apr 27, 2026
15 tasks
@Alizter Alizter force-pushed the push-vkkkwyxwsotw branch 2 times, most recently from dba99db to 10f294f Compare April 28, 2026 10:33
@Alizter Alizter self-assigned this Apr 29, 2026
@Leonidas-from-XIV
Copy link
Copy Markdown
Collaborator

Can you fill me in with the current state? The way I was explained this many months ago is that OCaml 5.5 is relocatable by default and the relocatable patches will be backported to older compilers in point releases. in such case it would just work out of the box for everyone without need for more overlays.

Is that not the case anymore?

@Alizter
Copy link
Copy Markdown
Collaborator Author

Alizter commented Apr 30, 2026

@Leonidas-from-XIV That is the case for OCaml 5.5 which is yet to be released. You can constrain your dependencies to use it. The support provided by David's repository is for older versions to at least 4.14. It takes time for patches to make their way to the compiler branch, and I'm not even certain that it has been agreed yet that this will be the case. For users of dune pkg, we can and should make use of it however.

@Leonidas-from-XIV
Copy link
Copy Markdown
Collaborator

Yes, but my question was about the backports to older compiler releases. Are these not planned anymore?

@Alizter
Copy link
Copy Markdown
Collaborator Author

Alizter commented Apr 30, 2026

I don't know. I don't know if it has been discussed with the compiler developers yet and I also don't know if these discussions have happened with opam. My point is that we don't need to know any of this to make use of it in dune.

@Leonidas-from-XIV
Copy link
Copy Markdown
Collaborator

@dra27 could you provide us with some insight on what the plan is for the backporting (or lack thereof) for older compilers?

Alizter added 2 commits May 4, 2026 18:15
Signed-off-by: Ali Caglayan <alizter@gmail.com>
The relocatable-compiler package installs libraries (including threads,
str, unix) under target/lib/ocaml/, matching the layout of other compiler
packages. Without being listed in compiler_package_names, install_roots
did not append the /ocaml subdirectory to its lib_root, causing dev-tools
like utop to fail with "Library threads not found".

Signed-off-by: Ali Caglayan <alizter@gmail.com>
@Alizter Alizter force-pushed the push-vkkkwyxwsotw branch from 10f294f to c98d4e6 Compare May 4, 2026 16:15
Comment thread src/dune_cache/shared.ml Outdated
@Alizter Alizter force-pushed the push-vkkkwyxwsotw branch 2 times, most recently from 8e41362 to 9bd5654 Compare May 4, 2026 20:43
file_async opens an fd eagerly and for large files holds it open across
a fiber yield while queued for the background thread pool. When called
via unbounded parallel_map over many targets (e.g. the relocatable
compiler with thousands of files), fds accumulate faster than they are
closed, exhausting the process fd limit.

Add a global Fiber.Throttle in file_async to bound the number of
concurrent digest operations.

Signed-off-by: Ali Caglayan <alizter@gmail.com>
@Alizter Alizter force-pushed the push-vkkkwyxwsotw branch from 9bd5654 to 53584cc Compare May 4, 2026 20:47
Comment thread src/dune_pkg/workspace.ml
{ name = "relocatable"
; url =
( Loc.none
, OpamUrl.of_string "git+https://github.com/dra27/opam-repository.git#relocatable"
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks to @Leonidas-from-XIV pointing out possible risks, perhaps we should mirror this repository to a repo that dune devs could update when needed, without having to depend on David to merge.

This is not because David cannot be depended on (quite the opposite) but because it seems to put needless pressure on his fork, and could be a buss factor issue if we need to a make a change. How about putting this on a branch on https://github.com/ocaml-dune/opam-overlays or (better?) merging the needed relocatable overlays into that one?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Always use the relocatable compiler over the older OCaml ones.

4 participants