linux-kernel - Re: [RFC v3] scripts: kernel-doc: fix typedef support for struct/union parsing

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <CAKXUXMwD_ZZA7EJaxZBRfMDEvwd4Ghsj2vy9KCfj0R-yx2_K0Q@mail.gmail.com>
Date:   Sat, 6 Mar 2021 07:25:25 +0100
From:   Lukas Bulwahn <lukas.bulwahn@...il.com>
To:     Matthew Wilcox <willy@...radead.org>
Cc:     Aditya Srivastava <yashsri421@...il.com>,
        Jonathan Corbet <corbet@....net>,
        "open list:DOCUMENTATION" <linux-doc@...r.kernel.org>,
        Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
        linux-kernel-mentees@...ts.linuxfoundation.org
Subject: Re: [RFC v3] scripts: kernel-doc: fix typedef support for
 struct/union parsing

On Sat, Mar 6, 2021 at 5:35 AM Matthew Wilcox <willy@...radead.org> wrote:
>
> On Thu, Feb 25, 2021 at 08:20:33PM +0530, Aditya Srivastava wrote:
> > +++ b/scripts/kernel-doc
> > @@ -1201,12 +1201,23 @@ sub dump_union($$) {
> >  sub dump_struct($$) {
> >      my $x = shift;
> >      my $file = shift;
> > +    my $decl_type;
> > +    my $members;
> > +    my $type = qr{struct|union};
> > +    # For capturing struct/union definition body, i.e. "{members*}qualifiers*"
> > +    my $definition_body = qr{\{(.*)\}(?:\s*(?:__packed|__aligned|____cacheline_aligned_in_smp|____cacheline_aligned|__attribute__\s*\(\([a-z0-9,_\s\(\)]*\)\)))*};
> > -    if ($x =~ /(struct|union)\s+(\w+)\s*\{(.*)\}(\s*(__packed|__aligned|____cacheline_aligned_in_smp|____cacheline_aligned|__attribute__\s*\(\([a-z0-9,_\s\(\)]*\)\)))*/) {
> > -     my $decl_type = $1;
> > +    if ($x =~ /($type)\s+(\w+)\s*$definition_body/) {
> > +     $decl_type = $1;
> >       $declaration_name = $2;
> > -     my $members = $3;
> > +     $members = $3;
> > +    } elsif ($x =~ /typedef\s+($type)\s*$definition_body\s*(\w+)\s*;/) {
> > +     $decl_type = $1;
> > +     $declaration_name = $3;
> > +     $members = $2;
> > +    }
>
> In the same spirit as dump_function, would something like this work?
>

I agree. That might be a suitable clean-up to keep the code for
functions and struct/union parsing similar in style/spirit.

Aditya, would you like to create a patch for that?

Lukas