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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
|
/*! @file CoverageMapBase.h
* @brief CoverageMapBase Specification
*
* This file contains the specification of the CoverageMapBase class.
*/
#ifndef __COVERAGE_MAP_BASE_H__
#define __COVERAGE_MAP_BASE_H__
#include <stdint.h>
#include <string>
#include <vector>
#include <list>
namespace Coverage {
/*!
* This structure defines the information that is gathered and
* tracked per address.
*/
struct AddressInfo {
AddressInfo ();
/*!
* This member indicates that the address is the start of
* an instruction.
*/
bool isStartOfInstruction;
/*!
* This member indicates how many times the address was executed.
*/
uint32_t wasExecuted;
/*!
* This member indicates that the address is a branch instruction.
*/
bool isBranch;
/*!
* This member indicates that the address is a NOP instruction.
*/
bool isNop;
/*!
* When isBranch is TRUE, this member indicates that the branch
* instruction at the address was taken.
*/
uint32_t wasTaken;
/*!
* When isBranch is TRUE, this member indicates that the branch
* instruction at the address was NOT taken.
*/
uint32_t wasNotTaken;
};
typedef std::vector<AddressInfo> AddressInfos;
/*!
* This structure identifies the low and high addresses
* of one range. Note:: There may be more than one address
* range per symbol.
*/
struct AddressRange {
AddressRange();
AddressRange(
const std::string& name,
uint32_t lowAddress,
uint32_t highAddress
);
size_t size() const;
bool inside( uint32_t address ) const;
AddressInfo& get( uint32_t address );
const AddressInfo& get( uint32_t address ) const;
void dump( std::ostream& out, bool show_slots = false ) const;
/*!
* This is the file from which this originated.
*/
std::string fileName;
/*!
* This is the low address of the address map range.
*/
uint32_t lowAddress;
/*!
* This is the high address of the address map range.
*/
uint32_t highAddress;
/*!
* The address info for this range.
*/
AddressInfos info;
};
/*
* This type identifies a list of ranges.
*/
typedef std::vector<AddressRange> AddressRanges;
/*! @class CoverageMapBase
*
* This is the base class for Coverage Map implementations.
*/
class CoverageMapBase {
public:
/*!
* This method constructs a CoverageMapBase instance.
*
* @param[in] exefileName specifies the executable this originated in
* @param[in] low specifies the lowest address of the coverage map
* @param[in] high specifies the highest address of the coverage map
*/
CoverageMapBase(
const std::string& exefileName,
uint32_t low,
uint32_t high
);
/*!
* This method destructs a CoverageMapBase instance.
*/
virtual ~CoverageMapBase();
/*!
* This method adds a address range to the RangeList.
*
* @param[in] Low specifies the lowAddress
* @param[in] High specifies the highAddress
*
*/
void Add( uint32_t low, uint32_t high );
/*!
* This method prints the contents of the coverage map to stdout.
*/
void dump() const;
/*!
* This method checks whether an address is valid.
*
* @param[in] address specifies the address to check
*
* @return Returns true if @p address is valid and false if not.
*/
bool validAddress( const uint32_t address ) const;
/*!
* This method will return the low address of the first range in
* the RangeList.
*
* @return Returns the low address of the first range in
* the RangeList.
*/
int32_t getFirstLowAddress() const;
/*!
* This method gets the low address of the range at @p index.
*
* @param[in] index the index of the range to get the size of
*
* @return Returns the low address of the range at @p index in the
* RangeList.
*/
uint32_t getLowAddressOfRange( size_t index ) const;
/*!
* This method returns true and sets the address range if
* the address falls with the bounds of an address range
* in the RangeList.
*
* @param[in] address specifies the address to find
* @param[out] range contains the high and low addresse for
* the range
*
* @return Returns TRUE if the address range can be found
* and FALSE if it was not.
*/
bool getRange( uint32_t address, AddressRange& range ) const;
/*!
* This method returns the size of the address range.
*
* @return Returns Size of the address range.
*/
uint32_t getSize() const;
/*!
* This method gets the size of the address range at @p index.
*
* @param[in] index the index of the range to get the size of
*
* @return Returns the size of the address range.
*/
uint32_t getSizeOfRange( size_t index ) const;
/*!
* This method returns the address of the beginning of the
* instruction that contains the specified address.
*
* @param[in] address specifies the address to search from
* @param[out] beginning contains the address of the beginning of
* the instruction.
*
* @return Returns TRUE if the beginning of the instruction was
* found and FALSE if it was not.
*/
bool getBeginningOfInstruction(
uint32_t address,
uint32_t* beginning
) const;
/*!
* This method returns the high address of the coverage map.
*
* @return Returns the high address of the coverage map.
uint32_t getHighAddress() const;
*/
/*!
* This method returns the low address of the coverage map.
*
* @return Returns the low address of the coverage map.
uint32_t getLowAddress() const;
*/
/*!
* This method sets the boolean which indicates if this
* is the starting address for an instruction.
*
* @param[in] address specifies the address of the start of an instruction
*/
void setIsStartOfInstruction( uint32_t address );
/*!
* This method returns a boolean which indicates if this
* is the starting address of an instruction.
*
* @param[in] address specifies the address to check
*
* @return Returns TRUE if the specified address is the start
* of an instruction and FALSE otherwise.
*/
bool isStartOfInstruction( uint32_t address ) const;
/*!
* This method increments the counter which indicates how many times
* the instruction at the specified address was executed.
*
* @param[in] address specifies the address which was executed
*/
virtual void setWasExecuted( uint32_t address );
/*!
* This method returns a boolean which indicates if the instruction
* at the specified address was executed.
*
* @param[in] address specifies the address to check
*
* @return Returns TRUE if the instruction at the specified
* address was executed and FALSE otherwise.
*/
bool wasExecuted( uint32_t address ) const;
/*!
* This method increases the counter which indicates how many times
* the instruction at the specified address was executed. It is used
* for merging coverage maps.
*
* @param[in] address specifies the address which was executed
* @param[in] address specifies the execution count that should be
* added
*/
virtual void sumWasExecuted( uint32_t address, uint32_t addition );
/*!
* This method returns an unsigned integer which indicates how often
* the instruction at the specified address was executed.
*
* @param[in] address specifies the address to check
*
* @return Returns number of executins
*/
uint32_t getWasExecuted( uint32_t address ) const;
/*!
* This method sets the boolean which indicates if the specified
* address is the starting address of a branch instruction.
*
* @param[in] address specifies the address of the branch instruction
*/
void setIsBranch( uint32_t address );
/*!
* This method returns a boolean which indicates if the specified
* address is the starting address of a NOP instruction.
*
* @param[in] address specifies the address to check
*
* @return Returns TRUE if a NOP instruction is at the
* specified address and FALSE otherwise.
*/
bool isNop( uint32_t address ) const;
/*!
* This method sets the boolean which indicates if the specified
* address is the starting address of a NOP instruction.
*
* @param[in] address specifies the address of the NOP instruction
*/
void setIsNop( uint32_t address );
/*!
* This method returns a boolean which indicates if the specified
* address is the starting address of a branch instruction.
*
* @param[in] address specifies the address to check
*
* @return Returns TRUE if a branch instruction is at the
* specified address and FALSE otherwise.
*/
bool isBranch( uint32_t address ) const;
/*!
* This method increments the counter which indicates how many times
* the branch at the specified address was taken.
*
* @param[in] address specifies the address of the branch instruction
*/
void setWasTaken( uint32_t address );
/*!
* This method increases the counter which indicates how many times
* the branch at the specified address was taken. It is used
* for merging coverage maps.
*
* @param[in] address specifies the address which was executed
* @param[in] address specifies the execution count that should be
* added
*/
virtual void sumWasTaken( uint32_t address, uint32_t addition );
/*!
* This method returns an unsigned integer which indicates how often
* the branch at the specified address was taken.
*
* @param[in] address specifies the address to check
*
* @return Returns number of executins
*/
uint32_t getWasTaken( uint32_t address ) const;
/*!
* This method increments the counter which indicates how many times
* the branch at the specified address was not taken.
*
* @param[in] address specifies the address of the branch instruction
*/
void setWasNotTaken( uint32_t address );
/*!
* This method increases the counter which indicates how many times
* the branch at the specified address was not taken. It is used
* for merging coverage maps.
*
* @param[in] address specifies the address which was executed
* @param[in] address specifies the execution count that should be
* added
*/
virtual void sumWasNotTaken( uint32_t address, uint32_t addition );
/*!
* This method returns an unsigned integer which indicates how often
* the branch at the specified address was not taken.
*
* @param[in] address specifies the address to check
*
* @return Returns number of executins
*/
uint32_t getWasNotTaken( uint32_t address ) const;
/*!
* This method returns a boolean which indicates if the branch
* instruction at the specified address is ALWAYS taken.
*
* @param[in] address specifies the address to check
*
* @return Returns TRUE if the branch instruction at the
* specified address is ALWAYS taken and FALSE otherwise.
*/
bool wasAlwaysTaken( uint32_t address ) const;
/*!
* This method returns a boolean which indicates if the branch
* instruction at the specified address is NEVER taken.
*
* @param[in] address specifies the address to check
*
* @return Returns TRUE if the branch instruction at the
* specified address is NEVER taken and FALSE otherwise.
*/
bool wasNeverTaken( uint32_t address ) const;
/*!
* This method returns a boolean which indicates if the branch
* instruction at the specified address was NOT taken.
*
* @param[in] address specifies the address to check
*
* @return Returns TRUE if the branch instruction at the
* specified address was NOT taken and FALSE otherwise.
*/
bool wasNotTaken( uint32_t address ) const;
/*!
* This method returns a boolean which indicates if the branch
* instruction at the specified address was taken.
*
* @param[in] address specifies the address to check
*
* @return Returns TRUE if the branch instruction at the
* specified address was taken and FALSE otherwise.
*/
bool wasTaken( uint32_t address ) const;
private:
/*!
* The executable file name.
*/
std::string exefileName;
/*!
*
* This is a list of address ranges for this symbolic address.
*/
AddressRanges Ranges;
/*!
* Range checked access to the info.
*/
AddressInfo& getInfo( uint32_t offset );
/*!
* Constant range checked access to the info.
*/
const AddressInfo& getInfo( uint32_t offset ) const;
};
}
#endif
|
