sanitizer_common.h revision b78caa645f70eff2f037f1f8bb43ca9129dbd8d9 
1//===-- sanitizer_common.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// This file is shared between AddressSanitizer and ThreadSanitizer
11// run-time libraries.
12// It declares common functions and classes that are used in both runtimes.
13// Implementation of some functions are provided in sanitizer_common, while
14// others must be defined by run-time library itself.
15//===----------------------------------------------------------------------===//
16#ifndef SANITIZER_COMMON_H
17#define SANITIZER_COMMON_H
18
19#include "sanitizer_internal_defs.h"
20
21namespace __sanitizer {
22
23// Constants.
24const uptr kWordSize = __WORDSIZE / 8;
25const uptr kWordSizeInBits = 8 * kWordSize;
26const uptr kPageSizeBits = 12;
27const uptr kPageSize = 1UL << kPageSizeBits;
28const uptr kCacheLineSize = 64;
29#ifndef _WIN32
30const uptr kMmapGranularity = kPageSize;
31#else
32const uptr kMmapGranularity = 1UL << 16;
33#endif
34
35// Threads
36int GetPid();
37uptr GetThreadSelf();
38void GetThreadStackTopAndBottom(bool at_initialization, uptr *stack_top,
39                                uptr *stack_bottom);
40
41// Memory management
42void *MmapOrDie(uptr size, const char *mem_type);
43void UnmapOrDie(void *addr, uptr size);
44void *MmapFixedNoReserve(uptr fixed_addr, uptr size);
45void *Mprotect(uptr fixed_addr, uptr size);
46// Used to check if we can map shadow memory to a fixed location.
47bool MemoryRangeIsAvailable(uptr range_start, uptr range_end);
48
49// Internal allocator
50void *InternalAlloc(uptr size);
51void InternalFree(void *p);
52// Given the pointer p into a valid allocated block,
53// returns a pointer to the beginning of the block.
54void *InternalAllocBlock(void *p);
55
56// IO
57void RawWrite(const char *buffer);
58void Printf(const char *format, ...);
59void Report(const char *format, ...);
60
61// Opens the file 'file_name" and reads up to 'max_len' bytes.
62// The resulting buffer is mmaped and stored in '*buff'.
63// The size of the mmaped region is stored in '*buff_size',
64// Returns the number of read bytes or 0 if file can not be opened.
65uptr ReadFileToBuffer(const char *file_name, char **buff,
66                      uptr *buff_size, uptr max_len);
67// Maps given file to virtual memory, and returns pointer to it
68// (or NULL if the mapping failes). Stores the size of mmaped region
69// in '*buff_size'.
70void *MapFileToMemory(const char *file_name, uptr *buff_size);
71
72const char *GetEnv(const char *name);
73const char *GetPwd();
74
75// Other
76void DisableCoreDumper();
77void DumpProcessMap();
78void SleepForSeconds(int seconds);
79void SleepForMillis(int millis);
80void NORETURN Exit(int exitcode);
81void NORETURN Abort();
82int Atexit(void (*function)(void));
83void SortArray(uptr *array, uptr size);
84
85// Math
86INLINE bool IsPowerOfTwo(uptr x) {
87  return (x & (x - 1)) == 0;
88}
89INLINE uptr RoundUpTo(uptr size, uptr boundary) {
90  CHECK(IsPowerOfTwo(boundary));
91  return (size + boundary - 1) & ~(boundary - 1);
92}
93// Don't use std::min and std::max, to minimize dependency on libstdc++.
94template<class T> T Min(T a, T b) { return a < b ? a : b; }
95template<class T> T Max(T a, T b) { return a > b ? a : b; }
96
97// Char handling
98INLINE bool IsSpace(int c) {
99  return (c == ' ') || (c == '\n') || (c == '\t') ||
100         (c == '\f') || (c == '\r') || (c == '\v');
101}
102INLINE bool IsDigit(int c) {
103  return (c >= '0') && (c <= '9');
104}
105INLINE int ToLower(int c) {
106  return (c >= 'A' && c <= 'Z') ? (c + 'a' - 'A') : c;
107}
108
109#if __WORDSIZE == 64
110# define FIRST_32_SECOND_64(a, b) (b)
111#else
112# define FIRST_32_SECOND_64(a, b) (a)
113#endif
114
115}  // namespace __sanitizer
116
117#endif  // SANITIZER_COMMON_H
118