The cl-mpi Reference Manual

Table of Contents

The cl-mpi Reference Manual

This is the cl-mpi Reference Manual, version 1.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 12:34:03 2020 GMT+0.

1 Introduction

#+TITLE: cl-mpi

cl-mpi provides convenient CFFI bindings for the Message Passing
Interface (MPI). MPI is typically used in High Performance Computing to
utilize big parallel computers with thousands of cores. It features minimal
communication overhead with a latency in the range of microseconds. In
comparison to the C or FORTRAN interface of MPI, cl-mpi relieves the
programmer from working with raw pointers to memory and a plethora of
mandatory function arguments.

If you have questions or suggestions, feel free to contact me
(marco.heisig@fau.de).

cl-mpi has been tested with MPICH, MPICH2, IntelMPI and Open MPI.

** Usage
An MPI program must be launched with =mpirun= or =mpiexec=. These commands
spawn multiple processes depending on your system and commandline
parameters. Each process is identical, except that it has a unique rank
that can be queried with =(MPI-COMM-RANK)=. The ranks are assigned from 0
to =(- (MPI-COMM-SIZE) 1)=. A wide range of communication functions is
available to transmit messages between different ranks. To become familiar
with cl-mpi, see the [[file:examples/][examples directory]].

The easiest way to deploy and run cl-mpi applications is by creating a
statically linked binary.  To do so, create a separate ASDF system like
this:
#+BEGIN_SRC lisp
(defsystem :my-mpi-app
  :depends-on (:cl-mpi)
  :defsystem-depends-on (:cl-mpi-asdf-integration)
  :class :mpi-program
  :build-operation :static-program-op
  :build-pathname "my-mpi-app"
  :entry-point "my-mpi-app:main"
  :serial t
  :components
  ((:file "foo") (:file "bar")))
#+END_SRC

and simply run
#+BEGIN_SRC lisp
(asdf:make :my-mpi-app)
#+END_SRC
on the REPL.  Note that not all Lisp implementation support the creation of
statically linked binaries (actually, we only tested SBCL so far).
Alternatively, you can try to use uiop:dump-image to create binaries.

Further remark: If the creation of statically linked binaries with SBCL
fails with something like "undefined reference to main", your SBCL is
probably not built with the =:sb-linkable-runtime= feature.  You are
affected by this when =(find :sb-linkable-runtime *features*)= returns
NIL. In that case, you have to compile SBCL yourself, which is as simple as
executing the following commands, where SOMEWHERE is the desired
installation folder
#+BEGIN_SRC sh
git clone git://git.code.sf.net/p/sbcl/sbcl
cd sbcl
sh make.sh --prefix=SOMEWHERE --fancy --with-sb-linkable-runtime --with-sb-dynamic-core
cd tests && sh run-tests.sh
sh install.sh
#+END_SRC

** Testing
To run the test suite:
#+BEGIN_SRC sh :results output
   ./scripts/run-test-suite.sh all
#+END_SRC

or

#+BEGIN_SRC sh :results output
   ./scripts/run-test-suite.sh YOUR-FAVOURITE-LISP
#+END_SRC

** Performance
cl-mpi makes no additional copies of transmitted data and has therefore the
same bandwidth as any other language (C, FORTRAN). However the convenience
of error handling, automatic inference of the message types and safe
computation of memory locations adds a little overhead to each message. The
exact overhead varies depending on the Lisp implementation and platform but
is somewhere around 1000 machine cycles.

Summary:
   - latency increase per message: 400 nanoseconds (SBCL on a 2.4GHz Intel i7-5500U)
   - bandwidth unchanged

** Authors
   - Alex Fukunaga
   - Marco Heisig

** Special Thanks
This project was funded by KONWIHR (The Bavarian Competence Network for
Technical and Scientific High Performance Computing) and the Chair for
Applied Mathematics 3 of Prof. Dr. Bänsch at the FAU Erlangen-Nürnberg.

Big thanks to Nicolas Neuss for all the useful suggestions.

2 Systems

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

2.1 cl-mpi

Author

Marco Heisig <marco.heisig@fau.de>

License

MIT

Description

Common Lisp bindings for the Message Passing Interface (MPI)

Long Description

cl-mpi provides convenient CFFI bindings for the Message Passing Interface (MPI). MPI is typically used in High Performance Computing to utilize big parallel computers with thousands of cores. It features minimal communication overhead with a latency in the range of microseconds. In comparison to the C or FORTRAN interface of MPI, cl-mpi relieves the programmer from working with raw pointers to memory and a plethora of mandatory function arguments.

Version

1.0

Defsystem Dependency

cl-mpi-asdf-integration (system)

Dependencies

• alexandria
• uiop
• cffi
• static-vectors

Source

cl-mpi.asd (file)

Component

mpi (module)

2.2 cl-mpi-asdf-integration

Author

Marco Heisig <marco.heisig@fau.de>

License

MIT

Description

CFFI and ASDF integration for CL-MPI.

Dependencies

• cffi-grovel
• cffi-toolchain

Source

cl-mpi-asdf-integration.asd (file)

Component

cl-mpi-asdf-integration.lisp (file)

3 Modules

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

3.1 cl-mpi/mpi

Parent

cl-mpi (system)

Location

mpi/

Components

• packages.lisp (file)
• grovel.lisp (file)
• setup.lisp (file)
• wrap.lisp (file)
• utilities.lisp (file)
• datatypes.lisp (file)
• collective.lisp (file)
• contexts.lisp (file)
• environment.lisp (file)
• point-to-point.lisp (file)
• one-sided.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 cl-mpi.asd

Location

cl-mpi.asd

Systems

cl-mpi (system)

4.1.2 cl-mpi-asdf-integration.asd

Location

cl-mpi-asdf-integration.asd

Systems

cl-mpi-asdf-integration (system)

4.1.3 cl-mpi/mpi/packages.lisp

Parent

mpi (module)

Location

mpi/packages.lisp

Packages

mpi

4.1.4 cl-mpi/mpi/grovel.lisp

Dependency

packages.lisp (file)

Parent

mpi (module)

Location

mpi/grovel.lisp

4.1.5 cl-mpi/mpi/setup.lisp

Dependency

grovel.lisp (file)

Parent

mpi (module)

Location

mpi/setup.lisp

Exported Definitions

• *standard-communicator* (special variable)
• +mpi-band+ (special variable)
• +mpi-bor+ (special variable)
• +mpi-bxor+ (special variable)
• +mpi-byte+ (special variable)
• +mpi-c-bool+ (special variable)
• +mpi-char+ (special variable)
• +mpi-comm-null+ (special variable)
• +mpi-comm-self+ (special variable)
• +mpi-comm-world+ (special variable)
• +mpi-datatype-null+ (special variable)
• +mpi-double+ (special variable)
• +mpi-errors-are-fatal+ (special variable)
• +mpi-errors-return+ (special variable)
• +mpi-float+ (special variable)
• +mpi-group-empty+ (special variable)
• +mpi-group-null+ (special variable)
• +mpi-int+ (special variable)
• +mpi-int16-t+ (special variable)
• +mpi-int32-t+ (special variable)
• +mpi-int64-t+ (special variable)
• +mpi-int8-t+ (special variable)
• +mpi-land+ (special variable)
• +mpi-library+ (constant)
• +mpi-long+ (special variable)
• +mpi-long-double+ (special variable)
• +mpi-long-long-int+ (special variable)
• +mpi-lor+ (special variable)
• +mpi-lxor+ (special variable)
• +mpi-max+ (special variable)
• +mpi-maxloc+ (special variable)
• +mpi-min+ (special variable)
• +mpi-minloc+ (special variable)
• +mpi-op-null+ (special variable)
• +mpi-packed+ (special variable)
• +mpi-prod+ (special variable)
• +mpi-replace+ (special variable)
• +mpi-request-null+ (special variable)
• +mpi-short+ (special variable)
• +mpi-signed-char+ (special variable)
• +mpi-sum+ (special variable)
• +mpi-uint16-t+ (special variable)
• +mpi-uint32-t+ (special variable)
• +mpi-uint64-t+ (special variable)
• +mpi-uint8-t+ (special variable)
• +mpi-unsigned+ (special variable)
• +mpi-unsigned-char+ (special variable)
• +mpi-unsigned-long+ (special variable)
• +mpi-unsigned-long-long+ (special variable)
• +mpi-unsigned-short+ (special variable)
• +mpi-version+ (constant)
• +mpi-wchar+ (special variable)
• mpi-comm (class)
• mpi-datatype (class)
• mpi-errhandler (class)
• mpi-error-condition (condition)
• mpi-group (class)
• mpi-info (class)
• mpi-object (class)
• mpi-op (class)
• mpi-request (class)

