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.

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

Rewrite gen_link_flags in OCaml #1189

Merged
merged 10 commits into from
Jul 31, 2024
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
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
13 changes: 11 additions & 2 deletions src/bin/text/dune
Original file line number Diff line number Diff line change
@@ -1,9 +1,18 @@
(documentation
(package alt-ergo))

(executable
(name gen_link_flags)
(libraries unix fmt stdcompat cmdliner)
Copy link
Collaborator

Choose a reason for hiding this comment

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

It doesn't look like we use cmdliner, it should not be a dependency.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I wrote a previous version with cmdliner but it was a bit over-engineering. I forgot to remove the dependency.

(modules gen_link_flags)
(promote (until-clean)))
Copy link
Collaborator

Choose a reason for hiding this comment

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

There should be no need to promote this executable, let's not clutter the source directory.


(rule
(with-stdout-to link_flags.dune
(run ./gen-link-flags.sh %{env:LINK_MODE=dynamic} %{ocaml-config:system})))
(target link_flags.dune)
(deps (:gen gen_link_flags.exe))
Copy link
Collaborator

Choose a reason for hiding this comment

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

I believe this is not needed and you can just use ./gen_link_flags.exe (or %{bin:gen_link_flags}) in the run command below

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

My first attempt was:

(executable
  (name gen_link_flags)
  (libraries unix fmt stdcompat)
  (modules gen_link_flags))

(rule
 (with-stdout-to link_flags.dune
  (run %{bin:gen_link_flags} %{env:LINK_MODE=dynamic} %{ocaml-config:system})))

But it does not work. It works if I add public_name and package in the executable stanza. I do not want to distribute this script. This is the only workaround I found to call gen_link_flags without shipping it in an opam package. I also add until-clean for this purpose.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Right, %{bin} scope is for installed executable — the following should work with no promotion tho:

(executable
  (name gen_link_flags)
  (libraries unix fmt stdcompat)
  (modules gen_link_flags))

(rule
 (with-stdout-to link_flags.dune
  (run ./gen_link_flags.exe %{env:LINK_MODE=dynamic} %{ocaml-config:system})))

(action
(with-stdout-to link_flags.dune
(run %{gen} %{env:LINK_MODE=dynamic} %{ocaml-config:system}))))

(executable
(name Main_text)
Expand Down
56 changes: 0 additions & 56 deletions src/bin/text/gen-link-flags.sh

This file was deleted.

53 changes: 53 additions & 0 deletions src/bin/text/gen_link_flags.ml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
let pkgconfig lib archive =
let cmd = Fmt.str "pkg-config %s --variable libdir" lib in
let output =
Unix.open_process_in cmd
|> Stdcompat.In_channel.input_line
|> Option.get
in
Fmt.str "%s/%s" output archive

let pp_lib ppf s = Fmt.pf ppf "-cclib %s" s

let () =
let mixed_flags = ["-noautolink"] in
(* Note: for OCaml 5, use -lcamlstrnat and -lunixnat and mind zlib
https://github.com/ocaml/ocaml/issues/12562 *)
let mixed_cclib = [
"-lstdcompat_stubs";
"-lcamlzip";
"-lzarith";
"-lcamlstr";
"-lunix";
"-lz"
]
in
let libs = ["gmp"] in
let link_mode = Sys.argv.(1) and os = Sys.argv.(2) in
let flags, cclib =
match link_mode, os with
| "dynamic", _ -> [], []
| "static", "linux" -> [], ["-static"; "-no-pie"]
| "mixed", "linux" ->
let cclib = mixed_cclib @ List.map (fun s -> "-l" ^ s) libs in
mixed_flags, "-Wl,-Bdynamic" :: "-Wl,-Bstatic" :: cclib
| "mixed", "macosx" ->
let cclib = mixed_cclib @
List.map
(fun lib ->
let archive =
if Stdcompat.String.starts_with
~prefix:"lib" lib then
Fmt.str "%s.a" lib
else
Fmt.str "lib%s.a" lib
in
pkgconfig lib archive
) libs
in
mixed_flags, cclib
| _ -> Fmt.invalid_arg "unsupported mode %s and OS %s" link_mode os
in
Fmt.pr "@[(-linkall %a %a)@]"
Fmt.(list ~sep:sp string) flags
Fmt.(list ~sep:sp pp_lib) cclib;
Loading