Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Fetching contributors…
Cannot retrieve contributors at this time
484 lines (379 sloc) 15.9 KB
(** * Plugin for building Coq via Ocamlbuild *)
open Ocamlbuild_plugin
open Ocamlbuild_pack
open Printf
open Scanf
(** WARNING !! this is preliminary stuff. It should allows you to
build coq and its libraries if everything goes right.
Support for all the build rules and configuration options
is progressively added. Tested only on linux + ocaml 3.11 +
local + natdynlink for now.
./configure -local -opt
./build (which launches ocamlbuild coq.otarget)
Then you can (hopefully) launch bin/coqtop, bin/coqide and so on.
Apart from the links in bin, every created files are in _build.
A "./build clean" should give you back a clean source tree
(** F.A.Q about ocamlbuild:
* P / Px ?
Same, except that the second can be use to signal the main target
of a rule, in order to get a nicer log (otherwise the full command
is used as target name)
(** Generic file reader, which produces a list of strings, one per line *)
let read_file f =
let ic = open_in f and l = ref [] in
(try while true do l := (input_line ic)::!l done with End_of_file -> ());
close_in ic; List.rev !l
(** Configuration *)
(** First, we access indirectly : we symlink it to, which is linked with this *)
module Coq_config = struct include Myocamlbuild_config end
let _ = begin
Options.ocamlc := A Coq_config.ocamlc;
Options.ocamlopt := A Coq_config.ocamlopt;
Options.ocamlmklib := A Coq_config.ocamlmklib;
Options.ocamldep := A Coq_config.ocamldep;
Options.ocamldoc := A Coq_config.ocamldoc;
Options.ocamlyacc := A Coq_config.ocamlyacc;
Options.ocamllex := A Coq_config.ocamllex;
let w32 = Coq_config.arch_is_win32
let w32pref = "i586-mingw32msvc"
let w32ocamlc = w32pref^"-ocamlc"
let w32ocamlopt = w32pref^"-ocamlopt"
let w32ocamlmklib = w32pref^"-ocamlmklib"
let w32res = w32pref^"-windres"
let w32lib = "/usr/"^w32pref^"/lib/"
let w32bin = "/usr/"^w32pref^"/bin/"
let w32ico = "ide/coq_icon.o"
let _ = if w32 then begin
Options.ocamlopt := A w32ocamlopt;
Options.ocamlmklib := A w32ocamlmklib;
let use_camlp5 = (Coq_config.camlp4 = "camlp5")
let camlp4args =
if use_camlp5 then [A "pa_extend.cmo";A "q_MLast.cmo";A "pa_macro.cmo"]
else []
let ocaml = A Coq_config.ocaml
let camlp4o = S ((A Coq_config.camlp4o) :: camlp4args)
let camlp4incl = S[A"-I"; A Coq_config.camlp4lib]
let camlp4compat = Sh Coq_config.camlp4compat
let opt = ( = "opt")
let ide = Coq_config.has_coqide
let hasdynlink = Coq_config.has_natdynlink
let os5fix = (Coq_config.natdynlinkflag = "os5fixme")
let dep_dynlink = if hasdynlink then N else Sh"-natdynlink no"
let lablgtkincl = Sh Coq_config.coqideincl
let local = Coq_config.local
let cflags = S[A"-ccopt";A Coq_config.cflags]
(** Do we want to inspect .ml generated from .ml4 ? *)
let readable_genml = false
let readable_flag = if readable_genml then A"pr_o.cmo" else N
let _build = Options.build_dir
(** Abbreviations about files *)
let core_libs =
["lib/clib"; "lib/lib"; "kernel/kernel"; "library/library";
"engine/engine"; "pretyping/pretyping"; "interp/interp"; "proofs/proofs";
"parsing/parsing"; "printing/printing"; "tactics/tactics";
"stm/stm"; "toplevel/toplevel"; "parsing/highparsing";
let core_cma = (fun s -> s^".cma") core_libs
let core_cmxa = (fun s -> s^".cmxa") core_libs
let core_mllib = (fun s -> s^".mllib") core_libs
let tolink = "tools/"
let c_headers_base =
["coq_fix_code.h";"coq_instruct.h"; "coq_memory.h"; "int64_emul.h";
"coq_gc.h"; "coq_interp.h"; "coq_values.h"; "int64_native.h";
let c_headers = ((^) "kernel/byterun/") c_headers_base
let coqinstrs = "kernel/byterun/coq_instruct.h"
let coqjumps = "kernel/byterun/coq_jumptbl.h"
let copcodes = "kernel/"
let libcoqrun = "kernel/byterun/libcoqrun.a"
let init_vo = "theories/Init/Prelude.vo"
let nmake = "theories/Numbers/Natural/BigN/NMake_gen.v"
let nmakegen = "theories/Numbers/Natural/BigN/"
let adapt_name (pref,oldsuf,newsuf) f =
pref ^ (Filename.chop_suffix f oldsuf) ^ newsuf
let get_names (oldsuf,newsuf) s =
let pref = Filename.dirname s ^ "/" in (adapt_name (pref,oldsuf,newsuf)) (string_list_of_file s)
let get_vo_itargets f =
let vo_itargets = get_names (".otarget",".itarget") f in
List.flatten ( (get_names (".vo",".v")) vo_itargets)
let theoriesv = get_vo_itargets "theories/theories.itarget"
let pluginsv = get_vo_itargets "plugins/pluginsvo.itarget"
let pluginsmllib = get_names (".cma",".mllib") "plugins/pluginsbyte.itarget"
(** for correct execution of coqdep_boot, source files should have
been imported in _build (and NMake_gen.v should have been created). *)
let coqdepdeps = theoriesv @ pluginsv @ pluginsmllib
let coqtop = "toplevel/coqtop"
let coqide = "ide/coqide"
let coqdepboot = "tools/coqdep_boot"
let coqmktop = "tools/coqmktop"
(** The list of binaries to build:
(name of link in bin/, name in _build, install both or only best) *)
type links = Both | Best | BestInPlace | Ide
let all_binaries =
(if w32 then [ "mkwinapp", "tools/mkwinapp", Best ] else []) @
[ "coqtop", coqtop, Both;
"coqide", "ide/coqide_main", Ide;
"coqmktop", coqmktop, Both;
"coqc", "tools/coqc", Both;
"coqchk", "checker/main", Both;
"coqdep_boot", coqdepboot, Best;
"coqdep", "tools/coqdep", Best;
"coqdoc", "tools/coqdoc/main", Best;
"coqwc", "tools/coqwc", Best;
"coq_makefile", "tools/coq_makefile", Best;
"coq-tex", "tools/coq_tex", Best;
"gallina", "tools/gallina", Best;
"csdpcert", "plugins/micromega/csdpcert", BestInPlace;
"fake_ide", "tools/fake_ide", Best;
let best_oext = if opt then ".native" else ".byte"
let best_ext = if opt then ".opt" else ".byte"
let best_iext = if ide = "opt" then ".opt" else ".byte"
let coqtopbest = coqtop^best_oext
(* For inner needs, we rather use the bytecode versions of coqdep
and coqmktop: slightly slower but compile quickly, and ok with
w32 cross-compilation *)
let coqdep_boot = coqdepboot^".byte"
let coqmktop_boot = coqmktop^".byte"
let binariesopt_deps =
let addext b = b ^ ".native" in
let rec deps = function
| [] -> []
| (_,b,Ide)::l -> if ide="opt" then addext b :: deps l else deps l
| (_,b,_)::l -> if opt then addext b :: deps l else deps l
in deps all_binaries
let binariesbyte_deps =
let addext b = b ^ ".byte" in
let rec deps = function
| [] -> []
| (_,b,Ide)::l -> if ide<>"no" then addext b :: deps l else deps l
| (_,b,Both)::l -> addext b :: deps l
| (_,b,_)::l -> if not opt then addext b :: deps l else deps l
in deps all_binaries
let ln_sf toward f =
Command.execute ~quiet:true (Cmd (S [A"ln";A"-sf";P toward;P f]))
let rec make_bin_links = function
| [] -> ()
| (b,ob,kind)::l ->
make_bin_links l;
let obd = "../"^ !_build^"/"^ob and bd = "bin/"^b in
match kind with
| Ide when ide <> "no" ->
ln_sf (obd^".byte") (bd^".byte");
if ide = "opt" then ln_sf (obd^".native") (bd^".opt");
ln_sf (b^best_iext) bd
| Ide (* when ide = "no" *) -> ()
| Both ->
ln_sf (obd^".byte") (bd^".byte");
if opt then ln_sf (obd^".native") (bd^".opt");
ln_sf (b^best_ext) bd
| Best -> ln_sf (obd^best_oext) bd
| BestInPlace -> ln_sf (b^best_oext) (!_build^"/"^ob)
let incl f = Ocaml_utils.ocaml_include_flags f
let cmd cl = (fun _ _ -> (Cmd (S cl)))
let initial_actions () = begin
(** We "pre-create" a few subdirs in _build *)
Shell.mkdir_p (!_build^"/dev");
Shell.mkdir_p (!_build^"/bin");
Shell.mkdir_p (!_build^"/plugins/micromega");
make_bin_links all_binaries;
let extra_rules () = begin
(** Virtual target for building all binaries *)
rule "binariesopt" ~stamp:"binariesopt" ~deps:binariesopt_deps (fun _ _ -> Nop);
rule "binariesbyte" ~stamp:"binariesbyte" ~deps:binariesbyte_deps (fun _ _ -> Nop);
rule "binaries" ~stamp:"binaries" ~deps:["binariesbyte";"binariesopt"] (fun _ _ -> Nop);
(** We create a special coq_config which mentions _build *)
rule "" ~prod:"" ~dep:"config/"
(fun _ _ ->
if w32 then cp "config/" "" else
let lines = read_file "config/" in
let lines = (fun s -> s^"\n") lines in
let line0 = "\n(* Adapted variables for ocamlbuild *)\n" in
(* TODO : line2 isn't completely accurate with respect to ./configure:
the case of -local -vmbyteflags foo isn't supported *)
let line1 =
"let vmbyteflags = [\"-dllib\";\"-lcoqrun\"]\n"
Echo (lines @ (if local then [line0;line1] else []),
(** Camlp4 extensions *)
rule "" ~dep:"%.ml4" ~prod:""
(fun env _ ->
let ml4 = env "%.ml4" and ml = env "" in
Cmd (S[camlp4o;T(tags_of_pathname ml4 ++ "p4mod");readable_flag;
T(tags_of_pathname ml4 ++ "p4option"); camlp4compat;
A"-o"; Px ml; A"-impl"; P ml4]));
flag_and_dep ["p4mod"; "use_grammar"] (P "grammar/grammar.cma");
flag_and_dep ["p4mod"; "use_constr"] (P "grammar/q_constr.cmo");
flag_and_dep ["p4mod"; "use_compat5"] (P "tools/compat5.cmo");
flag_and_dep ["p4mod"; "use_compat5b"] (P "tools/compat5b.cmo");
if w32 then begin
flag ["p4mod"] (A "-DWIN32");
dep ["ocaml"; "link"; "ide"] ["ide/ide_win32_stubs.o"];
if not use_camlp5 then begin
let mlp_cmo s =
let src=s^".mlp" and dst=s^".cmo" in
rule (src^".cmo") ~dep:src ~prod:dst ~insert:`top
(fun env _ ->
Cmd (S [!Options.ocamlc; A"-c"; A"-pp";
Quote (S [camlp4o;A"-impl"]); camlp4incl; A"-impl"; P src]))
mlp_cmo "tools/compat5";
mlp_cmo "tools/compat5b";
(** All caml files are compiled with +camlp4/5
and ide files need +lablgtk2 *)
flag ["compile"; "ocaml"] (S [A"-thread";A"-rectypes"; camlp4incl]);
flag ["link"; "ocaml"] (S [A"-rectypes"; camlp4incl]);
flag ["ocaml"; "ide"; "compile"] lablgtkincl;
flag ["ocaml"; "ide"; "link"] lablgtkincl;
flag ["ocaml"; "ide"; "link"; "byte"]
(S [A"lablgtk.cma"; A"lablgtksourceview2.cma"]);
flag ["ocaml"; "ide"; "link"; "native"]
(S [A"lablgtk.cmxa"; A"lablgtksourceview2.cmxa"]);
(** C code for the VM *)
dep ["compile"; "c"] c_headers;
flag ["compile"; "c"] cflags;
dep ["ocaml"; "use_libcoqrun"; "compile"] [libcoqrun];
dep ["ocaml"; "use_libcoqrun"; "link"; "native"] [libcoqrun];
flag ["ocaml"; "use_libcoqrun"; "link"; "byte"] (Sh Coq_config.vmbyteflags);
(* we need to use a different ocamlc. For now we copy the rule *)
if w32 then
rule ".c.o" ~deps:("%.c"::c_headers) ~prod:"%.o" ~insert:`top
(fun env _ ->
let c = env "%.c" in
let o = env "%.o" in
Seq [Cmd (S [P w32ocamlc;cflags;A"-c";Px c]);
mv (Filename.basename o) o]);
(** VM: Generation of coq_jumbtbl.h and from coq_instruct.h *)
rule "coqinstrs" ~dep:coqinstrs ~prods:[coqjumps;copcodes]
(fun _ _ ->
let jmps = ref [] and ops = ref [] and i = ref 0 in
let add_instr instr comma =
if instr = "" then failwith "Empty" else begin
jmps:=sprintf "&&coq_lbl_%s%s \n" instr comma :: !jmps;
ops:=sprintf "let op%s = %d\n" instr !i :: !ops;
incr i
(** we recognize comma-separated uppercase instruction names *)
let parse_line s =
let b = Scanning.from_string s in
try while true do bscanf b " %[A-Z0-9_]%[,]" add_instr done
with _ -> ()
List.iter parse_line (read_file coqinstrs);
Seq [Echo (List.rev !jmps, coqjumps);
Echo (List.rev !ops, copcodes)]);
(** Generation of *)
rule tolink ~deps:core_mllib ~prod:tolink
(fun _ _ ->
let cat s = String.concat " " (string_list_of_file s) in
let core_mods = String.concat " " ( cat core_mllib) in
let core_cmas = String.concat " " core_cma in
Echo (["let copts = \"-cclib -lcoqrun\"\n";
"let core_libs = \""^core_cmas^"\"\n";
"let core_objs = \""^core_mods^"\"\n"],
(** For windows, building coff object file from a .rc (for the icon) *)
if w32 then rule ".rc.o" ~deps:["%.rc";"ide/coq.ico"] ~prod:"%.o"
(fun env _ ->
let rc = env "%.rc" and o = env "%.o" in
Cmd (S [P w32res;A "--input-format";A "rc";A "--input";P rc;
A "--output-format";A "coff";A "--output"; Px o]));
(** The windows version of Coqide is now a console-free win32 app,
which moreover contains the Coq icon. If necessary, the mkwinapp
tool can be used later to restore or suppress the console of Coqide. *)
if w32 then dep ["link"; "ocaml"; "program"; "ide"] [w32ico];
if w32 then flag ["link"; "ocaml"; "program"; "ide"]
(S [A "-ccopt"; A "-link -Wl,-subsystem,windows"; P w32ico]);
(** Coqtop *)
let () =
let fo = coqtop^".native" and fb = coqtop^".byte" in
let depsall = (if w32 then [w32ico] else [])@[coqmktop_boot;libcoqrun] in
let depso = core_cmxa in
let depsb = core_cma in
let w32flag =
if not w32 then N else S ([A"-camlbin";A w32bin;A "-ccopt";P w32ico])
if opt then rule fo ~prod:fo ~deps:(depsall@depso) ~insert:`top
(cmd [P coqmktop_boot;w32flag;A"-boot";A"-opt";incl fo;A"-thread";camlp4incl;A"-o";Px fo]);
rule fb ~prod:fb ~deps:(depsall@depsb) ~insert:`top
(cmd [P coqmktop_boot;w32flag;A"-boot";A"-top";incl fb;A"-thread";camlp4incl;A"-o";Px fb]);
(** Coq files dependencies *)
rule "coqdepready" ~stamp:"coqdepready" ~deps:coqdepdeps (fun _ _ -> Nop);
rule ".v.d" ~prod:"%.v.depends" ~deps:["%.v";coqdep_boot;"coqdepready"]
(fun env _ ->
let v = env "%.v" and vd = env "%.v.depends" in
(** NB: this relies on all .v files being already in _build. *)
Cmd (S [P coqdep_boot;dep_dynlink;P v;Sh">";Px vd]));
(** Coq files compilation *)
let coq_build_dep f build =
(** NB: this relies on coqdep producing a single Makefile line
for one .v file, with some specific shape "f.vo ...: f.v deps.vo ..." *)
let src = f^".v" in
let depends = f^".v.depends" in
let rec get_deps keep = function
| [] -> []
| d::deps when d = src -> get_deps keep deps
| d::deps when keep -> [d] :: get_deps keep deps
| d::deps -> get_deps (String.contains d ':') deps
let d = get_deps false (string_list_of_file depends) in
List.iter Outcome.ignore_good (build d)
let coq_v_rule d init =
let bootflag = if init then A"-noinit" else N in
let gendep = if init then coqtopbest else init_vo in
rule (d^".v.vo")
~prods:[d^"%.vo";d^"%.glob"] ~deps:[gendep;d^"%.v";d^"%.v.depends"]
(fun env build ->
let f = env (d^"%") in
coq_build_dep f build;
Cmd (S [P coqtopbest;A"-boot";bootflag;A"-compile";Px f]))
coq_v_rule "theories/Init/" true;
coq_v_rule "" false;
(** Generation of files *)
rule "" ~prod:"" ~dep:"%_plugin.mllib"
(fun env _ ->
let line s = "let _ = Mltop.add_known_module \""^s^"\"\n" in
let mods =
string_list_of_file (env "%_plugin.mllib") @
[Filename.basename (env "%_plugin")]
Echo ( line mods, env ""));
(** Rule for native dynlinkable plugins *)
rule ".cmxa.cmxs" ~prod:"%.cmxs" ~dep:"%.cmxa"
(fun env _ ->
let cmxs = Px (env "%.cmxs") and cmxa = P (env "%.cmxa") in
if os5fix then
Cmd (S [A"../dev/"; !Options.ocamlopt; cmxs])
Cmd (S [!Options.ocamlopt;A"-linkall";A"-shared";A"-o";cmxs;cmxa]));
(** Generation of NMake.v from *)
rule "NMake" ~prod:nmake ~dep:nmakegen
(cmd [ocaml;P nmakegen;Sh ">";Px nmake]);
(** Registration of our rules (after the standard ones) *)
let _ = dispatch begin function
| After_rules -> initial_actions (); extra_rules ()
| _ -> ()
(** TODO / Remarques:
* Apres un premier build, le second prend du temps, meme cached:
1 min 25 pour les 2662 targets en cache. Etonnement, refaire
coqtop.byte ne prend que ~4s, au lieu des ~40s pour coqtop.opt.
A comprendre ...
* Parallelisation: vraiment pas top
Jump to Line
Something went wrong with that request. Please try again.