Internal Definitions

• *mpi-constant-table* (special variable)
• +mpi-errhandler-null+ (special variable)
• define-mpi-constant (macro)
• error-code (method)
• foreign-mpi-object-type (constant)
• index (type)
• initialize-mpi-constants (function)
• int (type)
• mpi-comm-type (class)
• mpi-datatype-type (class)
• mpi-errhandler-type (class)
• mpi-error-type (class)
• mpi-group-type (class)
• mpi-info-type (class)
• mpi-message-type (class)
• mpi-object-handle (method)
• (setf mpi-object-handle) (method)
• mpi-object-type (class)
• mpi-op-type (class)
• mpi-request-type (class)
• signal-mpi-error (function)
• since-mpi-version (macro)

4.1.6 cl-mpi/mpi/wrap.lisp

Dependency

setup.lisp (file)

Parent

mpi (module)

Location

mpi/wrap.lisp

4.1.7 cl-mpi/mpi/utilities.lisp

Dependency

wrap.lisp (file)

Parent

mpi (module)

Location

mpi/utilities.lisp

Exported Definitions

• mpi-equal (function)
• mpi-null (function)

Internal Definitions

• *bits-per-element-table* (special variable)
• *mpi-datatype-table* (special variable)
• *mpi-naming-conventions* (special variable)
• bits-per-element (function)
• defmpifun (macro)
• mpi-datatype-of-size (macro)
• reload-mpi-libraries (function)
• static-vector-mpi-data (function)
• static-vector-mpi-data-dispatch (macro)
• with-foreign-results (macro)

4.1.8 cl-mpi/mpi/datatypes.lisp

Dependency

utilities.lisp (file)

Parent

mpi (module)

Location

mpi/datatypes.lisp

Exported Definitions

mpi-type-size (function)

Internal Definitions

• %mpi-pack (function)
• %mpi-pack-size (function)
• %mpi-type-size (function)
• %mpi-unpack (function)

4.1.9 cl-mpi/mpi/collective.lisp

Dependency

datatypes.lisp (file)

Parent

mpi (module)

Location

mpi/collective.lisp

Exported Definitions

• mpi-allgather (function)
• mpi-allreduce (function)
• mpi-barrier (function)
• mpi-bcast (function)
• mpi-reduce (function)

Internal Definitions

• %mpi-allgather (function)
• %mpi-allgatherv (function)
• %mpi-allreduce (function)
• %mpi-alltoall (function)
• %mpi-alltoallv (function)
• %mpi-alltoallw (function)
• %mpi-barrier (function)
• %mpi-bcast (function)
• %mpi-exscan (function)
• %mpi-gather (function)
• %mpi-gatherv (function)
• %mpi-iallgather (function)
• %mpi-iallgatherv (function)
• %mpi-iallreduce (function)
• %mpi-ialltoall (function)
• %mpi-ialltoallv (function)
• %mpi-ialltoallw (function)
• %mpi-ibarrier (function)
• %mpi-ibcast (function)
• %mpi-iexscan (function)
• %mpi-igather (function)
• %mpi-igatherv (function)
• %mpi-ireduce (function)
• %mpi-ireduce-scatter (function)
• %mpi-ireduce-scatter-block (function)
• %mpi-iscan (function)
• %mpi-iscatter (function)
• %mpi-iscatterv (function)
• %mpi-op-commutative (function)
• %mpi-op-create (function)
• %mpi-op-free (function)
• %mpi-reduce (function)
• %mpi-reduce-local (function)
• %mpi-reduce-scatter (function)
• %mpi-reduce-scatter-block (function)
• %mpi-scan (function)
• %mpi-scatter (function)
• %mpi-scatterv (function)

4.1.10 cl-mpi/mpi/contexts.lisp

Dependency

collective.lisp (file)

Parent

mpi (module)

Location

mpi/contexts.lisp

Exported Definitions

• mpi-comm-create (function)
• mpi-comm-dup (function)
• mpi-comm-free (function)
• mpi-comm-group (function)
• mpi-comm-rank (function)
• mpi-comm-size (function)
• mpi-comm-split (function)
• mpi-group-difference (function)
• mpi-group-excl (function)
• mpi-group-free (function)
• mpi-group-incl (function)
• mpi-group-intersection (function)
• mpi-group-rank (function)
• mpi-group-size (function)
• mpi-group-union (function)

Internal Definitions

• %mpi-comm-compare (function)
• %mpi-comm-create (function)
• %mpi-comm-create-group (function)
• %mpi-comm-dup (function)
• %mpi-comm-free (function)
• %mpi-comm-group (function)
• %mpi-comm-idup (function)
• %mpi-comm-rank (function)
• %mpi-comm-remote-group (function)
• %mpi-comm-remote-size (function)
• %mpi-comm-size (function)
• %mpi-comm-split (function)
• %mpi-comm-test-inter (function)
• %mpi-group-compare (function)
• %mpi-group-difference (function)
• %mpi-group-excl (function)
• %mpi-group-free (function)
• %mpi-group-incl (function)
• %mpi-group-intersection (function)
• %mpi-group-range-excl (function)
• %mpi-group-range-incl (function)
• %mpi-group-rank (function)
• %mpi-group-size (function)
• %mpi-group-translate-ranks (function)
• %mpi-group-union (function)
• to-mpi-rank-spec (function)
• with-mpi-rank-spec (macro)

4.1.11 cl-mpi/mpi/environment.lisp

Dependency

contexts.lisp (file)

Parent

mpi (module)

Location

mpi/environment.lisp

Exported Definitions

• mpi-abort (function)
• mpi-error-string (function)
• mpi-finalize (function)
• mpi-finalized (function)
• mpi-get-processor-name (function)
• mpi-init (function)
• mpi-initialized (function)
• mpi-wtick (function)
• mpi-wtime (function)

Internal Definitions

• %mpi-abort (function)
• %mpi-alloc-mem (function)
• %mpi-comm-call-errhandler (function)
• %mpi-comm-set-errhandler (function)
• %mpi-error-string (function)
• %mpi-finalize (function)
• %mpi-finalized (function)
• %mpi-free-mem (function)
• %mpi-get-processor-name (function)
• %mpi-init (function)
• %mpi-init-thread (function)
• %mpi-initialized (function)

4.1.12 cl-mpi/mpi/point-to-point.lisp

Dependency

environment.lisp (file)

Parent

mpi (module)

Location

mpi/point-to-point.lisp

Exported Definitions

• mpi-demand-buffering (function)
• mpi-iprobe (function)
• mpi-irecv (function)
• mpi-isend (function)
• mpi-probe (function)
• mpi-recv (function)
• mpi-send (function)
• mpi-sendrecv (function)
• mpi-test (function)
• mpi-wait (function)
• mpi-waitall (function)

Internal Definitions

