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
|
// Copyright 2014 Google Inc. 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.cache.CacheBuilder;
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 #createConfiguration}.
*
* <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;
// A cache of key to configuration instances.
private final Cache<String, BuildConfiguration> hostConfigCache =
CacheBuilder.newBuilder().softValues().build();
private boolean performSanityCheck = true;
public ConfigurationFactory(
ConfigurationCollectionFactory configurationCollectionFactory,
List<ConfigurationFragmentFactory> fragmentFactories) {
this.configurationCollectionFactory =
Preconditions.checkNotNull(configurationCollectionFactory);
this.configurationFragmentFactories = fragmentFactories;
}
@VisibleForTesting
public void forbidSanityCheck() {
performSanityCheck = false;
}
/** Create the build configurations with the given options. */
@Nullable
public BuildConfiguration createConfiguration(
PackageProviderForConfigurations loadedPackageProvider, BuildOptions buildOptions,
BuildConfigurationKey key, EventHandler errorEventListener)
throws InvalidConfigurationException {
return configurationCollectionFactory.createConfigurations(this,
loadedPackageProvider, buildOptions, key.getClientEnv(),
errorEventListener, performSanityCheck);
}
/**
* Returns a (possibly new) canonical host BuildConfiguration instance based
* upon a given request configuration
*/
@Nullable
public BuildConfiguration getHostConfiguration(
PackageProviderForConfigurations loadedPackageProvider, Map<String, String> clientEnv,
BuildOptions buildOptions, boolean fallback) throws InvalidConfigurationException {
return getConfiguration(loadedPackageProvider, buildOptions.createHostOptions(fallback),
clientEnv, false, hostConfigCache);
}
/**
* The core of BuildConfiguration creation. All host and target instances are
* constructed and cached here.
*/
@Nullable
public BuildConfiguration getConfiguration(PackageProviderForConfigurations loadedPackageProvider,
BuildOptions buildOptions, Map<String, String> clientEnv,
boolean actionsDisabled, Cache<String, BuildConfiguration> cache)
throws InvalidConfigurationException {
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);
String key = BuildConfiguration.computeCacheKey(
directories, fragments, buildOptions, clientEnv);
BuildConfiguration configuration = cache.getIfPresent(key);
if (configuration == null) {
configuration = new BuildConfiguration(directories, fragments, buildOptions,
clientEnv, actionsDisabled);
cache.put(key, configuration);
}
return configuration;
}
public List<ConfigurationFragmentFactory> getFactories() {
return configurationFragmentFactories;
}
}
|
