apiv2/pkgdcl.lisp

   1 ;;;; -*- Mode: LISP; Syntax: ANSI-Common-lisp; Base: 10; Package: CL-USER -*-
   2 ;;;; The above modeline is required for Genera. Do not change.
   3
   4 (defpackage :bordeaux-threads-2
   5   (:nicknames :bt2)
   6   (:use :common-lisp :alexandria :global-vars)
   7   #+abcl
   8   (:import-from :java #:jnew #:jcall #:jclass #:jmethod)
   9   #+sbcl
  10   (:import-from :sb-ext #:timeout)
  11
  12   (:export
  13    #:*supports-threads-p*
  14    #:bordeaux-threads-error
  15    #:not-implemented)
  16
  17   ;; Threads
  18   (:export
  19    #:thread
  20    #:thread-name
  21    #:thread-native-thread
  22    #:threadp
  23    #:make-thread
  24    #:*default-special-bindings*
  25    #:*standard-io-bindings*
  26    #:current-thread
  27    #:all-threads
  28    #:start-multiprocessing
  29
  30    #:interrupt-thread
  31    #:signal-in-thread
  32    #:warn-in-thread
  33    #:error-in-thread
  34    #:destroy-thread
  35    #:thread-alive-p
  36    #:join-thread
  37    #:abnormal-exit
  38    #:abnormal-exit-condition
  39    #:thread-yield)
  40
  41   ;; Locks
  42   (:export
  43    #:lock
  44    #:lockp
  45    #:recursive-lock
  46    #:recursive-lock-p
  47    #:lock-name
  48    #:lock-native-lock
  49    #:native-lock
  50    #:native-lock-p
  51    #:native-recursive-lock
  52    #:native-recursive-lock-p
  53
  54    #:make-lock
  55    #:acquire-lock
  56    #:release-lock
  57    #:with-lock-held
  58
  59    #:make-recursive-lock
  60    #:acquire-recursive-lock
  61    #:release-recursive-lock
  62    #:with-recursive-lock-held)
  63
  64   ;; Condition variables
  65   (:export
  66    #:condition-variable
  67    #:condition-variable-p
  68    #:make-condition-variable
  69    #:condition-wait
  70    #:condition-notify
  71    #:condition-broadcast)
  72
  73   ;; Semaphores
  74   (:export
  75    #:semaphore
  76    #:semaphorep
  77    #:make-semaphore
  78    #:signal-semaphore
  79    #:wait-on-semaphore)
  80
  81   ;; Atomic operations
  82   (:export
  83    #:make-atomic-integer
  84    #:atomic-integer-compare-and-swap
  85    #:atomic-integer-decf
  86    #:atomic-integer-incf
  87    #:atomic-integer-value)
  88
  89   ;; Timeouts
  90   (:export
  91    #:timeout
  92    #:with-timeout)
  93
  94   (:documentation "BORDEAUX-THREADS is a proposed standard for a minimal
  95   MP/threading interface. It is similar to the CLIM-SYS threading and
  96   lock support, but for the following broad differences:
  97
  98   1) Some behaviours are defined in additional detail: attention has
  99      been given to special variable interaction, whether and when
 100      cleanup forms are run. Some behaviours are defined in less
 101      detail: an implementation that does not support multiple
 102      threads is not required to use a new list (nil) for a lock, for
 103      example.
 104
 105   2) Many functions which would be difficult, dangerous or inefficient
 106      to provide on some implementations have been removed. Chiefly
 107      these are functions such as thread-wait which expect for
 108      efficiency that the thread scheduler is written in Lisp and
 109      'hookable', which can't sensibly be done if the scheduler is
 110      external to the Lisp image, or the system has more than one CPU.
 111
 112   3) Unbalanced ACQUIRE-LOCK and RELEASE-LOCK functions have been
 113      added.
 114
 115   4) Posix-style condition variables have been added, as it's not
 116      otherwise possible to implement them correctly using the other
 117      operations that are specified.
 118
 119   Threads may be implemented using whatever applicable techniques are
 120   provided by the operating system: user-space scheduling,
 121   kernel-based LWPs or anything else that does the job.
 122
 123   To avoid conflict with existing MP/threading interfaces in
 124   implementations, these symbols live in the BORDEAUX-THREADS-2 package.
 125   Implementations and/or users may also make them visible or exported
 126   in other more traditionally named packages."))