• %mpi-bsend (function)
• %mpi-bsend-init (function)
• %mpi-buffer-attach (function)
• %mpi-buffer-detach (function)
• %mpi-cancel (function)
• %mpi-get-count (function)
• %mpi-ibsend (function)
• %mpi-improbe (function)
• %mpi-imrecv (function)
• %mpi-iprobe (function)
• %mpi-irecv (function)
• %mpi-irsend (function)
• %mpi-isend (function)
• %mpi-issend (function)
• %mpi-mprobe (function)
• %mpi-mrecv (function)
• %mpi-probe (function)
• %mpi-recv (function)
• %mpi-recv-init (function)
• %mpi-request-free (function)
• %mpi-request-get-status (function)
• %mpi-rsend (function)
• %mpi-rsend-init (function)
• %mpi-send (function)
• %mpi-send-init (function)
• %mpi-sendrecv (function)
• %mpi-sendrecv-replace (function)
• %mpi-ssend (function)
• %mpi-ssend-init (function)
• %mpi-start (function)
• %mpi-startall (function)
• %mpi-test (function)
• %mpi-test-cancelled (function)
• %mpi-testall (function)
• %mpi-testany (function)
• %mpi-testsome (function)
• %mpi-wait (function)
• %mpi-waitall (function)
• %mpi-waitany (function)
• %mpi-waitsome (function)
• *current-buffer* (special variable)
• mpi-buffer-detach (function)

4.1.13 cl-mpi/mpi/one-sided.lisp

Dependency

point-to-point.lisp (file)

Parent

mpi (module)

Location

mpi/one-sided.lisp

4.1.14 cl-mpi-asdf-integration/cl-mpi-asdf-integration.lisp

Parent

cl-mpi-asdf-integration (system)

Location

cl-mpi-asdf-integration.lisp

Packages

cl-mpi-asdf-integration

Exported Definitions

• mpi-grovel-file (class)
• mpi-program (class)
• mpi-wrapper-file (class)

Internal Definitions

mpi-mixin (class)

5 Packages

Packages are listed by definition order.

5.1 mpi

CL-MPI: Common Lisp bindings for the Message Passing Interface MPI

Source

packages.lisp (file)

Nickname

cl-mpi

Use List

• alexandria
• static-vectors
• cffi
• common-lisp

Exported Definitions

• *standard-communicator* (special variable)
• +mpi-any-source+ (constant)
• +mpi-any-tag+ (constant)
• +mpi-band+ (special variable)
• +mpi-bor+ (special variable)
• +mpi-bxor+ (special variable)
• +mpi-byte+ (special variable)
• +mpi-c-bool+ (special variable)
• +mpi-char+ (special variable)
• +mpi-comm-null+ (special variable)
• +mpi-comm-self+ (special variable)
• +mpi-comm-world+ (special variable)
• +mpi-datatype-null+ (special variable)
• +mpi-double+ (special variable)
• +mpi-errors-are-fatal+ (special variable)
• +mpi-errors-return+ (special variable)
• +mpi-float+ (special variable)
• +mpi-group-empty+ (special variable)
• +mpi-group-null+ (special variable)
• +mpi-int+ (special variable)
• +mpi-int16-t+ (special variable)
• +mpi-int32-t+ (special variable)
• +mpi-int64-t+ (special variable)
• +mpi-int8-t+ (special variable)
• +mpi-land+ (special variable)
• +mpi-library+ (constant)
• +mpi-long+ (special variable)
• +mpi-long-double+ (special variable)
• +mpi-long-long-int+ (special variable)
• +mpi-lor+ (special variable)
• +mpi-lxor+ (special variable)
• +mpi-max+ (special variable)
• +mpi-maxloc+ (special variable)
• +mpi-min+ (special variable)
• +mpi-minloc+ (special variable)
• +mpi-op-null+ (special variable)
• +mpi-packed+ (special variable)
• +mpi-proc-null+ (constant)
• +mpi-prod+ (special variable)
• +mpi-replace+ (special variable)
• +mpi-request-null+ (special variable)
• +mpi-root+ (constant)
• +mpi-short+ (special variable)
• +mpi-signed-char+ (special variable)
• +mpi-sum+ (special variable)
• +mpi-uint16-t+ (special variable)
• +mpi-uint32-t+ (special variable)
• +mpi-uint64-t+ (special variable)
• +mpi-uint8-t+ (special variable)
• +mpi-undefined+ (constant)
• +mpi-unsigned+ (special variable)
• +mpi-unsigned-char+ (special variable)
• +mpi-unsigned-long+ (special variable)
• +mpi-unsigned-long-long+ (special variable)
• +mpi-unsigned-short+ (special variable)
• +mpi-version+ (constant)
• +mpi-wchar+ (special variable)
• mpi-abort (function)
• mpi-allgather (function)
• mpi-allreduce (function)
• mpi-barrier (function)
• mpi-bcast (function)
• mpi-comm (class)
• mpi-comm-create (function)
• mpi-comm-dup (function)
• mpi-comm-free (function)
• mpi-comm-group (function)
• mpi-comm-rank (function)
• mpi-comm-size (function)
• mpi-comm-split (function)
• mpi-datatype (class)
• mpi-demand-buffering (function)
• mpi-equal (function)
• mpi-errhandler (class)
• mpi-error-condition (condition)
• mpi-error-string (function)
• mpi-finalize (function)
• mpi-finalized (function)
• mpi-get-processor-name (function)
• mpi-group (class)
• mpi-group-difference (function)
• mpi-group-excl (function)
• mpi-group-free (function)
• mpi-group-incl (function)
• mpi-group-intersection (function)
• mpi-group-rank (function)
• mpi-group-size (function)
• mpi-group-union (function)
• mpi-info (class)
• mpi-init (function)
• mpi-initialized (function)
• mpi-iprobe (function)
• mpi-irecv (function)
• mpi-isend (function)
• mpi-null (function)
• mpi-object (class)
• mpi-op (class)
• mpi-probe (function)
• mpi-recv (function)
• mpi-reduce (function)
• mpi-request (class)
• mpi-send (function)
• mpi-sendrecv (function)
• mpi-test (function)
• mpi-type-size (function)
• mpi-wait (function)
• mpi-waitall (function)
• mpi-wtick (function)
• mpi-wtime (function)

Internal Definitions

