2.1.1 pcall/pcall.asd

Source

pcall.asd.

Parent Component

pcall (system).

ASDF Systems

pcall.

---

2.1.2 pcall-queue/pcall-queue.asd

Source

pcall-queue.asd.

Parent Component

pcall-queue (system).

ASDF Systems

pcall-queue.

---

2.1.3 pcall/package.lisp

Source

pcall.asd.

Parent Component

pcall (system).

Packages

pcall.

---

2.1.4 pcall/task.lisp

Dependency

package.lisp (file).

Source

pcall.asd.

Parent Component

pcall (system).

Public Interface

• done-p (function).
• join (function).
• select-one (function).

Internals

• execute-task (function).
• task (class).
• task-error (reader method).
• (setf task-error) (writer method).
• task-lock (reader method).
• task-status (reader method).
• (setf task-status) (writer method).
• task-thunk (reader method).
• task-values (reader method).
• (setf task-values) (writer method).
• task-wait-locks (reader method).
• (setf task-wait-locks) (writer method).
• task-waiting (reader method).
• (setf task-waiting) (writer method).
• with-locks (function).

---

2.1.5 pcall/pool.lisp

Dependency

task.lisp (file).

Source

pcall.asd.

Parent Component

pcall (system).

Public Interface

• finish-tasks (function).
• set-worker-environment (function).
• thread-pool-size (function).
• (setf thread-pool-size) (function).
• with-local-thread-pool (macro).

Internals

• *pool* (special variable).
• audit-thread-pool (function).
• copy-pool (function).
• make-pool (function).
• pool (structure).
• pool-env (reader).
• (setf pool-env) (writer).
• pool-lock (reader).
• (setf pool-lock) (writer).
• pool-p (function).
• pool-queue (reader).
• (setf pool-queue) (writer).
• pool-size (reader).
• (setf pool-size) (writer).
• pool-threads (reader).
• (setf pool-threads) (writer).
• spawn-thread (function).
• stop-at-once-p (reader method).
• stop-running (condition).
• stop-thread (function).
• worker-thread (function).

---

2.1.6 pcall/pcall.lisp

Dependencies

• task.lisp (file).
• pool.lisp (file).

Source

pcall.asd.

Parent Component

pcall (system).

Public Interface

• pcall (function).
• pexec (macro).
• plet (macro).

---

2.1.7 pcall-queue/queue.lisp

Source

pcall-queue.asd.

Parent Component

pcall-queue (system).

Packages

pcall-queue.

Public Interface

• make-queue (function).
• queue-empty-p (function).
• queue-length (function).
• queue-pop (function).
• queue-push (function).
• queue-wait (function).

Internals

• copy-node (function).
• make-node (function).
• node (structure).
• node-next (reader).
• (setf node-next) (writer).
• node-p (function).
• node-prev (reader).
• (setf node-prev) (writer).
• node-val (reader).
• (setf node-val) (writer).
• queue (class).
• queue-back (reader method).
• (setf queue-back) (writer method).
• queue-condition (reader method).
• queue-do-pop (function).
• queue-front (reader method).
• (setf queue-front) (writer method).
• queue-lock (reader method).

---

4.1.1 Macros

Macro: pexec (&body body) ¶

Shorthand for pcall.

Package

pcall.

Source

pcall.lisp.

Macro: plet ((&rest bindings) &body body) ¶

Package

pcall.

Source

pcall.lisp.

Macro: with-local-thread-pool ((&key size on-unwind worker-environment) &body body) ¶

Run body with a fresh thread pool. If on-unwind is :wait, it will wait for all tasks to finish before returning. If it is :leave, the form will return while threads are still working. If it is :stop or :destroy, the threads will be stopped at the end of the body. With :stop, they will first finish their current task (if any), with :destroy, they will be brutally destroyed and might leak resources, leave stuff in inconsistent state, etc.

Package

pcall.

Source

pool.lisp.

---

4.1.2 Ordinary functions

Function: done-p (task) ¶

Package

pcall.

Source

task.lisp.

Function: finish-tasks () ¶

Package

