annotate libphobos/libdruntime/gc/os.d @ 158:494b0b89df80 default tip

...
author Shinji KONO <kono@ie.u-ryukyu.ac.jp>
date Mon, 25 May 2020 18:13:55 +0900
parents 1830386684a0
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
145
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
1 /**
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
2 * Contains OS-level routines needed by the garbage collector.
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
3 *
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
4 * Copyright: Copyright Digital Mars 2005 - 2013.
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
5 * License: $(WEB www.boost.org/LICENSE_1_0.txt, Boost License 1.0).
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
6 * Authors: Walter Bright, David Friedman, Sean Kelly, Leandro Lucarella
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
7 */
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
8
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
9 /* Copyright Digital Mars 2005 - 2013.
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
10 * Distributed under the Boost Software License, Version 1.0.
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
11 * (See accompanying file LICENSE or copy at
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
12 * http://www.boost.org/LICENSE_1_0.txt)
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
13 */
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
14 module gc.os;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
15
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
16
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
17 version (Windows)
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
18 {
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
19 import core.sys.windows.winbase : GetCurrentThreadId, VirtualAlloc, VirtualFree;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
20 import core.sys.windows.winnt : MEM_COMMIT, MEM_RELEASE, MEM_RESERVE, PAGE_READWRITE;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
21
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
22 alias int pthread_t;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
23
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
24 pthread_t pthread_self() nothrow
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
25 {
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
26 return cast(pthread_t) GetCurrentThreadId();
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
27 }
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
28
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
29 //version = GC_Use_Alloc_Win32;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
30 }
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
31 else version (Posix)
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
32 {
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
33 version (OSX)
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
34 version = Darwin;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
35 else version (iOS)
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
36 version = Darwin;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
37 else version (TVOS)
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
38 version = Darwin;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
39 else version (WatchOS)
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
40 version = Darwin;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
41
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
42 import core.sys.posix.sys.mman;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
43 version (FreeBSD) import core.sys.freebsd.sys.mman : MAP_ANON;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
44 version (DragonFlyBSD) import core.sys.dragonflybsd.sys.mman : MAP_ANON;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
45 version (NetBSD) import core.sys.netbsd.sys.mman : MAP_ANON;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
46 version (OpenBSD) import core.sys.openbsd.sys.mman : MAP_ANON;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
47 version (CRuntime_Glibc) import core.sys.linux.sys.mman : MAP_ANON;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
48 version (Darwin) import core.sys.darwin.sys.mman : MAP_ANON;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
49 version (CRuntime_UClibc) import core.sys.linux.sys.mman : MAP_ANON;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
50 import core.stdc.stdlib;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
51
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
52 //version = GC_Use_Alloc_MMap;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
53 }
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
54 else
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
55 {
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
56 import core.stdc.stdlib;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
57
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
58 //version = GC_Use_Alloc_Malloc;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
59 }
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
60
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
61 /+
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
62 static if (is(typeof(VirtualAlloc)))
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
63 version = GC_Use_Alloc_Win32;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
64 else static if (is(typeof(mmap)))
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
65 version = GC_Use_Alloc_MMap;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
66 else static if (is(typeof(valloc)))
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
67 version = GC_Use_Alloc_Valloc;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
68 else static if (is(typeof(malloc)))
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
69 version = GC_Use_Alloc_Malloc;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
70 else static assert(false, "No supported allocation methods available.");
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
71 +/
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
72
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
73 static if (is(typeof(VirtualAlloc))) // version (GC_Use_Alloc_Win32)
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
74 {
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
75 /**
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
76 * Map memory.
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
77 */
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
78 void *os_mem_map(size_t nbytes) nothrow
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
79 {
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
80 return VirtualAlloc(null, nbytes, MEM_RESERVE | MEM_COMMIT,
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
81 PAGE_READWRITE);
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
82 }
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
83
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
84
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
85 /**
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
86 * Unmap memory allocated with os_mem_map().
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
87 * Returns:
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
88 * 0 success
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
89 * !=0 failure
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
90 */
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
91 int os_mem_unmap(void *base, size_t nbytes) nothrow
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
92 {
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
93 return cast(int)(VirtualFree(base, 0, MEM_RELEASE) == 0);
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
94 }
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
95 }
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
96 else static if (is(typeof(mmap))) // else version (GC_Use_Alloc_MMap)
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
97 {
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
98 void *os_mem_map(size_t nbytes) nothrow
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
99 { void *p;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
100
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
101 p = mmap(null, nbytes, PROT_READ | PROT_WRITE, MAP_PRIVATE | MAP_ANON, -1, 0);
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
102 return (p == MAP_FAILED) ? null : p;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
103 }
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
104
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
105
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
106 int os_mem_unmap(void *base, size_t nbytes) nothrow
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
107 {
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
108 return munmap(base, nbytes);
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
109 }
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
110 }
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
111 else static if (is(typeof(valloc))) // else version (GC_Use_Alloc_Valloc)
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
112 {
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
113 void *os_mem_map(size_t nbytes) nothrow
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
114 {
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
115 return valloc(nbytes);
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
116 }
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
117
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
118
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
119 int os_mem_unmap(void *base, size_t nbytes) nothrow
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
120 {
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
121 free(base);
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
122 return 0;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
123 }
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
124 }
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
125 else static if (is(typeof(malloc))) // else version (GC_Use_Alloc_Malloc)
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
126 {
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
127 // NOTE: This assumes malloc granularity is at least (void*).sizeof. If
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
128 // (req_size + PAGESIZE) is allocated, and the pointer is rounded up
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
129 // to PAGESIZE alignment, there will be space for a void* at the end
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
130 // after PAGESIZE bytes used by the GC.
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
131
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
132
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
133 import gc.gc;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
134
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
135
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
136 const size_t PAGE_MASK = PAGESIZE - 1;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
137
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
138
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
139 void *os_mem_map(size_t nbytes) nothrow
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
140 { byte *p, q;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
141 p = cast(byte *) malloc(nbytes + PAGESIZE);
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
142 q = p + ((PAGESIZE - ((cast(size_t) p & PAGE_MASK))) & PAGE_MASK);
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
143 * cast(void**)(q + nbytes) = p;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
144 return q;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
145 }
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
146
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
147
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
148 int os_mem_unmap(void *base, size_t nbytes) nothrow
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
149 {
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
150 free( *cast(void**)( cast(byte*) base + nbytes ) );
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
151 return 0;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
152 }
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
153 }
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
154 else
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
155 {
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
156 static assert(false, "No supported allocation methods available.");
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
157 }
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
158
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
159 /**
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
160 Check for any kind of memory pressure.
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
161
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
162 Params:
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
163 mapped = the amount of memory mapped by the GC in bytes
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
164 Returns:
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
165 true if memory is scarce
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
166 */
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
167 // TOOD: get virtual mem sizes and current usage from OS
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
168 // TODO: compare current RSS and avail. physical memory
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
169 version (Windows)
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
170 {
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
171 bool isLowOnMem(size_t mapped) nothrow @nogc
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
172 {
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
173 version (D_LP64)
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
174 return false;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
175 else
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
176 {
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
177 import core.sys.windows.winbase : GlobalMemoryStatus, MEMORYSTATUS;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
178 MEMORYSTATUS stat;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
179 GlobalMemoryStatus(&stat);
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
180 // Less than 5 % of virtual address space available
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
181 return stat.dwAvailVirtual < stat.dwTotalVirtual / 20;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
182 }
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
183 }
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
184 }
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
185 else version (Darwin)
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
186 {
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
187 bool isLowOnMem(size_t mapped) nothrow @nogc
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
188 {
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
189 enum GB = 2 ^^ 30;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
190 version (D_LP64)
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
191 return false;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
192 else
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
193 {
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
194 // 80 % of available 4GB is used for GC (excluding malloc and mmap)
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
195 enum size_t limit = 4UL * GB * 8 / 10;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
196 return mapped > limit;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
197 }
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
198 }
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
199 }
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
200 else
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
201 {
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
202 bool isLowOnMem(size_t mapped) nothrow @nogc
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
203 {
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
204 enum GB = 2 ^^ 30;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
205 version (D_LP64)
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
206 return false;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
207 else
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
208 {
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
209 // be conservative and assume 3GB
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
210 enum size_t limit = 3UL * GB * 8 / 10;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
211 return mapped > limit;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
212 }
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
213 }
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
214 }