From: Maxime Coquelin <maxime.coquelin@redhat.com>
To: David Marchand <david.marchand@redhat.com>, dev@dpdk.org
Cc: stephen@networkplumber.org, chenbo.xia@intel.com,
jiayu.hu@intel.com, yuanx.wang@intel.com, xuan.ding@intel.com,
"Anatoly Burakov" <anatoly.burakov@intel.com>,
"Mattias Rönnblom" <mattias.ronnblom@ericsson.com>,
"David Christensen" <drc@linux.vnet.ibm.com>,
"Bruce Richardson" <bruce.richardson@intel.com>,
"Konstantin Ananyev" <konstantin.v.ananyev@yandex.ru>
Subject: Re: [PATCH v4 1/9] eal: annotate spinlock, rwlock and seqlock
Date: Tue, 31 Jan 2023 17:18:31 +0100 [thread overview]
Message-ID: <dcf35acd-6690-9340-8c98-9b0a5aace3e4@redhat.com> (raw)
In-Reply-To: <20230119184620.3195267-2-david.marchand@redhat.com>
On 1/19/23 19:46, David Marchand wrote:
> clang offers some thread safety checks, statically verifying that locks
> are taken and released in the code.
> To use those checks, the full code leading to taking or releasing locks
> must be annotated with some attributes.
>
> Wrap those attributes into our own set of macros.
>
> rwlock, seqlock and the "normal" spinlock are instrumented.
>
> Those checks might be of interest out of DPDK, but it requires that the
> including application locks are annotated.
> On the other hand, applications out there might have been using
> those same checks.
> To be on the safe side, keep this instrumentation under a
> RTE_ANNOTATE_LOCKS internal build flag.
>
> A component may en/disable this check by setting
> annotate_locks = true/false in its meson.build.
>
> Signed-off-by: David Marchand <david.marchand@redhat.com>
> ---
> Changes since RFC v3:
> - rebased,
> - added some documentation,
> - added assert attribute,
> - instrumented seqlock,
> - cleaned annotations in arch-specific headers,
>
> Changes since RFC v2:
> - fixed rwlock trylock,
> - instrumented _tm spinlocks,
> - aligned attribute names to clang,
>
> ---
> .../prog_guide/env_abstraction_layer.rst | 24 ++++++
> doc/guides/rel_notes/release_23_03.rst | 5 ++
> drivers/meson.build | 5 ++
> lib/eal/include/generic/rte_rwlock.h | 27 +++++--
> lib/eal/include/generic/rte_spinlock.h | 31 +++++---
> lib/eal/include/meson.build | 1 +
> lib/eal/include/rte_lock_annotations.h | 73 +++++++++++++++++++
> lib/eal/include/rte_seqlock.h | 6 ++
> lib/eal/ppc/include/rte_spinlock.h | 3 +
> lib/eal/x86/include/rte_rwlock.h | 4 +
> lib/eal/x86/include/rte_spinlock.h | 9 +++
> lib/meson.build | 5 ++
> 12 files changed, 179 insertions(+), 14 deletions(-)
> create mode 100644 lib/eal/include/rte_lock_annotations.h
>
> diff --git a/doc/guides/prog_guide/env_abstraction_layer.rst b/doc/guides/prog_guide/env_abstraction_layer.rst
> index 35fbebe1be..6c1e8ba985 100644
> --- a/doc/guides/prog_guide/env_abstraction_layer.rst
> +++ b/doc/guides/prog_guide/env_abstraction_layer.rst
> @@ -529,6 +529,30 @@ Misc Functions
>
> Locks and atomic operations are per-architecture (i686 and x86_64).
>
> +Lock annotations
> +~~~~~~~~~~~~~~~~
> +
> +R/W locks, seq locks and spinlocks have been instrumented to help developers in
> +catching issues in DPDK.
> +
> +This instrumentation relies on
> +`clang Thread Safety checks <https://clang.llvm.org/docs/ThreadSafetyAnalysis.html>`_.
> +All attributes are prefixed with __rte and are fully described in the clang
> +documentation.
> +
> +Some general comments:
> +
> +- it is important that lock requirements are expressed at the function
> + declaration level in headers so that other code units can be inspected,
> +- when some global lock is necessary to some user-exposed API, it is preferred
> + to expose it via an internal helper rather than expose the global variable,
> +- there are a list of known limitations with clang instrumentation, but before
> + waiving checks with ``__rte_no_thread_safety_analysis`` in your code, please
> + discuss it on the mailing list,
> +
> +A DPDK library/driver can enabled/disable the checks by setting
s/enabled/enable/
> +``annotate_locks`` accordingly in its ``meson.build`` file.
> +
> IOVA Mode Detection
> ~~~~~~~~~~~~~~~~~~~
>
> diff --git a/doc/guides/rel_notes/release_23_03.rst b/doc/guides/rel_notes/release_23_03.rst
> index c15f6fbb9f..5425e59c65 100644
> --- a/doc/guides/rel_notes/release_23_03.rst
> +++ b/doc/guides/rel_notes/release_23_03.rst
> @@ -55,6 +55,11 @@ New Features
> Also, make sure to start the actual text at the margin.
> =======================================================
>
> +* **Introduced lock annotations.**
> +
> + Added lock annotations attributes to that clang can statically analyze lock
s/to/so/
> + correctness.
> +
With above typos fixed:
Reviewed-by: Maxime Coquelin <maxime.coquelin@redhat.com>
Thanks,
Maxime
next prev parent reply other threads:[~2023-01-31 16:19 UTC|newest]
Thread overview: 110+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-03-28 12:17 [RFC PATCH 0/5] vhost lock annotations David Marchand
2022-03-28 12:17 ` [RFC PATCH 1/5] vhost: fix missing virtqueue lock protection David Marchand
2022-03-28 12:17 ` [RFC PATCH 2/5] vhost: annotate virtqueue access lock David Marchand
2022-03-28 12:17 ` [RFC PATCH 3/5] vhost: fix async access David Marchand
2022-03-28 12:17 ` [RFC PATCH 4/5] vhost: annotate async locking requirement David Marchand
2022-03-28 12:17 ` [RFC PATCH 5/5] vhost: annotate IOTLB locks David Marchand
2022-03-30 13:49 ` [RFC PATCH v2 0/9] vhost lock annotations David Marchand
2022-03-30 13:49 ` [RFC PATCH v2 1/9] vhost: fix missing virtqueue lock protection David Marchand
2022-03-30 13:49 ` [RFC PATCH v2 2/9] eal: annotate spinlock and rwlock David Marchand
2022-03-31 9:22 ` David Marchand
2022-04-04 6:21 ` Stephen Hemminger
2022-04-07 8:20 ` David Marchand
2022-03-30 13:49 ` [RFC PATCH v2 3/9] vhost: annotate virtqueue access lock David Marchand
2022-04-07 1:40 ` Hu, Jiayu
2022-04-07 7:03 ` David Marchand
2022-03-30 13:49 ` [RFC PATCH v2 4/9] vhost: fix async access David Marchand
2022-03-31 8:00 ` Maxime Coquelin
2022-03-31 10:23 ` Hu, Jiayu
2022-04-04 6:57 ` Pai G, Sunil
2022-03-30 13:49 ` [RFC PATCH v2 5/9] vhost: annotate async acesses David Marchand
2022-03-30 13:49 ` [RFC PATCH v2 6/9] vhost: annotate need reply handling David Marchand
2022-03-30 13:49 ` [RFC PATCH v2 7/9] vhost: annotate VDPA device list accesses David Marchand
2022-03-30 13:49 ` [RFC PATCH v2 8/9] vhost: annotate IOTLB locks David Marchand
2022-03-30 13:49 ` [RFC PATCH v2 9/9] vhost: enable lock check David Marchand
2022-03-30 14:03 ` [RFC PATCH v2 0/9] vhost lock annotations David Marchand
2022-03-30 14:37 ` Ali Alnubani
2022-04-05 7:11 ` David Marchand
2022-04-11 11:00 ` [RFC PATCH v3 0/8] " David Marchand
2022-04-11 11:00 ` [RFC PATCH v3 1/8] eal: annotate spinlock and rwlock David Marchand
2022-04-21 13:48 ` Maxime Coquelin
2022-04-28 12:16 ` David Marchand
2022-04-11 11:00 ` [RFC PATCH v3 2/8] vhost: annotate virtqueue access lock David Marchand
2022-04-21 15:25 ` Maxime Coquelin
2022-04-22 9:49 ` David Marchand
2022-04-11 11:00 ` [RFC PATCH v3 3/8] vhost: fix async access David Marchand
2022-04-21 19:21 ` Maxime Coquelin
2022-05-17 13:24 ` Maxime Coquelin
2022-04-11 11:00 ` [RFC PATCH v3 4/8] vhost: annotate async accesses David Marchand
2022-04-22 7:20 ` Maxime Coquelin
2022-04-11 11:00 ` [RFC PATCH v3 5/8] vhost: annotate need reply handling David Marchand
2022-04-22 7:25 ` Maxime Coquelin
2022-04-11 11:00 ` [RFC PATCH v3 6/8] vhost: annotate vDPA device list accesses David Marchand
2022-04-22 7:26 ` Maxime Coquelin
2022-04-11 11:00 ` [RFC PATCH v3 7/8] vhost: annotate IOTLB locks David Marchand
2022-04-22 7:46 ` Maxime Coquelin
2022-04-11 11:00 ` [RFC PATCH v3 8/8] vhost: enable lock check David Marchand
2022-04-22 7:47 ` Maxime Coquelin
2023-01-19 18:46 ` [PATCH v4 0/9] vhost lock annotations David Marchand
2023-01-19 18:46 ` [PATCH v4 1/9] eal: annotate spinlock, rwlock and seqlock David Marchand
2023-01-19 19:42 ` Stephen Hemminger
2023-01-19 20:39 ` Tyler Retzlaff
2023-01-19 21:16 ` David Marchand
2023-01-19 21:50 ` Tyler Retzlaff
2023-01-26 12:18 ` David Marchand
2023-01-19 20:55 ` David Marchand
2023-01-19 19:43 ` Stephen Hemminger
2023-01-31 16:18 ` Maxime Coquelin [this message]
2023-01-19 18:46 ` [PATCH v4 2/9] vhost: simplify need reply handling David Marchand
2023-01-31 16:41 ` Maxime Coquelin
2023-01-19 18:46 ` [PATCH v4 3/9] vhost: terminate when access lock is not taken David Marchand
2023-01-31 16:47 ` Maxime Coquelin
2023-01-19 18:46 ` [PATCH v4 4/9] vhost: annotate virtqueue access lock David Marchand
2023-01-31 16:50 ` Maxime Coquelin
2023-01-19 18:46 ` [PATCH v4 5/9] vhost: annotate async accesses David Marchand
2023-01-31 16:54 ` Maxime Coquelin
2023-01-19 18:46 ` [PATCH v4 6/9] vhost: always take IOTLB lock David Marchand
2023-01-31 16:59 ` Maxime Coquelin
2023-01-19 18:46 ` [PATCH v4 7/9] vhost: annotate " David Marchand
2023-01-31 17:05 ` Maxime Coquelin
2023-01-19 18:46 ` [PATCH v4 8/9] vhost: annotate vDPA device list accesses David Marchand
2023-01-31 17:08 ` Maxime Coquelin
2023-01-19 18:46 ` [PATCH v4 9/9] vhost: enable lock check David Marchand
2023-01-31 17:14 ` Maxime Coquelin
2023-01-19 19:20 ` [PATCH v4 0/9] vhost lock annotations Morten Brørup
2023-02-01 11:14 ` [PATCH v5 0/9] Lock annotations David Marchand
2023-02-01 11:14 ` [PATCH v5 1/9] eal: annotate spinlock, rwlock and seqlock David Marchand
2023-02-01 12:32 ` David Marchand
2023-02-06 1:01 ` Tu, Lijuan
2023-02-06 8:12 ` David Marchand
2023-02-01 11:14 ` [PATCH v5 2/9] vhost: simplify need reply handling David Marchand
2023-02-01 11:14 ` [PATCH v5 3/9] vhost: terminate when access lock is not taken David Marchand
2023-02-01 11:14 ` [PATCH v5 4/9] vhost: annotate virtqueue access lock David Marchand
2023-02-01 11:14 ` [PATCH v5 5/9] vhost: annotate async accesses David Marchand
2023-02-01 11:14 ` [PATCH v5 6/9] vhost: always take IOTLB lock David Marchand
2023-02-01 11:14 ` [PATCH v5 7/9] vhost: annotate " David Marchand
2023-02-01 11:14 ` [PATCH v5 8/9] vhost: annotate vDPA device list accesses David Marchand
2023-02-01 11:14 ` [PATCH v5 9/9] vhost: enable lock check David Marchand
2023-02-07 10:45 ` [PATCH v6 0/9] Lock annotations David Marchand
2023-02-07 10:45 ` [PATCH v6 1/9] eal: annotate spinlock, rwlock and seqlock David Marchand
2023-02-09 8:00 ` Xia, Chenbo
2023-02-07 10:45 ` [PATCH v6 2/9] vhost: simplify need reply handling David Marchand
2023-02-09 8:00 ` Xia, Chenbo
2023-02-07 10:45 ` [PATCH v6 3/9] vhost: terminate when access lock is not taken David Marchand
2023-02-09 8:01 ` Xia, Chenbo
2023-02-07 10:45 ` [PATCH v6 4/9] vhost: annotate virtqueue access lock David Marchand
2023-02-09 8:01 ` Xia, Chenbo
2023-02-07 10:45 ` [PATCH v6 5/9] vhost: annotate async accesses David Marchand
2023-02-09 8:01 ` Xia, Chenbo
2023-02-07 10:45 ` [PATCH v6 6/9] vhost: always take IOTLB lock David Marchand
2023-02-09 8:01 ` Xia, Chenbo
2023-02-07 10:45 ` [PATCH v6 7/9] vhost: annotate " David Marchand
2023-02-09 8:02 ` Xia, Chenbo
2023-02-07 10:45 ` [PATCH v6 8/9] vhost: annotate vDPA device list accesses David Marchand
2023-02-09 8:02 ` Xia, Chenbo
2023-02-07 10:45 ` [PATCH v6 9/9] vhost: enable lock check David Marchand
2023-02-09 8:05 ` Xia, Chenbo
2023-02-09 7:59 ` [PATCH v6 0/9] Lock annotations Xia, Chenbo
2023-02-09 8:08 ` David Marchand
2023-02-09 8:24 ` Xia, Chenbo
2023-02-09 13:48 ` David Marchand
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=dcf35acd-6690-9340-8c98-9b0a5aace3e4@redhat.com \
--to=maxime.coquelin@redhat.com \
--cc=anatoly.burakov@intel.com \
--cc=bruce.richardson@intel.com \
--cc=chenbo.xia@intel.com \
--cc=david.marchand@redhat.com \
--cc=dev@dpdk.org \
--cc=drc@linux.vnet.ibm.com \
--cc=jiayu.hu@intel.com \
--cc=konstantin.v.ananyev@yandex.ru \
--cc=mattias.ronnblom@ericsson.com \
--cc=stephen@networkplumber.org \
--cc=xuan.ding@intel.com \
--cc=yuanx.wang@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).