MMAP

Provides mmap: mapping files into memory.

Documentation

data MmapException

Exception thrown when mmap fails.

Constructors

MmapException

Instances

Eq MmapException

Defined in MMAP

Methods

(==) :: MmapException -> MmapException -> Bool

(/=) :: MmapException -> MmapException -> Bool

Ord MmapException

Defined in MMAP

Methods

compare :: MmapException -> MmapException -> Ordering

(<) :: MmapException -> MmapException -> Bool

(<=) :: MmapException -> MmapException -> Bool

(>) :: MmapException -> MmapException -> Bool

(>=) :: MmapException -> MmapException -> Bool

max :: MmapException -> MmapException -> MmapException

min :: MmapException -> MmapException -> MmapException

Show MmapException

Defined in MMAP

Methods

showsPrec :: Int -> MmapException -> ShowS

show :: MmapException -> String

showList :: [MmapException] -> ShowS

Exception MmapException

Defined in MMAP

Methods

toException :: MmapException -> SomeException

fromException :: SomeException -> Maybe MmapException

displayException :: MmapException -> String

data MunmapException

Exception thrown when munmap fails.

Constructors

MunmapException

Fields

• munmapExceptionSize :: CSize
• munmapExceptionPtr :: Ptr ()

Instances

Eq MunmapException

Defined in MMAP

Methods

(==) :: MunmapException -> MunmapException -> Bool

(/=) :: MunmapException -> MunmapException -> Bool

Ord MunmapException

Defined in MMAP

Methods

compare :: MunmapException -> MunmapException -> Ordering

(<) :: MunmapException -> MunmapException -> Bool

(<=) :: MunmapException -> MunmapException -> Bool

(>) :: MunmapException -> MunmapException -> Bool

(>=) :: MunmapException -> MunmapException -> Bool

max :: MunmapException -> MunmapException -> MunmapException

min :: MunmapException -> MunmapException -> MunmapException

Show MunmapException

Defined in MMAP

Methods

showsPrec :: Int -> MunmapException -> ShowS

show :: MunmapException -> String

showList :: [MunmapException] -> ShowS

Exception MunmapException

Defined in MMAP

Methods

toException :: MunmapException -> SomeException

fromException :: SomeException -> Maybe MunmapException

displayException :: MunmapException -> String

c_mmap

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

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 ())

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

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

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

newtype ProtOption

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

Defined in MMAP

Methods

(==) :: ProtOption -> ProtOption -> Bool

(/=) :: ProtOption -> ProtOption -> Bool

Ord ProtOption

Defined in MMAP

Methods

compare :: ProtOption -> ProtOption -> Ordering

(<) :: ProtOption -> ProtOption -> Bool

(<=) :: ProtOption -> ProtOption -> Bool

(>) :: ProtOption -> ProtOption -> Bool

(>=) :: ProtOption -> ProtOption -> Bool

max :: ProtOption -> ProtOption -> ProtOption

min :: ProtOption -> ProtOption -> ProtOption

Show ProtOption

Defined in MMAP

Methods

showsPrec :: Int -> ProtOption -> ShowS

show :: ProtOption -> String

showList :: [ProtOption] -> ShowS

Semigroup ProtOption

Defined in MMAP

Methods

(<>) :: ProtOption -> ProtOption -> ProtOption

sconcat :: NonEmpty ProtOption -> ProtOption

stimes :: Integral b => b -> ProtOption -> ProtOption

Monoid ProtOption

Defined in MMAP

Methods

mempty :: ProtOption

mappend :: ProtOption -> ProtOption -> ProtOption

mconcat :: [ProtOption] -> ProtOption

protExec :: ProtOption

Pages may be executed.

protRead :: ProtOption

Pages may be read.

protWrite :: ProtOption

Pages may be written.

protNone :: ProtOption

Pages may not be accessed.

newtype MmapSharedFlag

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

Defined in MMAP

Methods

(==) :: MmapSharedFlag -> MmapSharedFlag -> Bool

(/=) :: MmapSharedFlag -> MmapSharedFlag -> Bool

Ord MmapSharedFlag

Defined in MMAP

Methods

compare :: MmapSharedFlag -> MmapSharedFlag -> Ordering

(<) :: MmapSharedFlag -> MmapSharedFlag -> Bool

(<=) :: MmapSharedFlag -> MmapSharedFlag -> Bool

(>) :: MmapSharedFlag -> MmapSharedFlag -> Bool

(>=) :: MmapSharedFlag -> MmapSharedFlag -> Bool

