Safe Haskell	Safe-Inferred
Language	Haskell98

MMAP

Description

Provides mmap: mapping files into memory.

Synopsis

Documentation

data MmapException Source

Exception thrown when mmap fails.

Constructors

MmapException

Instances

Eq MmapException
Ord MmapException
Show MmapException
Exception MmapException
Typeable * MmapException

data MunmapException Source

Exception thrown when munmap fails.

Constructors

MunmapException
Fields munmapExceptionSize :: CSize munmapExceptionPtr :: Ptr ()

Instances

Eq MunmapException
Ord MunmapException
Show MunmapException
Exception MunmapException
Typeable * MunmapException

c_mmap Source

Arguments

:: Ptr ()	void *addr
-> CSize	size_t length
-> ProtOption	int prot
-> MmapFlags	int flags,
-> Fd	int fd
-> COff	off_t offset
-> IO (Ptr ())

mmap - map files or devices into memory.

The returned memory should be freed with c_munmap after use.

This is the raw C function, and its return value must be checked according to man mmap.

See mmap for a variant that turns bad return values into exceptions.

c_munmap Source

Arguments

:: Ptr ()	void *addr
-> CSize	size_t length
-> IO CInt

munmap - unmap mmap'ed memory.

This is the raw C function, and its return value must be checked according to man mmap.

See munmap for a variant that turns bad return values into exceptions.

mmap :: Ptr () -> CSize -> ProtOption -> MmapFlags -> Fd -> COff -> IO (Ptr ()) Source

Convenience around c_mmap, throwing a MmapException on a negative return value.

munmap :: Ptr () -> CSize -> IO () Source

Convenience around c_munmap, throwing a MunmapException on a negative return value.

newtype ProtOption Source

Describes the desired memory protection of the mapping (and must not conflict with the open mode of the file).

Can be combined using the Monoid instance `(<>)`.

Constructors

ProtOption
Fields unProtOption :: CInt

Instances

Eq ProtOption
Ord ProtOption
Show ProtOption
Monoid ProtOption

protExec :: ProtOption Source

Pages may be executed.

protRead :: ProtOption Source

Pages may be read.

protWrite :: ProtOption Source

Pages may be written.

protNone :: ProtOption Source

Pages may not be accessed.

newtype MmapSharedFlag Source

Determines whether updates to the mapping are visible to other processes mapping the same region, and whether updates are carried through to the underlying file.

This behavior is determined by including exactly one of mapShared and mapPrivate.

Constructors

MmapSharedFlag
Fields unMmapSharedFlag :: CInt

Instances

Eq MmapSharedFlag
Ord MmapSharedFlag
Show MmapSharedFlag

mapShared :: MmapSharedFlag Source

Share this mapping. Updates to the mapping are visible to other processes that map the file, and are carried through to the underlying file. The file may not actually be updated until msync(2) or munmap() is called..

mapPrivate :: MmapSharedFlag Source

Create a private copy-on-write mapping. Updates to the mapping are not visible to other processes mapping the same file, and are not carried through to the underlying file. It is unspecified whether changes made to the file after the mmap() call are visible in the mapped region.

newtype MmapOptionalFlag Source

And MmapSharedFlag with one or more MmapOptionalFlags.

Constructors

MmapOptionalFlag
Fields unMmapOptionalFlag :: CInt

Instances

Eq MmapOptionalFlag
Ord MmapOptionalFlag
Show MmapOptionalFlag
Monoid MmapOptionalFlag

map32Bit :: MmapOptionalFlag Source