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
|
// 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.skyframe;
import com.google.common.base.Supplier;
import com.google.devtools.build.lib.concurrent.ThreadSafety;
/** Receiver for various stages of the lifetime of a skyframe node evaluation. */
@ThreadSafety.ThreadSafe
public interface EvaluationProgressReceiver {
/**
* New state of the value entry after evaluation.
*/
enum EvaluationState {
/** The value was successfully re-evaluated. */
BUILT,
/** The value is clean or re-validated. */
CLEAN,
}
/**
* New state of the value entry after invalidation.
*/
enum InvalidationState {
/** The value is dirty, although it might get re-validated again. */
DIRTY,
/** The value is dirty and got deleted, cannot get re-validated again. */
DELETED,
}
/**
* Notifies that the node named by {@code key} has been invalidated.
*
* <p>{@code state} indicates the new state of the value.
*
* <p>May be called concurrently from multiple threads, possibly with the same {@code key}.
*/
void invalidated(SkyKey skyKey, InvalidationState state);
/**
* Notifies that {@code skyKey} is about to get queued for evaluation.
*
* <p>Note that we don't guarantee that it actually got enqueued or will, only that if
* everything "goes well" (e.g. no interrupts happen) it will.
*
* <p>This guarantee is intentionally vague to encourage writing robust implementations.
*/
void enqueueing(SkyKey skyKey);
/**
* Notifies that {@code skyFunction.compute(skyKey, ...)} is about to be called, for some
* appropriate {@link SkyFunction} {@code skyFunction}.
*
* <p>Notably, this includes {@link SkyFunction#compute} calls due to Skyframe restarts.
*/
void computing(SkyKey skyKey);
/**
* Notifies that {@code skyFunction.compute(skyKey, ...)} has just been called, for some
* appropriate {@link SkyFunction} {@code skyFunction}.
*
* <p>Notably, this includes {@link SkyFunction#compute} calls due to Skyframe restarts.
*/
void computed(SkyKey skyKey, long elapsedTimeNanos);
/**
* Notifies that the node for {@code skyKey} has been evaluated.
*
* <p>{@code state} indicates the new state of the node.
*
* <p>If the value builder threw an error when building this node, then
* {@code valueSupplier.get()} evaluates to null.
*/
void evaluated(SkyKey skyKey, Supplier<SkyValue> valueSupplier, EvaluationState state);
/** An {@link EvaluationProgressReceiver} that does nothing. */
class NullEvaluationProgressReceiver implements EvaluationProgressReceiver {
@Override
public void invalidated(SkyKey skyKey, InvalidationState state) {
}
@Override
public void enqueueing(SkyKey skyKey) {
}
@Override
public void computing(SkyKey skyKey) {
}
@Override
public void computed(SkyKey skyKey, long elapsedTimeNanos) {
}
@Override
public void evaluated(SkyKey skyKey, Supplier<SkyValue> valueSupplier, EvaluationState state) {
}
}
}
|
