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
|
// 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.coverageoutputgenerator;
import static com.google.common.base.Verify.verify;
import static java.lang.Math.max;
import com.google.auto.value.AutoValue;
/**
* Stores branch coverage information.
*
* <p>Corresponds to either a BRDA or BA (Google only) line in an lcov report.
*
* <p>BA lines correspond to instances where blockNumber and branchNumber are set to empty Strings
* and have the form:
*
* <pre>BA:[line_number],[taken]</pre>
*
* In this case, nrOfExecutions() actually refers to the "taken" value where:
*
* <ul>
* <li>0 = Branch was never evaluated (evaluated() == false)
* <li>1 = Branch was evaluated but never taken
* <li>2 = Branch was taken
* </ul>
*
* BRDA lines set have the form
*
* <pre>BRDA:[line_number],[block_number],[branch_number],[taken]</pre>
*
* where the block and branch numbers are internal identifiers, and taken is either "-" if the
* branch condition was never evaluated or a number indicating how often the branch was taken(which
* may be 0).
*/
@AutoValue
abstract class BranchCoverage {
/**
* Create a BranchCoverage object corresponding to a BA line
*
* <pre>BA:[line_number],[taken]</pre>
*
* @param lineNumber line number the branch comes from
* @param value the taken value, 0, 1, 2
* @return corresponding BranchCoverage
*/
static BranchCoverage create(int lineNumber, long value) {
verify(0 <= value && value < 3, "Taken value must be one of {0, 1, 2}");
return new AutoValue_BranchCoverage(
lineNumber, /*blockNumber=*/ "", /*branchNumber=*/ "", value > 0, value);
}
/**
* Create a BranchCoverage object corresponding to a BRDA line with a dummy block number
*
* <pre>BRDA:[line_number],[block_number=0],[branch_number],[taken]</pre>
*
* @param lineNumber line number the branch comes from
* @param branchNumber id for the specific branch at this line
* @param evaluated if this branch was evaluated (taken != "-")
* @param nrOfExecutions how many times the branch was taken (the value of taken if taken != "-")
* @return corresponding BranchCoverage
*/
static BranchCoverage createWithBranch(
int lineNumber, String branchNumber, boolean evaluated, long nrOfExecutions) {
return new AutoValue_BranchCoverage(
lineNumber, /*blockNumber=*/ "0", branchNumber, evaluated, nrOfExecutions);
}
/**
* Create a BranchCoverage object corresponding to a BRDA line
*
* <pre>BRDA:[line_number],[block_number],[branch_number],[taken]</pre>
*
* @param lineNumber line number the branch comes from
* @param blockNumber GCC internal block id
* @param branchNumber id for the specific branch at this line
* @param evaluated if this branch was evaluated (taken != "-")
* @param nrOfExecutions how many times the branch was taken (the value of taken if taken != "-")
* @return corresponding BranchCoverage
*/
static BranchCoverage createWithBlockAndBranch(
int lineNumber,
String blockNumber,
String branchNumber,
boolean evaluated,
long nrOfExecutions) {
return new AutoValue_BranchCoverage(
lineNumber, blockNumber, branchNumber, evaluated, nrOfExecutions);
}
/**
* Merges two given instances of {@link BranchCoverage}.
*
* <p>Calling {@code lineNumber()}, {@code blockNumber()} and {@code branchNumber()} must return
* the same values for {@code first} and {@code second}.
*/
static BranchCoverage merge(BranchCoverage first, BranchCoverage second) {
verify(first.lineNumber() == second.lineNumber(), "Branch line numbers must match");
verify(first.blockNumber().equals(second.blockNumber()), "Branch block numbers must match");
verify(first.branchNumber().equals(second.branchNumber()), "Branch branch numbers must match");
return first.blockNumber().isEmpty()
? mergeWithNoBlockAndBranch(first, second)
: mergeWithBlockAndBranch(first, second);
}
private static BranchCoverage mergeWithBlockAndBranch(
BranchCoverage first, BranchCoverage second) {
return createWithBlockAndBranch(
first.lineNumber(),
first.blockNumber(),
first.branchNumber(),
first.evaluated() || second.evaluated(),
first.nrOfExecutions() + second.nrOfExecutions());
}
private static BranchCoverage mergeWithNoBlockAndBranch(
BranchCoverage first, BranchCoverage second) {
long value = max(first.nrOfExecutions(), second.nrOfExecutions());
verify(0 <= value && value < 3, "Taken value must be one of {0, 1, 2}");
return create(first.lineNumber(), value);
}
abstract int lineNumber();
abstract String blockNumber(); // internal gcc ID for the branch
abstract String branchNumber(); // internal gcc ID for the branch
abstract boolean evaluated();
abstract long nrOfExecutions();
boolean wasExecuted() {
// if there's no block number then this is a BA branch so only taken if the "nrOfExecutions"
// value == 2 (since it refers to the BA taken value)
// otherwise it really is an execution count, so a count > 0 means the branch was executed
return blockNumber().isEmpty() ? nrOfExecutions() == 2 : nrOfExecutions() > 0;
}
}
|
