GCDAProfiling.c revision 5e436b3b0ef06258ed2d7929946eb00684973183
1b1928704201034c785a26296a49f69355eb56a05Nick Lewycky/*===- GCDAProfiling.c - Support library for GCDA file emission -----------===*\ 2b1928704201034c785a26296a49f69355eb56a05Nick Lewycky|* 3b1928704201034c785a26296a49f69355eb56a05Nick Lewycky|* The LLVM Compiler Infrastructure 4b1928704201034c785a26296a49f69355eb56a05Nick Lewycky|* 5b1928704201034c785a26296a49f69355eb56a05Nick Lewycky|* This file is distributed under the University of Illinois Open Source 6b1928704201034c785a26296a49f69355eb56a05Nick Lewycky|* License. See LICENSE.TXT for details. 7b1928704201034c785a26296a49f69355eb56a05Nick Lewycky|* 8b1928704201034c785a26296a49f69355eb56a05Nick Lewycky|*===----------------------------------------------------------------------===*| 9b1928704201034c785a26296a49f69355eb56a05Nick Lewycky|* 10b1928704201034c785a26296a49f69355eb56a05Nick Lewycky|* This file implements the call back routines for the gcov profiling 11b1928704201034c785a26296a49f69355eb56a05Nick Lewycky|* instrumentation pass. Link against this library when running code through 12b1928704201034c785a26296a49f69355eb56a05Nick Lewycky|* the -insert-gcov-profiling LLVM pass. 13b1928704201034c785a26296a49f69355eb56a05Nick Lewycky|* 14b1928704201034c785a26296a49f69355eb56a05Nick Lewycky|* We emit files in a corrupt version of GCOV's "gcda" file format. These files 15b1928704201034c785a26296a49f69355eb56a05Nick Lewycky|* are only close enough that LCOV will happily parse them. Anything that lcov 16b1928704201034c785a26296a49f69355eb56a05Nick Lewycky|* ignores is missing. 17b1928704201034c785a26296a49f69355eb56a05Nick Lewycky|* 181790c9cbb6714e81eab1412909a2320acaecc43bNick Lewycky|* TODO: gcov is multi-process safe by having each exit open the existing file 191790c9cbb6714e81eab1412909a2320acaecc43bNick Lewycky|* and append to it. We'd like to achieve that and be thread-safe too. 201790c9cbb6714e81eab1412909a2320acaecc43bNick Lewycky|* 21b1928704201034c785a26296a49f69355eb56a05Nick Lewycky\*===----------------------------------------------------------------------===*/ 22b1928704201034c785a26296a49f69355eb56a05Nick Lewycky 23b1928704201034c785a26296a49f69355eb56a05Nick Lewycky#include "llvm/Support/DataTypes.h" 24b1928704201034c785a26296a49f69355eb56a05Nick Lewycky#include <stdio.h> 25b1928704201034c785a26296a49f69355eb56a05Nick Lewycky#include <stdlib.h> 26b1928704201034c785a26296a49f69355eb56a05Nick Lewycky#include <string.h> 275e436b3b0ef06258ed2d7929946eb00684973183Nick Lewycky#include <sys/stat.h> 285e436b3b0ef06258ed2d7929946eb00684973183Nick Lewycky#include <sys/types.h> 29b1928704201034c785a26296a49f69355eb56a05Nick Lewycky 30ece78a30bdd4c26edcd5304aca1415ebc8b27756Nick Lewycky/* #define DEBUG_GCDAPROFILING */ 31b1928704201034c785a26296a49f69355eb56a05Nick Lewycky 32b1928704201034c785a26296a49f69355eb56a05Nick Lewycky/* 33b1928704201034c785a26296a49f69355eb56a05Nick Lewycky * --- GCOV file format I/O primitives --- 34b1928704201034c785a26296a49f69355eb56a05Nick Lewycky */ 35b1928704201034c785a26296a49f69355eb56a05Nick Lewycky 36b1928704201034c785a26296a49f69355eb56a05Nick Lewyckystatic FILE *output_file = NULL; 37b1928704201034c785a26296a49f69355eb56a05Nick Lewycky 38b1928704201034c785a26296a49f69355eb56a05Nick Lewyckystatic void write_int32(uint32_t i) { 39b1928704201034c785a26296a49f69355eb56a05Nick Lewycky fwrite(&i, 4, 1, output_file); 40b1928704201034c785a26296a49f69355eb56a05Nick Lewycky} 41b1928704201034c785a26296a49f69355eb56a05Nick Lewycky 42b1928704201034c785a26296a49f69355eb56a05Nick Lewyckystatic void write_int64(uint64_t i) { 43b1928704201034c785a26296a49f69355eb56a05Nick Lewycky uint32_t lo, hi; 44571c0e95fa74c570f1c42f15b63ba8c68cba86b1Benjamin Kramer lo = i >> 0; 45571c0e95fa74c570f1c42f15b63ba8c68cba86b1Benjamin Kramer hi = i >> 32; 46b1928704201034c785a26296a49f69355eb56a05Nick Lewycky 47b1928704201034c785a26296a49f69355eb56a05Nick Lewycky write_int32(lo); 48b1928704201034c785a26296a49f69355eb56a05Nick Lewycky write_int32(hi); 49b1928704201034c785a26296a49f69355eb56a05Nick Lewycky} 50b1928704201034c785a26296a49f69355eb56a05Nick Lewycky 517a2ba2fbe4b0ccaacc2cedbc1bfd2a3764170efeNick Lewyckystatic char *mangle_filename(const char *orig_filename) { 527a2ba2fbe4b0ccaacc2cedbc1bfd2a3764170efeNick Lewycky /* TODO: handle GCOV_PREFIX_STRIP */ 537a2ba2fbe4b0ccaacc2cedbc1bfd2a3764170efeNick Lewycky const char *prefix; 547a2ba2fbe4b0ccaacc2cedbc1bfd2a3764170efeNick Lewycky char *filename = 0; 557a2ba2fbe4b0ccaacc2cedbc1bfd2a3764170efeNick Lewycky 567a2ba2fbe4b0ccaacc2cedbc1bfd2a3764170efeNick Lewycky prefix = getenv("GCOV_PREFIX"); 577a2ba2fbe4b0ccaacc2cedbc1bfd2a3764170efeNick Lewycky 587a2ba2fbe4b0ccaacc2cedbc1bfd2a3764170efeNick Lewycky if (!prefix) 59d006ddc195934cf896d2f5e512d38e196923c79bNick Lewycky return strdup(orig_filename); 607a2ba2fbe4b0ccaacc2cedbc1bfd2a3764170efeNick Lewycky 617a2ba2fbe4b0ccaacc2cedbc1bfd2a3764170efeNick Lewycky filename = malloc(strlen(prefix) + 1 + strlen(orig_filename) + 1); 627a2ba2fbe4b0ccaacc2cedbc1bfd2a3764170efeNick Lewycky strcpy(filename, prefix); 637a2ba2fbe4b0ccaacc2cedbc1bfd2a3764170efeNick Lewycky strcat(filename, "/"); 647a2ba2fbe4b0ccaacc2cedbc1bfd2a3764170efeNick Lewycky strcat(filename, orig_filename); 657a2ba2fbe4b0ccaacc2cedbc1bfd2a3764170efeNick Lewycky 667a2ba2fbe4b0ccaacc2cedbc1bfd2a3764170efeNick Lewycky return filename; 677a2ba2fbe4b0ccaacc2cedbc1bfd2a3764170efeNick Lewycky} 687a2ba2fbe4b0ccaacc2cedbc1bfd2a3764170efeNick Lewycky 695e436b3b0ef06258ed2d7929946eb00684973183Nick Lewyckystatic void recursive_mkdir(const char *filename) { 705e436b3b0ef06258ed2d7929946eb00684973183Nick Lewycky char *pathname; 715e436b3b0ef06258ed2d7929946eb00684973183Nick Lewycky int i, e; 725e436b3b0ef06258ed2d7929946eb00684973183Nick Lewycky 735e436b3b0ef06258ed2d7929946eb00684973183Nick Lewycky for (i = 1, e = strlen(filename); i != e; ++i) { 745e436b3b0ef06258ed2d7929946eb00684973183Nick Lewycky if (filename[i] == '/') { 755e436b3b0ef06258ed2d7929946eb00684973183Nick Lewycky pathname = malloc(i + 1); 765e436b3b0ef06258ed2d7929946eb00684973183Nick Lewycky strncpy(pathname, filename, i); 775e436b3b0ef06258ed2d7929946eb00684973183Nick Lewycky pathname[i] = '\0'; 785e436b3b0ef06258ed2d7929946eb00684973183Nick Lewycky mkdir(pathname, 0750); /* some of these will fail, ignore it. */ 795e436b3b0ef06258ed2d7929946eb00684973183Nick Lewycky free(pathname); 805e436b3b0ef06258ed2d7929946eb00684973183Nick Lewycky } 815e436b3b0ef06258ed2d7929946eb00684973183Nick Lewycky } 825e436b3b0ef06258ed2d7929946eb00684973183Nick Lewycky} 835e436b3b0ef06258ed2d7929946eb00684973183Nick Lewycky 84b1928704201034c785a26296a49f69355eb56a05Nick Lewycky/* 85b1928704201034c785a26296a49f69355eb56a05Nick Lewycky * --- LLVM line counter API --- 86b1928704201034c785a26296a49f69355eb56a05Nick Lewycky */ 87b1928704201034c785a26296a49f69355eb56a05Nick Lewycky 88b1928704201034c785a26296a49f69355eb56a05Nick Lewycky/* A file in this case is a translation unit. Each .o file built with line 89b1928704201034c785a26296a49f69355eb56a05Nick Lewycky * profiling enabled will emit to a different file. Only one file may be 90b1928704201034c785a26296a49f69355eb56a05Nick Lewycky * started at a time. 91b1928704201034c785a26296a49f69355eb56a05Nick Lewycky */ 927a2ba2fbe4b0ccaacc2cedbc1bfd2a3764170efeNick Lewyckyvoid llvm_gcda_start_file(const char *orig_filename) { 937a2ba2fbe4b0ccaacc2cedbc1bfd2a3764170efeNick Lewycky char *filename; 947a2ba2fbe4b0ccaacc2cedbc1bfd2a3764170efeNick Lewycky filename = mangle_filename(orig_filename); 955e436b3b0ef06258ed2d7929946eb00684973183Nick Lewycky recursive_mkdir(filename); 967a2ba2fbe4b0ccaacc2cedbc1bfd2a3764170efeNick Lewycky output_file = fopen(filename, "wb"); 97b1928704201034c785a26296a49f69355eb56a05Nick Lewycky 98b1928704201034c785a26296a49f69355eb56a05Nick Lewycky /* gcda file, version 404*, stamp LLVM. */ 99b1928704201034c785a26296a49f69355eb56a05Nick Lewycky fwrite("adcg*404MVLL", 12, 1, output_file); 100b1928704201034c785a26296a49f69355eb56a05Nick Lewycky 101b1928704201034c785a26296a49f69355eb56a05Nick Lewycky#ifdef DEBUG_GCDAPROFILING 1027a2ba2fbe4b0ccaacc2cedbc1bfd2a3764170efeNick Lewycky printf("llvmgcda: [%s]\n", orig_filename); 1031790c9cbb6714e81eab1412909a2320acaecc43bNick Lewycky#endif 1047a2ba2fbe4b0ccaacc2cedbc1bfd2a3764170efeNick Lewycky 1057a2ba2fbe4b0ccaacc2cedbc1bfd2a3764170efeNick Lewycky free(filename); 1061790c9cbb6714e81eab1412909a2320acaecc43bNick Lewycky} 1071790c9cbb6714e81eab1412909a2320acaecc43bNick Lewycky 1081790c9cbb6714e81eab1412909a2320acaecc43bNick Lewycky/* Given an array of pointers to counters (counters), increment the n-th one, 1091790c9cbb6714e81eab1412909a2320acaecc43bNick Lewycky * where we're also given a pointer to n (predecessor). 1101790c9cbb6714e81eab1412909a2320acaecc43bNick Lewycky */ 1111790c9cbb6714e81eab1412909a2320acaecc43bNick Lewyckyvoid llvm_gcda_increment_indirect_counter(uint32_t *predecessor, 1121790c9cbb6714e81eab1412909a2320acaecc43bNick Lewycky uint64_t **counters) { 1131790c9cbb6714e81eab1412909a2320acaecc43bNick Lewycky uint64_t *counter; 1147a2ba2fbe4b0ccaacc2cedbc1bfd2a3764170efeNick Lewycky uint32_t pred; 1157a2ba2fbe4b0ccaacc2cedbc1bfd2a3764170efeNick Lewycky 1167a2ba2fbe4b0ccaacc2cedbc1bfd2a3764170efeNick Lewycky pred = *predecessor; 1177a2ba2fbe4b0ccaacc2cedbc1bfd2a3764170efeNick Lewycky if (pred == 0xffffffff) 1181790c9cbb6714e81eab1412909a2320acaecc43bNick Lewycky return; 1197a2ba2fbe4b0ccaacc2cedbc1bfd2a3764170efeNick Lewycky counter = counters[pred]; 1201790c9cbb6714e81eab1412909a2320acaecc43bNick Lewycky 1211790c9cbb6714e81eab1412909a2320acaecc43bNick Lewycky /* Don't crash if the pred# is out of sync. This can happen due to threads, 1221790c9cbb6714e81eab1412909a2320acaecc43bNick Lewycky or because of a TODO in GCOVProfiling.cpp buildEdgeLookupTable(). */ 1237a2ba2fbe4b0ccaacc2cedbc1bfd2a3764170efeNick Lewycky if (counter) 1241790c9cbb6714e81eab1412909a2320acaecc43bNick Lewycky ++*counter; 1251790c9cbb6714e81eab1412909a2320acaecc43bNick Lewycky#ifdef DEBUG_GCDAPROFILING 1261790c9cbb6714e81eab1412909a2320acaecc43bNick Lewycky else 1271790c9cbb6714e81eab1412909a2320acaecc43bNick Lewycky printf("llvmgcda: increment_indirect_counter counters=%x, pred=%u\n", 1281790c9cbb6714e81eab1412909a2320acaecc43bNick Lewycky state_table_row, *predecessor); 129b1928704201034c785a26296a49f69355eb56a05Nick Lewycky#endif 130b1928704201034c785a26296a49f69355eb56a05Nick Lewycky} 131b1928704201034c785a26296a49f69355eb56a05Nick Lewycky 132b1928704201034c785a26296a49f69355eb56a05Nick Lewyckyvoid llvm_gcda_emit_function(uint32_t ident) { 133b1928704201034c785a26296a49f69355eb56a05Nick Lewycky#ifdef DEBUG_GCDAPROFILING 1341790c9cbb6714e81eab1412909a2320acaecc43bNick Lewycky printf("llvmgcda: function id=%x\n", ident); 135b1928704201034c785a26296a49f69355eb56a05Nick Lewycky#endif 136b1928704201034c785a26296a49f69355eb56a05Nick Lewycky 137b1928704201034c785a26296a49f69355eb56a05Nick Lewycky /* function tag */ 138b1928704201034c785a26296a49f69355eb56a05Nick Lewycky fwrite("\0\0\0\1", 4, 1, output_file); 139b1928704201034c785a26296a49f69355eb56a05Nick Lewycky write_int32(2); 140b1928704201034c785a26296a49f69355eb56a05Nick Lewycky write_int32(ident); 141b1928704201034c785a26296a49f69355eb56a05Nick Lewycky write_int32(0); 142b1928704201034c785a26296a49f69355eb56a05Nick Lewycky} 143b1928704201034c785a26296a49f69355eb56a05Nick Lewycky 144b1928704201034c785a26296a49f69355eb56a05Nick Lewyckyvoid llvm_gcda_emit_arcs(uint32_t num_counters, uint64_t *counters) { 145b1928704201034c785a26296a49f69355eb56a05Nick Lewycky uint32_t i; 146b1928704201034c785a26296a49f69355eb56a05Nick Lewycky /* counter #1 (arcs) tag */ 147b1928704201034c785a26296a49f69355eb56a05Nick Lewycky fwrite("\0\0\xa1\1", 4, 1, output_file); 148b1928704201034c785a26296a49f69355eb56a05Nick Lewycky write_int32(num_counters * 2); 149b1928704201034c785a26296a49f69355eb56a05Nick Lewycky for (i = 0; i < num_counters; ++i) { 150b1928704201034c785a26296a49f69355eb56a05Nick Lewycky write_int64(counters[i]); 151b1928704201034c785a26296a49f69355eb56a05Nick Lewycky } 152b1928704201034c785a26296a49f69355eb56a05Nick Lewycky 153b1928704201034c785a26296a49f69355eb56a05Nick Lewycky#ifdef DEBUG_GCDAPROFILING 1541790c9cbb6714e81eab1412909a2320acaecc43bNick Lewycky printf("llvmgcda: %u arcs\n", num_counters); 155b1928704201034c785a26296a49f69355eb56a05Nick Lewycky for (i = 0; i < num_counters; ++i) { 1561790c9cbb6714e81eab1412909a2320acaecc43bNick Lewycky printf("llvmgcda: %llu\n", (unsigned long long)counters[i]); 157b1928704201034c785a26296a49f69355eb56a05Nick Lewycky } 158b1928704201034c785a26296a49f69355eb56a05Nick Lewycky#endif 159b1928704201034c785a26296a49f69355eb56a05Nick Lewycky} 160b1928704201034c785a26296a49f69355eb56a05Nick Lewycky 161b1928704201034c785a26296a49f69355eb56a05Nick Lewyckyvoid llvm_gcda_end_file() { 162b1928704201034c785a26296a49f69355eb56a05Nick Lewycky /* Write out EOF record. */ 163b1928704201034c785a26296a49f69355eb56a05Nick Lewycky fwrite("\0\0\0\0\0\0\0\0", 8, 1, output_file); 164b1928704201034c785a26296a49f69355eb56a05Nick Lewycky fclose(output_file); 165b1928704201034c785a26296a49f69355eb56a05Nick Lewycky output_file = NULL; 166b1928704201034c785a26296a49f69355eb56a05Nick Lewycky 167b1928704201034c785a26296a49f69355eb56a05Nick Lewycky#ifdef DEBUG_GCDAPROFILING 1681790c9cbb6714e81eab1412909a2320acaecc43bNick Lewycky printf("llvmgcda: -----\n"); 169b1928704201034c785a26296a49f69355eb56a05Nick Lewycky#endif 170b1928704201034c785a26296a49f69355eb56a05Nick Lewycky} 171