| Message ID | 20240411093208.2483580-1-aleksander.lobakin@intel.com (mailing list archive) |
|---|---|
| State | Not Applicable |
| Headers | show |
| Series | kernel-doc: fix struct_group_tagged() parsing | expand |
| Context | Check | Description |
|---|---|---|
| netdev/tree_selection | success | Not a local patch |
From: Przemek Kitszel <przemyslaw.kitszel@intel.com> Date: Thu, 11 Apr 2024 13:14:20 +0200 > On 4/11/24 11:32, Alexander Lobakin wrote: >> From: Kees Cook <keescook@chromium.org> >> >> kernel-doc emits a warning on struct_group_tagged() if you describe your >> struct group member: >> >> include/net/libeth/rx.h:69: warning: Excess struct member 'fp' >> description in 'libeth_fq' >> >> The code: >> >> /** >> * struct libeth_fq - structure representing a buffer queue >> * @fp: hotpath part of the structure >> * @pp: &page_pool for buffer management >> [...] >> */ >> struct libeth_fq { >> struct_group_tagged(libeth_fq_fp, fp, >> struct page_pool *pp; >> [...] >> ); >> >> When a struct_group_tagged() is encountered, we need to build a >> `struct TAG NAME;` from it, so that it will be treated as a valid >> embedded struct. >> Decouple the regex and do the replacement there. As far as I can see, >> this doesn't produce any new warnings on the current mainline tree. >> >> Reported-by: Jakub Kicinski <kuba@kernel.org> >> Closes: https://lore.kernel.org/netdev/20240405212513.0d189968@kernel.org >> Fixes: 50d7bd38c3aa ("stddef: Introduce struct_group() helper macro") >> Signed-off-by: Kees Cook <keescook@chromium.org> >> Co-developed-by: Alexander Lobakin <aleksander.lobakin@intel.com> >> Signed-off-by: Alexander Lobakin <aleksander.lobakin@intel.com> >> --- >> scripts/kernel-doc | 3 ++- >> 1 file changed, 2 insertions(+), 1 deletion(-) >> >> diff --git a/scripts/kernel-doc b/scripts/kernel-doc >> index 43a30f2de513..01ac8f794b30 100755 >> --- a/scripts/kernel-doc >> +++ b/scripts/kernel-doc >> @@ -1152,7 +1152,8 @@ sub dump_struct($$) { >> # - first eat non-declaration parameters and rewrite for >> final match >> # - then remove macro, outer parens, and trailing semicolon >> $members =~ s/\bstruct_group\s*\(([^,]*,)/STRUCT_GROUP(/gos; >> - $members =~ >> s/\bstruct_group_(attr|tagged)\s*\(([^,]*,){2}/STRUCT_GROUP(/gos; >> + $members =~ >> s/\bstruct_group_attr\s*\(([^,]*,){2}/STRUCT_GROUP(/gos; >> + $members =~ >> s/\bstruct_group_tagged\s*\(([^,]*),([^,]*),/struct $1 $2; >> STRUCT_GROUP(/gos; >> $members =~ >> s/\b__struct_group\s*\(([^,]*,){3}/STRUCT_GROUP(/gos; >> $members =~ >> s/\bSTRUCT_GROUP(\(((?:(?>[^)(]+)|(?1))*)\))[^;]*;/$2/gos; >> > > I would complain on code that matches `[^,]*` part with 0 characters, > meaning no tag for struct_group_tagged(), or no attrs for > struct_group_attrs(). In such cases simpler struct_group() call should > be suggested. However, that issue was presented prior to your patch. Rather a subject for checkpatch, not kernel-doc? > > This is clearly an improvement, so: > Reviewed-by: Przemek Kitszel <przemyslaw.kitszel@intel.com> Thanks! Olek
On 4/11/24 11:32, Alexander Lobakin wrote: > From: Kees Cook <keescook@chromium.org> > > kernel-doc emits a warning on struct_group_tagged() if you describe your > struct group member: > > include/net/libeth/rx.h:69: warning: Excess struct member 'fp' description in 'libeth_fq' > > The code: > > /** > * struct libeth_fq - structure representing a buffer queue > * @fp: hotpath part of the structure > * @pp: &page_pool for buffer management > [...] > */ > struct libeth_fq { > struct_group_tagged(libeth_fq_fp, fp, > struct page_pool *pp; > [...] > ); > > When a struct_group_tagged() is encountered, we need to build a > `struct TAG NAME;` from it, so that it will be treated as a valid > embedded struct. > Decouple the regex and do the replacement there. As far as I can see, > this doesn't produce any new warnings on the current mainline tree. > > Reported-by: Jakub Kicinski <kuba@kernel.org> > Closes: https://lore.kernel.org/netdev/20240405212513.0d189968@kernel.org > Fixes: 50d7bd38c3aa ("stddef: Introduce struct_group() helper macro") > Signed-off-by: Kees Cook <keescook@chromium.org> > Co-developed-by: Alexander Lobakin <aleksander.lobakin@intel.com> > Signed-off-by: Alexander Lobakin <aleksander.lobakin@intel.com> > --- > scripts/kernel-doc | 3 ++- > 1 file changed, 2 insertions(+), 1 deletion(-) > > diff --git a/scripts/kernel-doc b/scripts/kernel-doc > index 43a30f2de513..01ac8f794b30 100755 > --- a/scripts/kernel-doc > +++ b/scripts/kernel-doc > @@ -1152,7 +1152,8 @@ sub dump_struct($$) { > # - first eat non-declaration parameters and rewrite for final match > # - then remove macro, outer parens, and trailing semicolon > $members =~ s/\bstruct_group\s*\(([^,]*,)/STRUCT_GROUP(/gos; > - $members =~ s/\bstruct_group_(attr|tagged)\s*\(([^,]*,){2}/STRUCT_GROUP(/gos; > + $members =~ s/\bstruct_group_attr\s*\(([^,]*,){2}/STRUCT_GROUP(/gos; > + $members =~ s/\bstruct_group_tagged\s*\(([^,]*),([^,]*),/struct $1 $2; STRUCT_GROUP(/gos; > $members =~ s/\b__struct_group\s*\(([^,]*,){3}/STRUCT_GROUP(/gos; > $members =~ s/\bSTRUCT_GROUP(\(((?:(?>[^)(]+)|(?1))*)\))[^;]*;/$2/gos; > I would complain on code that matches `[^,]*` part with 0 characters, meaning no tag for struct_group_tagged(), or no attrs for struct_group_attrs(). In such cases simpler struct_group() call should be suggested. However, that issue was presented prior to your patch. This is clearly an improvement, so: Reviewed-by: Przemek Kitszel <przemyslaw.kitszel@intel.com>
On 4/11/24 13:14, Alexander Lobakin wrote: > From: Przemek Kitszel <przemyslaw.kitszel@intel.com> > Date: Thu, 11 Apr 2024 13:14:20 +0200 > >> On 4/11/24 11:32, Alexander Lobakin wrote: >>> From: Kees Cook <keescook@chromium.org> >>> >>> kernel-doc emits a warning on struct_group_tagged() if you describe your >>> struct group member: >>> >>> include/net/libeth/rx.h:69: warning: Excess struct member 'fp' >>> description in 'libeth_fq' >>> >>> The code: >>> >>> /** >>> * struct libeth_fq - structure representing a buffer queue >>> * @fp: hotpath part of the structure >>> * @pp: &page_pool for buffer management >>> [...] >>> */ >>> struct libeth_fq { >>> struct_group_tagged(libeth_fq_fp, fp, >>> struct page_pool *pp; >>> [...] >>> ); >>> >>> When a struct_group_tagged() is encountered, we need to build a >>> `struct TAG NAME;` from it, so that it will be treated as a valid >>> embedded struct. >>> Decouple the regex and do the replacement there. As far as I can see, >>> this doesn't produce any new warnings on the current mainline tree. >>> >>> Reported-by: Jakub Kicinski <kuba@kernel.org> >>> Closes: https://lore.kernel.org/netdev/20240405212513.0d189968@kernel.org >>> Fixes: 50d7bd38c3aa ("stddef: Introduce struct_group() helper macro") >>> Signed-off-by: Kees Cook <keescook@chromium.org> >>> Co-developed-by: Alexander Lobakin <aleksander.lobakin@intel.com> >>> Signed-off-by: Alexander Lobakin <aleksander.lobakin@intel.com> >>> --- >>> scripts/kernel-doc | 3 ++- >>> 1 file changed, 2 insertions(+), 1 deletion(-) >>> >>> diff --git a/scripts/kernel-doc b/scripts/kernel-doc >>> index 43a30f2de513..01ac8f794b30 100755 >>> --- a/scripts/kernel-doc >>> +++ b/scripts/kernel-doc >>> @@ -1152,7 +1152,8 @@ sub dump_struct($$) { >>> # - first eat non-declaration parameters and rewrite for >>> final match >>> # - then remove macro, outer parens, and trailing semicolon >>> $members =~ s/\bstruct_group\s*\(([^,]*,)/STRUCT_GROUP(/gos; >>> - $members =~ >>> s/\bstruct_group_(attr|tagged)\s*\(([^,]*,){2}/STRUCT_GROUP(/gos; >>> + $members =~ >>> s/\bstruct_group_attr\s*\(([^,]*,){2}/STRUCT_GROUP(/gos; >>> + $members =~ >>> s/\bstruct_group_tagged\s*\(([^,]*),([^,]*),/struct $1 $2; >>> STRUCT_GROUP(/gos; >>> $members =~ >>> s/\b__struct_group\s*\(([^,]*,){3}/STRUCT_GROUP(/gos; >>> $members =~ >>> s/\bSTRUCT_GROUP(\(((?:(?>[^)(]+)|(?1))*)\))[^;]*;/$2/gos; >>> >> >> I would complain on code that matches `[^,]*` part with 0 characters, >> meaning no tag for struct_group_tagged(), or no attrs for >> struct_group_attrs(). In such cases simpler struct_group() call should >> be suggested. However, that issue was presented prior to your patch. > > Rather a subject for checkpatch, not kernel-doc? Good point. But that reminds me that getting patches accepted into checkpatch is not possible for mere mortals :/ (exaggerating here, but just a little) > >> >> This is clearly an improvement, so: >> Reviewed-by: Przemek Kitszel <przemyslaw.kitszel@intel.com> > > Thanks! > Olek
Alexander Lobakin <aleksander.lobakin@intel.com> writes: > From: Kees Cook <keescook@chromium.org> > > kernel-doc emits a warning on struct_group_tagged() if you describe your > struct group member: > > include/net/libeth/rx.h:69: warning: Excess struct member 'fp' description in 'libeth_fq' > > The code: > > /** > * struct libeth_fq - structure representing a buffer queue > * @fp: hotpath part of the structure > * @pp: &page_pool for buffer management > [...] > */ > struct libeth_fq { > struct_group_tagged(libeth_fq_fp, fp, > struct page_pool *pp; > [...] > ); > > When a struct_group_tagged() is encountered, we need to build a > `struct TAG NAME;` from it, so that it will be treated as a valid > embedded struct. > Decouple the regex and do the replacement there. As far as I can see, > this doesn't produce any new warnings on the current mainline tree. > > Reported-by: Jakub Kicinski <kuba@kernel.org> > Closes: https://lore.kernel.org/netdev/20240405212513.0d189968@kernel.org > Fixes: 50d7bd38c3aa ("stddef: Introduce struct_group() helper macro") > Signed-off-by: Kees Cook <keescook@chromium.org> > Co-developed-by: Alexander Lobakin <aleksander.lobakin@intel.com> > Signed-off-by: Alexander Lobakin <aleksander.lobakin@intel.com> > --- > scripts/kernel-doc | 3 ++- > 1 file changed, 2 insertions(+), 1 deletion(-) So, in docs-next, applying this *adds* two warnings: > ./include/net/page_pool/types.h:77: warning: Function parameter or struct member 'fast' not described in 'page_pool_params' > ./include/net/page_pool/types.h:77: warning: Function parameter or struct member 'slow' not described in 'page_pool_params' In truth, the warnings look correct. I guess I'll leave this applied, but perhaps a fix for the warnings should go into the net tree? Thanks, jon
From: Jonathan Corbet <corbet@lwn.net> Date: Wed, 24 Apr 2024 13:31:14 -0600 > Alexander Lobakin <aleksander.lobakin@intel.com> writes: > >> From: Kees Cook <keescook@chromium.org> >> >> kernel-doc emits a warning on struct_group_tagged() if you describe your >> struct group member: >> >> include/net/libeth/rx.h:69: warning: Excess struct member 'fp' description in 'libeth_fq' >> >> The code: >> >> /** >> * struct libeth_fq - structure representing a buffer queue >> * @fp: hotpath part of the structure >> * @pp: &page_pool for buffer management >> [...] >> */ >> struct libeth_fq { >> struct_group_tagged(libeth_fq_fp, fp, >> struct page_pool *pp; >> [...] >> ); >> >> When a struct_group_tagged() is encountered, we need to build a >> `struct TAG NAME;` from it, so that it will be treated as a valid >> embedded struct. >> Decouple the regex and do the replacement there. As far as I can see, >> this doesn't produce any new warnings on the current mainline tree. >> >> Reported-by: Jakub Kicinski <kuba@kernel.org> >> Closes: https://lore.kernel.org/netdev/20240405212513.0d189968@kernel.org >> Fixes: 50d7bd38c3aa ("stddef: Introduce struct_group() helper macro") >> Signed-off-by: Kees Cook <keescook@chromium.org> >> Co-developed-by: Alexander Lobakin <aleksander.lobakin@intel.com> >> Signed-off-by: Alexander Lobakin <aleksander.lobakin@intel.com> >> --- >> scripts/kernel-doc | 3 ++- >> 1 file changed, 2 insertions(+), 1 deletion(-) > > So, in docs-next, applying this *adds* two warnings: > >> ./include/net/page_pool/types.h:77: warning: Function parameter or struct member 'fast' not described in 'page_pool_params' >> ./include/net/page_pool/types.h:77: warning: Function parameter or struct member 'slow' not described in 'page_pool_params' > > In truth, the warnings look correct. I guess I'll leave this applied, > but perhaps a fix for the warnings should go into the net tree? Sure, we'll fix this. Thanks! > > Thanks, > > jon Olek
diff --git a/scripts/kernel-doc b/scripts/kernel-doc index 43a30f2de513..01ac8f794b30 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc @@ -1152,7 +1152,8 @@ sub dump_struct($$) { # - first eat non-declaration parameters and rewrite for final match # - then remove macro, outer parens, and trailing semicolon $members =~ s/\bstruct_group\s*\(([^,]*,)/STRUCT_GROUP(/gos; - $members =~ s/\bstruct_group_(attr|tagged)\s*\(([^,]*,){2}/STRUCT_GROUP(/gos; + $members =~ s/\bstruct_group_attr\s*\(([^,]*,){2}/STRUCT_GROUP(/gos; + $members =~ s/\bstruct_group_tagged\s*\(([^,]*),([^,]*),/struct $1 $2; STRUCT_GROUP(/gos; $members =~ s/\b__struct_group\s*\(([^,]*,){3}/STRUCT_GROUP(/gos; $members =~ s/\bSTRUCT_GROUP(\(((?:(?>[^)(]+)|(?1))*)\))[^;]*;/$2/gos;