mmap
Source: quickjs-mmap.c — module exports a flat list of functions.
Thin bindings around the POSIX memory-mapping syscalls. Mapped regions are
returned as ArrayBuffers.
Functions
| Function | Args | Description |
|---|---|---|
mmap(addr, length, prot, flags, fd, offset) | 2 | Maps memory and returns it as an ArrayBuffer (-1 when mmap(2) fails). addr may be null; prot defaults to PROT_READ | PROT_WRITE, flags to MAP_ANONYMOUS, fd to -1, offset to 0. A MAP_SHARED mapping is a plain ArrayBuffer, not a SharedArrayBuffer. |
munmap(buffer) | 1 | Unmaps a previously mapped region. |
msync(buffer, flags, ...) | 3 | Flushes changes in a mapping back to the backing store (MS_* flags). |
mprotect(buffer, prot, ...) | 3 | Changes the protection (PROT_*) of a mapping. |
filename(buffer) | 1 | Returns the file name backing a mapping (from /proc/self/maps on Linux, GetMappedFileNameW on Windows), undefined for an anonymous mapping or an address in no mapping. |
toString(buffer) | 1 | Renders a description of a mapping. |
Constants
Protection: PROT_READ, PROT_WRITE, PROT_EXEC, PROT_NONE,
PROT_GROWSDOWN, PROT_GROWSUP.
Mapping flags: MAP_SHARED, MAP_PRIVATE, MAP_TYPE, MAP_FIXED,
MAP_ANONYMOUS, MAP_GROWSDOWN, MAP_DENYWRITE, MAP_EXECUTABLE,
MAP_LOCKED, MAP_NORESERVE, MAP_POPULATE, MAP_NONBLOCK, MAP_STACK,
MAP_HUGETLB, MAP_FAILED.
Sync flags: MS_ASYNC, MS_INVALIDATE, MS_SYNC. Plus the errno values
EBUSY, EFAULT, EINVAL, ENOMEM where available.
Export list
Generated by utilities/doc-api.js from the mmap dump of utilities/api-surface.sh: 34 members. Edit the text above this block, not the block.
Functions: filename(), mmap(), mprotect(), msync(), munmap(), toString()
Values: EBUSY = 16, EFAULT = 14, EINVAL = 22, ENOMEM = 12, MAP_ANONYMOUS = 32, MAP_DENYWRITE = 2048, MAP_EXECUTABLE = 4096, MAP_FAILED = -1, MAP_FIXED = 16, MAP_GROWSDOWN = 256, MAP_HUGETLB = 262144, MAP_LOCKED = 8192, MAP_NONBLOCK = 65536, MAP_NORESERVE = 16384, MAP_POPULATE = 32768, MAP_PRIVATE = 2, MAP_SHARED = 1, MAP_STACK = 131072, MAP_TYPE = 15, MS_ASYNC = 1, MS_INVALIDATE = 2, MS_SYNC = 4, PROT_EXEC = 4, PROT_GROWSDOWN = 16777216, PROT_GROWSUP = 33554432, PROT_NONE = 0, PROT_READ = 1, PROT_WRITE = 2