pcall.

Source

pool.lisp.

Function: join (task) ¶

Join a task, meaning stop execution of the current thread until the result of the task is available, and then return this result. When this is called on a task that no thread is currently working on, the current thread executes the task directly.

Package

pcall.

Source

task.lisp.

Function: make-queue () ¶

Create an empty queue.

Package

pcall-queue.

Source

queue.lisp.

Function: pcall (thunk) ¶

Call a thunk in parallel. Returns a task that can be joined. When an exclusive is given, the task will only run when no other tasks with that exclusive are running.

Package

pcall.

Source

pcall.lisp.

Function: queue-empty-p (queue) ¶

Test whether a queue is empty.

Package

pcall-queue.

Source

queue.lisp.

Function: queue-length (queue) ¶

Find the length of a queue.

Package

pcall-queue.

Source

queue.lisp.

Function: queue-pop (queue) ¶

Pop an element from the front of a queue. Returns immediately, returning nil if the queue is empty, and a second value indicating whether anything was popped.

Package

pcall-queue.

Source

queue.lisp.

Function: queue-push (elt queue) ¶

Push an element onto the back of a queue.

Package

pcall-queue.

Source

queue.lisp.

Function: queue-wait (queue) ¶

Pop an element from the front of a queue. Causes a blocking wait when no elements are available.

Package

pcall-queue.

Source

queue.lisp.

Function: select-one (&rest tasks) ¶

Returns the first task that can be joined without blocking.

Package

pcall.

Source

task.lisp.

Function: set-worker-environment (wrapper) ¶

Package

pcall.

Source

pool.lisp.

Function: thread-pool-size () ¶

Package

pcall.

Source

pool.lisp.

Function: (setf thread-pool-size) () ¶

Package

pcall.

Source

pool.lisp.

---

4.2.1 Special variables

Special Variable: *pool* ¶

Package

pcall.

Source

pool.lisp.

---

4.2.2 Ordinary functions

Function: audit-thread-pool () ¶

Make sure the thread pool holds the correct amount of live threads.

Package

pcall.

Source

pool.lisp.

Function: copy-node (instance) ¶

Package

pcall-queue.

Source

queue.lisp.

Function: copy-pool (instance) ¶

Package

pcall.

Source

pool.lisp.

Function: execute-task (task) ¶

Execute a task, and store the result or error in the task object. When a task’s status is not :free, that means the joiner has already started executing it, so this thread should leave it alone.

Package

pcall.

Source

task.lisp.

Function: make-node (&key val next prev) ¶

Package

pcall-queue.

Source

queue.lisp.

Function: make-pool (&key threads size lock env queue) ¶

Package

pcall.

Source

pool.lisp.

Reader: node-next (instance) ¶

Writer: (setf node-next) (instance) ¶

Package

pcall-queue.

Source

queue.lisp.

Target Slot

next.

Function: node-p (object) ¶

Package

pcall-queue.

Source

queue.lisp.

Reader: node-prev (instance) ¶

Writer: (setf node-prev) (instance) ¶

Package

pcall-queue.

Source

queue.lisp.

Target Slot

prev.

Reader: node-val (instance) ¶

Writer: (setf node-val) (instance) ¶

Package

pcall-queue.

Source

queue.lisp.

Target Slot

val.

Reader: pool-env (instance) ¶

Writer: (setf pool-env) (instance) ¶

Package

pcall.

Source

pool.lisp.

Target Slot

env.

Reader: pool-lock (instance) ¶

Writer: (setf pool-lock) (instance) ¶

Package

pcall.

Source

pool.lisp.

Target Slot

lock.

Function: pool-p (object) ¶

Package

pcall.

Source

pool.lisp.

Reader: pool-queue (instance) ¶

Writer: (setf pool-queue) (instance) ¶

Package

pcall.

Source

pool.lisp.

Target Slot

queue.

Reader: pool-size (instance) ¶

Writer: (setf pool-size) (instance) ¶

Package

pcall.

Source

pool.lisp.

Target Slot

size.

Reader: pool-threads (instance) ¶

