/
build.d
526 lines (452 loc) · 20.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
/**
Generator for direct compiler builds.
Copyright: © 2013-2013 rejectedsoftware e.K.
License: Subject to the terms of the MIT license, as written in the included LICENSE.txt file.
Authors: Sönke Ludwig
*/
module dub.generators.build;
import dub.compilers.compiler;
import dub.generators.generator;
import dub.internal.utils;
import dub.internal.vibecompat.core.file;
import dub.internal.vibecompat.core.log;
import dub.internal.vibecompat.inet.path;
import dub.package_;
import dub.packagemanager;
import dub.project;
import std.algorithm;
import std.array;
import std.conv;
import std.exception;
import std.file;
import std.process;
import std.string;
import std.encoding : sanitize;
version(Windows) enum objSuffix = ".obj";
else enum objSuffix = ".o";
class BuildGenerator : ProjectGenerator {
private {
PackageManager m_packageMan;
Path[] m_temporaryFiles;
}
this(Project project)
{
super(project);
m_packageMan = project.packageManager;
}
override void generateTargets(GeneratorSettings settings, in TargetInfo[string] targets)
{
scope (exit) cleanupTemporaries();
bool[string] visited;
void buildTargetRec(string target)
{
if (target in visited) return;
visited[target] = true;
auto ti = targets[target];
foreach (dep; ti.dependencies)
buildTargetRec(dep);
Path[] additional_dep_files;
auto bs = ti.buildSettings.dup;
foreach (ldep; ti.linkDependencies) {
auto dbs = targets[ldep].buildSettings;
if (bs.targetType != TargetType.staticLibrary) {
bs.addSourceFiles((Path(dbs.targetPath) ~ getTargetFileName(dbs, settings.platform)).toNativeString());
} else {
additional_dep_files ~= Path(dbs.targetPath) ~ getTargetFileName(dbs, settings.platform);
}
}
buildTarget(settings, bs, ti.pack, ti.config, ti.packages, additional_dep_files);
}
// build all targets
auto root_ti = targets[m_project.rootPackage.name];
if (settings.rdmd || root_ti.buildSettings.targetType == TargetType.staticLibrary) {
// RDMD always builds everything at once and static libraries don't need their
// dependencies to be built
buildTarget(settings, root_ti.buildSettings.dup, m_project.rootPackage, root_ti.config, root_ti.packages, null);
} else buildTargetRec(m_project.rootPackage.name);
}
override void performPostGenerateActions(GeneratorSettings settings, in TargetInfo[string] targets)
{
// run the generated executable
auto buildsettings = targets[m_project.rootPackage.name].buildSettings;
if (settings.run && !(buildsettings.options & BuildOptions.syntaxOnly)) {
auto exe_file_path = Path(buildsettings.targetPath) ~ getTargetFileName(buildsettings, settings.platform);
runTarget(exe_file_path, buildsettings, settings.runArgs, settings);
}
}
private void buildTarget(GeneratorSettings settings, BuildSettings buildsettings, in Package pack, string config, in Package[] packages, in Path[] additional_dep_files)
{
auto cwd = Path(getcwd());
bool generate_binary = !(buildsettings.options & BuildOptions.syntaxOnly);
auto build_id = computeBuildID(config, buildsettings, settings);
// make all paths relative to shrink the command line
string makeRelative(string path) { auto p = Path(path); if (p.absolute) p = p.relativeTo(cwd); return p.toNativeString(); }
foreach (ref f; buildsettings.sourceFiles) f = makeRelative(f);
foreach (ref p; buildsettings.importPaths) p = makeRelative(p);
foreach (ref p; buildsettings.stringImportPaths) p = makeRelative(p);
// perform the actual build
bool cached = false;
if (settings.rdmd) performRDMDBuild(settings, buildsettings, pack, config);
else if (settings.direct || !generate_binary) performDirectBuild(settings, buildsettings, pack, config);
else cached = performCachedBuild(settings, buildsettings, pack, config, build_id, packages, additional_dep_files);
// run post-build commands
if (!cached && buildsettings.postBuildCommands.length) {
logInfo("Running post-build commands...");
runBuildCommands(buildsettings.postBuildCommands, buildsettings);
}
}
bool performCachedBuild(GeneratorSettings settings, BuildSettings buildsettings, in Package pack, string config, string build_id, in Package[] packages, in Path[] additional_dep_files)
{
auto cwd = Path(getcwd());
auto target_path = pack.path ~ format(".dub/build/%s/", build_id);
if (!settings.force && isUpToDate(target_path, buildsettings, settings.platform, pack, packages, additional_dep_files)) {
logInfo("Target %s %s is up to date. Use --force to rebuild.", pack.name, pack.vers);
logDiagnostic("Using existing build in %s.", target_path.toNativeString());
copyTargetFile(target_path, buildsettings, settings.platform);
return true;
}
if (settings.tempBuild || !isWritableDir(target_path, true)) {
if (!settings.tempBuild)
logInfo("Build directory %s is not writable. Falling back to direct build in the system's temp folder.", target_path.relativeTo(cwd).toNativeString());
performDirectBuild(settings, buildsettings, pack, config);
return false;
}
// determine basic build properties
auto generate_binary = !(buildsettings.options & BuildOptions.syntaxOnly);
logInfo("Building %s %s configuration \"%s\", build type %s.", pack.name, pack.vers, config, settings.buildType);
if( buildsettings.preBuildCommands.length ){
logInfo("Running pre-build commands...");
runBuildCommands(buildsettings.preBuildCommands, buildsettings);
}
// override target path
auto cbuildsettings = buildsettings;
cbuildsettings.targetPath = target_path.relativeTo(cwd).toNativeString();
buildWithCompiler(settings, cbuildsettings);
copyTargetFile(target_path, buildsettings, settings.platform);
return false;
}
void performRDMDBuild(GeneratorSettings settings, ref BuildSettings buildsettings, in Package pack, string config)
{
auto cwd = Path(getcwd());
//Added check for existance of [AppNameInPackagejson].d
//If exists, use that as the starting file.
Path mainsrc;
if (buildsettings.mainSourceFile.length) {
mainsrc = Path(buildsettings.mainSourceFile);
if (!mainsrc.absolute) mainsrc = pack.path ~ mainsrc;
} else {
mainsrc = getMainSourceFile(pack);
logWarn(`Package has no "mainSourceFile" defined. Using best guess: %s`, mainsrc.relativeTo(pack.path).toNativeString());
}
// do not pass all source files to RDMD, only the main source file
buildsettings.sourceFiles = buildsettings.sourceFiles.filter!(s => !s.endsWith(".d"))().array();
settings.compiler.prepareBuildSettings(buildsettings, BuildSetting.commandLine);
auto generate_binary = !buildsettings.dflags.canFind("-o-");
// Create start script, which will be used by the calling bash/cmd script.
// build "rdmd --force %DFLAGS% -I%~dp0..\source -Jviews -Isource @deps.txt %LIBS% source\app.d" ~ application arguments
// or with "/" instead of "\"
Path exe_file_path;
bool tmp_target = false;
if (generate_binary) {
if (settings.tempBuild || (settings.run && !isWritableDir(Path(buildsettings.targetPath), true))) {
import std.random;
auto rnd = to!string(uniform(uint.min, uint.max)) ~ "-";
auto tmpdir = getTempDir()~".rdmd/source/";
buildsettings.targetPath = tmpdir.toNativeString();
buildsettings.targetName = rnd ~ buildsettings.targetName;
m_temporaryFiles ~= tmpdir;
tmp_target = true;
}
exe_file_path = Path(buildsettings.targetPath) ~ getTargetFileName(buildsettings, settings.platform);
settings.compiler.setTarget(buildsettings, settings.platform);
}
logDiagnostic("Application output name is '%s'", getTargetFileName(buildsettings, settings.platform));
string[] flags = ["--build-only", "--compiler="~settings.platform.compilerBinary];
if (settings.force) flags ~= "--force";
flags ~= buildsettings.dflags;
flags ~= mainsrc.relativeTo(cwd).toNativeString();
if (buildsettings.preBuildCommands.length){
logInfo("Running pre-build commands...");
runCommands(buildsettings.preBuildCommands);
}
logInfo("Building configuration "~config~", build type "~settings.buildType);
logInfo("Running rdmd...");
logDiagnostic("rdmd %s", join(flags, " "));
auto rdmd_pid = spawnProcess("rdmd" ~ flags);
auto result = rdmd_pid.wait();
enforce(result == 0, "Build command failed with exit code "~to!string(result));
if (tmp_target) {
m_temporaryFiles ~= exe_file_path;
foreach (f; buildsettings.copyFiles)
m_temporaryFiles ~= Path(buildsettings.targetPath).parentPath ~ Path(f).head;
}
}
void performDirectBuild(GeneratorSettings settings, ref BuildSettings buildsettings, in Package pack, string config)
{
auto cwd = Path(getcwd());
auto generate_binary = !(buildsettings.options & BuildOptions.syntaxOnly);
auto is_static_library = buildsettings.targetType == TargetType.staticLibrary || buildsettings.targetType == TargetType.library;
// make file paths relative to shrink the command line
foreach (ref f; buildsettings.sourceFiles) {
auto fp = Path(f);
if( fp.absolute ) fp = fp.relativeTo(cwd);
f = fp.toNativeString();
}
logInfo("Building configuration \""~config~"\", build type "~settings.buildType);
// make all target/import paths relative
string makeRelative(string path) { auto p = Path(path); if (p.absolute) p = p.relativeTo(cwd); return p.toNativeString(); }
buildsettings.targetPath = makeRelative(buildsettings.targetPath);
foreach (ref p; buildsettings.importPaths) p = makeRelative(p);
foreach (ref p; buildsettings.stringImportPaths) p = makeRelative(p);
Path exe_file_path;
bool is_temp_target = false;
if (generate_binary) {
if (settings.tempBuild || (settings.run && !isWritableDir(Path(buildsettings.targetPath), true))) {
import std.random;
auto rnd = to!string(uniform(uint.min, uint.max));
auto tmppath = getTempDir()~("dub/"~rnd~"/");
buildsettings.targetPath = tmppath.toNativeString();
m_temporaryFiles ~= tmppath;
is_temp_target = true;
}
exe_file_path = Path(buildsettings.targetPath) ~ getTargetFileName(buildsettings, settings.platform);
}
if( buildsettings.preBuildCommands.length ){
logInfo("Running pre-build commands...");
runBuildCommands(buildsettings.preBuildCommands, buildsettings);
}
buildWithCompiler(settings, buildsettings);
if (is_temp_target) {
m_temporaryFiles ~= exe_file_path;
foreach (f; buildsettings.copyFiles)
m_temporaryFiles ~= Path(buildsettings.targetPath).parentPath ~ Path(f).head;
}
}
private string computeBuildID(string config, in BuildSettings buildsettings, GeneratorSettings settings)
{
import std.digest.digest;
import std.digest.md;
import std.bitmanip;
MD5 hash;
hash.start();
void addHash(in string[] strings...) { foreach (s; strings) { hash.put(cast(ubyte[])s); hash.put(0); } hash.put(0); }
void addHashI(int value) { hash.put(nativeToLittleEndian(value)); }
addHash(buildsettings.versions);
addHash(buildsettings.debugVersions);
//addHash(buildsettings.versionLevel);
//addHash(buildsettings.debugLevel);
addHash(buildsettings.dflags);
addHash(buildsettings.lflags);
addHash((cast(uint)buildsettings.options).to!string);
addHash(buildsettings.stringImportPaths);
addHash(settings.platform.architecture);
addHash(settings.platform.compilerBinary);
addHash(settings.platform.compiler);
addHashI(settings.platform.frontendVersion);
auto hashstr = hash.finish().toHexString().idup;
return format("%s-%s-%s-%s-%s_%s-%s", config, settings.buildType,
settings.platform.platform.join("."),
settings.platform.architecture.join("."),
settings.platform.compiler, settings.platform.frontendVersion, hashstr);
}
private void copyTargetFile(Path build_path, BuildSettings buildsettings, BuildPlatform platform)
{
auto filename = getTargetFileName(buildsettings, platform);
auto src = build_path ~ filename;
logDiagnostic("Copying target from %s to %s", src.toNativeString(), buildsettings.targetPath);
if (!existsFile(Path(buildsettings.targetPath)))
mkdirRecurse(buildsettings.targetPath);
hardLinkFile(src, Path(buildsettings.targetPath) ~ filename, true);
}
private bool isUpToDate(Path target_path, BuildSettings buildsettings, BuildPlatform platform, in Package main_pack, in Package[] packages, in Path[] additional_dep_files)
{
import std.datetime;
auto targetfile = target_path ~ getTargetFileName(buildsettings, platform);
if (!existsFile(targetfile)) {
logDiagnostic("Target '%s' doesn't exist, need rebuild.", targetfile.toNativeString());
return false;
}
auto targettime = getFileInfo(targetfile).timeModified;
auto allfiles = appender!(string[]);
allfiles ~= buildsettings.sourceFiles;
allfiles ~= buildsettings.importFiles;
allfiles ~= buildsettings.stringImportFiles;
// TODO: add library files
foreach (p; packages)
allfiles ~= (p.packageInfoFilename != Path.init ? p : p.basePackage).packageInfoFilename.toNativeString();
foreach (f; additional_dep_files) allfiles ~= f.toNativeString();
if (main_pack is m_project.rootPackage)
allfiles ~= (main_pack.path ~ SelectedVersions.defaultFile).toNativeString();
foreach (file; allfiles.data) {
if (!existsFile(file)) {
logDiagnostic("File %s doesn't exists, triggering rebuild.", file);
return false;
}
auto ftime = getFileInfo(file).timeModified;
if (ftime > Clock.currTime)
logWarn("File '%s' was modified in the future. Please re-save.", file);
if (ftime > targettime) {
logDiagnostic("File '%s' modified, need rebuild.", file);
return false;
}
}
return true;
}
/// Output an unique name to represent the source file.
/// Calls with path that resolve to the same file on the filesystem will return the same,
/// unless they include different symbolic links (which are not resolved).
static string pathToObjName(string path)
{
import std.path : buildNormalizedPath, dirSeparator, stripDrive;
return stripDrive(buildNormalizedPath(getcwd(), path~objSuffix))[1..$].replace(dirSeparator, ".");
}
/// Compile a single source file (srcFile), and write the object to objName.
static string compileUnit(string srcFile, string objName, BuildSettings bs, GeneratorSettings gs) {
Path tempobj = Path(bs.targetPath)~objName;
string objPath = tempobj.toNativeString();
bs.libs = null;
bs.lflags = null;
bs.sourceFiles = [ srcFile ];
bs.targetType = TargetType.object;
gs.compiler.prepareBuildSettings(bs, BuildSetting.commandLine);
gs.compiler.setTarget(bs, gs.platform, objPath);
gs.compiler.invoke(bs, gs.platform, gs.compileCallback);
return objPath;
}
void buildWithCompiler(GeneratorSettings settings, BuildSettings buildsettings)
{
auto generate_binary = !(buildsettings.options & BuildOptions.syntaxOnly);
auto is_static_library = buildsettings.targetType == TargetType.staticLibrary || buildsettings.targetType == TargetType.library;
Path target_file;
scope (failure) {
logInfo("FAIL %s %s %s" , buildsettings.targetPath, buildsettings.targetName, buildsettings.targetType);
auto tpath = Path(buildsettings.targetPath) ~ getTargetFileName(buildsettings, settings.platform);
if (generate_binary && existsFile(tpath))
removeFile(tpath);
}
if (settings.buildMode == BuildMode.singleFile && generate_binary) {
import std.parallelism, std.range : walkLength;
auto lbuildsettings = buildsettings;
auto srcs = buildsettings.sourceFiles.filter!(f => !isLinkerFile(f));
auto objs = new string[](srcs.walkLength);
logInfo("Compiling using %s...", settings.platform.compilerBinary);
void compileSource(size_t i, string src) {
logInfo("Compiling %s...", src);
objs[i] = compileUnit(src, pathToObjName(src), buildsettings, settings);
}
if (settings.parallelBuild) {
foreach (i, src; srcs.parallel(1)) compileSource(i, src);
} else {
foreach (i, src; srcs.array) compileSource(i, src);
}
logInfo("Linking...");
lbuildsettings.sourceFiles = is_static_library ? [] : lbuildsettings.sourceFiles.filter!(f=> f.isLinkerFile()).array;
settings.compiler.setTarget(lbuildsettings, settings.platform);
settings.compiler.prepareBuildSettings(lbuildsettings, BuildSetting.commandLineSeparate|BuildSetting.sourceFiles);
settings.compiler.invokeLinker(lbuildsettings, settings.platform, objs, settings.linkCallback);
/*
NOTE: for DMD experimental separate compile/link is used, but this is not yet implemented
on the other compilers. Later this should be integrated somehow in the build process
(either in the dub.json, or using a command line flag)
*/
} else if (settings.buildMode == BuildMode.allAtOnce || settings.platform.compilerBinary != "dmd" || !generate_binary || is_static_library) {
// setup for command line
if (generate_binary) settings.compiler.setTarget(buildsettings, settings.platform);
settings.compiler.prepareBuildSettings(buildsettings, BuildSetting.commandLine);
// don't include symbols of dependencies (will be included by the top level target)
if (is_static_library) buildsettings.sourceFiles = buildsettings.sourceFiles.filter!(f => !f.isLinkerFile()).array;
// invoke the compiler
logInfo("Running %s...", settings.platform.compilerBinary);
settings.compiler.invoke(buildsettings, settings.platform, settings.compileCallback);
} else {
// determine path for the temporary object file
string tempobjname = buildsettings.targetName ~ objSuffix;
Path tempobj = Path(buildsettings.targetPath) ~ tempobjname;
// setup linker command line
auto lbuildsettings = buildsettings;
lbuildsettings.sourceFiles = lbuildsettings.sourceFiles.filter!(f => isLinkerFile(f)).array;
settings.compiler.setTarget(lbuildsettings, settings.platform);
settings.compiler.prepareBuildSettings(lbuildsettings, BuildSetting.commandLineSeparate|BuildSetting.sourceFiles);
// setup compiler command line
buildsettings.libs = null;
buildsettings.lflags = null;
buildsettings.addDFlags("-c", "-of"~tempobj.toNativeString());
buildsettings.sourceFiles = buildsettings.sourceFiles.filter!(f => !isLinkerFile(f)).array;
settings.compiler.prepareBuildSettings(buildsettings, BuildSetting.commandLine);
logInfo("Compiling using %s...", settings.platform.compilerBinary);
settings.compiler.invoke(buildsettings, settings.platform, settings.compileCallback);
logInfo("Linking...");
settings.compiler.invokeLinker(lbuildsettings, settings.platform, [tempobj.toNativeString()], settings.linkCallback);
}
}
void runTarget(Path exe_file_path, in BuildSettings buildsettings, string[] run_args, GeneratorSettings settings)
{
if (buildsettings.targetType == TargetType.executable) {
auto cwd = Path(getcwd());
auto runcwd = cwd;
if (buildsettings.workingDirectory.length) {
runcwd = Path(buildsettings.workingDirectory);
if (!runcwd.absolute) runcwd = cwd ~ runcwd;
logDiagnostic("Switching to %s", runcwd.toNativeString());
chdir(runcwd.toNativeString());
}
scope(exit) chdir(cwd.toNativeString());
if (!exe_file_path.absolute) exe_file_path = cwd ~ exe_file_path;
auto exe_path_string = exe_file_path.relativeTo(runcwd).toNativeString();
version (Posix) {
if (!exe_path_string.startsWith(".") && !exe_path_string.startsWith("/"))
exe_path_string = "./" ~ exe_path_string;
}
version (Windows) {
if (!exe_path_string.startsWith(".") && (exe_path_string.length < 2 || exe_path_string[1] != ':'))
exe_path_string = ".\\" ~ exe_path_string;
}
logInfo("Running %s %s", exe_path_string, run_args.join(" "));
if (settings.runCallback) {
auto res = execute(exe_path_string ~ run_args);
settings.runCallback(res.status, res.output);
} else {
auto prg_pid = spawnProcess(exe_path_string ~ run_args);
auto result = prg_pid.wait();
enforce(result == 0, "Program exited with code "~to!string(result));
}
} else
enforce(false, "Target is a library. Skipping execution.");
}
void cleanupTemporaries()
{
foreach_reverse (f; m_temporaryFiles) {
try {
if (f.endsWithSlash) rmdir(f.toNativeString());
else remove(f.toNativeString());
} catch (Exception e) {
logWarn("Failed to remove temporary file '%s': %s", f.toNativeString(), e.msg);
logDiagnostic("Full error: %s", e.toString().sanitize);
}
}
m_temporaryFiles = null;
}
}
private Path getMainSourceFile(in Package prj)
{
foreach (f; ["source/app.d", "src/app.d", "source/"~prj.name~".d", "src/"~prj.name~".d"])
if (existsFile(prj.path ~ f))
return prj.path ~ f;
return prj.path ~ "source/app.d";
}
unittest {
version (Windows) {
assert(isLinkerFile("test.obj"));
assert(isLinkerFile("test.lib"));
assert(isLinkerFile("test.res"));
assert(!isLinkerFile("test.o"));
assert(!isLinkerFile("test.d"));
} else {
assert(isLinkerFile("test.o"));
assert(isLinkerFile("test.a"));
assert(isLinkerFile("test.so"));
assert(isLinkerFile("test.dylib"));
assert(!isLinkerFile("test.obj"));
assert(!isLinkerFile("test.d"));
}
}