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 3.0 "Montgomery Scott"
on Mon Apr 19 15:53:57 2021 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
-
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
-
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
-
- Internal Definitions
-
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
-
- Internal Definitions
-
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
-
- Internal Definitions
-
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
-
- Use List
-
- Exported Definitions
-
- Internal Definitions
-
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
-
- Used By List
uk.co.deoxybyte-unix
- Exported Definitions
-
- Internal Definitions
-
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
-
- 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
-
- Direct methods
-
- 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
| Index Entry | | Section |
|
D | | |
| deoxybyte-unix.asd: | | The deoxybyte-unix․asd file |
| deoxybyte-unix/deoxybyte-unix: | | The deoxybyte-unix/deoxybyte-unix module |
| deoxybyte-unix/deoxybyte-unix/conditions.lisp: | | The deoxybyte-unix/deoxybyte-unix/conditions․lisp file |
| deoxybyte-unix/deoxybyte-unix/deoxybyte-unix-ffi.lisp: | | The deoxybyte-unix/deoxybyte-unix/deoxybyte-unix-ffi․lisp file |
| deoxybyte-unix/deoxybyte-unix/deoxybyte-unix.lisp: | | The deoxybyte-unix/deoxybyte-unix/deoxybyte-unix․lisp file |
| deoxybyte-unix/deoxybyte-unix/memory-map.lisp: | | The deoxybyte-unix/deoxybyte-unix/memory-map․lisp file |
| deoxybyte-unix/deoxybyte-unix/package.lisp: | | The deoxybyte-unix/deoxybyte-unix/package․lisp file |
| deoxybyte-unix/deoxybyte-unix/sbcl.lisp: | | The deoxybyte-unix/deoxybyte-unix/sbcl․lisp file |
|
F | | |
| File, Lisp, deoxybyte-unix.asd: | | The deoxybyte-unix․asd file |
| File, Lisp, deoxybyte-unix/deoxybyte-unix/conditions.lisp: | | The deoxybyte-unix/deoxybyte-unix/conditions․lisp file |
| File, Lisp, deoxybyte-unix/deoxybyte-unix/deoxybyte-unix-ffi.lisp: | | The deoxybyte-unix/deoxybyte-unix/deoxybyte-unix-ffi․lisp file |
| File, Lisp, deoxybyte-unix/deoxybyte-unix/deoxybyte-unix.lisp: | | The deoxybyte-unix/deoxybyte-unix/deoxybyte-unix․lisp file |
| File, Lisp, deoxybyte-unix/deoxybyte-unix/memory-map.lisp: | | The deoxybyte-unix/deoxybyte-unix/memory-map․lisp file |
| File, Lisp, deoxybyte-unix/deoxybyte-unix/package.lisp: | | The deoxybyte-unix/deoxybyte-unix/package․lisp file |
| File, Lisp, deoxybyte-unix/deoxybyte-unix/sbcl.lisp: | | The deoxybyte-unix/deoxybyte-unix/sbcl․lisp file |
|
L | | |
| Lisp File, deoxybyte-unix.asd: | | The deoxybyte-unix․asd file |
| Lisp File, deoxybyte-unix/deoxybyte-unix/conditions.lisp: | | The deoxybyte-unix/deoxybyte-unix/conditions․lisp file |
| Lisp File, deoxybyte-unix/deoxybyte-unix/deoxybyte-unix-ffi.lisp: | | The deoxybyte-unix/deoxybyte-unix/deoxybyte-unix-ffi․lisp file |
| Lisp File, deoxybyte-unix/deoxybyte-unix/deoxybyte-unix.lisp: | | The deoxybyte-unix/deoxybyte-unix/deoxybyte-unix․lisp file |
| Lisp File, deoxybyte-unix/deoxybyte-unix/memory-map.lisp: | | The deoxybyte-unix/deoxybyte-unix/memory-map․lisp file |
| Lisp File, deoxybyte-unix/deoxybyte-unix/package.lisp: | | The deoxybyte-unix/deoxybyte-unix/package․lisp file |
| Lisp File, deoxybyte-unix/deoxybyte-unix/sbcl.lisp: | | The deoxybyte-unix/deoxybyte-unix/sbcl․lisp file |
|
M | | |
| Module, deoxybyte-unix/deoxybyte-unix: | | The deoxybyte-unix/deoxybyte-unix module |
|
A.2 Functions
| Index Entry | | Section |
|
% | | |
| %var-accessor-*c-error-number* : | | Internal functions |
| %vector-bounds-check : | | Internal functions |
|
( | | |
| (setf %var-accessor-*c-error-number*) : | | Internal functions |
| (setf mmap-area-fd) : | | Exported functions |
| (setf mmap-area-live-p) : | | Exported functions |
| (setf mmap-area-ptr) : | | Exported functions |
| (setf mmap-area-size) : | | Exported functions |
| (setf mmap-area-type) : | | Exported functions |
| (setf mref) : | | Exported generic functions |
| (setf mref) : | | Exported generic functions |
| (setf mref) : | | Exported generic functions |
| (setf mref) : | | Exported generic functions |
| (setf mref) : | | Exported generic functions |
| (setf mref) : | | Exported generic functions |
| (setf mref) : | | Exported generic functions |
| (setf mref) : | | Exported generic functions |
| (setf mref) : | | Exported generic functions |
| (setf mref) : | | Exported generic functions |
| (setf mref) : | | Exported generic functions |
| (setf mref) : | | Exported generic functions |
| (setf mref) : | | Exported generic functions |
| (setf mref) : | | Exported generic functions |
|
C | | |
| c-close : | | Exported functions |
| c-fileno : | | Exported functions |
| c-lseek : | | Exported functions |
| c-mkstemp : | | Exported functions |
| c-mmap : | | Exported functions |
| c-munmap : | | Exported functions |
| c-open : | | Exported functions |
| c-strerror : | | Exported functions |
| c-sysconf : | | Exported functions |
| c-write : | | Exported functions |
| copy-mmap-area : | | Internal functions |
|
D | | |
| define-mapped-vector : | | Exported macros |
| delete-policy-of : | | Exported generic functions |
| delete-policy-of : | | Exported generic functions |
|
E | | |
| enlarge-file : | | Internal functions |
|
F | | |
| file-descriptor : | | Exported functions |
| filespec-of : | | Exported generic functions |
| filespec-of : | | Exported generic functions |
| free-mapped-vector : | | Exported generic functions |
| free-mapped-vector : | | Exported generic functions |
| Function, %var-accessor-*c-error-number* : | | Internal functions |
| Function, %vector-bounds-check : | | Internal functions |
| Function, (setf %var-accessor-*c-error-number*) : | | Internal functions |
| Function, (setf mmap-area-fd) : | | Exported functions |
| Function, (setf mmap-area-live-p) : | | Exported functions |
| Function, (setf mmap-area-ptr) : | | Exported functions |
| Function, (setf mmap-area-size) : | | Exported functions |
| Function, (setf mmap-area-type) : | | Exported functions |
| Function, c-close : | | Exported functions |
| Function, c-fileno : | | Exported functions |
| Function, c-lseek : | | Exported functions |
| Function, c-mkstemp : | | Exported functions |
| Function, c-mmap : | | Exported functions |
| Function, c-munmap : | | Exported functions |
| Function, c-open : | | Exported functions |
| Function, c-strerror : | | Exported functions |
| Function, c-sysconf : | | Exported functions |
| Function, c-write : | | Exported functions |
| Function, copy-mmap-area : | | Internal functions |
| Function, enlarge-file : | | Internal functions |
| Function, file-descriptor : | | Exported functions |
| Function, make-mmap-area : | | Internal functions |
| Function, maybe-standard-stream : | | Exported functions |
| Function, mmap : | | Exported functions |
| Function, mmap-area-fd : | | Exported functions |
| Function, mmap-area-live-p : | | Exported functions |
| Function, mmap-area-p : | | Internal functions |
| Function, mmap-area-ptr : | | Exported functions |
| Function, mmap-area-size : | | Exported functions |
| Function, mmap-area-type : | | Exported functions |
| Function, unix-tmpfile-template : | | Internal functions |
|
G | | |
| Generic Function, (setf mref) : | | Exported generic functions |
| Generic Function, delete-policy-of : | | Exported generic functions |
| Generic Function, filespec-of : | | Exported generic functions |
| Generic Function, free-mapped-vector : | | Exported generic functions |
| Generic Function, in-memory-p : | | Exported generic functions |
| Generic Function, index-of : | | Internal generic functions |
| Generic Function, length-of : | | Exported generic functions |
| Generic Function, mapped-file-of : | | Internal generic functions |
| Generic Function, mref : | | Exported generic functions |
| Generic Function, munmap : | | Exported generic functions |
|
I | | |
| in-memory-p : | | Exported generic functions |
| in-memory-p : | | Exported generic functions |
| index-of : | | Internal generic functions |
| index-of : | | Internal generic functions |
|
L | | |
| length-of : | | Exported generic functions |
| length-of : | | Exported generic functions |
|
M | | |
| Macro, define-mapped-vector : | | Exported macros |
| Macro, with-mapped-vector : | | Exported macros |
| make-mmap-area : | | Internal functions |
| mapped-file-of : | | Internal generic functions |
| mapped-file-of : | | Internal generic functions |
| maybe-standard-stream : | | Exported functions |
| Method, (setf mref) : | | Exported generic functions |
| Method, (setf mref) : | | Exported generic functions |
| Method, (setf mref) : | | Exported generic functions |
| Method, (setf mref) : | | Exported generic functions |
| Method, (setf mref) : | | Exported generic functions |
| Method, (setf mref) : | | Exported generic functions |
| Method, (setf mref) : | | Exported generic functions |
| Method, (setf mref) : | | Exported generic functions |
| Method, (setf mref) : | | Exported generic functions |
| Method, (setf mref) : | | Exported generic functions |
| Method, (setf mref) : | | Exported generic functions |
| Method, (setf mref) : | | Exported generic functions |
| Method, (setf mref) : | | Exported generic functions |
| Method, delete-policy-of : | | Exported generic functions |
| Method, filespec-of : | | Exported generic functions |
| Method, free-mapped-vector : | | Exported generic functions |
| Method, in-memory-p : | | Exported generic functions |
| Method, index-of : | | Internal generic functions |
| Method, length-of : | | Exported generic functions |
| Method, mapped-file-of : | | Internal generic functions |
| Method, mref : | | Exported generic functions |
| Method, mref : | | Exported generic functions |
| Method, mref : | | Exported generic functions |
| Method, mref : | | Exported generic functions |
| Method, mref : | | Exported generic functions |
| Method, mref : | | Exported generic functions |
| Method, mref : | | Exported generic functions |
| Method, mref : | | Exported generic functions |
| Method, mref : | | Exported generic functions |
| Method, mref : | | Exported generic functions |
| Method, mref : | | Exported generic functions |
| Method, mref : | | Exported generic functions |
| Method, mref : | | Exported generic functions |
| Method, munmap : | | Exported generic functions |
| mmap : | | Exported functions |
| mmap-area-fd : | | Exported functions |
| mmap-area-live-p : | | Exported functions |
| mmap-area-p : | | Internal functions |
| mmap-area-ptr : | | Exported functions |
| mmap-area-size : | | Exported functions |
| mmap-area-type : | | Exported functions |
| mref : | | Exported generic functions |
| mref : | | Exported generic functions |
| mref : | | Exported generic functions |
| mref : | | Exported generic functions |
| mref : | | Exported generic functions |
| mref : | | Exported generic functions |
| mref : | | Exported generic functions |
| mref : | | Exported generic functions |
| mref : | | Exported generic functions |
| mref : | | Exported generic functions |
| mref : | | Exported generic functions |
| mref : | | Exported generic functions |
| mref : | | Exported generic functions |
| mref : | | Exported generic functions |
| munmap : | | Exported generic functions |
| munmap : | | Exported generic functions |
|
U | | |
| unix-tmpfile-template : | | Internal functions |
|
W | | |
| with-mapped-vector : | | Exported macros |
|
A.3 Variables
| Index Entry | | Section |
|
* | | |
| *c-error-number* : | | Exported symbol macros |
|
D | | |
| delete-policy : | | Exported classes |
|
F | | |
| fd : | | Exported structures |
| filespec : | | Exported classes |
|
I | | |
| index : | | Exported conditions |
|
L | | |
| length : | | Exported classes |
| live-p : | | Exported structures |
|
M | | |
| mapped-file : | | Exported conditions |
| mmap-area : | | Exported classes |
|
P | | |
| ptr : | | Exported structures |
|
S | | |
| size : | | Exported structures |
| Slot, delete-policy : | | Exported classes |
| Slot, fd : | | Exported structures |
| Slot, filespec : | | Exported classes |
| Slot, index : | | Exported conditions |
| Slot, length : | | Exported classes |
| Slot, live-p : | | Exported structures |
| Slot, mapped-file : | | Exported conditions |
| Slot, mmap-area : | | Exported classes |
| Slot, ptr : | | Exported structures |
| Slot, size : | | Exported structures |
| Slot, type : | | Exported structures |
| Symbol Macro, *c-error-number* : | | Exported symbol macros |
|
T | | |
| type : | | Exported structures |
|
A.4 Data types
| Index Entry | | Section |
|
C | | |
| Class, mapped-file : | | Exported classes |
| Class, mapped-vector : | | Exported classes |
| Class, mapped-vector-char : | | Exported classes |
| Class, mapped-vector-double : | | Exported classes |
| Class, mapped-vector-float : | | Exported classes |
| Class, mapped-vector-int : | | Exported classes |
| Class, mapped-vector-int16 : | | Exported classes |
| Class, mapped-vector-int32 : | | Exported classes |
| Class, mapped-vector-short : | | Exported classes |
| Class, mapped-vector-uchar : | | Exported classes |
| Class, mapped-vector-uint : | | Exported classes |
| Class, mapped-vector-uint16 : | | Exported classes |
| Class, mapped-vector-uint32 : | | Exported classes |
| Class, mapped-vector-ushort : | | Exported classes |
| Condition, mapped-file-error : | | Exported conditions |
| Condition, mapped-index-error : | | Exported conditions |
|
D | | |
| deoxybyte-unix : | | The deoxybyte-unix system |
|
M | | |
| mapped-file : | | Exported classes |
| mapped-file-error : | | Exported conditions |
| mapped-index-error : | | Exported conditions |
| mapped-vector : | | Exported classes |
| mapped-vector-char : | | Exported classes |
| mapped-vector-double : | | Exported classes |
| mapped-vector-float : | | Exported classes |
| mapped-vector-int : | | Exported classes |
| mapped-vector-int16 : | | Exported classes |
| mapped-vector-int32 : | | Exported classes |
| mapped-vector-short : | | Exported classes |
| mapped-vector-uchar : | | Exported classes |
| mapped-vector-uint : | | Exported classes |
| mapped-vector-uint16 : | | Exported classes |
| mapped-vector-uint32 : | | Exported classes |
| mapped-vector-ushort : | | Exported classes |
| mmap-area : | | Exported structures |
|
P | | |
| Package, uk.co.deoxybyte-unix : | | The uk․co․deoxybyte-unix package |
| Package, uk.co.deoxybyte-unix-ffi : | | The uk․co․deoxybyte-unix-ffi package |
|
S | | |
| Structure, mmap-area : | | Exported structures |
| System, deoxybyte-unix : | | The deoxybyte-unix system |
|
U | | |
| uk.co.deoxybyte-unix : | | The uk․co․deoxybyte-unix package |
| uk.co.deoxybyte-unix-ffi : | | The uk․co․deoxybyte-unix-ffi package |
|