From: David Marchand <david.marchand@redhat.com>
To: "Chen, Zhaoyan" <zhaoyan.chen@intel.com>,
"Tu, Lijuan" <lijuan.tu@intel.com>, sys_stv <sys_stv@intel.com>
Cc: dev@dpdk.org, maxime.coquelin@redhat.com,
stephen@networkplumber.org, chenbo.xia@intel.com,
jiayu.hu@intel.com, yuanx.wang@intel.com, xuan.ding@intel.com,
mb@smartsharesystems.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 v5 1/9] eal: annotate spinlock, rwlock and seqlock
Date: Wed, 1 Feb 2023 13:32:49 +0100 [thread overview]
Message-ID: <CAJFAV8zGysAORH+iBfO8jXJtkZUVE03AqK7LiFstJV+PSK0RCQ@mail.gmail.com> (raw)
In-Reply-To: <20230201111411.1509520-2-david.marchand@redhat.com>
Hello Intel CI team,
On Wed, Feb 1, 2023 at 12:16 PM David Marchand
<david.marchand@redhat.com> wrote:
[snip]
> Note:
> Doxygen preprocessor does not understand trailing function attributes
> (this can be observed with the rte_seqlock.h header).
> One would think that expanding the annotation macros to a noop in
> rte_lock_annotations.h would be enough (since RTE_ANNOTATE_LOCKS is not
> set during doxygen processing)). Unfortunately, the use of
> EXPAND_ONLY_PREDEF defeats this.
>
> Removing EXPAND_ONLY_PREDEF entirely is not an option as it would expand
> all other DPDK macros.
>
> The chosen solution is to expand the annotation macros explicitly to a
> noop in PREDEFINED.
>
[snip]
> ---
> Changes since v4:
> - hid annotations from Doxygen,
> - fixed typos,
[snip]
> diff --git a/doc/api/doxy-api.conf.in b/doc/api/doxy-api.conf.in
> index f0886c3bd1..e859426099 100644
> --- a/doc/api/doxy-api.conf.in
> +++ b/doc/api/doxy-api.conf.in
> @@ -84,6 +84,17 @@ FILE_PATTERNS = rte_*.h \
> PREDEFINED = __DOXYGEN__ \
> RTE_HAS_CPUSET \
> VFIO_PRESENT \
> + __rte_lockable= \
> + __rte_guarded_by(x)= \
> + __rte_exclusive_locks_required(x)= \
> + __rte_exclusive_lock_function(x)= \
> + __rte_exclusive_trylock_function(x)= \
> + __rte_assert_exclusive_lock(x)= \
> + __rte_shared_locks_required(x)= \
> + __rte_shared_lock_function(x)= \
> + __rte_shared_trylock_function(x)= \
> + __rte_assert_shared_lock(x)= \
> + __rte_unlock_function(x)= \
> __attribute__(x)=
>
> OPTIMIZE_OUTPUT_FOR_C = YES
I received this report:
http://mails.dpdk.org/archives/test-report/2023-February/345705.html
FAILED: doc/api/html
/usr/bin/python3 ../doc/api/generate_doxygen.py doc/api/html
/usr/bin/doxygen doc/api/doxy-api.conf
/root/UB2204-64_K5.15.0_GCC11.3.0/x86_64-native-linuxapp-doc/26733/dpdk/lib/eal/include/rte_seqlock.h:218:
error: Found ')' without opening '(' for trailing return type ' ->
lock)...' (warning treated as error, aborting now)
Traceback (most recent call last):
File "/root/UB2204-64_K5.15.0_GCC11.3.0/x86_64-native-linuxapp-doc/26733/dpdk/x86_64-native-linuxapp-doc/../doc/api/generate_doxygen.py",
line 13, in <module>
subprocess.run(doxygen_command, check=True, stdout=out)
File "/usr/lib/python3.10/subprocess.py", line 524, in run
raise CalledProcessError(retcode, process.args,
subprocess.CalledProcessError: Command '['/usr/bin/doxygen',
'doc/api/doxy-api.conf']' returned non-zero exit status 1.
This error is what the patch 1 in this series (with the
doc/api/doxy-api.conf.in update) tries to avoid.
I tested my series in a fresh Ubuntu 22.04 container and I can't
reproduce this error.
Please share how this test was run in your lab so I can replicate.
Thanks.
--
David Marchand
next prev parent reply other threads:[~2023-02-01 12:33 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
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 [this message]
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=CAJFAV8zGysAORH+iBfO8jXJtkZUVE03AqK7LiFstJV+PSK0RCQ@mail.gmail.com \
--to=david.marchand@redhat.com \
--cc=anatoly.burakov@intel.com \
--cc=bruce.richardson@intel.com \
--cc=chenbo.xia@intel.com \
--cc=dev@dpdk.org \
--cc=drc@linux.vnet.ibm.com \
--cc=jiayu.hu@intel.com \
--cc=konstantin.v.ananyev@yandex.ru \
--cc=lijuan.tu@intel.com \
--cc=mattias.ronnblom@ericsson.com \
--cc=maxime.coquelin@redhat.com \
--cc=mb@smartsharesystems.com \
--cc=stephen@networkplumber.org \
--cc=sys_stv@intel.com \
--cc=xuan.ding@intel.com \
--cc=yuanx.wang@intel.com \
--cc=zhaoyan.chen@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).