libsanitizer/include/sanitizer/common_interface_defs.h

   1 //===-- sanitizer/common_interface_defs.h -----------------------*- C++ -*-===//
   2 //
   3 // This file is distributed under the University of Illinois Open Source
   4 // License. See LICENSE.TXT for details.
   5 //
   6 //===----------------------------------------------------------------------===//
   7 //
   8 // Common part of the public sanitizer interface.
   9 //===----------------------------------------------------------------------===//
  10
  11 #ifndef SANITIZER_COMMON_INTERFACE_DEFS_H
  12 #define SANITIZER_COMMON_INTERFACE_DEFS_H
  13
  14 #include <stddef.h>
  15 #include <stdint.h>
  16
  17 // GCC does not understand __has_feature.
  18 #if !defined(__has_feature)
  19 # define __has_feature(x) 0
  20 #endif
  21
  22 #ifdef __cplusplus
  23 extern "C" {
  24 #endif
  25   // Arguments for __sanitizer_sandbox_on_notify() below.
  26   typedef struct {
  27     // Enable sandbox support in sanitizer coverage.
  28     int coverage_sandboxed;
  29     // File descriptor to write coverage data to. If -1 is passed, a file will
  30     // be pre-opened by __sanitizer_sandobx_on_notify(). This field has no
  31     // effect if coverage_sandboxed == 0.
  32     intptr_t coverage_fd;
  33     // If non-zero, split the coverage data into well-formed blocks. This is
  34     // useful when coverage_fd is a socket descriptor. Each block will contain
  35     // a header, allowing data from multiple processes to be sent over the same
  36     // socket.
  37     unsigned int coverage_max_block_size;
  38   } __sanitizer_sandbox_arguments;
  39
  40   // Tell the tools to write their reports to "path.<pid>" instead of stderr.
  41   void __sanitizer_set_report_path(const char *path);
  42
  43   // Notify the tools that the sandbox is going to be turned on. The reserved
  44   // parameter will be used in the future to hold a structure with functions
  45   // that the tools may call to bypass the sandbox.
  46   void __sanitizer_sandbox_on_notify(__sanitizer_sandbox_arguments *args);
  47
  48   // This function is called by the tool when it has just finished reporting
  49   // an error. 'error_summary' is a one-line string that summarizes
  50   // the error message. This function can be overridden by the client.
  51   void __sanitizer_report_error_summary(const char *error_summary);
  52
  53   // Some of the sanitizers (e.g. asan/tsan) may miss bugs that happen
  54   // in unaligned loads/stores. In order to find such bugs reliably one needs
  55   // to replace plain unaligned loads/stores with these calls.
  56   uint16_t __sanitizer_unaligned_load16(const void *p);
  57   uint32_t __sanitizer_unaligned_load32(const void *p);
  58   uint64_t __sanitizer_unaligned_load64(const void *p);
  59   void __sanitizer_unaligned_store16(void *p, uint16_t x);
  60   void __sanitizer_unaligned_store32(void *p, uint32_t x);
  61   void __sanitizer_unaligned_store64(void *p, uint64_t x);
  62
  63   // Initialize coverage.
  64   void __sanitizer_cov_init();
  65   // Record and dump coverage info.
  66   void __sanitizer_cov_dump();
  67
  68   // Annotate the current state of a contiguous container, such as
  69   // std::vector, std::string or similar.
  70   // A contiguous container is a container that keeps all of its elements
  71   // in a contiguous region of memory. The container owns the region of memory
  72   // [beg, end); the memory [beg, mid) is used to store the current elements
  73   // and the memory [mid, end) is reserved for future elements;
  74   // beg <= mid <= end. For example, in "std::vector<> v"
  75   //   beg = &v[0];
  76   //   end = beg + v.capacity() * sizeof(v[0]);
  77   //   mid = beg + v.size()     * sizeof(v[0]);
  78   //
  79   // This annotation tells the Sanitizer tool about the current state of the
  80   // container so that the tool can report errors when memory from [mid, end)
  81   // is accessed. Insert this annotation into methods like push_back/pop_back.
  82   // Supply the old and the new values of mid (old_mid/new_mid).
  83   // In the initial state mid == end and so should be the final
  84   // state when the container is destroyed or when it reallocates the storage.
  85   //
  86   // Use with caution and don't use for anything other than vector-like classes.
  87   //
  88   // For AddressSanitizer, 'beg' should be 8-aligned and 'end' should
  89   // be either 8-aligned or it should point to the end of a separate heap-,
  90   // stack-, or global- allocated buffer. I.e. the following will not work:
  91   //   int64_t x[2];  // 16 bytes, 8-aligned.
  92   //   char *beg = (char *)&x[0];
  93   //   char *end = beg + 12;  // Not 8 aligned, not the end of the buffer.
  94   // This however will work fine:
  95   //   int32_t x[3];  // 12 bytes, but 8-aligned under AddressSanitizer.
  96   //   char *beg = (char*)&x[0];
  97   //   char *end = beg + 12;  // Not 8-aligned, but is the end of the buffer.
  98   void __sanitizer_annotate_contiguous_container(const void *beg,
  99                                                  const void *end,
 100                                                  const void *old_mid,
 101                                                  const void *new_mid);
 102   // Returns true if the contiguous container [beg, end) ir properly poisoned
 103   // (e.g. with __sanitizer_annotate_contiguous_container), i.e. if
 104   //  - [beg, mid) is addressable,
 105   //  - [mid, end) is unaddressable.
 106   // Full verification requires O(end-beg) time; this function tries to avoid
 107   // such complexity by touching only parts of the container around beg/mid/end.
 108   int __sanitizer_verify_contiguous_container(const void *beg, const void *mid,
 109                                               const void *end);
 110
 111   // Print the stack trace leading to this call. Useful for debugging user code.
 112   void __sanitizer_print_stack_trace();
 113
 114 #ifdef __cplusplus
 115 }  // extern "C"
 116 #endif
 117
 118 #endif  // SANITIZER_COMMON_INTERFACE_DEFS_H