max :: MmapSharedFlag -> MmapSharedFlag -> MmapSharedFlag

min :: MmapSharedFlag -> MmapSharedFlag -> MmapSharedFlag

Show MmapSharedFlag

Defined in MMAP

Methods

showsPrec :: Int -> MmapSharedFlag -> ShowS

show :: MmapSharedFlag -> String

showList :: [MmapSharedFlag] -> ShowS

mapShared :: MmapSharedFlag

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

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

And MmapSharedFlag with one or more MmapOptionalFlags.

Constructors

MmapOptionalFlag

Fields

• unMmapOptionalFlag :: CInt

Instances

Eq MmapOptionalFlag

Defined in MMAP

Methods

(==) :: MmapOptionalFlag -> MmapOptionalFlag -> Bool

(/=) :: MmapOptionalFlag -> MmapOptionalFlag -> Bool

Ord MmapOptionalFlag

Defined in MMAP

Methods

compare :: MmapOptionalFlag -> MmapOptionalFlag -> Ordering

(<) :: MmapOptionalFlag -> MmapOptionalFlag -> Bool

(<=) :: MmapOptionalFlag -> MmapOptionalFlag -> Bool

(>) :: MmapOptionalFlag -> MmapOptionalFlag -> Bool

(>=) :: MmapOptionalFlag -> MmapOptionalFlag -> Bool

max :: MmapOptionalFlag -> MmapOptionalFlag -> MmapOptionalFlag

min :: MmapOptionalFlag -> MmapOptionalFlag -> MmapOptionalFlag

Show MmapOptionalFlag

Defined in MMAP

Methods

showsPrec :: Int -> MmapOptionalFlag -> ShowS

show :: MmapOptionalFlag -> String

showList :: [MmapOptionalFlag] -> ShowS

Semigroup MmapOptionalFlag

Defined in MMAP

Methods

(<>) :: MmapOptionalFlag -> MmapOptionalFlag -> MmapOptionalFlag

sconcat :: NonEmpty MmapOptionalFlag -> MmapOptionalFlag

stimes :: Integral b => b -> MmapOptionalFlag -> MmapOptionalFlag

Monoid MmapOptionalFlag

Defined in MMAP

Methods

mempty :: MmapOptionalFlag

mappend :: MmapOptionalFlag -> MmapOptionalFlag -> MmapOptionalFlag

mconcat :: [MmapOptionalFlag] -> MmapOptionalFlag

map32Bit :: MmapOptionalFlag

See man mmap for a description.

mapAnonymous :: MmapOptionalFlag

See man mmap for a description.

mapDenywrite :: MmapOptionalFlag

See man mmap for a description.

mapFile :: MmapOptionalFlag

See man mmap for a description.

mapFixed :: MmapOptionalFlag

See man mmap for a description.

mapHugetlb :: MmapOptionalFlag

See man mmap for a description.

mapLocked :: MmapOptionalFlag

See man mmap for a description.

mapNonblock :: MmapOptionalFlag

See man mmap for a description.

mapNoreserve :: MmapOptionalFlag

See man mmap for a description.

mapStack :: MmapOptionalFlag

See man mmap for a description.

newtype MmapFlags

An MmapSharedFlag with one or more MmapOptionalFlags.

Constructors

MmapFlags

Fields

• unMmapFlags :: CInt

Instances

Eq MmapFlags

Defined in MMAP

Methods

(==) :: MmapFlags -> MmapFlags -> Bool

(/=) :: MmapFlags -> MmapFlags -> Bool

Ord MmapFlags

Defined in MMAP

Methods

compare :: MmapFlags -> MmapFlags -> Ordering

(<) :: MmapFlags -> MmapFlags -> Bool

(<=) :: MmapFlags -> MmapFlags -> Bool

(>) :: MmapFlags -> MmapFlags -> Bool

(>=) :: MmapFlags -> MmapFlags -> Bool

max :: MmapFlags -> MmapFlags -> MmapFlags

min :: MmapFlags -> MmapFlags -> MmapFlags

Show MmapFlags

Defined in MMAP

Methods

showsPrec :: Int -> MmapFlags -> ShowS

show :: MmapFlags -> String

showList :: [MmapFlags] -> ShowS

mkMmapFlags :: MmapSharedFlag -> MmapOptionalFlag -> MmapFlags

Create MmapFlags to be passed to c_mmap from an MmapSharedFlag and one or more MmapOptionalFlags (combine them via `(<>)`, mempty for none).