File: buffer-deref.rst

package info (click to toggle)
llvm-toolchain-15 1%3A15.0.6-4
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 1,554,644 kB
  • sloc: cpp: 5,922,452; ansic: 1,012,136; asm: 674,362; python: 191,568; objc: 73,855; f90: 42,327; lisp: 31,913; pascal: 11,973; javascript: 10,144; sh: 9,421; perl: 7,447; ml: 5,527; awk: 3,523; makefile: 2,520; xml: 885; cs: 573; fortran: 567
file content (26 lines) | stat: -rw-r--r-- 893 bytes parent folder | download | duplicates (31) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
.. title:: clang-tidy - mpi-buffer-deref

mpi-buffer-deref
================

This check verifies if a buffer passed to an MPI (Message Passing Interface)
function is sufficiently dereferenced. Buffers should be passed as a single
pointer or array. As MPI function signatures specify ``void *`` for their buffer
types, insufficiently dereferenced buffers can be passed, like for example as
double pointers or multidimensional arrays, without a compiler warning emitted.

Examples:

.. code-block:: c++

   // A double pointer is passed to the MPI function.
   char *buf;
   MPI_Send(&buf, 1, MPI_CHAR, 0, 0, MPI_COMM_WORLD);

   // A multidimensional array is passed to the MPI function.
   short buf[1][1];
   MPI_Send(buf, 1, MPI_SHORT, 0, 0, MPI_COMM_WORLD);

   // A pointer to an array is passed to the MPI function.
   short *buf[1];
   MPI_Send(buf, 1, MPI_SHORT, 0, 0, MPI_COMM_WORLD);