/
BuildManager.java
1656 lines (1525 loc) · 63.7 KB
/
BuildManager.java
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
/*******************************************************************************
* Copyright (c) 2000, 2021 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
* Isaac Pacht (isaacp3@gmail.com) - fix for bug 206540
* Anton Leherbauer (Wind River) - [305858] Allow Builder to return null rule
* James Blackburn (Broadcom) - [306822] Provide Context for Builder getRule()
* Broadcom Corporation - ongoing development
* Lars Vogel <Lars.Vogel@vogella.com> - Bug 473427
* Torbjörn Svensson (STMicroelectronics) - bug #552606
*******************************************************************************/
package org.eclipse.core.internal.events;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.function.Supplier;
import java.util.stream.Collectors;
import org.eclipse.core.internal.resources.ComputeProjectOrder.Digraph;
import org.eclipse.core.internal.resources.ICoreConstants;
import org.eclipse.core.internal.resources.IManager;
import org.eclipse.core.internal.resources.Project;
import org.eclipse.core.internal.resources.ProjectDescription;
import org.eclipse.core.internal.resources.ResourceStatus;
import org.eclipse.core.internal.resources.WorkManager;
import org.eclipse.core.internal.resources.Workspace;
import org.eclipse.core.internal.utils.Messages;
import org.eclipse.core.internal.utils.Policy;
import org.eclipse.core.internal.watson.ElementTree;
import org.eclipse.core.resources.IBuildConfiguration;
import org.eclipse.core.resources.IBuildContext;
import org.eclipse.core.resources.ICommand;
import org.eclipse.core.resources.IIncrementalProjectBuilder2;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IProjectDescription;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.resources.IResourceDelta;
import org.eclipse.core.resources.IResourceStatus;
import org.eclipse.core.resources.IncrementalProjectBuilder;
import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IConfigurationElement;
import org.eclipse.core.runtime.IExtension;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.ISafeRunnable;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.MultiStatus;
import org.eclipse.core.runtime.OperationCanceledException;
import org.eclipse.core.runtime.Platform;
import org.eclipse.core.runtime.QualifiedName;
import org.eclipse.core.runtime.SafeRunner;
import org.eclipse.core.runtime.Status;
import org.eclipse.core.runtime.jobs.IJobManager;
import org.eclipse.core.runtime.jobs.ILock;
import org.eclipse.core.runtime.jobs.ISchedulingRule;
import org.eclipse.core.runtime.jobs.Job;
import org.eclipse.core.runtime.jobs.JobGroup;
import org.eclipse.core.runtime.jobs.MultiRule;
import org.eclipse.osgi.util.NLS;
import org.osgi.framework.Bundle;
public class BuildManager implements ICoreConstants, IManager, ILifecycleListener {
public static class JobManagerSuspendedException extends RuntimeException {
private static final long serialVersionUID = 330426099787223028L;
public JobManagerSuspendedException(String message) {
super(message);
}
}
private static final String BUILDER_INIT = "BuilderInitInfo"; //$NON-NLS-1$
/**
* Cache used to optimize the common case of an autobuild against
* a workspace where only a single project has changed (and hence
* only a single delta is interesting).
*/
static class DeltaCache<E> {
private final Map<IPath, E> deltas = new HashMap<>();
private ElementTree newTree;
private ElementTree oldTree;
public void flush() {
deltas.clear();
this.oldTree = null;
this.newTree = null;
}
/**
* Returns the cached resource delta for the given project and trees, or
* calls calculator to compute a new delta if there is no matching one in the cache.
*/
public E computeIfAbsent(IPath project, ElementTree anOldTree, ElementTree aNewTree, Supplier<E> calculator) {
if (!(areEqual(this.oldTree, anOldTree) && areEqual(this.newTree, aNewTree))) {
this.oldTree = anOldTree;
this.newTree = aNewTree;
deltas.clear();
}
return deltas.computeIfAbsent(project, p -> calculator.get());
}
private static boolean areEqual(ElementTree cached, ElementTree requested) {
return !ElementTree.hasChanges(requested, cached, ResourceComparator.getBuildComparator(), true);
}
}
/**
* These builders are added to build tables in place of builders that couldn't be instantiated
*/
class MissingBuilder extends IncrementalProjectBuilder {
private boolean hasBeenBuilt = false;
private final String name;
MissingBuilder(String name) {
this.name = name;
}
/**
* Log an exception on the first build, and silently do nothing on subsequent builds.
*/
@Override
protected IProject[] build(int kind, Map<String, String> args, IProgressMonitor monitor) {
if (!hasBeenBuilt && Policy.DEBUG_BUILD_FAILURE) {
hasBeenBuilt = true;
String msg = NLS.bind(Messages.events_skippingBuilder, name, getProject().getName());
Policy.log(IStatus.WARNING, msg, null);
}
return null;
}
String getName() {
return name;
}
@Override
public ISchedulingRule getRule(int kind, Map<String, String> args) {
return null;
}
}
private static final int TOTAL_BUILD_WORK = Policy.totalWork * 1000;
//the job for performing background autobuild
final AutoBuildJob autoBuildJob;
private final Set<IProject> builtProjects = Collections.synchronizedSet(new HashSet<>());
//the following four fields only apply for the lifetime of a single builder invocation.
protected final Set<InternalBuilder> currentBuilders;
private ElementTree currentLastBuiltTree;
private ElementTree currentTree;
/**
* Caches the IResourceDelta for a pair of trees
*/
final private DeltaCache<IResourceDelta> deltaCache = new DeltaCache<>();
private final ILock lock;
/**
* {@code true} if we can exit inner build loop cycle early after
* {@link #requestRebuild()} is set by one build config and before following
* build configs are executed. Default is {@code false}.
*/
private boolean earlyExitFromBuildLoopAllowed;
/**
* Used for the build cycle looping mechanism. If true, build loop over multiple
* projects will be restarted again for all projects in the loop
*/
private boolean rebuildRequested;
/**
* Set of projects for which builders requested rebuild. Has no effect if any
* builder requested rebuild of everything via {@link #rebuildRequested}
*/
private final Set<IProject> projectsToRebuild;
/**
* Map of projects for which builders requested rebuild for the current build
* cycle. If the value is "true" - stop building project with other builders
* immediately, "false" to continue build and start project build again after
* all builders were done. If no value is set, no rebuild is requested.
*/
private final Map<IProject, Boolean> restartBuildImmediately;
// Shows if we are in the parallel build loop or not
boolean parallelBuild;
private final Bundle systemBundle = Platform.getBundle("org.eclipse.osgi"); //$NON-NLS-1$
// protects against concurrent access of session stored builders during builder initialization
private final Object builderInitializationLock = new Object();
//used for debug/trace timing
private long timeStamp = -1;
private long overallTimeStamp = -1;
private final Workspace workspace;
public BuildManager(Workspace workspace, ILock workspaceLock) {
this.workspace = workspace;
this.currentBuilders = Collections.synchronizedSet(new HashSet<>());
this.autoBuildJob = new AutoBuildJob(workspace);
projectsToRebuild = ConcurrentHashMap.newKeySet();
restartBuildImmediately = new ConcurrentHashMap<>();
this.lock = workspaceLock;
InternalBuilder.buildManager = this;
setEarlyExitFromBuildLoopAllowed(
Boolean.getBoolean("org.eclipse.core.resources.allowEarlyBuildLoopExit")); //$NON-NLS-1$ );
}
private void basicBuild(int trigger, IncrementalProjectBuilder builder, Map<String, String> args, MultiStatus status, IProgressMonitor monitor) {
InternalBuilder currentBuilder = builder; // downcast to make package methods visible
try {
currentBuilders.add(currentBuilder);
//clear any old requests to forget built state
currentBuilder.clearLastBuiltStateRequests();
// Figure out want kind of build is needed
boolean clean = trigger == IncrementalProjectBuilder.CLEAN_BUILD;
currentLastBuiltTree = currentBuilder.getLastBuiltTree();
// Does the build command respond to this trigger?
boolean isBuilding = builder.getCommand().isBuilding(trigger);
// If no tree is available we have to do a full build
if (!clean && currentLastBuiltTree == null) {
// Bug 306746 - Don't promote build to FULL_BUILD if builder doesn't AUTO_BUILD
if (trigger == IncrementalProjectBuilder.AUTO_BUILD && !isBuilding)
return;
// Without a build tree the build is promoted to FULL_BUILD
trigger = IncrementalProjectBuilder.FULL_BUILD;
isBuilding = isBuilding || builder.getCommand().isBuilding(trigger);
}
//don't build if this builder doesn't respond to the trigger
if (!isBuilding) {
if (clean)
currentBuilder.setLastBuiltTree(null);
return;
}
// For incremental builds, grab a pointer to the current state before computing the delta
currentTree = ((trigger == IncrementalProjectBuilder.FULL_BUILD) || clean) ? null : workspace.getElementTree();
int depth = -1;
ISchedulingRule rule = null;
try {
//short-circuit if none of the projects this builder cares about have changed.
if (!needsBuild(currentBuilder, trigger)) {
//use up the progress allocated for this builder
monitor.beginTask("", 1); //$NON-NLS-1$
monitor.done();
return;
}
rule = builder.getRule(trigger, args);
String name = currentBuilder.getLabel();
String message;
if (name != null) {
message = NLS.bind(Messages.events_invoking_2, name, builder.getProject().getFullPath());
} else {
message = NLS.bind(Messages.events_invoking_1, builder.getProject().getFullPath());
}
monitor.subTask(message);
hookStartBuild(builder, trigger);
// Make the current tree immutable before releasing the WS lock
if (rule != null && currentTree != null) {
workspace.newWorkingTree();
}
//release workspace lock while calling builders
depth = getWorkManager().beginUnprotected();
// Acquire the rule required for running this builder
if (rule != null) {
Job.getJobManager().beginRule(rule, monitor);
// Now that we've acquired the rule, changes may have been made concurrently, ensure we're pointing at the
// correct currentTree so delta contains concurrent changes made in areas guarded by the scheduling rule
if (currentTree != null)
currentTree = workspace.getElementTree();
}
//do the build
SafeRunner.run(getSafeRunnable(currentBuilder, trigger, args, status, monitor));
} finally {
// Re-acquire the WS lock, then release the scheduling rule
if (depth >= 0) {
getWorkManager().endUnprotected(depth);
}
if (rule != null) {
Job.getJobManager().endRule(rule);
}
// Be sure to clean up after ourselves.
if (clean || currentBuilder.wasForgetStateRequested()) {
currentBuilder.setLastBuiltTree(null);
} else if (currentBuilder.wasRememberStateRequested()) {
// If remember last build state, and FULL_BUILD
// last tree must be set to => null for next build
if (trigger == IncrementalProjectBuilder.FULL_BUILD) {
currentBuilder.setLastBuiltTree(null);
}
// else don't modify the last built tree
} else {
// remember the current state as the last built state.
ElementTree lastTree = workspace.getElementTree();
lastTree.immutable();
currentBuilder.setLastBuiltTree(lastTree);
}
hookEndBuild(builder);
}
} finally {
currentBuilders.remove(currentBuilder);
currentTree = null;
currentLastBuiltTree = null;
}
}
protected void basicBuild(IBuildConfiguration buildConfiguration, final int trigger, IBuildContext context,
ICommand[] commands, MultiStatus status, IProgressMonitor monitor) {
int remainingIterations = Math.max(1, workspace.getDescription().getMaxBuildIterations());
// Planned triggers for each builder are originally all same
// but may change if the rebuild is requested in the loop
int[] triggers = new int[commands.length];
Arrays.fill(triggers, trigger);
boolean shouldRebuild = true;
try {
while (shouldRebuild) {
shouldRebuild = false;
// If rebuild was requested, the triggers for next builder executions
// will be changed to incremental.
int[] nextTriggers = null;
for (int i = 0; i < commands.length; i++) {
int currentTrigger = triggers[i];
checkCanceled(currentTrigger, monitor);
BuildCommand command = (BuildCommand) commands[i];
IProgressMonitor sub = Policy.subMonitorFor(monitor, 1);
IncrementalProjectBuilder builder = getBuilder(buildConfiguration, command, i, status, context);
if (builder != null) {
basicBuild(currentTrigger, builder, command.getArguments(false), status, sub);
// Check if the builder requested rebuild
IProject project = builder.getProject();
Boolean restartImmediately = restartBuildImmediately.remove(project);
if (restartImmediately != null) {
remainingIterations--;
if (remainingIterations > 0) {
if (!restartImmediately) {
// process building all builders and restart after that
shouldRebuild = true;
// Next build rounds for all builders should be incremental
if (trigger != IncrementalProjectBuilder.AUTO_BUILD) {
nextTriggers = new int[triggers.length];
Arrays.fill(nextTriggers, IncrementalProjectBuilder.INCREMENTAL_BUILD);
}
} else {
// First builder doesn't need to restart anything
if (i > 0) {
// Start for loop again, input can be important for all builders before
shouldRebuild = true;
// Next build rounds for previous builders up to current should be incremental
if (trigger != IncrementalProjectBuilder.AUTO_BUILD) {
nextTriggers = Arrays.copyOf(triggers, triggers.length);
Arrays.fill(nextTriggers, 0, i + 1,
IncrementalProjectBuilder.INCREMENTAL_BUILD);
}
break;
}
}
}
}
}
}
if (nextTriggers != null) {
triggers = nextTriggers;
}
}
} catch (CoreException e) {
status.add(e.getStatus());
}
}
/**
* Runs all builders on the given project config.
* @return A status indicating if the build succeeded or failed
*/
private IStatus basicBuild(IBuildConfiguration buildConfiguration, int trigger, IBuildContext context, IProgressMonitor monitor) {
try {
hookStartBuild(new IBuildConfiguration[] {buildConfiguration}, trigger);
MultiStatus status = new MultiStatus(ResourcesPlugin.PI_RESOURCES, IResourceStatus.INTERNAL_ERROR, Messages.events_errors, null);
basicBuild(buildConfiguration, trigger, context, status, monitor);
return status;
} finally {
hookEndBuild(trigger);
}
}
private void basicBuild(final IBuildConfiguration buildConfiguration, final int trigger, final IBuildContext context, final MultiStatus status, final IProgressMonitor monitor) {
try {
final IProject project = buildConfiguration.getProject();
final ICommand[] commands;
if (project.isAccessible())
commands = ((Project) project).internalGetDescription().getBuildSpec(false);
else
commands = null;
int work = commands == null ? 0 : commands.length;
monitor.beginTask(NLS.bind(Messages.events_building_1, project.getFullPath()), work);
if (work == 0)
return;
ISafeRunnable code = new ISafeRunnable() {
@Override
public void handleException(Throwable e) {
if (e instanceof OperationCanceledException) {
if (Policy.DEBUG_BUILD_INVOKING)
Policy.debug("Build canceled"); //$NON-NLS-1$
throw (OperationCanceledException) e;
}
// don't log the exception....it is already being logged in Workspace#run
// should never get here because the lower-level build code wrappers
// builder exceptions in core exceptions if required.
String errorText = e.getMessage();
if (errorText == null)
errorText = NLS.bind(Messages.events_unknown, e.getClass().getName(), project.getName());
status.add(new Status(IStatus.WARNING, ResourcesPlugin.PI_RESOURCES, IResourceStatus.INTERNAL_ERROR, errorText, e));
}
@Override
public void run() throws Exception {
basicBuild(buildConfiguration, trigger, context, commands, status, monitor);
}
};
SafeRunner.run(code);
} finally {
monitor.done();
}
}
/**
* Runs the builder with the given name on the given project config.
* @return A status indicating if the build succeeded or failed
*/
private IStatus basicBuild(IBuildConfiguration buildConfiguration, int trigger, String builderName, Map<String, String> args, IProgressMonitor monitor) {
final IProject project = buildConfiguration.getProject();
monitor = Policy.monitorFor(monitor);
try {
String message = NLS.bind(Messages.events_building_1, project.getFullPath());
monitor.beginTask(message, 1);
try {
hookStartBuild(new IBuildConfiguration[] {buildConfiguration}, trigger);
MultiStatus status = new MultiStatus(ResourcesPlugin.PI_RESOURCES, IResourceStatus.INTERNAL_ERROR, Messages.events_errors, null);
ICommand command = getCommand(project, builderName, args);
try {
IBuildContext context = new BuildContext(buildConfiguration);
IncrementalProjectBuilder builder = getBuilder(buildConfiguration, command, -1, status, context);
if (builder != null)
basicBuild(trigger, builder, args, status, Policy.subMonitorFor(monitor, 1));
} catch (CoreException e) {
status.add(e.getStatus());
}
return status;
} finally {
hookEndBuild(trigger);
}
} finally {
monitor.done();
}
}
/**
* Loop the workspace build until no more builders request a rebuild.
*/
private void basicBuildLoop(IBuildConfiguration[] configs, IBuildConfiguration[] requestedConfigs, int trigger, MultiStatus status, IProgressMonitor monitor) {
int projectWork = configs.length > 0 ? TOTAL_BUILD_WORK / configs.length : 0;
int maxIterations = workspace.getDescription().getMaxBuildIterations();
// Scale allowed iterations count depending on affected projects -
// allow at least two build cycles per project
maxIterations = Math.max(configs.length * 2, maxIterations);
if (maxIterations <= 0) {
maxIterations = 1;
}
rebuildRequested = true;
boolean rebuildSomething = true;
for (int iter = 0; rebuildSomething && iter < maxIterations; iter++) {
// Used for compatibility reason with requestRebuild()
boolean rebuildAll = rebuildRequested;
final boolean lastIteration = iter == maxIterations - 1;
if (rebuildAll) {
// default build loop
basicBuildLoop(configs, requestedConfigs, trigger, status, monitor, projectWork, lastIteration);
} else {
// rebuild only projects requested by builders during previous build cycle
List<IBuildConfiguration> allConfigs = Arrays.asList(workspace.getBuildOrder());
IBuildConfiguration[] configurations = allConfigs.stream()
.filter(c -> projectsToRebuild.contains(c.getProject())).toArray(IBuildConfiguration[]::new);
basicBuildLoop(configurations, requestedConfigs, trigger, status, monitor, projectWork, lastIteration);
}
if (rebuildRequested) {
rebuildSomething = true;
projectsToRebuild.clear();
restartBuildImmediately.clear();
} else if (!projectsToRebuild.isEmpty()) {
rebuildSomething = true;
} else {
rebuildSomething = false;
}
// subsequent builds should always be incremental
// i.e. autobuild if not requested by user
// INCREMENTAL_BUILD would not be auto interrupted by user actions
if (trigger != IncrementalProjectBuilder.AUTO_BUILD) {
trigger = IncrementalProjectBuilder.INCREMENTAL_BUILD;
}
}
}
private void basicBuildLoop(IBuildConfiguration[] configs, IBuildConfiguration[] requestedConfigs, int trigger,
MultiStatus status, IProgressMonitor monitor, int projectWork, final boolean lastIteration) {
// If we are rebuilding anything, we can clear already build projects.
// If we build only few dedicated projects, all others, already built
// projects should be added again to the "built" list, otherwise
// hasBeenBuilt() will return "false" for them and they would not considered
// for a rebuild if requested by one of the projects to be re-built now.
if (rebuildRequested) {
builtProjects.clear();
} else {
builtProjects.removeAll(projectsToRebuild);
}
// Clear all the rebuild related flags before entering new build cycle
rebuildRequested = false;
projectsToRebuild.clear();
restartBuildImmediately.clear();
// Basic loop over projects
for (IBuildConfiguration config : configs) {
if (config.getProject().isAccessible()) {
IBuildContext context = new BuildContext(config, requestedConfigs, configs);
// Inner loop over builders in one project
basicBuild(config, trigger, context, status, Policy.subMonitorFor(monitor, projectWork));
builtProjects.add(config.getProject());
// Check if we should continue with other projects
if ((rebuildRequested || !projectsToRebuild.isEmpty())
&& isEarlyExitFromBuildLoopAllowed()) {
if (lastIteration) {
// run build for all projects at least once
continue;
}
// Don't build following projects if one of the predecessors
// requested rebuild anyway, just start main loop from scratch
break;
}
}
}
}
/**
* Runs all builders on all the given project configs, in the order that
* they are given.
* @return A status indicating if the build succeeded or failed
*/
public IStatus build(IBuildConfiguration[] configs, IBuildConfiguration[] requestedConfigs, int trigger, IProgressMonitor monitor) {
monitor = Policy.monitorFor(monitor);
try {
monitor.beginTask(Messages.events_building_0, TOTAL_BUILD_WORK);
try {
hookStartBuild(configs, trigger);
MultiStatus status = new MultiStatus(ResourcesPlugin.PI_RESOURCES, IResourceStatus.BUILD_FAILED, Messages.events_errors, null);
basicBuildLoop(configs, requestedConfigs, trigger, status, monitor);
return status;
} finally {
hookEndBuild(trigger);
}
} finally {
endBuild(trigger, monitor);
}
}
/**
* Runs all builders on all the given project configs, in the order that
* they are given.
* @return A status indicating if the build succeeded or failed
*/
public IStatus buildParallel(Digraph<IBuildConfiguration> configs, IBuildConfiguration[] requestedConfigs, int trigger, JobGroup buildJobGroup, IProgressMonitor monitor) {
parallelBuild = true;
monitor = Policy.monitorFor(monitor);
try {
monitor.beginTask(Messages.events_building_0, TOTAL_BUILD_WORK);
try {
builtProjects.clear();
hookStartBuild(configs.vertexList.stream().map(vertex -> vertex.id).toArray(IBuildConfiguration[]::new), trigger);
MultiStatus status = new MultiStatus(ResourcesPlugin.PI_RESOURCES, IResourceStatus.BUILD_FAILED, Messages.events_errors, null);
parallelBuildLoop(configs, requestedConfigs, trigger, buildJobGroup, status, monitor);
return status;
} finally {
hookEndBuild(trigger);
}
} finally {
endBuild(trigger, monitor);
parallelBuild = false;
}
}
private void endBuild(int trigger, IProgressMonitor monitor) {
boolean cancelledBuild = monitor.isCanceled();
monitor.done();
if (trigger == IncrementalProjectBuilder.INCREMENTAL_BUILD || trigger == IncrementalProjectBuilder.FULL_BUILD) {
autoBuildJob.avoidBuild();
} else if (cancelledBuild) {
// Bug 538789: if a build was explicitly cancelled, don't trigger auto-build jobs until a build is requested
autoBuildJob.avoidBuildIfNotInterrupted();
}
}
private void parallelBuildLoop(final Digraph<IBuildConfiguration> configs, IBuildConfiguration[] requestedConfigs, int trigger, JobGroup buildJobGroup, MultiStatus status, IProgressMonitor monitor) {
final int projectWork = configs.vertexList.size() > 0 ? TOTAL_BUILD_WORK / configs.vertexList.size() : 0;
builtProjects.clear();
final GraphProcessor<IBuildConfiguration> graphProcessor = new GraphProcessor<>(configs, IBuildConfiguration.class, (config, graphCrawler) -> {
IBuildContext context = new BuildContext(config, requestedConfigs, graphCrawler.getSequentialOrder()); // TODO consider passing Digraph to BuildConfig?
try {
try {
workspace.prepareOperation(null, monitor);
workspace.beginOperation(false);
basicBuild(config, trigger, context, status, Policy.subMonitorFor(monitor, projectWork));
} finally {
workspace.endOperation(null, false);
}
builtProjects.add(config.getProject());
} catch (CoreException ex) {
status.add(new Status(IStatus.ERROR, ResourcesPlugin.PI_RESOURCES, ex.getMessage(), ex));
}
}, config -> getRule(config, trigger, null, Collections.emptyMap()), buildJobGroup);
graphProcessor.processGraphWithParallelJobs();
try {
Job.getJobManager().join(graphProcessor, monitor);
} catch (OperationCanceledException | InterruptedException e) {
status.add(new Status(IStatus.ERROR, ResourcesPlugin.PI_RESOURCES, e.getMessage(), e));
}
}
/**
* Runs the builder with the given name on the given project config.
* @return A status indicating if the build succeeded or failed
*/
public IStatus build(IBuildConfiguration buildConfiguration, int trigger, String builderName, Map<String, String> args, IProgressMonitor monitor) {
monitor = Policy.monitorFor(monitor);
rebuildRequested = false;
projectsToRebuild.clear();
restartBuildImmediately.clear();
if (builderName == null) {
IBuildContext context = new BuildContext(buildConfiguration);
return basicBuild(buildConfiguration, trigger, context, monitor);
}
return basicBuild(buildConfiguration, trigger, builderName, args, monitor);
}
/**
* Cancel the build if the user has canceled or if an auto-build has been interrupted.
*/
private void checkCanceled(int trigger, IProgressMonitor monitor) {
//if the system is shutting down, don't build
if (systemBundle.getState() == Bundle.STOPPING)
throw new OperationCanceledException();
Policy.checkCanceled(monitor);
//check for auto-cancel only if we are auto-building
if (trigger != IncrementalProjectBuilder.AUTO_BUILD)
return;
//check for request to interrupt the auto-build
if (autoBuildJob.isInterrupted())
throw new OperationCanceledException();
}
/**
* Creates and returns an ArrayList of BuilderPersistentInfo.
* The list includes entries for all builders for all configs that are
* in the builder spec, and that have a last built state, even if they
* have not been instantiated this session.
*
* e.g.
* For a project with 3 builders, 2 build configurations and the second
* builder doesn't support configurations.
* The returned List of BuilderInfos is ordered:
* builder_id, config_name,builder_index
* builder_1, config_1, 1
* builder_1, config_2, 1
* builder_2, null, 2
* builder_3, config_1, 3
* builder_3, config_1, 3
*/
public ArrayList<BuilderPersistentInfo> createBuildersPersistentInfo(IProject project) throws CoreException {
/* get the old builders (those not yet instantiated) */
ArrayList<BuilderPersistentInfo> oldInfos = getBuildersPersistentInfo(project);
ProjectDescription desc = ((Project) project).internalGetDescription();
ICommand[] commands = desc.getBuildSpec(false);
if (commands.length == 0)
return null;
IBuildConfiguration[] configs = project.getBuildConfigs();
/* build the new list */
ArrayList<BuilderPersistentInfo> newInfos = new ArrayList<>(commands.length * configs.length);
for (int i = 0; i < commands.length; i++) {
BuildCommand command = (BuildCommand) commands[i];
String builderName = command.getBuilderName();
// If the builder doesn't support configurations, only 1 delta tree to persist
boolean supportsConfigs = command.supportsConfigs();
int numberConfigs = supportsConfigs ? configs.length : 1;
for (int j = 0; j < numberConfigs; j++) {
IBuildConfiguration config = configs[j];
BuilderPersistentInfo info = null;
IncrementalProjectBuilder builder = ((BuildCommand) commands[i]).getBuilder(config);
if (builder == null) {
// if the builder was not instantiated, use the old info if any.
if (oldInfos != null)
info = getBuilderInfo(oldInfos, builderName, supportsConfigs ? config.getName() : null, i);
} else if (!(builder instanceof MissingBuilder)) {
ElementTree oldTree = ((InternalBuilder) builder).getLastBuiltTree();
//don't persist build state for builders that have no last built state
if (oldTree != null) {
// if the builder was instantiated, construct a memento with the important info
info = new BuilderPersistentInfo(project.getName(), supportsConfigs ? config.getName() : null, builderName, i);
info.setLastBuildTree(oldTree);
info.setInterestingProjects(((InternalBuilder) builder).getInterestingProjects());
}
}
if (info != null)
newInfos.add(info);
}
}
return newInfos;
}
private String debugBuilder() {
return currentBuilders == null ? "<no builder>" : currentBuilders.getClass().getName(); //$NON-NLS-1$
}
private String debugProject() {
if (currentBuilders == null)
return "<no project>"; //$NON-NLS-1$
return "[" + currentBuilders.stream().map(builder -> builder.getProject().getFullPath().toString()).collect(Collectors.joining(",")) + "]"; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
}
/**
* Returns a string representation of a build trigger for debugging purposes.
* @param trigger The trigger to compute a representation of
* @return A string describing the trigger.
*/
private String debugTrigger(int trigger) {
switch (trigger) {
case IncrementalProjectBuilder.FULL_BUILD :
return "FULL_BUILD"; //$NON-NLS-1$
case IncrementalProjectBuilder.CLEAN_BUILD :
return "CLEAN_BUILD"; //$NON-NLS-1$
case IncrementalProjectBuilder.AUTO_BUILD :
case IncrementalProjectBuilder.INCREMENTAL_BUILD :
default :
return "INCREMENTAL_BUILD"; //$NON-NLS-1$
}
}
/**
* The outermost workspace operation has finished. Do an autobuild if necessary.
*/
public void endTopLevel(boolean needsBuild) {
autoBuildJob.build(needsBuild);
}
/**
* Waits till autobuild finished. Tries to finish it as soon as possible.
*/
public void waitForAutoBuild() {
waitFor(autoBuildJob);
}
/**
* Waits till noBuildJob finished. Tries to finish it as soon as possible.
*/
public void waitForAutoBuildOff() {
waitFor(autoBuildJob.noBuildJob);
}
private static void waitFor(Job job) {
IJobManager jobManager = Job.getJobManager();
// Need to loop because jobs can reschedule itself and concurrent running
// background jobs change the states too
while (job.getState() != Job.NONE) {
// Need to wake up thread to finish as soon as possible:
while (job.getState() != Job.RUNNING && job.getState() != Job.NONE) {
if (jobManager.isSuspended())
throw new JobManagerSuspendedException("The JobManager is suspended, waiting for " //$NON-NLS-1$
+ "a job to finish will just block this thread forever. Activate the JobManager again before waiting " //$NON-NLS-1$
+ "for a job to finish"); //$NON-NLS-1$
jobManager.wakeUp(ResourcesPlugin.FAMILY_AUTO_BUILD);
Thread.yield();
// After wakeup the woken job may go into sleep again when asynchronous
// workspace save interrupts autobuild so we need to wait till RUNNING or NONE
// (happens after each JUnit class)
}
// Need to wait till job finished:
try {
jobManager.join(ResourcesPlugin.FAMILY_AUTO_BUILD, null);
} catch (OperationCanceledException | InterruptedException e) {
// Ignore
}
}
}
/**
* Returns the value of the boolean configuration element attribute with the
* given name, or <code>false</code> if the attribute is missing.
*/
private boolean getBooleanAttribute(IConfigurationElement element, String name) {
String valueString = element.getAttribute(name);
return valueString != null && valueString.equalsIgnoreCase(Boolean.TRUE.toString());
}
/**
* Returns the builder instance corresponding to the given command, or
* <code>null</code> if the builder was not valid.
* @param buildConfiguration The project config this builder corresponds to
* @param command The build command
* @param buildSpecIndex The index of this builder in the build spec, or -1 if
* the index is unknown
* @param status MultiStatus for collecting errors
*/
private IncrementalProjectBuilder getBuilder(IBuildConfiguration buildConfiguration, ICommand command, int buildSpecIndex, MultiStatus status) throws CoreException {
BuildCommand buildCommand = (BuildCommand) command;
InternalBuilder result = buildCommand.getBuilder(buildConfiguration);
String builderName = command.getBuilderName();
IProject project = buildConfiguration.getProject();
if (result == null) {
// Synchronized builderInitializationLock blocks below are used to avoid
// locking during initializeBuilder() call and to make sure two threads
// trying to init the same builder in parallel will get properly
// initialized builder without deadlocks or ConcurrentModificationException
// See bug 538102 and bug 517411.
BuilderPersistentInfo info;
synchronized (builderInitializationLock) {
// get the map of builders to get the last built tree
BuilderPersistentInfo builderInitInProgress = getBuilderInitInfo(project, builderName);
if (builderInitInProgress != null) {
info = builderInitInProgress;
} else {
info = removePersistentBuilderInfo(builderName, buildConfiguration, buildSpecIndex);
setBuilderInitInfo(project, builderName, info);
}
}
result = buildCommand.getBuilder(buildConfiguration);
if (result == null) {
// Not synchronized on builderInitializationLock to avoid deadlocks if the builder init code
// requests a lock held by another thread which may be waiting on builderInitializationLock
result = initializeBuilder(command, builderName, buildConfiguration, info, status);
}
synchronized (builderInitializationLock) {
// the build command holds only one builder per configuration
// so query the builder for the configuration once more,
// in case another builder was added since we last checked
InternalBuilder other = buildCommand.getBuilder(buildConfiguration);
if (other == null) {
buildCommand.addBuilder(buildConfiguration, (IncrementalProjectBuilder) result);
} else {
result = other;
}
setBuilderInitInfo(project, builderName, null);
}
}
// Ensure the build configuration stays fresh for non-config aware builders
result.setBuildConfig(buildConfiguration);
if (!validateNature(result, builderName)) {
//skip this builder and null its last built tree because it is invalid
//if the nature gets added or re-enabled a full build will be triggered
result.setLastBuiltTree(null);
return null;
}
return (IncrementalProjectBuilder) result;
}
/**
* Returns the builder instance corresponding to the given command, or
* <code>null</code> if the builder was not valid, and sets its context
* to the one supplied.
*
* @param buildConfiguration The project config this builder corresponds to
* @param command The build command
* @param buildSpecIndex The index of this builder in the build spec, or -1 if
* the index is unknown
* @param status MultiStatus for collecting errors
*/
private IncrementalProjectBuilder getBuilder(IBuildConfiguration buildConfiguration, ICommand command, int buildSpecIndex, MultiStatus status, IBuildContext context) throws CoreException {
InternalBuilder builder = getBuilder(buildConfiguration, command, buildSpecIndex, status);
if (builder != null)
builder.setContext(context);
return (IncrementalProjectBuilder) builder;
}
/**
* Removes the builder persistent info from the map corresponding to the
* given builder name, configuration name and build spec index, or <code>null</code> if not found
*
* @param configName or null if the builder doesn't support configurations
* @param buildSpecIndex The index in the build spec, or -1 if unknown
*/
private BuilderPersistentInfo getBuilderInfo(ArrayList<BuilderPersistentInfo> infos, String builderName, String configName, int buildSpecIndex) {
//try to match on builder index, but if not match is found, use the builder name and config name
//this is because older workspace versions did not store builder infos in build spec order
BuilderPersistentInfo nameMatch = null;
for (BuilderPersistentInfo info : infos) {
// match on name, config name and build spec index if known
// Note: the config name may be null for builders that don't support configurations, or old workspaces
if (info.getBuilderName().equals(builderName) && (info.getConfigName() == null || info.getConfigName().equals(configName))) {
//we have found a match on name alone
if (nameMatch == null)
nameMatch = info;
//see if the index matches
if (buildSpecIndex == -1 || info.getBuildSpecIndex() == -1 || buildSpecIndex == info.getBuildSpecIndex())
return info;
}
}
//no exact index match, so return name match, if any
return nameMatch;
}
/**
* Returns a list of BuilderPersistentInfo.
* The list includes entries for all builders that are in the builder spec,
* and that have a last built state but have not been instantiated this session.
*/
@SuppressWarnings({"unchecked"})
public ArrayList<BuilderPersistentInfo> getBuildersPersistentInfo(IProject project) throws CoreException {
return (ArrayList<BuilderPersistentInfo>) project.getSessionProperty(K_BUILD_LIST);
}
/**
* Returns a build command for the given builder name and project.
* First looks for matching command in the project's build spec. If none
* is found, a new command is created and returned. This is necessary
* because IProject.build allows a builder to be executed that is not in the
* build spec.
*/
private ICommand getCommand(IProject project, String builderName, Map<String, String> args) {
ICommand[] buildSpec = ((Project) project).internalGetDescription().getBuildSpec(false);
for (ICommand element : buildSpec)
if (element.getBuilderName().equals(builderName))
return element;
//none found, so create a new command
BuildCommand result = new BuildCommand();
result.setBuilderName(builderName);
result.setArguments(args);
return result;
}
/**
* Gets a workspace delta for a given project, based on the state of the workspace
* tree the last time the current builder was run.
* <p>
* Returns null if:
* <ul>
* <li> The state of the workspace is unknown. </li>
* <li> The current builder has not indicated that it is interested in deltas
* for the given project. </li>
* <li> If the project does not exist. </li>
* </ul>
* <p>
* Deltas are computed once and cached for efficiency.
*
* @param project the project to get a delta for
*/
IResourceDelta getDelta(IProject project) {
try {
lock.acquire();
if (currentTree == null) {
if (Policy.DEBUG_BUILD_FAILURE)
Policy.debug("Build: no tree for delta " + debugBuilder() + " [" + debugProject() + "]"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
return null;
}
Set<InternalBuilder> interestedBuilders = getInterestedBuilders(project);