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
|
// Copyright 2014 The Bazel Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.devtools.build.lib.analysis.config;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Preconditions;
import com.google.common.cache.Cache;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSortedMap;
import com.google.devtools.build.lib.analysis.BlazeDirectories;
import com.google.devtools.build.lib.analysis.ConfigurationCollectionFactory;
import com.google.devtools.build.lib.analysis.config.BuildConfiguration.Fragment;
import com.google.devtools.build.lib.concurrent.ThreadSafety.ThreadCompatible;
import com.google.devtools.build.lib.events.EventHandler;
import java.util.Comparator;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.annotation.Nullable;
/**
* A factory class for {@link BuildConfiguration} instances. This is unfortunately more complex,
* and should be simplified in the future, if
* possible. Right now, creating a {@link BuildConfiguration} instance involves
* creating the instance itself and the related configurations; the main method
* is {@link #createConfigurations}.
*
* <p>Avoid calling into this class, and instead use the skyframe infrastructure to obtain
* configuration instances.
*
* <p>Blaze currently relies on the fact that all {@link BuildConfiguration}
* instances used in a build can be constructed ahead of time by this class.
*/
@ThreadCompatible // safe as long as separate instances are used
public final class ConfigurationFactory {
private final List<ConfigurationFragmentFactory> configurationFragmentFactories;
private final ConfigurationCollectionFactory configurationCollectionFactory;
private boolean performSanityCheck = true;
public ConfigurationFactory(
ConfigurationCollectionFactory configurationCollectionFactory,
ConfigurationFragmentFactory... fragmentFactories) {
this(configurationCollectionFactory, ImmutableList.copyOf(fragmentFactories));
}
public ConfigurationFactory(
ConfigurationCollectionFactory configurationCollectionFactory,
List<ConfigurationFragmentFactory> fragmentFactories) {
this.configurationCollectionFactory =
Preconditions.checkNotNull(configurationCollectionFactory);
this.configurationFragmentFactories = ImmutableList.copyOf(fragmentFactories);
}
@VisibleForTesting
public void forbidSanityCheck() {
performSanityCheck = false;
}
/** Creates a set of build configurations with top-level configuration having the given options.
*
* <p>The rest of the configurations are created based on the set of transitions available.
*/
@Nullable
public BuildConfiguration createConfigurations(
Cache<String, BuildConfiguration> cache,
PackageProviderForConfigurations loadedPackageProvider, BuildOptions buildOptions,
EventHandler errorEventListener)
throws InvalidConfigurationException {
return configurationCollectionFactory.createConfigurations(this, cache,
loadedPackageProvider, buildOptions, errorEventListener, performSanityCheck);
}
/**
* Returns a {@link com.google.devtools.build.lib.analysis.config.BuildConfiguration} based on
* the given set of build options.
*
* <p>If the configuration has already been created, re-uses it, otherwise, creates a new one.
*/
@Nullable
public BuildConfiguration getConfiguration(PackageProviderForConfigurations loadedPackageProvider,
BuildOptions buildOptions, boolean actionsDisabled, Cache<String, BuildConfiguration> cache)
throws InvalidConfigurationException {
String cacheKey = buildOptions.computeCacheKey();
BuildConfiguration result = cache.getIfPresent(cacheKey);
if (result != null) {
return result;
}
Map<Class<? extends Fragment>, Fragment> fragments = new HashMap<>();
// Create configuration fragments
for (ConfigurationFragmentFactory factory : configurationFragmentFactories) {
Class<? extends Fragment> fragmentType = factory.creates();
Fragment fragment = loadedPackageProvider.getFragment(buildOptions, fragmentType);
if (fragment != null && fragments.get(fragment) == null) {
fragments.put(fragment.getClass(), fragment);
}
}
BlazeDirectories directories = loadedPackageProvider.getDirectories();
if (loadedPackageProvider.valuesMissing()) {
return null;
}
// Sort the fragments by class name to make sure that the order is stable. Afterwards, copy to
// an ImmutableMap, which keeps the order stable, but uses hashing, and drops the reference to
// the Comparator object.
fragments = ImmutableSortedMap.copyOf(fragments, new Comparator<Class<? extends Fragment>>() {
@Override
public int compare(Class<? extends Fragment> o1, Class<? extends Fragment> o2) {
return o1.getName().compareTo(o2.getName());
}
});
fragments = ImmutableMap.copyOf(fragments);
result = new BuildConfiguration(directories, fragments, buildOptions, actionsDisabled);
cache.put(cacheKey, result);
return result;
}
public List<ConfigurationFragmentFactory> getFactories() {
return configurationFragmentFactories;
}
}
|
