1 //===-- sanitizer_linux_libcdep.cpp ---------------------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file is shared between AddressSanitizer and ThreadSanitizer
10 // run-time libraries and implements linux-specific functions from
11 // sanitizer_libc.h.
12 //===----------------------------------------------------------------------===//
13 
14 #include "sanitizer_platform.h"
15 
16 #if SANITIZER_FREEBSD || SANITIZER_LINUX || SANITIZER_NETBSD || \
17     SANITIZER_SOLARIS
18 
19 #include "sanitizer_allocator_internal.h"
20 #include "sanitizer_atomic.h"
21 #include "sanitizer_common.h"
22 #include "sanitizer_file.h"
23 #include "sanitizer_flags.h"
24 #include "sanitizer_freebsd.h"
25 #include "sanitizer_getauxval.h"
26 #include "sanitizer_glibc_version.h"
27 #include "sanitizer_linux.h"
28 #include "sanitizer_placement_new.h"
29 #include "sanitizer_procmaps.h"
30 
31 #if SANITIZER_NETBSD
32 #define _RTLD_SOURCE  // for __lwp_gettcb_fast() / __lwp_getprivate_fast()
33 #endif
34 
35 #include <dlfcn.h>  // for dlsym()
36 #include <link.h>
37 #include <pthread.h>
38 #include <signal.h>
39 #include <sys/mman.h>
40 #include <sys/resource.h>
41 #include <syslog.h>
42 
43 #if !defined(ElfW)
44 #define ElfW(type) Elf_##type
45 #endif
46 
47 #if SANITIZER_FREEBSD
48 #include <pthread_np.h>
49 #include <osreldate.h>
50 #include <sys/sysctl.h>
51 #define pthread_getattr_np pthread_attr_get_np
52 // The MAP_NORESERVE define has been removed in FreeBSD 11.x, and even before
53 // that, it was never implemented. So just define it to zero.
54 #undef MAP_NORESERVE
55 #define MAP_NORESERVE 0
56 #endif
57 
58 #if SANITIZER_NETBSD
59 #include <sys/sysctl.h>
60 #include <sys/tls.h>
61 #include <lwp.h>
62 #endif
63 
64 #if SANITIZER_SOLARIS
65 #include <stdlib.h>
66 #include <thread.h>
67 #endif
68 
69 #if SANITIZER_ANDROID
70 #include <android/api-level.h>
71 #if !defined(CPU_COUNT) && !defined(__aarch64__)
72 #include <dirent.h>
73 #include <fcntl.h>
74 struct __sanitizer::linux_dirent {
75   long           d_ino;
76   off_t          d_off;
77   unsigned short d_reclen;
78   char           d_name[];
79 };
80 #endif
81 #endif
82 
83 #if !SANITIZER_ANDROID
84 #include <elf.h>
85 #include <unistd.h>
86 #endif
87 
88 namespace __sanitizer {
89 
90 SANITIZER_WEAK_ATTRIBUTE int
91 real_sigaction(int signum, const void *act, void *oldact);
92 
93 int internal_sigaction(int signum, const void *act, void *oldact) {
94 #if !SANITIZER_GO
95   if (&real_sigaction)
96     return real_sigaction(signum, act, oldact);
97 #endif
98   return sigaction(signum, (const struct sigaction *)act,
99                    (struct sigaction *)oldact);
100 }
101 
102 void GetThreadStackTopAndBottom(bool at_initialization, uptr *stack_top,
103                                 uptr *stack_bottom) {
104   CHECK(stack_top);
105   CHECK(stack_bottom);
106   if (at_initialization) {
107     // This is the main thread. Libpthread may not be initialized yet.
108     struct rlimit rl;
109     CHECK_EQ(getrlimit(RLIMIT_STACK, &rl), 0);
110 
111     // Find the mapping that contains a stack variable.
112     MemoryMappingLayout proc_maps(/*cache_enabled*/true);
113     if (proc_maps.Error()) {
114       *stack_top = *stack_bottom = 0;
115       return;
116     }
117     MemoryMappedSegment segment;
118     uptr prev_end = 0;
119     while (proc_maps.Next(&segment)) {
120       if ((uptr)&rl < segment.end) break;
121       prev_end = segment.end;
122     }
123     CHECK((uptr)&rl >= segment.start && (uptr)&rl < segment.end);
124 
125     // Get stacksize from rlimit, but clip it so that it does not overlap
126     // with other mappings.
127     uptr stacksize = rl.rlim_cur;
128     if (stacksize > segment.end - prev_end) stacksize = segment.end - prev_end;
129     // When running with unlimited stack size, we still want to set some limit.
130     // The unlimited stack size is caused by 'ulimit -s unlimited'.
131     // Also, for some reason, GNU make spawns subprocesses with unlimited stack.
132     if (stacksize > kMaxThreadStackSize)
133       stacksize = kMaxThreadStackSize;
134     *stack_top = segment.end;
135     *stack_bottom = segment.end - stacksize;
136     return;
137   }
138   uptr stacksize = 0;
139   void *stackaddr = nullptr;
140 #if SANITIZER_SOLARIS
141   stack_t ss;
142   CHECK_EQ(thr_stksegment(&ss), 0);
143   stacksize = ss.ss_size;
144   stackaddr = (char *)ss.ss_sp - stacksize;
145 #else  // !SANITIZER_SOLARIS
146   pthread_attr_t attr;
147   pthread_attr_init(&attr);
148   CHECK_EQ(pthread_getattr_np(pthread_self(), &attr), 0);
149   my_pthread_attr_getstack(&attr, &stackaddr, &stacksize);
150   pthread_attr_destroy(&attr);
151 #endif  // SANITIZER_SOLARIS
152 
153   *stack_top = (uptr)stackaddr + stacksize;
154   *stack_bottom = (uptr)stackaddr;
155 }
156 
157 #if !SANITIZER_GO
158 bool SetEnv(const char *name, const char *value) {
159   void *f = dlsym(RTLD_NEXT, "setenv");
160   if (!f)
161     return false;
162   typedef int(*setenv_ft)(const char *name, const char *value, int overwrite);
163   setenv_ft setenv_f;
164   CHECK_EQ(sizeof(setenv_f), sizeof(f));
165   internal_memcpy(&setenv_f, &f, sizeof(f));
166   return setenv_f(name, value, 1) == 0;
167 }
168 #endif
169 
170 __attribute__((unused)) static bool GetLibcVersion(int *major, int *minor,
171                                                    int *patch) {
172 #ifdef _CS_GNU_LIBC_VERSION
173   char buf[64];
174   uptr len = confstr(_CS_GNU_LIBC_VERSION, buf, sizeof(buf));
175   if (len >= sizeof(buf))
176     return false;
177   buf[len] = 0;
178   static const char kGLibC[] = "glibc ";
179   if (internal_strncmp(buf, kGLibC, sizeof(kGLibC) - 1) != 0)
180     return false;
181   const char *p = buf + sizeof(kGLibC) - 1;
182   *major = internal_simple_strtoll(p, &p, 10);
183   *minor = (*p == '.') ? internal_simple_strtoll(p + 1, &p, 10) : 0;
184   *patch = (*p == '.') ? internal_simple_strtoll(p + 1, &p, 10) : 0;
185   return true;
186 #else
187   return false;
188 #endif
189 }
190 
191 // ThreadDescriptorSize() is only used by lsan to get the pointer to
192 // thread-specific data keys in the thread control block.
193 #if (defined(__x86_64__) || defined(__i386__) || defined(__mips__) ||       \
194      defined(__aarch64__) || defined(__powerpc64__) || defined(__s390__) || \
195      defined(__arm__) || SANITIZER_RISCV64) &&                              \
196     SANITIZER_LINUX && !SANITIZER_ANDROID
197 // sizeof(struct pthread) from glibc.
198 static atomic_uintptr_t thread_descriptor_size;
199 
200 uptr ThreadDescriptorSize() {
201   uptr val = atomic_load_relaxed(&thread_descriptor_size);
202   if (val)
203     return val;
204 #if defined(__x86_64__) || defined(__i386__) || defined(__arm__)
205   int major;
206   int minor;
207   int patch;
208   if (GetLibcVersion(&major, &minor, &patch) && major == 2) {
209     /* sizeof(struct pthread) values from various glibc versions.  */
210     if (SANITIZER_X32)
211       val = 1728; // Assume only one particular version for x32.
212     // For ARM sizeof(struct pthread) changed in Glibc 2.23.
213     else if (SANITIZER_ARM)
214       val = minor <= 22 ? 1120 : 1216;
215     else if (minor <= 3)
216       val = FIRST_32_SECOND_64(1104, 1696);
217     else if (minor == 4)
218       val = FIRST_32_SECOND_64(1120, 1728);
219     else if (minor == 5)
220       val = FIRST_32_SECOND_64(1136, 1728);
221     else if (minor <= 9)
222       val = FIRST_32_SECOND_64(1136, 1712);
223     else if (minor == 10)
224       val = FIRST_32_SECOND_64(1168, 1776);
225     else if (minor == 11 || (minor == 12 && patch == 1))
226       val = FIRST_32_SECOND_64(1168, 2288);
227     else if (minor <= 14)
228       val = FIRST_32_SECOND_64(1168, 2304);
229     else if (minor < 32)  // Unknown version
230       val = FIRST_32_SECOND_64(1216, 2304);
231     else  // minor == 32
232       val = FIRST_32_SECOND_64(1344, 2496);
233   }
234 #elif defined(__mips__)
235   // TODO(sagarthakur): add more values as per different glibc versions.
236   val = FIRST_32_SECOND_64(1152, 1776);
237 #elif SANITIZER_RISCV64
238   int major;
239   int minor;
240   int patch;
241   if (GetLibcVersion(&major, &minor, &patch) && major == 2) {
242     // TODO: consider adding an optional runtime check for an unknown (untested)
243     // glibc version
244     if (minor <= 28)  // WARNING: the highest tested version is 2.29
245       val = 1772;     // no guarantees for this one
246     else if (minor <= 31)
247       val = 1772;  // tested against glibc 2.29, 2.31
248     else
249       val = 1936;  // tested against glibc 2.32
250   }
251 
252 #elif defined(__aarch64__)
253   // The sizeof (struct pthread) is the same from GLIBC 2.17 to 2.22.
254   val = 1776;
255 #elif defined(__powerpc64__)
256   val = 1776; // from glibc.ppc64le 2.20-8.fc21
257 #elif defined(__s390__)
258   val = FIRST_32_SECOND_64(1152, 1776); // valid for glibc 2.22
259 #endif
260   if (val)
261     atomic_store_relaxed(&thread_descriptor_size, val);
262   return val;
263 }
264 
265 #if defined(__mips__) || defined(__powerpc64__) || SANITIZER_RISCV64
266 // TlsPreTcbSize includes size of struct pthread_descr and size of tcb
267 // head structure. It lies before the static tls blocks.
268 static uptr TlsPreTcbSize() {
269 #if defined(__mips__)
270   const uptr kTcbHead = 16; // sizeof (tcbhead_t)
271 #elif defined(__powerpc64__)
272   const uptr kTcbHead = 88; // sizeof (tcbhead_t)
273 #elif SANITIZER_RISCV64
274   const uptr kTcbHead = 16;  // sizeof (tcbhead_t)
275 #endif
276   const uptr kTlsAlign = 16;
277   const uptr kTlsPreTcbSize =
278       RoundUpTo(ThreadDescriptorSize() + kTcbHead, kTlsAlign);
279   return kTlsPreTcbSize;
280 }
281 #endif
282 
283 #if !SANITIZER_GO
284 namespace {
285 struct TlsBlock {
286   uptr begin, end, align;
287   size_t tls_modid;
288   bool operator<(const TlsBlock &rhs) const { return begin < rhs.begin; }
289 };
290 }  // namespace
291 
292 extern "C" void *__tls_get_addr(size_t *);
293 
294 static int TouchTlsBlock(struct dl_phdr_info *info, size_t size,
295                          void *data) {
296   size_t mod_and_off[2] = {info->dlpi_tls_modid, 0};
297   if (mod_and_off[0] != 0)
298     __tls_get_addr(mod_and_off);
299   return 0;
300 }
301 
302 static int CollectStaticTlsBlocks(struct dl_phdr_info *info, size_t size,
303                                   void *data) {
304   if (!info->dlpi_tls_data)
305     return 0;
306   const uptr begin = (uptr)info->dlpi_tls_data;
307   for (unsigned i = 0; i != info->dlpi_phnum; ++i)
308     if (info->dlpi_phdr[i].p_type == PT_TLS) {
309       static_cast<InternalMmapVector<TlsBlock> *>(data)->push_back(
310           TlsBlock{begin, begin + info->dlpi_phdr[i].p_memsz,
311                    info->dlpi_phdr[i].p_align, info->dlpi_tls_modid});
312       break;
313     }
314   return 0;
315 }
316 
317 static void GetStaticTlsBoundary(uptr *addr, uptr *size, uptr *align) {
318   InternalMmapVector<TlsBlock> ranges;
319   dl_iterate_phdr(CollectStaticTlsBlocks, &ranges);
320   uptr len = ranges.size();
321   Sort(ranges.begin(), len);
322   // Find the range with tls_modid=1. For glibc, because libc.so uses PT_TLS,
323   // this module is guaranteed to exist and is one of the initially loaded
324   // modules.
325   uptr one = 0;
326   while (one != len && ranges[one].tls_modid != 1) ++one;
327   if (one == len) {
328     // This may happen with musl if no module uses PT_TLS.
329     *addr = 0;
330     *size = 0;
331     *align = 1;
332     return;
333   }
334   // Find the maximum consecutive ranges. We consider two modules consecutive if
335   // the gap is smaller than the alignment. The dynamic loader places static TLS
336   // blocks this way not to waste space.
337   uptr l = one;
338   *align = ranges[l].align;
339   while (l != 0 && ranges[l].begin < ranges[l - 1].end + ranges[l - 1].align)
340     *align = Max(*align, ranges[--l].align);
341   uptr r = one + 1;
342   while (r != len && ranges[r].begin < ranges[r - 1].end + ranges[r - 1].align)
343     *align = Max(*align, ranges[r++].align);
344   *addr = ranges[l].begin;
345   *size = ranges[r - 1].end - ranges[l].begin;
346 }
347 #endif  // !SANITIZER_GO
348 #endif  // (x86_64 || i386 || mips || ...) && SANITIZER_LINUX &&
349         // !SANITIZER_ANDROID
350 
351 #if SANITIZER_FREEBSD
352 static void **ThreadSelfSegbase() {
353   void **segbase = 0;
354 #if defined(__i386__)
355   // sysarch(I386_GET_GSBASE, segbase);
356   __asm __volatile("mov %%gs:0, %0" : "=r" (segbase));
357 #elif defined(__x86_64__)
358   // sysarch(AMD64_GET_FSBASE, segbase);
359   __asm __volatile("movq %%fs:0, %0" : "=r" (segbase));
360 #else
361 #error "unsupported CPU arch"
362 #endif
363   return segbase;
364 }
365 
366 uptr ThreadSelf() {
367   return (uptr)ThreadSelfSegbase()[2];
368 }
369 #endif  // SANITIZER_FREEBSD
370 
371 #if SANITIZER_NETBSD
372 static struct tls_tcb * ThreadSelfTlsTcb() {
373   struct tls_tcb *tcb = nullptr;
374 #ifdef __HAVE___LWP_GETTCB_FAST
375   tcb = (struct tls_tcb *)__lwp_gettcb_fast();
376 #elif defined(__HAVE___LWP_GETPRIVATE_FAST)
377   tcb = (struct tls_tcb *)__lwp_getprivate_fast();
378 #endif
379   return tcb;
380 }
381 
382 uptr ThreadSelf() {
383   return (uptr)ThreadSelfTlsTcb()->tcb_pthread;
384 }
385 
386 int GetSizeFromHdr(struct dl_phdr_info *info, size_t size, void *data) {
387   const Elf_Phdr *hdr = info->dlpi_phdr;
388   const Elf_Phdr *last_hdr = hdr + info->dlpi_phnum;
389 
390   for (; hdr != last_hdr; ++hdr) {
391     if (hdr->p_type == PT_TLS && info->dlpi_tls_modid == 1) {
392       *(uptr*)data = hdr->p_memsz;
393       break;
394     }
395   }
396   return 0;
397 }
398 #endif  // SANITIZER_NETBSD
399 
400 #if SANITIZER_ANDROID
401 // Bionic provides this API since S.
402 extern "C" SANITIZER_WEAK_ATTRIBUTE void __libc_get_static_tls_bounds(void **,
403                                                                       void **);
404 #endif
405 
406 #if !SANITIZER_GO
407 static void GetTls(uptr *addr, uptr *size) {
408 #if SANITIZER_ANDROID
409   if (&__libc_get_static_tls_bounds) {
410     void *start_addr;
411     void *end_addr;
412     __libc_get_static_tls_bounds(&start_addr, &end_addr);
413     *addr = reinterpret_cast<uptr>(start_addr);
414     *size =
415         reinterpret_cast<uptr>(end_addr) - reinterpret_cast<uptr>(start_addr);
416   } else {
417     *addr = 0;
418     *size = 0;
419   }
420 #elif SANITIZER_LINUX
421   // glibc before 2.25 (BZ #19826) does not set dlpi_tls_data. Call
422   // __tls_get_addr to force allocation. For safety, skip grte/v4-2.19 for now.
423   int major, minor, patch;
424   if (GetLibcVersion(&major, &minor, &patch) && major == 2 && minor < 25 &&
425       minor != 19)
426     dl_iterate_phdr(TouchTlsBlock, nullptr);
427 
428   uptr align;
429   GetStaticTlsBoundary(addr, size, &align);
430 #if defined(__x86_64__) || defined(__i386__) || defined(__s390__)
431   if (SANITIZER_GLIBC) {
432 #if defined(__s390__)
433     align = Max<uptr>(align, 16);
434 #else
435     align = Max<uptr>(align, 64);
436 #endif
437   }
438   const uptr tp = RoundUpTo(*addr + *size, align);
439 
440   // lsan requires the range to additionally cover the static TLS surplus
441   // (elf/dl-tls.c defines 1664). Otherwise there may be false positives for
442   // allocations only referenced by tls in dynamically loaded modules.
443   if (SANITIZER_GLIBC)
444     *size += 1644;
445 
446   // Extend the range to include the thread control block. On glibc, lsan needs
447   // the range to include pthread::{specific_1stblock,specific} so that
448   // allocations only referenced by pthread_setspecific can be scanned. This may
449   // underestimate by at most TLS_TCB_ALIGN-1 bytes but it should be fine
450   // because the number of bytes after pthread::specific is larger.
451   *addr = tp - RoundUpTo(*size, align);
452   *size = tp - *addr + ThreadDescriptorSize();
453 #else
454   if (SANITIZER_GLIBC)
455     *size += 1664;
456 #if defined(__mips__) || defined(__powerpc64__) || SANITIZER_RISCV64
457   const uptr pre_tcb_size = TlsPreTcbSize();
458   *addr -= pre_tcb_size;
459   *size += pre_tcb_size;
460 #else
461   // arm and aarch64 reserve two words at TP, so this underestimates the range.
462   // However, this is sufficient for the purpose of finding the pointers to
463   // thread-specific data keys.
464   const uptr tcb_size = ThreadDescriptorSize();
465   *addr -= tcb_size;
466   *size += tcb_size;
467 #endif
468 #endif
469 #elif SANITIZER_FREEBSD
470   void** segbase = ThreadSelfSegbase();
471   *addr = 0;
472   *size = 0;
473   if (segbase != 0) {
474     // tcbalign = 16
475     // tls_size = round(tls_static_space, tcbalign);
476     // dtv = segbase[1];
477     // dtv[2] = segbase - tls_static_space;
478     void **dtv = (void**) segbase[1];
479     *addr = (uptr) dtv[2];
480     *size = (*addr == 0) ? 0 : ((uptr) segbase[0] - (uptr) dtv[2]);
481   }
482 #elif SANITIZER_NETBSD
483   struct tls_tcb * const tcb = ThreadSelfTlsTcb();
484   *addr = 0;
485   *size = 0;
486   if (tcb != 0) {
487     // Find size (p_memsz) of dlpi_tls_modid 1 (TLS block of the main program).
488     // ld.elf_so hardcodes the index 1.
489     dl_iterate_phdr(GetSizeFromHdr, size);
490 
491     if (*size != 0) {
492       // The block has been found and tcb_dtv[1] contains the base address
493       *addr = (uptr)tcb->tcb_dtv[1];
494     }
495   }
496 #elif SANITIZER_SOLARIS
497   // FIXME
498   *addr = 0;
499   *size = 0;
500 #else
501 #error "Unknown OS"
502 #endif
503 }
504 #endif
505 
506 #if !SANITIZER_GO
507 uptr GetTlsSize() {
508 #if SANITIZER_FREEBSD || SANITIZER_LINUX || SANITIZER_NETBSD || \
509     SANITIZER_SOLARIS
510   uptr addr, size;
511   GetTls(&addr, &size);
512   return size;
513 #else
514   return 0;
515 #endif
516 }
517 #endif
518 
519 void GetThreadStackAndTls(bool main, uptr *stk_addr, uptr *stk_size,
520                           uptr *tls_addr, uptr *tls_size) {
521 #if SANITIZER_GO
522   // Stub implementation for Go.
523   *stk_addr = *stk_size = *tls_addr = *tls_size = 0;
524 #else
525   GetTls(tls_addr, tls_size);
526 
527   uptr stack_top, stack_bottom;
528   GetThreadStackTopAndBottom(main, &stack_top, &stack_bottom);
529   *stk_addr = stack_bottom;
530   *stk_size = stack_top - stack_bottom;
531 
532   if (!main) {
533     // If stack and tls intersect, make them non-intersecting.
534     if (*tls_addr > *stk_addr && *tls_addr < *stk_addr + *stk_size) {
535       if (*stk_addr + *stk_size < *tls_addr + *tls_size)
536         *tls_size = *stk_addr + *stk_size - *tls_addr;
537       *stk_size = *tls_addr - *stk_addr;
538     }
539   }
540 #endif
541 }
542 
543 #if !SANITIZER_FREEBSD
544 typedef ElfW(Phdr) Elf_Phdr;
545 #elif SANITIZER_WORDSIZE == 32 && __FreeBSD_version <= 902001  // v9.2
546 #define Elf_Phdr XElf32_Phdr
547 #define dl_phdr_info xdl_phdr_info
548 #define dl_iterate_phdr(c, b) xdl_iterate_phdr((c), (b))
549 #endif  // !SANITIZER_FREEBSD
550 
551 struct DlIteratePhdrData {
552   InternalMmapVectorNoCtor<LoadedModule> *modules;
553   bool first;
554 };
555 
556 static int AddModuleSegments(const char *module_name, dl_phdr_info *info,
557                              InternalMmapVectorNoCtor<LoadedModule> *modules) {
558   if (module_name[0] == '\0')
559     return 0;
560   LoadedModule cur_module;
561   cur_module.set(module_name, info->dlpi_addr);
562   for (int i = 0; i < (int)info->dlpi_phnum; i++) {
563     const Elf_Phdr *phdr = &info->dlpi_phdr[i];
564     if (phdr->p_type == PT_LOAD) {
565       uptr cur_beg = info->dlpi_addr + phdr->p_vaddr;
566       uptr cur_end = cur_beg + phdr->p_memsz;
567       bool executable = phdr->p_flags & PF_X;
568       bool writable = phdr->p_flags & PF_W;
569       cur_module.addAddressRange(cur_beg, cur_end, executable,
570                                  writable);
571     }
572   }
573   modules->push_back(cur_module);
574   return 0;
575 }
576 
577 static int dl_iterate_phdr_cb(dl_phdr_info *info, size_t size, void *arg) {
578   DlIteratePhdrData *data = (DlIteratePhdrData *)arg;
579   if (data->first) {
580     InternalMmapVector<char> module_name(kMaxPathLength);
581     data->first = false;
582     // First module is the binary itself.
583     ReadBinaryNameCached(module_name.data(), module_name.size());
584     return AddModuleSegments(module_name.data(), info, data->modules);
585   }
586 
587   if (info->dlpi_name) {
588     InternalScopedString module_name;
589     module_name.append("%s", info->dlpi_name);
590     return AddModuleSegments(module_name.data(), info, data->modules);
591   }
592 
593   return 0;
594 }
595 
596 #if SANITIZER_ANDROID && __ANDROID_API__ < 21
597 extern "C" __attribute__((weak)) int dl_iterate_phdr(
598     int (*)(struct dl_phdr_info *, size_t, void *), void *);
599 #endif
600 
601 static bool requiresProcmaps() {
602 #if SANITIZER_ANDROID && __ANDROID_API__ <= 22
603   // Fall back to /proc/maps if dl_iterate_phdr is unavailable or broken.
604   // The runtime check allows the same library to work with
605   // both K and L (and future) Android releases.
606   return AndroidGetApiLevel() <= ANDROID_LOLLIPOP_MR1;
607 #else
608   return false;
609 #endif
610 }
611 
612 static void procmapsInit(InternalMmapVectorNoCtor<LoadedModule> *modules) {
613   MemoryMappingLayout memory_mapping(/*cache_enabled*/true);
614   memory_mapping.DumpListOfModules(modules);
615 }
616 
617 void ListOfModules::init() {
618   clearOrInit();
619   if (requiresProcmaps()) {
620     procmapsInit(&modules_);
621   } else {
622     DlIteratePhdrData data = {&modules_, true};
623     dl_iterate_phdr(dl_iterate_phdr_cb, &data);
624   }
625 }
626 
627 // When a custom loader is used, dl_iterate_phdr may not contain the full
628 // list of modules. Allow callers to fall back to using procmaps.
629 void ListOfModules::fallbackInit() {
630   if (!requiresProcmaps()) {
631     clearOrInit();
632     procmapsInit(&modules_);
633   } else {
634     clear();
635   }
636 }
637 
638 // getrusage does not give us the current RSS, only the max RSS.
639 // Still, this is better than nothing if /proc/self/statm is not available
640 // for some reason, e.g. due to a sandbox.
641 static uptr GetRSSFromGetrusage() {
642   struct rusage usage;
643   if (getrusage(RUSAGE_SELF, &usage))  // Failed, probably due to a sandbox.
644     return 0;
645   return usage.ru_maxrss << 10;  // ru_maxrss is in Kb.
646 }
647 
648 uptr GetRSS() {
649   if (!common_flags()->can_use_proc_maps_statm)
650     return GetRSSFromGetrusage();
651   fd_t fd = OpenFile("/proc/self/statm", RdOnly);
652   if (fd == kInvalidFd)
653     return GetRSSFromGetrusage();
654   char buf[64];
655   uptr len = internal_read(fd, buf, sizeof(buf) - 1);
656   internal_close(fd);
657   if ((sptr)len <= 0)
658     return 0;
659   buf[len] = 0;
660   // The format of the file is:
661   // 1084 89 69 11 0 79 0
662   // We need the second number which is RSS in pages.
663   char *pos = buf;
664   // Skip the first number.
665   while (*pos >= '0' && *pos <= '9')
666     pos++;
667   // Skip whitespaces.
668   while (!(*pos >= '0' && *pos <= '9') && *pos != 0)
669     pos++;
670   // Read the number.
671   uptr rss = 0;
672   while (*pos >= '0' && *pos <= '9')
673     rss = rss * 10 + *pos++ - '0';
674   return rss * GetPageSizeCached();
675 }
676 
677 // sysconf(_SC_NPROCESSORS_{CONF,ONLN}) cannot be used on most platforms as
678 // they allocate memory.
679 u32 GetNumberOfCPUs() {
680 #if SANITIZER_FREEBSD || SANITIZER_NETBSD
681   u32 ncpu;
682   int req[2];
683   uptr len = sizeof(ncpu);
684   req[0] = CTL_HW;
685   req[1] = HW_NCPU;
686   CHECK_EQ(internal_sysctl(req, 2, &ncpu, &len, NULL, 0), 0);
687   return ncpu;
688 #elif SANITIZER_ANDROID && !defined(CPU_COUNT) && !defined(__aarch64__)
689   // Fall back to /sys/devices/system/cpu on Android when cpu_set_t doesn't
690   // exist in sched.h. That is the case for toolchains generated with older
691   // NDKs.
692   // This code doesn't work on AArch64 because internal_getdents makes use of
693   // the 64bit getdents syscall, but cpu_set_t seems to always exist on AArch64.
694   uptr fd = internal_open("/sys/devices/system/cpu", O_RDONLY | O_DIRECTORY);
695   if (internal_iserror(fd))
696     return 0;
697   InternalMmapVector<u8> buffer(4096);
698   uptr bytes_read = buffer.size();
699   uptr n_cpus = 0;
700   u8 *d_type;
701   struct linux_dirent *entry = (struct linux_dirent *)&buffer[bytes_read];
702   while (true) {
703     if ((u8 *)entry >= &buffer[bytes_read]) {
704       bytes_read = internal_getdents(fd, (struct linux_dirent *)buffer.data(),
705                                      buffer.size());
706       if (internal_iserror(bytes_read) || !bytes_read)
707         break;
708       entry = (struct linux_dirent *)buffer.data();
709     }
710     d_type = (u8 *)entry + entry->d_reclen - 1;
711     if (d_type >= &buffer[bytes_read] ||
712         (u8 *)&entry->d_name[3] >= &buffer[bytes_read])
713       break;
714     if (entry->d_ino != 0 && *d_type == DT_DIR) {
715       if (entry->d_name[0] == 'c' && entry->d_name[1] == 'p' &&
716           entry->d_name[2] == 'u' &&
717           entry->d_name[3] >= '0' && entry->d_name[3] <= '9')
718         n_cpus++;
719     }
720     entry = (struct linux_dirent *)(((u8 *)entry) + entry->d_reclen);
721   }
722   internal_close(fd);
723   return n_cpus;
724 #elif SANITIZER_SOLARIS
725   return sysconf(_SC_NPROCESSORS_ONLN);
726 #else
727   cpu_set_t CPUs;
728   CHECK_EQ(sched_getaffinity(0, sizeof(cpu_set_t), &CPUs), 0);
729   return CPU_COUNT(&CPUs);
730 #endif
731 }
732 
733 #if SANITIZER_LINUX
734 
735 #if SANITIZER_ANDROID
736 static atomic_uint8_t android_log_initialized;
737 
738 void AndroidLogInit() {
739   openlog(GetProcessName(), 0, LOG_USER);
740   atomic_store(&android_log_initialized, 1, memory_order_release);
741 }
742 
743 static bool ShouldLogAfterPrintf() {
744   return atomic_load(&android_log_initialized, memory_order_acquire);
745 }
746 
747 extern "C" SANITIZER_WEAK_ATTRIBUTE
748 int async_safe_write_log(int pri, const char* tag, const char* msg);
749 extern "C" SANITIZER_WEAK_ATTRIBUTE
750 int __android_log_write(int prio, const char* tag, const char* msg);
751 
752 // ANDROID_LOG_INFO is 4, but can't be resolved at runtime.
753 #define SANITIZER_ANDROID_LOG_INFO 4
754 
755 // async_safe_write_log is a new public version of __libc_write_log that is
756 // used behind syslog. It is preferable to syslog as it will not do any dynamic
757 // memory allocation or formatting.
758 // If the function is not available, syslog is preferred for L+ (it was broken
759 // pre-L) as __android_log_write triggers a racey behavior with the strncpy
760 // interceptor. Fallback to __android_log_write pre-L.
761 void WriteOneLineToSyslog(const char *s) {
762   if (&async_safe_write_log) {
763     async_safe_write_log(SANITIZER_ANDROID_LOG_INFO, GetProcessName(), s);
764   } else if (AndroidGetApiLevel() > ANDROID_KITKAT) {
765     syslog(LOG_INFO, "%s", s);
766   } else {
767     CHECK(&__android_log_write);
768     __android_log_write(SANITIZER_ANDROID_LOG_INFO, nullptr, s);
769   }
770 }
771 
772 extern "C" SANITIZER_WEAK_ATTRIBUTE
773 void android_set_abort_message(const char *);
774 
775 void SetAbortMessage(const char *str) {
776   if (&android_set_abort_message)
777     android_set_abort_message(str);
778 }
779 #else
780 void AndroidLogInit() {}
781 
782 static bool ShouldLogAfterPrintf() { return true; }
783 
784 void WriteOneLineToSyslog(const char *s) { syslog(LOG_INFO, "%s", s); }
785 
786 void SetAbortMessage(const char *str) {}
787 #endif  // SANITIZER_ANDROID
788 
789 void LogMessageOnPrintf(const char *str) {
790   if (common_flags()->log_to_syslog && ShouldLogAfterPrintf())
791     WriteToSyslog(str);
792 }
793 
794 #endif  // SANITIZER_LINUX
795 
796 #if SANITIZER_GLIBC && !SANITIZER_GO
797 // glibc crashes when using clock_gettime from a preinit_array function as the
798 // vDSO function pointers haven't been initialized yet. __progname is
799 // initialized after the vDSO function pointers, so if it exists, is not null
800 // and is not empty, we can use clock_gettime.
801 extern "C" SANITIZER_WEAK_ATTRIBUTE char *__progname;
802 inline bool CanUseVDSO() { return &__progname && __progname && *__progname; }
803 
804 // MonotonicNanoTime is a timing function that can leverage the vDSO by calling
805 // clock_gettime. real_clock_gettime only exists if clock_gettime is
806 // intercepted, so define it weakly and use it if available.
807 extern "C" SANITIZER_WEAK_ATTRIBUTE
808 int real_clock_gettime(u32 clk_id, void *tp);
809 u64 MonotonicNanoTime() {
810   timespec ts;
811   if (CanUseVDSO()) {
812     if (&real_clock_gettime)
813       real_clock_gettime(CLOCK_MONOTONIC, &ts);
814     else
815       clock_gettime(CLOCK_MONOTONIC, &ts);
816   } else {
817     internal_clock_gettime(CLOCK_MONOTONIC, &ts);
818   }
819   return (u64)ts.tv_sec * (1000ULL * 1000 * 1000) + ts.tv_nsec;
820 }
821 #else
822 // Non-glibc & Go always use the regular function.
823 u64 MonotonicNanoTime() {
824   timespec ts;
825   clock_gettime(CLOCK_MONOTONIC, &ts);
826   return (u64)ts.tv_sec * (1000ULL * 1000 * 1000) + ts.tv_nsec;
827 }
828 #endif  // SANITIZER_GLIBC && !SANITIZER_GO
829 
830 void ReExec() {
831   const char *pathname = "/proc/self/exe";
832 
833 #if SANITIZER_NETBSD
834   static const int name[] = {
835       CTL_KERN,
836       KERN_PROC_ARGS,
837       -1,
838       KERN_PROC_PATHNAME,
839   };
840   char path[400];
841   uptr len;
842 
843   len = sizeof(path);
844   if (internal_sysctl(name, ARRAY_SIZE(name), path, &len, NULL, 0) != -1)
845     pathname = path;
846 #elif SANITIZER_SOLARIS
847   pathname = getexecname();
848   CHECK_NE(pathname, NULL);
849 #elif SANITIZER_USE_GETAUXVAL
850   // Calling execve with /proc/self/exe sets that as $EXEC_ORIGIN. Binaries that
851   // rely on that will fail to load shared libraries. Query AT_EXECFN instead.
852   pathname = reinterpret_cast<const char *>(getauxval(AT_EXECFN));
853 #endif
854 
855   uptr rv = internal_execve(pathname, GetArgv(), GetEnviron());
856   int rverrno;
857   CHECK_EQ(internal_iserror(rv, &rverrno), true);
858   Printf("execve failed, errno %d\n", rverrno);
859   Die();
860 }
861 
862 void UnmapFromTo(uptr from, uptr to) {
863   if (to == from)
864     return;
865   CHECK(to >= from);
866   uptr res = internal_munmap(reinterpret_cast<void *>(from), to - from);
867   if (UNLIKELY(internal_iserror(res))) {
868     Report("ERROR: %s failed to unmap 0x%zx (%zd) bytes at address %p\n",
869            SanitizerToolName, to - from, to - from, (void *)from);
870     CHECK("unable to unmap" && 0);
871   }
872 }
873 
874 uptr MapDynamicShadow(uptr shadow_size_bytes, uptr shadow_scale,
875                       uptr min_shadow_base_alignment,
876                       UNUSED uptr &high_mem_end) {
877   const uptr granularity = GetMmapGranularity();
878   const uptr alignment =
879       Max<uptr>(granularity << shadow_scale, 1ULL << min_shadow_base_alignment);
880   const uptr left_padding =
881       Max<uptr>(granularity, 1ULL << min_shadow_base_alignment);
882 
883   const uptr shadow_size = RoundUpTo(shadow_size_bytes, granularity);
884   const uptr map_size = shadow_size + left_padding + alignment;
885 
886   const uptr map_start = (uptr)MmapNoAccess(map_size);
887   CHECK_NE(map_start, ~(uptr)0);
888 
889   const uptr shadow_start = RoundUpTo(map_start + left_padding, alignment);
890 
891   UnmapFromTo(map_start, shadow_start - left_padding);
892   UnmapFromTo(shadow_start + shadow_size, map_start + map_size);
893 
894   return shadow_start;
895 }
896 
897 static uptr MmapSharedNoReserve(uptr addr, uptr size) {
898   return internal_mmap(
899       reinterpret_cast<void *>(addr), size, PROT_READ | PROT_WRITE,
900       MAP_FIXED | MAP_SHARED | MAP_ANONYMOUS | MAP_NORESERVE, -1, 0);
901 }
902 
903 static uptr MremapCreateAlias(uptr base_addr, uptr alias_addr,
904                               uptr alias_size) {
905 #if SANITIZER_LINUX
906   return internal_mremap(reinterpret_cast<void *>(base_addr), 0, alias_size,
907                          MREMAP_MAYMOVE | MREMAP_FIXED,
908                          reinterpret_cast<void *>(alias_addr));
909 #else
910   CHECK(false && "mremap is not supported outside of Linux");
911   return 0;
912 #endif
913 }
914 
915 static void CreateAliases(uptr start_addr, uptr alias_size, uptr num_aliases) {
916   uptr total_size = alias_size * num_aliases;
917   uptr mapped = MmapSharedNoReserve(start_addr, total_size);
918   CHECK_EQ(mapped, start_addr);
919 
920   for (uptr i = 1; i < num_aliases; ++i) {
921     uptr alias_addr = start_addr + i * alias_size;
922     CHECK_EQ(MremapCreateAlias(start_addr, alias_addr, alias_size), alias_addr);
923   }
924 }
925 
926 uptr MapDynamicShadowAndAliases(uptr shadow_size, uptr alias_size,
927                                 uptr num_aliases, uptr ring_buffer_size) {
928   CHECK_EQ(alias_size & (alias_size - 1), 0);
929   CHECK_EQ(num_aliases & (num_aliases - 1), 0);
930   CHECK_EQ(ring_buffer_size & (ring_buffer_size - 1), 0);
931 
932   const uptr granularity = GetMmapGranularity();
933   shadow_size = RoundUpTo(shadow_size, granularity);
934   CHECK_EQ(shadow_size & (shadow_size - 1), 0);
935 
936   const uptr alias_region_size = alias_size * num_aliases;
937   const uptr alignment =
938       2 * Max(Max(shadow_size, alias_region_size), ring_buffer_size);
939   const uptr left_padding = ring_buffer_size;
940 
941   const uptr right_size = alignment;
942   const uptr map_size = left_padding + 2 * alignment;
943 
944   const uptr map_start = reinterpret_cast<uptr>(MmapNoAccess(map_size));
945   CHECK_NE(map_start, static_cast<uptr>(-1));
946   const uptr right_start = RoundUpTo(map_start + left_padding, alignment);
947 
948   UnmapFromTo(map_start, right_start - left_padding);
949   UnmapFromTo(right_start + right_size, map_start + map_size);
950 
951   CreateAliases(right_start + right_size / 2, alias_size, num_aliases);
952 
953   return right_start;
954 }
955 
956 void InitializePlatformCommonFlags(CommonFlags *cf) {
957 #if SANITIZER_ANDROID
958   if (&__libc_get_static_tls_bounds == nullptr)
959     cf->detect_leaks = false;
960 #endif
961 }
962 
963 } // namespace __sanitizer
964 
965 #endif
966