The deoxybyte-unix Reference Manual

Table of Contents

The deoxybyte-unix Reference Manual

This is the deoxybyte-unix Reference Manual, version 0.8.0, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:41:32 2018 GMT+0.

1 Introduction

Introduction

The deoxybyte-unix system provides access to Unix functions via CFFI.

Some, but not all, Lisp implementations provide their own POSIX or
Unix package. While deoxybyte-unix treads some well-worn ground in
that respect, it should be portable to all Unix platforms supported by
CFFI.

Installation

deoxybyte-unix uses ASDF for system definition. Copy or symlink
deoxybyte-unix.asd (and optionally deoxybyte-unix-test.asd) to your
asdf:*central-registry* and load deoxybyte-unix with the asdf:operate
function:

 (asdf:operate 'asdf:load-op :deoxybyte-unix)

or with the equivalent deoxybyte-systems:load-system function:

 (dxs:load-system :deoxybyte-unix)


Tests

To run the unit and regression tests you need to have LIFT
installed. Run the tests with the asdf:operate function:

 (asdf:operate 'asdf:test-op :deoxybyte-unix)

or with the equivalent deoxybyte-systems:test-system function:

 (dxs:test-system :deoxybyte-unix)


Documentation

See the Lisp docstrings, particularly the package docstrings for an
overview. HTML documentation may be generated with the command:

 (dxs:document-system :deoxybyte-unix)

at the REPL, provided that CLDOC is installed.


Dependencies

deoxybyte-systems       git://github.com/keithj/deoxybyte-systems.git
deoxybyte-utilities     git://github.com/keithj/deoxybyte-utilities.git
deoxybyte-io            git://github.com/keithj/deoxybyte-io.git

CFFI                    http://common-lisp.net/project/cffi/


Optional dependencies

LIFT                    http://common-lisp.net/project/lift/
CLDOC                   http://common-lisp.net/project/cldoc/

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 deoxybyte-unix

Author

Keith James

License

GPL v3

Version

0.8.0

Dependencies

• deoxybyte-systems (at least version 1.0.0)
• cffi
• deoxybyte-io (at least version 0.15.0)

Source

deoxybyte-unix.asd (file)

Component

deoxybyte-unix (module)

3 Modules

Modules are listed depth-first from the system components tree.

3.1 deoxybyte-unix/deoxybyte-unix

Parent

deoxybyte-unix (system)

Location

src/

Components

• package.lisp (file)
• deoxybyte-unix-ffi.lisp (file)
• conditions.lisp (file)
• deoxybyte-unix.lisp (file)
• memory-map.lisp (file)
• sbcl.lisp (file)

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.

4.1 Lisp

4.1.1 deoxybyte-unix.asd

Location

deoxybyte-unix.asd

Systems

deoxybyte-unix (system)

4.1.2 deoxybyte-unix/deoxybyte-unix/package.lisp

Parent

deoxybyte-unix (module)

Location

src/package.lisp

Packages

• uk.co.deoxybyte-unix
• uk.co.deoxybyte-unix-ffi

4.1.3 deoxybyte-unix/deoxybyte-unix/deoxybyte-unix-ffi.lisp

Dependency

package.lisp (file)

Parent

deoxybyte-unix (module)

Location

src/deoxybyte-unix-ffi.lisp

Exported Definitions

• *c-error-number* (symbol macro)
• c-close (function)
• c-fileno (function)
• c-lseek (function)
• c-mkstemp (function)
• c-mmap (function)
• c-munmap (function)
• c-open (function)
• c-strerror (function)
• c-sysconf (function)
• c-write (function)

Internal Definitions

• %var-accessor-*c-error-number* (function)
• (setf %var-accessor-*c-error-number*) (function)

4.1.4 deoxybyte-unix/deoxybyte-unix/conditions.lisp

Dependency

deoxybyte-unix-ffi.lisp (file)

Parent

deoxybyte-unix (module)

Location

src/conditions.lisp

Exported Definitions

• mapped-file-error (condition)
• mapped-index-error (condition)

Internal Definitions

• index-of (method)
• mapped-file-of (method)

4.1.5 deoxybyte-unix/deoxybyte-unix/deoxybyte-unix.lisp

Dependency

conditions.lisp (file)

Parent

deoxybyte-unix (module)

Location

src/deoxybyte-unix.lisp

Exported Definitions

maybe-standard-stream (function)

4.1.6 deoxybyte-unix/deoxybyte-unix/memory-map.lisp

Dependency

deoxybyte-unix.lisp (file)

Parent

deoxybyte-unix (module)

Location

src/memory-map.lisp

Exported Definitions

• define-mapped-vector (macro)
• delete-policy-of (method)
• filespec-of (method)
• free-mapped-vector (generic function)
• free-mapped-vector (method)
• in-memory-p (generic function)
• in-memory-p (method)
• length-of (method)
• mapped-file (class)
• mapped-vector (class)
• mapped-vector-char (class)
• mapped-vector-double (class)
• mapped-vector-float (class)
• mapped-vector-int (class)
• mapped-vector-int16 (class)
• mapped-vector-int32 (class)
• mapped-vector-short (class)
• mapped-vector-uchar (class)
• mapped-vector-uint (class)
• mapped-vector-uint16 (class)
• mapped-vector-uint32 (class)
• mapped-vector-ushort (class)
• mmap (function)
• mmap-area (structure)
• mmap-area-fd (function)
• (setf mmap-area-fd) (function)
• mmap-area-live-p (function)
• (setf mmap-area-live-p) (function)
• mmap-area-ptr (function)
• (setf mmap-area-ptr) (function)
• mmap-area-size (function)
• (setf mmap-area-size) (function)
• mmap-area-type (function)
• (setf mmap-area-type) (function)
• mref (generic function)
• mref (method)
• (setf mref) (method)
• mref (method)
• (setf mref) (method)
• mref (method)
• (setf mref) (method)
• mref (method)
• (setf mref) (method)
• mref (method)
• (setf mref) (method)
• mref (method)
• (setf mref) (method)
• mref (method)
• (setf mref) (method)
• mref (method)
• (setf mref) (method)
• mref (method)
• (setf mref) (method)
• mref (method)
• (setf mref) (method)
• mref (method)
• (setf mref) (method)
• mref (method)
• (setf mref) (method)
• mref (method)
• (setf mref) (method)
• (setf mref) (generic function)
• munmap (generic function)
• munmap (method)
• with-mapped-vector (macro)

Internal Definitions

• %vector-bounds-check (function)
• copy-mmap-area (function)
• enlarge-file (function)
• make-mmap-area (function)
• mmap-area-p (function)
• unix-tmpfile-template (function)

4.1.7 deoxybyte-unix/deoxybyte-unix/sbcl.lisp

Dependency

memory-map.lisp (file)

Parent

deoxybyte-unix (module)

Location

src/sbcl.lisp

Exported Definitions

file-descriptor (function)

5 Packages

Packages are listed by definition order.

5.1 uk.co.deoxybyte-unix

The deoxybyte-unix package provides a Lisp style
interface to the low level FFI in the :deoxybyte-unix-ffi package.

Some, but not all, Lisp implementations provide a POSIX or Unix package. While deoxybyte-unix treads some well-worn ground in that respect, it should be portable to all Unix platforms supported by CFFI.

Source

package.lisp (file)

Nicknames

• dxn
• deoxybyte-unix

Use List

• uk.co.deoxybyte-unix-ffi
• uk.co.deoxybyte-io
• uk.co.deoxybyte-utilities
• cffi
• common-lisp

Exported Definitions

• define-mapped-vector (macro)
• delete-policy-of (generic function)
• delete-policy-of (method)
• file-descriptor (function)
• filespec-of (generic function)
• filespec-of (method)
• free-mapped-vector (generic function)
• free-mapped-vector (method)
• in-memory-p (generic function)
• in-memory-p (method)
• length-of (generic function)
• length-of (method)
• mapped-file (class)
• mapped-file-error (condition)
• mapped-index-error (condition)
• mapped-vector (class)
• mapped-vector-char (class)
• mapped-vector-double (class)
• mapped-vector-float (class)
• mapped-vector-int (class)
• mapped-vector-int16 (class)
• mapped-vector-int32 (class)
• mapped-vector-short (class)
• mapped-vector-uchar (class)
• mapped-vector-uint (class)
• mapped-vector-uint16 (class)
• mapped-vector-uint32 (class)
• mapped-vector-ushort (class)
• maybe-standard-stream (function)
• mmap (function)
• mmap-area (structure)
• mmap-area-fd (function)
• (setf mmap-area-fd) (function)
• mmap-area-live-p (function)
• (setf mmap-area-live-p) (function)
• mmap-area-ptr (function)
• (setf mmap-area-ptr) (function)
• mmap-area-size (function)
• (setf mmap-area-size) (function)
• mmap-area-type (function)
• (setf mmap-area-type) (function)
• mref (generic function)
• mref (method)
• (setf mref) (method)
• mref (method)
• (setf mref) (method)
• mref (method)
• (setf mref) (method)
• mref (method)
• (setf mref) (method)
• mref (method)
• (setf mref) (method)
• mref (method)
• (setf mref) (method)
• mref (method)
• (setf mref) (method)
• mref (method)
• (setf mref) (method)
• mref (method)
• (setf mref) (method)
• mref (method)
• (setf mref) (method)
• mref (method)
• (setf mref) (method)
• mref (method)
• (setf mref) (method)
• mref (method)
• (setf mref) (method)
• (setf mref) (generic function)
• munmap (generic function)
• munmap (method)
• with-mapped-vector (macro)

Internal Definitions

• %vector-bounds-check (function)
• copy-mmap-area (function)
• enlarge-file (function)
• index-of (generic function)
• index-of (method)
• make-mmap-area (function)
• mapped-file-of (generic function)
• mapped-file-of (method)
• mmap-area-p (function)
• unix-tmpfile-template (function)

5.2 uk.co.deoxybyte-unix-ffi

The deoxybyte-unix-ffi package provides utility
foreign functions to Unix via CFFI. This is a low-level FFI that does not provide a Lisp-style layer on top of the basic Unix functions. A small subset of Unix functionality is represented, with further functions being added as required.

Source

package.lisp (file)

Nicknames

• unix-ffi
• deoxybyte-unix-ffi

Use List

• cffi
• common-lisp

Used By List

uk.co.deoxybyte-unix

Exported Definitions

• *c-error-number* (symbol macro)
• c-close (function)
• c-fileno (function)
• c-lseek (function)
• c-mkstemp (function)
• c-mmap (function)
• c-munmap (function)
• c-open (function)
• c-strerror (function)
• c-sysconf (function)
• c-write (function)

Internal Definitions

• %var-accessor-*c-error-number* (function)
• (setf %var-accessor-*c-error-number*) (function)

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

6.1 Exported definitions

6.1.1 Symbol macros

Symbol Macro: *c-error-number*

Package

uk.co.deoxybyte-unix-ffi

Source

deoxybyte-unix-ffi.lisp (file)

Expansion

(uk.co.deoxybyte-unix-ffi::%var-accessor-*c-error-number*)

6.1.2 Macros

Macro: define-mapped-vector NAME FOREIGN-TYPE &optional DOCSTRING

Defines a mapped vector class NAME, with accompanying accessor methods ( {defmethod mref} ), specialized to store elements of FOREIGN-TYPE.

Package

uk.co.deoxybyte-unix

Source

memory-map.lisp (file)

Macro: with-mapped-vector (VAR CLASS &rest INITARGS) &body BODY

Executes BODY in the context of a newly instantiated {defclass mapped-vector} object of CLASS bound to VAR. The vector is safely munmapped after use.

Package

uk.co.deoxybyte-unix

Source

memory-map.lisp (file)

6.1.3 Functions

Function: c-close FILE-DESCRIPTOR

Package

uk.co.deoxybyte-unix-ffi

Source

deoxybyte-unix-ffi.lisp (file)

Function: c-fileno STREAM

Package

uk.co.deoxybyte-unix-ffi

Source

deoxybyte-unix-ffi.lisp (file)

Function: c-lseek FILE-DESCRIPTOR OFFSET WHENCE

Package

uk.co.deoxybyte-unix-ffi

Source

deoxybyte-unix-ffi.lisp (file)

Function: c-mkstemp TEMPLATE

Package

uk.co.deoxybyte-unix-ffi

Source

deoxybyte-unix-ffi.lisp (file)

Function: c-mmap ADDRESS LENGTH PROTECTION FLAGS FILE-DESCRIPTOR OFFSET

Package

uk.co.deoxybyte-unix-ffi

Source

deoxybyte-unix-ffi.lisp (file)

Function: c-munmap ADDRESS LENGTH

Package

uk.co.deoxybyte-unix-ffi

Source

deoxybyte-unix-ffi.lisp (file)

Function: c-open PATH FLAGS MODE

Package

uk.co.deoxybyte-unix-ffi

Source

deoxybyte-unix-ffi.lisp (file)

Function: c-strerror ERRNO

Package

uk.co.deoxybyte-unix-ffi

Source

deoxybyte-unix-ffi.lisp (file)

Function: c-sysconf NAME

Package

uk.co.deoxybyte-unix-ffi

Source

deoxybyte-unix-ffi.lisp (file)

Function: c-write FILE-DESCRIPTOR VALUE COUNT

Package

uk.co.deoxybyte-unix-ffi

Source

deoxybyte-unix-ffi.lisp (file)

Function: file-descriptor STREAM &optional DIRECTION

Returns the Unix file descriptor associated with STREAM.

Package

uk.co.deoxybyte-unix

Source

sbcl.lisp (file)

Function: maybe-standard-stream DESIGNATOR

Returns a standard stream (*standard-input* *standard-output* or *error-output*) if DESIGNATOR is a string that is STRING-EQUAL to one of "stdin", "stdout" or "stderr", otherwise returns
DESIGNATOR. (Also works for "/dev/stdin" etc.) This function is useful where one of these strings may be given on a command line to indicate a system stream, rather than a file-stream is to be used.

Package

uk.co.deoxybyte-unix

Source

deoxybyte-unix.lisp (file)

Function: mmap FILESPEC &key LENGTH FOREIGN-TYPE PROTECTION

Maps a file into memory.

Arguments:

- filespec (pathname designator): The file to be mmapped.

Key:

- length (fixnum): The length of the Lisp vector created when the file is mmapped.
- foreign-type (symbol): The foreign type of the elements to be stored in the vector.
- protection (list symbol): The memory protection keyword flags used in the mmap operation.

Returns:

- A pointer.

Package

uk.co.deoxybyte-unix

Source

memory-map.lisp (file)

Function: mmap-area-fd INSTANCE

Function: (setf mmap-area-fd) VALUE INSTANCE

Package

uk.co.deoxybyte-unix

Source

memory-map.lisp (file)

Function: mmap-area-live-p INSTANCE

Function: (setf mmap-area-live-p) VALUE INSTANCE

Package

uk.co.deoxybyte-unix

Source

memory-map.lisp (file)

Function: mmap-area-ptr INSTANCE

Function: (setf mmap-area-ptr) VALUE INSTANCE

Package

uk.co.deoxybyte-unix

Source

memory-map.lisp (file)

Function: mmap-area-size INSTANCE

Function: (setf mmap-area-size) VALUE INSTANCE

Package

uk.co.deoxybyte-unix

Source

memory-map.lisp (file)

Function: mmap-area-type INSTANCE

Function: (setf mmap-area-type) VALUE INSTANCE

Package

uk.co.deoxybyte-unix

Source

memory-map.lisp (file)

6.1.4 Generic functions

Generic Function: delete-policy-of OBJECT

Package

uk.co.deoxybyte-unix

Methods

Method: delete-policy-of (MAPPED-FILE mapped-file)

A flag to indicate whether the file
designated in the FILESPEC slot is to be deleted automatically when the mmapped file is freed. If an automatically generated tmp is to be used, the value of this slot is set to T.

Source

memory-map.lisp (file)

Generic Function: filespec-of OBJECT

Package

uk.co.deoxybyte-unix

Methods

Method: filespec-of (MAPPED-FILE mapped-file)

A user-supplied pathname designator for
the file to be mmapped, or NIL an automatically generated tmp file is to be used.

Source

memory-map.lisp (file)

Generic Function: free-mapped-vector MAPPED-VECTOR

Frees the mapped memory used by MAPPED-VECTOR.

Package

uk.co.deoxybyte-unix

Source

memory-map.lisp (file)

Methods

Method: free-mapped-vector (VECTOR mapped-vector)

Generic Function: in-memory-p MAPPED-FILE

Returns T if MAPPED-FILE is mapped into memory, or NIL otherwise.

Package

uk.co.deoxybyte-unix

Source

memory-map.lisp (file)

Methods

Method: in-memory-p (OBJ mapped-file)

Generic Function: length-of OBJECT

Package

uk.co.deoxybyte-unix

Methods

Method: length-of (MAPPED-FILE mapped-file)

The length of the Lisp vector created when the file is mmapped.

Source

memory-map.lisp (file)

Generic Function: mref MAPPED-VECTOR INDEX

Returns the value at INDEX in MAPPED-VECTOR.

Package

uk.co.deoxybyte-unix

Source

memory-map.lisp (file)

Writer

(setf mref) (generic function)

Methods

Method: mref (VECTOR mapped-vector-uint32) (INDEX fixnum)

Method: mref (VECTOR mapped-vector-int32) (INDEX fixnum)

Method: mref (VECTOR mapped-vector-uint16) (INDEX fixnum)

Method: mref (VECTOR mapped-vector-int16) (INDEX fixnum)

Method: mref (VECTOR mapped-vector-double) (INDEX fixnum)

Method: mref (VECTOR mapped-vector-float) (INDEX fixnum)

Method: mref (VECTOR mapped-vector-uint) (INDEX fixnum)

Method: mref (VECTOR mapped-vector-int) (INDEX fixnum)

Method: mref (VECTOR mapped-vector-ushort) (INDEX fixnum)

Method: mref (VECTOR mapped-vector-short) (INDEX fixnum)

Method: mref (VECTOR mapped-vector-uchar) (INDEX fixnum)

Method: mref (VECTOR mapped-vector-char) (INDEX fixnum)

Method: mref (VECTOR mapped-vector) (INDEX fixnum) before

Generic Function: (setf mref) VALUE MAPPED-VECTOR INDEX

Sets VALUE at INDEX in MAPPED-VECTOR.

Package

uk.co.deoxybyte-unix

Source

memory-map.lisp (file)

Reader

mref (generic function)

Methods

Method: (setf mref) VALUE (VECTOR mapped-vector-uint32) (INDEX fixnum)

Method: (setf mref) VALUE (VECTOR mapped-vector-int32) (INDEX fixnum)

Method: (setf mref) VALUE (VECTOR mapped-vector-uint16) (INDEX fixnum)

Method: (setf mref) VALUE (VECTOR mapped-vector-int16) (INDEX fixnum)

Method: (setf mref) VALUE (VECTOR mapped-vector-double) (INDEX fixnum)

Method: (setf mref) VALUE (VECTOR mapped-vector-float) (INDEX fixnum)

Method: (setf mref) VALUE (VECTOR mapped-vector-uint) (INDEX fixnum)

Method: (setf mref) VALUE (VECTOR mapped-vector-int) (INDEX fixnum)

Method: (setf mref) VALUE (VECTOR mapped-vector-ushort) (INDEX fixnum)

Method: (setf mref) VALUE (VECTOR mapped-vector-short) (INDEX fixnum)

Method: (setf mref) VALUE (VECTOR mapped-vector-uchar) (INDEX fixnum)

Method: (setf mref) VALUE (VECTOR mapped-vector-char) (INDEX fixnum)

Method: (setf mref) VALUE (VECTOR mapped-vector) (INDEX fixnum) before

Generic Function: munmap MAPPED-FILE

Frees the mapped memory used by MAPPED-FILE and closes the underlying file descriptor.

Package

uk.co.deoxybyte-unix

Source

memory-map.lisp (file)

Methods

Method: munmap (OBJ mapped-file)

6.1.5 Conditions

Condition: mapped-file-error ()

An error that is raised during an operation on a mmapped file.

Package

uk.co.deoxybyte-unix

Source

conditions.lisp (file)

Direct superclasses

• simple-text-condition (condition)
• error (condition)

Direct subclasses

mapped-index-error (condition)

Direct methods

mapped-file-of (method)

Direct slots

Slot: mapped-file

The mapped file where the error occurred.

Initargs

:mapped-file

Readers

mapped-file-of (generic function)

Condition: mapped-index-error ()

An error that is raised during an index operation on a mmapped file.

Package

uk.co.deoxybyte-unix

Source

conditions.lisp (file)

Direct superclasses

mapped-file-error (condition)

Direct methods

index-of (method)

Direct slots

Slot: index

The index that caused the error.

Initargs

:index

Initform

(quote nil)

Readers

index-of (generic function)

6.1.6 Structures

Structure: mmap-area ()

An aggregate of data used to describe an mmap operation.

- fr: The mmap file descriptor.
- type: The foreign type in the file being mmapped.
- size: The size in bytes of the region mmapped.
- ptr: The CFFI pointer returned by the mmap foreign function.
- livep: A boolean value which is T if the file is currently mmapped, or NIL otherwise.

Package

uk.co.deoxybyte-unix

Source

memory-map.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: fd

Type

fixnum

Initform

0

Readers

mmap-area-fd (function)

Writers

(setf mmap-area-fd) (function)

Slot: type

Type

symbol

Initform

:char

Readers

mmap-area-type (function)

Writers

(setf mmap-area-type) (function)

Slot: size

Type

fixnum

Initform

0

Readers

mmap-area-size (function)

Writers

(setf mmap-area-size) (function)

Slot: ptr

Readers

mmap-area-ptr (function)

Writers

(setf mmap-area-ptr) (function)

Slot: live-p

Type

boolean

Readers

mmap-area-live-p (function)

Writers

(setf mmap-area-live-p) (function)

6.1.7 Classes

Class: mapped-file ()

Package

uk.co.deoxybyte-unix

Source

memory-map.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

mapped-vector (class)

Direct methods

• munmap (method)
• in-memory-p (method)
• print-object (method)
• length-of (method)
• delete-policy-of (method)
• filespec-of (method)

Direct slots

Slot: filespec

A user-supplied pathname designator for
the file to be mmapped, or NIL an automatically generated tmp file is to be used.

Initargs

:filespec

Readers

filespec-of (generic function)

Slot: delete-policy

A flag to indicate whether the file
designated in the FILESPEC slot is to be deleted automatically when the mmapped file is freed. If an automatically generated tmp is to be used, the value of this slot is set to T.

Initargs

:delete

Readers

delete-policy-of (generic function)

Slot: length

The length of the Lisp vector created when the file is mmapped.

Initargs

:length

Initform

(error "a length argument is required.")

Readers

length-of (generic function)

Slot: mmap-area

The mmap-area. This slot symbol is
exported to allow direct access without method dispatch. This is significantly faster, at least on SBCL.

Initargs

:mmap-area

Class: mapped-vector ()

A vector backed by a mapped file.

Package

uk.co.deoxybyte-unix

Source

memory-map.lisp (file)

Direct superclasses

mapped-file (class)

Direct subclasses

• mapped-vector-char (class)
• mapped-vector-uchar (class)
• mapped-vector-short (class)
• mapped-vector-ushort (class)
• mapped-vector-int (class)
• mapped-vector-uint (class)
• mapped-vector-float (class)
• mapped-vector-double (class)
• mapped-vector-int16 (class)
• mapped-vector-uint16 (class)
• mapped-vector-int32 (class)
• mapped-vector-uint32 (class)

Direct methods

• mref (method)
• mref (method)
• free-mapped-vector (method)
• print-object (method)

Class: mapped-vector-char ()

A mapped vector of CHAR.

Package

uk.co.deoxybyte-unix

Source

memory-map.lisp (file)

Direct superclasses

mapped-vector (class)

Direct methods

• mref (method)
• mref (method)
• initialize-instance (method)

Class: mapped-vector-double ()

A mapped vector of DOUBLE.

Package

uk.co.deoxybyte-unix

Source

memory-map.lisp (file)

Direct superclasses

mapped-vector (class)

Direct methods

• mref (method)
• mref (method)
• initialize-instance (method)

Class: mapped-vector-float ()

A mapped vector of FLOAT.

Package

uk.co.deoxybyte-unix

Source

memory-map.lisp (file)

Direct superclasses

mapped-vector (class)

Direct methods

• mref (method)
• mref (method)
• initialize-instance (method)

Class: mapped-vector-int ()

A mapped vector of INT.

Package

uk.co.deoxybyte-unix

Source

memory-map.lisp (file)

Direct superclasses

mapped-vector (class)

Direct methods

• mref (method)
• mref (method)
• initialize-instance (method)

Class: mapped-vector-int16 ()

A mapped vector of INT16.

Package

uk.co.deoxybyte-unix

Source

memory-map.lisp (file)

Direct superclasses

mapped-vector (class)

Direct methods

• mref (method)
• mref (method)
• initialize-instance (method)

Class: mapped-vector-int32 ()

A mapped vector of INT32.

Package

uk.co.deoxybyte-unix

Source

memory-map.lisp (file)

Direct superclasses

mapped-vector (class)

Direct methods

• mref (method)
• mref (method)
• initialize-instance (method)

Class: mapped-vector-short ()

A mapped vector of SHORT.

Package

uk.co.deoxybyte-unix

Source

memory-map.lisp (file)

Direct superclasses

mapped-vector (class)

Direct methods

• mref (method)
• mref (method)
• initialize-instance (method)

Class: mapped-vector-uchar ()

A mapped vector of UNSIGNED-CHAR.

Package

uk.co.deoxybyte-unix

Source

memory-map.lisp (file)

Direct superclasses

mapped-vector (class)

Direct methods

• mref (method)
• mref (method)
• initialize-instance (method)

Class: mapped-vector-uint ()

A mapped vector of UNSIGNED-INT.

Package

uk.co.deoxybyte-unix

Source

memory-map.lisp (file)

Direct superclasses

mapped-vector (class)

Direct methods

• mref (method)
• mref (method)
• initialize-instance (method)

Class: mapped-vector-uint16 ()

A mapped vector of UINT16.

Package

uk.co.deoxybyte-unix

Source

memory-map.lisp (file)

Direct superclasses

mapped-vector (class)

Direct methods

• mref (method)
• mref (method)
• initialize-instance (method)

Class: mapped-vector-uint32 ()

A mapped vector of UINT32.

Package

uk.co.deoxybyte-unix

Source

memory-map.lisp (file)

Direct superclasses

mapped-vector (class)

Direct methods

• mref (method)
• mref (method)
• initialize-instance (method)

Class: mapped-vector-ushort ()

A mapped vector of UNSIGNED-SHORT.

Package

uk.co.deoxybyte-unix

Source

memory-map.lisp (file)

Direct superclasses

mapped-vector (class)

Direct methods

• mref (method)
• mref (method)
• initialize-instance (method)

6.2 Internal definitions

6.2.1 Functions

Function: %var-accessor-*c-error-number* ()

Function: (setf %var-accessor-*c-error-number*) VALUE

Package

uk.co.deoxybyte-unix-ffi

Source

deoxybyte-unix-ffi.lisp (file)

Function: %vector-bounds-check VECTOR INDEX

Performs a bounds check on INDEX with respect to LENGTH. Returns T if 0 <= INDEX < LENGTH, or raises an error otherwise.

Package

uk.co.deoxybyte-unix

Source

memory-map.lisp (file)

Function: copy-mmap-area INSTANCE

Package

uk.co.deoxybyte-unix

Source

memory-map.lisp (file)

Function: enlarge-file FD FSIZE

Enlarges the open file designated by Unix file descriptor FD to FSIZE bytes.

Package

uk.co.deoxybyte-unix

Source

memory-map.lisp (file)

Function: make-mmap-area &key (FD FD) (TYPE TYPE) (SIZE SIZE) (PTR PTR) (LIVE-P LIVE-P)

Package

uk.co.deoxybyte-unix

Source

memory-map.lisp (file)

Function: mmap-area-p OBJECT

Package

uk.co.deoxybyte-unix

Source

memory-map.lisp (file)

Function: unix-tmpfile-template ()

Returns a new temporary file template string suitable for the C mkstemp function. The template is merged with *default-tmpfile-defaults* to supply the directory component.

Package

uk.co.deoxybyte-unix

Source

memory-map.lisp (file)

6.2.2 Generic functions

Generic Function: index-of CONDITION

Package

uk.co.deoxybyte-unix

Methods

Method: index-of (CONDITION mapped-index-error)

Source

conditions.lisp (file)

Generic Function: mapped-file-of CONDITION

Package

uk.co.deoxybyte-unix

Methods

Method: mapped-file-of (CONDITION mapped-file-error)

Source

conditions.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types