Stefan Reinauer | d37ab45 | 2012-12-18 16:23:28 -0800 | [diff] [blame] | 1 | /* File format for coverage information |
| 2 | Copyright (C) 1996, 1997, 1998, 2000, 2002, |
| 3 | 2003, 2004, 2005, 2008, 2009 Free Software Foundation, Inc. |
| 4 | Contributed by Bob Manson <manson@cygnus.com>. |
| 5 | Completely remangled by Nathan Sidwell <nathan@codesourcery.com>. |
| 6 | |
| 7 | This file is part of GCC. |
| 8 | |
| 9 | GCC is free software; you can redistribute it and/or modify it under |
| 10 | the terms of the GNU General Public License as published by the Free |
| 11 | Software Foundation; either version 3, or (at your option) any later |
| 12 | version. |
| 13 | |
| 14 | GCC is distributed in the hope that it will be useful, but WITHOUT ANY |
| 15 | WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| 16 | FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| 17 | for more details. |
| 18 | |
| 19 | Under Section 7 of GPL version 3, you are granted additional |
| 20 | permissions described in the GCC Runtime Library Exception, version |
| 21 | 3.1, as published by the Free Software Foundation. |
| 22 | |
| 23 | You should have received a copy of the GNU General Public License and |
| 24 | a copy of the GCC Runtime Library Exception along with this program; |
| 25 | see the files COPYING3 and COPYING.RUNTIME respectively. If not, see |
| 26 | <http://www.gnu.org/licenses/>. */ |
| 27 | |
| 28 | |
| 29 | /* Coverage information is held in two files. A notes file, which is |
| 30 | generated by the compiler, and a data file, which is generated by |
| 31 | the program under test. Both files use a similar structure. We do |
| 32 | not attempt to make these files backwards compatible with previous |
| 33 | versions, as you only need coverage information when developing a |
| 34 | program. We do hold version information, so that mismatches can be |
| 35 | detected, and we use a format that allows tools to skip information |
| 36 | they do not understand or are not interested in. |
| 37 | |
| 38 | Numbers are recorded in the 32 bit unsigned binary form of the |
| 39 | endianness of the machine generating the file. 64 bit numbers are |
| 40 | stored as two 32 bit numbers, the low part first. Strings are |
| 41 | padded with 1 to 4 NUL bytes, to bring the length up to a multiple |
| 42 | of 4. The number of 4 bytes is stored, followed by the padded |
| 43 | string. Zero length and NULL strings are simply stored as a length |
| 44 | of zero (they have no trailing NUL or padding). |
| 45 | |
| 46 | int32: byte3 byte2 byte1 byte0 | byte0 byte1 byte2 byte3 |
| 47 | int64: int32:low int32:high |
| 48 | string: int32:0 | int32:length char* char:0 padding |
| 49 | padding: | char:0 | char:0 char:0 | char:0 char:0 char:0 |
| 50 | item: int32 | int64 | string |
| 51 | |
| 52 | The basic format of the files is |
| 53 | |
| 54 | file : int32:magic int32:version int32:stamp record* |
| 55 | |
| 56 | The magic ident is different for the notes and the data files. The |
| 57 | magic ident is used to determine the endianness of the file, when |
| 58 | reading. The version is the same for both files and is derived |
| 59 | from gcc's version number. The stamp value is used to synchronize |
| 60 | note and data files and to synchronize merging within a data |
| 61 | file. It need not be an absolute time stamp, merely a ticker that |
| 62 | increments fast enough and cycles slow enough to distinguish |
| 63 | different compile/run/compile cycles. |
| 64 | |
| 65 | Although the ident and version are formally 32 bit numbers, they |
| 66 | are derived from 4 character ASCII strings. The version number |
| 67 | consists of the single character major version number, a two |
| 68 | character minor version number (leading zero for versions less than |
| 69 | 10), and a single character indicating the status of the release. |
| 70 | That will be 'e' experimental, 'p' prerelease and 'r' for release. |
| 71 | Because, by good fortune, these are in alphabetical order, string |
| 72 | collating can be used to compare version strings. Be aware that |
| 73 | the 'e' designation will (naturally) be unstable and might be |
| 74 | incompatible with itself. For gcc 3.4 experimental, it would be |
| 75 | '304e' (0x33303465). When the major version reaches 10, the |
| 76 | letters A-Z will be used. Assuming minor increments releases every |
| 77 | 6 months, we have to make a major increment every 50 years. |
| 78 | Assuming major increments releases every 5 years, we're ok for the |
| 79 | next 155 years -- good enough for me. |
| 80 | |
| 81 | A record has a tag, length and variable amount of data. |
| 82 | |
| 83 | record: header data |
| 84 | header: int32:tag int32:length |
| 85 | data: item* |
| 86 | |
| 87 | Records are not nested, but there is a record hierarchy. Tag |
| 88 | numbers reflect this hierarchy. Tags are unique across note and |
| 89 | data files. Some record types have a varying amount of data. The |
| 90 | LENGTH is the number of 4bytes that follow and is usually used to |
| 91 | determine how much data. The tag value is split into 4 8-bit |
| 92 | fields, one for each of four possible levels. The most significant |
| 93 | is allocated first. Unused levels are zero. Active levels are |
| 94 | odd-valued, so that the LSB of the level is one. A sub-level |
| 95 | incorporates the values of its superlevels. This formatting allows |
| 96 | you to determine the tag hierarchy, without understanding the tags |
| 97 | themselves, and is similar to the standard section numbering used |
| 98 | in technical documents. Level values [1..3f] are used for common |
| 99 | tags, values [41..9f] for the notes file and [a1..ff] for the data |
| 100 | file. |
| 101 | |
| 102 | The basic block graph file contains the following records |
| 103 | note: unit function-graph* |
| 104 | unit: header int32:checksum string:source |
| 105 | function-graph: announce_function basic_blocks {arcs | lines}* |
| 106 | announce_function: header int32:ident |
| 107 | int32:lineno_checksum int32:cfg_checksum |
| 108 | string:name string:source int32:lineno |
| 109 | basic_block: header int32:flags* |
| 110 | arcs: header int32:block_no arc* |
| 111 | arc: int32:dest_block int32:flags |
| 112 | lines: header int32:block_no line* |
| 113 | int32:0 string:NULL |
| 114 | line: int32:line_no | int32:0 string:filename |
| 115 | |
| 116 | The BASIC_BLOCK record holds per-bb flags. The number of blocks |
| 117 | can be inferred from its data length. There is one ARCS record per |
| 118 | basic block. The number of arcs from a bb is implicit from the |
| 119 | data length. It enumerates the destination bb and per-arc flags. |
| 120 | There is one LINES record per basic block, it enumerates the source |
| 121 | lines which belong to that basic block. Source file names are |
| 122 | introduced by a line number of 0, following lines are from the new |
| 123 | source file. The initial source file for the function is NULL, but |
| 124 | the current source file should be remembered from one LINES record |
| 125 | to the next. The end of a block is indicated by an empty filename |
| 126 | - this does not reset the current source file. Note there is no |
| 127 | ordering of the ARCS and LINES records: they may be in any order, |
| 128 | interleaved in any manner. The current filename follows the order |
| 129 | the LINES records are stored in the file, *not* the ordering of the |
| 130 | blocks they are for. |
| 131 | |
| 132 | The data file contains the following records. |
| 133 | data: {unit summary:object summary:program* function-data*}* |
| 134 | unit: header int32:checksum |
| 135 | function-data: announce_function present counts |
| 136 | announce_function: header int32:ident |
| 137 | int32:lineno_checksum int32:cfg_checksum |
| 138 | present: header int32:present |
| 139 | counts: header int64:count* |
| 140 | summary: int32:checksum {count-summary}GCOV_COUNTERS_SUMMABLE |
| 141 | count-summary: int32:num int32:runs int64:sum |
| 142 | int64:max int64:sum_max |
| 143 | |
| 144 | The ANNOUNCE_FUNCTION record is the same as that in the note file, |
| 145 | but without the source location. The COUNTS gives the |
| 146 | counter values for instrumented features. The about the whole |
| 147 | program. The checksum is used for whole program summaries, and |
| 148 | disambiguates different programs which include the same |
| 149 | instrumented object file. There may be several program summaries, |
| 150 | each with a unique checksum. The object summary's checksum is |
| 151 | zero. Note that the data file might contain information from |
| 152 | several runs concatenated, or the data might be merged. |
| 153 | |
| 154 | This file is included by both the compiler, gcov tools and the |
| 155 | runtime support library libgcov. IN_LIBGCOV and IN_GCOV are used to |
| 156 | distinguish which case is which. If IN_LIBGCOV is nonzero, |
| 157 | libgcov is being built. If IN_GCOV is nonzero, the gcov tools are |
| 158 | being built. Otherwise the compiler is being built. IN_GCOV may be |
| 159 | positive or negative. If positive, we are compiling a tool that |
| 160 | requires additional functions (see the code for knowledge of what |
| 161 | those functions are). */ |
| 162 | |
| 163 | #ifndef GCC_GCOV_IO_H |
| 164 | #define GCC_GCOV_IO_H |
| 165 | |
| 166 | #ifdef __COREBOOT__ |
| 167 | #define GCOV_LINKAGE /* nothing */ |
| 168 | /* We need the definitions for |
| 169 | BITS_PER_UNIT and |
| 170 | LONG_LONG_TYPE_SIZE |
| 171 | They are defined in gcc/defaults.h and gcc/config/<arch_depend_files> |
| 172 | (like, gcc/config/i386/i386.h). And it can be overridden by setting |
| 173 | in build scripts. Here I hardcoded the value for x86. */ |
| 174 | #define BITS_PER_UNIT 8 |
| 175 | #define LONG_LONG_TYPE_SIZE 64 |
| 176 | |
| 177 | /* There are many gcc_assertions. Set the vaule to 1 if we want a warning |
| 178 | message if the assertion fails. */ |
| 179 | #ifndef ENABLE_ASSERT_CHECKING |
| 180 | #define ENABLE_ASSERT_CHECKING 1 |
| 181 | #endif |
| 182 | #endif /* __COREBOOT__ */ |
| 183 | |
| 184 | #if IN_LIBGCOV |
| 185 | /* About the target */ |
| 186 | |
| 187 | #if BITS_PER_UNIT == 8 |
| 188 | typedef unsigned gcov_unsigned_t __attribute__ ((mode (SI))); |
| 189 | typedef unsigned gcov_position_t __attribute__ ((mode (SI))); |
| 190 | #if LONG_LONG_TYPE_SIZE > 32 |
| 191 | typedef signed gcov_type __attribute__ ((mode (DI))); |
| 192 | #else |
| 193 | typedef signed gcov_type __attribute__ ((mode (SI))); |
| 194 | #endif |
| 195 | #else |
| 196 | #if BITS_PER_UNIT == 16 |
| 197 | typedef unsigned gcov_unsigned_t __attribute__ ((mode (HI))); |
| 198 | typedef unsigned gcov_position_t __attribute__ ((mode (HI))); |
| 199 | #if LONG_LONG_TYPE_SIZE > 32 |
| 200 | typedef signed gcov_type __attribute__ ((mode (SI))); |
| 201 | #else |
| 202 | typedef signed gcov_type __attribute__ ((mode (HI))); |
| 203 | #endif |
| 204 | #else |
| 205 | typedef unsigned gcov_unsigned_t __attribute__ ((mode (QI))); |
| 206 | typedef unsigned gcov_position_t __attribute__ ((mode (QI))); |
| 207 | #if LONG_LONG_TYPE_SIZE > 32 |
| 208 | typedef signed gcov_type __attribute__ ((mode (HI))); |
| 209 | #else |
| 210 | typedef signed gcov_type __attribute__ ((mode (QI))); |
| 211 | #endif |
| 212 | #endif |
| 213 | #endif |
| 214 | |
| 215 | |
| 216 | #if defined (TARGET_POSIX_IO) |
| 217 | #define GCOV_LOCKED 1 |
| 218 | #else |
| 219 | #define GCOV_LOCKED 0 |
| 220 | #endif |
| 221 | |
| 222 | #else /* !IN_LIBGCOV */ |
| 223 | /* About the host */ |
| 224 | |
| 225 | typedef unsigned gcov_unsigned_t; |
| 226 | typedef unsigned gcov_position_t; |
| 227 | /* gcov_type is typedef'd elsewhere for the compiler */ |
| 228 | #if IN_GCOV |
| 229 | #define GCOV_LINKAGE static |
| 230 | typedef HOST_WIDEST_INT gcov_type; |
| 231 | #if IN_GCOV > 0 |
| 232 | #include <sys/types.h> |
| 233 | #endif |
| 234 | #else /*!IN_GCOV */ |
| 235 | #define GCOV_TYPE_SIZE (LONG_LONG_TYPE_SIZE > 32 ? 64 : 32) |
| 236 | #endif |
| 237 | |
| 238 | #if defined (HOST_HAS_F_SETLKW) |
| 239 | #define GCOV_LOCKED 1 |
| 240 | #else |
| 241 | #define GCOV_LOCKED 0 |
| 242 | #endif |
| 243 | |
| 244 | #endif /* !IN_LIBGCOV */ |
| 245 | |
| 246 | /* In gcov we want function linkage to be static. In the compiler we want |
| 247 | it extern, so that they can be accessed from elsewhere. In libgcov we |
| 248 | need these functions to be extern, so prefix them with __gcov. In |
| 249 | libgcov they must also be hidden so that the instance in the executable |
| 250 | is not also used in a DSO. */ |
| 251 | #if IN_LIBGCOV |
| 252 | |
| 253 | #ifndef __COREBOOT__ |
| 254 | #include "tconfig.h" |
| 255 | #endif /* __COREBOOT__ */ |
| 256 | |
| 257 | #define gcov_var __gcov_var |
| 258 | #define gcov_open __gcov_open |
| 259 | #define gcov_close __gcov_close |
| 260 | #define gcov_write_tag_length __gcov_write_tag_length |
| 261 | #define gcov_position __gcov_position |
| 262 | #define gcov_seek __gcov_seek |
| 263 | #define gcov_rewrite __gcov_rewrite |
| 264 | #define gcov_is_error __gcov_is_error |
| 265 | #define gcov_write_unsigned __gcov_write_unsigned |
| 266 | #define gcov_write_counter __gcov_write_counter |
| 267 | #define gcov_write_summary __gcov_write_summary |
| 268 | #define gcov_read_unsigned __gcov_read_unsigned |
| 269 | #define gcov_read_counter __gcov_read_counter |
| 270 | #define gcov_read_summary __gcov_read_summary |
| 271 | |
| 272 | /* Poison these, so they don't accidentally slip in. */ |
| 273 | #pragma GCC poison gcov_write_string gcov_write_tag gcov_write_length |
| 274 | #pragma GCC poison gcov_read_string gcov_sync gcov_time gcov_magic |
| 275 | |
| 276 | #ifdef HAVE_GAS_HIDDEN |
| 277 | #define ATTRIBUTE_HIDDEN __attribute__ ((__visibility__ ("hidden"))) |
| 278 | #else |
| 279 | #define ATTRIBUTE_HIDDEN |
| 280 | #endif |
| 281 | |
| 282 | #else |
| 283 | |
| 284 | #define ATTRIBUTE_HIDDEN |
| 285 | |
| 286 | #endif |
| 287 | |
| 288 | #ifndef GCOV_LINKAGE |
| 289 | #define GCOV_LINKAGE extern |
| 290 | #endif |
| 291 | |
| 292 | /* File suffixes. */ |
| 293 | #define GCOV_DATA_SUFFIX ".gcda" |
| 294 | #define GCOV_NOTE_SUFFIX ".gcno" |
| 295 | |
| 296 | /* File magic. Must not be palindromes. */ |
| 297 | #define GCOV_DATA_MAGIC ((gcov_unsigned_t)0x67636461) /* "gcda" */ |
| 298 | #define GCOV_NOTE_MAGIC ((gcov_unsigned_t)0x67636e6f) /* "gcno" */ |
| 299 | |
| 300 | /* gcov-iov.h is automatically generated by the makefile from |
| 301 | version.c, it looks like |
| 302 | #define GCOV_VERSION ((gcov_unsigned_t)0x89abcdef) |
| 303 | */ |
| 304 | #include "gcov-iov.h" |
| 305 | |
| 306 | /* Convert a magic or version number to a 4 character string. */ |
| 307 | #define GCOV_UNSIGNED2STRING(ARRAY,VALUE) \ |
| 308 | ((ARRAY)[0] = (char)((VALUE) >> 24), \ |
| 309 | (ARRAY)[1] = (char)((VALUE) >> 16), \ |
| 310 | (ARRAY)[2] = (char)((VALUE) >> 8), \ |
| 311 | (ARRAY)[3] = (char)((VALUE) >> 0)) |
| 312 | |
| 313 | /* The record tags. Values [1..3f] are for tags which may be in either |
| 314 | file. Values [41..9f] for those in the note file and [a1..ff] for |
| 315 | the data file. The tag value zero is used as an explicit end of |
| 316 | file marker -- it is not required to be present. */ |
| 317 | |
| 318 | #define GCOV_TAG_FUNCTION ((gcov_unsigned_t)0x01000000) |
| 319 | #define GCOV_TAG_FUNCTION_LENGTH (3) |
| 320 | #define GCOV_TAG_BLOCKS ((gcov_unsigned_t)0x01410000) |
| 321 | #define GCOV_TAG_BLOCKS_LENGTH(NUM) (NUM) |
| 322 | #define GCOV_TAG_BLOCKS_NUM(LENGTH) (LENGTH) |
| 323 | #define GCOV_TAG_ARCS ((gcov_unsigned_t)0x01430000) |
| 324 | #define GCOV_TAG_ARCS_LENGTH(NUM) (1 + (NUM) * 2) |
| 325 | #define GCOV_TAG_ARCS_NUM(LENGTH) (((LENGTH) - 1) / 2) |
| 326 | #define GCOV_TAG_LINES ((gcov_unsigned_t)0x01450000) |
| 327 | #define GCOV_TAG_COUNTER_BASE ((gcov_unsigned_t)0x01a10000) |
| 328 | #define GCOV_TAG_COUNTER_LENGTH(NUM) ((NUM) * 2) |
| 329 | #define GCOV_TAG_COUNTER_NUM(LENGTH) ((LENGTH) / 2) |
| 330 | #define GCOV_TAG_OBJECT_SUMMARY ((gcov_unsigned_t)0xa1000000) /* Obsolete */ |
| 331 | #define GCOV_TAG_PROGRAM_SUMMARY ((gcov_unsigned_t)0xa3000000) |
| 332 | #define GCOV_TAG_SUMMARY_LENGTH \ |
| 333 | (1 + GCOV_COUNTERS_SUMMABLE * (2 + 3 * 2)) |
| 334 | |
| 335 | /* Counters that are collected. */ |
| 336 | #define GCOV_COUNTER_ARCS 0 /* Arc transitions. */ |
| 337 | #define GCOV_COUNTERS_SUMMABLE 1 /* Counters which can be |
| 338 | summaried. */ |
| 339 | #define GCOV_FIRST_VALUE_COUNTER 1 /* The first of counters used for value |
| 340 | profiling. They must form a consecutive |
| 341 | interval and their order must match |
| 342 | the order of HIST_TYPEs in |
| 343 | value-prof.h. */ |
| 344 | #define GCOV_COUNTER_V_INTERVAL 1 /* Histogram of value inside an interval. */ |
| 345 | #define GCOV_COUNTER_V_POW2 2 /* Histogram of exact power2 logarithm |
| 346 | of a value. */ |
| 347 | #define GCOV_COUNTER_V_SINGLE 3 /* The most common value of expression. */ |
| 348 | #define GCOV_COUNTER_V_DELTA 4 /* The most common difference between |
| 349 | consecutive values of expression. */ |
| 350 | |
| 351 | #define GCOV_COUNTER_V_INDIR 5 /* The most common indirect address */ |
| 352 | #define GCOV_COUNTER_AVERAGE 6 /* Compute average value passed to the |
| 353 | counter. */ |
| 354 | #define GCOV_COUNTER_IOR 7 /* IOR of the all values passed to |
| 355 | counter. */ |
| 356 | #define GCOV_LAST_VALUE_COUNTER 7 /* The last of counters used for value |
| 357 | profiling. */ |
| 358 | #define GCOV_COUNTERS 8 |
| 359 | |
| 360 | /* Number of counters used for value profiling. */ |
| 361 | #define GCOV_N_VALUE_COUNTERS \ |
| 362 | (GCOV_LAST_VALUE_COUNTER - GCOV_FIRST_VALUE_COUNTER + 1) |
| 363 | |
| 364 | /* A list of human readable names of the counters */ |
| 365 | #define GCOV_COUNTER_NAMES {"arcs", "interval", "pow2", "single", \ |
| 366 | "delta", "indirect_call", "average", "ior"} |
| 367 | |
| 368 | /* Names of merge functions for counters. */ |
| 369 | #define GCOV_MERGE_FUNCTIONS {"__gcov_merge_add", \ |
| 370 | "__gcov_merge_add", \ |
| 371 | "__gcov_merge_add", \ |
| 372 | "__gcov_merge_single", \ |
| 373 | "__gcov_merge_delta", \ |
| 374 | "__gcov_merge_single", \ |
| 375 | "__gcov_merge_add", \ |
| 376 | "__gcov_merge_ior"} |
| 377 | |
| 378 | /* Convert a counter index to a tag. */ |
| 379 | #define GCOV_TAG_FOR_COUNTER(COUNT) \ |
| 380 | (GCOV_TAG_COUNTER_BASE + ((gcov_unsigned_t)(COUNT) << 17)) |
| 381 | /* Convert a tag to a counter. */ |
| 382 | #define GCOV_COUNTER_FOR_TAG(TAG) \ |
| 383 | ((unsigned)(((TAG) - GCOV_TAG_COUNTER_BASE) >> 17)) |
| 384 | /* Check whether a tag is a counter tag. */ |
| 385 | #define GCOV_TAG_IS_COUNTER(TAG) \ |
| 386 | (!((TAG) & 0xFFFF) && GCOV_COUNTER_FOR_TAG (TAG) < GCOV_COUNTERS) |
| 387 | |
| 388 | /* The tag level mask has 1's in the position of the inner levels, & |
| 389 | the lsb of the current level, and zero on the current and outer |
| 390 | levels. */ |
| 391 | #define GCOV_TAG_MASK(TAG) (((TAG) - 1) ^ (TAG)) |
| 392 | |
| 393 | /* Return nonzero if SUB is an immediate subtag of TAG. */ |
| 394 | #define GCOV_TAG_IS_SUBTAG(TAG,SUB) \ |
| 395 | (GCOV_TAG_MASK (TAG) >> 8 == GCOV_TAG_MASK (SUB) \ |
| 396 | && !(((SUB) ^ (TAG)) & ~GCOV_TAG_MASK(TAG))) |
| 397 | |
| 398 | /* Return nonzero if SUB is at a sublevel to TAG. */ |
| 399 | #define GCOV_TAG_IS_SUBLEVEL(TAG,SUB) \ |
| 400 | (GCOV_TAG_MASK (TAG) > GCOV_TAG_MASK (SUB)) |
| 401 | |
| 402 | /* Basic block flags. */ |
| 403 | #define GCOV_BLOCK_UNEXPECTED (1 << 1) |
| 404 | |
| 405 | /* Arc flags. */ |
| 406 | #define GCOV_ARC_ON_TREE (1 << 0) |
| 407 | #define GCOV_ARC_FAKE (1 << 1) |
| 408 | #define GCOV_ARC_FALLTHROUGH (1 << 2) |
| 409 | |
| 410 | /* Structured records. */ |
| 411 | |
| 412 | /* Cumulative counter data. */ |
| 413 | struct gcov_ctr_summary |
| 414 | { |
| 415 | gcov_unsigned_t num; /* number of counters. */ |
| 416 | gcov_unsigned_t runs; /* number of program runs */ |
| 417 | gcov_type sum_all; /* sum of all counters accumulated. */ |
| 418 | gcov_type run_max; /* maximum value on a single run. */ |
| 419 | gcov_type sum_max; /* sum of individual run max values. */ |
| 420 | }; |
| 421 | |
| 422 | /* Object & program summary record. */ |
| 423 | struct gcov_summary |
| 424 | { |
| 425 | gcov_unsigned_t checksum; /* checksum of program */ |
| 426 | struct gcov_ctr_summary ctrs[GCOV_COUNTERS_SUMMABLE]; |
| 427 | }; |
| 428 | |
| 429 | /* Structures embedded in coveraged program. The structures generated |
| 430 | by write_profile must match these. */ |
| 431 | |
| 432 | #if IN_LIBGCOV |
| 433 | /* Information about counters for a single function. */ |
| 434 | struct gcov_ctr_info |
| 435 | { |
| 436 | gcov_unsigned_t num; /* number of counters. */ |
| 437 | gcov_type *values; /* their values. */ |
| 438 | }; |
| 439 | |
| 440 | /* Information about a single function. This uses the trailing array |
| 441 | idiom. The number of counters is determined from the merge pointer |
| 442 | array in gcov_info. The key is used to detect which of a set of |
| 443 | comdat functions was selected -- it points to the gcov_info object |
| 444 | of the object file containing the selected comdat function. */ |
| 445 | |
| 446 | struct gcov_fn_info |
| 447 | { |
| 448 | const struct gcov_info *key; /* comdat key */ |
| 449 | gcov_unsigned_t ident; /* unique ident of function */ |
| 450 | gcov_unsigned_t lineno_checksum; /* function lineo_checksum */ |
| 451 | gcov_unsigned_t cfg_checksum; /* function cfg checksum */ |
| 452 | struct gcov_ctr_info ctrs[0]; /* instrumented counters */ |
| 453 | }; |
| 454 | |
| 455 | /* Type of function used to merge counters. */ |
| 456 | typedef void (*gcov_merge_fn) (gcov_type *, gcov_unsigned_t); |
| 457 | |
| 458 | /* Information about a single object file. */ |
| 459 | struct gcov_info |
| 460 | { |
| 461 | gcov_unsigned_t version; /* expected version number */ |
| 462 | struct gcov_info *next; /* link to next, used by libgcov */ |
| 463 | |
| 464 | gcov_unsigned_t stamp; /* uniquifying time stamp */ |
| 465 | const char *filename; /* output file name */ |
| 466 | |
| 467 | gcov_merge_fn merge[GCOV_COUNTERS]; /* merge functions (null for |
| 468 | unused) */ |
| 469 | |
| 470 | unsigned n_functions; /* number of functions */ |
| 471 | const struct gcov_fn_info *const *functions; /* pointer to pointers |
| 472 | to function information */ |
| 473 | }; |
| 474 | |
| 475 | /* Register a new object file module. */ |
| 476 | extern void __gcov_init (struct gcov_info *) ATTRIBUTE_HIDDEN; |
| 477 | |
| 478 | #ifndef __COREBOOT__ |
| 479 | /* Called before fork, to avoid double counting. */ |
| 480 | extern void __gcov_flush (void) ATTRIBUTE_HIDDEN; |
| 481 | #endif |
| 482 | |
| 483 | /* The merge function that just sums the counters. */ |
| 484 | extern void __gcov_merge_add (gcov_type *, unsigned) ATTRIBUTE_HIDDEN; |
| 485 | |
| 486 | /* The merge function to choose the most common value. */ |
| 487 | extern void __gcov_merge_single (gcov_type *, unsigned) ATTRIBUTE_HIDDEN; |
| 488 | |
| 489 | /* The merge function to choose the most common difference between |
| 490 | consecutive values. */ |
| 491 | extern void __gcov_merge_delta (gcov_type *, unsigned) ATTRIBUTE_HIDDEN; |
| 492 | |
| 493 | /* The merge function that just ors the counters together. */ |
| 494 | extern void __gcov_merge_ior (gcov_type *, unsigned) ATTRIBUTE_HIDDEN; |
| 495 | |
| 496 | /* The profiler functions. */ |
| 497 | extern void __gcov_interval_profiler (gcov_type *, gcov_type, int, unsigned); |
| 498 | extern void __gcov_pow2_profiler (gcov_type *, gcov_type); |
| 499 | extern void __gcov_one_value_profiler (gcov_type *, gcov_type); |
| 500 | extern void __gcov_indirect_call_profiler (gcov_type *, gcov_type, void *, void *); |
| 501 | extern void __gcov_average_profiler (gcov_type *, gcov_type); |
| 502 | extern void __gcov_ior_profiler (gcov_type *, gcov_type); |
| 503 | |
| 504 | #ifndef inhibit_libc |
| 505 | /* The wrappers around some library functions.. */ |
| 506 | extern pid_t __gcov_fork (void) ATTRIBUTE_HIDDEN; |
| 507 | extern int __gcov_execl (const char *, char *, ...) ATTRIBUTE_HIDDEN; |
| 508 | extern int __gcov_execlp (const char *, char *, ...) ATTRIBUTE_HIDDEN; |
| 509 | extern int __gcov_execle (const char *, char *, ...) ATTRIBUTE_HIDDEN; |
| 510 | extern int __gcov_execv (const char *, char *const []) ATTRIBUTE_HIDDEN; |
| 511 | extern int __gcov_execvp (const char *, char *const []) ATTRIBUTE_HIDDEN; |
| 512 | extern int __gcov_execve (const char *, char *const [], char *const []) |
| 513 | ATTRIBUTE_HIDDEN; |
| 514 | #endif |
| 515 | |
| 516 | #endif /* IN_LIBGCOV */ |
| 517 | |
| 518 | #if IN_LIBGCOV >= 0 |
| 519 | |
| 520 | /* Optimum number of gcov_unsigned_t's read from or written to disk. */ |
| 521 | #define GCOV_BLOCK_SIZE (1 << 10) |
| 522 | |
| 523 | GCOV_LINKAGE struct gcov_var |
| 524 | { |
| 525 | FILE *file; |
| 526 | gcov_position_t start; /* Position of first byte of block */ |
| 527 | unsigned offset; /* Read/write position within the block. */ |
| 528 | unsigned length; /* Read limit in the block. */ |
| 529 | unsigned overread; /* Number of words overread. */ |
| 530 | int error; /* < 0 overflow, > 0 disk error. */ |
| 531 | int mode; /* < 0 writing, > 0 reading */ |
| 532 | #if IN_LIBGCOV |
| 533 | /* Holds one block plus 4 bytes, thus all coverage reads & writes |
| 534 | fit within this buffer and we always can transfer GCOV_BLOCK_SIZE |
| 535 | to and from the disk. libgcov never backtracks and only writes 4 |
| 536 | or 8 byte objects. */ |
| 537 | gcov_unsigned_t buffer[GCOV_BLOCK_SIZE + 1]; |
| 538 | #else |
| 539 | int endian; /* Swap endianness. */ |
| 540 | /* Holds a variable length block, as the compiler can write |
| 541 | strings and needs to backtrack. */ |
| 542 | size_t alloc; |
| 543 | gcov_unsigned_t *buffer; |
| 544 | #endif |
| 545 | } gcov_var ATTRIBUTE_HIDDEN; |
| 546 | |
| 547 | /* Functions for reading and writing gcov files. In libgcov you can |
| 548 | open the file for reading then writing. Elsewhere you can open the |
| 549 | file either for reading or for writing. When reading a file you may |
| 550 | use the gcov_read_* functions, gcov_sync, gcov_position, & |
| 551 | gcov_error. When writing a file you may use the gcov_write |
| 552 | functions, gcov_seek & gcov_error. When a file is to be rewritten |
| 553 | you use the functions for reading, then gcov_rewrite then the |
| 554 | functions for writing. Your file may become corrupted if you break |
| 555 | these invariants. */ |
| 556 | #if IN_LIBGCOV |
| 557 | GCOV_LINKAGE int gcov_open (const char */*name*/) ATTRIBUTE_HIDDEN; |
| 558 | #else |
| 559 | GCOV_LINKAGE int gcov_open (const char */*name*/, int /*direction*/); |
| 560 | GCOV_LINKAGE int gcov_magic (gcov_unsigned_t, gcov_unsigned_t); |
| 561 | #endif |
| 562 | GCOV_LINKAGE int gcov_close (void) ATTRIBUTE_HIDDEN; |
| 563 | |
| 564 | /* Available everywhere. */ |
| 565 | static gcov_position_t gcov_position (void); |
| 566 | static int gcov_is_error (void); |
| 567 | |
| 568 | GCOV_LINKAGE gcov_unsigned_t gcov_read_unsigned (void) ATTRIBUTE_HIDDEN; |
| 569 | GCOV_LINKAGE gcov_type gcov_read_counter (void) ATTRIBUTE_HIDDEN; |
| 570 | GCOV_LINKAGE void gcov_read_summary (struct gcov_summary *) ATTRIBUTE_HIDDEN; |
| 571 | |
| 572 | #if IN_LIBGCOV |
| 573 | /* Available only in libgcov */ |
| 574 | GCOV_LINKAGE void gcov_write_counter (gcov_type) ATTRIBUTE_HIDDEN; |
| 575 | GCOV_LINKAGE void gcov_write_tag_length (gcov_unsigned_t, gcov_unsigned_t) |
| 576 | ATTRIBUTE_HIDDEN; |
| 577 | GCOV_LINKAGE void gcov_write_summary (gcov_unsigned_t /*tag*/, |
| 578 | const struct gcov_summary *) |
| 579 | ATTRIBUTE_HIDDEN; |
| 580 | static void gcov_rewrite (void); |
| 581 | GCOV_LINKAGE void gcov_seek (gcov_position_t /*position*/) ATTRIBUTE_HIDDEN; |
| 582 | #else |
| 583 | /* Available outside libgcov */ |
| 584 | GCOV_LINKAGE const char *gcov_read_string (void); |
| 585 | GCOV_LINKAGE void gcov_sync (gcov_position_t /*base*/, |
| 586 | gcov_unsigned_t /*length */); |
| 587 | #endif |
| 588 | |
| 589 | #if !IN_GCOV |
| 590 | /* Available outside gcov */ |
| 591 | GCOV_LINKAGE void gcov_write_unsigned (gcov_unsigned_t) ATTRIBUTE_HIDDEN; |
| 592 | #endif |
| 593 | |
| 594 | #if !IN_GCOV && !IN_LIBGCOV |
| 595 | /* Available only in compiler */ |
| 596 | GCOV_LINKAGE void gcov_write_string (const char *); |
| 597 | GCOV_LINKAGE gcov_position_t gcov_write_tag (gcov_unsigned_t); |
| 598 | GCOV_LINKAGE void gcov_write_length (gcov_position_t /*position*/); |
| 599 | #endif |
| 600 | |
| 601 | #if IN_GCOV > 0 |
| 602 | /* Available in gcov */ |
| 603 | GCOV_LINKAGE time_t gcov_time (void); |
| 604 | #endif |
| 605 | |
| 606 | /* Save the current position in the gcov file. */ |
| 607 | |
| 608 | static inline gcov_position_t |
| 609 | gcov_position (void) |
| 610 | { |
| 611 | gcc_assert (gcov_var.mode > 0); |
| 612 | return gcov_var.start + gcov_var.offset; |
| 613 | } |
| 614 | |
| 615 | /* Return nonzero if the error flag is set. */ |
| 616 | |
| 617 | static inline int |
| 618 | gcov_is_error (void) |
| 619 | { |
| 620 | return gcov_var.file ? gcov_var.error : 1; |
| 621 | } |
| 622 | |
| 623 | #if IN_LIBGCOV |
| 624 | /* Move to beginning of file and initialize for writing. */ |
| 625 | |
| 626 | static inline void |
| 627 | gcov_rewrite (void) |
| 628 | { |
| 629 | gcc_assert (gcov_var.mode > 0); |
| 630 | gcov_var.mode = -1; |
| 631 | gcov_var.start = 0; |
| 632 | gcov_var.offset = 0; |
| 633 | fseek (gcov_var.file, 0L, SEEK_SET); |
| 634 | } |
| 635 | #endif |
| 636 | |
| 637 | #endif /* IN_LIBGCOV >= 0 */ |
| 638 | |
| 639 | #endif /* GCC_GCOV_IO_H */ |