• %mpi-abort (function)
• %mpi-allgather (function)
• %mpi-allgatherv (function)
• %mpi-alloc-mem (function)
• %mpi-allreduce (function)
• %mpi-alltoall (function)
• %mpi-alltoallv (function)
• %mpi-alltoallw (function)
• %mpi-barrier (function)
• %mpi-bcast (function)
• %mpi-bsend (function)
• %mpi-bsend-init (function)
• %mpi-buffer-attach (function)
• %mpi-buffer-detach (function)
• %mpi-cancel (function)
• %mpi-comm-call-errhandler (function)
• %mpi-comm-compare (function)
• %mpi-comm-create (function)
• %mpi-comm-create-group (function)
• %mpi-comm-dup (function)
• %mpi-comm-free (function)
• %mpi-comm-group (function)
• %mpi-comm-idup (function)
• %mpi-comm-rank (function)
• %mpi-comm-remote-group (function)
• %mpi-comm-remote-size (function)
• %mpi-comm-set-errhandler (function)
• %mpi-comm-size (function)
• %mpi-comm-split (function)
• %mpi-comm-test-inter (function)
• %mpi-error-string (function)
• %mpi-exscan (function)
• %mpi-finalize (function)
• %mpi-finalized (function)
• %mpi-free-mem (function)
• %mpi-gather (function)
• %mpi-gatherv (function)
• %mpi-get-count (function)
• %mpi-get-processor-name (function)
• %mpi-group-compare (function)
• %mpi-group-difference (function)
• %mpi-group-excl (function)
• %mpi-group-free (function)
• %mpi-group-incl (function)
• %mpi-group-intersection (function)
• %mpi-group-range-excl (function)
• %mpi-group-range-incl (function)
• %mpi-group-rank (function)
• %mpi-group-size (function)
• %mpi-group-translate-ranks (function)
• %mpi-group-union (function)
• %mpi-iallgather (function)
• %mpi-iallgatherv (function)
• %mpi-iallreduce (function)
• %mpi-ialltoall (function)
• %mpi-ialltoallv (function)
• %mpi-ialltoallw (function)
• %mpi-ibarrier (function)
• %mpi-ibcast (function)
• %mpi-ibsend (function)
• %mpi-iexscan (function)
• %mpi-igather (function)
• %mpi-igatherv (function)
• %mpi-improbe (function)
• %mpi-imrecv (function)
• %mpi-init (function)
• %mpi-init-thread (function)
• %mpi-initialized (function)
• %mpi-iprobe (function)
• %mpi-irecv (function)
• %mpi-ireduce (function)
• %mpi-ireduce-scatter (function)
• %mpi-ireduce-scatter-block (function)
• %mpi-irsend (function)
• %mpi-iscan (function)
• %mpi-iscatter (function)
• %mpi-iscatterv (function)
• %mpi-isend (function)
• %mpi-issend (function)
• %mpi-mprobe (function)
• %mpi-mrecv (function)
• %mpi-op-commutative (function)
• %mpi-op-create (function)
• %mpi-op-free (function)
• %mpi-pack (function)
• %mpi-pack-size (function)
• %mpi-probe (function)
• %mpi-recv (function)
• %mpi-recv-init (function)
• %mpi-reduce (function)
• %mpi-reduce-local (function)
• %mpi-reduce-scatter (function)
• %mpi-reduce-scatter-block (function)
• %mpi-request-free (function)
• %mpi-request-get-status (function)
• %mpi-rsend (function)
• %mpi-rsend-init (function)
• %mpi-scan (function)
• %mpi-scatter (function)
• %mpi-scatterv (function)
• %mpi-send (function)
• %mpi-send-init (function)
• %mpi-sendrecv (function)
• %mpi-sendrecv-replace (function)
• %mpi-ssend (function)
• %mpi-ssend-init (function)
• %mpi-start (function)
• %mpi-startall (function)
• %mpi-test (function)
• %mpi-test-cancelled (function)
• %mpi-testall (function)
• %mpi-testany (function)
• %mpi-testsome (function)
• %mpi-type-size (function)
• %mpi-unpack (function)
• %mpi-wait (function)
• %mpi-waitall (function)
• %mpi-waitany (function)
• %mpi-waitsome (function)
• *bits-per-element-table* (special variable)
• *current-buffer* (special variable)
• *mpi-constant-table* (special variable)
• *mpi-datatype-table* (special variable)
• *mpi-naming-conventions* (special variable)
• +mpi-errhandler-null+ (special variable)
• +mpi-max-error-string+ (constant)
• +mpi-max-processor-name+ (constant)
• bits-per-element (function)
• cl_mpi_get_mpi_band (function)
• cl_mpi_get_mpi_bor (function)
• cl_mpi_get_mpi_bxor (function)
• cl_mpi_get_mpi_byte (function)
• cl_mpi_get_mpi_c_bool (function)
• cl_mpi_get_mpi_char (function)
• cl_mpi_get_mpi_comm_null (function)
• cl_mpi_get_mpi_comm_self (function)
• cl_mpi_get_mpi_comm_world (function)
• cl_mpi_get_mpi_datatype_null (function)
• cl_mpi_get_mpi_double (function)
• cl_mpi_get_mpi_errhandler_null (function)
• cl_mpi_get_mpi_errors_are_fatal (function)
• cl_mpi_get_mpi_errors_return (function)
• cl_mpi_get_mpi_float (function)
• cl_mpi_get_mpi_group_empty (function)
• cl_mpi_get_mpi_group_null (function)
• cl_mpi_get_mpi_int (function)
• cl_mpi_get_mpi_int16_t (function)
• cl_mpi_get_mpi_int32_t (function)
• cl_mpi_get_mpi_int64_t (function)
• cl_mpi_get_mpi_int8_t (function)
• cl_mpi_get_mpi_land (function)
• cl_mpi_get_mpi_long (function)
• cl_mpi_get_mpi_long_double (function)
• cl_mpi_get_mpi_long_long_int (function)
• cl_mpi_get_mpi_lor (function)
• cl_mpi_get_mpi_lxor (function)
• cl_mpi_get_mpi_max (function)
• cl_mpi_get_mpi_maxloc (function)
• cl_mpi_get_mpi_min (function)
• cl_mpi_get_mpi_minloc (function)
• cl_mpi_get_mpi_op_null (function)
• cl_mpi_get_mpi_packed (function)
• cl_mpi_get_mpi_prod (function)
• cl_mpi_get_mpi_replace (function)
• cl_mpi_get_mpi_request_null (function)
• cl_mpi_get_mpi_short (function)
• cl_mpi_get_mpi_signed_char (function)
• cl_mpi_get_mpi_sum (function)
• cl_mpi_get_mpi_uint16_t (function)
• cl_mpi_get_mpi_uint32_t (function)
• cl_mpi_get_mpi_uint64_t (function)
• cl_mpi_get_mpi_uint8_t (function)
• cl_mpi_get_mpi_unsigned (function)
• cl_mpi_get_mpi_unsigned_char (function)
• cl_mpi_get_mpi_unsigned_long (function)
• cl_mpi_get_mpi_unsigned_long_long (function)
• cl_mpi_get_mpi_unsigned_short (function)
• cl_mpi_get_mpi_wchar (function)
• define-mpi-constant (macro)
• defmpifun (macro)
• error-code (generic function)
• error-code (method)
• foreign-mpi-object-type (constant)
• index (type)
• initialize-mpi-constants (function)
• int (type)
• mpi-buffer-detach (function)
• mpi-comm-type (class)
• mpi-datatype-of-size (macro)
• mpi-datatype-type (class)
• mpi-errhandler-type (class)
• mpi-error-type (class)
• mpi-group-type (class)
• mpi-info-type (class)
• mpi-message-type (class)
• mpi-object-handle (generic function)
• mpi-object-handle (method)
• (setf mpi-object-handle) (method)
• (setf mpi-object-handle) (generic function)
• mpi-object-type (class)
• mpi-op-type (class)
• mpi-request-type (class)
• mpi-status-tclass (class)
• mpi_subversion (constant)
• mpi_version (constant)
• open_mpi (constant)
• open_mpi_major_version (constant)
• open_mpi_minor_version (constant)
• open_mpi_release_version (constant)
• reload-mpi-libraries (function)
• signal-mpi-error (function)
• since-mpi-version (macro)
• size-of-mpi-status (constant)
• static-vector-mpi-data (function)
• static-vector-mpi-data-dispatch (macro)
• to-mpi-rank-spec (function)
• with-foreign-results (macro)
• with-mpi-rank-spec (macro)

5.2 cl-mpi-asdf-integration

Source

cl-mpi-asdf-integration.lisp (file)

Use List

common-lisp

Exported Definitions

• mpi-grovel-file (class)
• mpi-program (class)
• mpi-wrapper-file (class)

Internal Definitions

mpi-mixin (class)

6 Definitions

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

6.1 Exported definitions

6.1.1 Constants

Constant: +mpi-any-source+

Package

mpi

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-mpi-20190710-git/mpi/grovel.processed-grovel-file

Constant: +mpi-any-tag+

Package

mpi

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-mpi-20190710-git/mpi/grovel.processed-grovel-file

Constant: +mpi-library+

A string describing the MPI library that CL-MPI uses to send its messages. Something like "Open MPI 1.6.2".

Package

mpi

Source

setup.lisp (file)

Constant: +mpi-proc-null+

Package

mpi

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-mpi-20190710-git/mpi/grovel.processed-grovel-file

Constant: +mpi-root+

Package

mpi

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-mpi-20190710-git/mpi/grovel.processed-grovel-file

Constant: +mpi-undefined+

Package

mpi

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-mpi-20190710-git/mpi/grovel.processed-grovel-file

Constant: +mpi-version+

The version of the MPI standard supported by the underlying implementation.

Package

mpi

Source

setup.lisp (file)

6.1.2 Special variables

