The chanl Reference Manual

Table of Contents

The chanl Reference Manual

This is the chanl Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 09:58:36 2020 GMT+0.

1 Introduction

What is ChanL?

"Wh-what you have to understand is that-that ChanL is not a big blob of state. When you have a lot of global state with lots of threads, you need to, you need to lock it down. It's like a truck, and if too many people try to use that truck, you, you get problems. ChanL is not a big truck. It's a series--it's a series of tubes."

• Sen. Ted Stevens

In a nutshell, you create various threads sequentially executing tasks you need done, and use channel objects to communicate and synchronize the state of these threads.

You can read more about what that means here:

• http://swtch.com/~rsc/thread/

• http://www.usingcsp.com/cspbook.pdf

Loading ChanL

ChanL uses asdf for compiling/loading, so in order to load it, you must first make chanl.asd visible to your lisp, then simply

   (asdf:oos 'asdf:load-op 'chanl)

The included examples can be loaded by doing

   (asdf:oos 'asdf:load-op 'chanl.examples)

at the REPL after the main .asd has been loaded.

Compatibility

ChanL uses a subset of Bordeaux-threads for all its operations. All other code is written in ANSI CL, so any lisp with a BT-compatible thread library should be able to use this library.

ChanL is mainly developed on Clozure CL and SBCL, although it's been casually tested on other lisps.

You can run the test suite to see how well it works on yours:

   (asdf:oos 'asdf:test-op 'chanl)

Note that the test-suite depends on 5AM, which can be found at http://github.com/sionescu/fiveam

Channel API

[generic function] make-instance class &rest initargs &key &allow-other-keys

[method] make-instance (class channel) &rest initargs

Returns a new channel object.

[method] make-instance (class unbounded-channel) &rest initargs

Returns a new buffered channel with a FIFO buffer with no maximum length.

[method] make-instance (class bounded-channel) &key (size 1) &rest initargs

Creates a new buffered channel object with a limited buffer size. The buffer has a maximum size of SIZE. Bounded channel buffers are FIFO. When the buffer is full, SEND will block until something is RECVd from the channel.

SIZE must be positive and less than +maximum-buffer-size+, and defaults to 1.

[method] make-instance (class stack-channel) &rest initargs

Returns a new buffered channel with a LIFO buffer with no maximum length.

[constant] +maximum-buffer-size+

This constant has an implementation-dependant value, fixed when ChanL is loaded. It is the exclusive upper bound to the size of a bounded-channel's buffer.

Note that this value might be further limited by memory constraints.

[generic function] send channel value &key

[method] send (channel channel) value &key (blockp t)

Tries to send VALUE into CHANNEL. If the channel is unbufferd or buffered but full, this operation will block until RECV is called on the channel. Returns the channel that the value was sent into. If blockp is NIL, NIL is returned immediately instead of a channel if attempting to send would block.

[method] send (channels sequence) value &key (blockp t)

SEND may be used on a sequence of channels. SEND will linearly attempt to send VALUE into one of the channels in the sequence. It will return immediately as soon as it is able to send VALUE into one channel. If BLOCKP is T (default), SEND will continue to block until one operation succeeds, otherwise, it will return NIL when the sequence has been exhausted.

[generic function] recv channel &key

[method] recv (channel channel) &key (blockp t)

Tries to receive a value from CHANNEL. If the channel is unbuffered, or buffered but empty, this operation will block until SEND is called on the channel. Returns two values: 1. The value received through the channel, and 2. The channel the value was sent into. If BLOCKP is nil, this operation will not block, and will return (values NIL NIL) if attempting it would block.

[method] recv (channel sequence) &key (blockp t)

RECV may be used on a sequence of channels. RECV will linearly attempt to receive a value from one of the channels in teh sequence. It will return immediately as soon as one channel has a value available. As with the method for CHANNEL, this will return the value received, as well as the channel the value was received from. If BLOCKP is NIL, and operating on all channels in sequence would block, (values NIL NIL) is returned instead of blocking.

[macro] select &body clauses* Non-deterministically select a non-blocking clause to execute.

The syntax is:

  select clause*
      clause ::= (op form*)
      op ::= (recv c &optional variable channel-var) | (send c value &optional channel-var)
             | else | otherwise | t
      c ::= An evaluated form representing a channel, or a sequence of channels.
      variable ::= an unevaluated symbol RECV's return value is to be bound to.
      value ::= An evaluated form representing a value to send into the channel.
      channel-var ::= An unevaluated symbol that will be bound to the channel the SEND/RECV
                      operation succeeded on.

SELECT will first attempt to find a clause with a non-blocking op, and execute it. Execution of the check-if-blocks-and-do-it part is atomic, but execution of the clause's body once the SEND/RECV clause executes is NOT atomic. If all channel clauses would block, and no else clause is provided, SELECT will block until one of the clauses is available for execution.

SELECT's non-determinism is, in fact, very non-deterministic. Clauses are chosen at random, not in the order they are written. It's worth noting that SEND/RECV, when used on sequences of channels, are still linear in the way they go through the sequence -- the random selection is reserved for individual SELECT clauses.

Please note that currently, the form for the channel in the RECV and SEND clauses and for the value in the SEND clause might be evaluated multiple times in an unspecified order. It is thus undesirable to place forms with side-effects in these places. This is a bug and will be fixed in a future version of ChanL.

Thread API

[special variable] *default-special-bindings*

