Re: [PATCH 3/3] analyzer: add text-art visualizations of out-of-bounds accesses [PR106626]

[Martin Jambor <mjambor@suse.cz>]

Hi David,

On Wed, May 31 2023, David Malcolm via Gcc-patches wrote:
> This patch extends -Wanalyzer-out-of-bounds so that, where possible, it
> will emit a text art diagram visualizing the spatial relationship between

[...]


>
> gcc/ChangeLog:
> 	PR analyzer/106626
> 	* Makefile.in (ANALYZER_OBJS): Add analyzer/access-diagram.o.
> 	* doc/invoke.texi (Wanalyzer-out-of-bounds): Add description of
> 	text art.
> 	(fanalyzer-debug-text-art): New.
>
> gcc/analyzer/ChangeLog:
> 	PR analyzer/106626
> 	* access-diagram.cc: New file.
> 	* access-diagram.h: New file.
> 	* analyzer.h (class region_offset): Add default ctor.
> 	(region_offset::make_byte_offset): New decl.
> 	(region_offset::concrete_p): New.
> 	(region_offset::get_concrete_byte_offset): New.
> 	(region_offset::calc_symbolic_bit_offset): New decl.
> 	(region_offset::calc_symbolic_byte_offset): New decl.
> 	(region_offset::dump_to_pp): New decl.
> 	(region_offset::dump): New decl.
> 	(operator<, operator<=, operator>, operator>=): New decls for
> 	region_offset.
> 	* analyzer.opt
> 	(-param=analyzer-text-art-string-ellipsis-threshold=): New.
> 	(-param=analyzer-text-art-string-ellipsis-head-len=): New.
> 	(-param=analyzer-text-art-string-ellipsis-tail-len=): New.
> 	(-param=analyzer-text-art-ideal-canvas-width=): New.

contrib/check-params-in-docs.py now complains that:

  $ ./gcc/xgcc -Bgcc --help=param &>/tmp/params.txt
  $ ../src/contrib/check-params-in-docs.py ../src/gcc/doc/invoke.texi /tmp/params.txt 
  Missing:
  @item analyzer-text-art-string-ellipsis-threshold
  The number of bytes at which to ellipsize string literals in

  @item analyzer-text-art-string-ellipsis-head-len
  The number of literal bytes to show at the head of a string

  @item analyzer-text-art-string-ellipsis-tail-len
  The number of literal bytes to show at the tail of a string

  @item analyzer-text-art-ideal-canvas-width
  The ideal width in characters of text art diagrams generated by the

Can you please add the respective documentation entries?

Thanks!

Martin