Special Variable: *standard-communicator*

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-band+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-bor+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-bxor+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-byte+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-c-bool+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-char+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-comm-null+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-comm-self+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-comm-world+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-datatype-null+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-double+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-errors-are-fatal+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-errors-return+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-float+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-group-empty+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-group-null+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-int+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-int16-t+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-int32-t+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-int64-t+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-int8-t+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-land+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-long+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-long-double+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-long-long-int+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-lor+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-lxor+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-max+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-maxloc+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-min+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-minloc+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-op-null+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-packed+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-prod+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-replace+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-request-null+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-short+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-signed-char+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-sum+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-uint16-t+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-uint32-t+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-uint64-t+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-uint8-t+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-unsigned+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-unsigned-char+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-unsigned-long+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-unsigned-long-long+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-unsigned-short+

Package

mpi

Source

setup.lisp (file)

Special Variable: +mpi-wchar+

Package

mpi

Source

setup.lisp (file)

6.1.3 Functions

Function: mpi-abort &key COMM ERRCODE

This routine makes a ’best attempt’ to abort all tasks in the group of comm. This function does not require that the invoking environment take any action with the error code. However, a Unix or POSIX environment should handle this as a return errorcode from the main program or an abort(errorcode).

Package

mpi

Source

environment.lisp (file)

Function: mpi-allgather SEND-ARRAY RECV-ARRAY &key COMM SEND-START SEND-END RECV-START RECV-END

After MPI-ALLGATHER returns, RECV-ARRAY will contain the contents of each processes SEND-ARRAY ordered by increasing mpi rank.

Package

mpi

Source

collective.lisp (file)

Function: mpi-allreduce SEND-ARRAY RECV-ARRAY OP &key COMM SEND-START SEND-END RECV-START RECV-END

Combine the contents of each SEND-ARRAY element wise with the operation OP and store the result RECV-ARRAY.

Package

mpi

Source

collective.lisp (file)

Function: mpi-barrier &optional COMM

MPI-BARRIER blocks the caller until all members of COMM have called it. The call returns at any process only after all members of COMM have entered the call.

Package

mpi

Source

collective.lisp (file)

Function: mpi-bcast ARRAY ROOT &key COMM START END

Transfer the contents of ARRAY of the process with rank ROOT to all members of COMM. The call returns at any process only after all members of COMM have entered the call. The arguments START and END can be used to manipulate only a sub-sequence of ARRAY.

Package

mpi

Source

collective.lisp (file)

Function: mpi-comm-create GROUP &key COMM

Package

mpi

Source

contexts.lisp (file)

Function: mpi-comm-dup &optional COMM

Package

mpi

Source

contexts.lisp (file)

Function: mpi-comm-free COMM

Package

mpi

Source

contexts.lisp (file)

Function: mpi-comm-group &optional COMM

Package

mpi

Source

contexts.lisp (file)

Function: mpi-comm-rank &optional COMM

Returns the rank of the process in a given communicator.

Package

mpi

Source

contexts.lisp (file)

Function: mpi-comm-size &optional COMM

Indicates the number of processes involved in a communicator. For +mpi-comm-world+, it indicates the total number of processes available.

Package

mpi

Source

contexts.lisp (file)

Function: mpi-comm-split COLOR KEY &key COMM

Returns new communicator by partitioning a communicator according to color and key.

Package

mpi

Source

contexts.lisp (file)

Function: mpi-demand-buffering SIZE

Ensure that the MPI buffer that is used for blocking commands has a size of at least SIZE bytes.

Package

mpi

Source

point-to-point.lisp (file)

Function: mpi-equal A B

Package

mpi

Source

utilities.lisp (file)

Function: mpi-error-string ERRORCODE

Convert the given errorcode to a human readable error message

Package

mpi

Source

environment.lisp (file)

Function: mpi-finalize ()

This routines cleans up all MPI state. Once this routine is called, no MPI routine (even MPI-INIT) may be called. The user must ensure that all pending communications involving a process complete before the process calls MPI-FINALIZE.

Package

mpi

Source

environment.lisp (file)

Function: mpi-finalized ()

Returns true if MPI_FINALIZE has been called and nil otherwise.

Package

mpi

Source

environment.lisp (file)

Function: mpi-get-processor-name ()

This routine returns the name of the processor on which it was called at the moment of the call. The name is a character string for maximum flexibility. From this value it must be possible to identify a specific piece of hardware; possible values include ’processor 9 in rack 4 of mpp.cs.org’ and ’231’ (where 231 is the actual processor number in the running homogeneous system).

Package

mpi

Source

environment.lisp (file)

Function: mpi-group-difference GROUP1 GROUP2

Package

mpi

Source

contexts.lisp (file)

Function: mpi-group-excl GROUP &rest RANK-SPEC

Create a new MPI group consisting of a subset of the ranks of the original group. A valid range can be
- an integer
- a list of the form (first-rank last-rank &optional step-size)

Package

mpi

Source

contexts.lisp (file)

Function: mpi-group-free &rest GROUPS

Package

mpi

Source

contexts.lisp (file)

Function: mpi-group-incl GROUP &rest RANK-SPEC

Create a new MPI group consisting of a subset of the ranks of the original group. A valid range can be
- an integer
- a list of the form (first-rank last-rank &optional step-size)

Package

mpi

Source

contexts.lisp (file)

Function: mpi-group-intersection GROUP1 GROUP2

Package

mpi

Source

contexts.lisp (file)

Function: mpi-group-rank GROUP

Package

mpi

Source

contexts.lisp (file)

Function: mpi-group-size GROUP

Package

mpi

Source

contexts.lisp (file)

Function: mpi-group-union GROUP1 GROUP2

Package

mpi

Source

contexts.lisp (file)

Function: mpi-init &key THREAD-SUPPORT

Initialize MPI. If supplied, the keyword parameter THREAD-SUPPORT denotes the required level of thread support in MPI. It must be one of the following keywords:

:MPI-THREAD-SINGLE - Only one thread will ever execute.

:MPI-THREAD-FUNNELED - The process may be multi-threaded, but the application must ensure that only the main thread makes MPI calls.

:MPI-THREAD-SERIALIZED - The process may be multi-threaded, and multiple threads may make MPI calls, but not concurrently from two distinct threads.

:MPI-THREAD-MULTIPLE - Multiple threads may call MPI, with no restrictions.

An error is signaled when the MPI implementation fails to provide the required level of thread support.

Package

mpi

Source

environment.lisp (file)

Function: mpi-initialized ()

Returns true if MPI_INIT has been called and nil otherwise.
This routine may be used to determine whether MPI-INIT has been called. It is the only routine that may be called before MPI-INIT is called.

Package

mpi

Source

environment.lisp (file)

Function: mpi-iprobe SOURCE &key TAG COMM

Checks whether a message with matching TAG and SOURCE has been sent on the communicator COMM. If so, it returns three values: The size of the incoming message in bytes, and the rank and tag of the sender. Otherwise, it returns false.

MPI makes a progress guarantee, such that repeated calls to MPI-IPROBE to a message that has been sent will eventually succeed.

Package

mpi

Source

point-to-point.lisp (file)

Function: mpi-irecv ARRAY SOURCE &key COMM START END TAG

Package

mpi

Source

point-to-point.lisp (file)

Function: mpi-isend ARRAY DEST &key COMM START END TAG MODE

A non-blocking variant of MPI-SEND. Returns a MPI-REQUEST that can be passed to MPI-TEST, MPI-WAIT and MPI-WAITALL.

WARNING: The caller of MPI-ISEND is responsible that the given array is not relocated or garbage-collected until the send operation is complete. This can be achieved by using STATIC-VECTORS or some implementation dependent mechanism such as sb-sys:with-pinned-objects.

Package

mpi

Source

point-to-point.lisp (file)

Function: mpi-null OBJECT

Package

mpi

Source

utilities.lisp (file)

Function: mpi-probe SOURCE &key TAG COMM

Block until a message with matching TAG and SOURCE has been sent on the communicator COMM.

Returns three values:

1. The size of the incoming message in bytes.

2. The rank of the sender of the message. This value is particularly useful if the SOURCE was specified as +MPI-ANY-SOURCE+.

