The metalock Reference Manual

Table of Contents

The metalock Reference Manual

This is the metalock Reference Manual, version 0.0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 14:23:22 2020 GMT+0.

1 Introduction

metalock

This is a project simply provides a metaclass which when used means that you do not have to manually manage locks. This package exports one thing metalock which is a metaclass for use with whatever class definitions you want. This metaclass is implemented using *-using-class methods so your distribution of CL must use these methods to implement access functions like 'slot-value' for this metaclass to work. Obviously it must also implement the MOP. I have tested on SBCL 1.4.9 only.

Access to slots is controlled using read-writer locks described here: https://en.wikipedia.org/wiki/Readers%E2%80%93writer_lock#Using_a_condition_variable_and_a_mutex

(defclass myclass ()
  ((oneslot :accessor oneslot :initform 1))
 (:metaclass metalock:metalock))

Instantiate and use like normal.

License

MIT

• needs to work for initialized instances when you redefine the class.

2 Systems

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

2.1 metalock

Author

K1D77A

License

MIT

Description

A metaclass that makes building parallel systems easier by providing each slot within a class a lock which is grabbed automatically.

Version

0.0.1

Dependencies

• closer-mop
• bordeaux-threads

Source

metalock.asd (file)

Components

• package.lisp (file)
• readwriter-lock.lisp (file)
• metalock.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 metalock.asd

Location

metalock.asd

Systems

metalock (system)

3.1.2 metalock/package.lisp

Parent

metalock (system)

Location

package.lisp

Packages

metalock

3.1.3 metalock/readwriter-lock.lisp

Dependency

package.lisp (file)

Parent

metalock (system)

Location

readwriter-lock.lisp

Internal Definitions

• active-writer-p (method)
• (setf active-writer-p) (method)
• condition-var (method)
• (setf condition-var) (method)
• g-lock (method)
• (setf g-lock) (method)
• read-with-rw-lock (macro)
• reader-writer-lock (class)
• readers-active (method)
• (setf readers-active) (method)
• while-loop (macro)
• write-with-rw-lock (macro)
• writers-waiting (method)
• (setf writers-waiting) (method)

3.1.4 metalock/metalock.lisp

Dependency

readwriter-lock.lisp (file)

Parent

metalock (system)

Location

metalock.lisp

Exported Definitions

metalock (class)

Internal Definitions

• make-special-slot (function)
• slot-names-to-lock-alist (function)
• special-slot (class)

4 Packages

Packages are listed by definition order.

4.1 metalock

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

metalock (class)

Internal Definitions

