The memory-regions Reference Manual

This is the memory-regions Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 06:13:52 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 memory-regions

Implementation of a memory region abstraction

Maintainer

Yukari Hafner <>

Author

Yukari Hafner <>

Home Page

https://shinmera.github.io/memory-regions/

Source Control

(GIT https://github.com/shinmera/memory-regions.git)

Bug Tracker

https://github.com/shinmera/memory-regions/issues

License

zlib

Version

1.0.0

Dependencies
Source

memory-regions.asd.


2.2 memory-regions/region

Maintainer

Yukari Hafner <>

Author

Yukari Hafner <>

Home Page

https://shinmera.github.io/memory-regions/

Source Control

(GIT https://github.com/shinmera/memory-regions.git)

Bug Tracker

https://github.com/shinmera/memory-regions/issues

License

zlib

Dependencies
  • cffi (system).
  • documentation-utils (system).
Source

memory-regions.asd.

Child Components

2.3 memory-regions/allocator

Maintainer

Yukari Hafner <>

Author

Yukari Hafner <>

Home Page

https://shinmera.github.io/memory-regions/

Source Control

(GIT https://github.com/shinmera/memory-regions.git)

Bug Tracker

https://github.com/shinmera/memory-regions/issues

License

zlib

Dependency

memory-regions/region (system).

Source

memory-regions.asd.

Child Components

2.4 memory-regions/sequence

Maintainer

Yukari Hafner <>

Author

Yukari Hafner <>

Home Page

https://shinmera.github.io/memory-regions/

Source Control

(GIT https://github.com/shinmera/memory-regions.git)

Bug Tracker

https://github.com/shinmera/memory-regions/issues

License

zlib

Dependencies
Source

memory-regions.asd.

Child Component

sequence.lisp (file).


2.5 memory-regions/stream

Maintainer

Yukari Hafner <>

Author

Yukari Hafner <>

Home Page

https://shinmera.github.io/memory-regions/

Source Control

(GIT https://github.com/shinmera/memory-regions.git)

Bug Tracker

https://github.com/shinmera/memory-regions/issues

License

zlib

Dependencies
Source

memory-regions.asd.

Child Component

stream.lisp (file).


2.6 memory-regions/object

Maintainer

Yukari Hafner <>

Author

Yukari Hafner <>

Home Page

https://shinmera.github.io/memory-regions/

Source Control

(GIT https://github.com/shinmera/memory-regions.git)

Bug Tracker

https://github.com/shinmera/memory-regions/issues

License

zlib

Dependencies
Source

memory-regions.asd.

Child Component

object.lisp (file).


2.7 memory-regions/pathname

Maintainer

Yukari Hafner <>

Author

Yukari Hafner <>

Home Page

https://shinmera.github.io/memory-regions/

Source Control

(GIT https://github.com/shinmera/memory-regions.git)

Bug Tracker

https://github.com/shinmera/memory-regions/issues

License

zlib

Dependencies
Source

memory-regions.asd.

Child Component

pathname.lisp (file).


3 Files

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


3.1 Lisp


3.1.2 memory-regions/region/package.lisp

Source

memory-regions.asd.

Parent Component

memory-regions/region (system).

Packages

org.shirakumo.memory-regions.


3.1.3 memory-regions/region/toolkit.lisp

Dependency

package.lisp (file).

Source

memory-regions.asd.

Parent Component

memory-regions/region (system).

Public Interface

with-pointer-to-array-data (macro).

Internals

3.1.4 memory-regions/region/memory-region.lisp

Dependency

toolkit.lisp (file).

Source

memory-regions.asd.

Parent Component

memory-regions/region (system).

Public Interface
Internals

3.1.5 memory-regions/region/allocator.lisp

Dependency

memory-region.lisp (file).

Source

memory-regions.asd.

Parent Component

memory-regions/region (system).

Public Interface

3.1.6 memory-regions/region/documentation.lisp

Dependency

allocator.lisp (file).

Source

memory-regions.asd.

Parent Component

memory-regions/region (system).


3.1.7 memory-regions/allocator/null-allocator.lisp

Source

memory-regions.asd.

Parent Component

memory-regions/allocator (system).

Public Interface

3.1.8 memory-regions/allocator/bump-allocator.lisp

Dependency

null-allocator.lisp (file).

Source

memory-regions.asd.

Parent Component

memory-regions/allocator (system).

Public Interface
Internals

3.1.9 memory-regions/allocator/documentation.lisp

Dependency

bump-allocator.lisp (file).

Source

memory-regions.asd.

Parent Component

memory-regions/allocator (system).


3.1.10 memory-regions/sequence/sequence.lisp

Source

memory-regions.asd.

Parent Component

memory-regions/sequence (system).

Public Interface
Internals

3.1.11 memory-regions/stream/stream.lisp

Source

memory-regions.asd.

Parent Component

memory-regions/stream (system).

Public Interface
Internals

3.1.12 memory-regions/object/object.lisp

Source

memory-regions.asd.

Parent Component

memory-regions/object (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 org.shirakumo.memory-regions

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Special variables

Special Variable: *allocator*

Holds the default allocator used for allocation operations.

See WITH-ARENA
See ALLOCATOR (type)

Package

org.shirakumo.memory-regions.

Source

allocator.lisp.

Special Variable: *standard-allocator*

Holds the class name of the default allocator used for new arenas.

See WITH-ARENA
See ALLOCATOR (type)

Package

org.shirakumo.memory-regions.

Source

allocator.lisp.


5.1.2 Macros

Macro: with-arena ((size &optional type &rest args) &body body)

Executes body with an arena allocator bound.

Any memory-regions allocated by the allocator may only be referenced within the dynamic-extent of the BODY. Attempting to do so outside of that dynamic-extent leads to undefined behaviour.

As much as possible the arena will be stack-allocated.

See *STANDARD-ALLOCATOR*
See *ALLOCATOR*
See ALLOCATOR (type)

Package

org.shirakumo.memory-regions.

Source

allocator.lisp.

Macro: with-memory-region ((region data/size &rest args) &body body)

Convenience macro to dynamically create a memory region.

If the source is a positive fixnum constant, the memory area is allocated directly on the stack.

See CALL-WITH-MEMORY-REGION

Package

org.shirakumo.memory-regions.

Source

memory-region.lisp.

Macro: with-pointer-to-array-data ((ptr data &key direction) &body body)

Provides a foreign pointer to the array contents.

DIRECTION must be one of:
:INPUT — The data is only read
:OUTPUT — The data is only written
:IO — The data is both read and written

As much as possible the provided pointer will literally point to the array’s in-memory representation. When this is not possible, a foreign memory area is used instead, and the data is transferred as informed by the DIRECTION argument.

Package

org.shirakumo.memory-regions.

Source

toolkit.lisp.


5.1.3 Ordinary functions

Function: memory-region (pointer size)
Package

org.shirakumo.memory-regions.

Source

memory-region.lisp.

Reader: memory-region-pointer (instance)

Returns the pointer to the memory region.

See MEMORY-REGION (type)

Package

org.shirakumo.memory-regions.

Source

memory-region.lisp.

Target Slot

pointer.

Writer: (setf memory-region-pointer) (instance)
Package

org.shirakumo.memory-regions.

Source

memory-region.lisp.

Target Slot

pointer.

Reader: memory-region-size (instance)

Returns the number of octets the memory region encompasses.

See MEMORY-REGION (type)

Package

org.shirakumo.memory-regions.

Source

memory-region.lisp.

Target Slot

size.

Writer: (setf memory-region-size) (instance)
Package

org.shirakumo.memory-regions.

Source

memory-region.lisp.

Target Slot

size.

Function: memory-region-valid-p (region)

Returns true if the memory region is valid and may be accessed.

See MEMORY-REGION (type)

Package

org.shirakumo.memory-regions.

Source

memory-region.lisp.


5.1.4 Generic functions

Generic Function: allocate (allocator size)

Allocate a new memory-region.

The allocator may provide a region that is bigger than the requested size, but not smaller. If the allocator would have to shrink the region to provide the block of memory, an error of type BLOCK-TOO-BIG must be signalled, instead. If the allocator cannot allocate the requested amount of memory at all, an error of type OUT-OF-MEMORY is signalled, instead.

The data pointed to by the returned region is *NOT* guaranteed to have been cleared out and may contain random non-zero data.

SIZE must be a positive fixnum.

See MEMORY-REGION (type)
See ALLOCATOR (type)
See BLOCK-TOO-BIG (type)
See OUT-OF-MEMORY (type)

Package

org.shirakumo.memory-regions.

Source

allocator.lisp.

Methods
Method: allocate ((allocator bump-allocator) size)
Source

bump-allocator.lisp.

Method: allocate ((allocator null) size)
Source

null-allocator.lisp.

Method: allocate ((allocator (eql t)) size)
Generic Reader: allocator (condition)

Returns the allocator related to the condition.

See ALLOCATOR-ERROR

Package

org.shirakumo.memory-regions.

Methods
Reader Method: allocator ((condition allocator-condition))
Source

allocator.lisp.

Target Slot

allocator.

Generic Function: call-with-memory-region (function data &key start offset direction size &allow-other-keys)

Calls the function with the argument coerced to a memory region.

The passed memory region is only valid within the dynamic extent of the function call, and may not be accessed outside of it.

You may pass OFFSET to provide a starting offset into the resulting memory region, as well as potentially other arguments depending on the source.

If a CFFI:FOREIGN-POINTER is passed as the source, you must also pass a SIZE argument to provide the memory region’s extents.

See MEMORY-REGION (type)
See TO-MEMORY-REGION
See WITH-MEMORY-REGION

Package

org.shirakumo.memory-regions.

Source

memory-region.lisp.

Methods
Method: call-with-memory-region (function (data pathname) &key offset)
Source

pathname.lisp.

Method: call-with-memory-region ((function function) (region memory-region-ish) &key start)
Method: call-with-memory-region ((function function) (data array) &key start direction)
Method: call-with-memory-region ((function function) pointer &key size start)
Method: call-with-memory-region ((function function) (size integer) &key start)
Method: call-with-memory-region ((function function) (null null) &key start)
Method: call-with-memory-region ((function function) (region memory-region) &key start)
Generic Function: clear (region)

Clears the memory region and fills it with zeroes.

See MEMORY-REGION (type)
See MEMORY-REGION-ISH (type)

Package

org.shirakumo.memory-regions.

Source

memory-region.lisp.

Methods
Method: clear ((allocator bump-allocator))
Source

bump-allocator.lisp.

Method: clear (dst)
Method: clear ((region memory-region))
Generic Function: deallocate (allocator region)

Free a previously allocated memory-region.

The passed memory region must have been provided by a call to ALLOCATE of the same allocator. Passing unrelated region objects will lead to undefined behaviour.

The returned memory region will no longer be valid. Passing in an invalid region has no effect.

If you pass NIL as the memory region, the allocator itself will be deallocated, after which it must not be used again.

See MEMORY-REGION (type)
See ALLOCATOR (type)
See MEMORY-REGION-VALID-P
See ALLOCATE

Package

org.shirakumo.memory-regions.

Source

allocator.lisp.

Methods
Method: deallocate ((allocator null) (region stream-memory-region))
Source

pathname.lisp.

Method: deallocate ((allocator null) (region mmap-memory-region))
Source

pathname.lisp.

Method: deallocate ((allocator bump-allocator) (region memory-region))
Source

bump-allocator.lisp.

Method: deallocate ((allocator bump-allocator) (self null))
Source

bump-allocator.lisp.

Method: deallocate ((allocator null) (region memory-region))
Source

null-allocator.lisp.

Method: deallocate ((allocator (eql t)) region)
Generic Function: end (region)

Returns a pointer to the end of the memory region.

See MEMORY-REGION (type)
See MEMORY-REGION-ISH (type)

Package

org.shirakumo.memory-regions.

Source

memory-region.lisp.

Methods
Method: end (region)
Generic Function: fill (dst byte)

Fills the memory region with a specific octet.

See MEMORY-REGION (type)
See MEMORY-REGION-ISH (type)

Package

org.shirakumo.memory-regions.

Source

memory-region.lisp.

Methods
Method: fill (dst byte)
Method: fill ((region memory-region) byte)
Generic Function: free-space (allocator)

Returns the remaining number of octets the allocator can distribute to memory-regions.

See ALLOCATOR (type)

Package

org.shirakumo.memory-regions.

Source

allocator.lisp.

Methods
Method: free-space ((allocator (eql t)))
Method: free-space ((allocator allocator))
Generic Function: maximum-block-size (allocator)

Returns the maximal size a memory-region can have under this allocator.

See ALLOCATOR (type)

Package

org.shirakumo.memory-regions.

Source

allocator.lisp.

Methods
Method: maximum-block-size ((allocator null))
Source

null-allocator.lisp.

Method: maximum-block-size ((allocator (eql t)))
Method: maximum-block-size ((allocator allocator))
Generic Function: minimum-block-size (allocator)

Returns the minimal size of an allocated memory-region.

See ALLOCATOR (type)

Package

org.shirakumo.memory-regions.

Source

allocator.lisp.

Methods
Method: minimum-block-size ((allocator null))
Source

null-allocator.lisp.

Method: minimum-block-size ((allocator (eql t)))
Method: minimum-block-size ((allocator allocator))
Generic Function: reallocate (allocator region new-size)

Resizes a previously allocated memory-region.

The passed memory region must have been provided by a call to ALLOCATE of the same allocator. Passing unrelated region objects will lead to undefined behaviour.

The memory region’s pointer and size are modified in-place, if the reallocation is successful, and the data pointed to will be preserved. If the region’s size is increased, octets beyond the previous size are *NOT* guaranteed to have been cleared and may contain random non-zero data.

The same constraints and error behaviour as for ALLOCATE apply.

See MEMORY-REGION (type)
See ALLOCATOR (type)
See ALLOCATE

Package

org.shirakumo.memory-regions.

Source

allocator.lisp.

Methods
Method: reallocate ((allocator bump-allocator) (region memory-region) new-size)
Source

bump-allocator.lisp.

Method: reallocate ((allocator null) (region memory-region) new-size)
Source

null-allocator.lisp.

Method: reallocate ((allocator (eql t)) region new-size)
Generic Function: replace (dst src &key start1 end1 start2 end2)

Replaces the memory region’s contents with that of another.

See MEMORY-REGION (type)
See MEMORY-REGION-ISH (type)

Package

org.shirakumo.memory-regions.

Source

memory-region.lisp.

Methods
Method: replace (dst src &rest args)
Method: replace ((dst memory-region) (src memory-region) &key start1 end1 start2 end2)
Generic Function: size (region)

Returns the number of octets represented by the memory region.

See MEMORY-REGION (type)
See MEMORY-REGION-ISH (type)

Package

org.shirakumo.memory-regions.

Source

memory-region.lisp.

Methods
Reader Method: size ((memory-region-object memory-region-object))

automatically generated reader method

Source

object.lisp.

Target Slot

size.

Reader Method: size ((memory-region-stream memory-region-stream))

automatically generated reader method

Source

stream.lisp.

Target Slot

size.

Method: size ((sequence memory-region-sequence))
Source

sequence.lisp.

Reader Method: size ((bump-allocator bump-allocator))

automatically generated reader method

Source

bump-allocator.lisp.

Target Slot

size.

Reader Method: size ((condition block-too-big))
Source

allocator.lisp.

Target Slot

size.

Method: size ((region memory-region))
Generic Writer: (setf size) (object)
Package

org.shirakumo.memory-regions.

Methods
Writer Method: (setf size) ((memory-region-object memory-region-object))

automatically generated writer method

Source

object.lisp.

Target Slot

size.

Writer Method: (setf size) ((memory-region-stream memory-region-stream))

automatically generated writer method

Source

stream.lisp.

Target Slot

size.

Writer Method: (setf size) ((bump-allocator bump-allocator))

automatically generated writer method

Source

bump-allocator.lisp.

Target Slot

size.

Generic Function: start (region)

Returns a pointer to the start of the memory region.

See MEMORY-REGION (type)
See MEMORY-REGION-ISH (type)

Package

org.shirakumo.memory-regions.

Source

memory-region.lisp.

Methods
Reader Method: start ((memory-region-object memory-region-object))

automatically generated reader method

Source

object.lisp.

Target Slot

start.

Reader Method: start ((memory-region-stream memory-region-stream))

automatically generated reader method

Source

stream.lisp.

Target Slot

start.

Reader Method: start ((memory-region-sequence memory-region-sequence))

automatically generated reader method

Source

sequence.lisp.

Target Slot

start.

Reader Method: start ((bump-allocator bump-allocator))

automatically generated reader method

Source

bump-allocator.lisp.

Target Slot

start.

Method: start ((region memory-region))
Generic Writer: (setf start) (object)
Package

org.shirakumo.memory-regions.

Methods
Writer Method: (setf start) ((memory-region-object memory-region-object))

automatically generated writer method

Source

object.lisp.

Target Slot

start.

Writer Method: (setf start) ((memory-region-stream memory-region-stream))

automatically generated writer method

Source

stream.lisp.

Target Slot

start.

Writer Method: (setf start) ((memory-region-sequence memory-region-sequence))

automatically generated writer method

Source

sequence.lisp.

Target Slot

start.

Writer Method: (setf start) ((bump-allocator bump-allocator))

automatically generated writer method

Source

bump-allocator.lisp.

Target Slot

start.

Generic Function: subregion (region &optional start end)

Returns a sub-region of the given memory-region.

The following restrictions apply:
- START and END must both be positive fixnums - START must be less than or equal to END
- END must be less than the memory region’s SIZE

See MEMORY-REGION (type)
See MEMORY-REGION-ISH (type)

Package

org.shirakumo.memory-regions.

Source

memory-region.lisp.

Methods
Method: subregion (region-ish &optional start end)
Method: subregion ((region memory-region) &optional start end)
Generic Function: to-memory-region (thing)

Coerces the given argument to a memory region.

See MEMORY-REGION (type)
See CALL-WITH-MEMORY-REGION
See WITH-MEMORY-REGION

Package

org.shirakumo.memory-regions.

Source

memory-region.lisp.

Methods
Method: to-memory-region ((pathname pathname))
Source

pathname.lisp.

Reader Method: to-memory-region ((memory-region-sequence memory-region-sequence))

automatically generated reader method

Source

sequence.lisp.

Target Slot

region.

Method: to-memory-region ((region memory-region-ish))
Method: to-memory-region ((memory-region memory-region))
Generic Function: to-object (object structure-type)
Package

org.shirakumo.memory-regions.

Methods
Method: to-object (thing structure-type)
Source

object.lisp.

Method: to-object ((region memory-region) structure-type)
Source

object.lisp.

Method: to-object ((object memory-region-object) structure-type)
Source

object.lisp.

Generic Function: to-sequence (sequence &optional element-type)
Package

org.shirakumo.memory-regions.

Methods
Method: to-sequence (thing &optional element-type)
Source

sequence.lisp.

Method: to-sequence ((memory-region memory-region) &optional element-type)
Source

sequence.lisp.

Method: to-sequence ((sequence memory-region-sequence) &optional element-type)
Source

sequence.lisp.

Generic Function: to-stream (stream)
Package

org.shirakumo.memory-regions.

Methods
Method: to-stream (thing)
Source

stream.lisp.

Method: to-stream ((memory-region memory-region))
Source

stream.lisp.

Method: to-stream ((stream memory-region-stream))
Source

stream.lisp.

Generic Function: total-size (allocator)

Returns the total number of octets the allocator can distribute to memory-regions.

See ALLOCATOR (type)

Package

org.shirakumo.memory-regions.

Source

allocator.lisp.

Methods
Reader Method: total-size ((bump-allocator bump-allocator))

automatically generated reader method

Source

bump-allocator.lisp.

Target Slot

size.

Method: total-size ((allocator null))
Source

null-allocator.lisp.

Method: total-size ((allocator (eql t)))
Generic Function: used-space (allocator)

Returns the number of octets that are currently distributed to memory-regions.

See ALLOCATOR (type)

Package

org.shirakumo.memory-regions.

Source

allocator.lisp.

Methods
Reader Method: used-space ((bump-allocator bump-allocator))

automatically generated reader method

Source

bump-allocator.lisp.

Target Slot

index.

Method: used-space ((allocator null))
Source

null-allocator.lisp.

Method: used-space ((allocator (eql t)))

5.1.5 Standalone methods

Method: adjust-sequence ((sequence memory-region-sequence) length &key initial-contents initial-element allocator)
Package

sb-sequence.

Source

sequence.lisp.

Method: (setf elt) ((sequence memory-region-sequence) index)
Package

sb-sequence.

Source

sequence.lisp.

Method: elt ((sequence memory-region-sequence) index)
Package

sb-sequence.

Source

sequence.lisp.

Method: initialize-instance :after ((allocator bump-allocator) &key)
Source

bump-allocator.lisp.

Reader Method: length ((memory-region-sequence memory-region-sequence))

automatically generated reader method

Package

sb-sequence.

Source

sequence.lisp.

Target Slot

count.

Method: make-sequence-like ((sequence memory-region-sequence) length &key initial-contents initial-element allocator)
Package

sb-sequence.

Source

sequence.lisp.

Method: print-object ((region memory-region) stream)
Source

memory-region.lisp.

Method: slot-boundp-using-class (class (object memory-region-object) slot)
Package

sb-mop.

Source

object.lisp.

Method: slot-makunbound-using-class (class (object memory-region-object) slot)
Package

sb-mop.

Source

object.lisp.

Method: (setf slot-value-using-class) (class (object memory-region-object) slot)
Package

sb-mop.

Source

object.lisp.

Method: slot-value-using-class (class (object memory-region-object) slot)
Package

sb-mop.

Source

object.lisp.

Method: stream-clear-input ((stream memory-region-stream))
Package

sb-gray.

Source

stream.lisp.

Method: stream-clear-output ((stream memory-region-stream))
Package

sb-gray.

Source

stream.lisp.

Writer Method: (setf stream-file-position) ((memory-region-stream memory-region-stream))

automatically generated writer method

Package

trivial-gray-streams.

Source

stream.lisp.

Target Slot

index.

Reader Method: stream-file-position ((memory-region-stream memory-region-stream))

automatically generated reader method

Package

trivial-gray-streams.

Source

stream.lisp.

Target Slot

index.

Method: stream-read-byte ((stream memory-region-stream))
Package

sb-gray.

Source

stream.lisp.

Method: stream-read-sequence ((stream memory-region-stream) (sequence vector) start end &key)
Package

trivial-gray-streams.

Source

stream.lisp.

Method: stream-write-byte ((stream memory-region-stream) integer)
Package

sb-gray.

Source

stream.lisp.

Method: stream-write-sequence ((stream memory-region-stream) (sequence vector) start end &key)
Package

trivial-gray-streams.

Source

stream.lisp.

Method: subseq ((sequence memory-region-sequence) start &optional end)
Package

sb-sequence.

Source

sequence.lisp.


5.1.6 Conditions

Condition: allocator-condition

Supertype for conditions related to allocators.

See ALLOCATOR

Package

org.shirakumo.memory-regions.

Source

allocator.lisp.

Direct superclasses

condition.

Direct subclasses
Direct methods

allocator.

Direct slots
Slot: allocator
Initargs

:allocator

Readers

allocator.

Writers

This slot is read-only.

Condition: block-too-big

Error signalled when a block that is too big for the allocator is requested.

See SIZE
See ALLOCATOR-CONDITION (type)
See ALLOCATOR (type)

Package

org.shirakumo.memory-regions.

Source

allocator.lisp.

Direct superclasses
Direct methods

size.

Direct slots
Slot: size
Initargs

:size

Readers

size.

Writers

This slot is read-only.

Condition: out-of-memory

Error signalled when an allocation request cannot be fulfilled.

See ALLOCATOR-CONDITION (type)
See ALLOCATOR (type)

Package

org.shirakumo.memory-regions.

Source

allocator.lisp.

Direct superclasses

5.1.7 Structures

Structure: memory-region

Representation of a region of memory.

This is a pointer and a size.

See MEMORY-REGION-POINTER
See MEMORY-REGION-SIZE
See MEMORY-REGION-VALID-P
See MEMORY-REGION-ISH (type)
See TO-MEMORY-REGION
See CALL-WITH-MEMORY-REGION
See START
See END
See SIZE
See CLEAR
See FILL
See REPLACE
See SUBREGION

Package

org.shirakumo.memory-regions.

Source

memory-region.lisp.

Direct superclasses

structure-object.

Direct subclasses
Direct methods
Direct slots
Slot: pointer
Type

cffi-sys:foreign-pointer

Readers

memory-region-pointer.

Writers

(setf memory-region-pointer).

Slot: size
Type

(unsigned-byte 64)

Initform

0

Readers

memory-region-size.

Writers

(setf memory-region-size).


5.1.8 Classes

Class: allocator

Representation of an allocation manager that can hand out regions.

If you plan on implementing your own allocator, you must implement the related functions.

You may also use NIL with any of the allocation functions, in which case the C runtime allocator (malloc, etc) is used.

When you use T with any of the allocation functions, the current value of the *ALLOCATOR* variable is used.

In order to free the allocator itself you should pass it to DEALLOCATE with NIL as the region.

See ALLOCATE
See DEALLOCATE
See REALLOCATE
See TOTAL-SIZE
See FREE-SPACE
See USED-SPACE
See MINIMUM-BLOCK-SIZE
See MAXIMUM-BLOCK-SIZE
See *ALLOCATOR*
See WITH-ARENA
See CLEAR

Package

org.shirakumo.memory-regions.

Source

allocator.lisp.

Direct subclasses

bump-allocator.

Direct methods
Class: bump-allocator

Implementation of a simple bump allocator.

Allocations using this will be as fast as possible. Deallocations are only regarded if the region is the last region that was allocated. The idea being that you typically don’t deallocate individual regions, and instead CLEAR or DEALLOCATE the allocator itself when you’re done.

See ALLOCATOR (type)

Package

org.shirakumo.memory-regions.

Source

bump-allocator.lisp.

Direct superclasses
Direct methods
Direct slots
Slot: start
Initargs

:start

Readers

start.

Writers

(setf start).

Slot: size
Initform

0

Initargs

:size

Readers
Writers

(setf size).

Slot: index
Initform

0

Readers
Writers

(setf index).

Class: memory-region-ish

Superclass for all objects that can be coerced to a memory region.

See TO-MEMORY-REGION
See CALL-WITH-MEMORY-REGION
See MEMORY-REGION (type)
See START
See END
See SIZE
See CLEAR
See FILL
See REPLACE
See SUBREGION

Package

org.shirakumo.memory-regions.

Source

memory-region.lisp.

Direct subclasses
Direct methods
Class: memory-region-object
Package

org.shirakumo.memory-regions.

Source

object.lisp.

Direct superclasses

memory-region-ish.

Direct methods
Direct slots
Slot: start
Initargs

:start

Readers

start.

Writers

(setf start).

Slot: size
Initargs

:size

Readers

size.

Writers

(setf size).

Slot: slot-info
Initargs

:slot-info

Readers

slot-info.

Writers

(setf slot-info).

Class: memory-region-sequence
Package

org.shirakumo.memory-regions.

Source

sequence.lisp.

Direct superclasses
Direct methods
Direct slots
Slot: region
Initargs

:region

Readers

to-memory-region.

Writers

This slot is read-only.

Slot: start
Initargs

:start

Readers

start.

Writers

(setf start).

Slot: count
Package

common-lisp.

Readers

length.

Writers

This slot is read-only.

Slot: element-type
Initargs

:element-type

Readers

element-type.

Writers

(setf element-type).

Slot: element-size
Initargs

:element-size

Readers

element-size.

Writers

(setf element-size).

Class: memory-region-stream
Package

org.shirakumo.memory-regions.

Source

stream.lisp.

Direct superclasses
  • fundamental-binary-input-stream.
  • fundamental-binary-output-stream.
  • memory-region-ish.
Direct methods
Direct slots
Slot: start
Initargs

:start

Readers

start.

Writers

(setf start).

Slot: size
Initargs

:size

Readers

size.

Writers

(setf size).

Slot: index
Initform

0

Initargs

:index

Readers
Writers

5.2 Internals


5.2.1 Special variables

Special Variable: *ffi-slot-info*
Package

org.shirakumo.memory-regions.

Source

object.lisp.


5.2.2 Ordinary functions

Function: %make-ffi-slot-info (offset reader writer)
Package

org.shirakumo.memory-regions.

Source

object.lisp.

Function: copy-memory-region (instance)
Package

org.shirakumo.memory-regions.

Source

memory-region.lisp.

Function: copy-mmap-memory-region (instance)
Package

org.shirakumo.memory-regions.

Source

pathname.lisp.

Function: copy-stream-memory-region (instance)
Package

org.shirakumo.memory-regions.

Source

pathname.lisp.

Function: element-type->c-type (type)
Package

org.shirakumo.memory-regions.

Source

toolkit.lisp.

Function: element-type-size (type)
Package

org.shirakumo.memory-regions.

Source

toolkit.lisp.

Function: ffi-slot-info (structure-type)
Package

org.shirakumo.memory-regions.

Source

object.lisp.

Reader: ffi-slot-info-offset (instance)
Package

org.shirakumo.memory-regions.

Source

object.lisp.

Target Slot

offset.

Reader: ffi-slot-info-reader (instance)
Package

org.shirakumo.memory-regions.

Source

object.lisp.

Target Slot

reader.

Reader: ffi-slot-info-writer (instance)
Package

org.shirakumo.memory-regions.

Source

object.lisp.

Target Slot

writer.

Function: make-ffi-slot-info (type)
Package

org.shirakumo.memory-regions.

Source

object.lisp.

Function: memory-region-p (object)
Package

org.shirakumo.memory-regions.

Source

memory-region.lisp.

Function: mmap-memory-region (pointer size fd)
Package

org.shirakumo.memory-regions.

Source

pathname.lisp.

Reader: mmap-memory-region-fd (instance)
Writer: (setf mmap-memory-region-fd) (instance)
Package

org.shirakumo.memory-regions.

Source

pathname.lisp.

Target Slot

fd.

Function: mmap-memory-region-p (object)
Package

org.shirakumo.memory-regions.

Source

pathname.lisp.

Function: mmap-memory-region-pointer (instance)
Package

org.shirakumo.memory-regions.

Source

pathname.lisp.

Function: (setf mmap-memory-region-pointer) (instance)
Package

org.shirakumo.memory-regions.

Source

pathname.lisp.

Function: mmap-memory-region-size (instance)
Package

org.shirakumo.memory-regions.

Source

pathname.lisp.

Function: (setf mmap-memory-region-size) (instance)
Package

org.shirakumo.memory-regions.

Source

pathname.lisp.

Function: stream-memory-region (pointer size stream array)
Package

org.shirakumo.memory-regions.

Source

pathname.lisp.

Reader: stream-memory-region-array (instance)
Writer: (setf stream-memory-region-array) (instance)
Package

org.shirakumo.memory-regions.

Source

pathname.lisp.

Target Slot

array.

Function: stream-memory-region-p (object)
Package

org.shirakumo.memory-regions.

Source

pathname.lisp.

Function: stream-memory-region-pointer (instance)
Package

org.shirakumo.memory-regions.

Source

pathname.lisp.

Function: (setf stream-memory-region-pointer) (instance)
Package

org.shirakumo.memory-regions.

Source

pathname.lisp.

Function: stream-memory-region-size (instance)
Package

org.shirakumo.memory-regions.

Source

pathname.lisp.

Function: (setf stream-memory-region-size) (instance)
Package

org.shirakumo.memory-regions.

Source

pathname.lisp.

Reader: stream-memory-region-stream (instance)
Writer: (setf stream-memory-region-stream) (instance)
Package

org.shirakumo.memory-regions.

Source

pathname.lisp.

Target Slot

stream.


5.2.3 Generic functions

Generic Reader: element-size (object)
Package

org.shirakumo.memory-regions.

Methods
Reader Method: element-size ((memory-region-sequence memory-region-sequence))

automatically generated reader method

Source

sequence.lisp.

Target Slot

element-size.

Generic Writer: (setf element-size) (object)
Package

org.shirakumo.memory-regions.

Methods
Writer Method: (setf element-size) ((memory-region-sequence memory-region-sequence))

automatically generated writer method

Source

sequence.lisp.

Target Slot

element-size.

Generic Reader: element-type (object)
Package

org.shirakumo.memory-regions.

Methods
Reader Method: element-type ((memory-region-sequence memory-region-sequence))

automatically generated reader method

Source

sequence.lisp.

Target Slot

element-type.

Generic Writer: (setf element-type) (object)
Package

org.shirakumo.memory-regions.

Methods
Writer Method: (setf element-type) ((memory-region-sequence memory-region-sequence))

automatically generated writer method

Source

sequence.lisp.

Target Slot

element-type.

Generic Reader: index (object)
Package

org.shirakumo.memory-regions.

Methods
Reader Method: index ((memory-region-stream memory-region-stream))

automatically generated reader method

Source

stream.lisp.

Target Slot

index.

Reader Method: index ((bump-allocator bump-allocator))

automatically generated reader method

Source

bump-allocator.lisp.

Target Slot

index.

Generic Writer: (setf index) (object)
Package

org.shirakumo.memory-regions.

Methods
Writer Method: (setf index) ((memory-region-stream memory-region-stream))

automatically generated writer method

Source

stream.lisp.

Target Slot

index.

Writer Method: (setf index) ((bump-allocator bump-allocator))

automatically generated writer method

Source

bump-allocator.lisp.

Target Slot

index.

Generic Reader: slot-info (object)
Package

org.shirakumo.memory-regions.

Methods
Reader Method: slot-info ((memory-region-object memory-region-object))

automatically generated reader method

Source

object.lisp.

Target Slot

slot-info.

Generic Writer: (setf slot-info) (object)
Package

org.shirakumo.memory-regions.

Methods
Writer Method: (setf slot-info) ((memory-region-object memory-region-object))

automatically generated writer method

Source

object.lisp.

Target Slot

slot-info.


5.2.4 Structures

Structure: ffi-slot-info
Package

org.shirakumo.memory-regions.

Source

object.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: offset
Type

(unsigned-byte 32)

Initform

0

Readers

ffi-slot-info-offset.

Writers

This slot is read-only.

Slot: reader
Type

function

Readers

ffi-slot-info-reader.

Writers

This slot is read-only.

Slot: writer
Type

function

Readers

ffi-slot-info-writer.

Writers

This slot is read-only.

Structure: mmap-memory-region
Package

org.shirakumo.memory-regions.

Source

pathname.lisp.

Direct superclasses

memory-region.

Direct methods

deallocate.

Direct slots
Slot: fd
Readers

mmap-memory-region-fd.

Writers

(setf mmap-memory-region-fd).

Structure: stream-memory-region
Package

org.shirakumo.memory-regions.

Source

pathname.lisp.

Direct superclasses

memory-region.

Direct methods

deallocate.

Direct slots
Slot: stream
Package

common-lisp.

Readers

stream-memory-region-stream.

Writers

(setf stream-memory-region-stream).

Slot: array
Package

common-lisp.

Readers

stream-memory-region-array.

Writers

(setf stream-memory-region-array).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %   (  
A   C   D   E   F   G   I   L   M   P   R   S   T   U   W  
Index Entry  Section

%
%make-ffi-slot-info: Private ordinary functions

(
(setf element-size): Private generic functions
(setf element-size): Private generic functions
(setf element-type): Private generic functions
(setf element-type): Private generic functions
(setf elt): Public standalone methods
(setf index): Private generic functions
(setf index): Private generic functions
(setf index): Private generic functions
(setf memory-region-pointer): Public ordinary functions
(setf memory-region-size): Public ordinary functions
(setf mmap-memory-region-fd): Private ordinary functions
(setf mmap-memory-region-pointer): Private ordinary functions
(setf mmap-memory-region-size): Private ordinary functions
(setf size): Public generic functions
(setf size): Public generic functions
(setf size): Public generic functions
(setf size): Public generic functions
(setf slot-info): Private generic functions
(setf slot-info): Private generic functions
(setf slot-value-using-class): Public standalone methods
(setf start): Public generic functions
(setf start): Public generic functions
(setf start): Public generic functions
(setf start): Public generic functions
(setf start): Public generic functions
(setf stream-file-position): Public standalone methods
(setf stream-memory-region-array): Private ordinary functions
(setf stream-memory-region-pointer): Private ordinary functions
(setf stream-memory-region-size): Private ordinary functions
(setf stream-memory-region-stream): Private ordinary functions

A
adjust-sequence: Public standalone methods
allocate: Public generic functions
allocate: Public generic functions
allocate: Public generic functions
allocate: Public generic functions
allocator: Public generic functions
allocator: Public generic functions

C
call-with-memory-region: Public generic functions
call-with-memory-region: Public generic functions
call-with-memory-region: Public generic functions
call-with-memory-region: Public generic functions
call-with-memory-region: Public generic functions
call-with-memory-region: Public generic functions
call-with-memory-region: Public generic functions
call-with-memory-region: Public generic functions
clear: Public generic functions
clear: Public generic functions
clear: Public generic functions
clear: Public generic functions
copy-memory-region: Private ordinary functions
copy-mmap-memory-region: Private ordinary functions
copy-stream-memory-region: Private ordinary functions

D
deallocate: Public generic functions
deallocate: Public generic functions
deallocate: Public generic functions
deallocate: Public generic functions
deallocate: Public generic functions
deallocate: Public generic functions
deallocate: Public generic functions

E
element-size: Private generic functions
element-size: Private generic functions
element-type: Private generic functions
element-type: Private generic functions
element-type->c-type: Private ordinary functions
element-type-size: Private ordinary functions
elt: Public standalone methods
end: Public generic functions
end: Public generic functions

F
ffi-slot-info: Private ordinary functions
ffi-slot-info-offset: Private ordinary functions
ffi-slot-info-reader: Private ordinary functions
ffi-slot-info-writer: Private ordinary functions
fill: Public generic functions
fill: Public generic functions
fill: Public generic functions
free-space: Public generic functions
free-space: Public generic functions
free-space: Public generic functions
Function, %make-ffi-slot-info: Private ordinary functions
Function, (setf memory-region-pointer): Public ordinary functions
Function, (setf memory-region-size): Public ordinary functions
Function, (setf mmap-memory-region-fd): Private ordinary functions
Function, (setf mmap-memory-region-pointer): Private ordinary functions
Function, (setf mmap-memory-region-size): Private ordinary functions
Function, (setf stream-memory-region-array): Private ordinary functions
Function, (setf stream-memory-region-pointer): Private ordinary functions
Function, (setf stream-memory-region-size): Private ordinary functions
Function, (setf stream-memory-region-stream): Private ordinary functions
Function, copy-memory-region: Private ordinary functions
Function, copy-mmap-memory-region: Private ordinary functions
Function, copy-stream-memory-region: Private ordinary functions
Function, element-type->c-type: Private ordinary functions
Function, element-type-size: Private ordinary functions
Function, ffi-slot-info: Private ordinary functions
Function, ffi-slot-info-offset: Private ordinary functions
Function, ffi-slot-info-reader: Private ordinary functions
Function, ffi-slot-info-writer: Private ordinary functions
Function, make-ffi-slot-info: Private ordinary functions
Function, memory-region: Public ordinary functions
Function, memory-region-p: Private ordinary functions
Function, memory-region-pointer: Public ordinary functions
Function, memory-region-size: Public ordinary functions
Function, memory-region-valid-p: Public ordinary functions
Function, mmap-memory-region: Private ordinary functions
Function, mmap-memory-region-fd: Private ordinary functions
Function, mmap-memory-region-p: Private ordinary functions
Function, mmap-memory-region-pointer: Private ordinary functions
Function, mmap-memory-region-size: Private ordinary functions
Function, stream-memory-region: Private ordinary functions
Function, stream-memory-region-array: Private ordinary functions
Function, stream-memory-region-p: Private ordinary functions
Function, stream-memory-region-pointer: Private ordinary functions
Function, stream-memory-region-size: Private ordinary functions
Function, stream-memory-region-stream: Private ordinary functions

G
Generic Function, (setf element-size): Private generic functions
Generic Function, (setf element-type): Private generic functions
Generic Function, (setf index): Private generic functions
Generic Function, (setf size): Public generic functions
Generic Function, (setf slot-info): Private generic functions
Generic Function, (setf start): Public generic functions
Generic Function, allocate: Public generic functions
Generic Function, allocator: Public generic functions
Generic Function, call-with-memory-region: Public generic functions
Generic Function, clear: Public generic functions
Generic Function, deallocate: Public generic functions
Generic Function, element-size: Private generic functions
Generic Function, element-type: Private generic functions
Generic Function, end: Public generic functions
Generic Function, fill: Public generic functions
Generic Function, free-space: Public generic functions
Generic Function, index: Private generic functions
Generic Function, maximum-block-size: Public generic functions
Generic Function, minimum-block-size: Public generic functions
Generic Function, reallocate: Public generic functions
Generic Function, replace: Public generic functions
Generic Function, size: Public generic functions
Generic Function, slot-info: Private generic functions
Generic Function, start: Public generic functions
Generic Function, subregion: Public generic functions
Generic Function, to-memory-region: Public generic functions
Generic Function, to-object: Public generic functions
Generic Function, to-sequence: Public generic functions
Generic Function, to-stream: Public generic functions
Generic Function, total-size: Public generic functions
Generic Function, used-space: Public generic functions

I
index: Private generic functions
index: Private generic functions
index: Private generic functions
initialize-instance: Public standalone methods

L
length: Public standalone methods

M
Macro, with-arena: Public macros
Macro, with-memory-region: Public macros
Macro, with-pointer-to-array-data: Public macros
make-ffi-slot-info: Private ordinary functions
make-sequence-like: Public standalone methods
maximum-block-size: Public generic functions
maximum-block-size: Public generic functions
maximum-block-size: Public generic functions
maximum-block-size: Public generic functions
memory-region: Public ordinary functions
memory-region-p: Private ordinary functions
memory-region-pointer: Public ordinary functions
memory-region-size: Public ordinary functions
memory-region-valid-p: Public ordinary functions
Method, (setf element-size): Private generic functions
Method, (setf element-type): Private generic functions
Method, (setf elt): Public standalone methods
Method, (setf index): Private generic functions
Method, (setf index): Private generic functions
Method, (setf size): Public generic functions
Method, (setf size): Public generic functions
Method, (setf size): Public generic functions
Method, (setf slot-info): Private generic functions
Method, (setf slot-value-using-class): Public standalone methods
Method, (setf start): Public generic functions
Method, (setf start): Public generic functions
Method, (setf start): Public generic functions
Method, (setf start): Public generic functions
Method, (setf stream-file-position): Public standalone methods
Method, adjust-sequence: Public standalone methods
Method, allocate: Public generic functions
Method, allocate: Public generic functions
Method, allocate: Public generic functions
Method, allocator: Public generic functions
Method, call-with-memory-region: Public generic functions
Method, call-with-memory-region: Public generic functions
Method, call-with-memory-region: Public generic functions
Method, call-with-memory-region: Public generic functions
Method, call-with-memory-region: Public generic functions
Method, call-with-memory-region: Public generic functions
Method, call-with-memory-region: Public generic functions
Method, clear: Public generic functions
Method, clear: Public generic functions
Method, clear: Public generic functions
Method, deallocate: Public generic functions
Method, deallocate: Public generic functions
Method, deallocate: Public generic functions
Method, deallocate: Public generic functions
Method, deallocate: Public generic functions
Method, deallocate: Public generic functions
Method, element-size: Private generic functions
Method, element-type: Private generic functions
Method, elt: Public standalone methods
Method, end: Public generic functions
Method, fill: Public generic functions
Method, fill: Public generic functions
Method, free-space: Public generic functions
Method, free-space: Public generic functions
Method, index: Private generic functions
Method, index: Private generic functions
Method, initialize-instance: Public standalone methods
Method, length: Public standalone methods
Method, make-sequence-like: Public standalone methods
Method, maximum-block-size: Public generic functions
Method, maximum-block-size: Public generic functions
Method, maximum-block-size: Public generic functions
Method, minimum-block-size: Public generic functions
Method, minimum-block-size: Public generic functions
Method, minimum-block-size: Public generic functions
Method, print-object: Public standalone methods
Method, reallocate: Public generic functions
Method, reallocate: Public generic functions
Method, reallocate: Public generic functions
Method, replace: Public generic functions
Method, replace: Public generic functions
Method, size: Public generic functions
Method, size: Public generic functions
Method, size: Public generic functions
Method, size: Public generic functions
Method, size: Public generic functions
Method, size: Public generic functions
Method, slot-boundp-using-class: Public standalone methods
Method, slot-info: Private generic functions
Method, slot-makunbound-using-class: Public standalone methods
Method, slot-value-using-class: Public standalone methods
Method, start: Public generic functions
Method, start: Public generic functions
Method, start: Public generic functions
Method, start: Public generic functions
Method, start: Public generic functions
Method, stream-clear-input: Public standalone methods
Method, stream-clear-output: Public standalone methods
Method, stream-file-position: Public standalone methods
Method, stream-read-byte: Public standalone methods
Method, stream-read-sequence: Public standalone methods
Method, stream-write-byte: Public standalone methods
Method, stream-write-sequence: Public standalone methods
Method, subregion: Public generic functions
Method, subregion: Public generic functions
Method, subseq: Public standalone methods
Method, to-memory-region: Public generic functions
Method, to-memory-region: Public generic functions
Method, to-memory-region: Public generic functions
Method, to-memory-region: Public generic functions
Method, to-object: Public generic functions
Method, to-object: Public generic functions
Method, to-object: Public generic functions
Method, to-sequence: Public generic functions
Method, to-sequence: Public generic functions
Method, to-sequence: Public generic functions
Method, to-stream: Public generic functions
Method, to-stream: Public generic functions
Method, to-stream: Public generic functions
Method, total-size: Public generic functions
Method, total-size: Public generic functions
Method, total-size: Public generic functions
Method, used-space: Public generic functions
Method, used-space: Public generic functions
Method, used-space: Public generic functions
minimum-block-size: Public generic functions
minimum-block-size: Public generic functions
minimum-block-size: Public generic functions
minimum-block-size: Public generic functions
mmap-memory-region: Private ordinary functions
mmap-memory-region-fd: Private ordinary functions
mmap-memory-region-p: Private ordinary functions
mmap-memory-region-pointer: Private ordinary functions
mmap-memory-region-size: Private ordinary functions

P
print-object: Public standalone methods

R
reallocate: Public generic functions
reallocate: Public generic functions
reallocate: Public generic functions
reallocate: Public generic functions
replace: Public generic functions
replace: Public generic functions
replace: Public generic functions

S
size: Public generic functions
size: Public generic functions
size: Public generic functions
size: Public generic functions
size: Public generic functions
size: Public generic functions
size: Public generic functions
slot-boundp-using-class: Public standalone methods
slot-info: Private generic functions
slot-info: Private generic functions
slot-makunbound-using-class: Public standalone methods
slot-value-using-class: Public standalone methods
start: Public generic functions
start: Public generic functions
start: Public generic functions
start: Public generic functions
start: Public generic functions
start: Public generic functions
stream-clear-input: Public standalone methods
stream-clear-output: Public standalone methods
stream-file-position: Public standalone methods
stream-memory-region: Private ordinary functions
stream-memory-region-array: Private ordinary functions
stream-memory-region-p: Private ordinary functions
stream-memory-region-pointer: Private ordinary functions
stream-memory-region-size: Private ordinary functions
stream-memory-region-stream: Private ordinary functions
stream-read-byte: Public standalone methods
stream-read-sequence: Public standalone methods
stream-write-byte: Public standalone methods
stream-write-sequence: Public standalone methods
subregion: Public generic functions
subregion: Public generic functions
subregion: Public generic functions
subseq: Public standalone methods

T
to-memory-region: Public generic functions
to-memory-region: Public generic functions
to-memory-region: Public generic functions
to-memory-region: Public generic functions
to-memory-region: Public generic functions
to-object: Public generic functions
to-object: Public generic functions
to-object: Public generic functions
to-object: Public generic functions
to-sequence: Public generic functions
to-sequence: Public generic functions
to-sequence: Public generic functions
to-sequence: Public generic functions
to-stream: Public generic functions
to-stream: Public generic functions
to-stream: Public generic functions
to-stream: Public generic functions
total-size: Public generic functions
total-size: Public generic functions
total-size: Public generic functions
total-size: Public generic functions

U
used-space: Public generic functions
used-space: Public generic functions
used-space: Public generic functions
used-space: Public generic functions

W
with-arena: Public macros
with-memory-region: Public macros
with-pointer-to-array-data: Public macros


A.3 Variables

Jump to:   *  
A   C   E   F   I   O   P   R   S   W  
Index Entry  Section

*
*allocator*: Public special variables
*ffi-slot-info*: Private special variables
*standard-allocator*: Public special variables

A
allocator: Public conditions
array: Private structures

C
count: Public classes

E
element-size: Public classes
element-type: Public classes

F
fd: Private structures

I
index: Public classes
index: Public classes

O
offset: Private structures

P
pointer: Public structures

R
reader: Private structures
region: Public classes

S
size: Public conditions
size: Public structures
size: Public classes
size: Public classes
size: Public classes
Slot, allocator: Public conditions
Slot, array: Private structures
Slot, count: Public classes
Slot, element-size: Public classes
Slot, element-type: Public classes
Slot, fd: Private structures
Slot, index: Public classes
Slot, index: Public classes
Slot, offset: Private structures
Slot, pointer: Public structures
Slot, reader: Private structures
Slot, region: Public classes
Slot, size: Public conditions
Slot, size: Public structures
Slot, size: Public classes
Slot, size: Public classes
Slot, size: Public classes
Slot, slot-info: Public classes
Slot, start: Public classes
Slot, start: Public classes
Slot, start: Public classes
Slot, start: Public classes
Slot, stream: Private structures
Slot, writer: Private structures
slot-info: Public classes
Special Variable, *allocator*: Public special variables
Special Variable, *ffi-slot-info*: Private special variables
Special Variable, *standard-allocator*: Public special variables
start: Public classes
start: Public classes
start: Public classes
start: Public classes
stream: Private structures

W
writer: Private structures


A.4 Data types

Jump to:   A   B   C   D   F   M   N   O   P   S   T  
Index Entry  Section

A
allocator: Public classes
allocator-condition: Public conditions
allocator.lisp: The memory-regions/region/allocator․lisp file

B
block-too-big: Public conditions
bump-allocator: Public classes
bump-allocator.lisp: The memory-regions/allocator/bump-allocator․lisp file

C
Class, allocator: Public classes
Class, bump-allocator: Public classes
Class, memory-region-ish: Public classes
Class, memory-region-object: Public classes
Class, memory-region-sequence: Public classes
Class, memory-region-stream: Public classes
Condition, allocator-condition: Public conditions
Condition, block-too-big: Public conditions
Condition, out-of-memory: Public conditions

D
documentation.lisp: The memory-regions/region/documentation․lisp file
documentation.lisp: The memory-regions/allocator/documentation․lisp file

F
ffi-slot-info: Private structures
File, allocator.lisp: The memory-regions/region/allocator․lisp file
File, bump-allocator.lisp: The memory-regions/allocator/bump-allocator․lisp file
File, documentation.lisp: The memory-regions/region/documentation․lisp file
File, documentation.lisp: The memory-regions/allocator/documentation․lisp file
File, memory-region.lisp: The memory-regions/region/memory-region․lisp file
File, memory-regions.asd: The memory-regions/memory-regions․asd file
File, null-allocator.lisp: The memory-regions/allocator/null-allocator․lisp file
File, object.lisp: The memory-regions/object/object․lisp file
File, package.lisp: The memory-regions/region/package․lisp file
File, pathname.lisp: The memory-regions/pathname/pathname․lisp file
File, sequence.lisp: The memory-regions/sequence/sequence․lisp file
File, stream.lisp: The memory-regions/stream/stream․lisp file
File, toolkit.lisp: The memory-regions/region/toolkit․lisp file

M
memory-region: Public structures
memory-region-ish: Public classes
memory-region-object: Public classes
memory-region-sequence: Public classes
memory-region-stream: Public classes
memory-region.lisp: The memory-regions/region/memory-region․lisp file
memory-regions: The memory-regions system
memory-regions.asd: The memory-regions/memory-regions․asd file
memory-regions/allocator: The memory-regions/allocator system
memory-regions/object: The memory-regions/object system
memory-regions/pathname: The memory-regions/pathname system
memory-regions/region: The memory-regions/region system
memory-regions/sequence: The memory-regions/sequence system
memory-regions/stream: The memory-regions/stream system
mmap-memory-region: Private structures

N
null-allocator.lisp: The memory-regions/allocator/null-allocator․lisp file

O
object.lisp: The memory-regions/object/object․lisp file
org.shirakumo.memory-regions: The org․shirakumo․memory-regions package
out-of-memory: Public conditions

P
Package, org.shirakumo.memory-regions: The org․shirakumo․memory-regions package
package.lisp: The memory-regions/region/package․lisp file
pathname.lisp: The memory-regions/pathname/pathname․lisp file

S
sequence.lisp: The memory-regions/sequence/sequence․lisp file
stream-memory-region: Private structures
stream.lisp: The memory-regions/stream/stream․lisp file
Structure, ffi-slot-info: Private structures
Structure, memory-region: Public structures
Structure, mmap-memory-region: Private structures
Structure, stream-memory-region: Private structures
System, memory-regions: The memory-regions system
System, memory-regions/allocator: The memory-regions/allocator system
System, memory-regions/object: The memory-regions/object system
System, memory-regions/pathname: The memory-regions/pathname system
System, memory-regions/region: The memory-regions/region system
System, memory-regions/sequence: The memory-regions/sequence system
System, memory-regions/stream: The memory-regions/stream system

T
toolkit.lisp: The memory-regions/region/toolkit․lisp file