Writer: (setf pool-threads) (instance) ¶

Package

pcall.

Source

pool.lisp.

Target Slot

threads.

Function: queue-do-pop (queue) ¶

Package

pcall-queue.

Source

queue.lisp.

Function: spawn-thread (pool) ¶

Package

pcall.

Source

pool.lisp.

Function: stop-thread (thread at-once-p) ¶

Package

pcall.

Source

pool.lisp.

Function: with-locks (locks thunk) ¶

Package

pcall.

Source

task.lisp.

Function: worker-thread (queue) ¶

The code running inside the pooled threads. Repeatedly tries to take a task from the queue, and handles it.

Package

pcall.

Source

pool.lisp.

---

4.2.3 Generic functions

Generic Reader: queue-back (object) ¶

Package

pcall-queue.

Methods

Reader Method: queue-back ((queue queue)) ¶

automatically generated reader method

Source

queue.lisp.

Target Slot

back.

Generic Writer: (setf queue-back) (object) ¶

Package

pcall-queue.

Methods

Writer Method: (setf queue-back) ((queue queue)) ¶

automatically generated writer method

Source

queue.lisp.

Target Slot

back.

Generic Reader: queue-condition (object) ¶

Package

pcall-queue.

Methods

Reader Method: queue-condition ((queue queue)) ¶

automatically generated reader method

Source

queue.lisp.

Target Slot

condition.

Generic Reader: queue-front (object) ¶

Package

pcall-queue.

Methods

Reader Method: queue-front ((queue queue)) ¶

automatically generated reader method

Source

queue.lisp.

Target Slot

front.

Generic Writer: (setf queue-front) (object) ¶

Package

pcall-queue.

Methods

Writer Method: (setf queue-front) ((queue queue)) ¶

automatically generated writer method

Source

queue.lisp.

Target Slot

front.

Generic Reader: queue-lock (object) ¶

Package

pcall-queue.

Methods

Reader Method: queue-lock ((queue queue)) ¶

automatically generated reader method

Source

queue.lisp.

Target Slot

lock.

Generic Reader: stop-at-once-p (condition) ¶

Package

pcall.

Methods

Reader Method: stop-at-once-p ((condition stop-running)) ¶

Source

pool.lisp.

Target Slot

at-once-p.

Generic Reader: task-error (object) ¶

Package

pcall.

Methods

Reader Method: task-error ((task task)) ¶

automatically generated reader method

Source

task.lisp.

Target Slot

error.

Generic Writer: (setf task-error) (object) ¶

Package

pcall.

Methods

Writer Method: (setf task-error) ((task task)) ¶

automatically generated writer method

Source

task.lisp.

Target Slot

error.

Generic Reader: task-lock (object) ¶

Package

pcall.

Methods

Reader Method: task-lock ((task task)) ¶

automatically generated reader method

Source

task.lisp.

Target Slot

lock.

Generic Reader: task-status (object) ¶

Package

pcall.

Methods

Reader Method: task-status ((task task)) ¶

automatically generated reader method

Source

task.lisp.

Target Slot

status.

Generic Writer: (setf task-status) (object) ¶

Package

pcall.

Methods

Writer Method: (setf task-status) ((task task)) ¶

automatically generated writer method

Source

task.lisp.

Target Slot

status.

Generic Reader: task-thunk (object) ¶

Package

pcall.

Methods

Reader Method: task-thunk ((task task)) ¶

automatically generated reader method

Source

task.lisp.

Target Slot

thunk.

Generic Reader: task-values (object) ¶

Package

pcall.

Methods

Reader Method: task-values ((task task)) ¶

automatically generated reader method

Source

task.lisp.

Target Slot

values.

Generic Writer: (setf task-values) (object) ¶

Package

pcall.

Methods

Writer Method: (setf task-values) ((task task)) ¶

automatically generated writer method

Source

task.lisp.

Target Slot

values.

Generic Reader: task-wait-locks (object) ¶

Package

pcall.

Methods

Reader Method: task-wait-locks ((task task)) ¶

automatically generated reader method

Source

task.lisp.