An alist of bindings new threads should have. The format is: '((var1 'value) (var2 'value2)).

[function] pcall function &key initial-bindings name

PCALL, a mnemonic for Parallel Call, calls FUNCTION in a new thread. FUNCTION must be a function of zero arguments. INITIAL-BINDINGS, if provided, should be an alist with the same format as default-special-bindings representing dynamic variable bindings that FUNCTION is to be executed with. The default value for INITIAL-BINDINGS is DEFAULT-SPECIAL-BINDINGS.

PCALL returns a task object representing this task. This object is intended for interactive use (ie for debugging), and contains a bit of metadata about the execution. The NAME argument can be used to initialize the name slot of the task object.

[macro] pexec (&key (initial-bindings *default-special-bindings*)) &body body

Executes BODY in parallel. INITIAL-BINDINGS, if provided, should be an alist representing dynamic variable bindings that BODY is to be executed with, as if with default-special-bindings. NAME can be used to initialize the name slot of the returned task object. PEXEC also returns a task.

Thread Introspection

ChanL includes portable support for lisp threads through bordeaux-threads, and adds some sugar on top, such as a built-in thread pool. None of the thread functions here should be used in user code, since they are meant exclusively for development purposes. Most thread-related matters are automatically handled by the thread pool already. In fact, not a single one of these should be expected to work properly when you use them, so do so at your own risk.

[class] task

Tasks represent the bits of work carried out by threads. Task objects should be treated as read- only debugging aids. The functions TASK-NAME, TASK-THREAD, and TASK-STATUS return metadata about the task. Since this is an experimental feature, its API is likely to change -- the current behavior can be checked in src/threads.lisp.

[function] current-thread

Returns the current thread

[function] thread-alive-p thread

T if THREAD is still alive

[function] threadp maybe-thread

T if maybe-thread is, in fact, a thread.

[function] thread-name thread

Returns the name of the thread.

[function] kill thread

Kills thread dead.

[function] all-threads

Returns a list of all threads currently running in the lisp image.

[function] pooled-threads

Returns a list of all threads currently managed by ChanL's thread pool.

[function] pooled-tasks

Returns a list of all tasks pending or live in ChanL's thread pool.

[symbol-macro] %thread-pool-soft-limit

This is a SETFable place. It may be used to inspect and change the soft limit for how many threads the thread pool keeps around. Note that the total number of threads will exceed this limit if threads continue to be spawned while others are still running. This only refers to the number of threads kept alive for later use. The default value is 1000.

Writing your own channels

Currently, ChanL provides a very early API for writing your own channels easily.

[class] abstract-channel

This class is the ancestral superclass of all channels. CHANNELP returns T for any instances of this class or its subclasses.

Direct subclasses of abstract-channel will have to define their own SEND/RECV methods, which should meet the API requirements in order to be compatible with ChanL.

[class] channel

This is the main unbuffered class used in ChanL. Unless you wish to write a new synchronization algorithm for your custom channels, you should subclass CHANNEL, since you then get to reuse ChanL's build-in algorithm (which relies on locks and condition variables).

Subclasses of the CHANNEL class are able to extend behavior in a fairly flexible way by simply writing methods for the following 4 generic functions:

[generic function] send-blocks-p channel

This function returns, as a generalized boolean, whether SEND should block on this channel.

[generic function] recv-blocks-p channel

Like send-blocks-p, but for RECV.

Please note that the consequences of calling send-blocks-p and recv-blocks-p in user code are undefined -- these functions are called from specific points within the carefully instrumented algorithms of the SEND and RECV methods specialized on the CHANNEL class.

[generic function] channel-insert-value channel value

Methods on this function define what actions are taken to insert a value into a channel. Methods should be specialized only on the first argument. This function's return values are ignored.

[generic function] channel-grab-value channel

Methods on this function define how to retrieve a value from a channel. This function must return at least one value, the object retrieved from the channel, which will then be returned by RECV.

Additionally, ChanL uses and exports a number of abstract and concrete classes to implement its buffered channels:

[abstract class] buffered-channel

Abstract class for channels using various buffering styles.

[abstract class] queue-channel

Abstract class for channels whose buffer works like a queue.

[class] bounded-channel

Class used by ChanL's bounded channels (queue channels that block when the queue reaches a certain length).

[class] unbounded-channel

Class used by ChanL's unbounded channels, which are queues of unlimited length (SEND never blocks)

[class] stack-channel

Class used by ChanL's stack channels. These channels' buffers are unbounded LIFO stack structures.

Examples

Create a channel:

 (defvar *c* (make-instance 'channel))

Create a buffered channel with a buffer size of 5. Buffered channels do not block on send until their buffer is full, or on recv until their buffer is empty.

 (defvar *c* (make-instance 'bounded-channel :size 5))

Read a value from a channel (blocks if channel is empty)

 (recv *c*)

Write a value to a channel (blocks if channel is full, always blocks on unbuffered channels)

 (send *c* 99)

Wait for any of a number of things to occur:

 (select
   ((recv c d)
    (format t "got ~a from c~%" d))
   ((send e val)
    (print "sent val on e~%"))
   ((recv *lots-of-channels* value channel)
    (format t "Got ~A from ~C~%" value channel))
   (otherwise
    (print "would have blocked~%")))

Create a new thread continually reading values and printing them:

 (pexec ()
   (loop (format t "~a~%" (recv *c*))))

Create a new thread that runs a function:

 (pcall #'my-function)

Please refer to the examples/ directory for examples of how ChanL can be used, including a parallel prime sieve algorithm translated from Newsqueak and an implementation of future-based concurrency.

2 Systems

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

2.1 chanl

Maintainer

Adlai Chandrasekhar

Author

Kat Marchan

Description

Communicating Sequential Process support for Common Lisp

Dependency

bordeaux-threads

Source

chanl.asd (file)

Component

src (module)

3 Modules

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

3.1 chanl/src

Parent

chanl (system)

Location

src/

Components

• trivial-cas.lisp (file)
• package.lisp (file)
• utils.lisp (file)
• threads.lisp (file)
• queues.lisp (file)
• channels.lisp (file)
• select.lisp (file)
• actors.lisp (file)

4 Files

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

4.1 Lisp

4.1.1 chanl.asd

Location

chanl.asd

Systems

chanl (system)

4.1.2 chanl/src/trivial-cas.lisp

Parent

src (module)

Location

src/trivial-cas.lisp

Packages

trivial-compare-and-swap

Exported Definitions

atomic-incf (macro)

4.1.3 chanl/src/package.lisp

Dependency

trivial-cas.lisp (file)

Parent

src (module)

Location

src/package.lisp

Packages

chanl

4.1.4 chanl/src/utils.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/utils.lisp

Internal Definitions

• aif (macro)
• awhen (macro)
• define-print-object (macro)
• define-speedy-function (macro)
• econd (macro)
• ensure-list (function)
• fun (macro)
• nunzip-alist (function)
• pop-declarations (macro)
• pushend (macro)
• unzip-alist (function)
• when-bind (macro)
• with-gensyms (macro)

4.1.5 chanl/src/threads.lisp

Dependency

utils.lisp (file)

Parent

src (module)

Location

src/threads.lisp

Exported Definitions

• %thread-pool-soft-limit (symbol macro)
• all-threads (function)
• current-thread (function)
• kill (function)
• pcall (function)
• pexec (macro)
• pooled-tasks (function)
• pooled-threads (function)
• task (class)
• task-name (method)
• (setf task-name) (method)
• task-status (method)
• (setf task-status) (method)
• task-thread (method)
• (setf task-thread) (method)
• thread-alive-p (function)
• thread-name (function)
• threadp (function)

Internal Definitions

• *thread-pool* (special variable)
• assign-task (generic function)
• assign-task (method)
• free-thread-counter (method)
• (setf free-thread-counter) (method)
• new-worker-thread (function)
• pool-leader-lock (method)
• pool-leader-notifier (method)
• pool-lock (method)
• pool-pending-tasks (method)
• (setf pool-pending-tasks) (method)
• pool-soft-limit (method)
• (setf pool-soft-limit) (method)
• pool-tasks (method)
• (setf pool-tasks) (method)
• pool-threads (method)
• (setf pool-threads) (method)
• task-function (method)
• thread-pool (class)

4.1.6 chanl/src/queues.lisp

Dependency

threads.lisp (file)

Parent

src (module)

Location

src/queues.lisp

Internal Definitions

• %dequeue (function)
• %enqueue (function)
• %make-queue (function)
• %next-index (function)
• %queue-count (function)
• %queue-empty-p (function)
• %queue-full-p (function)
• %queue-in (function)
• %queue-length (function)
• %queue-out (function)
• %queue-peek (function)
• %queue-zero-p (function)
• dequeue (function)
• enqueue (function)
• make-queue (function)
• queue-condition (condition)
• queue-condition-queue (method)
• queue-count (function)
• queue-empty-p (function)
• queue-error-attempted-length (method)
• queue-full-p (function)
• queue-length (function)
• queue-length-error (condition)
• queue-overflow-error (condition)
• queue-overflow-extra-item (method)
• queue-peek (function)
• queue-sentinel (special variable)
• queue-underflow-error (condition)
• queuep (function)

4.1.7 chanl/src/channels.lisp

Dependency

queues.lisp (file)

Parent

src (module)

Location

src/channels.lisp

Exported Definitions

• +maximum-buffer-size+ (constant)
• abstract-channel (class)
• bounded-channel (class)
• buffered-channel (class)
• cas-channel (class)
• channel (class)
• channel-grab-value (generic function)
• channel-grab-value (method)
• channel-grab-value (method)
• channel-grab-value (method)
• channel-grab-value (method)
• channel-insert-value (generic function)
• channel-insert-value (method)
• channel-insert-value (method)
• channel-insert-value (method)
• channel-insert-value (method)
• channelp (generic function)
• channelp (method)
• channelp (method)
• queue-channel (class)
• recv (generic function)
• recv (method)
• recv (method)
• recv (method)
• recv (method)
• recv-blocks-p (generic function)
• recv-blocks-p (method)
• recv-blocks-p (method)
• recv-blocks-p (method)
• recv-blocks-p (method)
• recv-blocks-p (method)
• send (generic function)
• send (method)
• send (method)
• send (method)
• send (method)
• send-blocks-p (generic function)
• send-blocks-p (method)
• send-blocks-p (method)
• send-blocks-p (method)
• send-blocks-p (method)
• send-blocks-p (method)
• stack-channel (class)
• unbounded-channel (class)

Internal Definitions

• *secret-unbound-value* (special variable)
• cas-channel-set (function)
• channel-being-read-p (function)
• channel-being-written-p (function)
• channel-buffered-p (generic function)
• channel-buffered-p (method)
• channel-buffered-p (method)
• channel-dequeue (generic function)
• channel-dequeue (method)
• channel-dequeue (method)
• channel-enqueue (generic function)
• channel-enqueue (method)
• channel-enqueue (method)
• channel-lock (method)
• (setf channel-lock) (method)
• channel-peek (generic function)
• channel-peek (method)
• channel-peek (method)
• channel-peek (method)
• channel-pop (generic function)
• channel-pop (method)
• channel-push (generic function)
• channel-push (method)
• channel-readers (method)
• channel-readers (method)
• (setf channel-readers) (method)
• channel-recv-ok (method)
• (setf channel-recv-ok) (method)
• channel-send-ok (method)
• (setf channel-send-ok) (method)
• channel-send-return-wait (method)
• (setf channel-send-return-wait) (method)
• channel-value (method)
• channel-value (method)
• (setf channel-value) (method)
• channel-vector (method)
• (setf channel-vector) (method)
• channel-writers (method)
• channel-writers (method)
• (setf channel-writers) (method)
• recv-grabbed-value-p (method)
• recv-grabbed-value-p (method)
• (setf recv-grabbed-value-p) (method)
• with-cas-read-state (macro)
• with-cas-write-state (macro)
• with-read-state (macro)
• with-write-state (macro)

4.1.8 chanl/src/select.lisp

Dependency

channels.lisp (file)

Parent

src (module)

Location

src/select.lisp

Exported Definitions

select (macro)

Internal Definitions

• clause-type (function)
• wrap-select-clause (function)

4.1.9 chanl/src/actors.lisp

Dependency

select.lisp (file)

Parent

src (module)

Location

src/actors.lisp

Packages

chanl.actors

Exported Definitions

• *boss* (special variable)
• actor (class)
• boss (method)
• boss (class)
• christen (generic function)
• christen (method)
• christen (method)
• compute-tubes (generic function)
• compute-tubes (method)
• compute-tubes (method)
• compute-tubes (method)
• ensure-running (generic function)
• ensure-running (method)
• ensure-running (method)
• execute (generic function)
• execute (method)
• execute (method)
• execute (method)
• fire (function)
• halt (function)
• name (method)
• perform (generic function)
• perform (method)
• perform (method)
• perform (method)
• perform (method)
• slot-channel (function)

Internal Definitions

• %kill (function)
• act (generic function)
• act (method)
• launch (function)
• map-workers (function)
• strftime (function)

5 Packages

Packages are listed by definition order.

5.1 trivial-compare-and-swap

Source

trivial-cas.lisp (file)

Nickname

trivial-cas

Use List

common-lisp

Used By List

chanl

Exported Definitions

atomic-incf (macro)

5.2 chanl

Source

package.lisp (file)

Use List

• trivial-compare-and-swap
• common-lisp

Used By List

chanl.actors

Exported Definitions

• %thread-pool-soft-limit (symbol macro)
• +maximum-buffer-size+ (constant)
• abstract-channel (class)
• all-threads (function)
• bounded-channel (class)
• buffered-channel (class)
• cas-channel (class)
• channel (class)
• channel-grab-value (generic function)
• channel-grab-value (method)
• channel-grab-value (method)
• channel-grab-value (method)
• channel-grab-value (method)
• channel-insert-value (generic function)
• channel-insert-value (method)
• channel-insert-value (method)
• channel-insert-value (method)
• channel-insert-value (method)
• channelp (generic function)
• channelp (method)
• channelp (method)
• current-thread (function)
• kill (function)
• pcall (function)
• pexec (macro)
• pooled-tasks (function)
• pooled-threads (function)
• queue-channel (class)
• recv (generic function)
• recv (method)
• recv (method)
• recv (method)
• recv (method)
• recv-blocks-p (generic function)
• recv-blocks-p (method)
• recv-blocks-p (method)
• recv-blocks-p (method)
• recv-blocks-p (method)
• recv-blocks-p (method)
• select (macro)
• send (generic function)
• send (method)
• send (method)
• send (method)
• send (method)
• send-blocks-p (generic function)
• send-blocks-p (method)
• send-blocks-p (method)
• send-blocks-p (method)
• send-blocks-p (method)
• send-blocks-p (method)
• stack-channel (class)
• task (class)
• task-name (generic function)
• task-name (method)
• (setf task-name) (method)
• (setf task-name) (generic function)
• task-status (generic function)
• task-status (method)
• (setf task-status) (method)
• (setf task-status) (generic function)
• task-thread (generic function)
• task-thread (method)
• (setf task-thread) (method)
• (setf task-thread) (generic function)
• thread-alive-p (function)
• thread-name (function)
• threadp (function)
• unbounded-channel (class)

Internal Definitions

• %dequeue (function)
• %enqueue (function)
• %make-queue (function)
• %next-index (function)
• %queue-count (function)
• %queue-empty-p (function)
• %queue-full-p (function)
• %queue-in (function)
• %queue-length (function)
• %queue-out (function)
• %queue-peek (function)
• %queue-zero-p (function)
• *secret-unbound-value* (special variable)
• *thread-pool* (special variable)
• aif (macro)
• assign-task (generic function)
• assign-task (method)
• awhen (macro)
• cas-channel-set (function)
• channel-being-read-p (function)
• channel-being-written-p (function)
• channel-buffered-p (generic function)
• channel-buffered-p (method)
• channel-buffered-p (method)
• channel-dequeue (generic function)
• channel-dequeue (method)
• channel-dequeue (method)
• channel-enqueue (generic function)
• channel-enqueue (method)
• channel-enqueue (method)
• channel-lock (generic function)
• channel-lock (method)
• (setf channel-lock) (method)
• (setf channel-lock) (generic function)
• channel-peek (generic function)
• channel-peek (method)
• channel-peek (method)
• channel-peek (method)
• channel-pop (generic function)
• channel-pop (method)
• channel-push (generic function)
• channel-push (method)
• channel-readers (generic function)
• channel-readers (method)
• channel-readers (method)
• (setf channel-readers) (method)
• (setf channel-readers) (generic function)
• channel-recv-ok (generic function)
• channel-recv-ok (method)
• (setf channel-recv-ok) (method)
• (setf channel-recv-ok) (generic function)
• channel-send-ok (generic function)
• channel-send-ok (method)
• (setf channel-send-ok) (method)
• (setf channel-send-ok) (generic function)
• channel-send-return-wait (generic function)
• channel-send-return-wait (method)
• (setf channel-send-return-wait) (method)
• (setf channel-send-return-wait) (generic function)
• channel-value (generic function)
• channel-value (method)
• channel-value (method)
• (setf channel-value) (method)
• (setf channel-value) (generic function)
• channel-vector (generic function)
• channel-vector (method)
• (setf channel-vector) (method)
• (setf channel-vector) (generic function)
• channel-writers (generic function)
• channel-writers (method)
• channel-writers (method)
• (setf channel-writers) (method)
• (setf channel-writers) (generic function)
• clause-type (function)
• define-print-object (macro)
• define-speedy-function (macro)
• dequeue (function)
• econd (macro)
• enqueue (function)
• ensure-list (function)
• free-thread-counter (generic function)
• free-thread-counter (method)
• (setf free-thread-counter) (method)
• (setf free-thread-counter) (generic function)
• fun (macro)
• make-queue (function)
• new-worker-thread (function)
• nunzip-alist (function)
• pool-leader-lock (generic function)
• pool-leader-lock (method)
• pool-leader-notifier (generic function)
• pool-leader-notifier (method)
• pool-lock (generic function)
• pool-lock (method)
• pool-pending-tasks (generic function)
• pool-pending-tasks (method)
• (setf pool-pending-tasks) (method)
• (setf pool-pending-tasks) (generic function)
• pool-soft-limit (generic function)
• pool-soft-limit (method)
• (setf pool-soft-limit) (method)
• (setf pool-soft-limit) (generic function)
• pool-tasks (generic function)
• pool-tasks (method)
• (setf pool-tasks) (method)
• (setf pool-tasks) (generic function)
• pool-threads (generic function)
• pool-threads (method)
• (setf pool-threads) (method)
• (setf pool-threads) (generic function)
• pop-declarations (macro)
• pushend (macro)
• queue-condition (condition)
• queue-condition-queue (generic function)
• queue-condition-queue (method)
• queue-count (function)
• queue-empty-p (function)
• queue-error-attempted-length (generic function)
• queue-error-attempted-length (method)
• queue-full-p (function)
• queue-length (function)
• queue-length-error (condition)
• queue-overflow-error (condition)
• queue-overflow-extra-item (generic function)
• queue-overflow-extra-item (method)
• queue-peek (function)
• queue-sentinel (special variable)
• queue-underflow-error (condition)
• queuep (function)
• recv-grabbed-value-p (generic function)
• recv-grabbed-value-p (method)
• recv-grabbed-value-p (method)
• (setf recv-grabbed-value-p) (method)
• (setf recv-grabbed-value-p) (generic function)
• task-function (generic function)
• task-function (method)
• thread-pool (class)
• unzip-alist (function)
• when-bind (macro)
• with-cas-read-state (macro)
• with-cas-write-state (macro)
• with-gensyms (macro)
• with-read-state (macro)
• with-write-state (macro)
• wrap-select-clause (function)

5.3 chanl.actors

Source

actors.lisp (file)

Use List

• chanl
• common-lisp

Exported Definitions

• *boss* (special variable)
• actor (class)
• boss (generic function)
• boss (method)
• boss (class)
• christen (generic function)
• christen (method)
• christen (method)
• compute-tubes (generic function)
• compute-tubes (method)
• compute-tubes (method)
• compute-tubes (method)
• ensure-running (generic function)
• ensure-running (method)
• ensure-running (method)
• execute (generic function)
• execute (method)
• execute (method)
• execute (method)
• fire (function)
• halt (function)
• name (generic function)
• name (method)
• perform (generic function)
• perform (method)
• perform (method)
• perform (method)
• perform (method)
• slot-channel (function)

Internal Definitions

• %kill (function)
• act (generic function)
• act (method)
• launch (function)
• map-workers (function)
• strftime (function)

6 Definitions

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

6.1 Exported definitions

6.1.1 Constants

Constant: +maximum-buffer-size+

The exclusive upper bound on the size of a channel’s buffer.

Package

chanl

Source

channels.lisp (file)

6.1.2 Special variables

Special Variable: *boss*

Package

chanl.actors

Source

actors.lisp (file)

6.1.3 Symbol macros

Symbol Macro: %thread-pool-soft-limit

Package

chanl

Source

threads.lisp (file)

Expansion

(chanl::pool-soft-limit chanl::*thread-pool*)

6.1.4 Macros

Macro: atomic-incf PLACE &optional DELTA

Package

trivial-compare-and-swap

Source

trivial-cas.lisp (file)

Macro: pexec (&key INITIAL-BINDINGS NAME) &body BODY

Executes BODY in parallel. INITIAL-BINDINGS, if provided, should be an alist representing dynamic variable bindings that BODY is to be executed with. The format is: ’((*var* value)).

Package

chanl

Source

threads.lisp (file)

Macro: select &body CLAUSES

Non-deterministically select a non-blocking clause to execute.

The syntax is:

select clause*
clause ::= (op form*)
op ::= (recv c &optional variable channel-var) | (send c value &optional channel-var)
| else | otherwise | t
c ::= An evaluated form representing a channel, or a sequence of channels.
variable ::= an unevaluated symbol RECV’s return value is to be bound to. Made available to form*. value ::= An evaluated form representing a value to send into the channel.
channel-var ::= An unevaluated symbol that will be bound to the channel the SEND/RECV operation succeeded on.

SELECT will first attempt to find a clause with a non-blocking op, and execute it. Execution of the check-if-blocks-and-do-it part is atomic, but execution of the clause’s body once the SEND/RECV clause executes is NOT atomic. If all channel clauses would block, and no else clause is provided, SELECT will thrash-idle (an undesirable state!) until one of the clauses is available for execution.

SELECT’s non-determinism is, in fact, very non-deterministic. Clauses are chosen at random, not in the order they are written. It’s worth noting that SEND/RECV, when used on sequences of channels, are still linear in the way they go through the sequence – the random selection is reserved for individual SELECT clauses.

Package

chanl

Source

select.lisp (file)

6.1.5 Functions

Function: all-threads ()

Package

chanl

Source

threads.lisp (file)

Function: current-thread ()

Package

chanl

Source

threads.lisp (file)

Function: fire ACTOR

Package

chanl.actors

Source

actors.lisp (file)

Function: halt ACTOR

Package

chanl.actors

Source

actors.lisp (file)

Function: kill PROC

Package

chanl

Source

threads.lisp (file)

Function: pcall FUNCTION &key INITIAL-BINDINGS NAME

PCALL -> Parallel Call; calls FUNCTION in a new thread. FUNCTION must be a no-argument function. INITIAL-BINDINGS, if provided, should be an alist representing dynamic variable bindings that BODY is to be executed with. The format is: ’((*var* value)).

Package

chanl

Source

threads.lisp (file)

Function: pooled-tasks ()

Package

chanl

Source

threads.lisp (file)

Function: pooled-threads ()

Package

chanl

Source

threads.lisp (file)

Function: slot-channel ACTOR SLOT

Returns the channel associated with ‘slot’ in ‘actor’

Package

chanl.actors

Source

actors.lisp (file)

Function: thread-alive-p PROC

Package

chanl

Source

threads.lisp (file)

Function: thread-name PROC

Package

chanl

Source

threads.lisp (file)

Function: threadp PROC

Package

chanl

Source

threads.lisp (file)

6.1.6 Generic functions

Generic Function: boss OBJECT

Package

chanl.actors

Methods

Method: boss (ACTOR actor)

For whom[’s benefit] the bell tolls

Source

actors.lisp (file)

Generic Function: channel-grab-value CHANNEL

Package

chanl

Source

channels.lisp (file)

Methods

Method: channel-grab-value (CHANNEL cas-channel)

Method: channel-grab-value (CHANNEL queue-channel)

Method: channel-grab-value (CHANNEL stack-channel)

Method: channel-grab-value (CHANNEL channel)

Generic Function: channel-insert-value CHANNEL VALUE

Package

chanl

Source

channels.lisp (file)

Methods

Method: channel-insert-value (CHANNEL cas-channel) VALUE

Method: channel-insert-value (CHANNEL queue-channel) VALUE

Method: channel-insert-value (CHANNEL stack-channel) VALUE

Method: channel-insert-value (CHANNEL channel) VALUE

Generic Function: channelp CHANNEL

Package

chanl

Source

channels.lisp (file)

Methods

Method: channelp ANYTHING-ELSE

Method: channelp (CHANNEL abstract-channel)

Generic Function: christen ACTOR

Package

chanl.actors

Source

actors.lisp (file)

Methods

Method: christen (ACTOR actor)

Method: christen (ACTOR actor) around

Generic Function: compute-tubes ACTOR

Calculates the list of communication slots for ‘actor’.
Methods should return a list of specifications (or a single one as an atom)

Package

chanl.actors

Source

actors.lisp (file)

Method Combination

list (short method combination)

Options: :most-specific-last

Methods

Method: compute-tubes (BOSS boss) list

Method: compute-tubes (ACTOR actor) around

Combines the specifications, creating channels if necessary

Method: compute-tubes (ACTOR actor) list

Generic Function: ensure-running ACTOR

Package

chanl.actors

Source

actors.lisp (file)

Methods

Method: ensure-running (BOSS boss) after

Method: ensure-running (ACTOR actor)

Generic Function: execute ACTOR COMMAND

Package

chanl.actors

Source

actors.lisp (file)

Methods

Method: execute (BOSS boss) (COMMAND (eql die)) before

Method: execute (ACTOR actor) (COMMAND function)

Method: execute (ACTOR actor) (COMMAND (eql die))

Generic Function: name OBJECT

Package

chanl.actors

Methods

Method: name (ACTOR actor)

Name for identifying this actor and its tasks

Source

actors.lisp (file)

Generic Function: perform ACTOR &key

Implement actor’s behavior, executing commands by default

Package

chanl.actors

Source

actors.lisp (file)

Method Combination

select (long method combination)

Methods

Method: perform (BOSS boss) &key recv to-fire

Method: perform (BOSS boss) &key recv to-halt

Method: perform (BOSS boss) &key recv to-run

Method: perform (ACTOR actor) &key recv command

Generic Function: recv CHAN &key BLOCKP

Tries to receive from either a single channel, or a sequence of channels. If
BLOCKP is true, RECV will block until it’s possible to receive something. Returns two values: The first is the actual value received through the channel. The second is the channel the value was received from. When BLOCKP is NIL, RECV will immediately return (values NIL NIL) instead of blocking (if it would block)

Package

chanl

Source

channels.lisp (file)

Methods

Method: recv (CHANNEL cas-channel) &key BLOCKP

Method: recv (CHANNEL channel) &key BLOCKP

Method: recv (CHANNELS null) &key

Method: recv (CHANNELS sequence) &key BLOCKP

Generic Function: recv-blocks-p CHANNEL

Returns T if trying to RECV from CHANNEL would block.

Assumes that the calling context holds the channel’s lock.

Package

chanl

Source

channels.lisp (file)

Methods

Method: recv-blocks-p (CHANNEL cas-channel)

Method: recv-blocks-p (CHANNEL unbounded-channel)

Method: recv-blocks-p (CHANNEL bounded-channel)

Method: recv-blocks-p (CHANNEL stack-channel)

Method: recv-blocks-p (CHANNEL channel)

Generic Function: send CHAN VALUE &key BLOCKP

Tries to send VALUE into CHAN. If a sequence of channels is provided
instead of a single channel, SEND will send the value into the first channel that doesn’t block. If BLOCKP is true, SEND will continue to block until it’s able to actually send a value. If BLOCKP is NIL, SEND will immediately return NIL instead of blocking, if there’s no channel available to send input into. When SEND succeeds, it returns the channel the value was sent into.

Package

chanl

Source

channels.lisp (file)

Methods

Method: send (CHANNEL cas-channel) VALUE &key BLOCKP

Method: send (CHANNEL channel) VALUE &key BLOCKP

Method: send (CHANNELS null) VALUE &key

Method: send (CHANNELS sequence) VALUE &key BLOCKP

Generic Function: send-blocks-p CHANNEL

Returns T if trying to SEND to CHANNEL would block.

Assumes that the calling context holds the channel’s lock.

Package

chanl

Source

channels.lisp (file)

Methods

Method: send-blocks-p (CHANNEL cas-channel)

Method: send-blocks-p (CHANNEL unbounded-channel)

Method: send-blocks-p (CHANNEL bounded-channel)

Method: send-blocks-p (CHANNEL stack-channel)

Method: send-blocks-p (CHANNEL channel)

Generic Function: task-name OBJECT

Generic Function: (setf task-name) NEW-VALUE OBJECT

Package

chanl

Methods

Method: task-name (TASK task)

automatically generated reader method

Source

threads.lisp (file)

Method: (setf task-name) NEW-VALUE (TASK task)

automatically generated writer method

Source

threads.lisp (file)

Generic Function: task-status OBJECT

Generic Function: (setf task-status) NEW-VALUE OBJECT

Package

chanl

Methods

Method: task-status (TASK task)

automatically generated reader method

Source

threads.lisp (file)

Method: (setf task-status) NEW-VALUE (TASK task)

automatically generated writer method

Source

threads.lisp (file)

Generic Function: task-thread OBJECT

Generic Function: (setf task-thread) NEW-VALUE OBJECT

Package

chanl

Methods

Method: task-thread (TASK task)

automatically generated reader method

Source

threads.lisp (file)

Method: (setf task-thread) NEW-VALUE (TASK task)

automatically generated writer method

Source

threads.lisp (file)

6.1.7 Classes

Class: abstract-channel ()

Package

chanl

Source

channels.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

• channel (class)
• cas-channel (class)

Direct methods

channelp (method)

Class: actor ()

Package

chanl.actors

Source

actors.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

boss (class)

Direct methods

• shared-initialize (method)
• initialize-instance (method)
• ensure-running (method)
• execute (method)
• execute (method)
• perform (method)
• slot-missing (method)
• slot-missing (method)
• print-object (method)
• slot-unbound (method)
• christen (method)
• christen (method)
• compute-tubes (method)
• compute-tubes (method)
• boss (method)
• name (method)

Direct slots

Slot: name

Name for identifying this actor and its tasks

Initargs

:name

Readers

name (generic function)

Slot: abbrev

Allocation

:class

Slot: state

Represents/performs actor’s state

Initform

(quote chanl.actors:perform)

Slot: tubes

Channels used for communication

Slot: boss

For whom[’s benefit] the bell tolls

Type

(or null bordeaux-threads:thread chanl.actors:boss)

Initargs

:boss

Initform

chanl.actors:*boss*

Readers

boss (generic function)

Slot: command

Command being executed by the actor

Class: boss ()

Package

chanl.actors

Source

actors.lisp (file)

Direct superclasses

actor (class)

Direct methods

• perform (method)
• perform (method)
• perform (method)
• execute (method)
• ensure-running (method)
• compute-tubes (method)

Direct slots

Slot: workers

Workers managed by this boss

Slot: to-run

New actor to manage

Slot: to-halt

Actor to halt, but keep its link

Slot: to-fire

Actor to both halt and unlink

Class: bounded-channel ()

Package

chanl

Source

channels.lisp (file)

Direct superclasses

queue-channel (class)

Direct methods

• channel-dequeue (method)
• recv-blocks-p (method)
• channel-enqueue (method)
• send-blocks-p (method)
• channel-peek (method)
• print-object (method)
• initialize-instance (method)

Class: buffered-channel ()

Abstract class for channels using various buffering styles.

Package

chanl

Source

channels.lisp (file)

Direct superclasses

channel (class)

Direct subclasses

• stack-channel (class)
• queue-channel (class)

Direct methods

channel-buffered-p (method)

Class: cas-channel ()

These channels use COMPARE-AND-SWAP to do their thing, instead of locks+condition-vars. Ideally, these would be faster than regular channels. In reality, they’re not. It’s possible there might be a way to speed these guys up while keeping the same behavior in the interface, but for now, they’re about 100x slower, not to mention non-portable.

Package

chanl

Source

channels.lisp (file)

Direct superclasses

abstract-channel (class)

Direct methods

• channel-grab-value (method)
• recv-blocks-p (method)
• recv (method)
• channel-insert-value (method)
• send-blocks-p (method)
• send (method)
• recv-grabbed-value-p (method)
• channel-writers (method)
• channel-readers (method)
• channel-value (method)
• channel-vector (method)
• channel-vector (method)

Direct slots

Slot: vector

Initform

(vector chanl::*secret-unbound-value* 0 0 nil)

Readers

channel-vector (generic function)

Writers

(setf channel-vector) (generic function)

Class: channel ()

Package

chanl

Source

channels.lisp (file)

Direct superclasses

abstract-channel (class)

Direct subclasses

buffered-channel (class)

Direct methods

• channel-grab-value (method)
• recv-blocks-p (method)
• recv (method)
• send-blocks-p (method)
• channel-insert-value (method)
• send (method)
• recv-grabbed-value-p (method)
• recv-grabbed-value-p (method)
• channel-send-return-wait (method)
• channel-send-return-wait (method)
• channel-recv-ok (method)
• channel-recv-ok (method)
• channel-send-ok (method)
• channel-send-ok (method)
• channel-lock (method)
• channel-lock (method)
• channel-writers (method)
• channel-writers (method)
• channel-readers (method)
• channel-readers (method)
• channel-value (method)
• channel-value (method)

Direct slots

Slot: value

Initform

chanl::*secret-unbound-value*

Readers

channel-value (generic function)

Writers

(setf channel-value) (generic function)

Slot: readers

Initform

0

Readers

channel-readers (generic function)

Writers

(setf channel-readers) (generic function)

Slot: writers

Initform

0

Readers

channel-writers (generic function)

Writers

(setf channel-writers) (generic function)

Slot: lock

Initform

(bordeaux-threads:make-recursive-lock)

Readers

channel-lock (generic function)

Writers

(setf channel-lock) (generic function)

Slot: send-ok

Initform

(bordeaux-threads:make-condition-variable)

Readers

channel-send-ok (generic function)

Writers

(setf channel-send-ok) (generic function)

Slot: recv-ok

Initform

(bordeaux-threads:make-condition-variable)

Readers

channel-recv-ok (generic function)

Writers

(setf channel-recv-ok) (generic function)

Slot: send-return-wait

Initform

(bordeaux-threads:make-condition-variable)

Readers

channel-send-return-wait (generic function)

Writers

(setf channel-send-return-wait) (generic function)

Slot: recv-grabbed-value-p

Readers

recv-grabbed-value-p (generic function)

Writers

(setf recv-grabbed-value-p) (generic function)

Class: queue-channel ()

These channels buffer objects in some sort of queue.

Package

chanl

Source

channels.lisp (file)

Direct superclasses

buffered-channel (class)

Direct subclasses

• bounded-channel (class)
• unbounded-channel (class)

Direct methods

• channel-grab-value (method)
• channel-insert-value (method)

Class: stack-channel ()

Package

chanl

Source

channels.lisp (file)

Direct superclasses

buffered-channel (class)

Direct methods

• recv-blocks-p (method)
• send-blocks-p (method)
• channel-grab-value (method)
• channel-insert-value (method)
• channel-push (method)
• channel-pop (method)
• channel-peek (method)
• print-object (method)
• initialize-instance (method)

Class: task ()

Package

chanl

Source

threads.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• assign-task (method)
• print-object (method)
• task-thread (method)
• task-thread (method)
• task-status (method)
• task-status (method)
• task-function (method)
• task-name (method)
• task-name (method)

Direct slots

Slot: name

Initargs

:name

Initform

"anonymous task"

Readers

task-name (generic function)

Writers

(setf task-name) (generic function)

Slot: function

Initargs

:function

Initform

(error "must supply a task-function")

Readers

task-function (generic function)

Slot: status

Initform

:pending

Readers

task-status (generic function)

Writers

(setf task-status) (generic function)

Slot: thread

Readers

task-thread (generic function)

Writers

(setf task-thread) (generic function)

Class: unbounded-channel ()

Package

chanl

Source

channels.lisp (file)

Direct superclasses

queue-channel (class)

Direct methods

• channel-dequeue (method)
• recv-blocks-p (method)
• channel-enqueue (method)
• send-blocks-p (method)
• channel-peek (method)
• print-object (method)
• initialize-instance (method)

6.2 Internal definitions

6.2.1 Special variables

Special Variable: *secret-unbound-value*

This value is used as a sentinel in channels.

Package

chanl

Source

channels.lisp (file)

Special Variable: *thread-pool*

Package

chanl

Source

threads.lisp (file)

Special Variable: queue-sentinel

Package

chanl

Source

queues.lisp (file)

6.2.2 Macros

Macro: aif TEST THEN &optional ELSE

Package

chanl

Source

utils.lisp (file)

Macro: awhen TEST &body BODY

Package

chanl

Source

utils.lisp (file)

Macro: define-print-object ((OBJECT CLASS) &key IDENTITY TYPE) &body BODY

Package

chanl

Source

utils.lisp (file)

Macro: define-speedy-function NAME ARGS &body BODY

Package

chanl

Source

utils.lisp (file)

Macro: econd &body COND-CLAUSES

Like ‘ecase’, but for ‘cond’. An optional initial string is used as the error message.

Package

chanl

Source

utils.lisp (file)

Macro: fun &body BODY

This macro puts the FUN back in FUNCTION.

Package

chanl

Source

utils.lisp (file)

Macro: pop-declarations PLACE

Returns and removes all leading declarations from PLACE, which should be a setf-able form. NOTE: Does not support docstrings.

Package

chanl

Source

utils.lisp (file)

Macro: pushend NEW-ITEM LIST LIST-END

Package

chanl

Source

utils.lisp (file)

Macro: when-bind VARIABLE TEST &body BODY

Package

chanl

Source

utils.lisp (file)

Macro: with-cas-read-state CHANNEL &body BODY

Package

chanl

Source

channels.lisp (file)

Macro: with-cas-write-state CHANNEL &body BODY

Package

chanl

Source

channels.lisp (file)

Macro: with-gensyms NAMES &body BODY

Package

chanl

Source

utils.lisp (file)

Macro: with-read-state CHANNEL &body BODY

Package

chanl

Source

channels.lisp (file)

Macro: with-write-state CHANNEL &body BODY

Package

chanl

Source

channels.lisp (file)

6.2.3 Functions

Function: %dequeue ()

Sets QUEUE’s tail to QUEUE, increments QUEUE’s tail pointer, and returns the previous tail ref

Package

chanl

Source

queues.lisp (file)

Function: %enqueue ()

Enqueue OBJECT and increment QUEUE’s entry pointer

Package

chanl

Source

queues.lisp (file)

Function: %kill ACTOR

Package

chanl.actors

Source

actors.lisp (file)

Function: %make-queue ()

Creates a new queue of maximum size LENGTH

Package

chanl

Source

queues.lisp (file)

Function: %next-index ()

Package

chanl

Source

queues.lisp (file)

Function: %queue-count ()

Returns QUEUE’s effective length

Package

chanl

Source

queues.lisp (file)

Function: %queue-empty-p ()

Checks whether QUEUE is effectively empty

Package

chanl

Source

queues.lisp (file)

Function: %queue-full-p ()

Checks whether QUEUE is effectively full

Package

chanl

Source

queues.lisp (file)

Function: %queue-in ()

QUEUE’s entry pointer

Package

chanl

Source

queues.lisp (file)

Function: %queue-length ()

Returns QUEUE’s maximum length

Package

chanl

Source

queues.lisp (file)

Function: %queue-out ()

QUEUE’s exit pointer

Package

chanl

Source

queues.lisp (file)

Function: %queue-peek ()

Dereference QUEUE’s exit pointer

Package

chanl

Source

queues.lisp (file)

Function: %queue-zero-p ()

Checks whether QUEUE’s theoretical length is zero

Package

chanl

Source

queues.lisp (file)

Function: cas-channel-set SLOT-NAME CHANNEL VALUE

Package

chanl

Source

channels.lisp (file)

Function: channel-being-read-p CHANNEL

Package

chanl

Source

channels.lisp (file)

Function: channel-being-written-p CHANNEL

Package

chanl

Source

channels.lisp (file)

Function: clause-type CLAUSE

Package

chanl

Source

select.lisp (file)

Function: dequeue QUEUE

Dequeues QUEUE

Package

chanl

Source

queues.lisp (file)

Function: enqueue OBJECT QUEUE

Enqueues OBJECT in QUEUE

Package

chanl

Source

queues.lisp (file)

Function: ensure-list X

Package

chanl

Source

utils.lisp (file)

Function: launch ACTOR

Package

chanl.actors

Source

actors.lisp (file)

Function: make-queue SIZE

Makes a queue of maximum size SIZE

Package

chanl

Source

queues.lisp (file)

Function: map-workers BOSS FUNCTION

Package

chanl.actors

Source

actors.lisp (file)

Function: new-worker-thread THREAD-POOL &optional TASK

Package

chanl

Source

threads.lisp (file)

Function: nunzip-alist ALIST &aux KEYS VALS

Destructive, non-consing version of ‘unzip-alist’.

Package

chanl

Source

utils.lisp (file)

Function: queue-count QUEUE

Returns the current size of QUEUE

Package

chanl

Source

queues.lisp (file)

Function: queue-empty-p QUEUE

Tests whether QUEUE is empty

Package

chanl

Source

queues.lisp (file)

Function: queue-full-p QUEUE

Tests whether QUEUE is full

Package

chanl

Source

queues.lisp (file)

Function: queue-length QUEUE

Returns the maximum size of QUEUE

Package

chanl

Source

queues.lisp (file)

Function: queue-peek QUEUE

Package

chanl

Source

queues.lisp (file)

Function: queuep ()

If this returns NIL, X is not a queue

Package

chanl

Source

queues.lisp (file)

Function: strftime &optional DATEP &aux BITS

Package

chanl.actors

Source

actors.lisp (file)

Function: unzip-alist ALIST

Returns two fresh lists containing the keys and values of ALIST

Package

chanl

Source

utils.lisp (file)

Function: wrap-select-clause CLAUSE

Package

chanl

Source

select.lisp (file)

6.2.4 Generic functions

Generic Function: act CLASS &key

Package

chanl.actors

Source

actors.lisp (file)

Methods

Method: act (CLASS symbol) &rest INITARGS

Generic Function: assign-task THREAD-POOL TASK

Package

chanl

Source

threads.lisp (file)

Methods

Method: assign-task (THREAD-POOL thread-pool) (TASK task)

Generic Function: channel-buffered-p CHANNEL

Package

chanl

Source

channels.lisp (file)

Methods

Method: channel-buffered-p ANYTHING-ELSE

Method: channel-buffered-p (CHANNEL buffered-channel)

Generic Function: channel-dequeue CHANNEL

Dequeue a value from CHANNEL’s buffer queue.

Package

chanl

Source

channels.lisp (file)

Methods

Method: channel-dequeue (CHANNEL unbounded-channel)

Method: channel-dequeue (CHANNEL bounded-channel)

Generic Function: channel-enqueue VALUE CHANNEL

Enqueue VALUE in CHANNEL’s buffer queue.

Package

chanl

Source

channels.lisp (file)

Methods

Method: channel-enqueue VALUE (CHANNEL unbounded-channel)

Method: channel-enqueue VALUE (CHANNEL bounded-channel)

Generic Function: channel-lock OBJECT

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

Package

chanl

Methods

Method: channel-lock (CHANNEL channel)

automatically generated reader method

Source

channels.lisp (file)

Method: (setf channel-lock) NEW-VALUE (CHANNEL channel)

automatically generated writer method

Source

channels.lisp (file)

Generic Function: channel-peek CHANNEL

Peek at a possible next value CHANNEL would dequeue. An actual call to RECV may return a different value, if the previously-peeked one has been received by a different thread in the meantime.

Returns two values: the value of interest or NIL, and a generalized boolean that is NIL when there is no available value in the queue.

Package

chanl

Source

channels.lisp (file)

Methods

Method: channel-peek (CHANNEL unbounded-channel)

Method: channel-peek (CHANNEL bounded-channel)

Method: channel-peek (CHANNEL stack-channel)

Generic Function: channel-pop CHANNEL

Package

chanl

Source

channels.lisp (file)

Methods

Method: channel-pop (CHANNEL stack-channel)

Generic Function: channel-push VALUE CHANNEL

Package

chanl

Source

channels.lisp (file)

Methods

Method: channel-push VALUE (CHANNEL stack-channel)

Generic Function: channel-readers OBJECT

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

Package

chanl

Methods

Method: channel-readers (CHANNEL cas-channel)

Source

channels.lisp (file)

Method: channel-readers (CHANNEL channel)

automatically generated reader method

Source

channels.lisp (file)

Method: (setf channel-readers) NEW-VALUE (CHANNEL channel)

automatically generated writer method

Source

channels.lisp (file)

Generic Function: channel-recv-ok OBJECT

Generic Function: (setf channel-recv-ok) NEW-VALUE OBJECT

Package

chanl

Methods

Method: channel-recv-ok (CHANNEL channel)

automatically generated reader method

Source

channels.lisp (file)

Method: (setf channel-recv-ok) NEW-VALUE (CHANNEL channel)

automatically generated writer method

Source

channels.lisp (file)

Generic Function: channel-send-ok OBJECT

Generic Function: (setf channel-send-ok) NEW-VALUE OBJECT

Package

chanl

Methods

Method: channel-send-ok (CHANNEL channel)

automatically generated reader method

Source

channels.lisp (file)

Method: (setf channel-send-ok) NEW-VALUE (CHANNEL channel)

automatically generated writer method

Source

channels.lisp (file)

Generic Function: channel-send-return-wait OBJECT

Generic Function: (setf channel-send-return-wait) NEW-VALUE OBJECT

Package

chanl

Methods

Method: channel-send-return-wait (CHANNEL channel)

automatically generated reader method

Source

channels.lisp (file)

Method: (setf channel-send-return-wait) NEW-VALUE (CHANNEL channel)

automatically generated writer method

Source

channels.lisp (file)

Generic Function: channel-value OBJECT

Generic Function: (setf channel-value) NEW-VALUE OBJECT

Package

chanl

Methods

Method: channel-value (CHANNEL cas-channel)

Source

channels.lisp (file)

Method: channel-value (CHANNEL channel)

automatically generated reader method

Source

channels.lisp (file)

Method: (setf channel-value) NEW-VALUE (CHANNEL channel)

automatically generated writer method

Source

channels.lisp (file)

Generic Function: channel-vector OBJECT

Generic Function: (setf channel-vector) NEW-VALUE OBJECT

Package

chanl

Methods

Method: channel-vector (CAS-CHANNEL cas-channel)

automatically generated reader method

Source

channels.lisp (file)

Method: (setf channel-vector) NEW-VALUE (CAS-CHANNEL cas-channel)

automatically generated writer method

Source

channels.lisp (file)

Generic Function: channel-writers OBJECT

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

Package

chanl

Methods

Method: channel-writers (CHANNEL cas-channel)

Source

channels.lisp (file)

Method: channel-writers (CHANNEL channel)

automatically generated reader method

Source

channels.lisp (file)

Method: (setf channel-writers) NEW-VALUE (CHANNEL channel)

automatically generated writer method

Source

channels.lisp (file)

Generic Function: free-thread-counter OBJECT

Generic Function: (setf free-thread-counter) NEW-VALUE OBJECT

Package

chanl

Methods

Method: free-thread-counter (THREAD-POOL thread-pool)

automatically generated reader method

Source

threads.lisp (file)

Method: (setf free-thread-counter) NEW-VALUE (THREAD-POOL thread-pool)

automatically generated writer method

Source

threads.lisp (file)

Generic Function: pool-leader-lock OBJECT

Package

chanl

Methods

Method: pool-leader-lock (THREAD-POOL thread-pool)

automatically generated reader method

Source

threads.lisp (file)

Generic Function: pool-leader-notifier OBJECT

Package

chanl

Methods

Method: pool-leader-notifier (THREAD-POOL thread-pool)

automatically generated reader method

Source

threads.lisp (file)

Generic Function: pool-lock OBJECT

Package

chanl

Methods

Method: pool-lock (THREAD-POOL thread-pool)

automatically generated reader method

Source

threads.lisp (file)

Generic Function: pool-pending-tasks OBJECT

Generic Function: (setf pool-pending-tasks) NEW-VALUE OBJECT

Package

chanl

Methods

Method: pool-pending-tasks (THREAD-POOL thread-pool)

automatically generated reader method

Source

threads.lisp (file)

Method: (setf pool-pending-tasks) NEW-VALUE (THREAD-POOL thread-pool)

automatically generated writer method

Source

threads.lisp (file)

Generic Function: pool-soft-limit OBJECT

Generic Function: (setf pool-soft-limit) NEW-VALUE OBJECT

Package

chanl

Methods

Method: pool-soft-limit (THREAD-POOL thread-pool)

automatically generated reader method

Source

threads.lisp (file)

Method: (setf pool-soft-limit) NEW-VALUE (THREAD-POOL thread-pool)

automatically generated writer method

Source

threads.lisp (file)

Generic Function: pool-tasks OBJECT

Generic Function: (setf pool-tasks) NEW-VALUE OBJECT

Package

chanl

Methods

Method: pool-tasks (THREAD-POOL thread-pool)

automatically generated reader method

Source

threads.lisp (file)

Method: (setf pool-tasks) NEW-VALUE (THREAD-POOL thread-pool)

automatically generated writer method

Source

threads.lisp (file)

Generic Function: pool-threads OBJECT

Generic Function: (setf pool-threads) NEW-VALUE OBJECT

Package

chanl

Methods

Method: pool-threads (THREAD-POOL thread-pool)

automatically generated reader method

Source

threads.lisp (file)

Method: (setf pool-threads) NEW-VALUE (THREAD-POOL thread-pool)

automatically generated writer method

Source

threads.lisp (file)

Generic Function: queue-condition-queue CONDITION

Package

chanl

Methods

Method: queue-condition-queue (CONDITION queue-condition)

Source

queues.lisp (file)

Generic Function: queue-error-attempted-length CONDITION

Package

chanl

Methods

Method: queue-error-attempted-length (CONDITION queue-length-error)

Source

queues.lisp (file)

Generic Function: queue-overflow-extra-item CONDITION

Package

chanl

Methods

Method: queue-overflow-extra-item (CONDITION queue-overflow-error)

Source

queues.lisp (file)

Generic Function: recv-grabbed-value-p OBJECT

Generic Function: (setf recv-grabbed-value-p) NEW-VALUE OBJECT

Package

chanl

Methods

Method: recv-grabbed-value-p (CHANNEL cas-channel)

Source

channels.lisp (file)

Method: recv-grabbed-value-p (CHANNEL channel)

automatically generated reader method

Source

channels.lisp (file)

Method: (setf recv-grabbed-value-p) NEW-VALUE (CHANNEL channel)

automatically generated writer method

Source

channels.lisp (file)

Generic Function: task-function OBJECT

Package

chanl

Methods

Method: task-function (TASK task)

automatically generated reader method

Source

threads.lisp (file)

6.2.5 Conditions

Condition: queue-condition ()

Package

chanl

Source

queues.lisp (file)

Direct superclasses

error (condition)

Direct subclasses

• queue-length-error (condition)
• queue-overflow-error (condition)
• queue-underflow-error (condition)

Direct methods

queue-condition-queue (method)

Direct slots

Slot: queue

Initargs

:queue

Readers

queue-condition-queue (generic function)

Condition: queue-length-error ()

Package

chanl

Source

queues.lisp (file)

Direct superclasses

queue-condition (condition)

Direct methods

queue-error-attempted-length (method)

Direct slots

Slot: attempted-length

Initargs

:attempted-length

Readers

queue-error-attempted-length (generic function)

Condition: queue-overflow-error ()

Package

chanl

Source

queues.lisp (file)

Direct superclasses

queue-condition (condition)

Direct methods

queue-overflow-extra-item (method)

Direct slots

Slot: item

Initargs

:item

Readers

queue-overflow-extra-item (generic function)

Condition: queue-underflow-error ()

Package

chanl

Source

queues.lisp (file)

Direct superclasses

queue-condition (condition)

6.2.6 Classes

Class: thread-pool ()

Package

chanl

Source

threads.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• assign-task (method)
• pool-tasks (method)
• pool-tasks (method)
• pool-pending-tasks (method)
• pool-pending-tasks (method)
• pool-leader-notifier (method)
• pool-leader-lock (method)
• pool-lock (method)
• pool-soft-limit (method)
• pool-soft-limit (method)
• free-thread-counter (method)
• free-thread-counter (method)
• pool-threads (method)
• pool-threads (method)

Direct slots

Slot: threads

Readers

pool-threads (generic function)

Writers

(setf pool-threads) (generic function)

Slot: free-thread-counter

Initform

0

Readers

free-thread-counter (generic function)

Writers

(setf free-thread-counter) (generic function)

Slot: soft-limit

Initform

1000

Readers

pool-soft-limit (generic function)

Writers

(setf pool-soft-limit) (generic function)

Slot: lock

Initform

(bordeaux-threads:make-lock "thread pool lock")

Readers

pool-lock (generic function)

Slot: leader-lock

Initform

(bordeaux-threads:make-lock "thread leader lock")

Readers

pool-leader-lock (generic function)

Slot: leader-notifier

Initform

(bordeaux-threads:make-condition-variable)

Readers

pool-leader-notifier (generic function)

Slot: pending-tasks

Readers

pool-pending-tasks (generic function)

Writers

(setf pool-pending-tasks) (generic function)

Slot: tasks

Readers

pool-tasks (generic function)

Writers

(setf pool-tasks) (generic function)

Appendix A Indexes

A.1 Concepts