1 //===-- linux.cpp -----------------------------------------------*- C++ -*-===//
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 #include "platform.h"
10 
11 #if SCUDO_LINUX
12 
13 #include "common.h"
14 #include "linux.h"
15 #include "mutex.h"
16 #include "string_utils.h"
17 
18 #include <errno.h>
19 #include <fcntl.h>
20 #include <linux/futex.h>
21 #include <sched.h>
22 #include <stdlib.h>
23 #include <string.h>
24 #include <sys/mman.h>
25 #include <sys/stat.h>
26 #include <sys/syscall.h>
27 #include <sys/time.h>
28 #include <time.h>
29 #include <unistd.h>
30 
31 #if SCUDO_ANDROID
32 #include <sys/prctl.h>
33 // Definitions of prctl arguments to set a vma name in Android kernels.
34 #define ANDROID_PR_SET_VMA 0x53564d41
35 #define ANDROID_PR_SET_VMA_ANON_NAME 0
36 #endif
37 
38 namespace scudo {
39 
40 uptr getPageSize() { return static_cast<uptr>(sysconf(_SC_PAGESIZE)); }
41 
42 void NORETURN die() { abort(); }
43 
44 void *map(void *Addr, uptr Size, UNUSED const char *Name, uptr Flags,
45           UNUSED MapPlatformData *Data) {
46   int MmapFlags = MAP_PRIVATE | MAP_ANONYMOUS;
47   int MmapProt;
48   if (Flags & MAP_NOACCESS) {
49     MmapFlags |= MAP_NORESERVE;
50     MmapProt = PROT_NONE;
51   } else {
52     MmapProt = PROT_READ | PROT_WRITE;
53   }
54 #if defined(__aarch64__)
55 #ifndef PROT_MTE
56 #define PROT_MTE 0x20
57 #endif
58   if (Flags & MAP_MEMTAG)
59     MmapProt |= PROT_MTE;
60 #endif
61   if (Addr) {
62     // Currently no scenario for a noaccess mapping with a fixed address.
63     DCHECK_EQ(Flags & MAP_NOACCESS, 0);
64     MmapFlags |= MAP_FIXED;
65   }
66   void *P = mmap(Addr, Size, MmapProt, MmapFlags, -1, 0);
67   if (P == MAP_FAILED) {
68     if (!(Flags & MAP_ALLOWNOMEM) || errno != ENOMEM)
69       dieOnMapUnmapError(errno == ENOMEM);
70     return nullptr;
71   }
72 #if SCUDO_ANDROID
73   if (Name)
74     prctl(ANDROID_PR_SET_VMA, ANDROID_PR_SET_VMA_ANON_NAME, P, Size, Name);
75 #endif
76   return P;
77 }
78 
79 void unmap(void *Addr, uptr Size, UNUSED uptr Flags,
80            UNUSED MapPlatformData *Data) {
81   if (munmap(Addr, Size) != 0)
82     dieOnMapUnmapError();
83 }
84 
85 void setMemoryPermission(uptr Addr, uptr Size, uptr Flags,
86                          UNUSED MapPlatformData *Data) {
87   int Prot = (Flags & MAP_NOACCESS) ? PROT_NONE : (PROT_READ | PROT_WRITE);
88   if (mprotect(reinterpret_cast<void *>(Addr), Size, Prot) != 0)
89     dieOnMapUnmapError();
90 }
91 
92 void releasePagesToOS(uptr BaseAddress, uptr Offset, uptr Size,
93                       UNUSED MapPlatformData *Data) {
94   void *Addr = reinterpret_cast<void *>(BaseAddress + Offset);
95   while (madvise(Addr, Size, MADV_DONTNEED) == -1 && errno == EAGAIN) {
96   }
97 }
98 
99 // Calling getenv should be fine (c)(tm) at any time.
100 const char *getEnv(const char *Name) { return getenv(Name); }
101 
102 namespace {
103 enum State : u32 { Unlocked = 0, Locked = 1, Sleeping = 2 };
104 }
105 
106 bool HybridMutex::tryLock() {
107   return atomic_compare_exchange(&M, Unlocked, Locked) == Unlocked;
108 }
109 
110 // The following is based on https://akkadia.org/drepper/futex.pdf.
111 void HybridMutex::lockSlow() {
112   u32 V = atomic_compare_exchange(&M, Unlocked, Locked);
113   if (V == Unlocked)
114     return;
115   if (V != Sleeping)
116     V = atomic_exchange(&M, Sleeping, memory_order_acquire);
117   while (V != Unlocked) {
118     syscall(SYS_futex, reinterpret_cast<uptr>(&M), FUTEX_WAIT_PRIVATE, Sleeping,
119             nullptr, nullptr, 0);
120     V = atomic_exchange(&M, Sleeping, memory_order_acquire);
121   }
122 }
123 
124 void HybridMutex::unlock() {
125   if (atomic_fetch_sub(&M, 1U, memory_order_release) != Locked) {
126     atomic_store(&M, Unlocked, memory_order_release);
127     syscall(SYS_futex, reinterpret_cast<uptr>(&M), FUTEX_WAKE_PRIVATE, 1,
128             nullptr, nullptr, 0);
129   }
130 }
131 
132 u64 getMonotonicTime() {
133   timespec TS;
134   clock_gettime(CLOCK_MONOTONIC, &TS);
135   return static_cast<u64>(TS.tv_sec) * (1000ULL * 1000 * 1000) +
136          static_cast<u64>(TS.tv_nsec);
137 }
138 
139 u32 getNumberOfCPUs() {
140   cpu_set_t CPUs;
141   // sched_getaffinity can fail for a variety of legitimate reasons (lack of
142   // CAP_SYS_NICE, syscall filtering, etc), in which case we shall return 0.
143   if (sched_getaffinity(0, sizeof(cpu_set_t), &CPUs) != 0)
144     return 0;
145   return static_cast<u32>(CPU_COUNT(&CPUs));
146 }
147 
148 u32 getThreadID() {
149 #if SCUDO_ANDROID
150   return static_cast<u32>(gettid());
151 #else
152   return static_cast<u32>(syscall(SYS_gettid));
153 #endif
154 }
155 
156 // Blocking is possibly unused if the getrandom block is not compiled in.
157 bool getRandom(void *Buffer, uptr Length, UNUSED bool Blocking) {
158   if (!Buffer || !Length || Length > MaxRandomLength)
159     return false;
160   ssize_t ReadBytes;
161 #if defined(SYS_getrandom)
162 #if !defined(GRND_NONBLOCK)
163 #define GRND_NONBLOCK 1
164 #endif
165   // Up to 256 bytes, getrandom will not be interrupted.
166   ReadBytes =
167       syscall(SYS_getrandom, Buffer, Length, Blocking ? 0 : GRND_NONBLOCK);
168   if (ReadBytes == static_cast<ssize_t>(Length))
169     return true;
170 #endif // defined(SYS_getrandom)
171   // Up to 256 bytes, a read off /dev/urandom will not be interrupted.
172   // Blocking is moot here, O_NONBLOCK has no effect when opening /dev/urandom.
173   const int FileDesc = open("/dev/urandom", O_RDONLY);
174   if (FileDesc == -1)
175     return false;
176   ReadBytes = read(FileDesc, Buffer, Length);
177   close(FileDesc);
178   return (ReadBytes == static_cast<ssize_t>(Length));
179 }
180 
181 // Allocation free syslog-like API.
182 extern "C" WEAK int async_safe_write_log(int pri, const char *tag,
183                                          const char *msg);
184 
185 void outputRaw(const char *Buffer) {
186   if (&async_safe_write_log) {
187     constexpr s32 AndroidLogInfo = 4;
188     constexpr uptr MaxLength = 1024U;
189     char LocalBuffer[MaxLength];
190     while (strlen(Buffer) > MaxLength) {
191       uptr P;
192       for (P = MaxLength - 1; P > 0; P--) {
193         if (Buffer[P] == '\n') {
194           memcpy(LocalBuffer, Buffer, P);
195           LocalBuffer[P] = '\0';
196           async_safe_write_log(AndroidLogInfo, "scudo", LocalBuffer);
197           Buffer = &Buffer[P + 1];
198           break;
199         }
200       }
201       // If no newline was found, just log the buffer.
202       if (P == 0)
203         break;
204     }
205     async_safe_write_log(AndroidLogInfo, "scudo", Buffer);
206   } else {
207     (void)write(2, Buffer, strlen(Buffer));
208   }
209 }
210 
211 extern "C" WEAK void android_set_abort_message(const char *);
212 
213 void setAbortMessage(const char *Message) {
214   if (&android_set_abort_message)
215     android_set_abort_message(Message);
216 }
217 
218 } // namespace scudo
219 
220 #endif // SCUDO_LINUX
221