4 * Copyright (C) 2013 JP Ikaheimonen <jp_ikaheimonen@mentor.com>
5 * 2016 Michael Jeanson <mjeanson@efficios.com>
7 * These sources are based on ftp://g.oswego.edu/pub/misc/malloc.c
8 * file by Doug Lea, released to the public domain.
10 * Permission is hereby granted, free of charge, to any person obtaining a copy
11 * of this software and associated documentation files (the "Software"), to deal
12 * in the Software without restriction, including without limitation the rights
13 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 * copies of the Software, and to permit persons to whom the Software is
15 * furnished to do so, subject to the following conditions:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29 #define BT_LOG_OUTPUT_LEVEL (mapping->log_level)
30 #define BT_LOG_TAG "COMPAT/MMAN"
31 #include "logging/log.h"
33 #include "common/macros.h"
34 #include "common/common.h"
38 * On macOS, we need a dummy symbol so that the linker won't
39 * complain of an empty table of contents.
42 int bt_mman_dummy_symbol
;
43 #endif /* __APPLE__ */
54 #include "compat/mman.h"
59 /* The duplicated handle. */
61 /* Handle returned by CreateFileMapping. */
66 GHashTable
*mmap_mappings
= NULL
;
69 * This mutex protects the hashtable of memory mappings.
71 static pthread_mutex_t mmap_mutex
= PTHREAD_MUTEX_INITIALIZER
;
74 struct mmap_mapping
*mapping_create(int log_level
)
76 struct mmap_mapping
*mapping
;
78 mapping
= malloc(sizeof(struct mmap_mapping
));
80 mapping
->file_handle
= NULL
;
81 mapping
->map_handle
= NULL
;
82 mapping
->log_level
= log_level
;
89 void mapping_clean(struct mmap_mapping
*mapping
)
92 if (!CloseHandle(mapping
->map_handle
)) {
93 BT_LOGF_STR("Failed to close mmap map_handle.");
96 if (!CloseHandle(mapping
->file_handle
)) {
97 BT_LOGF_STR("Failed to close mmap file_handle.");
106 void addr_clean(void *addr
)
108 /* Cleanup of handles should never fail. */
109 if (!UnmapViewOfFile(addr
)) {
111 * FIXME: We don't have access to the mapping's log
112 * level here, so force a FATAL level.
114 BT_LOG_WRITE_CUR_LVL(BT_LOG_FATAL
, BT_LOG_FATAL
, BT_LOG_TAG
,
115 "Failed to unmap mmap mapping.");
121 void mmap_lock(int log_level
)
123 if (pthread_mutex_lock(&mmap_mutex
)) {
124 BT_LOG_WRITE_CUR_LVL(BT_LOG_FATAL
, log_level
, BT_LOG_TAG
, "Failed to acquire mmap_mutex.");
130 void mmap_unlock(int log_level
)
132 if (pthread_mutex_unlock(&mmap_mutex
)) {
133 BT_LOG_WRITE_CUR_LVL(BT_LOG_FATAL
, log_level
, BT_LOG_TAG
, "Failed to release mmap_mutex.");
139 * Convert mmap memory protection flags to CreateFileMapping page protection
140 * flag and MapViewOfFile desired access flag.
143 DWORD
map_prot_flags(int prot
, DWORD
*dwDesiredAccess
)
145 if (prot
& PROT_READ
) {
146 if (prot
& PROT_WRITE
) {
147 *dwDesiredAccess
= FILE_MAP_WRITE
;
148 if (prot
& PROT_EXEC
) {
149 return PAGE_EXECUTE_READWRITE
;
151 return PAGE_READWRITE
;
153 if (prot
& PROT_EXEC
) {
154 *dwDesiredAccess
= FILE_MAP_EXECUTE
;
155 return PAGE_EXECUTE_READ
;
157 *dwDesiredAccess
= FILE_MAP_READ
;
158 return PAGE_READONLY
;
160 if (prot
& PROT_WRITE
) {
161 *dwDesiredAccess
= FILE_MAP_COPY
;
162 return PAGE_WRITECOPY
;
164 if (prot
& PROT_EXEC
) {
165 *dwDesiredAccess
= FILE_MAP_EXECUTE
;
166 return PAGE_EXECUTE_READ
;
169 /* Mapping failed. */
170 *dwDesiredAccess
= 0;
175 void *bt_mmap(void *addr
, size_t length
, int prot
, int flags
, int fd
,
176 off_t offset
, int log_level
)
178 struct mmap_mapping
*mapping
= NULL
;
180 DWORD dwDesiredAccess
;
184 /* Check for a valid fd. */
190 /* We don't support this at the moment. */
191 if (flags
== MAP_FIXED
) {
196 /* Map mmap flags to those of the Windows API. */
197 flProtect
= map_prot_flags(prot
, &dwDesiredAccess
);
198 if (flProtect
== 0) {
203 /* Allocate the mapping struct. */
204 mapping
= mapping_create(log_level
);
206 BT_LOG_WRITE_CUR_LVL(BT_LOG_ERROR
, log_level
, BT_LOG_TAG
,
207 "Failed to allocate mmap mapping.");
212 /* Get a handle from the fd. */
213 handle
= (HANDLE
) _get_osfhandle(fd
);
215 /* Duplicate the handle and store it in 'mapping.file_handle'. */
216 if (!DuplicateHandle(GetCurrentProcess(), handle
, GetCurrentProcess(),
217 &mapping
->file_handle
, 0, FALSE
,
218 DUPLICATE_SAME_ACCESS
)) {
224 * Create a file mapping object with a maximum size
225 * of 'offset' + 'length'.
227 mapping
->map_handle
= CreateFileMapping(mapping
->file_handle
, NULL
,
228 flProtect
, 0, offset
+ length
, NULL
);
229 if (mapping
->map_handle
== 0) {
234 /* Map the requested block starting at 'offset' for 'length' bytes. */
235 mapping_addr
= MapViewOfFile(mapping
->map_handle
, dwDesiredAccess
, 0,
237 if (mapping_addr
== 0) {
238 DWORD dwLastErr
= GetLastError();
239 if (dwLastErr
== ERROR_MAPPED_ALIGNMENT
) {
247 mmap_lock(log_level
);
249 /* If we have never done any mappings, allocate the hashtable. */
250 if (!mmap_mappings
) {
251 mmap_mappings
= g_hash_table_new_full(g_direct_hash
,
252 g_direct_equal
, (GDestroyNotify
) addr_clean
,
253 (GDestroyNotify
) mapping_clean
);
254 if (!mmap_mappings
) {
255 BT_LOGE_STR("Failed to allocate mmap hashtable.");
257 goto error_mutex_unlock
;
261 /* Add the new mapping to the hashtable. */
262 g_hash_table_insert(mmap_mappings
, mapping_addr
, mapping
);
264 mmap_unlock(log_level
);
269 mmap_unlock(log_level
);
271 mapping_clean(mapping
);
276 int bt_munmap(void *addr
, size_t length
)
279 struct mmap_mapping
*mapping
= addr
;
283 log_level
= mapping
->log_level
;
284 mmap_lock(log_level
);
286 /* Check if the mapping exists in the hashtable. */
287 if (!g_hash_table_lookup(mmap_mappings
, addr
)) {
294 if (!g_hash_table_remove(mmap_mappings
, addr
)) {
295 BT_LOGF_STR("Failed to remove mapping from hashtable.");
300 mmap_unlock(log_level
);
305 size_t bt_mmap_get_offset_align_size(int log_level
)
309 GetNativeSystemInfo(&sysinfo
);
310 BT_LOG_WRITE_CUR_LVL(BT_LOG_DEBUG
, log_level
, BT_LOG_TAG
,
311 "Allocator granularity is %lu.",
312 sysinfo
.dwAllocationGranularity
);
314 return sysinfo
.dwAllocationGranularity
;