Target Slot

wait-locks.

Generic Writer: (setf task-wait-locks) (object) ¶

Package

pcall.

Methods

Writer Method: (setf task-wait-locks) ((task task)) ¶

automatically generated writer method

Source

task.lisp.

Target Slot

wait-locks.

Generic Reader: task-waiting (object) ¶

Package

pcall.

Methods

Reader Method: task-waiting ((task task)) ¶

automatically generated reader method

Source

task.lisp.

Target Slot

waiting.

Generic Writer: (setf task-waiting) (object) ¶

Package

pcall.

Methods

Writer Method: (setf task-waiting) ((task task)) ¶

automatically generated writer method

Source

task.lisp.

Target Slot

waiting.

---

4.2.4 Conditions

Condition: stop-running ¶

Package

pcall.

Source

pool.lisp.

Direct superclasses

condition.

Direct methods

stop-at-once-p.

Direct slots

Slot: at-once-p ¶

Initargs

:at-once-p

Readers

stop-at-once-p.

Writers

This slot is read-only.

---

4.2.5 Structures

Structure: node ¶

Package

pcall-queue.

Source

queue.lisp.

Direct superclasses

structure-object.

Direct slots

Slot: val ¶

Readers

node-val.

Writers

(setf node-val).

Slot: next ¶

Readers

node-next.

Writers

(setf node-next).

Slot: prev ¶

Readers

node-prev.

Writers

(setf node-prev).

Structure: pool ¶

Package

pcall.

Source

pool.lisp.

Direct superclasses

structure-object.

Direct slots

Slot: threads ¶

Readers

pool-threads.

Writers

(setf pool-threads).

Slot: size ¶

Initform

3

Readers

pool-size.

Writers

(setf pool-size).

Slot: lock ¶

Package

bordeaux-threads.

Initform

(bordeaux-threads:make-lock)

Readers

pool-lock.

Writers

(setf pool-lock).

Slot: env ¶

Readers

pool-env.

Writers

(setf pool-env).

Slot: queue ¶

Initform

(pcall-queue:make-queue)

Readers

pool-queue.

Writers

(setf pool-queue).

---

4.2.6 Classes

Class: queue ¶

Package

pcall-queue.

Source

queue.lisp.

Direct methods

• (setf queue-back).
• queue-back.
• queue-condition.
• (setf queue-front).
• queue-front.
• queue-lock.

Direct slots

Slot: lock ¶

Package

bordeaux-threads.

Initform

(bordeaux-threads:make-lock)

Readers

queue-lock.

Writers

This slot is read-only.

Slot: condition ¶

Package

common-lisp.

Initform

(bordeaux-threads:make-condition-variable)

Readers

queue-condition.

Writers

This slot is read-only.

Slot: front ¶

Readers

queue-front.

Writers

(setf queue-front).

Slot: back ¶

Readers

queue-back.

Writers

(setf queue-back).

Class: task ¶

A task is a piece of code that is scheduled to run in the thread pool.

Package

pcall.

Source

task.lisp.

Direct methods

• (setf task-error).
• task-error.
• task-lock.
• (setf task-status).
• task-status.
• task-thunk.
• (setf task-values).
• task-values.
• (setf task-wait-locks).
• task-wait-locks.
• (setf task-waiting).
• task-waiting.

Direct slots

Slot: thunk ¶

Initargs

:thunk

Readers

task-thunk.

Writers

This slot is read-only.

Slot: error ¶

Package

common-lisp.

Readers

task-error.

Writers

(setf task-error).

Slot: values ¶

Package

common-lisp.

Readers

task-values.

Writers

(setf task-values).

Slot: lock ¶

Package

bordeaux-threads.

Initform

(bordeaux-threads:make-lock)

Readers

task-lock.

Writers

This slot is read-only.

Slot: wait-locks ¶

Readers

task-wait-locks.

Writers

(setf task-wait-locks).

Slot: status ¶

Initform

:free

Readers

task-status.

Writers

(setf task-status).

Slot: waiting ¶

Readers

task-waiting.

Writers

(setf task-waiting).

---