Moduleunix-memory-0.1.2Haskell98

System.Posix.Memory

Functions defined by the POSIX standards for manipulating memory maps

When a function that calls an underlying POSIX function fails, the errno code is converted to an IOError using errnoToIOError. For a list of which errno codes may be generated, consult the POSIX documentation for the underlying function.

Contents

Flags types
system page size

Synopsis

value memoryMap
value memoryUnmap
value memoryAdvise
value memoryLock
value memoryUnlock
value memoryProtect
value memorySync
data MemoryMapFlag
data MemoryProtection
data MemoryAdvice
data MemorySyncFlag
value sysconfPageSize

Packageunix-memory-0.1.2
Exports12
LanguageHaskell98
LicenceBSD-3-Clause
SourceMemory.hsc

valuememoryMap

:: Maybe (Ptr a)
The address to map to if MapFixed is used.
-> CSize
The length of the mapping
-> [MemoryProtection]
the memory protection associated with the mapping
-> MemoryMapFlag
-> Maybe Fd
-> COff
-> IO (Ptr a)

Source#

Map pages of memory.

If fd is present, this memory will represent the file associated. Otherwise, the memory will be an anonymous mapping.

use mmap

valuememoryUnmap :: Ptr a -> CSize -> IO ()

valuememoryAdvise :: Ptr a -> CSize -> MemoryAdvice -> IO ()

Source#

give advice to the operating system about use of memory

call madvise

valuememoryLock :: Ptr a -> CSize -> IO ()

Source#

lock a range of process address space

call mlock

valuememoryUnlock :: Ptr a -> CSize -> IO ()

Source#

unlock a range of process address space

call munlock

valuememoryProtect :: Ptr a -> CSize -> [MemoryProtection] -> IO ()

Source#

set protection of memory mapping

call mprotect

valuememorySync :: Ptr a -> CSize -> [MemorySyncFlag] -> IO ()

Source#

memorySync synchronize memory with physical storage.

On an anonymous mapping this function doesn't have any effect. call msync

Flags types

datadata MemoryMapFlag

Source#

Mapping flag

Constructors

MemoryMapShared
memory changes are shared between process
MemoryMapPrivate
memory changes are private to process

Instances3Eq, Read, Show

Eq MemoryMapFlagDefined in unix-memory-0.1.2 · System.Posix.Memory
Read MemoryMapFlagDefined in unix-memory-0.1.2 · System.Posix.Memory
Show MemoryMapFlagDefined in unix-memory-0.1.2 · System.Posix.Memory

datadata MemoryProtection

Source#

Memory protection

MemoryProtectionNone MemoryProtectionRead MemoryProtectionWrite MemoryProtectionExecute

Instances3Eq, Read, Show

Eq MemoryProtectionDefined in unix-memory-0.1.2 · System.Posix.Memory
Read MemoryProtectionDefined in unix-memory-0.1.2 · System.Posix.Memory
Show MemoryProtectionDefined in unix-memory-0.1.2 · System.Posix.Memory

datadata MemoryAdvice

Source#

Advice to put on memory.

only define the posix one.

Constructors

MemoryAdviceNormal
no specific advice, the default.
MemoryAdviceRandom
Expect page references in random order. No readahead should occur.
MemoryAdviceSequential
Expect page references in sequential order. Page should be readahead aggressively.
MemoryAdviceWillNeed
Expect access in the near future. Probably a good idea to readahead early
MemoryAdviceDontNeed
Do not expect access in the near future.

Instances3Eq, Read, Show

Eq MemoryAdviceDefined in unix-memory-0.1.2 · System.Posix.Memory
Read MemoryAdviceDefined in unix-memory-0.1.2 · System.Posix.Memory
Show MemoryAdviceDefined in unix-memory-0.1.2 · System.Posix.Memory

datadata MemorySyncFlag

Source#

Memory synchronization flags

Constructors

MemorySyncAsync
perform asynchronous write.
MemorySyncSync
perform synchronous write.
MemorySyncInvalidate
invalidate cache data.

Instances3Eq, Read, Show

Eq MemorySyncFlagDefined in unix-memory-0.1.2 · System.Posix.Memory
Read MemorySyncFlagDefined in unix-memory-0.1.2 · System.Posix.Memory
Show MemorySyncFlagDefined in unix-memory-0.1.2 · System.Posix.Memory

system page size

valuesysconfPageSize :: Int

Source#

Return the operating system page size.

call sysconf