3. The tag of the sender of the message. This value is particularly useful if the TAG was specified as +MPI-ANY-TAG+.

Package

mpi

Source

point-to-point.lisp (file)

Function: mpi-recv ARRAY SOURCE &key COMM START END TAG

Blocks until a message from a process with rank SOURCE and tag TAG has been received.

Returns three values:

1. The size of the incoming message in bytes.

2. The rank of the sender of the message. This value is particularly useful if the SOURCE was specified as +MPI-ANY-SOURCE+.

3. The tag of the sender of the message. This value is particularly useful if the TAG was specified as +MPI-ANY-TAG+.

Package

mpi

Source

point-to-point.lisp (file)

Function: mpi-reduce SEND-ARRAY RECV-ARRAY OP ROOT &key COMM SEND-START SEND-END RECV-START RECV-END

Combine the contents of each SEND-ARRAY element wise with the operation OP and store the result into the RECV-ARRAY of the process with rank ROOT.

Package

mpi

Source

collective.lisp (file)

Function: mpi-send ARRAY DEST &key COMM START END TAG MODE

Send a given ARRAY to a corresponding MPI-RECV. The arrays passed to MPI-SEND and MPI-RECV must be of type SIMPLE-ARRAY and have the same element-type and dimensions. Undefined behaviour occurs if the arrays at sender and receiver side do not match.

Package

mpi

Source

point-to-point.lisp (file)

Function: mpi-sendrecv SEND-DATA DEST RECV-DATA SOURCE &key COMM SEND-TAG RECV-TAG SEND-START SEND-END RECV-START RECV-END

Simultaneously send and receive a message. Behaves as if calls to MPI-SEND and MPI-RECV were issued in separate threads that were then joined.

Returns three values:

1. The size of the incoming message in bytes.

2. The rank of the sender of the received message. This value is particularly useful if the SOURCE was specified as +MPI-ANY-SOURCE+.

3. The tag of the sender of the received message. This value is particularly useful if the TAG was specified as +MPI-ANY-TAG+.

Package

mpi

Source

point-to-point.lisp (file)

Function: mpi-test REQUEST

Returns whether REQUEST has been completed.

MPI makes a progress guarantee, such that repeated calls to MPI-TEST to a request whose matching operation has been issued will eventually succeed.

Package

mpi

Source

point-to-point.lisp (file)

Function: mpi-type-size DATATYPE

Package

mpi

Source

datatypes.lisp (file)

Function: mpi-wait REQUEST

Blocks until REQUEST has been completed.

Package

mpi

Source

point-to-point.lisp (file)

Function: mpi-waitall &rest REQUESTS

MPI-WAITALL blocks until all given requests have been completed. It returns REQUESTS.

Package

mpi

Source

point-to-point.lisp (file)

Function: mpi-wtick ()

Returns the resolution of MPI-WTIME in seconds. That is, it returns, as a double precision value, the number of seconds between successive clock ticks. For example, if the clock is implemented by the hardware as a counter that is incremented every millisecond, the value returned by MPI-WTICK should be 0.001

Package

mpi

Source

environment.lisp (file)

Function: mpi-wtime ()

Returns a (double) floating-point number of seconds, representing elapsed wall-clock time since some time in the past.

The ’time in the past’ is guaranteed not to change during the life of the process. The user is responsible for converting large numbers of seconds to other units if they are preferred. This function is portable (it returns seconds, not ’ticks’), it allows high-resolution, and carries no unnecessary baggage. The times returned are local to the node that called them. There is no requirement that different nodes return ’the same time.’

Package

mpi

Source

environment.lisp (file)

6.1.4 Conditions

Condition: mpi-error-condition ()

Signaled when a MPI function returns a status code other than MPI_SUCCESS.

Package

mpi

Source

setup.lisp (file)

Direct superclasses

error (condition)

Direct methods

error-code (method)

Direct slots

Slot: %error-code

Initargs

:error-code

Readers

error-code (generic function)

6.1.5 Classes

Class: mpi-comm ()

Package

mpi

Source

setup.lisp (file)

Direct superclasses

mpi-object (class)

Class: mpi-datatype ()

Package

mpi

Source

setup.lisp (file)

Direct superclasses

mpi-object (class)

Class: mpi-errhandler ()

Package

mpi

Source

setup.lisp (file)

Direct superclasses

mpi-object (class)

Class: mpi-group ()

Package

mpi

Source

setup.lisp (file)

Direct superclasses

mpi-object (class)

Class: mpi-grovel-file ()

Package

cl-mpi-asdf-integration

Source

cl-mpi-asdf-integration.lisp (file)

Direct superclasses

• mpi-mixin (class)
• grovel-file (class)

Class: mpi-info ()

Package

mpi

Source

setup.lisp (file)

Direct superclasses

mpi-object (class)

Class: mpi-object ()

Package

mpi

Source

setup.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

• mpi-errhandler (class)
• mpi-comm (class)
• mpi-group (class)
• mpi-datatype (class)
• mpi-op (class)
• mpi-info (class)
• mpi-request (class)

Direct methods

• mpi-object-handle (method)
• mpi-object-handle (method)

Direct slots

Slot: %handle

Initargs

:handle

Readers

mpi-object-handle (generic function)

Writers

(setf mpi-object-handle) (generic function)

Class: mpi-op ()

Package

mpi

Source

setup.lisp (file)

Direct superclasses

mpi-object (class)

Class: mpi-program ()

Class of ASDF systems that represent standalone MPI programs.

Package

cl-mpi-asdf-integration

Source

cl-mpi-asdf-integration.lisp (file)

Direct superclasses

• mpi-mixin (class)
• system (class)

Direct methods

perform (method)

Class: mpi-request ()

Package

mpi

Source

setup.lisp (file)

Direct superclasses

mpi-object (class)

Class: mpi-wrapper-file ()

Package

cl-mpi-asdf-integration

Source

cl-mpi-asdf-integration.lisp (file)

Direct superclasses

• mpi-mixin (class)
• wrapper-file (class)

6.2 Internal definitions

6.2.1 Constants

Constant: +mpi-max-error-string+

Package

mpi

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-mpi-20190710-git/mpi/grovel.processed-grovel-file

Constant: +mpi-max-processor-name+

Package

mpi

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-mpi-20190710-git/mpi/grovel.processed-grovel-file

Constant: foreign-mpi-object-type

Package

mpi

Source

setup.lisp (file)

Constant: mpi_subversion

Package

mpi

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-mpi-20190710-git/mpi/grovel.processed-grovel-file

Constant: mpi_version

Package

mpi

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-mpi-20190710-git/mpi/grovel.processed-grovel-file

Constant: open_mpi

Package

mpi

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-mpi-20190710-git/mpi/grovel.processed-grovel-file

Constant: open_mpi_major_version

Package

mpi

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-mpi-20190710-git/mpi/grovel.processed-grovel-file

Constant: open_mpi_minor_version

Package

mpi

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-mpi-20190710-git/mpi/grovel.processed-grovel-file

Constant: open_mpi_release_version

Package

mpi

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-mpi-20190710-git/mpi/grovel.processed-grovel-file

Constant: size-of-mpi-status

Package

mpi

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-mpi-20190710-git/mpi/grovel.processed-grovel-file

6.2.2 Special variables

Special Variable: *bits-per-element-table*

Package

mpi

Source

utilities.lisp (file)

Special Variable: *current-buffer*

Package

mpi

Source

point-to-point.lisp (file)

Special Variable: *mpi-constant-table*

Package

mpi

Source

setup.lisp (file)

Special Variable: *mpi-datatype-table*

An alist of MPI datatypes and corresponding CFFI types.

Package

mpi

Source

utilities.lisp (file)

Special Variable: *mpi-naming-conventions*

Package

mpi

Source

utilities.lisp (file)

Special Variable: +mpi-errhandler-null+

Package

mpi

Source

setup.lisp (file)

6.2.3 Macros

Macro: define-mpi-constant CLASS C-NAME

Package

mpi

Source

