1353944Sdim//===-- sanitizer_linux_libcdep.cpp ---------------------------------------===//
2353944Sdim//
3353944Sdim// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4353944Sdim// See https://llvm.org/LICENSE.txt for license information.
5353944Sdim// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6353944Sdim//
7353944Sdim//===----------------------------------------------------------------------===//
8353944Sdim//
9353944Sdim// This file is shared between AddressSanitizer and ThreadSanitizer
10353944Sdim// run-time libraries and implements linux-specific functions from
11353944Sdim// sanitizer_libc.h.
12353944Sdim//===----------------------------------------------------------------------===//
13353944Sdim
14353944Sdim#include "sanitizer_platform.h"
15353944Sdim
16353944Sdim#if SANITIZER_FREEBSD || SANITIZER_LINUX || SANITIZER_NETBSD ||                \
17353944Sdim    SANITIZER_OPENBSD || SANITIZER_SOLARIS
18353944Sdim
19353944Sdim#include "sanitizer_allocator_internal.h"
20353944Sdim#include "sanitizer_atomic.h"
21353944Sdim#include "sanitizer_common.h"
22353944Sdim#include "sanitizer_file.h"
23353944Sdim#include "sanitizer_flags.h"
24353944Sdim#include "sanitizer_freebsd.h"
25353944Sdim#include "sanitizer_getauxval.h"
26353944Sdim#include "sanitizer_glibc_version.h"
27353944Sdim#include "sanitizer_linux.h"
28353944Sdim#include "sanitizer_placement_new.h"
29353944Sdim#include "sanitizer_procmaps.h"
30353944Sdim
31353944Sdim#include <dlfcn.h>  // for dlsym()
32353944Sdim#include <link.h>
33353944Sdim#include <pthread.h>
34353944Sdim#include <signal.h>
35353944Sdim#include <sys/resource.h>
36353944Sdim#include <syslog.h>
37353944Sdim
38353944Sdim#if SANITIZER_FREEBSD
39353944Sdim#include <pthread_np.h>
40353944Sdim#include <osreldate.h>
41353944Sdim#include <sys/sysctl.h>
42353944Sdim#define pthread_getattr_np pthread_attr_get_np
43353944Sdim#endif
44353944Sdim
45353944Sdim#if SANITIZER_OPENBSD
46353944Sdim#include <pthread_np.h>
47353944Sdim#include <sys/sysctl.h>
48353944Sdim#endif
49353944Sdim
50353944Sdim#if SANITIZER_NETBSD
51353944Sdim#include <sys/sysctl.h>
52353944Sdim#include <sys/tls.h>
53357095Sdim#include <lwp.h>
54353944Sdim#endif
55353944Sdim
56353944Sdim#if SANITIZER_SOLARIS
57353944Sdim#include <stdlib.h>
58353944Sdim#include <thread.h>
59353944Sdim#endif
60353944Sdim
61353944Sdim#if SANITIZER_ANDROID
62353944Sdim#include <android/api-level.h>
63353944Sdim#if !defined(CPU_COUNT) && !defined(__aarch64__)
64353944Sdim#include <dirent.h>
65353944Sdim#include <fcntl.h>
66353944Sdimstruct __sanitizer::linux_dirent {
67353944Sdim  long           d_ino;
68353944Sdim  off_t          d_off;
69353944Sdim  unsigned short d_reclen;
70353944Sdim  char           d_name[];
71353944Sdim};
72353944Sdim#endif
73353944Sdim#endif
74353944Sdim
75353944Sdim#if !SANITIZER_ANDROID
76353944Sdim#include <elf.h>
77353944Sdim#include <unistd.h>
78353944Sdim#endif
79353944Sdim
80353944Sdimnamespace __sanitizer {
81353944Sdim
82353944SdimSANITIZER_WEAK_ATTRIBUTE int
83353944Sdimreal_sigaction(int signum, const void *act, void *oldact);
84353944Sdim
85353944Sdimint internal_sigaction(int signum, const void *act, void *oldact) {
86353944Sdim#if !SANITIZER_GO
87353944Sdim  if (&real_sigaction)
88353944Sdim    return real_sigaction(signum, act, oldact);
89353944Sdim#endif
90353944Sdim  return sigaction(signum, (const struct sigaction *)act,
91353944Sdim                   (struct sigaction *)oldact);
92353944Sdim}
93353944Sdim
94353944Sdimvoid GetThreadStackTopAndBottom(bool at_initialization, uptr *stack_top,
95353944Sdim                                uptr *stack_bottom) {
96353944Sdim  CHECK(stack_top);
97353944Sdim  CHECK(stack_bottom);
98353944Sdim  if (at_initialization) {
99353944Sdim    // This is the main thread. Libpthread may not be initialized yet.
100353944Sdim    struct rlimit rl;
101353944Sdim    CHECK_EQ(getrlimit(RLIMIT_STACK, &rl), 0);
102353944Sdim
103353944Sdim    // Find the mapping that contains a stack variable.
104353944Sdim    MemoryMappingLayout proc_maps(/*cache_enabled*/true);
105353944Sdim    if (proc_maps.Error()) {
106353944Sdim      *stack_top = *stack_bottom = 0;
107353944Sdim      return;
108353944Sdim    }
109353944Sdim    MemoryMappedSegment segment;
110353944Sdim    uptr prev_end = 0;
111353944Sdim    while (proc_maps.Next(&segment)) {
112353944Sdim      if ((uptr)&rl < segment.end) break;
113353944Sdim      prev_end = segment.end;
114353944Sdim    }
115353944Sdim    CHECK((uptr)&rl >= segment.start && (uptr)&rl < segment.end);
116353944Sdim
117353944Sdim    // Get stacksize from rlimit, but clip it so that it does not overlap
118353944Sdim    // with other mappings.
119353944Sdim    uptr stacksize = rl.rlim_cur;
120353944Sdim    if (stacksize > segment.end - prev_end) stacksize = segment.end - prev_end;
121353944Sdim    // When running with unlimited stack size, we still want to set some limit.
122353944Sdim    // The unlimited stack size is caused by 'ulimit -s unlimited'.
123353944Sdim    // Also, for some reason, GNU make spawns subprocesses with unlimited stack.
124353944Sdim    if (stacksize > kMaxThreadStackSize)
125353944Sdim      stacksize = kMaxThreadStackSize;
126353944Sdim    *stack_top = segment.end;
127353944Sdim    *stack_bottom = segment.end - stacksize;
128353944Sdim    return;
129353944Sdim  }
130353944Sdim  uptr stacksize = 0;
131353944Sdim  void *stackaddr = nullptr;
132353944Sdim#if SANITIZER_SOLARIS
133353944Sdim  stack_t ss;
134353944Sdim  CHECK_EQ(thr_stksegment(&ss), 0);
135353944Sdim  stacksize = ss.ss_size;
136353944Sdim  stackaddr = (char *)ss.ss_sp - stacksize;
137353944Sdim#elif SANITIZER_OPENBSD
138353944Sdim  stack_t sattr;
139353944Sdim  CHECK_EQ(pthread_stackseg_np(pthread_self(), &sattr), 0);
140353944Sdim  stackaddr = sattr.ss_sp;
141353944Sdim  stacksize = sattr.ss_size;
142353944Sdim#else  // !SANITIZER_SOLARIS
143353944Sdim  pthread_attr_t attr;
144353944Sdim  pthread_attr_init(&attr);
145353944Sdim  CHECK_EQ(pthread_getattr_np(pthread_self(), &attr), 0);
146353944Sdim  my_pthread_attr_getstack(&attr, &stackaddr, &stacksize);
147353944Sdim  pthread_attr_destroy(&attr);
148353944Sdim#endif // SANITIZER_SOLARIS
149353944Sdim
150353944Sdim  *stack_top = (uptr)stackaddr + stacksize;
151353944Sdim  *stack_bottom = (uptr)stackaddr;
152353944Sdim}
153353944Sdim
154353944Sdim#if !SANITIZER_GO
155353944Sdimbool SetEnv(const char *name, const char *value) {
156353944Sdim  void *f = dlsym(RTLD_NEXT, "setenv");
157353944Sdim  if (!f)
158353944Sdim    return false;
159353944Sdim  typedef int(*setenv_ft)(const char *name, const char *value, int overwrite);
160353944Sdim  setenv_ft setenv_f;
161353944Sdim  CHECK_EQ(sizeof(setenv_f), sizeof(f));
162353944Sdim  internal_memcpy(&setenv_f, &f, sizeof(f));
163353944Sdim  return setenv_f(name, value, 1) == 0;
164353944Sdim}
165353944Sdim#endif
166353944Sdim
167353944Sdim__attribute__((unused)) static bool GetLibcVersion(int *major, int *minor,
168353944Sdim                                                   int *patch) {
169353944Sdim#ifdef _CS_GNU_LIBC_VERSION
170353944Sdim  char buf[64];
171353944Sdim  uptr len = confstr(_CS_GNU_LIBC_VERSION, buf, sizeof(buf));
172353944Sdim  if (len >= sizeof(buf))
173353944Sdim    return false;
174353944Sdim  buf[len] = 0;
175353944Sdim  static const char kGLibC[] = "glibc ";
176353944Sdim  if (internal_strncmp(buf, kGLibC, sizeof(kGLibC) - 1) != 0)
177353944Sdim    return false;
178353944Sdim  const char *p = buf + sizeof(kGLibC) - 1;
179353944Sdim  *major = internal_simple_strtoll(p, &p, 10);
180353944Sdim  *minor = (*p == '.') ? internal_simple_strtoll(p + 1, &p, 10) : 0;
181353944Sdim  *patch = (*p == '.') ? internal_simple_strtoll(p + 1, &p, 10) : 0;
182353944Sdim  return true;
183353944Sdim#else
184353944Sdim  return false;
185353944Sdim#endif
186353944Sdim}
187353944Sdim
188353944Sdim#if !SANITIZER_FREEBSD && !SANITIZER_ANDROID && !SANITIZER_GO &&               \
189353944Sdim    !SANITIZER_NETBSD && !SANITIZER_OPENBSD && !SANITIZER_SOLARIS
190353944Sdimstatic uptr g_tls_size;
191353944Sdim
192353944Sdim#ifdef __i386__
193353944Sdim# define CHECK_GET_TLS_STATIC_INFO_VERSION (!__GLIBC_PREREQ(2, 27))
194353944Sdim#else
195353944Sdim# define CHECK_GET_TLS_STATIC_INFO_VERSION 0
196353944Sdim#endif
197353944Sdim
198353944Sdim#if CHECK_GET_TLS_STATIC_INFO_VERSION
199353944Sdim# define DL_INTERNAL_FUNCTION __attribute__((regparm(3), stdcall))
200353944Sdim#else
201353944Sdim# define DL_INTERNAL_FUNCTION
202353944Sdim#endif
203353944Sdim
204353944Sdimnamespace {
205353944Sdimstruct GetTlsStaticInfoCall {
206353944Sdim  typedef void (*get_tls_func)(size_t*, size_t*);
207353944Sdim};
208353944Sdimstruct GetTlsStaticInfoRegparmCall {
209353944Sdim  typedef void (*get_tls_func)(size_t*, size_t*) DL_INTERNAL_FUNCTION;
210353944Sdim};
211353944Sdim
212353944Sdimtemplate <typename T>
213353944Sdimvoid CallGetTls(void* ptr, size_t* size, size_t* align) {
214353944Sdim  typename T::get_tls_func get_tls;
215353944Sdim  CHECK_EQ(sizeof(get_tls), sizeof(ptr));
216353944Sdim  internal_memcpy(&get_tls, &ptr, sizeof(ptr));
217353944Sdim  CHECK_NE(get_tls, 0);
218353944Sdim  get_tls(size, align);
219353944Sdim}
220353944Sdim
221353944Sdimbool CmpLibcVersion(int major, int minor, int patch) {
222353944Sdim  int ma;
223353944Sdim  int mi;
224353944Sdim  int pa;
225353944Sdim  if (!GetLibcVersion(&ma, &mi, &pa))
226353944Sdim    return false;
227353944Sdim  if (ma > major)
228353944Sdim    return true;
229353944Sdim  if (ma < major)
230353944Sdim    return false;
231353944Sdim  if (mi > minor)
232353944Sdim    return true;
233353944Sdim  if (mi < minor)
234353944Sdim    return false;
235353944Sdim  return pa >= patch;
236353944Sdim}
237353944Sdim
238353944Sdim}  // namespace
239353944Sdim
240353944Sdimvoid InitTlsSize() {
241353944Sdim  // all current supported platforms have 16 bytes stack alignment
242353944Sdim  const size_t kStackAlign = 16;
243353944Sdim  void *get_tls_static_info_ptr = dlsym(RTLD_NEXT, "_dl_get_tls_static_info");
244353944Sdim  size_t tls_size = 0;
245353944Sdim  size_t tls_align = 0;
246353944Sdim  // On i?86, _dl_get_tls_static_info used to be internal_function, i.e.
247353944Sdim  // __attribute__((regparm(3), stdcall)) before glibc 2.27 and is normal
248353944Sdim  // function in 2.27 and later.
249353944Sdim  if (CHECK_GET_TLS_STATIC_INFO_VERSION && !CmpLibcVersion(2, 27, 0))
250353944Sdim    CallGetTls<GetTlsStaticInfoRegparmCall>(get_tls_static_info_ptr,
251353944Sdim                                            &tls_size, &tls_align);
252353944Sdim  else
253353944Sdim    CallGetTls<GetTlsStaticInfoCall>(get_tls_static_info_ptr,
254353944Sdim                                     &tls_size, &tls_align);
255353944Sdim  if (tls_align < kStackAlign)
256353944Sdim    tls_align = kStackAlign;
257353944Sdim  g_tls_size = RoundUpTo(tls_size, tls_align);
258353944Sdim}
259353944Sdim#else
260353944Sdimvoid InitTlsSize() { }
261353944Sdim#endif  // !SANITIZER_FREEBSD && !SANITIZER_ANDROID && !SANITIZER_GO &&
262353944Sdim        // !SANITIZER_NETBSD && !SANITIZER_SOLARIS
263353944Sdim
264353944Sdim#if (defined(__x86_64__) || defined(__i386__) || defined(__mips__) ||          \
265353944Sdim     defined(__aarch64__) || defined(__powerpc64__) || defined(__s390__) ||    \
266353944Sdim     defined(__arm__)) &&                                                      \
267353944Sdim    SANITIZER_LINUX && !SANITIZER_ANDROID
268353944Sdim// sizeof(struct pthread) from glibc.
269353944Sdimstatic atomic_uintptr_t thread_descriptor_size;
270353944Sdim
271353944Sdimuptr ThreadDescriptorSize() {
272353944Sdim  uptr val = atomic_load_relaxed(&thread_descriptor_size);
273353944Sdim  if (val)
274353944Sdim    return val;
275353944Sdim#if defined(__x86_64__) || defined(__i386__) || defined(__arm__)
276353944Sdim  int major;
277353944Sdim  int minor;
278353944Sdim  int patch;
279353944Sdim  if (GetLibcVersion(&major, &minor, &patch) && major == 2) {
280353944Sdim    /* sizeof(struct pthread) values from various glibc versions.  */
281353944Sdim    if (SANITIZER_X32)
282353944Sdim      val = 1728; // Assume only one particular version for x32.
283353944Sdim    // For ARM sizeof(struct pthread) changed in Glibc 2.23.
284353944Sdim    else if (SANITIZER_ARM)
285353944Sdim      val = minor <= 22 ? 1120 : 1216;
286353944Sdim    else if (minor <= 3)
287353944Sdim      val = FIRST_32_SECOND_64(1104, 1696);
288353944Sdim    else if (minor == 4)
289353944Sdim      val = FIRST_32_SECOND_64(1120, 1728);
290353944Sdim    else if (minor == 5)
291353944Sdim      val = FIRST_32_SECOND_64(1136, 1728);
292353944Sdim    else if (minor <= 9)
293353944Sdim      val = FIRST_32_SECOND_64(1136, 1712);
294353944Sdim    else if (minor == 10)
295353944Sdim      val = FIRST_32_SECOND_64(1168, 1776);
296353944Sdim    else if (minor == 11 || (minor == 12 && patch == 1))
297353944Sdim      val = FIRST_32_SECOND_64(1168, 2288);
298353944Sdim    else if (minor <= 14)
299353944Sdim      val = FIRST_32_SECOND_64(1168, 2304);
300353944Sdim    else
301353944Sdim      val = FIRST_32_SECOND_64(1216, 2304);
302353944Sdim  }
303353944Sdim#elif defined(__mips__)
304353944Sdim  // TODO(sagarthakur): add more values as per different glibc versions.
305353944Sdim  val = FIRST_32_SECOND_64(1152, 1776);
306353944Sdim#elif defined(__aarch64__)
307353944Sdim  // The sizeof (struct pthread) is the same from GLIBC 2.17 to 2.22.
308353944Sdim  val = 1776;
309353944Sdim#elif defined(__powerpc64__)
310353944Sdim  val = 1776; // from glibc.ppc64le 2.20-8.fc21
311353944Sdim#elif defined(__s390__)
312353944Sdim  val = FIRST_32_SECOND_64(1152, 1776); // valid for glibc 2.22
313353944Sdim#endif
314353944Sdim  if (val)
315353944Sdim    atomic_store_relaxed(&thread_descriptor_size, val);
316353944Sdim  return val;
317353944Sdim}
318353944Sdim
319353944Sdim// The offset at which pointer to self is located in the thread descriptor.
320353944Sdimconst uptr kThreadSelfOffset = FIRST_32_SECOND_64(8, 16);
321353944Sdim
322353944Sdimuptr ThreadSelfOffset() {
323353944Sdim  return kThreadSelfOffset;
324353944Sdim}
325353944Sdim
326353944Sdim#if defined(__mips__) || defined(__powerpc64__)
327353944Sdim// TlsPreTcbSize includes size of struct pthread_descr and size of tcb
328353944Sdim// head structure. It lies before the static tls blocks.
329353944Sdimstatic uptr TlsPreTcbSize() {
330353944Sdim# if defined(__mips__)
331353944Sdim  const uptr kTcbHead = 16; // sizeof (tcbhead_t)
332353944Sdim# elif defined(__powerpc64__)
333353944Sdim  const uptr kTcbHead = 88; // sizeof (tcbhead_t)
334353944Sdim# endif
335353944Sdim  const uptr kTlsAlign = 16;
336353944Sdim  const uptr kTlsPreTcbSize =
337353944Sdim      RoundUpTo(ThreadDescriptorSize() + kTcbHead, kTlsAlign);
338353944Sdim  return kTlsPreTcbSize;
339353944Sdim}
340353944Sdim#endif
341353944Sdim
342353944Sdimuptr ThreadSelf() {
343353944Sdim  uptr descr_addr;
344353944Sdim# if defined(__i386__)
345353944Sdim  asm("mov %%gs:%c1,%0" : "=r"(descr_addr) : "i"(kThreadSelfOffset));
346353944Sdim# elif defined(__x86_64__)
347353944Sdim  asm("mov %%fs:%c1,%0" : "=r"(descr_addr) : "i"(kThreadSelfOffset));
348353944Sdim# elif defined(__mips__)
349353944Sdim  // MIPS uses TLS variant I. The thread pointer (in hardware register $29)
350353944Sdim  // points to the end of the TCB + 0x7000. The pthread_descr structure is
351353944Sdim  // immediately in front of the TCB. TlsPreTcbSize() includes the size of the
352353944Sdim  // TCB and the size of pthread_descr.
353353944Sdim  const uptr kTlsTcbOffset = 0x7000;
354353944Sdim  uptr thread_pointer;
355353944Sdim  asm volatile(".set push;\
356353944Sdim                .set mips64r2;\
357353944Sdim                rdhwr %0,$29;\
358353944Sdim                .set pop" : "=r" (thread_pointer));
359353944Sdim  descr_addr = thread_pointer - kTlsTcbOffset - TlsPreTcbSize();
360353944Sdim# elif defined(__aarch64__) || defined(__arm__)
361353944Sdim  descr_addr = reinterpret_cast<uptr>(__builtin_thread_pointer()) -
362353944Sdim                                      ThreadDescriptorSize();
363353944Sdim# elif defined(__s390__)
364353944Sdim  descr_addr = reinterpret_cast<uptr>(__builtin_thread_pointer());
365353944Sdim# elif defined(__powerpc64__)
366353944Sdim  // PPC64LE uses TLS variant I. The thread pointer (in GPR 13)
367353944Sdim  // points to the end of the TCB + 0x7000. The pthread_descr structure is
368353944Sdim  // immediately in front of the TCB. TlsPreTcbSize() includes the size of the
369353944Sdim  // TCB and the size of pthread_descr.
370353944Sdim  const uptr kTlsTcbOffset = 0x7000;
371353944Sdim  uptr thread_pointer;
372353944Sdim  asm("addi %0,13,%1" : "=r"(thread_pointer) : "I"(-kTlsTcbOffset));
373353944Sdim  descr_addr = thread_pointer - TlsPreTcbSize();
374353944Sdim# else
375353944Sdim#  error "unsupported CPU arch"
376353944Sdim# endif
377353944Sdim  return descr_addr;
378353944Sdim}
379353944Sdim#endif  // (x86_64 || i386 || MIPS) && SANITIZER_LINUX
380353944Sdim
381353944Sdim#if SANITIZER_FREEBSD
382353944Sdimstatic void **ThreadSelfSegbase() {
383353944Sdim  void **segbase = 0;
384353944Sdim# if defined(__i386__)
385353944Sdim  // sysarch(I386_GET_GSBASE, segbase);
386353944Sdim  __asm __volatile("mov %%gs:0, %0" : "=r" (segbase));
387353944Sdim# elif defined(__x86_64__)
388353944Sdim  // sysarch(AMD64_GET_FSBASE, segbase);
389353944Sdim  __asm __volatile("movq %%fs:0, %0" : "=r" (segbase));
390353944Sdim# else
391353944Sdim#  error "unsupported CPU arch"
392353944Sdim# endif
393353944Sdim  return segbase;
394353944Sdim}
395353944Sdim
396353944Sdimuptr ThreadSelf() {
397353944Sdim  return (uptr)ThreadSelfSegbase()[2];
398353944Sdim}
399353944Sdim#endif  // SANITIZER_FREEBSD
400353944Sdim
401353944Sdim#if SANITIZER_NETBSD
402353944Sdimstatic struct tls_tcb * ThreadSelfTlsTcb() {
403357095Sdim  return (struct tls_tcb *)_lwp_getprivate();
404353944Sdim}
405353944Sdim
406353944Sdimuptr ThreadSelf() {
407353944Sdim  return (uptr)ThreadSelfTlsTcb()->tcb_pthread;
408353944Sdim}
409353944Sdim
410353944Sdimint GetSizeFromHdr(struct dl_phdr_info *info, size_t size, void *data) {
411353944Sdim  const Elf_Phdr *hdr = info->dlpi_phdr;
412353944Sdim  const Elf_Phdr *last_hdr = hdr + info->dlpi_phnum;
413353944Sdim
414353944Sdim  for (; hdr != last_hdr; ++hdr) {
415353944Sdim    if (hdr->p_type == PT_TLS && info->dlpi_tls_modid == 1) {
416353944Sdim      *(uptr*)data = hdr->p_memsz;
417353944Sdim      break;
418353944Sdim    }
419353944Sdim  }
420353944Sdim  return 0;
421353944Sdim}
422353944Sdim#endif  // SANITIZER_NETBSD
423353944Sdim
424353944Sdim#if !SANITIZER_GO
425353944Sdimstatic void GetTls(uptr *addr, uptr *size) {
426353944Sdim#if SANITIZER_LINUX && !SANITIZER_ANDROID
427353944Sdim# if defined(__x86_64__) || defined(__i386__) || defined(__s390__)
428353944Sdim  *addr = ThreadSelf();
429353944Sdim  *size = GetTlsSize();
430353944Sdim  *addr -= *size;
431353944Sdim  *addr += ThreadDescriptorSize();
432353944Sdim# elif defined(__mips__) || defined(__aarch64__) || defined(__powerpc64__) \
433353944Sdim    || defined(__arm__)
434353944Sdim  *addr = ThreadSelf();
435353944Sdim  *size = GetTlsSize();
436353944Sdim# else
437353944Sdim  *addr = 0;
438353944Sdim  *size = 0;
439353944Sdim# endif
440353944Sdim#elif SANITIZER_FREEBSD
441353944Sdim  void** segbase = ThreadSelfSegbase();
442353944Sdim  *addr = 0;
443353944Sdim  *size = 0;
444353944Sdim  if (segbase != 0) {
445353944Sdim    // tcbalign = 16
446353944Sdim    // tls_size = round(tls_static_space, tcbalign);
447353944Sdim    // dtv = segbase[1];
448353944Sdim    // dtv[2] = segbase - tls_static_space;
449353944Sdim    void **dtv = (void**) segbase[1];
450353944Sdim    *addr = (uptr) dtv[2];
451353944Sdim    *size = (*addr == 0) ? 0 : ((uptr) segbase[0] - (uptr) dtv[2]);
452353944Sdim  }
453353944Sdim#elif SANITIZER_NETBSD
454353944Sdim  struct tls_tcb * const tcb = ThreadSelfTlsTcb();
455353944Sdim  *addr = 0;
456353944Sdim  *size = 0;
457353944Sdim  if (tcb != 0) {
458353944Sdim    // Find size (p_memsz) of dlpi_tls_modid 1 (TLS block of the main program).
459353944Sdim    // ld.elf_so hardcodes the index 1.
460353944Sdim    dl_iterate_phdr(GetSizeFromHdr, size);
461353944Sdim
462353944Sdim    if (*size != 0) {
463353944Sdim      // The block has been found and tcb_dtv[1] contains the base address
464353944Sdim      *addr = (uptr)tcb->tcb_dtv[1];
465353944Sdim    }
466353944Sdim  }
467353944Sdim#elif SANITIZER_OPENBSD
468353944Sdim  *addr = 0;
469353944Sdim  *size = 0;
470353944Sdim#elif SANITIZER_ANDROID
471353944Sdim  *addr = 0;
472353944Sdim  *size = 0;
473353944Sdim#elif SANITIZER_SOLARIS
474353944Sdim  // FIXME
475353944Sdim  *addr = 0;
476353944Sdim  *size = 0;
477353944Sdim#else
478353944Sdim# error "Unknown OS"
479353944Sdim#endif
480353944Sdim}
481353944Sdim#endif
482353944Sdim
483353944Sdim#if !SANITIZER_GO
484353944Sdimuptr GetTlsSize() {
485353944Sdim#if SANITIZER_FREEBSD || SANITIZER_ANDROID || SANITIZER_NETBSD ||              \
486353944Sdim    SANITIZER_OPENBSD || SANITIZER_SOLARIS
487353944Sdim  uptr addr, size;
488353944Sdim  GetTls(&addr, &size);
489353944Sdim  return size;
490353944Sdim#elif defined(__mips__) || defined(__powerpc64__)
491353944Sdim  return RoundUpTo(g_tls_size + TlsPreTcbSize(), 16);
492353944Sdim#else
493353944Sdim  return g_tls_size;
494353944Sdim#endif
495353944Sdim}
496353944Sdim#endif
497353944Sdim
498353944Sdimvoid GetThreadStackAndTls(bool main, uptr *stk_addr, uptr *stk_size,
499353944Sdim                          uptr *tls_addr, uptr *tls_size) {
500353944Sdim#if SANITIZER_GO
501353944Sdim  // Stub implementation for Go.
502353944Sdim  *stk_addr = *stk_size = *tls_addr = *tls_size = 0;
503353944Sdim#else
504353944Sdim  GetTls(tls_addr, tls_size);
505353944Sdim
506353944Sdim  uptr stack_top, stack_bottom;
507353944Sdim  GetThreadStackTopAndBottom(main, &stack_top, &stack_bottom);
508353944Sdim  *stk_addr = stack_bottom;
509353944Sdim  *stk_size = stack_top - stack_bottom;
510353944Sdim
511353944Sdim  if (!main) {
512353944Sdim    // If stack and tls intersect, make them non-intersecting.
513353944Sdim    if (*tls_addr > *stk_addr && *tls_addr < *stk_addr + *stk_size) {
514353944Sdim      CHECK_GT(*tls_addr + *tls_size, *stk_addr);
515353944Sdim      CHECK_LE(*tls_addr + *tls_size, *stk_addr + *stk_size);
516353944Sdim      *stk_size -= *tls_size;
517353944Sdim      *tls_addr = *stk_addr + *stk_size;
518353944Sdim    }
519353944Sdim  }
520353944Sdim#endif
521353944Sdim}
522353944Sdim
523353944Sdim#if !SANITIZER_FREEBSD && !SANITIZER_OPENBSD
524353944Sdimtypedef ElfW(Phdr) Elf_Phdr;
525353944Sdim#elif SANITIZER_WORDSIZE == 32 && __FreeBSD_version <= 902001 // v9.2
526353944Sdim#define Elf_Phdr XElf32_Phdr
527353944Sdim#define dl_phdr_info xdl_phdr_info
528353944Sdim#define dl_iterate_phdr(c, b) xdl_iterate_phdr((c), (b))
529353944Sdim#endif // !SANITIZER_FREEBSD && !SANITIZER_OPENBSD
530353944Sdim
531353944Sdimstruct DlIteratePhdrData {
532353944Sdim  InternalMmapVectorNoCtor<LoadedModule> *modules;
533353944Sdim  bool first;
534353944Sdim};
535353944Sdim
536353944Sdimstatic int dl_iterate_phdr_cb(dl_phdr_info *info, size_t size, void *arg) {
537353944Sdim  DlIteratePhdrData *data = (DlIteratePhdrData*)arg;
538353944Sdim  InternalScopedString module_name(kMaxPathLength);
539353944Sdim  if (data->first) {
540353944Sdim    data->first = false;
541353944Sdim    // First module is the binary itself.
542353944Sdim    ReadBinaryNameCached(module_name.data(), module_name.size());
543353944Sdim  } else if (info->dlpi_name) {
544353944Sdim    module_name.append("%s", info->dlpi_name);
545353944Sdim  }
546353944Sdim  if (module_name[0] == '\0')
547353944Sdim    return 0;
548353944Sdim  LoadedModule cur_module;
549353944Sdim  cur_module.set(module_name.data(), info->dlpi_addr);
550353944Sdim  for (int i = 0; i < (int)info->dlpi_phnum; i++) {
551353944Sdim    const Elf_Phdr *phdr = &info->dlpi_phdr[i];
552353944Sdim    if (phdr->p_type == PT_LOAD) {
553353944Sdim      uptr cur_beg = info->dlpi_addr + phdr->p_vaddr;
554353944Sdim      uptr cur_end = cur_beg + phdr->p_memsz;
555353944Sdim      bool executable = phdr->p_flags & PF_X;
556353944Sdim      bool writable = phdr->p_flags & PF_W;
557353944Sdim      cur_module.addAddressRange(cur_beg, cur_end, executable,
558353944Sdim                                 writable);
559353944Sdim    }
560353944Sdim  }
561353944Sdim  data->modules->push_back(cur_module);
562353944Sdim  return 0;
563353944Sdim}
564353944Sdim
565353944Sdim#if SANITIZER_ANDROID && __ANDROID_API__ < 21
566353944Sdimextern "C" __attribute__((weak)) int dl_iterate_phdr(
567353944Sdim    int (*)(struct dl_phdr_info *, size_t, void *), void *);
568353944Sdim#endif
569353944Sdim
570353944Sdimstatic bool requiresProcmaps() {
571353944Sdim#if SANITIZER_ANDROID && __ANDROID_API__ <= 22
572353944Sdim  // Fall back to /proc/maps if dl_iterate_phdr is unavailable or broken.
573353944Sdim  // The runtime check allows the same library to work with
574353944Sdim  // both K and L (and future) Android releases.
575353944Sdim  return AndroidGetApiLevel() <= ANDROID_LOLLIPOP_MR1;
576353944Sdim#else
577353944Sdim  return false;
578353944Sdim#endif
579353944Sdim}
580353944Sdim
581353944Sdimstatic void procmapsInit(InternalMmapVectorNoCtor<LoadedModule> *modules) {
582353944Sdim  MemoryMappingLayout memory_mapping(/*cache_enabled*/true);
583353944Sdim  memory_mapping.DumpListOfModules(modules);
584353944Sdim}
585353944Sdim
586353944Sdimvoid ListOfModules::init() {
587353944Sdim  clearOrInit();
588353944Sdim  if (requiresProcmaps()) {
589353944Sdim    procmapsInit(&modules_);
590353944Sdim  } else {
591353944Sdim    DlIteratePhdrData data = {&modules_, true};
592353944Sdim    dl_iterate_phdr(dl_iterate_phdr_cb, &data);
593353944Sdim  }
594353944Sdim}
595353944Sdim
596353944Sdim// When a custom loader is used, dl_iterate_phdr may not contain the full
597353944Sdim// list of modules. Allow callers to fall back to using procmaps.
598353944Sdimvoid ListOfModules::fallbackInit() {
599353944Sdim  if (!requiresProcmaps()) {
600353944Sdim    clearOrInit();
601353944Sdim    procmapsInit(&modules_);
602353944Sdim  } else {
603353944Sdim    clear();
604353944Sdim  }
605353944Sdim}
606353944Sdim
607353944Sdim// getrusage does not give us the current RSS, only the max RSS.
608353944Sdim// Still, this is better than nothing if /proc/self/statm is not available
609353944Sdim// for some reason, e.g. due to a sandbox.
610353944Sdimstatic uptr GetRSSFromGetrusage() {
611353944Sdim  struct rusage usage;
612353944Sdim  if (getrusage(RUSAGE_SELF, &usage))  // Failed, probably due to a sandbox.
613353944Sdim    return 0;
614353944Sdim  return usage.ru_maxrss << 10;  // ru_maxrss is in Kb.
615353944Sdim}
616353944Sdim
617353944Sdimuptr GetRSS() {
618353944Sdim  if (!common_flags()->can_use_proc_maps_statm)
619353944Sdim    return GetRSSFromGetrusage();
620353944Sdim  fd_t fd = OpenFile("/proc/self/statm", RdOnly);
621353944Sdim  if (fd == kInvalidFd)
622353944Sdim    return GetRSSFromGetrusage();
623353944Sdim  char buf[64];
624353944Sdim  uptr len = internal_read(fd, buf, sizeof(buf) - 1);
625353944Sdim  internal_close(fd);
626353944Sdim  if ((sptr)len <= 0)
627353944Sdim    return 0;
628353944Sdim  buf[len] = 0;
629353944Sdim  // The format of the file is:
630353944Sdim  // 1084 89 69 11 0 79 0
631353944Sdim  // We need the second number which is RSS in pages.
632353944Sdim  char *pos = buf;
633353944Sdim  // Skip the first number.
634353944Sdim  while (*pos >= '0' && *pos <= '9')
635353944Sdim    pos++;
636353944Sdim  // Skip whitespaces.
637353944Sdim  while (!(*pos >= '0' && *pos <= '9') && *pos != 0)
638353944Sdim    pos++;
639353944Sdim  // Read the number.
640353944Sdim  uptr rss = 0;
641353944Sdim  while (*pos >= '0' && *pos <= '9')
642353944Sdim    rss = rss * 10 + *pos++ - '0';
643353944Sdim  return rss * GetPageSizeCached();
644353944Sdim}
645353944Sdim
646353944Sdim// sysconf(_SC_NPROCESSORS_{CONF,ONLN}) cannot be used on most platforms as
647353944Sdim// they allocate memory.
648353944Sdimu32 GetNumberOfCPUs() {
649353944Sdim#if SANITIZER_FREEBSD || SANITIZER_NETBSD || SANITIZER_OPENBSD
650353944Sdim  u32 ncpu;
651353944Sdim  int req[2];
652353944Sdim  uptr len = sizeof(ncpu);
653353944Sdim  req[0] = CTL_HW;
654353944Sdim  req[1] = HW_NCPU;
655353944Sdim  CHECK_EQ(internal_sysctl(req, 2, &ncpu, &len, NULL, 0), 0);
656353944Sdim  return ncpu;
657353944Sdim#elif SANITIZER_ANDROID && !defined(CPU_COUNT) && !defined(__aarch64__)
658353944Sdim  // Fall back to /sys/devices/system/cpu on Android when cpu_set_t doesn't
659353944Sdim  // exist in sched.h. That is the case for toolchains generated with older
660353944Sdim  // NDKs.
661353944Sdim  // This code doesn't work on AArch64 because internal_getdents makes use of
662353944Sdim  // the 64bit getdents syscall, but cpu_set_t seems to always exist on AArch64.
663353944Sdim  uptr fd = internal_open("/sys/devices/system/cpu", O_RDONLY | O_DIRECTORY);
664353944Sdim  if (internal_iserror(fd))
665353944Sdim    return 0;
666353944Sdim  InternalMmapVector<u8> buffer(4096);
667353944Sdim  uptr bytes_read = buffer.size();
668353944Sdim  uptr n_cpus = 0;
669353944Sdim  u8 *d_type;
670353944Sdim  struct linux_dirent *entry = (struct linux_dirent *)&buffer[bytes_read];
671353944Sdim  while (true) {
672353944Sdim    if ((u8 *)entry >= &buffer[bytes_read]) {
673353944Sdim      bytes_read = internal_getdents(fd, (struct linux_dirent *)buffer.data(),
674353944Sdim                                     buffer.size());
675353944Sdim      if (internal_iserror(bytes_read) || !bytes_read)
676353944Sdim        break;
677353944Sdim      entry = (struct linux_dirent *)buffer.data();
678353944Sdim    }
679353944Sdim    d_type = (u8 *)entry + entry->d_reclen - 1;
680353944Sdim    if (d_type >= &buffer[bytes_read] ||
681353944Sdim        (u8 *)&entry->d_name[3] >= &buffer[bytes_read])
682353944Sdim      break;
683353944Sdim    if (entry->d_ino != 0 && *d_type == DT_DIR) {
684353944Sdim      if (entry->d_name[0] == 'c' && entry->d_name[1] == 'p' &&
685353944Sdim          entry->d_name[2] == 'u' &&
686353944Sdim          entry->d_name[3] >= '0' && entry->d_name[3] <= '9')
687353944Sdim        n_cpus++;
688353944Sdim    }
689353944Sdim    entry = (struct linux_dirent *)(((u8 *)entry) + entry->d_reclen);
690353944Sdim  }
691353944Sdim  internal_close(fd);
692353944Sdim  return n_cpus;
693353944Sdim#elif SANITIZER_SOLARIS
694353944Sdim  return sysconf(_SC_NPROCESSORS_ONLN);
695353944Sdim#else
696353944Sdim  cpu_set_t CPUs;
697353944Sdim  CHECK_EQ(sched_getaffinity(0, sizeof(cpu_set_t), &CPUs), 0);
698353944Sdim  return CPU_COUNT(&CPUs);
699353944Sdim#endif
700353944Sdim}
701353944Sdim
702353944Sdim#if SANITIZER_LINUX
703353944Sdim
704353944Sdim# if SANITIZER_ANDROID
705353944Sdimstatic atomic_uint8_t android_log_initialized;
706353944Sdim
707353944Sdimvoid AndroidLogInit() {
708353944Sdim  openlog(GetProcessName(), 0, LOG_USER);
709353944Sdim  atomic_store(&android_log_initialized, 1, memory_order_release);
710353944Sdim}
711353944Sdim
712353944Sdimstatic bool ShouldLogAfterPrintf() {
713353944Sdim  return atomic_load(&android_log_initialized, memory_order_acquire);
714353944Sdim}
715353944Sdim
716353944Sdimextern "C" SANITIZER_WEAK_ATTRIBUTE
717353944Sdimint async_safe_write_log(int pri, const char* tag, const char* msg);
718353944Sdimextern "C" SANITIZER_WEAK_ATTRIBUTE
719353944Sdimint __android_log_write(int prio, const char* tag, const char* msg);
720353944Sdim
721353944Sdim// ANDROID_LOG_INFO is 4, but can't be resolved at runtime.
722353944Sdim#define SANITIZER_ANDROID_LOG_INFO 4
723353944Sdim
724353944Sdim// async_safe_write_log is a new public version of __libc_write_log that is
725353944Sdim// used behind syslog. It is preferable to syslog as it will not do any dynamic
726353944Sdim// memory allocation or formatting.
727353944Sdim// If the function is not available, syslog is preferred for L+ (it was broken
728353944Sdim// pre-L) as __android_log_write triggers a racey behavior with the strncpy
729353944Sdim// interceptor. Fallback to __android_log_write pre-L.
730353944Sdimvoid WriteOneLineToSyslog(const char *s) {
731353944Sdim  if (&async_safe_write_log) {
732353944Sdim    async_safe_write_log(SANITIZER_ANDROID_LOG_INFO, GetProcessName(), s);
733353944Sdim  } else if (AndroidGetApiLevel() > ANDROID_KITKAT) {
734353944Sdim    syslog(LOG_INFO, "%s", s);
735353944Sdim  } else {
736353944Sdim    CHECK(&__android_log_write);
737353944Sdim    __android_log_write(SANITIZER_ANDROID_LOG_INFO, nullptr, s);
738353944Sdim  }
739353944Sdim}
740353944Sdim
741353944Sdimextern "C" SANITIZER_WEAK_ATTRIBUTE
742353944Sdimvoid android_set_abort_message(const char *);
743353944Sdim
744353944Sdimvoid SetAbortMessage(const char *str) {
745353944Sdim  if (&android_set_abort_message)
746353944Sdim    android_set_abort_message(str);
747353944Sdim}
748353944Sdim# else
749353944Sdimvoid AndroidLogInit() {}
750353944Sdim
751353944Sdimstatic bool ShouldLogAfterPrintf() { return true; }
752353944Sdim
753353944Sdimvoid WriteOneLineToSyslog(const char *s) { syslog(LOG_INFO, "%s", s); }
754353944Sdim
755353944Sdimvoid SetAbortMessage(const char *str) {}
756353944Sdim# endif  // SANITIZER_ANDROID
757353944Sdim
758353944Sdimvoid LogMessageOnPrintf(const char *str) {
759353944Sdim  if (common_flags()->log_to_syslog && ShouldLogAfterPrintf())
760353944Sdim    WriteToSyslog(str);
761353944Sdim}
762353944Sdim
763353944Sdim#endif  // SANITIZER_LINUX
764353944Sdim
765353944Sdim#if SANITIZER_LINUX && !SANITIZER_GO
766353944Sdim// glibc crashes when using clock_gettime from a preinit_array function as the
767353944Sdim// vDSO function pointers haven't been initialized yet. __progname is
768353944Sdim// initialized after the vDSO function pointers, so if it exists, is not null
769353944Sdim// and is not empty, we can use clock_gettime.
770353944Sdimextern "C" SANITIZER_WEAK_ATTRIBUTE char *__progname;
771353944SdimINLINE bool CanUseVDSO() {
772353944Sdim  // Bionic is safe, it checks for the vDSO function pointers to be initialized.
773353944Sdim  if (SANITIZER_ANDROID)
774353944Sdim    return true;
775353944Sdim  if (&__progname && __progname && *__progname)
776353944Sdim    return true;
777353944Sdim  return false;
778353944Sdim}
779353944Sdim
780353944Sdim// MonotonicNanoTime is a timing function that can leverage the vDSO by calling
781353944Sdim// clock_gettime. real_clock_gettime only exists if clock_gettime is
782353944Sdim// intercepted, so define it weakly and use it if available.
783353944Sdimextern "C" SANITIZER_WEAK_ATTRIBUTE
784353944Sdimint real_clock_gettime(u32 clk_id, void *tp);
785353944Sdimu64 MonotonicNanoTime() {
786353944Sdim  timespec ts;
787353944Sdim  if (CanUseVDSO()) {
788353944Sdim    if (&real_clock_gettime)
789353944Sdim      real_clock_gettime(CLOCK_MONOTONIC, &ts);
790353944Sdim    else
791353944Sdim      clock_gettime(CLOCK_MONOTONIC, &ts);
792353944Sdim  } else {
793353944Sdim    internal_clock_gettime(CLOCK_MONOTONIC, &ts);
794353944Sdim  }
795353944Sdim  return (u64)ts.tv_sec * (1000ULL * 1000 * 1000) + ts.tv_nsec;
796353944Sdim}
797353944Sdim#else
798353944Sdim// Non-Linux & Go always use the syscall.
799353944Sdimu64 MonotonicNanoTime() {
800353944Sdim  timespec ts;
801353944Sdim  internal_clock_gettime(CLOCK_MONOTONIC, &ts);
802353944Sdim  return (u64)ts.tv_sec * (1000ULL * 1000 * 1000) + ts.tv_nsec;
803353944Sdim}
804353944Sdim#endif  // SANITIZER_LINUX && !SANITIZER_GO
805353944Sdim
806353944Sdim#if !SANITIZER_OPENBSD
807353944Sdimvoid ReExec() {
808353944Sdim  const char *pathname = "/proc/self/exe";
809353944Sdim
810353944Sdim#if SANITIZER_NETBSD
811353944Sdim  static const int name[] = {
812353944Sdim      CTL_KERN,
813353944Sdim      KERN_PROC_ARGS,
814353944Sdim      -1,
815353944Sdim      KERN_PROC_PATHNAME,
816353944Sdim  };
817353944Sdim  char path[400];
818353944Sdim  uptr len;
819353944Sdim
820353944Sdim  len = sizeof(path);
821353944Sdim  if (internal_sysctl(name, ARRAY_SIZE(name), path, &len, NULL, 0) != -1)
822353944Sdim    pathname = path;
823353944Sdim#elif SANITIZER_SOLARIS
824353944Sdim  pathname = getexecname();
825353944Sdim  CHECK_NE(pathname, NULL);
826353944Sdim#elif SANITIZER_USE_GETAUXVAL
827353944Sdim  // Calling execve with /proc/self/exe sets that as $EXEC_ORIGIN. Binaries that
828353944Sdim  // rely on that will fail to load shared libraries. Query AT_EXECFN instead.
829353944Sdim  pathname = reinterpret_cast<const char *>(getauxval(AT_EXECFN));
830353944Sdim#endif
831353944Sdim
832353944Sdim  uptr rv = internal_execve(pathname, GetArgv(), GetEnviron());
833353944Sdim  int rverrno;
834353944Sdim  CHECK_EQ(internal_iserror(rv, &rverrno), true);
835353944Sdim  Printf("execve failed, errno %d\n", rverrno);
836353944Sdim  Die();
837353944Sdim}
838353944Sdim#endif  // !SANITIZER_OPENBSD
839353944Sdim
840353944Sdim} // namespace __sanitizer
841353944Sdim
842353944Sdim#endif
843