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
|
// Copyright 2015 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.skyframe;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.collect.ImmutableSortedSet;
import com.google.common.collect.Interner;
import com.google.devtools.build.lib.analysis.config.BuildConfiguration;
import com.google.devtools.build.lib.analysis.config.BuildOptions;
import com.google.devtools.build.lib.analysis.config.FragmentClassSet;
import com.google.devtools.build.lib.concurrent.BlazeInterners;
import com.google.devtools.build.lib.concurrent.ThreadSafety.ThreadSafe;
import com.google.devtools.build.lib.skyframe.serialization.DeserializationContext;
import com.google.devtools.build.lib.skyframe.serialization.ObjectCodec;
import com.google.devtools.build.lib.skyframe.serialization.SerializationContext;
import com.google.devtools.build.lib.skyframe.serialization.SerializationException;
import com.google.devtools.build.lib.skyframe.serialization.autocodec.AutoCodec;
import com.google.devtools.build.skyframe.SkyFunctionName;
import com.google.devtools.build.skyframe.SkyKey;
import com.google.devtools.build.skyframe.SkyValue;
import com.google.protobuf.CodedInputStream;
import com.google.protobuf.CodedOutputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.Serializable;
import java.util.Objects;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
import java.util.logging.Logger;
/** A Skyframe value representing a {@link BuildConfiguration}. */
// TODO(bazel-team): mark this immutable when BuildConfiguration is immutable.
// @Immutable
@AutoCodec
@ThreadSafe
public class BuildConfigurationValue implements SkyValue {
private static final Logger logger = Logger.getLogger(BuildConfigurationValue.class.getName());
private final BuildConfiguration configuration;
BuildConfigurationValue(BuildConfiguration configuration) {
this.configuration = configuration;
}
public BuildConfiguration getConfiguration() {
return configuration;
}
/**
* Returns the key for a requested configuration.
*
* @param fragments the fragments the configuration should contain
* @param optionsDiff the {@link BuildOptions.OptionsDiffForReconstruction} object the {@link
* BuildOptions} should be rebuilt from
*/
@ThreadSafe
public static Key key(
Set<Class<? extends BuildConfiguration.Fragment>> fragments,
BuildOptions.OptionsDiffForReconstruction optionsDiff) {
return key(
FragmentClassSet.of(
ImmutableSortedSet.copyOf(BuildConfiguration.lexicalFragmentSorter, fragments)),
optionsDiff);
}
public static Key key(
FragmentClassSet fragmentClassSet, BuildOptions.OptionsDiffForReconstruction optionsDiff) {
return Key.create(fragmentClassSet, optionsDiff);
}
public static Key key(BuildConfiguration buildConfiguration) {
return key(buildConfiguration.fragmentClasses(), buildConfiguration.getBuildOptionsDiff());
}
/** {@link SkyKey} for {@link BuildConfigurationValue}. */
public static final class Key implements SkyKey, Serializable {
private static final Interner<Key> keyInterner = BlazeInterners.newWeakInterner();
private final FragmentClassSet fragments;
private final BuildOptions.OptionsDiffForReconstruction optionsDiff;
// If hashCode really is -1, we'll recompute it from scratch each time. Oh well.
private volatile int hashCode = -1;
private static Key create(
FragmentClassSet fragments, BuildOptions.OptionsDiffForReconstruction optionsDiff) {
return keyInterner.intern(new Key(fragments, optionsDiff));
}
private Key(FragmentClassSet fragments, BuildOptions.OptionsDiffForReconstruction optionsDiff) {
this.fragments = fragments;
this.optionsDiff = optionsDiff;
}
@VisibleForTesting
public ImmutableSortedSet<Class<? extends BuildConfiguration.Fragment>> getFragments() {
return fragments.fragmentClasses();
}
public BuildOptions.OptionsDiffForReconstruction getOptionsDiff() {
return optionsDiff;
}
@Override
public SkyFunctionName functionName() {
return SkyFunctions.BUILD_CONFIGURATION;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (!(o instanceof Key)) {
return false;
}
Key otherConfig = (Key) o;
return optionsDiff.equals(otherConfig.optionsDiff)
&& Objects.equals(fragments, otherConfig.fragments);
}
@Override
public int hashCode() {
if (hashCode == -1) {
hashCode = Objects.hash(fragments, optionsDiff);
}
return hashCode;
}
@Override
public String toString() {
return "BuildConfigurationValue.Key[" + optionsDiff.getChecksum() + "]";
}
private static class Codec implements ObjectCodec<Key> {
@Override
public Class<Key> getEncodedClass() {
return Key.class;
}
@Override
public void serialize(SerializationContext context, Key obj, CodedOutputStream codedOut)
throws SerializationException, IOException {
@SuppressWarnings("unchecked")
ConcurrentMap<BuildConfigurationValue.Key, byte[]> cache =
context.getDependency(KeyCodecCache.class).map;
byte[] bytes = cache.get(obj);
if (bytes == null) {
context = context.getNewNonMemoizingContext();
ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
CodedOutputStream bytesOut = CodedOutputStream.newInstance(byteArrayOutputStream);
context.serialize(obj.optionsDiff, bytesOut);
bytesOut.flush();
byteArrayOutputStream.flush();
int optionsDiffSerializedSize = byteArrayOutputStream.toByteArray().length;
context.serialize(obj.fragments, bytesOut);
bytesOut.flush();
byteArrayOutputStream.flush();
bytes = byteArrayOutputStream.toByteArray();
cache.put(obj, bytes);
logger.info(
"Serialized "
+ obj.optionsDiff
+ " and "
+ obj.fragments
+ " to "
+ bytes.length
+ " bytes (optionsDiff took "
+ optionsDiffSerializedSize
+ " bytes)");
}
codedOut.writeInt32NoTag(bytes.length);
codedOut.writeRawBytes(bytes);
}
@Override
public Key deserialize(DeserializationContext context, CodedInputStream codedIn)
throws SerializationException, IOException {
byte[] serializedBytes = codedIn.readRawBytes(codedIn.readInt32());
codedIn = CodedInputStream.newInstance(serializedBytes);
context = context.getNewNonMemoizingContext();
BuildOptions.OptionsDiffForReconstruction optionsDiff = context.deserialize(codedIn);
FragmentClassSet fragmentClassSet = context.deserialize(codedIn);
return key(fragmentClassSet, optionsDiff);
}
}
}
/**
* Injected cache for {@code Codec}, so that we don't have to repeatedly serialize the same
* object. We still incur the over-the-wire cost of the bytes, but we don't use CPU to repeatedly
* compute it.
*
* <p>We provide the cache as an injected dependency so that different serializers' caches are
* isolated.
*/
public static class KeyCodecCache {
private final ConcurrentMap<BuildConfigurationValue.Key, byte[]> map =
new ConcurrentHashMap<>();
public KeyCodecCache() {}
}
}
|