From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id BDAE441B9E; Wed, 1 Feb 2023 13:33:08 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 67413406A2; Wed, 1 Feb 2023 13:33:08 +0100 (CET) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by mails.dpdk.org (Postfix) with ESMTP id 147254021F for ; Wed, 1 Feb 2023 13:33:05 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1675254785; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=gWXsj62oY6rURcns0E/7+L8adDmTtnVhKxqxlvZWP5U=; b=NbmtsKmxJHtOYveX4uSrEnQbiq9+Yz9LkOPXxrUuYAyLS2teuYNOa+W41QWcl0MvVZwFDH WOl69sNTFFOeUjF/rEXp75nwNjLyalHP/aAMk9p+uEVSIrX33YqkdXRUShBR4HzwcmCgzV TVbS/q+7t3+vnzLdMls1BwYYq4b/7a8= Received: from mail-pg1-f198.google.com (mail-pg1-f198.google.com [209.85.215.198]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_128_GCM_SHA256) id us-mta-371-zZE9SrBsNji11QYYO-_D5A-1; Wed, 01 Feb 2023 07:33:02 -0500 X-MC-Unique: zZE9SrBsNji11QYYO-_D5A-1 Received: by mail-pg1-f198.google.com with SMTP id q130-20020a632a88000000b004a03cfb3ac6so8327749pgq.6 for ; Wed, 01 Feb 2023 04:33:02 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=cc:to:subject:message-id:date:from:in-reply-to:references :mime-version:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=gWXsj62oY6rURcns0E/7+L8adDmTtnVhKxqxlvZWP5U=; b=0hPtTKE5myhgt4Nejfc/1ilaMwUfuFnzCrxlIT9yHR2NuZrOHEJL4tcWLp8R6YGQo3 UW1VnjmEyR+aCACXdKSkhLbpGNzMjnaHpIiIYA3ilauvppf1RjRT42+4oEZAbPWvsydj VQQauTwEizm3SbR0jSrWvYLu5gfsUmHhAJh4fuwQysHL//VR1nrkq08sBLMHuF+t7imB HKIAARGX4JAW8yzFZdlbRRWa2z5rqWBL2aXzptbN4pn/29Bz4pE1Y6KIvMjkzitwfQoL 3GetiH5ZZkfv1yFKim4iWBzuBJuKaYpZ8LTQn8gPYE29NXh1kQ9V26FLJYk7wWgV7QS2 xWpw== X-Gm-Message-State: AO0yUKXtjg/cqwWUxd/HsZKotWtFpzmepoAUm2qWPui3/2PzG1mEKNb5 4XdQB6uysRDEyGnS2y9x44Q20dxAA9BV1vVU+xDGn1ibpYHmY98zZAD7g+u9aBK+O/VZgp7cpzm 6Z8NOcFO0dEwdflmn/SA= X-Received: by 2002:a17:902:e807:b0:198:a084:faa9 with SMTP id u7-20020a170902e80700b00198a084faa9mr542163plg.33.1675254781577; Wed, 01 Feb 2023 04:33:01 -0800 (PST) X-Google-Smtp-Source: AK7set+zVgzt0CxRHirXNez5vXM3Ons/0MYq37EFoUKxn5AsFw/EpCjR19Mzb8yZHJvS7tqIR2t3fq1/YOeLnZSRuzQ= X-Received: by 2002:a17:902:e807:b0:198:a084:faa9 with SMTP id u7-20020a170902e80700b00198a084faa9mr542144plg.33.1675254781239; Wed, 01 Feb 2023 04:33:01 -0800 (PST) MIME-Version: 1.0 References: <20220328121758.26632-1-david.marchand@redhat.com> <20230201111411.1509520-1-david.marchand@redhat.com> <20230201111411.1509520-2-david.marchand@redhat.com> In-Reply-To: <20230201111411.1509520-2-david.marchand@redhat.com> From: David Marchand Date: Wed, 1 Feb 2023 13:32:49 +0100 Message-ID: Subject: Re: [PATCH v5 1/9] eal: annotate spinlock, rwlock and seqlock To: "Chen, Zhaoyan" , "Tu, Lijuan" , sys_stv 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 , =?UTF-8?Q?Mattias_R=C3=B6nnblom?= , David Christensen , Bruce Richardson , Konstantin Ananyev X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="UTF-8" X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Hello Intel CI team, On Wed, Feb 1, 2023 at 12:16 PM David Marchand 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 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