2e33ed9ecc
Add the `__memprof_default_options_str` variable, initialized via the `-memprof-runtime-default-options` LLVM flag, to hold the default options string for memprof. This allows us to set these options during compile time in the clang invocation. Also update the docs to describe the various ways to set these options.
73 lines
2.6 KiB
C++
73 lines
2.6 KiB
C++
//===-- sanitizer/memprof_interface.h --------------------------*- C++ -*-===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This file is a part of MemProfiler (MemProf).
|
|
//
|
|
// Public interface header.
|
|
//===----------------------------------------------------------------------===//
|
|
#ifndef SANITIZER_MEMPROF_INTERFACE_H
|
|
#define SANITIZER_MEMPROF_INTERFACE_H
|
|
|
|
#include <sanitizer/common_interface_defs.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
/// Records access to a memory region (<c>[addr, addr+size)</c>).
|
|
///
|
|
/// This memory must be previously allocated by your program.
|
|
///
|
|
/// \param addr Start of memory region.
|
|
/// \param size Size of memory region.
|
|
void SANITIZER_CDECL __memprof_record_access_range(void const volatile *addr,
|
|
size_t size);
|
|
|
|
/// Records access to a memory address <c><i>addr</i></c>.
|
|
///
|
|
/// This memory must be previously allocated by your program.
|
|
///
|
|
/// \param addr Accessed memory address
|
|
void SANITIZER_CDECL __memprof_record_access(void const volatile *addr);
|
|
|
|
/// User-provided callback on MemProf errors.
|
|
///
|
|
/// You can provide a function that would be called immediately when MemProf
|
|
/// detects an error. This is useful in cases when MemProf detects an error but
|
|
/// your program crashes before the MemProf report is printed.
|
|
void SANITIZER_CDECL __memprof_on_error(void);
|
|
|
|
/// Prints accumulated statistics to <c>stderr</c> (useful for calling from the
|
|
/// debugger).
|
|
void SANITIZER_CDECL __memprof_print_accumulated_stats(void);
|
|
|
|
/// User-provided default option settings.
|
|
///
|
|
/// You can set these options via the -memprof-runtime-default-options LLVM flag
|
|
/// or you can provide your own implementation of this function. See
|
|
/// memprof_flags.h for more info.
|
|
///
|
|
/// \returns Default options string.
|
|
const char *SANITIZER_CDECL __memprof_default_options(void);
|
|
|
|
/// Prints the memory profile to the current profile file.
|
|
///
|
|
/// \returns 0 on success.
|
|
int SANITIZER_CDECL __memprof_profile_dump(void);
|
|
|
|
/// Closes the existing file descriptor, if it is valid and not stdout or
|
|
/// stderr, and resets the internal state such that the profile filename is
|
|
/// reopened on the next profile dump attempt. This can be used to enable
|
|
/// multiple rounds of profiling on the same binary.
|
|
void SANITIZER_CDECL __memprof_profile_reset(void);
|
|
|
|
#ifdef __cplusplus
|
|
} // extern "C"
|
|
#endif
|
|
|
|
#endif // SANITIZER_MEMPROF_INTERFACE_H
|