[1/7] decodetree: Add !extern flag to argument sets

Allow argument sets to be shared between two decoders by avoiding
a re-declaration error.  Make sure that anonymous argument sets
have unique names.

Signed-off-by: Richard Henderson <richard.henderson@linaro.org>
---
 scripts/decodetree.py | 34 +++++++++++++++++++++++-----------
 1 file changed, 23 insertions(+), 11 deletions(-)

On 10/23/18 2:04 PM, Richard Henderson wrote:
> Allow argument sets to be shared between two decoders by avoiding
> a re-declaration error.  Make sure that anonymous argument sets
> have unique names.
>
> Signed-off-by: Richard Henderson <richard.henderson@linaro.org>
> ---
>   scripts/decodetree.py | 34 +++++++++++++++++++++++-----------
>   1 file changed, 23 insertions(+), 11 deletions(-)
>

Reviewed-by: Bastian Koppelmann <kbastian@mail.uni-paderborn.de>

Cheers,

Bastian

On 23/10/18 14:04, Richard Henderson wrote:
> Allow argument sets to be shared between two decoders by avoiding
> a re-declaration error.  Make sure that anonymous argument sets
> have unique names.
> 
> Signed-off-by: Richard Henderson <richard.henderson@linaro.org>
> ---
>   scripts/decodetree.py | 34 +++++++++++++++++++++++-----------
>   1 file changed, 23 insertions(+), 11 deletions(-)
> 
> diff --git a/scripts/decodetree.py b/scripts/decodetree.py
> index 277f9a9bba..a9b10452ef 100755
> --- a/scripts/decodetree.py
> +++ b/scripts/decodetree.py
> @@ -63,13 +63,16 @@
>   #
>   # *** Argument set syntax:
>   #
> -# args_def    := '&' identifier ( args_elt )+
> +# args_def    := '&' identifier ( args_elt )+ ( !extern )?
>   # args_elt    := identifier
>   #
>   # Each args_elt defines an argument within the argument set.
>   # Each argument set will be rendered as a C structure "arg_$name"
>   # with each of the fields being one of the member arguments.
>   #
> +# If !extern is specified, the backing structure is assumed to
> +# have been already declared, typically via a second decoder.
> +#
>   # Argument set examples:
>   #
>   #   &reg3       ra rb rc
> @@ -169,6 +172,7 @@ input_file = ''
>   output_file = None
>   output_fd = None
>   insntype = 'uint32_t'
> +decode_function = 'decode'
>   
>   re_ident = '[a-zA-Z][a-zA-Z0-9_]*'
>   
> @@ -394,8 +398,9 @@ class FunctionField:
>   
>   class Arguments:
>       """Class representing the extracted fields of a format"""
> -    def __init__(self, nm, flds):
> +    def __init__(self, nm, flds, extern):
>           self.name = nm
> +        self.extern = extern
>           self.fields = sorted(flds)
>   
>       def __str__(self):
> @@ -405,10 +410,11 @@ class Arguments:
>           return 'arg_' + self.name
>   
>       def output_def(self):
> -        output('typedef struct {\n')
> -        for n in self.fields:
> -            output('    int ', n, ';\n')
> -        output('} ', self.struct_name(), ';\n\n')
> +        if not self.extern:
> +            output('typedef struct {\n')
> +            for n in self.fields:
> +                output('    int ', n, ';\n')
> +            output('} ', self.struct_name(), ';\n\n')
>   # end Arguments
>   
>   
> @@ -542,7 +548,11 @@ def parse_arguments(lineno, name, toks):
>       global re_ident
>   
>       flds = []
> +    extern = False
>       for t in toks:
> +        if re_fullmatch('!extern', t):
> +            extern = True

It looks odd to match a negative form then use a positive one.

Why not simply use 'extern'?

Regardless,
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>

> +            continue
>           if not re_fullmatch(re_ident, t):
>               error(lineno, 'invalid argument set token "{0}"'.format(t))
>           if t in flds:
> @@ -551,7 +561,7 @@ def parse_arguments(lineno, name, toks):
>   
>       if name in arguments:
>           error(lineno, 'duplicate argument set', name)
> -    arguments[name] = Arguments(name, flds)
> +    arguments[name] = Arguments(name, flds, extern)
>   # end parse_arguments
>   
>   
> @@ -575,13 +585,14 @@ def add_field_byname(lineno, flds, new_name, old_name):
>   
>   def infer_argument_set(flds):
>       global arguments
> +    global decode_function
>   
>       for arg in arguments.values():
>           if eq_fields_for_args(flds, arg.fields):
>               return arg
>   
> -    name = str(len(arguments))
> -    arg = Arguments(name, flds.keys())
> +    name = decode_function + str(len(arguments))
> +    arg = Arguments(name, flds.keys(), False)
>       arguments[name] = arg
>       return arg
>   
> @@ -589,6 +600,7 @@ def infer_argument_set(flds):
>   def infer_format(arg, fieldmask, flds):
>       global arguments
>       global formats
> +    global decode_function
>   
>       const_flds = {}
>       var_flds = {}
> @@ -608,7 +620,7 @@ def infer_format(arg, fieldmask, flds):
>               continue
>           return (fmt, const_flds)
>   
> -    name = 'Fmt_' + str(len(formats))
> +    name = decode_function + '_Fmt_' + str(len(formats))
>       if not arg:
>           arg = infer_argument_set(flds)
>   
> @@ -973,8 +985,8 @@ def main():
>       global insnwidth
>       global insntype
>       global insnmask
> +    global decode_function
>   
> -    decode_function = 'decode'
>       decode_scope = 'static '
>   
>       long_opts = ['decode=', 'translate=', 'output=', 'insnwidth=']
>

On 10/23/18 2:27 PM, Philippe Mathieu-Daudé wrote:
>> +        if re_fullmatch('!extern', t):
>> +            extern = True
> 
> It looks odd to match a negative form then use a positive one.
> 
> Why not simply use 'extern'?

"!" is an escape character here.
Just "escape" would be a field named "escape".

It follows existing similar syntax for !function=foo


r~

On 23/10/18 15:54, Richard Henderson wrote:
> On 10/23/18 2:27 PM, Philippe Mathieu-Daudé wrote:
>>> +        if re_fullmatch('!extern', t):
>>> +            extern = True
>>
>> It looks odd to match a negative form then use a positive one.
>>
>> Why not simply use 'extern'?
> 
> "!" is an escape character here.
> Just "escape" would be a field named "escape".
> 
> It follows existing similar syntax for !function=foo

Oh OK!

Thanks,

Phil.