• active-writer-p (generic function)
• active-writer-p (method)
• (setf active-writer-p) (method)
• (setf active-writer-p) (generic function)
• condition-var (generic function)
• condition-var (method)
• (setf condition-var) (method)
• (setf condition-var) (generic function)
• g-lock (generic function)
• g-lock (method)
• (setf g-lock) (method)
• (setf g-lock) (generic function)
• make-special-slot (function)
• read-with-rw-lock (macro)
• reader-writer-lock (class)
• readers-active (generic function)
• readers-active (method)
• (setf readers-active) (method)
• (setf readers-active) (generic function)
• slot-names-to-lock-alist (function)
• special-slot (class)
• while-loop (macro)
• write-with-rw-lock (macro)
• writers-waiting (generic function)
• writers-waiting (method)
• (setf writers-waiting) (method)
• (setf writers-waiting) (generic function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Classes

Class: metalock ()

Package

metalock

Source

metalock.lisp (file)

Direct superclasses

standard-class (class)

Direct methods

• compute-slots (method)
• slot-makunbound-using-class (method)
• slot-boundp-using-class (method)
• slot-value-using-class (method)
• slot-value-using-class (method)
• validate-superclass (method)

5.2 Internal definitions

5.2.1 Macros

Macro: read-with-rw-lock (READER-WRITER-LOCK) &body BODY

Package

metalock

Source

readwriter-lock.lisp (file)

Macro: while-loop TEST &body BODY

Package

metalock

Source

readwriter-lock.lisp (file)

Macro: write-with-rw-lock (READER-WRITER-LOCK) &body BODY

Package

metalock

Source

readwriter-lock.lisp (file)

5.2.2 Functions

Function: make-special-slot KEYS

Package

metalock

Source

metalock.lisp (file)

Function: slot-names-to-lock-alist SLOT-NAMES

Package

metalock

Source

metalock.lisp (file)

5.2.3 Generic functions

Generic Function: active-writer-p OBJECT

Generic Function: (setf active-writer-p) NEW-VALUE OBJECT

Package

metalock

Methods

Method: active-writer-p (READER-WRITER-LOCK reader-writer-lock)

automatically generated reader method

Source

readwriter-lock.lisp (file)

Method: (setf active-writer-p) NEW-VALUE (READER-WRITER-LOCK reader-writer-lock)

automatically generated writer method

Source

readwriter-lock.lisp (file)

Generic Function: condition-var OBJECT

Generic Function: (setf condition-var) NEW-VALUE OBJECT

Package

metalock

Methods

Method: condition-var (READER-WRITER-LOCK reader-writer-lock)

automatically generated reader method

Source

readwriter-lock.lisp (file)

Method: (setf condition-var) NEW-VALUE (READER-WRITER-LOCK reader-writer-lock)

automatically generated writer method

Source

readwriter-lock.lisp (file)

Generic Function: g-lock OBJECT

Generic Function: (setf g-lock) NEW-VALUE OBJECT

Package

metalock

Methods

Method: g-lock (READER-WRITER-LOCK reader-writer-lock)

automatically generated reader method

Source

readwriter-lock.lisp (file)

Method: (setf g-lock) NEW-VALUE (READER-WRITER-LOCK reader-writer-lock)

automatically generated writer method

Source

readwriter-lock.lisp (file)

Generic Function: readers-active OBJECT

Generic Function: (setf readers-active) NEW-VALUE OBJECT

Package

metalock

Methods

Method: readers-active (READER-WRITER-LOCK reader-writer-lock)

automatically generated reader method

Source

readwriter-lock.lisp (file)

Method: (setf readers-active) NEW-VALUE (READER-WRITER-LOCK reader-writer-lock)

automatically generated writer method

Source

readwriter-lock.lisp (file)

Generic Function: writers-waiting OBJECT

Generic Function: (setf writers-waiting) NEW-VALUE OBJECT

Package

metalock

Methods

Method: writers-waiting (READER-WRITER-LOCK reader-writer-lock)

automatically generated reader method

Source

readwriter-lock.lisp (file)

Method: (setf writers-waiting) NEW-VALUE (READER-WRITER-LOCK reader-writer-lock)

automatically generated writer method

Source

readwriter-lock.lisp (file)

5.2.4 Classes

Class: reader-writer-lock ()

Package

metalock

Source

readwriter-lock.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• active-writer-p (method)
• active-writer-p (method)
• writers-waiting (method)
• writers-waiting (method)
• readers-active (method)
• readers-active (method)
• g-lock (method)
• g-lock (method)
• condition-var (method)
• condition-var (method)

Direct slots

Slot: condition-var

Initform

(bordeaux-threads:make-condition-variable)

Readers

condition-var (generic function)

Writers

(setf condition-var) (generic function)

Slot: g-lock

Type

bordeaux-threads:lock

Initform

(bordeaux-threads:make-lock)

Readers

g-lock (generic function)

Writers

(setf g-lock) (generic function)

Slot: readers-active

Type

integer

Initform

0

Readers

readers-active (generic function)

Writers

(setf readers-active) (generic function)

Slot: writers-waiting

Type

integer

Initform

0

Readers

writers-waiting (generic function)

Writers

(setf writers-waiting) (generic function)

Slot: active-writer-p

Type

boolean

Readers

active-writer-p (generic function)

Writers

(setf active-writer-p) (generic function)

Class: special-slot ()

Package

metalock

Source

metalock.lisp (file)

Direct superclasses

standard-effective-slot-definition (class)

Direct methods

• compute-effective-slot-definition (method)
• validate-superclass (method)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types