xref: /PHP-7.4/ext/pcre/pcre2lib/sljit/sljitUtils.c (revision 9f2d0395)
1 /*
2  *    Stack-less Just-In-Time compiler
3  *
4  *    Copyright Zoltan Herczeg (hzmester@freemail.hu). All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without modification, are
7  * permitted provided that the following conditions are met:
8  *
9  *   1. Redistributions of source code must retain the above copyright notice, this list of
10  *      conditions and the following disclaimer.
11  *
12  *   2. Redistributions in binary form must reproduce the above copyright notice, this list
13  *      of conditions and the following disclaimer in the documentation and/or other materials
14  *      provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND CONTRIBUTORS ``AS IS'' AND ANY
17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
19  * SHALL THE COPYRIGHT HOLDER(S) OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
21  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
22  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
24  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26 
27 /* ------------------------------------------------------------------------ */
28 /*  Locks                                                                   */
29 /* ------------------------------------------------------------------------ */
30 
31 #if (defined SLJIT_EXECUTABLE_ALLOCATOR && SLJIT_EXECUTABLE_ALLOCATOR) || (defined SLJIT_UTIL_GLOBAL_LOCK && SLJIT_UTIL_GLOBAL_LOCK)
32 
33 #if (defined SLJIT_SINGLE_THREADED && SLJIT_SINGLE_THREADED)
34 
35 #if (defined SLJIT_EXECUTABLE_ALLOCATOR && SLJIT_EXECUTABLE_ALLOCATOR)
36 
allocator_grab_lock(void)37 static SLJIT_INLINE void allocator_grab_lock(void)
38 {
39 	/* Always successful. */
40 }
41 
allocator_release_lock(void)42 static SLJIT_INLINE void allocator_release_lock(void)
43 {
44 	/* Always successful. */
45 }
46 
47 #endif /* SLJIT_EXECUTABLE_ALLOCATOR */
48 
49 #if (defined SLJIT_UTIL_GLOBAL_LOCK && SLJIT_UTIL_GLOBAL_LOCK)
50 
sljit_grab_lock(void)51 SLJIT_API_FUNC_ATTRIBUTE void SLJIT_FUNC sljit_grab_lock(void)
52 {
53 	/* Always successful. */
54 }
55 
sljit_release_lock(void)56 SLJIT_API_FUNC_ATTRIBUTE void SLJIT_FUNC sljit_release_lock(void)
57 {
58 	/* Always successful. */
59 }
60 
61 #endif /* SLJIT_UTIL_GLOBAL_LOCK */
62 
63 #elif defined(_WIN32) /* SLJIT_SINGLE_THREADED */
64 
65 #include "windows.h"
66 
67 #if (defined SLJIT_EXECUTABLE_ALLOCATOR && SLJIT_EXECUTABLE_ALLOCATOR)
68 
69 static HANDLE allocator_mutex = 0;
70 
allocator_grab_lock(void)71 static SLJIT_INLINE void allocator_grab_lock(void)
72 {
73 	/* No idea what to do if an error occures. Static mutexes should never fail... */
74 	if (!allocator_mutex)
75 		allocator_mutex = CreateMutex(NULL, TRUE, NULL);
76 	else
77 		WaitForSingleObject(allocator_mutex, INFINITE);
78 }
79 
allocator_release_lock(void)80 static SLJIT_INLINE void allocator_release_lock(void)
81 {
82 	ReleaseMutex(allocator_mutex);
83 }
84 
85 #endif /* SLJIT_EXECUTABLE_ALLOCATOR */
86 
87 #if (defined SLJIT_UTIL_GLOBAL_LOCK && SLJIT_UTIL_GLOBAL_LOCK)
88 
89 static HANDLE global_mutex = 0;
90 
sljit_grab_lock(void)91 SLJIT_API_FUNC_ATTRIBUTE void SLJIT_FUNC sljit_grab_lock(void)
92 {
93 	/* No idea what to do if an error occures. Static mutexes should never fail... */
94 	if (!global_mutex)
95 		global_mutex = CreateMutex(NULL, TRUE, NULL);
96 	else
97 		WaitForSingleObject(global_mutex, INFINITE);
98 }
99 
sljit_release_lock(void)100 SLJIT_API_FUNC_ATTRIBUTE void SLJIT_FUNC sljit_release_lock(void)
101 {
102 	ReleaseMutex(global_mutex);
103 }
104 
105 #endif /* SLJIT_UTIL_GLOBAL_LOCK */
106 
107 #else /* _WIN32 */
108 
109 #if (defined SLJIT_EXECUTABLE_ALLOCATOR && SLJIT_EXECUTABLE_ALLOCATOR)
110 
111 #include <pthread.h>
112 
113 static pthread_mutex_t allocator_mutex = PTHREAD_MUTEX_INITIALIZER;
114 
allocator_grab_lock(void)115 static SLJIT_INLINE void allocator_grab_lock(void)
116 {
117 	pthread_mutex_lock(&allocator_mutex);
118 }
119 
allocator_release_lock(void)120 static SLJIT_INLINE void allocator_release_lock(void)
121 {
122 	pthread_mutex_unlock(&allocator_mutex);
123 }
124 
125 #endif /* SLJIT_EXECUTABLE_ALLOCATOR */
126 
127 #if (defined SLJIT_UTIL_GLOBAL_LOCK && SLJIT_UTIL_GLOBAL_LOCK)
128 
129 #include <pthread.h>
130 
131 static pthread_mutex_t global_mutex = PTHREAD_MUTEX_INITIALIZER;
132 
sljit_grab_lock(void)133 SLJIT_API_FUNC_ATTRIBUTE void SLJIT_FUNC sljit_grab_lock(void)
134 {
135 	pthread_mutex_lock(&global_mutex);
136 }
137 
sljit_release_lock(void)138 SLJIT_API_FUNC_ATTRIBUTE void SLJIT_FUNC sljit_release_lock(void)
139 {
140 	pthread_mutex_unlock(&global_mutex);
141 }
142 
143 #endif /* SLJIT_UTIL_GLOBAL_LOCK */
144 
145 #endif /* _WIN32 */
146 
147 /* ------------------------------------------------------------------------ */
148 /*  Stack                                                                   */
149 /* ------------------------------------------------------------------------ */
150 
151 #if (defined SLJIT_UTIL_STACK && SLJIT_UTIL_STACK) || (defined SLJIT_EXECUTABLE_ALLOCATOR && SLJIT_EXECUTABLE_ALLOCATOR)
152 
153 #ifdef _WIN32
154 #include "windows.h"
155 #else /* !_WIN32 */
156 /* Provides mmap function. */
157 #include <sys/types.h>
158 #include <sys/mman.h>
159 
160 #ifndef MAP_ANON
161 #ifdef MAP_ANONYMOUS
162 #define MAP_ANON MAP_ANONYMOUS
163 #endif /* MAP_ANONYMOUS */
164 #endif /* !MAP_ANON */
165 
166 #ifndef MADV_DONTNEED
167 #ifdef POSIX_MADV_DONTNEED
168 #define MADV_DONTNEED POSIX_MADV_DONTNEED
169 #endif /* POSIX_MADV_DONTNEED */
170 #endif /* !MADV_DONTNEED */
171 
172 /* For detecting the page size. */
173 #include <unistd.h>
174 
175 #ifndef MAP_ANON
176 
177 #include <fcntl.h>
178 
179 /* Some old systems does not have MAP_ANON. */
180 static sljit_s32 dev_zero = -1;
181 
182 #if (defined SLJIT_SINGLE_THREADED && SLJIT_SINGLE_THREADED)
183 
open_dev_zero(void)184 static SLJIT_INLINE sljit_s32 open_dev_zero(void)
185 {
186 	dev_zero = open("/dev/zero", O_RDWR);
187 	return dev_zero < 0;
188 }
189 
190 #else /* SLJIT_SINGLE_THREADED */
191 
192 #include <pthread.h>
193 
194 static pthread_mutex_t dev_zero_mutex = PTHREAD_MUTEX_INITIALIZER;
195 
open_dev_zero(void)196 static SLJIT_INLINE sljit_s32 open_dev_zero(void)
197 {
198 	pthread_mutex_lock(&dev_zero_mutex);
199 	/* The dev_zero might be initialized by another thread during the waiting. */
200 	if (dev_zero < 0) {
201 		dev_zero = open("/dev/zero", O_RDWR);
202 	}
203 	pthread_mutex_unlock(&dev_zero_mutex);
204 	return dev_zero < 0;
205 }
206 
207 #endif /* SLJIT_SINGLE_THREADED */
208 
209 #endif /* !MAP_ANON */
210 
211 #endif /* _WIN32 */
212 
213 #endif /* SLJIT_UTIL_STACK || SLJIT_EXECUTABLE_ALLOCATOR */
214 
215 #endif /* SLJIT_EXECUTABLE_ALLOCATOR || SLJIT_UTIL_GLOBAL_LOCK */
216 
217 #if (defined SLJIT_UTIL_STACK && SLJIT_UTIL_STACK)
218 
219 #if (defined SLJIT_UTIL_SIMPLE_STACK_ALLOCATION && SLJIT_UTIL_SIMPLE_STACK_ALLOCATION)
220 
sljit_allocate_stack(sljit_uw start_size,sljit_uw max_size,void * allocator_data)221 SLJIT_API_FUNC_ATTRIBUTE struct sljit_stack* SLJIT_FUNC sljit_allocate_stack(sljit_uw start_size, sljit_uw max_size, void *allocator_data)
222 {
223 	struct sljit_stack *stack;
224 	void *ptr;
225 
226 	SLJIT_UNUSED_ARG(allocator_data);
227 
228 	if (start_size > max_size || start_size < 1)
229 		return NULL;
230 
231 	stack = (struct sljit_stack*)SLJIT_MALLOC(sizeof(struct sljit_stack), allocator_data);
232 	if (stack == NULL)
233 		return NULL;
234 
235 	ptr = SLJIT_MALLOC(max_size, allocator_data);
236 	if (ptr == NULL) {
237 		SLJIT_FREE(stack, allocator_data);
238 		return NULL;
239 	}
240 
241 	stack->min_start = (sljit_u8 *)ptr;
242  	stack->end = stack->min_start + max_size;
243  	stack->start = stack->end - start_size;
244 	stack->top = stack->end;
245 	return stack;
246 }
247 
sljit_free_stack(struct sljit_stack * stack,void * allocator_data)248 SLJIT_API_FUNC_ATTRIBUTE void SLJIT_FUNC sljit_free_stack(struct sljit_stack *stack, void *allocator_data)
249 {
250 	SLJIT_UNUSED_ARG(allocator_data);
251 	SLJIT_FREE((void*)stack->min_start, allocator_data);
252 	SLJIT_FREE(stack, allocator_data);
253 }
254 
sljit_stack_resize(struct sljit_stack * stack,sljit_u8 * new_start)255 SLJIT_API_FUNC_ATTRIBUTE sljit_u8 *SLJIT_FUNC sljit_stack_resize(struct sljit_stack *stack, sljit_u8 *new_start)
256 {
257 	if ((new_start < stack->min_start) || (new_start >= stack->end))
258 		return NULL;
259 	stack->start = new_start;
260 	return new_start;
261 }
262 
263 #else /* !SLJIT_UTIL_SIMPLE_STACK_ALLOCATION */
264 
265 #ifdef _WIN32
266 
get_page_alignment(void)267 SLJIT_INLINE static sljit_sw get_page_alignment(void) {
268 	SYSTEM_INFO si;
269 	static sljit_sw sljit_page_align;
270 	if (!sljit_page_align) {
271 		GetSystemInfo(&si);
272 		sljit_page_align = si.dwPageSize - 1;
273 	}
274 	return sljit_page_align;
275 }
276 
sljit_free_stack(struct sljit_stack * stack,void * allocator_data)277 SLJIT_API_FUNC_ATTRIBUTE void SLJIT_FUNC sljit_free_stack(struct sljit_stack *stack, void *allocator_data)
278 {
279 	SLJIT_UNUSED_ARG(allocator_data);
280 	VirtualFree((void*)stack->min_start, 0, MEM_RELEASE);
281 	SLJIT_FREE(stack, allocator_data);
282 }
283 
284 #else /* ! defined _WIN32 */
285 
get_page_alignment(void)286 SLJIT_INLINE static sljit_sw get_page_alignment(void) {
287 	static sljit_sw sljit_page_align;
288 	if (!sljit_page_align) {
289 		sljit_page_align = sysconf(_SC_PAGESIZE);
290 		/* Should never happen. */
291 		if (sljit_page_align < 0)
292 			sljit_page_align = 4096;
293 		sljit_page_align--;
294 	}
295 	return sljit_page_align;
296 }
297 
sljit_free_stack(struct sljit_stack * stack,void * allocator_data)298 SLJIT_API_FUNC_ATTRIBUTE void SLJIT_FUNC sljit_free_stack(struct sljit_stack *stack, void *allocator_data)
299 {
300 	SLJIT_UNUSED_ARG(allocator_data);
301 	munmap((void*)stack->min_start, stack->end - stack->min_start);
302 	SLJIT_FREE(stack, allocator_data);
303 }
304 
305 #endif /* defined _WIN32 */
306 
sljit_allocate_stack(sljit_uw start_size,sljit_uw max_size,void * allocator_data)307 SLJIT_API_FUNC_ATTRIBUTE struct sljit_stack* SLJIT_FUNC sljit_allocate_stack(sljit_uw start_size, sljit_uw max_size, void *allocator_data)
308 {
309 	struct sljit_stack *stack;
310 	void *ptr;
311 	sljit_sw page_align;
312 
313 	SLJIT_UNUSED_ARG(allocator_data);
314 
315 	if (start_size > max_size || start_size < 1)
316 		return NULL;
317 
318 	stack = (struct sljit_stack*)SLJIT_MALLOC(sizeof(struct sljit_stack), allocator_data);
319 	if (stack == NULL)
320 		return NULL;
321 
322 	/* Align max_size. */
323 	page_align = get_page_alignment();
324 	max_size = (max_size + page_align) & ~page_align;
325 
326 #ifdef _WIN32
327 	ptr = VirtualAlloc(NULL, max_size, MEM_RESERVE, PAGE_READWRITE);
328 	if (!ptr) {
329 		SLJIT_FREE(stack, allocator_data);
330 		return NULL;
331 	}
332 
333 	stack->min_start = (sljit_u8 *)ptr;
334 	stack->end = stack->min_start + max_size;
335 	stack->start = stack->end;
336 
337 	if (sljit_stack_resize(stack, stack->end - start_size) == NULL) {
338 		sljit_free_stack(stack, allocator_data);
339 		return NULL;
340 	}
341 #else /* !_WIN32 */
342 #ifdef MAP_ANON
343 	ptr = mmap(NULL, max_size, PROT_READ | PROT_WRITE, MAP_PRIVATE | MAP_ANON, -1, 0);
344 #else /* !MAP_ANON */
345 	if (dev_zero < 0) {
346 		if (open_dev_zero() != 0) {
347 			SLJIT_FREE(stack, allocator_data);
348 			return NULL;
349 		}
350 	}
351 	ptr = mmap(NULL, max_size, PROT_READ | PROT_WRITE, MAP_PRIVATE, dev_zero, 0);
352 #endif /* MAP_ANON */
353 	if (ptr == MAP_FAILED) {
354 		SLJIT_FREE(stack, allocator_data);
355 		return NULL;
356 	}
357 	stack->min_start = (sljit_u8 *)ptr;
358 	stack->end = stack->min_start + max_size;
359 	stack->start = stack->end - start_size;
360 #endif /* _WIN32 */
361 
362 	stack->top = stack->end;
363 	return stack;
364 }
365 
sljit_stack_resize(struct sljit_stack * stack,sljit_u8 * new_start)366 SLJIT_API_FUNC_ATTRIBUTE sljit_u8 *SLJIT_FUNC sljit_stack_resize(struct sljit_stack *stack, sljit_u8 *new_start)
367 {
368 #if defined _WIN32 || defined(MADV_DONTNEED)
369 	sljit_uw aligned_old_start;
370 	sljit_uw aligned_new_start;
371 	sljit_sw page_align;
372 #endif
373 
374 	if ((new_start < stack->min_start) || (new_start >= stack->end))
375 		return NULL;
376 
377 #ifdef _WIN32
378 	page_align = get_page_alignment();
379 
380 	aligned_new_start = (sljit_uw)new_start & ~page_align;
381 	aligned_old_start = ((sljit_uw)stack->start) & ~page_align;
382 	if (aligned_new_start != aligned_old_start) {
383 		if (aligned_new_start < aligned_old_start) {
384 			if (!VirtualAlloc((void*)aligned_new_start, aligned_old_start - aligned_new_start, MEM_COMMIT, PAGE_READWRITE))
385 				return NULL;
386 		}
387 		else {
388 			if (!VirtualFree((void*)aligned_old_start, aligned_new_start - aligned_old_start, MEM_DECOMMIT))
389 				return NULL;
390 		}
391 	}
392 #elif defined(MADV_DONTNEED)
393 	if (stack->start < new_start) {
394 		page_align = get_page_alignment();
395 
396 		aligned_new_start = (sljit_uw)new_start & ~page_align;
397 		aligned_old_start = ((sljit_uw)stack->start) & ~page_align;
398 		/* If madvise is available, we release the unnecessary space. */
399 		if (aligned_new_start > aligned_old_start)
400 			madvise((void*)aligned_old_start, aligned_new_start - aligned_old_start, MADV_DONTNEED);
401 	}
402 #endif /* _WIN32 */
403 
404 	stack->start = new_start;
405 	return new_start;
406 }
407 
408 #endif /* SLJIT_UTIL_SIMPLE_STACK_ALLOCATION */
409 
410 #endif /* SLJIT_UTIL_STACK */
411