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
|
// Copyright 2018 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.serialization;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableMap;
import com.google.common.util.concurrent.FutureCallback;
import com.google.common.util.concurrent.Futures;
import com.google.common.util.concurrent.ListenableFuture;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.devtools.build.lib.skyframe.serialization.Memoizer.Serializer;
import com.google.devtools.build.lib.skyframe.serialization.SerializationException.NoCodecException;
import com.google.devtools.build.lib.util.BazelCrashUtils;
import com.google.protobuf.CodedOutputStream;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import javax.annotation.CheckReturnValue;
import javax.annotation.Nullable;
/**
* Stateful class for providing additional context to a single serialization "session". This class
* is thread-safe so long as {@link #serializer} is null (which also implies that {@link
* #allowFuturesToBlockWritingOn) is false). If it is not null, this class is not thread-safe and
* should only be accessed on a single thread for serializing one object (that may involve
* serializing other objects contained in it).
*/
public class SerializationContext {
private final ObjectCodecRegistry registry;
private final ImmutableMap<Class<?>, Object> dependencies;
@Nullable private final Memoizer.Serializer serializer;
/** Initialized lazily. */
@Nullable private List<ListenableFuture<Void>> futuresToBlockWritingOn;
private final boolean allowFuturesToBlockWritingOn;
private SerializationContext(
ObjectCodecRegistry registry,
ImmutableMap<Class<?>, Object> dependencies,
@Nullable Serializer serializer,
boolean allowFuturesToBlockWritingOn) {
this.registry = registry;
this.dependencies = dependencies;
this.serializer = serializer;
this.allowFuturesToBlockWritingOn = allowFuturesToBlockWritingOn;
}
@VisibleForTesting
public SerializationContext(
ObjectCodecRegistry registry, ImmutableMap<Class<?>, Object> dependencies) {
this(registry, dependencies, /*serializer=*/ null, /*allowFuturesToBlockWritingOn=*/ false);
}
@VisibleForTesting
public SerializationContext(ImmutableMap<Class<?>, Object> dependencies) {
this(AutoRegistry.get(), dependencies);
}
// TODO(shahan): consider making codedOut a member of this class.
public void serialize(Object object, CodedOutputStream codedOut)
throws IOException, SerializationException {
ObjectCodecRegistry.CodecDescriptor descriptor =
recordAndGetDescriptorIfNotConstantMemoizedOrNull(object, codedOut);
if (descriptor != null) {
if (serializer == null) {
descriptor.serialize(this, object, codedOut);
} else {
@SuppressWarnings("unchecked")
ObjectCodec<Object> castCodec = (ObjectCodec<Object>) descriptor.getCodec();
serializer.serialize(this, object, castCodec, codedOut);
}
}
}
@SuppressWarnings("unchecked")
public <T> T getDependency(Class<T> type) {
Preconditions.checkNotNull(type);
return (T) dependencies.get(type);
}
/**
* Returns a {@link SerializationContext} that will memoize values it encounters (using reference
* equality) in a new memoization table. The returned context should be used instead of the
* original: memoization may only occur when using the returned context. Calls must be in pairs
* with {@link DeserializationContext#getMemoizingContext} in the corresponding deserialization
* code.
*
* <p>This method is idempotent: calling it on an already memoizing context will return the same
* context.
*/
@CheckReturnValue
SerializationContext getMemoizingContext() {
if (serializer != null) {
return this;
}
return getNewMemoizingContext(/*allowFuturesToBlockWritingOn=*/ false);
}
@CheckReturnValue
SerializationContext getMemoizingAndBlockingOnWriteContext() {
Preconditions.checkState(
serializer == null, "Should only be called on base serializationContext");
Preconditions.checkState(
!allowFuturesToBlockWritingOn, "Should only be called on base serializationContext");
return getNewMemoizingContext(/*allowFuturesToBlockWritingOn=*/ true);
}
/**
* Returns a memoizing {@link SerializationContext}, as getMemoizingContext above. Unlike
* getMemoizingContext, this method is not idempotent - the returned context will always be fresh.
*/
public SerializationContext getNewMemoizingContext() {
return getNewMemoizingContext(allowFuturesToBlockWritingOn);
}
private SerializationContext getNewMemoizingContext(boolean allowFuturesToBlockWritingOn) {
return new SerializationContext(
this.registry, this.dependencies, new Memoizer.Serializer(), allowFuturesToBlockWritingOn);
}
public SerializationContext getNewNonMemoizingContext() {
return new SerializationContext(
this.registry, this.dependencies, null, this.allowFuturesToBlockWritingOn);
}
/**
* Register a {@link ListenableFuture} that must complete successfully before the serialized bytes
* generated using this context can be written remotely. Failure of the future implies a bug or
* other unrecoverable error that should crash this JVM.
*/
public void addFutureToBlockWritingOn(ListenableFuture<Void> future) {
Preconditions.checkState(allowFuturesToBlockWritingOn, "This context cannot block on a future");
if (futuresToBlockWritingOn == null) {
futuresToBlockWritingOn = new ArrayList<>();
}
Futures.addCallback(future, crashTerminatingCallback, MoreExecutors.directExecutor());
futuresToBlockWritingOn.add(future);
}
private static final FutureCallback<Void> crashTerminatingCallback =
new FutureCallback<Void>() {
@Override
public void onSuccess(@Nullable Void result) {
// Do nothing.
}
@Override
public void onFailure(Throwable t) {
throw BazelCrashUtils.halt(t);
}
};
/**
* Creates a future that succeeds when all futures stored in this context via {@link
* #addFutureToBlockWritingOn} have succeeded, or null if no such futures were stored.
*/
@Nullable
public ListenableFuture<Void> createFutureToBlockWritingOn() {
return futuresToBlockWritingOn != null
? Futures.whenAllSucceed(futuresToBlockWritingOn)
.call(() -> null, MoreExecutors.directExecutor())
: null;
}
private boolean writeNullOrConstant(@Nullable Object object, CodedOutputStream codedOut)
throws IOException {
if (object == null) {
codedOut.writeSInt32NoTag(0);
return true;
}
Integer tag = registry.maybeGetTagForConstant(object);
if (tag != null) {
codedOut.writeSInt32NoTag(tag);
return true;
}
return false;
}
@Nullable
private ObjectCodecRegistry.CodecDescriptor recordAndGetDescriptorIfNotConstantMemoizedOrNull(
@Nullable Object object, CodedOutputStream codedOut) throws IOException, NoCodecException {
if (writeNullOrConstant(object, codedOut)) {
return null;
}
if (serializer != null) {
Integer memoizedIndex = serializer.getMemoizedIndex(object);
if (memoizedIndex != null) {
// Subtract 1 so it will be negative and not collide with null.
codedOut.writeSInt32NoTag(-memoizedIndex - 1);
return null;
}
}
ObjectCodecRegistry.CodecDescriptor descriptor = registry.getCodecDescriptorForObject(object);
codedOut.writeSInt32NoTag(descriptor.getTag());
return descriptor;
}
}
|
