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