libsanitizer/include/sanitizer/hwasan_interface.h

   1 //===-- sanitizer/hwasan_interface.h ----------------------------*- C++ -*-===//
   2 //
   3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
   4 // See https://llvm.org/LICENSE.txt for license information.
   5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
   6 //
   7 //===----------------------------------------------------------------------===//
   8 //
   9 // This file is a part of HWAddressSanitizer.
  10 //
  11 // Public interface header.
  12 //===----------------------------------------------------------------------===//
  13 #ifndef SANITIZER_HWASAN_INTERFACE_H
  14 #define SANITIZER_HWASAN_INTERFACE_H
  15
  16 #include <sanitizer/common_interface_defs.h>
  17
  18 #ifdef __cplusplus
  19 extern "C" {
  20 #endif
  21 // Libc hook for program startup in statically linked executables.
  22 // Initializes enough of the runtime to run instrumented code. This function
  23 // should only be called in statically linked executables because it modifies
  24 // the GOT, which won't work in regular binaries because RELRO will already
  25 // have been applied by the time the function is called. This also means that
  26 // the function should be called before libc applies RELRO.
  27 // Does not call libc unless there is an error.
  28 // Can be called multiple times.
  29 void SANITIZER_CDECL __hwasan_init_static(void);
  30
  31 // This function may be optionally provided by user and should return
  32 // a string containing HWASan runtime options. See asan_flags.h for details.
  33 const char *SANITIZER_CDECL __hwasan_default_options(void);
  34
  35 void SANITIZER_CDECL __hwasan_enable_allocator_tagging(void);
  36 void SANITIZER_CDECL __hwasan_disable_allocator_tagging(void);
  37
  38 // Mark region of memory with the given tag. Both address and size need to be
  39 // 16-byte aligned.
  40 void SANITIZER_CDECL __hwasan_tag_memory(const volatile void *p,
  41                                          unsigned char tag, size_t size);
  42
  43 /// Set pointer tag. Previous tag is lost.
  44 void *SANITIZER_CDECL __hwasan_tag_pointer(const volatile void *p,
  45                                            unsigned char tag);
  46
  47 // Set memory tag from the current SP address to the given address to zero.
  48 // This is meant to annotate longjmp and other non-local jumps.
  49 // This function needs to know the (almost) exact destination frame address;
  50 // clearing shadow for the entire thread stack like __asan_handle_no_return
  51 // does would cause false reports.
  52 void SANITIZER_CDECL __hwasan_handle_longjmp(const void *sp_dst);
  53
  54 // Set memory tag for the part of the current thread stack below sp_dst to
  55 // zero. Call this in vfork() before returning in the parent process.
  56 void SANITIZER_CDECL __hwasan_handle_vfork(const void *sp_dst);
  57
  58 // Libc hook for thread creation. Should be called in the child thread before
  59 // any instrumented code.
  60 void SANITIZER_CDECL __hwasan_thread_enter();
  61
  62 // Libc hook for thread destruction. No instrumented code should run after
  63 // this call.
  64 void SANITIZER_CDECL __hwasan_thread_exit();
  65
  66 // Print shadow and origin for the memory range to stderr in a human-readable
  67 // format.
  68 void SANITIZER_CDECL __hwasan_print_shadow(const volatile void *x, size_t size);
  69
  70 // Print one-line report about the memory usage of the current process.
  71 void SANITIZER_CDECL __hwasan_print_memory_usage();
  72
  73 /* Returns the offset of the first byte in the memory range that can not be
  74  * accessed through the pointer in x, or -1 if the whole range is good. */
  75 intptr_t SANITIZER_CDECL __hwasan_test_shadow(const volatile void *x,
  76                                               size_t size);
  77
  78 /* Sets the callback function to be called during HWASan error reporting. */
  79 void SANITIZER_CDECL
  80 __hwasan_set_error_report_callback(void (*callback)(const char *));
  81
  82 int SANITIZER_CDECL __sanitizer_posix_memalign(void **memptr, size_t alignment,
  83                                                size_t size);
  84 void *SANITIZER_CDECL __sanitizer_memalign(size_t alignment, size_t size);
  85 void *SANITIZER_CDECL __sanitizer_aligned_alloc(size_t alignment, size_t size);
  86 void *SANITIZER_CDECL __sanitizer___libc_memalign(size_t alignment,
  87                                                   size_t size);
  88 void *SANITIZER_CDECL __sanitizer_valloc(size_t size);
  89 void *SANITIZER_CDECL __sanitizer_pvalloc(size_t size);
  90 void SANITIZER_CDECL __sanitizer_free(void *ptr);
  91 void SANITIZER_CDECL __sanitizer_cfree(void *ptr);
  92 size_t SANITIZER_CDECL __sanitizer_malloc_usable_size(const void *ptr);
  93 struct mallinfo SANITIZER_CDECL __sanitizer_mallinfo();
  94 int SANITIZER_CDECL __sanitizer_mallopt(int cmd, int value);
  95 void SANITIZER_CDECL __sanitizer_malloc_stats(void);
  96 void *SANITIZER_CDECL __sanitizer_calloc(size_t nmemb, size_t size);
  97 void *SANITIZER_CDECL __sanitizer_realloc(void *ptr, size_t size);
  98 void *SANITIZER_CDECL __sanitizer_reallocarray(void *ptr, size_t nmemb,
  99                                                size_t size);
 100 void *SANITIZER_CDECL __sanitizer_malloc(size_t size);
 101 #ifdef __cplusplus
 102 } // extern "C"
 103 #endif
 104
 105 #endif // SANITIZER_HWASAN_INTERFACE_H