docparse improvements
v3 cover docparse improvements
Implement support for various missing bits to the docparse tool and enables it unconditionally so that the metadata file is present on all builds.
This is first part of bigger effort to get the metadata useful for the testrunners, expecially we need the .test_variants field to be properly parsed in order to compute the overall test runtime correctly.
v3:
- A few fixes in the parser as reported by rpalethorpe
- Fixed out-of-tree build for the last patch that moves the parser to a metadata directory
v2:
- Cleaned up the patchset a bit
pvorel:
- Added Makefile to metadata tests
- Rename the expected output files to foo.c.json
rpalethorpe:
- Fixed parsing of the '# include' and '# define' directives now the hash character produces a separate token and any whitespaces between it and the keyword are removed by the parser
Cyril Hrubis (7):
docparse: Implement #define and #include
docparse: Add tests
docparse: data_storage: Add integer type node
docparse: Implement ARRAY_SIZE()
docparse: Add type normalization
docparse: Group data to 'testsuite' and 'defaults'
docparse: Split into metadata and docparse
Makefile | 5 +-
docparse/.gitignore | 2 -
docparse/Makefile | 12 +-
docparse/docparse.c | 434 -------------
docparse/testinfo.pl | 16 +-
metadata/.gitignore | 2 +
metadata/Makefile | 27 +
{docparse => metadata}/data_storage.h | 45 ++
metadata/metaparse.c | 900 ++++++++++++++++++++++++++
{docparse => metadata}/parse.sh | 18 +-
metadata/tests/Makefile | 4 +
metadata/tests/array_size01.c | 5 +
metadata/tests/array_size01.c.json | 4 +
metadata/tests/array_size02.c | 9 +
metadata/tests/array_size02.c.json | 4 +
metadata/tests/array_size03.c | 10 +
metadata/tests/array_size03.c.json | 4 +
metadata/tests/array_size04.c | 5 +
metadata/tests/array_size04.c.json | 4 +
metadata/tests/empty_struct.c | 2 +
metadata/tests/empty_struct.c.json | 3 +
metadata/tests/expand_flags.c | 3 +
metadata/tests/expand_flags.c.json | 6 +
metadata/tests/include.c | 5 +
metadata/tests/include.c.json | 4 +
metadata/tests/include.h | 7 +
metadata/tests/macro.c | 5 +
metadata/tests/macro.c.json | 4 +
metadata/tests/macro_str.c | 5 +
metadata/tests/macro_str.c.json | 4 +
metadata/tests/multiline_macro.c | 6 +
metadata/tests/multiline_macro.c.json | 4 +
metadata/tests/tags.c | 7 +
metadata/tests/tags.c.json | 13 +
metadata/tests/test.sh | 18 +
35 files changed, 1141 insertions(+), 465 deletions(-)
delete mode 100644 docparse/docparse.c
create mode 100644 metadata/.gitignore
create mode 100644 metadata/Makefile
rename {docparse => metadata}/data_storage.h (89%)
create mode 100644 metadata/metaparse.c
rename {docparse => metadata}/parse.sh (58%)
create mode 100644 metadata/tests/Makefile
create mode 100644 metadata/tests/array_size01.c
create mode 100644 metadata/tests/array_size01.c.json
create mode 100644 metadata/tests/array_size02.c
create mode 100644 metadata/tests/array_size02.c.json
create mode 100644 metadata/tests/array_size03.c
create mode 100644 metadata/tests/array_size03.c.json
create mode 100644 metadata/tests/array_size04.c
create mode 100644 metadata/tests/array_size04.c.json
create mode 100644 metadata/tests/empty_struct.c
create mode 100644 metadata/tests/empty_struct.c.json
create mode 100644 metadata/tests/expand_flags.c
create mode 100644 metadata/tests/expand_flags.c.json
create mode 100644 metadata/tests/include.c
create mode 100644 metadata/tests/include.c.json
create mode 100644 metadata/tests/include.h
create mode 100644 metadata/tests/macro.c
create mode 100644 metadata/tests/macro.c.json
create mode 100644 metadata/tests/macro_str.c
create mode 100644 metadata/tests/macro_str.c.json
create mode 100644 metadata/tests/multiline_macro.c
create mode 100644 metadata/tests/multiline_macro.c.json
create mode 100644 metadata/tests/tags.c
create mode 100644 metadata/tests/tags.c.json
create mode 100755 metadata/tests/test.shSignature · 5 lines
2.32.0 -- Mailing list info: https://lists.linux.it/listinfo/ltp
PATCH v3 1/7 docparse: Implement #define and #include
We ignore most of the include statements and we attempt to parse only header files that reside in the same directory as the test source code, that is since we are not interested in any system or library headers as we are only looking for constants used in the tst_test structure that are always either directly in the test source or in header in the same directory.
The macro support is very simple as well, it's a single pass as we are not interested in intricate macros. We just need values for constants that are used in the tst_test structure intializations.
+ Also add -v verbose mode that prints included files and defined macros
--- docparse/docparse.c | 242 ++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 232 insertions(+), 10 deletions(-)
docparse/docparse.c +232 -10
@@ -1,9 +1,12 @@// SPDX-License-Identifier: GPL-2.0-or-later /* -* Copyright (c) 2019 Cyril Hrubis <[email protected]> +* Copyright (c) 2019-2021 Cyril Hrubis <[email protected]> * Copyright (c) 2020 Petr Vorel <[email protected]> */ +#define _GNU_SOURCE + +#include <search.h> #include <stdio.h> #include <string.h> #include <libgen.h>
@@ -12,6 +15,9 @@#include "data_storage.h" +static int verbose; +static char *includepath; +#define WARN (str) fprintf(stderr, "WARNING: " str "\n")static void oneline_comment (FILE *f)
@@ -126,7 +132,7 @@ static void maybe_comment(FILE *f, struct data_node *doc) } } -const char *next_token (FILE *f,struct data_node *doc) +static char *next_token (FILE *f,struct data_node *doc) {size_t i =0 ;static char buf[4096 ];
@@ -159,6 +165,7 @@ const char *next_token(FILE *f, struct data_node *doc)case ',' :case '[' :case ']' : +case '#' :if (i) {ungetc (c, f); goto exit;
@@ -197,6 +204,46 @@ exit:return buf; } +static FILE *open_include (const char *includepath,FILE *f) +{ +char buf[256 ]; +char *path; +FILE *inc; + +if (!fscanf (f,"%s\n" , buf)) +return NULL ; + +if (buf[0 ] !='"' ) +return NULL ; + +char *filename = buf +1 ; + +if (!buf[0 ]) +return NULL ; + + filename[strlen (filename)-1 ] =0 ; + +if (asprintf (&path,"%s/%s" , includepath, filename) <0 ) +return NULL ; + + inc =fopen (path,"r" ); + +if (inc && verbose) +fprintf (stderr,"INCLUDE %s\n" , path); + +free (path); + +return inc; +} + +static void close_include (FILE *inc) +{ +if (verbose) +fprintf (stderr,"INCLUDE END\n" ); + +fclose (inc); +} +static int parse_array (FILE *f,struct data_node *node) {const char *token;
@@ -234,9 +281,28 @@ static int parse_array(FILE *f, struct data_node *node)return 0 ; } +static void try_apply_macro (char **res) +{ +ENTRY macro = { + .key = *res, + }; + +ENTRY *ret; + + ret =hsearch (macro,FIND ); + +if (!ret) +return ; + +if (verbose) +fprintf (stderr,"APPLYING MACRO %s=%s\n" , ret->key, (char *)ret->data); + + *res = ret->data; +} +static int parse_test_struct (FILE *f,struct data_node *doc,struct data_node *node) { -const char *token; +char *token;char *id =NULL ;int state =0 ;struct data_node *ret;
@@ -280,6 +346,7 @@ static int parse_test_struct(FILE *f, struct data_node *doc, struct data_node *n ret =data_node_array ();parse_array (f, ret); }else { +try_apply_macro (&token); ret =data_node_string (token); }
@@ -302,6 +369,122 @@ static const char *tokens[] = { "{", }; +static void macro_get_string (FILE *f,char *buf,char *buf_end) +{ +int c; +char *buf_start = buf; + +for (;;) { + c =fgetc (f); + +switch (c) { +case EOF : + *buf =0 ; +return ; +case '"' : +if (buf == buf_start || buf[-1 ] !='\\' ) { + *buf =0 ; +return ; + } + buf[-1 ] ='"' ; +break ; +default : +if (buf < buf_end) + *(buf++) = c; + } + } +} + +static void macro_get_val (FILE *f,char *buf,size_t buf_len) +{ +int c, prev =0 ; +char *buf_end = buf + buf_len -1 ; + +while (isspace (c =fgetc (f))); + +if (c =='"' ) { +macro_get_string (f, buf, buf_end); +return ; + } + +for (;;) { +switch (c) { +case '\n' : +if (prev =='\\' ) { + buf--; + }else { + *buf =0 ; +return ; + } +break ; +case EOF : + *buf =0 ; +return ; +case ' ' : +case '\t' : +break ; +default : +if (buf < buf_end) + *(buf++) = c; + } + + prev = c; + c =fgetc (f); + } +} + +static void parse_macro (FILE *f) +{ +char name[128 ]; +char val[256 ]; + +if (!fscanf (f,"%s[^\n]" , name)) +return ; + +if (fgetc (f) =='\n' ) +return ; + +macro_get_val (f, val,sizeof (val)); + +ENTRY e = { + .key =strdup (name), + .data =strdup (val), + }; + +if (verbose) +fprintf (stderr," MACRO %s=%s\n" , e.key, (char *)e.data); + +hsearch (e,ENTER ); +} + +static void parse_include_macros (FILE *f) +{ +FILE *inc; +const char *token; +int hash =0 ; + + inc =open_include (includepath, f); +if (!inc) +return ; + +while ((token =next_token (inc,NULL ))) { +if (token[0 ] =='#' ) { + hash =1 ; +continue ; + } + +if (!hash) +continue ; + +if (!strcmp (token,"define" )) +parse_macro (inc); + + hash =0 ; + } + +close_include (inc); +} +static struct data_node *parse_file (const char *fname) {int state =0 , found =0 ;
@@ -314,14 +497,28 @@ static struct data_node *parse_file(const char *fname)FILE *f =fopen (fname,"r" ); + includepath =dirname (strdup (fname)); +struct data_node *res =data_node_hash ();struct data_node *doc =data_node_array ();while ((token =next_token (f, doc))) { -if (state <6 && !strcmp (tokens[state], token)) +if (state <6 && !strcmp (tokens[state], token)) { state++; -else + }else { +if (token[0 ] =='#' ) { + token =next_token (f, doc); +if (token) { +if (!strcmp (token,"define" )) +parse_macro (f); + +if (!strcmp (token,"include" )) +parse_include_macros (f); + } + } + state =0 ; + }if (state <6 )continue ;
@@ -386,17 +583,42 @@ const char *strip_name(char *path)return name; } +static void print_help (const char *prgname) +{ +printf ("usage: %s [-vh] input.c\n\n" , prgname); +printf ("-v sets verbose mode\n" ); +printf ("-h prints this help\n\n" ); +exit (0 ); +} +int main (int argc,char *argv[]) {unsigned int i, j;struct data_node *res; +int opt; + +while ((opt =getopt (argc, argv,"hv" )) !=-1 ) { +switch (opt) { +case 'h' : +print_help (argv[0 ]); +break ; +case 'v' : + verbose =1 ; +break ; + } + } + +if (optind >= argc) { +fprintf (stderr,"No input filename.c\n" ); +return 1 ; + } -if (argc !=2 ) { -fprintf (stderr,"Usage: docparse filename.c\n" ); +if (!hcreate (128 )) { +fprintf (stderr,"Failed to initialize hash table\n" );return 1 ; } - res =parse_file (argv[1 ]); + res =parse_file (argv[optind]);if (!res)return 0 ;
@@ -425,8 +647,8 @@ int main(int argc, char *argv[]) } } -data_node_hash_add (res,"fname" ,data_node_string (argv[1 ])); -printf (" \"%s\": " ,strip_name (argv[1 ])); +data_node_hash_add (res,"fname" ,data_node_string (argv[optind])); +printf (" \"%s\": " ,strip_name (argv[optind]));data_to_json (res, stdout,2 );data_node_free (res);
Signature · 5 lines
2.32.0 -- Mailing list info: https://lists.linux.it/listinfo/ltp
Re: [LTP] [PATCH v3 1/7] docparse: Implement #define and #include
Hi Cyril,
Kind regards,
Petr
Signature · 1 line
Mailing list info: https://lists.linux.it/listinfo/ltp
PATCH v3 2/7 docparse: Add tests
In reply to Cyril HrubisThis add a simple tests for the docparse parser.
--- docparse/tests/Makefile | 4 ++++ docparse/tests/empty_struct.c | 2 ++ docparse/tests/empty_struct.c.json | 3 +++ docparse/tests/expand_flags.c | 3 +++ docparse/tests/expand_flags.c.json | 6 ++++++ docparse/tests/include.c | 5 +++++ docparse/tests/include.c.json | 4 ++++ docparse/tests/include.h | 1 + docparse/tests/macro.c | 5 +++++ docparse/tests/macro.c.json | 4 ++++ docparse/tests/macro_str.c | 5 +++++ docparse/tests/macro_str.c.json | 4 ++++ docparse/tests/multiline_macro.c | 6 ++++++ docparse/tests/multiline_macro.c.json | 4 ++++ docparse/tests/tags.c | 7 +++++++ docparse/tests/tags.c.json | 13 +++++++++++++ docparse/tests/test.sh | 18 ++++++++++++++++++ 17 files changed, 94 insertions(+) create mode 100644 docparse/tests/Makefile create mode 100644 docparse/tests/empty_struct.c create mode 100644 docparse/tests/empty_struct.c.json create mode 100644 docparse/tests/expand_flags.c create mode 100644 docparse/tests/expand_flags.c.json create mode 100644 docparse/tests/include.c create mode 100644 docparse/tests/include.c.json create mode 100644 docparse/tests/include.h create mode 100644 docparse/tests/macro.c create mode 100644 docparse/tests/macro.c.json create mode 100644 docparse/tests/macro_str.c create mode 100644 docparse/tests/macro_str.c.json create mode 100644 docparse/tests/multiline_macro.c create mode 100644 docparse/tests/multiline_macro.c.json create mode 100644 docparse/tests/tags.c create mode 100644 docparse/tests/tags.c.json create mode 100755 docparse/tests/test.sh
docparse/tests/Makefile new file +4 -0
@@ -0,0 +1,4 @@ +all: + +test: + @./test.sh
docparse/tests/empty_struct.c new file +2 -0
@@ -0,0 +1,2 @@ +static struct tst_test test = { +};
docparse/tests/empty_struct.c.json new file +3 -0
@@ -0,0 +1,3 @@ + "empty_struct": { + "fname": "empty_struct.c" + }
docparse/tests/expand_flags.c new file +3 -0
@@ -0,0 +1,3 @@ +static struct tst_test test = { + .all_filesystems =1 , +};
docparse/tests/expand_flags.c.json new file +6 -0
@@ -0,0 +1,6 @@ + "expand_flags": { + "all_filesystems": "1", + "needs_device": "1", + "needs_tmpdir": "1", + "fname": "expand_flags.c" + }
docparse/tests/include.c new file +5 -0
@@ -0,0 +1,5 @@ +# include "include.h" + +static struct tst_test test = { + .test_variants =TEST_VARIANTS , +};
docparse/tests/include.c.json new file +4 -0
@@ -0,0 +1,4 @@ + "include": { + "test_variants": "10", + "fname": "include.c" + }
docparse/tests/include.h new file +1 -0
@@ -0,0 +1 @@ +#define TEST_VARIANTS 10
docparse/tests/macro.c new file +5 -0
@@ -0,0 +1,5 @@ +#define TEST_VARIANTS 10 + +static struct tst_test test = { + .test_variants =TEST_VARIANTS , +};
docparse/tests/macro.c.json new file +4 -0
@@ -0,0 +1,4 @@ + "macro": { + "test_variants": "10", + "fname": "macro.c" + }
docparse/tests/macro_str.c new file +5 -0
@@ -0,0 +1,5 @@ +#define SYSCALL "syscall(\"foo\")" + +static struct tst_test test = { + .syscall =SYSCALL , +};
docparse/tests/macro_str.c.json new file +4 -0
@@ -0,0 +1,4 @@ + "macro_str": { + "syscall": "syscall(\"foo\")", + "fname": "macro_str.c" + }
docparse/tests/multiline_macro.c new file +6 -0
@@ -0,0 +1,6 @@ +#define TEST_VARIANTS \ + 10 + +static struct tst_test test = { + .test_variants =TEST_VARIANTS , +};
docparse/tests/multiline_macro.c.json new file +4 -0
@@ -0,0 +1,4 @@ + "multiline_macro": { + "test_variants": "10", + "fname": "multiline_macro.c" + }
docparse/tests/tags.c new file +7 -0
@@ -0,0 +1,7 @@ +static struct tst_test test = { + .tags = (const struct tst_tag []) { + {"tag-name-1" ,"tag-value-1" }, + {"tag-name-2" ,"tag-value-2" }, + {} + } +};
docparse/tests/tags.c.json new file +13 -0
@@ -0,0 +1,13 @@ + "tags": { + "tags": [ + [ + "tag-name-1", + "tag-value-1" + ], + [ + "tag-name-2", + "tag-value-2" + ] + ], + "fname": "tags.c" + }
docparse/tests/test.sh new file +18 -0
@@ -0,0 +1,18 @@ +#!/bin/sh + +fail=0 + +for i in *.c; do + ../docparse $i > tmp.json + if ! diff tmp.json $i.json &> /dev/null; then + echo "***" + echo "$i output differs!" + diff -u tmp.json $i.json + echo "***" + fail=1 + fi +done + +rm -f tmp.json + +exit $fail
Signature · 5 lines
2.32.0 -- Mailing list info: https://lists.linux.it/listinfo/ltp
Re: [LTP] [PATCH v3 2/7] docparse: Add tests
Hi Cyril,
docparse/tests/Makefile line 4
Quoted 10 lines
docparse/tests/Makefile new file +4
-0@@ -0,0 +1,4 @@ +all: + +test: + @./test.sh
How about
1) Run test as default (all: test)?
2) Propagate test target into docparse/Makefile
3) Run docparse testing as part of make test
4) Be more verbose about running docparse tests
These are in patch below.
Also part of lib/newlib_tests/runtest.sh could be put into separate file, which could be reused in docparse/tests/test.sh (color etc), but that should be postponed to later to not blocking this patchset.
Kind regards,
Petr
Makefile +4 -0
@@ -210,6 +210,7 @@ ifneq ($(build),$(host)) $(error running tests on cross-compile build not supported) endif $(call _test) + $(MAKE) test-docparse test-c: lib-all ifneq ($(build),$(host))
@@ -223,6 +224,9 @@ ifneq ($(build),$(host)) endif $(call _test,-s) +test-docparse: + $(MAKE) -C docparse/tests test + ## Help .PHONY: help help:
Makefile +5 -0
@@ -74,4 +74,9 @@ metadata.pdf: txt $(METADATA_GENERATOR_CMD) $(METADATA_GENERATOR_PARAMS) $(METADATA_GENERATOR_PARAMS_PDF) endif +.PHONY: test + +test: metadata.json + $(MAKE) -C tests $@ + include $(top_srcdir)/include/mk/generic_leaf_target.mk
tests/Makefile +2 -1
@@ -1,4 +1,5 @@ -all: +all: test test: + $(info Testing docparse) @./test.sh
Signature · 1 line
Mailing list info: https://lists.linux.it/listinfo/ltp
Re: [LTP] [PATCH v3 2/7] docparse: Add tests
Hi!
Quoted 28 lines
How about
1) Run test as default (all: test)?
2) Propagate test target into docparse/Makefile
3) Run docparse testing as part of make test
4) Be more verbose about running docparse testsThese are in patch below.
Also part of
lib/newlib_tests/runtest.shcould be put into separate file, which could be reused indocparse/tests/test.sh(color etc), but that should be postponed to later to not blocking this patchset.Kind regards,
PetrMakefile +1
-0@@ -210,6 +210,7 @@ ifneq ($(build),$(host)) $(error running tests on cross-compile build not supported) endif $(call _test) + $(MAKE) test-docparse test-c: lib-all ifneq ($(build),$(host))
Makefile ifneq ($(build),$(host)) · line 228
Quoted 5 lines
Makefile +2
-0@@ -223,6 +224,9 @@ ifneq ($(build),$(host)) endif $(call _test,-s) +test-docparse: + $(MAKE) -C docparse/tests test
That's have been moved to metadata/tests/ in the last patch of the series.
Other than that the rest looks good. Feel free to push this on the top of my patchset with my Reviewed-by:
Signature · 5 lines
Cyril Hrubis [email protected] -- Mailing list info: https://lists.linux.it/listinfo/ltp
PATCH v3 3/7 docparse: data_storage: Add integer type node
In reply to Cyril Hrubis--- docparse/data_storage.h | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+)
docparse/data_storage.h +29 -0
@@ -15,6 +15,7 @@ enum data_type {DATA_ARRAY ,DATA_HASH ,DATA_STRING , + DATA_INT, }; struct data_node_array {
@@ -41,12 +42,18 @@ struct data_node_string {char val[]; }; +struct data_node_int { +enum data_type type; +long val; +}; +struct data_node {union {enum data_type type;struct data_node_hash hash;struct data_node_array array;struct data_node_string string; +struct data_node_int i; }; };
@@ -64,6 +71,19 @@ static inline struct data_node *data_node_string(const char *string)return node; } +static inline struct data_node *data_node_int (long i) +{ +struct data_node *node =malloc (sizeof (struct data_node_int )); + +if (!node) +return NULL ; + + node->type =DATA_INT ; + node->i.val = i; + +return node; +} +#define MAX_ELEMS 100static inline struct data_node *data_node_hash (void )
@@ -122,6 +142,7 @@ static inline void data_node_free(struct data_node *self)switch (self->type) {case DATA_STRING : +case DATA_INT :break ;case DATA_HASH :for (i =0 ; i < self->hash.elems_used; i++) {
@@ -209,6 +230,10 @@ static inline void data_node_print_(struct data_node *self, unsigned int padd)unsigned int i;switch (self->type) { +case DATA_INT : +data_print_padd (padd); +printf ("%li\n" , self->i.val); +break ;case DATA_STRING :data_print_padd (padd);printf ("'%s'\n" , self->string.val);
@@ -295,6 +320,10 @@ static inline void data_to_json_(struct data_node *self, FILE *f, unsigned int punsigned int i;switch (self->type) { +case DATA_INT : + padd = do_padd ? padd :0 ; +data_fprintf (f, padd,"%li" , self->i.val); +break ;case DATA_STRING : padd = do_padd ? padd :0 ;data_fprintf_esc (f, padd, self->string.val);
Signature · 5 lines
2.32.0 -- Mailing list info: https://lists.linux.it/listinfo/ltp
Re: [LTP] [PATCH v3 3/7] docparse: data_storage: Add integer type node
Kind regards,
Petr
Signature · 1 line
Mailing list info: https://lists.linux.it/listinfo/ltp
PATCH v3 4/7 docparse: Implement ARRAY_SIZE()
In reply to Cyril HrubisAdds a special handlingn for ARRAY_SIZE() macro.
If we stumble upon ARRAY_SIZE() in the tst_test structure we try to lookup the array and count its members.
Proper parsing of .test_variants also requires that we add -I switch to the docparse to be able to specify include paths on a command line since some variants are stuck in top level include while others are in testcases/kernel/syscalls/utils/.
+ tests
--- docparse/docparse.c | 221 ++++++++++++++++++++++++++--- docparse/parse.sh | 2 +- docparse/tests/array_size01.c | 5 + docparse/tests/array_size01.c.json | 4 + docparse/tests/array_size02.c | 9 ++ docparse/tests/array_size02.c.json | 4 + docparse/tests/array_size03.c | 10 ++ docparse/tests/array_size03.c.json | 4 + docparse/tests/array_size04.c | 5 + docparse/tests/array_size04.c.json | 4 + docparse/tests/include.h | 6 + 11 files changed, 255 insertions(+), 19 deletions(-) create mode 100644 docparse/tests/array_size01.c create mode 100644 docparse/tests/array_size01.c.json create mode 100644 docparse/tests/array_size02.c create mode 100644 docparse/tests/array_size02.c.json create mode 100644 docparse/tests/array_size03.c create mode 100644 docparse/tests/array_size03.c.json create mode 100644 docparse/tests/array_size04.c create mode 100644 docparse/tests/array_size04.c.json
docparse/docparse.c +203 -18
@@ -15,7 +15,11 @@#include "data_storage.h" +#define INCLUDE_PATH_MAX 5 +static int verbose; +static char *cmdline_includepath[INCLUDE_PATH_MAX ]; +static unsigned int cmdline_includepaths;static char *includepath;#define WARN (str) fprintf(stderr, "WARNING: " str "\n")
@@ -132,13 +136,14 @@ static void maybe_comment(FILE *f, struct data_node *doc) } } -static char *next_token (FILE *f,struct data_node *doc) +static char *next_token2 (FILE *f,char *buf,size_t buf_len,struct data_node *doc) {size_t i =0 ; -static char buf[4096 ];int c;int in_str =0 ; + buf_len--; +for (;;) { c =fgetc (f);
@@ -151,7 +156,8 @@ static char *next_token(FILE *f, struct data_node *doc) goto exit; } - buf[i++] = c; +if (i < buf_len) + buf[i++] = c;continue ; }
@@ -171,7 +177,8 @@ static char *next_token(FILE *f, struct data_node *doc) goto exit; } - buf[i++] = c; +if (i < buf_len) + buf[i++] = c; goto exit; case '0' ... '9': case 'a' ... 'z':
@@ -204,11 +211,33 @@ exit:return buf; } -static FILE *open_include (const char *includepath,FILE *f) +static char *next_token (FILE *f,struct data_node *doc) +{ +static char buf[4096 ]; + +return next_token2 (f, buf,sizeof (buf), doc); +} + +static FILE *open_file (const char *dir,const char *fname) { -char buf[256 ]; +FILE *f;char *path; + +if (asprintf (&path,"%s/%s" , dir, fname) <0 ) +return NULL ; + + f =fopen (path,"r" ); + +free (path); + +return f; +} + +static FILE *open_include (FILE *f) +{ +char buf[256 ], *fname;FILE *inc; +unsigned int i;if (!fscanf (f,"%s\n" , buf))return NULL ;
@@ -216,24 +245,36 @@ static FILE *open_include(const char *includepath, FILE *f)if (buf[0 ] !='"' )return NULL ; -char *filename = buf +1 ; + fname = buf +1 ;if (!buf[0 ])return NULL ; - filename[strlen (filename)-1 ] =0 ; + fname[strlen (fname)-1 ] =0 ; -if (asprintf (&path,"%s/%s" , includepath, filename) <0 ) -return NULL ; + inc =open_file (includepath, fname); +if (inc) { +if (verbose) +fprintf (stderr,"INCLUDE %s/%s\n" , includepath, fname); - inc =fopen (path,"r" ); +return inc; + } -if (inc && verbose) -fprintf (stderr,"INCLUDE %s\n" , path); +for (i =0 ; i < cmdline_includepaths; i++) { + inc =open_file (cmdline_includepath[i], fname); -free (path); +if (!inc) +continue ; -return inc; +if (verbose) { +fprintf (stderr,"INCLUDE %s/%s\n" , + cmdline_includepath[i], fname); + } + +return inc; + } + +return NULL ; }static void close_include (FILE *inc)
@@ -300,6 +341,136 @@ static void try_apply_macro(char **res) *res = ret->data; } +static int parse_get_array_len (FILE *f) +{ +const char *token; +int cnt =0 , depth =0 , prev_comma =0 ; + +if (!(token =next_token (f,NULL ))) +return 0 ; + +if (strcmp (token,"{" )) +return 0 ; + +for (;;) { +if (!(token =next_token (f,NULL ))) +return 0 ; + +if (!strcmp (token,"{" )) + depth++; + +if (!strcmp (token,"}" )) + depth--; +else + prev_comma =0 ; + +if (!strcmp (token,"," ) && !depth) { + prev_comma =1 ; + cnt++; + } + +if (depth <0 ) +return cnt + !prev_comma; + } +} + +static void look_for_array_size (FILE *f,const char *arr_id,struct data_node **res) +{ +const char *token; +char buf[2 ][2048 ] = {}; +int cur_buf =0 ; +int prev_buf =1 ; + +for (;;) { +if (!(token =next_token2 (f, buf[cur_buf],2048 ,NULL ))) +break ; + +if (!strcmp (token,"=" ) && !strcmp (buf[prev_buf], arr_id)) { +int arr_len =parse_get_array_len (f); + +if (verbose) +fprintf (stderr,"ARRAY %s LENGTH = %i\n" , arr_id, arr_len); + + *res =data_node_int (arr_len); + +break ; + } + +if (strcmp (buf[cur_buf],"]" ) &&strcmp (buf[cur_buf],"[" )) { + cur_buf = !cur_buf; + prev_buf = !prev_buf; + } + } +} + +static int parse_array_size (FILE *f,struct data_node **res) +{ +const char *token; +char *arr_id; +long pos; +int hash =0 ; + + *res =NULL ; + +if (!(token =next_token (f,NULL ))) +return 1 ; + +if (strcmp (token,"(" )) +return 1 ; + +if (!(token =next_token (f,NULL ))) +return 1 ; + + arr_id =strdup (token); + +if (verbose) +fprintf (stderr,"COMPUTING ARRAY '%s' LENGHT\n" , arr_id); + + pos =ftell (f); + +rewind (f); + +look_for_array_size (f, arr_id, res); + +if (!*res) { +FILE *inc; + +rewind (f); + +for (;;) { +if (!(token =next_token (f,NULL ))) +break ; + +if (token[0 ] =='#' ) { + hash =1 ; +continue ; + } + +if (!hash) +continue ; + +if (!strcmp (token,"include" )) { + inc =open_include (f); + +if (inc) { +look_for_array_size (inc, arr_id, res); +close_include (inc); + } + } + +if (*res) +break ; + } + } + +free (arr_id); + +if (fseek (f, pos,SEEK_SET )) +return 1 ; + +return 0 ; +} +static int parse_test_struct (FILE *f,struct data_node *doc,struct data_node *node) {char *token;
@@ -345,11 +516,17 @@ static int parse_test_struct(FILE *f, struct data_node *doc, struct data_node *nif (!strcmp (token,"{" )) { ret =data_node_array ();parse_array (f, ret); + }else if (!strcmp (token,"ARRAY_SIZE" )) { +if (parse_array_size (f, &ret)) +return 1 ; }else {try_apply_macro (&token); ret =data_node_string (token); } +if (!ret) +continue ; +const char *key = id;if (key[0 ] =='.' ) key++;
@@ -463,7 +640,7 @@ static void parse_include_macros(FILE *f)const char *token;int hash =0 ; - inc =open_include (includepath, f); + inc =open_include (f);if (!inc)return ;
@@ -527,7 +704,6 @@ static struct data_node *parse_file(const char *fname)parse_test_struct (f, doc, res); } -if (data_node_array_len (doc)) {data_node_hash_add (res,"doc" , doc); found =1 ;
@@ -587,6 +763,7 @@ static void print_help(const char *prgname) {printf ("usage: %s [-vh] input.c\n\n" , prgname);printf ("-v sets verbose mode\n" ); +printf ("-I add include path\n" );printf ("-h prints this help\n\n" );exit (0 ); }
@@ -597,11 +774,19 @@ int main(int argc, char *argv[])struct data_node *res;int opt; -while ((opt =getopt (argc, argv,"hv" )) !=-1 ) { +while ((opt =getopt (argc, argv,"hI:v" )) !=-1 ) {switch (opt) {case 'h' :print_help (argv[0 ]);break ; +case 'I' : +if (cmdline_includepaths >=INCLUDE_PATH_MAX ) { +fprintf (stderr,"Too much include paths!" ); +exit (1 ); + } + + cmdline_includepath[cmdline_includepaths++] = optarg; +break ;case 'v' : verbose =1 ;break ;
docparse/parse.sh +1 -1
@@ -26,7 +26,7 @@ echo ' "tests": {' first=1 for test in `find testcases/ -name '*.c'`; do - a=$($top_builddir/docparse/docparse "$test") + a=$($top_builddir/docparse/docparse -Iinclude -Itestcases/kernel/syscalls/utils/ "$test") if [ -n "$a" ]; then if [ -z "$first" ]; then echo ','
docparse/tests/array_size01.c new file +5 -0
@@ -0,0 +1,5 @@ +static int variants[] = {1 }; + +static struct tst_test test = { + .test_variants =ARRAY_SIZE (variants), +};
docparse/tests/array_size01.c.json new file +4 -0
@@ -0,0 +1,4 @@ + "array_size01": { + "test_variants": 1, + "fname": "array_size01.c" + }
docparse/tests/array_size02.c new file +9 -0
@@ -0,0 +1,9 @@ +struct foo { +int val; +}; + +static struct foo variants[] = {{1 }, {2 }, {3 }}; + +static struct tst_test test = { + .test_variants =ARRAY_SIZE (variants), +};
docparse/tests/array_size02.c.json new file +4 -0
@@ -0,0 +1,4 @@ + "array_size02": { + "test_variants": 3, + "fname": "array_size02.c" + }
docparse/tests/array_size03.c new file +10 -0
@@ -0,0 +1,10 @@ +static struct foo variants[] = { +#ifdef FOO + {.bar = 11}, +#endif + {.bar = 10}, +}; + +static struct tst_test test = { + .test_variants = ARRAY_SIZE(variants), +};
docparse/tests/array_size03.c.json new file +4 -0
@@ -0,0 +1,4 @@ + "array_size03": { + "test_variants": 2, + "fname": "array_size03.c" + }
docparse/tests/array_size04.c new file +5 -0
@@ -0,0 +1,5 @@ +#include "include.h" + +static struct tst_test test = { + .test_variants =ARRAY_SIZE (variants), +};
docparse/tests/array_size04.c.json new file +4 -0
@@ -0,0 +1,4 @@ + "array_size04": { + "test_variants": 3, + "fname": "array_size04.c" + }
docparse/tests/include.h +6 -0
@@ -1 +1,7 @@#define TEST_VARIANTS 10 + +static struct variants[] = { + {.bar =10 }, + {.bar =11 }, + {.bar =12 } +};
Signature · 5 lines
2.32.0 -- Mailing list info: https://lists.linux.it/listinfo/ltp
Re: [LTP] [PATCH v3 4/7] docparse: Implement ARRAY_SIZE()
Hi Cyril,
Quoted 1 line
Adds a special handlingn for
ARRAY_SIZE()macro.
typo: s/handlingn/handling/
While code LGTM
Not related to this change (it's also in code in current master): return value of parse_test_struct() is not used.
...
docparse/docparse.c static void try_apply_macro(char **res) · line 385
Quoted 9 lines
docparse/docparse.c +9
-0+static void look_for_array_size (FILE *f,const char *arr_id,struct data_node **res) +{ +const char *token; +char buf[2 ][2048 ] = {}; +int cur_buf =0 ; +int prev_buf =1 ; + +for (;;) { +if (!(token =next_token2 (f, buf[cur_buf],2048 ,NULL )))
nit: there could be sizeof(buf[cur_buf]) instead of hardwiring 2048.
LGTM.
Kind regards,
Petr
Signature · 1 line
Mailing list info: https://lists.linux.it/listinfo/ltp
PATCH v3 5/7 docparse: Add type normalization
In reply to Cyril HrubisFor now just for .test_variants.
There are two reasons for this:
- This code makes sure that we get right value parsed and aborts the compilation if the parser got confused. This part is important since if the testrunners are going to use the metadata the data in there must be correct.
- And much less important it makes the resulting json nicer to read
--- docparse/data_storage.h | 16 ++++++++ docparse/docparse.c | 59 +++++++++++++++++++++++++++ docparse/tests/include.c.json | 2 +- docparse/tests/macro.c.json | 2 +- docparse/tests/multiline_macro.c.json | 2 +- 5 files changed, 78 insertions(+), 3 deletions(-)
docparse/data_storage.h +16 -0
@@ -57,6 +57,22 @@ struct data_node { }; }; +static inline const char *data_type_name (enum data_type type) +{ +switch (type) { +case DATA_ARRAY : +return "array" ; +case DATA_HASH : +return "hash" ; +case DATA_STRING : +return "string" ; +case DATA_INT : +return "int" ; +default : +return "???" ; + } +} +static inline struct data_node *data_node_string (const char *string) {size_t size =sizeof (struct data_node_string ) +strlen (string) +1 ;
docparse/docparse.c +59 -0
77 lines not on this page · raw message
docparse/tests/include.c.json +1 -1
@@ -1,4 +1,4 @@ "include": { - "test_variants": "10", + "test_variants": 10, "fname": "include.c" }
docparse/tests/macro.c.json +1 -1
@@ -1,4 +1,4 @@ "macro": { - "test_variants": "10", + "test_variants": 10, "fname": "macro.c" }
docparse/tests/multiline_macro.c.json +1 -1
@@ -1,4 +1,4 @@ "multiline_macro": { - "test_variants": "10", + "test_variants": 10, "fname": "multiline_macro.c" }
Signature · 5 lines
2.32.0 -- Mailing list info: https://lists.linux.it/listinfo/ltp
Re: [LTP] [PATCH v3 5/7] docparse: Add type normalization
Hi Cyril,
Quoted 8 lines
For now just for .test_variants.
There are two reasons for this:
- This code makes sure that we get right value parsed and aborts the compilation if the parser got confused. This part is important since if the testrunners are going to use the metadata the data in there must be correct.
Very good idea.
Quoted 1 line
- And much less important it makes the resulting json nicer to read
...
docparse/docparse.c static struct data_node *parse_file(const char *fname) · line 742
Quoted 10 lines
docparse/docparse.c +10
-0+static void convert_str2int (struct data_node *res,const char *id,const char *str_val) +{ +long val; +char *endptr; + + errno =0 ; + val =strtol (str_val, &endptr,10 ); + +if (errno || *endptr) { +fprintf (stderr,"Cannot convert %s value %s to int!" , id, str_val);
=> missing \n.
docparse/docparse.c static struct data_node *parse_file(const char *fname) · line 747
Quoted 5 lines
docparse/docparse.c +5
-0+exit (1 ); + } + +if (verbose) +fprintf (stderr,"NORMALIZING %s TO INT %li" , id, val);
And here.
Quoted 16 lines
docparse/docparse.c +16
-0+ +data_node_hash_del (res, id); +data_node_hash_add (res, id,data_node_int (val)); +} + +static void check_normalize_types (struct data_node *res) +{ +unsigned int i; + +for (i =0 ; tst_test_typemap[i].id; i++) { +struct data_node *n; +struct typemap *typemap = &tst_test_typemap[i]; + + n =data_node_hash_get (res, typemap->id); +if (!n) +continue ;
docparse/docparse.c static struct data_node *parse_file(const char *fname) · line 773
Quoted 10 lines
docparse/docparse.c +10
-0+ +if (n->type == typemap->type) +continue ; + +if (n->type ==DATA_STRING && typemap->type ==DATA_INT ) { +convert_str2int (res, typemap->id, n->string.val); +continue ; + } + + fprintf(stderr, "Cannot convert %s from %s to %s!",
And here.
docparse/docparse.c static struct data_node *parse_file(const char *fname) · line 778
Quoted 5 lines
docparse/docparse.c +5
-0+ typemap->id,data_type_name (n->type), + data_type_name(typemap->type)); +exit (1 ); + } +}
Kind regards,
Petr
Signature · 1 line
Mailing list info: https://lists.linux.it/listinfo/ltp
PATCH v3 6/7 docparse: Group data to 'testsuite' and 'defaults'
In reply to Cyril HrubisGroup all data belonging to testsuite info to 'testsuite' object and move default timeout to 'defaults' object. This makes the JSON structure a bit cleaner and easier to understand.
--- docparse/parse.sh | 16 ++++++++++------ docparse/testinfo.pl | 16 ++++++++-------- 2 files changed, 18 insertions(+), 14 deletions(-)
docparse/parse.sh +10 -6
@@ -15,12 +15,16 @@ if [ -d .git ]; then fi echo '{' -echo ' "testsuite": "Linux Test Project",' -echo ' "testsuite_short": "LTP",' -echo ' "url": "https://github.com/linux-test-project/ltp/",' -echo ' "scm_url_base": "https://github.com/linux-test-project/ltp/tree/master/",' -echo ' "timeout": 300,' -echo " \"version\": \"$version\"," +echo ' "testsuite": {' +echo ' "name": "Linux Test Project",' +echo ' "short_name": "LTP",' +echo ' "url": "https://github.com/linux-test-project/ltp/",' +echo ' "scm_url_base": "https://github.com/linux-test-project/ltp/tree/master/",' +echo " \"version\": \"$version\"" +echo ' },' +echo ' "defaults": {' +echo ' "timeout": 300' +echo ' },' echo ' "tests": {' first=1
docparse/testinfo.pl +8 -8
@@ -164,9 +164,9 @@ sub content_about my $json = shift; my $content; - $content .= print_defined("URL", $json->{'url'}); - $content .= print_defined("Version", $json->{'version'}); - $content .= print_defined("Default timeout", $json->{'timeout'}, "seconds"); + $content .= print_defined("URL", $json->{'testsuite'}->{'url'}); + $content .= print_defined("Version", $json->{'testsuite'}->{'version'}); + $content .= print_defined("Default timeout", $json->{'defaults'}->{'timeout'}, "seconds"); return $content; }
@@ -360,10 +360,10 @@ sub content_all_tests $content .= h3($name); $content .= $letters; - if (defined($json->{'scm_url_base'}) && + if (defined($json->{'testsuite'}->{'scm_url_base'}) && defined($json->{'tests'}{$name}{fname})) { $content .= paragraph(html_a(tag_url("fname", $json->{'tests'}{$name}{fname}, - $json->{'scm_url_base'}), "source")); + $json->{'testsuite'}->{'scm_url_base'}), "source")); } if (defined $json->{'tests'}{$name}{doc}) {
@@ -386,7 +386,7 @@ sub content_all_tests $content .= paragraph("Test timeout is $json->{'tests'}{$name}{timeout} seconds"); } } else { - $content .= paragraph("Test timeout defaults to $json->{'timeout'} seconds"); + $content .= paragraph("Test timeout defaults to $json->{'defaults'}->{'timeout'} seconds"); } my $tmp2 = undef;
@@ -463,7 +463,7 @@ my $json = decode_json(load_json($ARGV[0])); my $config = [ { file => "about.txt", - title => h2("About $json->{'testsuite'}"), + title => h2("About $json->{'testsuite'}->{'name'}"), content => \&content_about, }, {
@@ -495,7 +495,7 @@ EOL for my $c (@{$config}) { $content .= "include::$c->{'file'}\[\]\n"; } - print_asciidoc_page($fh, $json, h1($json->{'testsuite_short'} . " test catalog"), $content); + print_asciidoc_page($fh, $json, h1($json->{'testsuite'}->{'short_name'} . " test catalog"), $content); } for my $c (@{$config}) {
Signature · 5 lines
2.32.0 -- Mailing list info: https://lists.linux.it/listinfo/ltp
Re: [LTP] [PATCH v3 6/7] docparse: Group data to 'testsuite' and 'defaults'
Hi Cyril,
Kind regards,
Petr
Signature · 1 line
Mailing list info: https://lists.linux.it/listinfo/ltp
PATCH v3 7/7 docparse: Split into metadata and docparse
In reply to Cyril HrubisThat way the metadata are build and installed unconditionally as they are going to be integral part of the test execution framework.
The metadata file is also renamed to ltp.json and installed into $DESTDIR/metadata/ltp.json.
The docparse build is triggered from the metadata Makefile since it has to be done once the ltp.json is fully generated.
---
Makefile | 5 +---
docparse/.gitignore | 2 --
docparse/Makefile | 12 ++-------
metadata/.gitignore | 2 ++
metadata/Makefile | 27 +++++++++++++++++++
{docparse => metadata}/data_storage.h | 0
docparse/docparse.c => metadata/metaparse.c | 0
{docparse => metadata}/parse.sh | 2 +-
{docparse => metadata}/tests/Makefile | 0
{docparse => metadata}/tests/array_size01.c | 0
.../tests/array_size01.c.json | 0
{docparse => metadata}/tests/array_size02.c | 0
.../tests/array_size02.c.json | 0
{docparse => metadata}/tests/array_size03.c | 0
.../tests/array_size03.c.json | 0
{docparse => metadata}/tests/array_size04.c | 0
.../tests/array_size04.c.json | 0
{docparse => metadata}/tests/empty_struct.c | 0
.../tests/empty_struct.c.json | 0
{docparse => metadata}/tests/expand_flags.c | 0
.../tests/expand_flags.c.json | 0
{docparse => metadata}/tests/include.c | 0
{docparse => metadata}/tests/include.c.json | 0
{docparse => metadata}/tests/include.h | 0
{docparse => metadata}/tests/macro.c | 0
{docparse => metadata}/tests/macro.c.json | 0
{docparse => metadata}/tests/macro_str.c | 0
{docparse => metadata}/tests/macro_str.c.json | 0
.../tests/multiline_macro.c | 0
.../tests/multiline_macro.c.json | 0
{docparse => metadata}/tests/tags.c | 0
{docparse => metadata}/tests/tags.c.json | 0
{docparse => metadata}/tests/test.sh | 2 +-
33 files changed, 34 insertions(+), 18 deletions(-)
create mode 100644 metadata/.gitignore
create mode 100644 metadata/Makefile
rename {docparse => metadata}/data_storage.h (100%)
rename docparse/docparse.c => metadata/metaparse.c (100%)
rename {docparse => metadata}/parse.sh (91%)
rename {docparse => metadata}/tests/Makefile (100%)
rename {docparse => metadata}/tests/array_size01.c (100%)
rename {docparse => metadata}/tests/array_size01.c.json (100%)
rename {docparse => metadata}/tests/array_size02.c (100%)
rename {docparse => metadata}/tests/array_size02.c.json (100%)
rename {docparse => metadata}/tests/array_size03.c (100%)
rename {docparse => metadata}/tests/array_size03.c.json (100%)
rename {docparse => metadata}/tests/array_size04.c (100%)
rename {docparse => metadata}/tests/array_size04.c.json (100%)
rename {docparse => metadata}/tests/empty_struct.c (100%)
rename {docparse => metadata}/tests/empty_struct.c.json (100%)
rename {docparse => metadata}/tests/expand_flags.c (100%)
rename {docparse => metadata}/tests/expand_flags.c.json (100%)
rename {docparse => metadata}/tests/include.c (100%)
rename {docparse => metadata}/tests/include.c.json (100%)
rename {docparse => metadata}/tests/include.h (100%)
rename {docparse => metadata}/tests/macro.c (100%)
rename {docparse => metadata}/tests/macro.c.json (100%)
rename {docparse => metadata}/tests/macro_str.c (100%)
rename {docparse => metadata}/tests/macro_str.c.json (100%)
rename {docparse => metadata}/tests/multiline_macro.c (100%)
rename {docparse => metadata}/tests/multiline_macro.c.json (100%)
rename {docparse => metadata}/tests/tags.c (100%)
rename {docparse => metadata}/tests/tags.c.json (100%)
rename {docparse => metadata}/tests/test.sh (88%)Makefile +1 -4
@@ -62,10 +62,7 @@ $(1):: | $$(abs_top_builddir)/$$(basename $$(subst -,.,$(1))) endif endef -COMMON_TARGETS += testcases tools -ifeq ($(WITH_METADATA),yes) -COMMON_TARGETS += docparse -endif +COMMON_TARGETS += testcases tools metadata # Don't want to nuke the original files if we're installing in-build-tree. ifneq ($(BUILD_TREE_STATE),$(BUILD_TREE_SRCDIR_INSTALL))
docparse/.gitignore +0 -2
@@ -1,7 +1,5 @@ /*.txt /docbook-xsl.css -/docparse -/metadata.json /metadata.html /metadata.pdf /metadata.chunked/
docparse/Makefile +2 -10
@@ -29,7 +29,6 @@ METADATA_GENERATOR_PARAMS += -v endif CLEAN_TARGETS := *.css *.js *.txt -MAKE_TARGETS := metadata.json ifeq ($(WITH_METADATA_HTML),yes) MAKE_TARGETS += metadata.html
@@ -42,8 +41,6 @@ ifeq ($(WITH_METADATA_PDF),yes) MAKE_TARGETS += metadata.pdf endif -HOST_MAKE_TARGETS := docparse - INSTALL_DIR = metadata INSTALL_TARGETS = *.css *.js
@@ -51,13 +48,8 @@ ifndef METADATA_GENERATOR METADATA_GENERATOR := asciidoctor endif -.PHONY: metadata.json - -metadata.json: docparse - $(abs_srcdir)/parse.sh > metadata.json - -txt: metadata.json - $(abs_srcdir)/testinfo.pl metadata.json +txt: ${abs_top_builddir}/metadata/ltp.json + $(abs_srcdir)/testinfo.pl $< ifeq ($(WITH_METADATA_HTML),yes) metadata.html: txt
metadata/.gitignore new file +2 -0
@@ -0,0 +1,2 @@ +metaparse +ltp.json
metadata/Makefile new file +27 -0
@@ -0,0 +1,27 @@ +# SPDX-License-Identifier: GPL-2.0-or-later +# Copyright (c) 2020 Cyril Hrubis <[email protected]> + +top_srcdir ?= .. + +include $(top_srcdir)/include/mk/env_pre.mk +include $(top_srcdir)/include/mk/functions.mk + +MAKE_TARGETS := ltp.json docparse +HOST_MAKE_TARGETS := metaparse +INSTALL_DIR = metadata + +.PHONY: ltp.json + +ltp.json: metaparse + $(abs_srcdir)/parse.sh > ltp.json + +docparse: ltp.json +ifeq ($(WITH_METADATA),yes) + mkdir -p $(abs_top_builddir)/docparse + $(MAKE) -C $(abs_top_builddir)/docparse/ -f $(abs_top_srcdir)/docparse/Makefile +endif + +test: + $(MAKE) -C $(abs_srcdir)/tests/ test + +include $(top_srcdir)/include/mk/generic_leaf_target.mk
metadata/data_storage.h renamed from docparse/data_storage.h +0 -0
metadata/metaparse.c renamed from docparse/docparse.c +0 -0
metadata/parse.sh renamed from docparse/parse.sh +1 -1
@@ -30,7 +30,7 @@ echo ' "tests": {' first=1 for test in `find testcases/ -name '*.c'`; do - a=$($top_builddir/docparse/docparse -Iinclude -Itestcases/kernel/syscalls/utils/ "$test") + a=$($top_builddir/metadata/metaparse -Iinclude -Itestcases/kernel/syscalls/utils/ "$test") if [ -n "$a" ]; then if [ -z "$first" ]; then echo ','
metadata/tests/Makefile renamed from docparse/tests/Makefile +0 -0
metadata/tests/array_size01.c renamed from docparse/tests/array_size01.c +0 -0
metadata/tests/array_size01.c.json renamed from docparse/tests/array_size01.c.json +0 -0
metadata/tests/array_size02.c renamed from docparse/tests/array_size02.c +0 -0
metadata/tests/array_size02.c.json renamed from docparse/tests/array_size02.c.json +0 -0
metadata/tests/array_size03.c renamed from docparse/tests/array_size03.c +0 -0
metadata/tests/array_size03.c.json renamed from docparse/tests/array_size03.c.json +0 -0
metadata/tests/array_size04.c renamed from docparse/tests/array_size04.c +0 -0
metadata/tests/array_size04.c.json renamed from docparse/tests/array_size04.c.json +0 -0
metadata/tests/empty_struct.c renamed from docparse/tests/empty_struct.c +0 -0
metadata/tests/empty_struct.c.json renamed from docparse/tests/empty_struct.c.json +0 -0
metadata/tests/expand_flags.c renamed from docparse/tests/expand_flags.c +0 -0
metadata/tests/expand_flags.c.json renamed from docparse/tests/expand_flags.c.json +0 -0
metadata/tests/include.c renamed from docparse/tests/include.c +0 -0
metadata/tests/include.c.json renamed from docparse/tests/include.c.json +0 -0
metadata/tests/include.h renamed from docparse/tests/include.h +0 -0
metadata/tests/macro.c renamed from docparse/tests/macro.c +0 -0
metadata/tests/macro.c.json renamed from docparse/tests/macro.c.json +0 -0
metadata/tests/macro_str.c renamed from docparse/tests/macro_str.c +0 -0
metadata/tests/macro_str.c.json renamed from docparse/tests/macro_str.c.json +0 -0
metadata/tests/multiline_macro.c renamed from docparse/tests/multiline_macro.c +0 -0
metadata/tests/multiline_macro.c.json renamed from docparse/tests/multiline_macro.c.json +0 -0
metadata/tests/tags.c renamed from docparse/tests/tags.c +0 -0
metadata/tests/tags.c.json renamed from docparse/tests/tags.c.json +0 -0
metadata/tests/test.sh renamed from docparse/tests/test.sh +1 -1
@@ -3,7 +3,7 @@ fail=0 for i in *.c; do - ../docparse $i > tmp.json + ../metaparse $i > tmp.json if ! diff tmp.json $i.json &> /dev/null; then echo "***" echo "$i output differs!"
Signature · 5 lines
2.32.0 -- Mailing list info: https://lists.linux.it/listinfo/ltp
Re: [LTP] [PATCH v3 7/7] docparse: Split into metadata and docparse
Hi Cyril,
there are still some failures
https://github.com/pevik/ltp/actions/runs/1416702471
make install has wrong path (it's on jobs with out-of-tree build and with
Fedora; it's visible in .github/workflows/ci.yml - MAKE_INSTALL but unfortunately GitHub Actions hide these variables):
https://github.com/pevik/ltp/runs/4092384478?check_suite_focus=true
install -m 00775 "/__w/ltp/ltp-build/metadata/ltp.json" /github/home/ltp-install/opt/ltp/metadata/ltp.json
install -m 00775 "/__w/ltp/ltp-build/metadata/docparse" /github/home/ltp-install/opt/ltp/metadata/docparse
install: cannot stat '/__w/ltp/ltp-build/metadata/docparse': No such file or directory
make[1]: *** [/__w/ltp/ltp/include/mk/env_post.mk:85: /github/home/ltp-install/opt/ltp/metadata/docparse] Error 1
Obviously path should be '/__w/ltp/ltp-build/metadata/../docparse'
Reproducing locally:
$ ./configure CC=clang $ cd metadata $ make $ make install mkdir -p "/opt/ltp/metadata" install -m 00775 "ltp.git/metadata/ltp.json" /opt/ltp/metadata/ltp.json install -m 00775 "ltp.git/metadata/docparse" /opt/ltp/metadata/docparse install: cannot stat 'ltp.git/metadata/docparse': No such file or directory make: *** [../include/mk/env_post.mk:85: /opt/ltp/metadata/docparse] Error 1
Kind regards,
Petr
Signature · 1 line
Mailing list info: https://lists.linux.it/listinfo/ltp
Re: [LTP] [PATCH v3 7/7] docparse: Split into metadata and docparse
Hi Cyril,
Quoted 1 line
Obviously path should be '/__w/ltp/ltp-build/metadata/../docparse'
Actually '/__w/ltp/ltp-build/metadata/../docparse/docparse'
Or we might want to disable installing docparse.
Kind regards,
Petr
Signature · 1 line
Mailing list info: https://lists.linux.it/listinfo/ltp
Re: [LTP] [PATCH v3 7/7] docparse: Split into metadata and docparse
In reply to Petr VorelHi!
Quoted 12 lines
make install has wrong path (it's on jobs with out-of-tree build and with
Fedora; it's visible in.github/workflows/ci.yml-MAKE_INSTALLbut unfortunately GitHub Actions hide these variables):https://github.com/pevik/ltp/runs/4092384478?check_suite_focus=true
install -m 00775 "/__w/ltp/ltp-build/metadata/ltp.json" /github/home/ltp-install/opt/ltp/metadata/ltp.json
install -m 00775 "/__w/ltp/ltp-build/metadata/docparse" /github/home/ltp-install/opt/ltp/metadata/docparse
install: cannot stat '/__w/ltp/ltp-build/metadata/docparse': No such file or directory
make[1]: *** [/__w/ltp/ltp/include/mk/env_post.mk:85: /github/home/ltp-install/opt/ltp/metadata/docparse] Error 1Obviously path should be '/__w/ltp/ltp-build/metadata/../docparse'
Reproducing locally:
Quoted 9 lines
$ ./configure CC=clang $ cd metadata $ make $ make install mkdir -p "/opt/ltp/metadata" install -m 00775 "ltp.git/metadata/ltp.json" /opt/ltp/metadata/ltp.json install -m 00775 "ltp.git/metadata/docparse" /opt/ltp/metadata/docparse install: cannot stat 'ltp.git/metadata/docparse': No such file or directory make: *** [../include/mk/env_post.mk:85: /opt/ltp/metadata/docparse] Error 1
Actually it's the
MAKE_TARGETS := ltp.json docparse
which treats the docparse as a actuall file.
So I guess that we need this:
metadata/Makefile +6 -3
@@ -6,7 +6,7 @@ top_srcdir ?= .. include $(top_srcdir)/include/mk/env_pre.mk include $(top_srcdir)/include/mk/functions.mk -MAKE_TARGETS := ltp.json docparse +MAKE_TARGETS := ltp.json HOST_MAKE_TARGETS := metaparse INSTALL_DIR = metadata
@@ -14,13 +14,16 @@ INSTALL_DIR = metadata ltp.json: metaparse $(abs_srcdir)/parse.sh > ltp.json - -docparse: ltp.json ifeq ($(WITH_METADATA),yes) mkdir -p $(abs_top_builddir)/docparse $(MAKE) -C $(abs_top_builddir)/docparse/ -f $(abs_top_srcdir)/docparse/Makefile endif +ifeq ($(WITH_METADATA),yes) +install: + $(MAKE) -C $(abs_top_builddir)/docparse/ -f $(abs_top_srcdir)/docparse/Makefile install +endif + test: $(MAKE) -C $(abs_srcdir)/tests/ test
Signature · 5 lines
Cyril Hrubis [email protected] -- Mailing list info: https://lists.linux.it/listinfo/ltp
Re: [LTP] [PATCH v3 7/7] docparse: Split into metadata and docparse
Hi!
Quoted 22 lines
Actually it's the
MAKE_TARGETS:= ltp.json docparsewhich treats the docparse as a actuall file.
So I guess that we need this:
metadata/Makefile +1
-1@@ -6,7 +6,7 @@ top_srcdir ?= .. include $(top_srcdir)/include/mk/env_pre.mk include $(top_srcdir)/include/mk/functions.mk -MAKE_TARGETS := ltp.json docparse +MAKE_TARGETS := ltp.json HOST_MAKE_TARGETS := metaparse INSTALL_DIR = metadata
metadata/Makefile INSTALL_DIR = metadata · line 20
Quoted 9 lines
metadata/Makefile +0
-2@@ -14,13 +14,16 @@ INSTALL_DIR = metadata ltp.json: metaparse $(abs_srcdir)/parse.sh > ltp.json - -docparse: ltp.json ifeq ($(WITH_METADATA),yes) mkdir -p $(abs_top_builddir)/docparse $(MAKE) -C $(abs_top_builddir)/docparse/ -f $(abs_top_srcdir)/docparse/Makefile endif
And obviously if we do not want to install the html pages we can remove this part:
Quoted 4 lines
metadata/Makefile +4
-0+ifeq ($(WITH_METADATA),yes) +install: + $(MAKE) -C $(abs_top_builddir)/docparse/ -f $(abs_top_srcdir)/docparse/Makefile install +endif
Signature · 5 lines
Cyril Hrubis [email protected] -- Mailing list info: https://lists.linux.it/listinfo/ltp
Re: [LTP] [PATCH v3 7/7] docparse: Split into metadata and docparse
Hi Cyril,
Changes LGTM (works locally, testing it in CI:
https://github.com/pevik/ltp/actions/runs/1417208983
Quoted 2 lines
And obviously if we do not want to install the html pages we can remove this part:
I'd keep installing html/pdf. Also nice json is also installed.
Kind regards,
Petr
Signature · 1 line
Mailing list info: https://lists.linux.it/listinfo/ltp
Re: [LTP] [PATCH v3 7/7] docparse: Split into metadata and docparse
Quoted 4 lines
Hi Cyril,
Changes LGTM (works locally, testing it in CI:
https://github.com/pevik/ltp/actions/runs/1417208983
Failed :(.
Reproducible locally:
make -C "metadata" \
-f "/home/pvorel/install/src/ltp.git/metadata/Makefile" install
make[1]: Entering directory '/home/pvorel/install/src/ltp.git/metadata'
make -C /home/pvorel/install/src/ltp.git/docparse/ -f /home/pvorel/install/src/ltp.git/docparse/Makefile install make[2]: Entering directory '/home/pvorel/install/src/ltp.git/docparse'
install -m 00775 "/home/pvorel/install/src/ltp.git/docparse/metadata.html" /opt/ltp/metadata/metadata.html
install: cannot stat '/home/pvorel/install/src/ltp.git/docparse/metadata.html': No such file or directory make[2]: *** [../include/mk/env_post.mk:85: /opt/ltp/metadata/metadata.html] Error 1
make[2]: Leaving directory '/home/pvorel/install/src/ltp.git/docparse'
make[1]: *** [/home/pvorel/install/src/ltp.git/metadata/Makefile:26: install] Error 2
make[1]: Leaving directory '/home/pvorel/install/src/ltp.git/metadata'
make: *** [Makefile:138: metadata-install] Error 2
Maybe I wrongly applied your patch, could you please have a look?
Kind regards,
Petr
Makefile +1 -6
@@ -6,7 +6,7 @@ top_srcdir ?= .. include $(top_srcdir)/include/mk/env_pre.mk include $(top_srcdir)/include/mk/functions.mk -MAKE_TARGETS := ltp.json +MAKE_TARGETS := ltp.json docparse HOST_MAKE_TARGETS := metaparse INSTALL_DIR = metadata
@@ -21,11 +21,6 @@ ifeq ($(WITH_METADATA),yes) $(MAKE) -C $(abs_top_builddir)/docparse/ -f $(abs_top_srcdir)/docparse/Makefile endif -ifeq ($(WITH_METADATA),yes) -install: - $(MAKE) -C $(abs_top_builddir)/docparse/ -f $(abs_top_srcdir)/docparse/Makefile install -endif - test: $(MAKE) -C $(abs_srcdir)/tests/ test
Signature · 1 line
Mailing list info: https://lists.linux.it/listinfo/ltp
Re: [LTP] [PATCH v3 7/7] docparse: Split into metadata and docparse
Hi!
Quoted 18 lines
Quoted 2 lines
Changes LGTM (works locally, testing it in CI:
https://github.com/pevik/ltp/actions/runs/1417208983Failed :(.
Reproducible locally:
make -C "metadata" \
-f "/home/pvorel/install/src/ltp.git/metadata/Makefile" install
make[1]: Entering directory '/home/pvorel/install/src/ltp.git/metadata'
make -C/home/pvorel/install/src/ltp.git/docparse/-f/home/pvorel/install/src/ltp.git/docparse/Makefileinstall make[2]: Entering directory '/home/pvorel/install/src/ltp.git/docparse'
install -m 00775 "/home/pvorel/install/src/ltp.git/docparse/metadata.html"/opt/ltp/metadata/metadata.html
install: cannot stat '/home/pvorel/install/src/ltp.git/docparse/metadata.html': No such file or directory make[2]: *** [../include/mk/env_post.mk:85:/opt/ltp/metadata/metadata.html] Error 1
make[2]: Leaving directory '/home/pvorel/install/src/ltp.git/docparse'
make[1]: *** [/home/pvorel/install/src/ltp.git/metadata/Makefile:26: install] Error 2
make[1]: Leaving directory '/home/pvorel/install/src/ltp.git/metadata'
make: *** [Makefile:138: metadata-install] Error 2
Quoted 1 line
Maybe I wrongly applied your patch, could you please have a look?
As far as I can tell this just means that the html wasn't build at all, at least that's what was shown by the CI.
Quoted 8 lines
Kind regards,
PetrMakefile +0
-0
Makefile top_srcdir ?= .. · line 11
Quoted 7 lines
Makefile +1
-1@@ -6,7 +6,7 @@ top_srcdir ?= .. include $(top_srcdir)/include/mk/env_pre.mk include $(top_srcdir)/include/mk/functions.mk -MAKE_TARGETS := ltp.json +MAKE_TARGETS := ltp.json docparse HOST_MAKE_TARGETS := metaparse INSTALL_DIR = metadata
I guess that this is the revese diff.
Makefile ifeq ($(WITH_METADATA),yes) · line 22
Quoted 3 lines
Makefile +0
-0@@ -21,11 +21,6 @@ ifeq ($(WITH_METADATA),yes) $(MAKE) -C $(abs_top_builddir)/docparse/ -f $(abs_top_srcdir)/docparse/Makefile endif
This part is likely wrong, it should look like:
ltp.json: metaparse
$(abs_srcdir)/parse.sh > ltp.json
ifeq ($(WITH_METADATA),yes)
mkdir -p $(abs_top_builddir)/docparse
$(MAKE) -C $(abs_top_builddir)/docparse/ -f $(abs_top_srcdir)/docparse/Makefileendif
So that in the case that WITH_METADATA is set the rule has three lines not one.
And that would explain why the html wasn't build since there was a docparse rule but nothing refrenced it.
Signature · 5 lines
Cyril Hrubis [email protected] -- Mailing list info: https://lists.linux.it/listinfo/ltp
Re: [LTP] [PATCH v3 7/7] docparse: Split into metadata and docparse
Hi!
And I did a CI run with the correct version at:
https://github.com/metan-ucw/ltp/actions/runs/1421302973
Signature · 5 lines
Cyril Hrubis [email protected] -- Mailing list info: https://lists.linux.it/listinfo/ltp
Petr Vorel
Reviewed-byRe: [LTP] [PATCH v3 7/7] docparse: Split into metadata and docparse
Quoted 4 lines
Hi!
And I did a CI run with the correct version at:
Thanks!
I'd still appreciate make in docparse/ directory could somehow resolve missing dependency, but I can live without it as it's obviously meant to run make only in metadata/ directory.
$ cd docparse/ $ make make: *** No rule to make target 'ltp/metadata/ltp.json', needed by 'txt'. Stop. [2] Čt lis 04 20:34 W ltp/docparse (metan/docparse-improvements.v4.fixes) $ cd ../metadata/
$ make
HOSTCC metadata/metaparse
ltp/metadata/parse.sh > ltp.json
mkdir -p ltp/docparse
make -C ltp/docparse/ -f ltp/docparse/Makefile
make[1]: Entering directory 'ltp/docparse'
ltp/docparse/testinfo.pl ltp/metadata/ltp.json
INFO: using '../linux' as LINUX_GIT repository
WARN: $LINUX_STABLE_GIT does not exit ('../linux-stable')
INFO: using '../glibc' as GLIBC_GIT repository
asciidoctor -d book metadata.txt -b xhtml
make[1]: Leaving directory 'ltp/docparse'Kind regards,
Petr
Signature · 1 line
Mailing list info: https://lists.linux.it/listinfo/ltp
Re: [LTP] [PATCH v3 7/7] docparse: Split into metadata and docparse
Hi!
Quoted 3 lines
I'd still appreciate make in docparse/ directory could somehow resolve missing dependency, but I can live without it as it's obviously meant to run make only in metadata/ directory.
The problem is that if we add any way how to trigger the ltp.json build from the metadata directory it will crash and burn when parallel build is invoked from the top level directory.
We would have to explain the dependency in the top level Makefile as well as in the docparse/Makefile. Which would be complicated and error prone.
Signature · 5 lines
Cyril Hrubis [email protected] -- Mailing list info: https://lists.linux.it/listinfo/ltp
Re: [LTP] [PATCH v3 7/7] docparse: Split into metadata and docparse
Quoted 5 lines
Hi!
Quoted 3 lines
I'd still appreciate make in docparse/ directory could somehow resolve missing dependency, but I can live without it as it's obviously meant to run make only in metadata/ directory.
Quoted 7 lines
The problem is that if we add any way how to trigger the ltp.json build from the metadata directory it will crash and burn when parallel build is invoked from the top level directory.
We would have to explain the dependency in the top level
Makefileas well as in the docparse/Makefile. Which would be complicated and error prone.
Thanks for info, agree to avoid it.
Kind regards,
Petr
Signature · 1 line
Mailing list info: https://lists.linux.it/listinfo/ltp
Re: [LTP] [PATCH v3 7/7] docparse: Split into metadata and docparse
In reply to Petr VorelHi!
Quoted 2 lines
Changes LGTM (works locally, testing it in CI:
https://github.com/pevik/ltp/actions/runs/1417208983
And it looks like there is still a mistake, it fails to build the html and pdf on debian stable and fedora lastest. It looks like the docparse build wasn't triggered from the metadata directory and I have no idea why.
Signature · 5 lines
Cyril Hrubis [email protected] -- Mailing list info: https://lists.linux.it/listinfo/ltp
Hi Cyril,
very nice improvements, thanks!
I put some notes, but unlike trivial fixes (missing \n) feel free to merge as is. To whole patchset:
Kind regards,
Petr
Signature · 1 line
Mailing list info: https://lists.linux.it/listinfo/ltp
Hi!
Quoted 4 lines
very nice improvements, thanks!
I put some notes, but unlike trivial fixes (missing \n) feel free to merge as is.
I've fixed these and pushed.
Peter Ritchie thanks for the reviews.
Signature · 5 lines
Cyril Hrubis [email protected] -- Mailing list info: https://lists.linux.it/listinfo/ltp