1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541
|
/* -----------------------------------------------------------------------------
*
* (c) The University of Glasgow 2006-2007
*
* OS-specific memory management
*
* ---------------------------------------------------------------------------*/
// This is non-posix compliant.
// #include "PosixSource.h"
#include "Rts.h"
#include "RtsUtils.h"
#include "sm/OSMem.h"
#include "sm/HeapAlloc.h"
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
#ifdef HAVE_SYS_TYPES_H
#include <sys/types.h>
#endif
#ifdef HAVE_SYS_MMAN_H
#include <sys/mman.h>
#endif
#ifdef HAVE_STRING_H
#include <string.h>
#endif
#ifdef HAVE_FCNTL_H
#include <fcntl.h>
#endif
#include <errno.h>
#if darwin_HOST_OS || ios_HOST_OS
#include <mach/mach.h>
#include <mach/vm_map.h>
#include <sys/sysctl.h>
#endif
static caddr_t next_request = 0;
void osMemInit(void)
{
next_request = (caddr_t)RtsFlags.GcFlags.heapBase;
}
/* -----------------------------------------------------------------------------
The mmap() method
On Unix-like systems, we use mmap() to allocate our memory. We
want memory in chunks of MBLOCK_SIZE, and aligned on an MBLOCK_SIZE
boundary. The mmap() interface doesn't give us this level of
control, so we have to use some heuristics.
In the general case, if we want a block of n megablocks, then we
allocate n+1 and trim off the slop from either side (using
munmap()) to get an aligned chunk of size n. However, the next
time we'll try to allocate directly after the previously allocated
chunk, on the grounds that this is aligned and likely to be free.
If it turns out that we were wrong, we have to munmap() and try
again using the general method.
Note on posix_memalign(): this interface is available on recent
systems and appears to provide exactly what we want. However, it
turns out not to be as good as our mmap() implementation, because
it wastes extra space (using double the address space, in a test on
x86_64/Linux). The problem seems to be that posix_memalign()
returns memory that can be free()'d, so the library must store
extra information along with the allocated block, thus messing up
the alignment. Hence, we don't use posix_memalign() for now.
-------------------------------------------------------------------------- */
/*
A wrapper around mmap(), to abstract away from OS differences in
the mmap() interface.
It supports the following operations:
- reserve: find a new chunk of available address space, and make it so
that we own it (no other library will get it), but don't actually
allocate memory for it
the addr is a hint for where to place the memory (and most
of the time the OS happily ignores!)
- commit: given a chunk of address space that we know we own, make sure
there is some memory backing it
the addr is not a hint, it must point into previously reserved
address space, or bad things happen
- reserve&commit: do both at the same time
The naming is chosen from the Win32 API (VirtualAlloc) which does the
same thing and has done so forever, while support for this in Unix systems
has only been added recently and is hidden in the posix portability mess.
It is confusing because to get the reserve behavior we need MAP_NORESERVE
(which tells the kernel not to allocate backing space), but heh...
*/
enum
{
MEM_RESERVE = 1,
MEM_COMMIT = 2,
MEM_RESERVE_AND_COMMIT = MEM_RESERVE | MEM_COMMIT
};
/* Returns NULL on failure; errno set */
static void *
my_mmap (void *addr, W_ size, int operation)
{
void *ret;
#if darwin_HOST_OS
// Without MAP_FIXED, Apple's mmap ignores addr.
// With MAP_FIXED, it overwrites already mapped regions, whic
// mmap(0, ... MAP_FIXED ...) is worst of all: It unmaps the program text
// and replaces it with zeroes, causing instant death.
// This behaviour seems to be conformant with IEEE Std 1003.1-2001.
// Let's just use the underlying Mach Microkernel calls directly,
// they're much nicer.
kern_return_t err = 0;
ret = addr;
if(operation & MEM_RESERVE)
{
if(addr) // try to allocate at address
err = vm_allocate(mach_task_self(),(vm_address_t*) &ret,
size, FALSE);
if(!addr || err) // try to allocate anywhere
err = vm_allocate(mach_task_self(),(vm_address_t*) &ret,
size, TRUE);
}
if(err) {
// don't know what the error codes mean exactly, assume it's
// not our problem though.
errorBelch("memory allocation failed (requested %" FMT_Word " bytes)",
size);
stg_exit(EXIT_FAILURE);
}
if(operation & MEM_COMMIT) {
vm_protect(mach_task_self(), (vm_address_t)ret, size, FALSE,
VM_PROT_READ|VM_PROT_WRITE);
}
#else
int prot, flags;
if (operation & MEM_COMMIT)
prot = PROT_READ | PROT_WRITE;
else
prot = PROT_NONE;
if (operation == MEM_RESERVE)
# if defined(MAP_NORESERVE)
flags = MAP_NORESERVE;
# else
# ifdef USE_LARGE_ADDRESS_SPACE
# error USE_LARGE_ADDRESS_SPACE needs MAP_NORESERVE
# endif
errorBelch("my_mmap(,,MEM_RESERVE) not supported on this platform");
# endif
else if (operation == MEM_COMMIT)
flags = MAP_FIXED;
else
flags = 0;
#if defined(irix_HOST_OS)
{
if (operation & MEM_RESERVE)
{
int fd = open("/dev/zero",O_RDONLY);
ret = mmap(addr, size, prot, flags | MAP_PRIVATE, fd, 0);
close(fd);
}
else
{
ret = mmap(addr, size, prot, flags | MAP_PRIVATE, -1, 0);
}
}
#elif hpux_HOST_OS
ret = mmap(addr, size, prot, flags | MAP_ANONYMOUS | MAP_PRIVATE, -1, 0);
#elif linux_HOST_OS
ret = mmap(addr, size, prot, flags | MAP_ANON | MAP_PRIVATE, -1, 0);
if (ret == (void *)-1 && errno == EPERM) {
// Linux may return EPERM if it tried to give us
// a chunk of address space below mmap_min_addr,
// See Trac #7500.
if (addr != 0 && (operation & MEM_RESERVE)) {
// Try again with no hint address.
// It's not clear that this can ever actually help,
// but since our alternative is to abort, we may as well try.
ret = mmap(0, size, prot, flags | MAP_ANON | MAP_PRIVATE, -1, 0);
}
if (ret == (void *)-1 && errno == EPERM) {
// Linux is not willing to give us any mapping,
// so treat this as an out-of-memory condition
// (really out of virtual address space).
errno = ENOMEM;
}
}
#else
ret = mmap(addr, size, prot, flags | MAP_ANON | MAP_PRIVATE, -1, 0);
#endif
#endif
if (ret == (void *)-1) {
return NULL;
}
return ret;
}
/* Variant of my_mmap which aborts in the case of an error */
static void *
my_mmap_or_barf (void *addr, W_ size, int operation)
{
void *ret = my_mmap(addr, size, operation);
if (ret == NULL) {
if (errno == ENOMEM ||
(errno == EINVAL && sizeof(void*)==4 && size >= 0xc0000000)) {
// If we request more than 3Gig, then we get EINVAL
// instead of ENOMEM (at least on Linux).
errorBelch("out of memory (requested %" FMT_Word " bytes)", size);
stg_exit(EXIT_HEAPOVERFLOW);
} else {
barf("getMBlock: mmap: %s", strerror(errno));
}
}
return ret;
}
// Implements the general case: allocate a chunk of memory of 'size'
// mblocks.
static void *
gen_map_mblocks (W_ size)
{
int slop;
StgWord8 *ret;
// Try to map a larger block, and take the aligned portion from
// it (unmap the rest).
size += MBLOCK_SIZE;
ret = my_mmap_or_barf(0, size, MEM_RESERVE_AND_COMMIT);
// unmap the slop bits around the chunk we allocated
slop = (W_)ret & MBLOCK_MASK;
if (munmap((void*)ret, MBLOCK_SIZE - slop) == -1) {
barf("gen_map_mblocks: munmap failed");
}
if (slop > 0 && munmap((void*)(ret+size-slop), slop) == -1) {
barf("gen_map_mblocks: munmap failed");
}
// ToDo: if we happened to get an aligned block, then don't
// unmap the excess, just use it. For this to work, you
// need to keep in mind the following:
// * Calling my_mmap() with an 'addr' arg pointing to
// already my_mmap()ed space is OK and won't fail.
// * If my_mmap() can't satisfy the request at the
// given 'next_request' address in getMBlocks(), that
// you unmap the extra mblock mmap()ed here (or simply
// satisfy yourself that the slop introduced isn't worth
// salvaging.)
//
// next time, try after the block we just got.
ret += MBLOCK_SIZE - slop;
return ret;
}
void *
osGetMBlocks(nat n)
{
caddr_t ret;
W_ size = MBLOCK_SIZE * (W_)n;
if (next_request == 0) {
// use gen_map_mblocks the first time.
ret = gen_map_mblocks(size);
} else {
ret = my_mmap_or_barf(next_request, size, MEM_RESERVE_AND_COMMIT);
if (((W_)ret & MBLOCK_MASK) != 0) {
// misaligned block!
#if 0 // defined(DEBUG)
errorBelch("warning: getMBlock: misaligned block %p returned "
"when allocating %d megablock(s) at %p",
ret, n, next_request);
#endif
// unmap this block...
if (munmap(ret, size) == -1) {
barf("getMBlock: munmap failed");
}
// and do it the hard way
ret = gen_map_mblocks(size);
}
}
// Next time, we'll try to allocate right after the block we just got.
// ToDo: check that we haven't already grabbed the memory at next_request
next_request = ret + size;
return ret;
}
void osFreeMBlocks(char *addr, nat n)
{
munmap(addr, n * MBLOCK_SIZE);
}
void osReleaseFreeMemory(void) {
/* Nothing to do on POSIX */
}
void osFreeAllMBlocks(void)
{
void *mblock;
void *state;
for (mblock = getFirstMBlock(&state);
mblock != NULL;
mblock = getNextMBlock(&state, mblock)) {
munmap(mblock, MBLOCK_SIZE);
}
}
W_ getPageSize (void)
{
static W_ pageSize = 0;
if (pageSize) {
return pageSize;
} else {
long ret;
ret = sysconf(_SC_PAGESIZE);
if (ret == -1) {
barf("getPageSize: cannot get page size");
}
pageSize = ret;
return ret;
}
}
/* Returns 0 if physical memory size cannot be identified */
StgWord64 getPhysicalMemorySize (void)
{
static StgWord64 physMemSize = 0;
if (!physMemSize) {
#if defined(darwin_HOST_OS) || defined(ios_HOST_OS)
/* So, darwin doesn't support _SC_PHYS_PAGES, but it does
support getting the raw memory size in bytes through
sysctlbyname(hw.memsize); */
size_t len = sizeof(physMemSize);
int ret = -1;
/* Note hw.memsize is in bytes, so no need to multiply by page size. */
ret = sysctlbyname("hw.memsize", &physMemSize, &len, NULL, 0);
if (ret == -1) {
physMemSize = 0;
return 0;
}
#else
/* We'll politely assume we have a system supporting _SC_PHYS_PAGES
* otherwise. */
W_ pageSize = getPageSize();
long ret = sysconf(_SC_PHYS_PAGES);
if (ret == -1) {
#if defined(DEBUG)
errorBelch("warning: getPhysicalMemorySize: cannot get "
"physical memory size");
#endif
return 0;
}
physMemSize = ret * pageSize;
#endif /* darwin_HOST_OS */
}
return physMemSize;
}
void setExecutable (void *p, W_ len, rtsBool exec)
{
StgWord pageSize = getPageSize();
/* malloced memory isn't executable by default on OpenBSD */
StgWord mask = ~(pageSize - 1);
StgWord startOfFirstPage = ((StgWord)p ) & mask;
StgWord startOfLastPage = ((StgWord)p + len - 1) & mask;
StgWord size = startOfLastPage - startOfFirstPage + pageSize;
if (mprotect((void*)startOfFirstPage, (size_t)size,
(exec ? PROT_EXEC : 0) | PROT_READ | PROT_WRITE) != 0) {
barf("setExecutable: failed to protect 0x%p\n", p);
}
}
#ifdef USE_LARGE_ADDRESS_SPACE
static void *
osTryReserveHeapMemory (W_ len, void *hint)
{
void *base, *top;
void *start, *end;
/* We try to allocate len + MBLOCK_SIZE,
because we need memory which is MBLOCK_SIZE aligned,
and then we discard what we don't need */
base = my_mmap(hint, len + MBLOCK_SIZE, MEM_RESERVE);
if (base == NULL)
return NULL;
top = (void*)((W_)base + len + MBLOCK_SIZE);
if (((W_)base & MBLOCK_MASK) != 0) {
start = MBLOCK_ROUND_UP(base);
end = MBLOCK_ROUND_DOWN(top);
ASSERT(((W_)end - (W_)start) == len);
if (munmap(base, (W_)start-(W_)base) < 0) {
sysErrorBelch("unable to release slop before heap");
}
if (munmap(end, (W_)top-(W_)end) < 0) {
sysErrorBelch("unable to release slop after heap");
}
} else {
start = base;
}
return start;
}
void *osReserveHeapMemory(W_ *len)
{
int attempt;
void *at;
/* We want to ensure the heap starts at least 8 GB inside the address space,
to make sure that any dynamically loaded code will be close enough to the
original code so that short relocations will work. This is in particular
important on Darwin/Mach-O, because object files not compiled as shared
libraries are position independent but cannot be loaded about 4GB.
We do so with a hint to the mmap, and we verify the OS satisfied our
hint. We loop, shifting our hint by 1 BLOCK_SIZE every time, in case
there is already something allocated there.
Some systems impose resource limits restricting the amount of memory we
can request (see, e.g. #10877). If mmap fails we halve our allocation
request and try again. If our request size gets absurdly small we simply
give up.
*/
attempt = 0;
while (1) {
if (*len < MBLOCK_SIZE) {
// Give up if the system won't even give us 16 blocks worth of heap
barf("osReserveHeapMemory: Failed to allocate heap storage");
}
void *hint = (void*)((W_)8 * (1 << 30) + attempt * BLOCK_SIZE);
at = osTryReserveHeapMemory(*len, hint);
if (at == NULL) {
// This means that mmap failed which we take to mean that we asked
// for too much memory. This can happen due to POSIX resource
// limits. In this case we reduce our allocation request by a factor
// of two and try again.
*len /= 2;
} else if ((W_)at >= ((W_)8 * (1 << 30))) {
// Success! We were given a block of memory starting above the 8 GB
// mark, which is what we were looking for.
break;
} else {
// We got addressing space but it wasn't above the 8GB mark.
// Try again.
if (munmap(at, *len) < 0) {
sysErrorBelch("unable to release reserved heap");
}
}
}
return at;
}
void osCommitMemory(void *at, W_ size)
{
my_mmap(at, size, MEM_COMMIT);
}
void osDecommitMemory(void *at, W_ size)
{
int r;
// First make the memory unaccessible (so that we get a segfault
// at the next attempt to touch it)
// We only do this in DEBUG because it forces the OS to remove
// all MMU entries for this page range, and there is no reason
// to do so unless there is memory pressure
#ifdef DEBUG
r = mprotect(at, size, PROT_NONE);
if(r < 0)
sysErrorBelch("unable to make released memory unaccessible");
#endif
#ifdef MADV_FREE
// Try MADV_FREE first, FreeBSD has both and MADV_DONTNEED
// just swaps memory out. Linux >= 4.5 has both DONTNEED and FREE; either
// will work as they both allow the system to free anonymous pages.
// It is important that we try both methods as the kernel which we were
// built on may differ from the kernel we are now running on.
r = madvise(at, size, MADV_FREE);
if(r < 0) {
if (errno == EINVAL) {
// Perhaps the system doesn't support MADV_FREE; fall-through and
// try MADV_DONTNEED.
} else {
sysErrorBelch("unable to decommit memory");
}
} else {
return;
}
#endif
r = madvise(at, size, MADV_DONTNEED);
if(r < 0)
sysErrorBelch("unable to decommit memory");
}
void osReleaseHeapMemory(void)
{
int r;
r = munmap((void*)mblock_address_space.begin,
mblock_address_space.end - mblock_address_space.begin);
if(r < 0)
sysErrorBelch("unable to release address space");
}
#endif
|