setup.lisp (file)

Macro: defmpifun FOREIGN-NAME (&rest ARGS) &key INTRODUCED

Package

mpi

Source

utilities.lisp (file)

Macro: mpi-datatype-of-size SIZE

Package

mpi

Source

utilities.lisp (file)

Macro: since-mpi-version VERSION &body BODY

Package

mpi

Source

setup.lisp (file)

Macro: static-vector-mpi-data-dispatch VECTOR START END

Package

mpi

Source

utilities.lisp (file)

Macro: with-foreign-results BINDINGS &body BODY

Evaluate body as with WITH-FOREIGN-OBJECTS, but afterwards convert them to lisp objects and return them via VALUES.

Package

mpi

Source

utilities.lisp (file)

Macro: with-mpi-rank-spec (SPEC-NAME COUNT-NAME) (RANK-SPEC) &body BODY

Package

mpi

Source

contexts.lisp (file)

6.2.4 Functions

Function: %mpi-abort COMM ERRORCODE

Package

mpi

Source

environment.lisp (file)

Function: %mpi-allgather *SENDBUF SENDCOUNT SENDTYPE *RECVBUF RECVCOUNT RECVTYPE COMM

Package

mpi

Source

collective.lisp (file)

Function: %mpi-allgatherv *SENDBUF SENDCOUNT SENDTYPE *RECVBUF RECVCOUNTS DISPLS RECVTYPE COMM

Package

mpi

Source

collective.lisp (file)

Function: %mpi-alloc-mem COUNT PTR *BUF

Package

mpi

Source

environment.lisp (file)

Function: %mpi-allreduce *SENDBUF *RECVBUF COUNT DATATYPE OP COMM

Package

mpi

Source

collective.lisp (file)

Function: %mpi-alltoall *SENDBUF *RECVBUF COUNT DATATYPE OP COMM

Package

mpi

Source

collective.lisp (file)

Function: %mpi-alltoallv *SENDBUF SENDCOUNTS SDISPLS SENDTYPE *RECVBUF RECVCOUNTS RDISPLS RECVTYPE COMM

Package

mpi

Source

collective.lisp (file)

Function: %mpi-alltoallw *SENDBUF SENDCOUNTS SDISPLS SENDTYPES *RECVBUF RECVCOUNTS RDISPLS RECVTYPES COMM

Package

mpi

Source

collective.lisp (file)

Function: %mpi-barrier COMM

Package

mpi

Source

collective.lisp (file)

Function: %mpi-bcast *BUF COUNT DATATYPE ROOT COMM

Package

mpi

Source

collective.lisp (file)

Function: %mpi-bsend *BUF COUNT DATATYPE DEST TAG COMM

Package

mpi

Source

point-to-point.lisp (file)

Function: %mpi-bsend-init *BUF COUNT DATATYPE DEST TAG COMM *REQUEST

Package

mpi

Source

point-to-point.lisp (file)

Function: %mpi-buffer-attach *BUF SIZE

Package

mpi

Source

point-to-point.lisp (file)

Function: %mpi-buffer-detach *BUF *SIZE

Package

mpi

Source

point-to-point.lisp (file)

Function: %mpi-cancel *REQUEST

Package

mpi

Source

point-to-point.lisp (file)

Function: %mpi-comm-call-errhandler COMM ERRORCODE

Package

mpi

Source

environment.lisp (file)

Function: %mpi-comm-compare COMM1 COMM2 *RESULT

Package

mpi

Source

contexts.lisp (file)

Function: %mpi-comm-create COMM GROUP *NEWCOMM

Package

mpi

Source

contexts.lisp (file)

Function: %mpi-comm-create-group COMM GROUP TAG *NEWCOMM

Package

mpi

Source

contexts.lisp (file)

Function: %mpi-comm-dup COMM *NEWCOMM

Package

mpi

Source

contexts.lisp (file)

Function: %mpi-comm-free *COMM

Package

mpi

Source

contexts.lisp (file)

Function: %mpi-comm-group COMM *GROUP

Package

mpi

Source

contexts.lisp (file)

Function: %mpi-comm-idup COMM *NEWCOMM *REQUEST

Package

mpi

Source

contexts.lisp (file)

Function: %mpi-comm-rank COMM *RANK

Package

mpi

Source

contexts.lisp (file)

Function: %mpi-comm-remote-group COMM *GROUP

Package

mpi

Source

contexts.lisp (file)

Function: %mpi-comm-remote-size COMM *SIZE

Package

mpi

Source

contexts.lisp (file)

Function: %mpi-comm-set-errhandler COMM ERRHANDLER

Package

mpi

Source

environment.lisp (file)

Function: %mpi-comm-size COMM *SIZE

Package

mpi

Source

contexts.lisp (file)

Function: %mpi-comm-split COMM COLOR KEY *NEWCOMM

Package

mpi

Source

contexts.lisp (file)

Function: %mpi-comm-test-inter COMM *FLAG

Package

mpi

Source

contexts.lisp (file)

Function: %mpi-error-string ERRORCODE STRING *SIZE

Package

mpi

Source

environment.lisp (file)

Function: %mpi-exscan *SENDBUF *RECVBUF COUNT DATATYPE OP COMM

Package

mpi

Source

collective.lisp (file)

Function: %mpi-finalize ()

Package

mpi

Source

environment.lisp (file)

Function: %mpi-finalized *FLAG

Package

mpi

Source

environment.lisp (file)

Function: %mpi-free-mem PTR

Package

mpi

Source

environment.lisp (file)

Function: %mpi-gather *SENDBUF SENDCOUNT SENDTYPE *RECVBUF RECVCOUNT RECVTYPE ROOT COMM

Package

mpi

Source

collective.lisp (file)

Function: %mpi-gatherv *SENDBUF SENDCOUNT SENDTYPE *RECVBUF RECVCOUNTS DISPLS RECVTYPE ROOT COMM

Package

mpi

Source

collective.lisp (file)

Function: %mpi-get-count *STATUS DATATYPE *COUNT

Package

mpi

Source

point-to-point.lisp (file)

Function: %mpi-get-processor-name STRING *SIZE

Package

mpi

Source

environment.lisp (file)

Function: %mpi-group-compare GROUP1 GROUP2 *RESULT

Package

mpi

Source

contexts.lisp (file)

Function: %mpi-group-difference GROUP1 GROUP2 *NEWGROUP

Package

mpi

Source

contexts.lisp (file)

Function: %mpi-group-excl GROUP COUNT RANGES *NEWGROUP

Package

mpi

Source

contexts.lisp (file)

Function: %mpi-group-free *GROUP

Package

mpi

Source

contexts.lisp (file)

Function: %mpi-group-incl GROUP COUNT RANGES *NEWGROUP

Package

mpi

Source

contexts.lisp (file)

Function: %mpi-group-intersection GROUP1 GROUP2 *NEWGROUP

Package

mpi

Source

contexts.lisp (file)

Function: %mpi-group-range-excl GROUP COUNT RANGES *NEWGROUP

Package

mpi

Source

contexts.lisp (file)

Function: %mpi-group-range-incl GROUP COUNT RANGES *NEWGROUP

Package

mpi

Source

contexts.lisp (file)

Function: %mpi-group-rank GROUP *RANK

Package

mpi

Source

contexts.lisp (file)

Function: %mpi-group-size GROUP *SIZE

Package

mpi

Source

contexts.lisp (file)

Function: %mpi-group-translate-ranks GROUP1 COUNT RANKS1 GROUP2 RANKS2

Package

mpi

Source

contexts.lisp (file)

Function: %mpi-group-union GROUP1 GROUP2 *NEWGROUP

Package

mpi

Source

contexts.lisp (file)

Function: %mpi-iallgather *SENDBUF SENDCOUNT SENDTYPE *RECVBUF RECVCOUNT RECVTYPE COMM *REQUEST

Package

mpi

Source

collective.lisp (file)

