1*ee754c2dSkamil //===-- sanitizer_linux.h ---------------------------------------*- C++ -*-===//
2*ee754c2dSkamil //
3*ee754c2dSkamil //                     The LLVM Compiler Infrastructure
4*ee754c2dSkamil //
5*ee754c2dSkamil // This file is distributed under the University of Illinois Open Source
6*ee754c2dSkamil // License. See LICENSE.TXT for details.
7*ee754c2dSkamil //
8*ee754c2dSkamil //===----------------------------------------------------------------------===//
9*ee754c2dSkamil //
10*ee754c2dSkamil // Linux-specific syscall wrappers and classes.
11*ee754c2dSkamil //
12*ee754c2dSkamil //===----------------------------------------------------------------------===//
13*ee754c2dSkamil #ifndef SANITIZER_LINUX_H
14*ee754c2dSkamil #define SANITIZER_LINUX_H
15*ee754c2dSkamil 
16*ee754c2dSkamil #include "sanitizer_platform.h"
17*ee754c2dSkamil #if SANITIZER_FREEBSD || SANITIZER_LINUX || SANITIZER_NETBSD ||                \
18*ee754c2dSkamil     SANITIZER_OPENBSD || SANITIZER_SOLARIS
19*ee754c2dSkamil #include "sanitizer_common.h"
20*ee754c2dSkamil #include "sanitizer_internal_defs.h"
21*ee754c2dSkamil #include "sanitizer_platform_limits_freebsd.h"
22*ee754c2dSkamil #include "sanitizer_platform_limits_netbsd.h"
23*ee754c2dSkamil #include "sanitizer_platform_limits_openbsd.h"
24*ee754c2dSkamil #include "sanitizer_platform_limits_posix.h"
25*ee754c2dSkamil #include "sanitizer_platform_limits_solaris.h"
26*ee754c2dSkamil #include "sanitizer_posix.h"
27*ee754c2dSkamil 
28*ee754c2dSkamil struct link_map;  // Opaque type returned by dlopen().
29*ee754c2dSkamil 
30*ee754c2dSkamil namespace __sanitizer {
31*ee754c2dSkamil // Dirent structure for getdents(). Note that this structure is different from
32*ee754c2dSkamil // the one in <dirent.h>, which is used by readdir().
33*ee754c2dSkamil struct linux_dirent;
34*ee754c2dSkamil 
35*ee754c2dSkamil struct ProcSelfMapsBuff {
36*ee754c2dSkamil   char *data;
37*ee754c2dSkamil   uptr mmaped_size;
38*ee754c2dSkamil   uptr len;
39*ee754c2dSkamil };
40*ee754c2dSkamil 
41*ee754c2dSkamil struct MemoryMappingLayoutData {
42*ee754c2dSkamil   ProcSelfMapsBuff proc_self_maps;
43*ee754c2dSkamil   const char *current;
44*ee754c2dSkamil };
45*ee754c2dSkamil 
46*ee754c2dSkamil void ReadProcMaps(ProcSelfMapsBuff *proc_maps);
47*ee754c2dSkamil 
48*ee754c2dSkamil // Syscall wrappers.
49*ee754c2dSkamil uptr internal_getdents(fd_t fd, struct linux_dirent *dirp, unsigned int count);
50*ee754c2dSkamil uptr internal_sigaltstack(const void* ss, void* oss);
51*ee754c2dSkamil uptr internal_sigprocmask(int how, __sanitizer_sigset_t *set,
52*ee754c2dSkamil     __sanitizer_sigset_t *oldset);
53*ee754c2dSkamil uptr internal_clock_gettime(__sanitizer_clockid_t clk_id, void *tp);
54*ee754c2dSkamil 
55*ee754c2dSkamil // Linux-only syscalls.
56*ee754c2dSkamil #if SANITIZER_LINUX
57*ee754c2dSkamil uptr internal_prctl(int option, uptr arg2, uptr arg3, uptr arg4, uptr arg5);
58*ee754c2dSkamil // Used only by sanitizer_stoptheworld. Signal handlers that are actually used
59*ee754c2dSkamil // (like the process-wide error reporting SEGV handler) must use
60*ee754c2dSkamil // internal_sigaction instead.
61*ee754c2dSkamil int internal_sigaction_norestorer(int signum, const void *act, void *oldact);
62*ee754c2dSkamil #if (defined(__x86_64__) || SANITIZER_MIPS64) && !SANITIZER_GO
63*ee754c2dSkamil // Uses a raw system call to avoid interceptors.
64*ee754c2dSkamil int internal_sigaction_syscall(int signum, const void *act, void *oldact);
65*ee754c2dSkamil #endif
66*ee754c2dSkamil void internal_sigdelset(__sanitizer_sigset_t *set, int signum);
67*ee754c2dSkamil #if defined(__x86_64__) || defined(__mips__) || defined(__aarch64__) \
68*ee754c2dSkamil   || defined(__powerpc64__) || defined(__s390__) || defined(__i386__) \
69*ee754c2dSkamil   || defined(__arm__)
70*ee754c2dSkamil uptr internal_clone(int (*fn)(void *), void *child_stack, int flags, void *arg,
71*ee754c2dSkamil                     int *parent_tidptr, void *newtls, int *child_tidptr);
72*ee754c2dSkamil #endif
73*ee754c2dSkamil #elif SANITIZER_FREEBSD
74*ee754c2dSkamil void internal_sigdelset(__sanitizer_sigset_t *set, int signum);
75*ee754c2dSkamil #endif  // SANITIZER_LINUX
76*ee754c2dSkamil 
77*ee754c2dSkamil // This class reads thread IDs from /proc/<pid>/task using only syscalls.
78*ee754c2dSkamil class ThreadLister {
79*ee754c2dSkamil  public:
80*ee754c2dSkamil   explicit ThreadLister(pid_t pid);
81*ee754c2dSkamil   ~ThreadLister();
82*ee754c2dSkamil   enum Result {
83*ee754c2dSkamil     Error,
84*ee754c2dSkamil     Incomplete,
85*ee754c2dSkamil     Ok,
86*ee754c2dSkamil   };
87*ee754c2dSkamil   Result ListThreads(InternalMmapVector<tid_t> *threads);
88*ee754c2dSkamil 
89*ee754c2dSkamil  private:
90*ee754c2dSkamil   bool IsAlive(int tid);
91*ee754c2dSkamil 
92*ee754c2dSkamil   pid_t pid_;
93*ee754c2dSkamil   int descriptor_ = -1;
94*ee754c2dSkamil   InternalMmapVector<char> buffer_;
95*ee754c2dSkamil };
96*ee754c2dSkamil 
97*ee754c2dSkamil // Exposed for testing.
98*ee754c2dSkamil uptr ThreadDescriptorSize();
99*ee754c2dSkamil uptr ThreadSelf();
100*ee754c2dSkamil uptr ThreadSelfOffset();
101*ee754c2dSkamil 
102*ee754c2dSkamil // Matches a library's file name against a base name (stripping path and version
103*ee754c2dSkamil // information).
104*ee754c2dSkamil bool LibraryNameIs(const char *full_name, const char *base_name);
105*ee754c2dSkamil 
106*ee754c2dSkamil // Call cb for each region mapped by map.
107*ee754c2dSkamil void ForEachMappedRegion(link_map *map, void (*cb)(const void *, uptr));
108*ee754c2dSkamil 
109*ee754c2dSkamil #if SANITIZER_ANDROID
110*ee754c2dSkamil 
111*ee754c2dSkamil #if defined(__aarch64__)
112*ee754c2dSkamil # define __get_tls() \
113*ee754c2dSkamil     ({ void** __v; __asm__("mrs %0, tpidr_el0" : "=r"(__v)); __v; })
114*ee754c2dSkamil #elif defined(__arm__)
115*ee754c2dSkamil # define __get_tls() \
116*ee754c2dSkamil     ({ void** __v; __asm__("mrc p15, 0, %0, c13, c0, 3" : "=r"(__v)); __v; })
117*ee754c2dSkamil #elif defined(__mips__)
118*ee754c2dSkamil // On mips32r1, this goes via a kernel illegal instruction trap that's
119*ee754c2dSkamil // optimized for v1.
120*ee754c2dSkamil # define __get_tls() \
121*ee754c2dSkamil     ({ register void** __v asm("v1"); \
122*ee754c2dSkamil        __asm__(".set    push\n" \
123*ee754c2dSkamil                ".set    mips32r2\n" \
124*ee754c2dSkamil                "rdhwr   %0,$29\n" \
125*ee754c2dSkamil                ".set    pop\n" : "=r"(__v)); \
126*ee754c2dSkamil        __v; })
127*ee754c2dSkamil #elif defined(__i386__)
128*ee754c2dSkamil # define __get_tls() \
129*ee754c2dSkamil     ({ void** __v; __asm__("movl %%gs:0, %0" : "=r"(__v)); __v; })
130*ee754c2dSkamil #elif defined(__x86_64__)
131*ee754c2dSkamil # define __get_tls() \
132*ee754c2dSkamil     ({ void** __v; __asm__("mov %%fs:0, %0" : "=r"(__v)); __v; })
133*ee754c2dSkamil #else
134*ee754c2dSkamil #error "Unsupported architecture."
135*ee754c2dSkamil #endif
136*ee754c2dSkamil 
137*ee754c2dSkamil // The Android Bionic team has allocated a TLS slot for sanitizers starting
138*ee754c2dSkamil // with Q, given that Android currently doesn't support ELF TLS. It is used to
139*ee754c2dSkamil // store sanitizer thread specific data.
140*ee754c2dSkamil static const int TLS_SLOT_SANITIZER = 6;
141*ee754c2dSkamil 
get_android_tls_ptr()142*ee754c2dSkamil ALWAYS_INLINE uptr *get_android_tls_ptr() {
143*ee754c2dSkamil   return reinterpret_cast<uptr *>(&__get_tls()[TLS_SLOT_SANITIZER]);
144*ee754c2dSkamil }
145*ee754c2dSkamil 
146*ee754c2dSkamil #endif  // SANITIZER_ANDROID
147*ee754c2dSkamil 
148*ee754c2dSkamil }  // namespace __sanitizer
149*ee754c2dSkamil 
150*ee754c2dSkamil #endif
151*ee754c2dSkamil #endif  // SANITIZER_LINUX_H
152