/
build.d
executable file
·1749 lines (1531 loc) · 55.6 KB
/
build.d
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env rdmd
/**
DMD builder
Usage:
./build.d dmd
detab, tolf, install targets - require the D Language Tools (detab.exe, tolf.exe)
https://github.com/dlang/tools.
zip target - requires Info-ZIP or equivalent (zip32.exe)
http://www.info-zip.org/Zip.html#Downloads
TODO:
- add all posix.mak Makefile targets
- support 32-bit builds
- test the script with LDC or GDC as host compiler
*/
version(CoreDdoc) {} else:
import std.algorithm, std.conv, std.datetime, std.exception, std.file, std.format, std.functional,
std.getopt, std.parallelism, std.path, std.process, std.range, std.stdio, std.string, std.traits;
const thisBuildScript = __FILE_FULL_PATH__.buildNormalizedPath;
const srcDir = thisBuildScript.dirName;
const dmdRepo = srcDir.dirName;
shared bool verbose; // output verbose logging
shared bool force; // always build everything (ignores timestamp checking)
shared bool dryRun; /// dont execute targets, just print command to be executed
__gshared string[string] env;
__gshared string[][string] flags;
__gshared typeof(sourceFiles()) sources;
/// Array of build rules through which all other build rules can be reached
immutable rootRules = [
&dmdDefault,
&autoTesterBuild,
&runDmdUnittest,
&clean,
&checkwhitespace,
&runCxxUnittest,
&detab,
&tolf,
&zip,
&html,
&toolchainInfo,
&style,
&man,
&installCopy,
];
int main(string[] args)
{
try
{
runMain(args);
return 0;
}
catch (BuildException e)
{
writeln(e.msg);
return 1;
}
}
void runMain(string[] args)
{
int jobs = totalCPUs;
bool calledFromMake = false;
auto res = getopt(args,
"j|jobs", "Specifies the number of jobs (commands) to run simultaneously (default: %d)".format(totalCPUs), &jobs,
"v|verbose", "Verbose command output", (cast(bool*) &verbose),
"f|force", "Force run (ignore timestamps and always run all tests)", (cast(bool*) &force),
"d|dry-run", "Print commands instead of executing them", (cast(bool*) &dryRun),
"called-from-make", "Calling the build script from the Makefile", &calledFromMake
);
void showHelp()
{
defaultGetoptPrinter(`./build.d <targets>...
Examples
--------
./build.d dmd # build DMD
./build.d unittest # runs internal unittests
./build.d clean # remove all generated files
./build.d generated/linux/release/64/dmd.conf
Important variables:
--------------------
HOST_DMD: Host D compiler to use for bootstrapping
AUTO_BOOTSTRAP: Enable auto-boostrapping by downloading a stable DMD binary
MODEL: Target architecture to build for (32,64) - defaults to the host architecture
Build modes:
------------
BUILD: release (default) | debug (enabled a build with debug instructions)
Opt-in build features:
ENABLE_RELEASE: Optimized release built
ENABLE_DEBUG: Add debug instructions and symbols (set if ENABLE_RELEASE isn't set)
ENABLE_LTO: Enable link-time optimizations
ENABLE_UNITTEST: Build dmd with unittests (sets ENABLE_COVERAGE=1)
ENABLE_PROFILE: Build dmd with a profiling recorder (D)
ENABLE_COVERAGE Build dmd with coverage counting
ENABLE_SANITIZERS Build dmd with sanitizer (e.g. ENABLE_SANITIZERS=address,undefined)
Targets
-------
` ~ targetsHelp ~ `
The generated files will be in generated/$(OS)/$(BUILD)/$(MODEL) (` ~ env["G"] ~ `)
Command-line parameters
-----------------------
`, res.options);
return;
}
// parse arguments
args.popFront;
args2Environment(args);
parseEnvironment;
processEnvironment;
processEnvironmentCxx;
sources = sourceFiles;
if (res.helpWanted)
return showHelp;
// default target
if (!args.length)
args = ["dmd"];
auto targets = predefinedTargets(args); // preprocess
if (targets.length == 0)
return showHelp;
if (verbose)
{
log("================================================================================");
foreach (key, value; env)
log("%s=%s", key, value);
log("================================================================================");
}
{
File lockFile;
if (calledFromMake)
{
// If called from make, use an interprocess lock so that parallel builds don't stomp on each other
lockFile = File(env["GENERATED"].buildPath("build.lock"), "w");
lockFile.lock();
}
scope (exit)
{
if (calledFromMake)
{
lockFile.unlock();
lockFile.close();
}
}
foreach (target; targets.parallel(1))
target.run();
}
writeln("Success");
}
/// Generate list of targets for use in the help message
string targetsHelp()
{
string result = "";
foreach (rule; BuildRuleRange(rootRules.map!(a => a()).array))
{
if (rule.name)
{
enum defaultPrefix = "\n ";
result ~= rule.name;
string prefix = defaultPrefix[1 + rule.name.length .. $];
void add(string msg)
{
result ~= format("%s%s", prefix, msg);
prefix = defaultPrefix;
}
if (rule.description)
add(rule.description);
else if (rule.targets)
{
foreach (target; rule.targets)
{
add(target.relativePath);
}
}
result ~= "\n";
}
}
return result;
}
/**
D build rules
====================
The strategy of this script is to emulate what the Makefile is doing.
Below all individual rules of DMD are defined.
They have a target path, sources paths and an optional name.
When a rule is needed either its command or custom commandFunction is executed.
A rule will be skipped if all targets are older than all sources.
This script is by default part of the sources and thus any change to the build script,
will trigger a full rebuild.
*/
/// Returns: The rule that runs the autotester build
alias autoTesterBuild = makeRule!((builder, rule) {
builder
.name("auto-tester-build")
.description("Run the autotester build")
.deps([toolchainInfo, dmdDefault, checkwhitespace]);
version (Posix)
rule.deps ~= runCxxUnittest;
// unittests are currently not executed as part of `auto-tester-test` on windows
// because changes to `win32.mak` require additional changes on the autotester
// (see https://github.com/dlang/dmd/pull/7414).
// This requires no further actions and avoids building druntime+phobos on unittest failure
version (Windows)
rule.deps ~= runDmdUnittest;
});
/// Returns: the rule that builds the lexer object file
alias lexer = makeRule!((builder, rule) => builder
.name("lexer")
.target(env["G"].buildPath("lexer").objName)
.sources(sources.lexer)
.deps([versionFile, sysconfDirFile])
.msg("(DC) LEXER_OBJ")
.command([env["HOST_DMD_RUN"],
"-c",
"-of" ~ rule.target,
"-vtls"]
.chain(flags["DFLAGS"],
// source files need to have relative paths in order for the code coverage
// .lst files to be named properly for CodeCov to find them
rule.sources.map!(e => e.relativePath(srcDir))
).array
)
);
/// Returns: the rule that generates the dmd.conf file in the output folder
alias dmdConf = makeRule!((builder, rule) {
// TODO: add support for Windows
string exportDynamic;
version(OSX) {} else
exportDynamic = " -L--export-dynamic";
auto conf = `[Environment32]
DFLAGS=-I%@P%/../../../../../druntime/import -I%@P%/../../../../../phobos -L-L%@P%/../../../../../phobos/generated/{OS}/{BUILD}/32{exportDynamic}
[Environment64]
DFLAGS=-I%@P%/../../../../../druntime/import -I%@P%/../../../../../phobos -L-L%@P%/../../../../../phobos/generated/{OS}/{BUILD}/64{exportDynamic} -fPIC`
.replace("{exportDynamic}", exportDynamic)
.replace("{BUILD}", env["BUILD"])
.replace("{OS}", env["OS"]);
builder
.name("dmdconf")
.target(env["G"].buildPath("dmd.conf"))
.msg("(TX) DMD_CONF")
.commandFunction(() {
conf.toFile(rule.target);
});
});
/// Returns: the rule that builds the backend object file
alias backend = makeRule!((builder, rule) => builder
.name("backend")
.target(env["G"].buildPath("backend").objName)
.sources(sources.backend)
.msg("(DC) BACKEND_OBJ")
.command([
env["HOST_DMD_RUN"],
"-c",
"-of" ~ rule.target,
"-betterC"]
.chain(flags["DFLAGS"], rule.sources).array)
);
/// Returns: the rules that generate required string files: VERSION and SYSCONFDIR.imp
alias versionFile = makeRule!((builder, rule) {
alias contents = memoize!(() {
if (dmdRepo.buildPath(".git").exists)
{
try
{
auto gitResult = [env["GIT"], "describe", "--dirty"].tryRun;
if (gitResult.status == 0)
return gitResult.output.strip;
}
catch (ProcessException)
{
// git not installed
}
}
// version fallback
return dmdRepo.buildPath("VERSION").readText;
});
builder
.target(env["G"].buildPath("VERSION"))
.condition(() => !rule.target.exists || rule.target.readText != contents)
.msg("(TX) VERSION")
.commandFunction(() => std.file.write(rule.target, contents));
});
alias sysconfDirFile = makeRule!((builder, rule) => builder
.target(env["G"].buildPath("SYSCONFDIR.imp"))
.condition(() => !rule.target.exists || rule.target.readText != env["SYSCONFDIR"])
.msg("(TX) SYSCONFDIR")
.commandFunction(() => std.file.write(rule.target, env["SYSCONFDIR"]))
);
/// BuildRule to create a directory if it doesn't exist.
alias directoryRule = makeRuleWithArgs!((MethodInitializer!BuildRule builder, BuildRule rule, string dir) => builder
.target(dir)
.condition(() => !exists(dir))
.msg("mkdirRecurse '%s'".format(dir))
.commandFunction(() => mkdirRecurse(dir))
);
/**
BuildRule for the DMD executable.
Params:
extra_flags = Flags to apply to the main build but not the rules
*/
alias dmdExe = makeRuleWithArgs!((MethodInitializer!BuildRule builder, BuildRule rule, string targetSuffix, string[] extraFlags) {
const dmdSources = sources.dmd.all.chain(sources.root).array;
string[] platformArgs;
version (Windows)
platformArgs = ["-L/STACK:8388608"];
builder
// include lexer.o and backend.o
.sources(dmdSources.chain(lexer.targets, backend.targets).array)
.target(env["DMD_PATH"] ~ targetSuffix)
.msg("(DC) DMD" ~ targetSuffix)
.deps([versionFile, sysconfDirFile, lexer, backend])
.command([
env["HOST_DMD_RUN"],
"-of" ~ rule.target,
"-vtls",
"-J" ~ env["RES"],
].chain(extraFlags, platformArgs, flags["DFLAGS"],
// source files need to have relative paths in order for the code coverage
// .lst files to be named properly for CodeCov to find them
rule.sources.map!(e => e.relativePath(srcDir))
).array);
});
alias dmdDefault = makeRule!((builder, rule) => builder
.name("dmd")
.description("Build dmd")
.deps([dmdExe(null, null), dmdConf])
);
/// BuildRule to run the DMD unittest executable.
alias runDmdUnittest = makeRule!((builder, rule) {
auto dmdUnittestExe = dmdExe("-unittest", ["-version=NoMain", "-unittest", "-main"]);
builder
.name("unittest")
.description("Run the dmd unittests")
.msg("(RUN) DMD-UNITTEST")
.deps([dmdUnittestExe])
.command(dmdUnittestExe.targets);
});
/// Runs the C++ unittest executable
alias runCxxUnittest = makeRule!((runCxxBuilder, runCxxRule) {
/// Compiles the C++ frontend test files
alias cxxFrontend = methodInit!(BuildRule, (frontendBuilder, frontendRule) => frontendBuilder
.name("cxx-frontend")
.description("Build the C++ frontend")
.msg("(CXX) CXX-FRONTEND")
.sources(srcDir.buildPath("tests", "cxxfrontend.c") ~ .sources.frontendHeaders ~ .sources.dmd.all ~ .sources.root)
.target(env["G"].buildPath("cxxfrontend").objName)
.command([ env["CXX"], "-c", frontendRule.sources[0], "-o" ~ frontendRule.target, "-I" ~ env["D"] ] ~ flags["CXXFLAGS"])
);
alias cxxUnittestExe = methodInit!(BuildRule, (exeBuilder, exeRule) => exeBuilder
.name("cxx-unittest")
.description("Build the C++ unittests")
.msg("(DMD) CXX-UNITTEST")
.deps([lexer, backend, cxxFrontend])
.sources(sources.dmd.all ~ sources.root)
.target(env["G"].buildPath("cxx-unittest").exeName)
.command([ env["HOST_DMD_RUN"], "-of=" ~ exeRule.target, "-vtls", "-J" ~ env["RES"],
"-L-lstdc++", "-version=NoMain"
].chain(
flags["DFLAGS"], exeRule.sources, exeRule.deps.map!(d => d.target)
).array)
);
runCxxBuilder
.name("cxx-unittest")
.description("Run the C++ unittests")
.msg("(RUN) CXX-UNITTEST");
version (Windows) runCxxBuilder
.commandFunction({ abortBuild("Running the C++ unittests is not supported on Windows yet"); });
else runCxxBuilder
.deps([cxxUnittestExe])
.command([cxxUnittestExe.target]);
});
/// BuildRule that removes all generated files
alias clean = makeRule!((builder, rule) => builder
.name("clean")
.description("Remove the generated directory")
.msg("(RM) " ~ env["G"])
.commandFunction(delegate() {
if (env["G"].exists)
env["G"].rmdirRecurse;
})
);
alias toolsRepo = makeRule!((builder, rule) => builder
.target(env["TOOLS_DIR"])
.msg("(GIT) DLANG/TOOLS")
.condition(() => !exists(rule.target))
.commandFunction(delegate() {
auto toolsDir = env["TOOLS_DIR"];
version(Win32)
// Win32-git seems to confuse C:\... as a relative path
toolsDir = toolsDir.relativePath(srcDir);
run([env["GIT"], "clone", "--depth=1", env["GIT_HOME"] ~ "/tools", toolsDir]);
})
);
alias checkwhitespace = makeRule!((builder, rule) => builder
.name("checkwhitespace")
.description("Check for trailing whitespace and tabs")
.msg("(RUN) checkwhitespace")
.deps([toolsRepo])
.sources(allRepoSources)
.commandFunction(delegate() {
const cmdPrefix = [env["HOST_DMD_RUN"], "-run", env["TOOLS_DIR"].buildPath("checkwhitespace.d")];
auto chunkLength = allRepoSources.length;
version (Win32)
chunkLength = 80; // avoid command-line limit on win32
foreach (nextSources; allRepoSources.chunks(chunkLength).parallel(1))
{
const nextCommand = cmdPrefix ~ nextSources;
run(nextCommand);
}
})
);
alias style = makeRule!((builder, rule)
{
const dscannerDir = env["G"].buildPath("dscanner");
alias dscanner = methodInit!(BuildRule, (dscannerBuilder, dscannerRule) => dscannerBuilder
.name("dscanner")
.description("Build custom DScanner")
.msg("(GIT,MAKE) DScanner")
.target(dscannerDir.buildPath("dsc".exeName))
.commandFunction(()
{
const git = env["GIT"];
// FIXME: Omitted --shallow-submodules because it errors for libdparse
run([git, "clone", "--depth=1", "--recurse-submodules", "--branch=v0.7.2",
"https://github.com/dlang-community/Dscanner", dscannerDir]);
// debug build is faster but disable trace output
run([env.get("MAKE", "make"), "-C", dscannerDir, "debug",
"DEBUG_VERSIONS=-version=StdLoggerDisableWarning"]);
})
);
builder
.name("style")
.description("Check for style errors using D-Scanner")
.msg("(DSCANNER) dmd")
.deps([dscanner])
// Disabled because we need to build a patched dscanner version
// .command([
// "dub", "-q", "run", "-y", "dscanner", "--", "--styleCheck", "--config",
// srcDir.buildPath(".dscanner.ini"), srcDir.buildPath("dmd"), "-I" ~ srcDir
// ])
.command([
dscanner.target, "--styleCheck", "--config", srcDir.buildPath(".dscanner.ini"),
srcDir.buildPath("dmd"), "-I" ~ srcDir
]);
});
/// BuildRule to generate man pages
alias man = makeRule!((builder, rule) {
alias genMan = methodInit!(BuildRule, (genManBuilder, genManRule) => genManBuilder
.target(env["G"].buildPath("gen_man"))
.sources([
dmdRepo.buildPath("docs", "gen_man.d"),
env["D"].buildPath("cli.d")])
.command([
env["HOST_DMD_RUN"],
"-I" ~ srcDir,
"-of" ~ genManRule.target]
~ flags["DFLAGS"]
~ genManRule.sources)
.msg(genManRule.command.join(" "))
);
const genManDir = env["GENERATED"].buildPath("docs", "man");
alias dmdMan = methodInit!(BuildRule, (dmdManBuilder, dmdManRule) => dmdManBuilder
.target(genManDir.buildPath("man1", "dmd.1"))
.deps([genMan, directoryRule(dmdManRule.target.dirName)])
.msg("(GEN_MAN) " ~ dmdManRule.target)
.commandFunction(() {
std.file.write(dmdManRule.target, genMan.target.execute.output);
})
);
builder
.name("man")
.description("Generate and prepare man files")
.deps([dmdMan].chain(
"man1/dumpobj.1 man1/obj2asm.1 man5/dmd.conf.5".split
.map!(e => methodInit!(BuildRule, (manFileBuilder, manFileRule) => manFileBuilder
.target(genManDir.buildPath(e))
.sources([dmdRepo.buildPath("docs", "man", e)])
.deps([directoryRule(manFileRule.target.dirName)])
.commandFunction(() => copyAndTouch(manFileRule.sources[0], manFileRule.target))
.msg("copy '%s' to '%s'".format(manFileRule.sources[0], manFileRule.target))
))
).array);
});
alias detab = makeRule!((builder, rule) => builder
.name("detab")
.description("Replace hard tabs with spaces")
.command([env["DETAB"]] ~ allRepoSources)
.msg("(DETAB) DMD")
);
alias tolf = makeRule!((builder, rule) => builder
.name("tolf")
.description("Convert to Unix line endings")
.command([env["TOLF"]] ~ allRepoSources)
.msg("(TOLF) DMD")
);
alias zip = makeRule!((builder, rule) => builder
.name("zip")
.target(srcDir.buildPath("dmdsrc.zip"))
.description("Archive all source files")
.sources(allBuildSources)
.msg("ZIP " ~ rule.target)
.commandFunction(() {
if (exists(rule.target))
remove(rule.target);
run([env["ZIP"], rule.target, thisBuildScript] ~ rule.sources);
})
);
alias html = makeRule!((htmlBuilder, htmlRule) {
htmlBuilder
.name("html")
.description("Generate html docs, requires DMD and STDDOC to be set");
static string d2html(string sourceFile)
{
const ext = sourceFile.extension();
assert(ext == ".d" || ext == ".di", sourceFile);
const htmlFilePrefix = (sourceFile.baseName == "package.d") ?
sourceFile[0 .. $ - "package.d".length - 1] :
sourceFile[0 .. $ - ext.length];
return htmlFilePrefix ~ ".html";
}
const stddocs = env.get("STDDOC", "").split();
auto docSources = .sources.root ~ .sources.lexer ~ .sources.dmd.all ~ env["D"].buildPath("frontend.d");
htmlBuilder.deps(docSources.chunks(1).map!(sourceArray =>
methodInit!(BuildRule, (docBuilder, docRule) {
const source = sourceArray[0];
docBuilder
.sources(sourceArray)
.target(env["DOC_OUTPUT_DIR"].buildPath(d2html(source)[srcDir.length + 1..$]
.replace(dirSeparator, "_")))
.deps([dmdDefault, versionFile, sysconfDirFile])
.command([
dmdDefault.deps[0].target,
"-o-",
"-c",
"-Dd" ~ env["DOCSRC"],
"-J" ~ env["RES"],
"-I" ~ env["D"],
srcDir.buildPath("project.ddoc")
] ~ stddocs ~ [
"-Df" ~ docRule.target,
// Need to use a short relative path to make sure ddoc links are correct
source.relativePath(runDir)
] ~ flags["DFLAGS"])
.msg("(DDOC) " ~ source);
})
).array);
});
alias toolchainInfo = makeRule!((builder, rule) => builder
.name("toolchain-info")
.description("Show informations about used tools")
.commandFunction(() {
scope Appender!(char[]) app;
void show(string what, string[] cmd)
{
string output;
try
output = tryRun(cmd).output;
catch (ProcessException)
output = "<Not available>";
app.formattedWrite("%s (%s): %s\n", what, cmd[0], output);
}
app.put("==== Toolchain Information ====\n");
version (Windows)
show("SYSTEM", ["systeminfo"]);
else
show("SYSTEM", ["uname", "-a"]);
show("MAKE", [env.get("MAKE", "make"), "--version"]);
version (Posix)
show("SHELL", [env.get("SHELL", nativeShell), "--version"]); // cmd.exe --version hangs
show("HOST_DMD", [env["HOST_DMD_RUN"], "--version"]);
version (Posix)
show("HOST_CXX", [env["CXX"], "--version"]);
show("ld", ["ld", "-v"]);
show("gdb", ["gdb", "--version"]);
app.put("==== Toolchain Information ====\n\n");
writeln(app.data);
})
);
alias installCopy = makeRule!((builder, rule) => builder
.name("install-copy")
.description("Legacy alias for install")
.deps([install])
);
alias install = makeRule!((builder, rule) {
const dmdExeFile = dmdDefault.deps[0].target;
auto sourceFiles = allBuildSources ~ [
env["D"].buildPath("readme.txt"),
env["D"].buildPath("boostlicense.txt"),
];
builder
.name("install")
.description("Installs dmd into $(INSTALL)")
.deps([dmdDefault])
.sources(sourceFiles)
.commandFunction(() {
version (Windows)
{
enum conf = "sc.ini";
enum bin = "bin";
}
else
{
enum conf = "dmd.conf";
version (OSX)
enum bin = "bin";
else
const bin = "bin" ~ env["MODEL"];
}
installRelativeFiles(env["INSTALL"].buildPath(env["OS"], bin), dmdExeFile.dirName, dmdExeFile.only);
version (Windows)
installRelativeFiles(env["INSTALL"], dmdRepo, sourceFiles);
const scPath = buildPath(env["OS"], bin, conf);
copyAndTouch(buildPath(dmdRepo, "ini", scPath), buildPath(env["INSTALL"], scPath));
version (Posix)
copyAndTouch(sourceFiles[$-1], env["INSTALL"].buildPath("dmd-boostlicense.txt"));
});
});
/**
Goes through the target list and replaces short-hand targets with their expanded version.
Special targets:
- clean -> removes generated directory + immediately stops the builder
Params:
targets = the target list to process
Returns:
the expanded targets
*/
BuildRule[] predefinedTargets(string[] targets)
{
import std.functional : toDelegate;
Appender!(BuildRule[]) newTargets;
LtargetsLoop:
foreach (t; targets)
{
t = t.buildNormalizedPath; // remove trailing slashes
// check if `t` matches any rule names first
foreach (rule; BuildRuleRange(rootRules.map!(a => a()).array))
{
if (t == rule.name)
{
newTargets.put(rule);
continue LtargetsLoop;
}
}
switch (t)
{
case "all":
t = "dmd";
goto default;
default:
// check this last, target paths should be checked after predefined names
const tAbsolute = t.absolutePath.buildNormalizedPath;
foreach (rule; BuildRuleRange(rootRules.map!(a => a()).array))
{
foreach (ruleTarget; rule.targets)
{
if (ruleTarget.endsWith(t, tAbsolute))
{
newTargets.put(rule);
continue LtargetsLoop;
}
}
}
abortBuild("Target `" ~ t ~ "` is unknown.");
}
}
return newTargets.data;
}
/// An input range for a recursive set of rules
struct BuildRuleRange
{
private BuildRule[] next;
private bool[BuildRule] added;
this(BuildRule[] rules) { addRules(rules); }
bool empty() const { return next.length == 0; }
auto front() inout { return next[0]; }
void popFront()
{
auto save = next[0];
next = next[1 .. $];
addRules(save.deps);
}
void addRules(BuildRule[] rules)
{
foreach (rule; rules)
{
if (!added.get(rule, false))
{
next ~= rule;
added[rule] = true;
}
}
}
}
/// Sets the environment variables
void parseEnvironment()
{
if (!verbose)
verbose = "1" == env.getDefault("VERBOSE", null);
// This block is temporary until we can remove the windows make files
{
const ddebug = env.get("DDEBUG", null);
if (ddebug.length)
{
writefln("WARNING: the DDEBUG variable is deprecated");
if (ddebug == "-debug -g -unittest -cov")
{
environment["ENABLE_DEBUG"] = "1";
environment["ENABLE_UNITTEST"] = "1";
environment["ENABLE_COVERAGE"] = "1";
}
else if (ddebug == "-debug -g -unittest")
{
environment["ENABLE_DEBUG"] = "1";
environment["ENABLE_UNITTEST"] = "1";
}
else
{
abortBuild("DDEBUG is not an expected value: " ~ ddebug);
}
}
}
version (Windows)
{
// On windows, the OS environment variable is already being used by the system.
// For example, on a default Windows7 system it's configured by the system
// to be "Windows_NT".
//
// However, there are a good number of components in this repo and the other
// repos that set this environment variable to "windows" without checking whether
// it's already configured, i.e.
// dmd\src\win32.mak (OS=windows)
// druntime\win32.mak (OS=windows)
// phobos\win32.mak (OS=windows)
//
// It's necessary to emulate the same behavior in this tool in order to make this
// new tool compatible with existing tools. We can do this by also setting the
// environment variable to "windows" whether or not it already has a value.
//
const os = env["OS"] = "windows";
}
else
const os = env.getDefault("OS", detectOS);
auto build = env.getDefault("BUILD", "release");
enforce(build.among("release", "debug"), "BUILD must be 'debug' or 'release'");
if (build == "debug")
env.getDefault("ENABLE_DEBUG", "1");
// detect Model
auto model = env.getDefault("MODEL", detectModel);
env["MODEL_FLAG"] = "-m" ~ env["MODEL"];
// detect PIC
version(Posix)
{
// default to PIC on x86_64, use PIC=1/0 to en-/disable PIC.
// Note that shared libraries and C files are always compiled with PIC.
bool pic;
version(X86_64)
pic = true;
else version(X86)
pic = false;
if (env.getNumberedBool("PIC"))
pic = true;
env["PIC_FLAG"] = pic ? "-fPIC" : "";
}
else
{
env["PIC_FLAG"] = "";
}
env.getDefault("GIT", "git");
env.getDefault("GIT_HOME", "https://github.com/dlang");
env.getDefault("SYSCONFDIR", "/etc");
env.getDefault("TMP", tempDir);
env.getDefault("RES", dmdRepo.buildPath("res"));
version (Windows)
enum installPref = "";
else
enum installPref = "..";
env.getDefault("INSTALL", environment.get("INSTALL_DIR", dmdRepo.buildPath(installPref, "install")));
env.getDefault("DOCSRC", dmdRepo.buildPath("dlang.org"));
if (env.get("DOCDIR", null).length == 0)
env["DOCDIR"] = srcDir;
env.getDefault("DOC_OUTPUT_DIR", env["DOCDIR"]);
auto d = env["D"] = srcDir.buildPath("dmd");
env["C"] = d.buildPath("backend");
env["ROOT"] = d.buildPath("root");
env["EX"] = srcDir.buildPath("examples");
auto generated = env["GENERATED"] = dmdRepo.buildPath("generated");
auto g = env["G"] = generated.buildPath(os, build, model);
mkdirRecurse(g);
env.getDefault("TOOLS_DIR", dmdRepo.dirName.buildPath("tools"));
if (env.get("HOST_DMD", null).length == 0)
{
const hostDmd = env.get("HOST_DC", null);
env["HOST_DMD"] = hostDmd.length ? hostDmd : "dmd";
}
// Auto-bootstrapping of a specific host compiler
if (env.getNumberedBool("AUTO_BOOTSTRAP"))
{
auto hostDMDVer = env.getDefault("HOST_DMD_VER", "2.088.0");
writefln("Using Bootstrap compiler: %s", hostDMDVer);
auto hostDMDRoot = env["G"].buildPath("host_dmd-"~hostDMDVer);
auto hostDMDBase = hostDMDVer~"."~os;
auto hostDMDURL = "http://downloads.dlang.org/releases/2.x/"~hostDMDVer~"/dmd."~hostDMDBase;
env["HOST_DMD"] = hostDMDRoot.buildPath("dmd2", os, os == "osx" ? "bin" : "bin"~model, "dmd");
env["HOST_DMD_PATH"] = env["HOST_DMD"];
// TODO: use dmd.conf from the host too (in case there's a global or user-level dmd.conf)
env["HOST_DMD_RUN"] = env["HOST_DMD"];
if (!env["HOST_DMD"].exists)
{
writefln("Downloading DMD %s", hostDMDVer);
auto curlFlags = "-fsSL --retry 5 --retry-max-time 120 --connect-timeout 5 --speed-time 30 --speed-limit 1024";
hostDMDRoot.mkdirRecurse;
("curl " ~ curlFlags ~ " " ~ hostDMDURL~".tar.xz | tar -C "~hostDMDRoot~" -Jxf - || rm -rf "~hostDMDRoot).spawnShell.wait;
}
}
else
{
env["HOST_DMD_PATH"] = getHostDMDPath(env["HOST_DMD"]).strip.absolutePath;
env["HOST_DMD_RUN"] = env["HOST_DMD_PATH"];
}
if (!env["HOST_DMD_PATH"].exists)
{
abortBuild("No DMD compiler is installed. Try AUTO_BOOTSTRAP=1 or manually set the D host compiler with HOST_DMD");
}
}
/// Checks the environment variables and flags
void processEnvironment()
{
import std.meta : AliasSeq;
const os = env["OS"];
const hostDMDVersion = [env["HOST_DMD_RUN"], "--version"].execute.output;
alias DMD = AliasSeq!("DMD");
alias LDC = AliasSeq!("LDC");
alias GDC = AliasSeq!("GDC", "gdmd", "gdc");
const kindIdx = hostDMDVersion.canFind(DMD, LDC, GDC);
enforce(kindIdx, "Invalid Host DMD found: " ~ hostDMDVersion);
if (kindIdx <= DMD.length)
env["HOST_DMD_KIND"] = "dmd";
else if (kindIdx <= LDC.length + DMD.length)
env["HOST_DMD_KIND"] = "ldc";
else
env["HOST_DMD_KIND"] = "gdc";
env["DMD_PATH"] = env["G"].buildPath("dmd").exeName;
env.getDefault("DETAB", "detab");
env.getDefault("TOLF", "tolf");
version (Windows)
env.getDefault("ZIP", "zip32");
else
env.getDefault("ZIP", "zip");
// TODO: this isn't being used for anything yet...
env.getNumberedBool("ENABLE_WARNINGS");
string[] warnings;
string[] dflags = ["-version=MARS", "-w", "-de", env["PIC_FLAG"], env["MODEL_FLAG"], "-J"~env["G"]];
if (env["HOST_DMD_KIND"] != "gdc")
dflags ~= ["-dip25"]; // gdmd doesn't support -dip25
// TODO: add support for dObjc
auto dObjc = false;
version(OSX) version(X86_64)
dObjc = true;
if (env.getNumberedBool("ENABLE_DEBUG"))
{
dflags ~= ["-g", "-debug"];
}
if (env.getNumberedBool("ENABLE_RELEASE"))
{
dflags ~= ["-O", "-release", "-inline"];
}
else
{
// add debug symbols for all non-release builds
if (!dflags.canFind("-g"))
dflags ~= ["-g"];
}
if (env.getNumberedBool("ENABLE_LTO"))
{
dflags ~= ["-flto=full"];
}
if (env.getNumberedBool("ENABLE_UNITTEST"))
{
dflags ~= ["-unittest", "-cov"];
}
if (env.getNumberedBool("ENABLE_PROFILE"))
{
dflags ~= ["-profile"];
}
if (env.getNumberedBool("ENABLE_COVERAGE"))
{
dflags ~= ["-cov", "-L-lgcov"];
}
if (env.getNumberedBool("ENABLE_SANITIZERS"))
{
dflags ~= ["-fsanitize="~env["ENABLE_SANITIZERS"]];
}