Re: [RFC PATCH 1/3] dtc: dts source location annotation

[David Gibson <david-xT8FGy+AXnRB3Ne2BGzF6laj5H9X9Tb+@public.gmane.org>]

[-- Attachment #1: Type: text/plain, Size: 3396 bytes --]

On Tue, Sep 15, 2015 at 09:22:18PM -0700, Frank Rowand wrote:
> 
> From: Frank Rowand <frank.rowand-/MT0OVThwyLZJqsBc5GL+g@public.gmane.org>
> 
> Proof of concept patch.
> 
> Annotates input source file and line number of nodes and properties
> as comments in output .dts file when --annotate flag is supplied.
> 
> Not-signed-off-by: Frank Rowand <frank.rowand-/MT0OVThwyLZJqsBc5GL+g@public.gmane.org>

A like the concept, but I have some queries about the implementation.

> ---
>  dtc-lexer.l  |    2 +
>  dtc.c        |    9 ++++++++
>  dtc.h        |   14 +++++++++++++
>  livetree.c   |   62 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>  srcpos.h     |    6 +++++
>  treesource.c |   27 ++++++++++++++++++++-----
>  6 files changed, 115 insertions(+), 5 deletions(-)
> 
> Index: b/dtc.h
> ===================================================================
> --- a/dtc.h
> +++ b/dtc.h
> @@ -54,6 +54,7 @@ extern int reservenum;		/* Number of mem
>  extern int minsize;		/* Minimum blob size */
>  extern int padsize;		/* Additional padding to blob */
>  extern int phandle_format;	/* Use linux,phandle or phandle properties */
> +extern bool annotate;		/* annotate .dts with input source location */
>  
>  #define PHANDLE_LEGACY	0x1
>  #define PHANDLE_EPAPR	0x2
> @@ -126,6 +127,16 @@ bool data_is_one_string(struct data d);
>  #define MAX_NODENAME_LEN	31
>  
>  /* Live trees */
> +struct src {
> +	char *name;
> +	int lineno;
> +};

I'd prefer to see the existing struct srcpos used, rather than
creating a new structure.

> +struct prop_src {
> +	struct prop_src *prev;
> +	struct src src;
> +};
> +
>  struct label {
>  	bool deleted;
>  	char *label;
> @@ -140,6 +151,7 @@ struct property {
>  	struct property *next;
>  
>  	struct label *labels;
> +	struct src src;
>  };
>  
>  struct node {
> @@ -158,6 +170,8 @@ struct node {
>  	int addr_cells, size_cells;
>  
>  	struct label *labels;
> +	struct src begin_src;
> +	struct src end_src;
>  };
>  
>  #define for_each_label_withdel(l0, l) \
> Index: b/livetree.c
> ===================================================================
> --- a/livetree.c
> +++ b/livetree.c
> @@ -19,6 +19,9 @@
>   */
>  
>  #include "dtc.h"
> +#include "srcpos.h"
> +
> +struct prop_src *prev_prop_src = NULL;

So you've built a new global stack here, and I don't really understand
what it's for.  The parser already tracks source positions for each
construct, so you should be able to just use that.  You'd need to pass
the srcpos from dtc-parser.y into the tree building calls in more
places, but that should be it.

Or have I missed something?

>  /*
>   * Tree building functions
> @@ -58,6 +61,13 @@ struct property *build_property(char *na
>  
>  	new->name = name;
>  	new->val = val;
> +	if (current_srcfile) {
> +		new->src.name = current_srcfile->name;
> +		new->src.lineno = current_srcfile->lineno;
> +	} else {
> +		new->src.name = "__builtin__";
> +		new->src.lineno = 0;

A comment explaining when this will happen in practice would be nice.

Incidentally.. what happens if you use dtb input and try to annotate?

-- 
David Gibson			| I'll have my music baroque, and my code
david AT gibson.dropbear.id.au	| minimalist, thank you.  NOT _the_ _other_
				| _way_ _around_!
http://www.ozlabs.org/~dgibson

[-- Attachment #2: Type: application/pgp-signature, Size: 819 bytes --]