Function: %mpi-iallgatherv *SENDBUF SENDCOUNT SENDTYPE *RECVBUF RECVCOUNTS DISPLS RECVTYPE COMM *REQUEST

Package

mpi

Source

collective.lisp (file)

Function: %mpi-iallreduce *SENDBUF *RECVBUF COUNT DATATYPE OP COMM *REQUEST

Package

mpi

Source

collective.lisp (file)

Function: %mpi-ialltoall *SENDBUF SENDCOUNT SENDTYPE *RECVBUF RECVCOUNT RECVTYPE COMM *REQUEST

Package

mpi

Source

collective.lisp (file)

Function: %mpi-ialltoallv *SENDBUF SENDCOUNTS SDISPLS SENDTYPE *RECVBUF RECVCOUNTS RDISPLS RECVTYPE COMM *REQUEST

Package

mpi

Source

collective.lisp (file)

Function: %mpi-ialltoallw *SENDBUF SENDCOUNTS SDISPLS SENDTYPES *RECVBUF RECVCOUNTS RDISPLS RECVTYPES COMM *REQUEST

Package

mpi

Source

collective.lisp (file)

Function: %mpi-ibarrier COMM *REQUEST

Package

mpi

Source

collective.lisp (file)

Function: %mpi-ibcast *BUF COUNT DATATYPE ROOT COMM *REQUEST

Package

mpi

Source

collective.lisp (file)

Function: %mpi-ibsend *BUF COUNT DATATYPE DEST TAG COMM *REQUEST

Package

mpi

Source

point-to-point.lisp (file)

Function: %mpi-iexscan *SENDBUF *RECVBUF COUNT DATATYPE OP COMM *REQUEST

Package

mpi

Source

collective.lisp (file)

Function: %mpi-igather *SENDBUF SENDCOUNT SENDTYPE *RECVBUF RECVCOUNT RECVTYPE ROOT COMM *REQUEST

Package

mpi

Source

collective.lisp (file)

Function: %mpi-igatherv *SENDBUF SENDCOUNT SENDTYPE *RECVBUF RECVCOUNTS DISPLS RECVTYPE ROOT COMM *REQUEST

Package

mpi

Source

collective.lisp (file)

Function: %mpi-improbe SOURCE TAG COMM *FLAG *MESSAGE *STATUS

Package

mpi

Source

point-to-point.lisp (file)

Function: %mpi-imrecv *BUF COUNT DATATYPE *MESSAGE *REQUEST

Package

mpi

Source

point-to-point.lisp (file)

Function: %mpi-init ARGC ARGV

Package

mpi

Source

environment.lisp (file)

Function: %mpi-init-thread ARGC ARGV REQUIRED PROVIDED

Package

mpi

Source

environment.lisp (file)

Function: %mpi-initialized *FLAG

Package

mpi

Source

environment.lisp (file)

Function: %mpi-iprobe SOURCE TAG COMM *FLAG *STATUS

Package

mpi

Source

point-to-point.lisp (file)

Function: %mpi-irecv *BUF COUNT DATATYPE SOURCE TAG COMM *REQUEST

Package

mpi

Source

point-to-point.lisp (file)

Function: %mpi-ireduce *SENDBUF *RECVBUF COUNT DATATYPE OP ROOT COMM *REQUEST

Package

mpi

Source

collective.lisp (file)

Function: %mpi-ireduce-scatter *SENDBUF *RECVBUF RECVCOUNTS DATATYPE OP COMM *REQUEST

Package

mpi

Source

collective.lisp (file)

Function: %mpi-ireduce-scatter-block *SENDBUF *RECVBUF RECVCOUNT DATATYPE OP COMM *REQUEST

Package

mpi

Source

collective.lisp (file)

Function: %mpi-irsend *BUF COUNT DATATYPE DEST TAG COMM *REQUEST

Package

mpi

Source

point-to-point.lisp (file)

Function: %mpi-iscan *SENDBUF *RECVBUF COUNT DATATYPE OP COMM *REQUEST

Package

mpi

Source

collective.lisp (file)

Function: %mpi-iscatter *SENDBUF SENDCOUNT SENDTYPE *RECVBUF RECVCOUNT RECVTYPE ROOT COMM *REQUEST

Package

mpi

Source

collective.lisp (file)

Function: %mpi-iscatterv *SENDBUF SENDCOUNTS DISPLS SENDTYPE *RECVBUF RECVCOUNT RECVTYPE ROOT COMM *REQUEST

Package

mpi

Source

collective.lisp (file)

Function: %mpi-isend *BUF COUNT DATATYPE DEST TAG COMM *REQUEST

Package

mpi

Source

point-to-point.lisp (file)

Function: %mpi-issend *BUF COUNT DATATYPE DEST TAG COMM *REQUEST

Package

mpi

Source

point-to-point.lisp (file)

Function: %mpi-mprobe SOURCE TAG COMM *MESSAGE *STATUS

Package

mpi

Source

point-to-point.lisp (file)

Function: %mpi-mrecv *BUF COUNT DATATYPE *MESSAGE *STATUS

Package

mpi

Source

point-to-point.lisp (file)

Function: %mpi-op-commutative OP *COMMUTE

Package

mpi

Source

collective.lisp (file)

Function: %mpi-op-create FUN COMMUTE *OP

Package

mpi

Source

collective.lisp (file)

Function: %mpi-op-free *OP

Package

mpi

Source

collective.lisp (file)

Function: %mpi-pack *INBUF INCOUNT DATATYPE *OUTBUF OUTSIZE *POSITION COMM

Package

mpi

Source

datatypes.lisp (file)

Function: %mpi-pack-size INCOUNT DATATYPE COMM *SIZE

Package

mpi

Source

datatypes.lisp (file)

Function: %mpi-probe SOURCE TAG COMM *STATUS

Package

mpi

Source

point-to-point.lisp (file)

Function: %mpi-recv *BUF COUNT DATATYPE SOURCE TAG COMM *STATUS

Package

mpi

Source

point-to-point.lisp (file)

Function: %mpi-recv-init *BUF COUNT DATATYPE SOURCE TAG COMM *REQUEST

Package

mpi

Source

point-to-point.lisp (file)

Function: %mpi-reduce *SENDBUF *RECVBUF COUNT DATATYPE OP ROOT COMM

Package

mpi

Source

collective.lisp (file)

Function: %mpi-reduce-local *INBUF *INOUTBUF COUNT DATATYPE OP

Package

mpi

Source

collective.lisp (file)

Function: %mpi-reduce-scatter *SENDBUF *RECVBUF RECVCOUNTS DATATYPE OP COMM

Package

mpi

Source

collective.lisp (file)

Function: %mpi-reduce-scatter-block *SENDBUF *RECVBUF RECVCOUNT DATATYPE OP COMM

Package

mpi

Source

collective.lisp (file)

Function: %mpi-request-free *REQUEST

Package

mpi

Source

point-to-point.lisp (file)

Function: %mpi-request-get-status REQUEST *FLAG *STATUS

Package

mpi

Source

point-to-point.lisp (file)

Function: %mpi-rsend *BUF COUNT DATATYPE DEST TAG COMM

Package

mpi

Source

point-to-point.lisp (file)

Function: %mpi-rsend-init *BUF COUNT DATATYPE DEST TAG COMM *REQUEST

Package

mpi

Source

point-to-point.lisp (file)

Function: %mpi-scan *SENDBUF *RECVBUF COUNT DATATYPE OP COMM

Package

mpi

Source

collective.lisp (file)

Function: %mpi-scatter *SENDBUF SENDCOUNT SENDTYPE *RECVBUF RECVCOUNT RECVTYPE ROOT COMM

Package

mpi

Source

collective.lisp (file)

Function: %mpi-scatterv *SENDBUF SENDCOUNTS DISPLS SENDTYPE *RECVBUF RECVCOUNT RECVTYPE ROOT COMM

Package

mpi

Source

collective.lisp (file)

Function: %mpi-send *BUF COUNT DATATYPE DEST TAG COMM

Package

mpi

Source

point-to-point.lisp (file)