1 /*===- InstrProfiling.h- Support library for PGO instrumentation ----------===*\ 2 |* 3 |* The LLVM Compiler Infrastructure 4 |* 5 |* This file is distributed under the University of Illinois Open Source 6 |* License. See LICENSE.TXT for details. 7 |* 8 \*===----------------------------------------------------------------------===*/ 9 10 #ifndef PROFILE_INSTRPROFILING_H_ 11 #define PROFILE_INSTRPROFILING_H_ 12 13 #if defined(__FreeBSD__) && defined(__i386__) 14 15 /* System headers define 'size_t' incorrectly on x64 FreeBSD (prior to 16 * FreeBSD 10, r232261) when compiled in 32-bit mode. 17 */ 18 #define PRIu64 "llu" 19 typedef unsigned int uint32_t; 20 typedef unsigned long long uint64_t; 21 typedef uint32_t uintptr_t; 22 23 #else /* defined(__FreeBSD__) && defined(__i386__) */ 24 25 #include <inttypes.h> 26 #include <stdint.h> 27 28 #endif /* defined(__FreeBSD__) && defined(__i386__) */ 29 30 #define PROFILE_HEADER_SIZE 7 31 32 typedef struct __llvm_profile_data { 33 const uint32_t NameSize; 34 const uint32_t NumCounters; 35 const uint64_t FuncHash; 36 const char *const Name; 37 uint64_t *const Counters; 38 } __llvm_profile_data; 39 40 /*! 41 * \brief Get required size for profile buffer. 42 */ 43 uint64_t __llvm_profile_get_size_for_buffer(void); 44 45 /*! 46 * \brief Write instrumentation data to the given buffer. 47 * 48 * \pre \c Buffer is the start of a buffer at least as big as \a 49 * __llvm_profile_get_size_for_buffer(). 50 */ 51 int __llvm_profile_write_buffer(char *Buffer); 52 53 const __llvm_profile_data *__llvm_profile_data_begin(void); 54 const __llvm_profile_data *__llvm_profile_data_end(void); 55 const char *__llvm_profile_names_begin(void); 56 const char *__llvm_profile_names_end(void); 57 uint64_t *__llvm_profile_counters_begin(void); 58 uint64_t *__llvm_profile_counters_end(void); 59 60 #define PROFILE_RANGE_SIZE(Range) \ 61 (__llvm_profile_ ## Range ## _end() - __llvm_profile_ ## Range ## _begin()) 62 63 /*! 64 * \brief Write instrumentation data to the current file. 65 * 66 * Writes to the file with the last name given to \a __llvm_profile_set_filename(), 67 * or if it hasn't been called, the \c LLVM_PROFILE_FILE environment variable, 68 * or if that's not set, \c "default.profdata". 69 */ 70 int __llvm_profile_write_file(void); 71 72 /*! 73 * \brief Set the filename for writing instrumentation data. 74 * 75 * Sets the filename to be used for subsequent calls to 76 * \a __llvm_profile_write_file(). 77 * 78 * \c Name is not copied, so it must remain valid. Passing NULL resets the 79 * filename logic to the default behaviour. 80 */ 81 void __llvm_profile_set_filename(const char *Name); 82 83 /*! \brief Register to write instrumentation data to file at exit. */ 84 int __llvm_profile_register_write_file_atexit(void); 85 86 /*! \brief Initialize file handling. */ 87 void __llvm_profile_initialize_file(void); 88 89 /*! \brief Get the magic token for the file format. */ 90 uint64_t __llvm_profile_get_magic(void); 91 92 /*! \brief Get the version of the file format. */ 93 uint64_t __llvm_profile_get_version(void); 94 95 #endif /* PROFILE_INSTRPROFILING_H_ */ 96