| Message ID | 20230131220355.1603527-2-rmoar@google.com (mailing list archive) |
|---|---|
| State | New |
| Delegated to: | Brendan Higgins |
| Headers | show |
| Series | kunit: fix bugs in debugfs logs | expand |
Hi Rae,
Thank you for the patch! Perhaps something to improve:
[auto build test WARNING on 766f4f2514d2d18bcbd60a058188fb502dea5ddf]
url: https://github.com/intel-lab-lkp/linux/commits/Rae-Moar/kunit-fix-bug-in-debugfs-logs-of-parameterized-tests/20230201-060537
base: 766f4f2514d2d18bcbd60a058188fb502dea5ddf
patch link: https://lore.kernel.org/r/20230131220355.1603527-2-rmoar%40google.com
patch subject: [PATCH v1 1/3] kunit: fix bug in debugfs logs of parameterized tests
config: m68k-allyesconfig (https://download.01.org/0day-ci/archive/20230201/202302010709.7ZmEen4w-lkp@intel.com/config)
compiler: m68k-linux-gcc (GCC) 12.1.0
reproduce (this is a W=1 build):
wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross
chmod +x ~/bin/make.cross
# https://github.com/intel-lab-lkp/linux/commit/c8b669e1d139e1ee08121b184d859e45d7a02940
git remote add linux-review https://github.com/intel-lab-lkp/linux
git fetch --no-tags linux-review Rae-Moar/kunit-fix-bug-in-debugfs-logs-of-parameterized-tests/20230201-060537
git checkout c8b669e1d139e1ee08121b184d859e45d7a02940
# save the config file
mkdir build_dir && cp config build_dir/.config
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=gcc-12.1.0 make.cross W=1 O=build_dir ARCH=m68k olddefconfig
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=gcc-12.1.0 make.cross W=1 O=build_dir ARCH=m68k SHELL=/bin/bash lib/
If you fix the issue, kindly add following tag where applicable
| Reported-by: kernel test robot <lkp@intel.com>
All warnings (new ones prefixed by >>):
lib/kunit/test.c: In function '__kunit_fail_current_test_impl':
lib/kunit/test.c:40:9: warning: function '__kunit_fail_current_test_impl' might be a candidate for 'gnu_printf' format attribute [-Wsuggest-attribute=format]
40 | len = vsnprintf(NULL, 0, fmt, args) + 1;
| ^~~
lib/kunit/test.c:48:9: warning: function '__kunit_fail_current_test_impl' might be a candidate for 'gnu_printf' format attribute [-Wsuggest-attribute=format]
48 | vsnprintf(buffer, len, fmt, args);
| ^~~~~~~~~
lib/kunit/test.c: In function 'kunit_log_append':
>> lib/kunit/test.c:133:1: warning: the frame size of 1500 bytes is larger than 1024 bytes [-Wframe-larger-than=]
133 | }
| ^
vim +133 lib/kunit/test.c
acd8e8407b8fcc David Gow 2021-08-03 110
e2219db280e3fe Alan Maguire 2020-03-26 111 /*
e2219db280e3fe Alan Maguire 2020-03-26 112 * Append formatted message to log, size of which is limited to
e2219db280e3fe Alan Maguire 2020-03-26 113 * KUNIT_LOG_SIZE bytes (including null terminating byte).
e2219db280e3fe Alan Maguire 2020-03-26 114 */
e2219db280e3fe Alan Maguire 2020-03-26 115 void kunit_log_append(char *log, const char *fmt, ...)
e2219db280e3fe Alan Maguire 2020-03-26 116 {
e2219db280e3fe Alan Maguire 2020-03-26 117 char line[KUNIT_LOG_SIZE];
e2219db280e3fe Alan Maguire 2020-03-26 118 va_list args;
e2219db280e3fe Alan Maguire 2020-03-26 119 int len_left;
e2219db280e3fe Alan Maguire 2020-03-26 120
e2219db280e3fe Alan Maguire 2020-03-26 121 if (!log)
e2219db280e3fe Alan Maguire 2020-03-26 122 return;
e2219db280e3fe Alan Maguire 2020-03-26 123
e2219db280e3fe Alan Maguire 2020-03-26 124 len_left = KUNIT_LOG_SIZE - strlen(log) - 1;
e2219db280e3fe Alan Maguire 2020-03-26 125 if (len_left <= 0)
e2219db280e3fe Alan Maguire 2020-03-26 126 return;
e2219db280e3fe Alan Maguire 2020-03-26 127
e2219db280e3fe Alan Maguire 2020-03-26 128 va_start(args, fmt);
e2219db280e3fe Alan Maguire 2020-03-26 129 vsnprintf(line, sizeof(line), fmt, args);
e2219db280e3fe Alan Maguire 2020-03-26 130 va_end(args);
e2219db280e3fe Alan Maguire 2020-03-26 131
e2219db280e3fe Alan Maguire 2020-03-26 132 strncat(log, line, len_left);
e2219db280e3fe Alan Maguire 2020-03-26 @133 }
e2219db280e3fe Alan Maguire 2020-03-26 134 EXPORT_SYMBOL_GPL(kunit_log_append);
e2219db280e3fe Alan Maguire 2020-03-26 135
Hi Rae,
Thank you for the patch! Perhaps something to improve:
[auto build test WARNING on 766f4f2514d2d18bcbd60a058188fb502dea5ddf]
url: https://github.com/intel-lab-lkp/linux/commits/Rae-Moar/kunit-fix-bug-in-debugfs-logs-of-parameterized-tests/20230201-060537
base: 766f4f2514d2d18bcbd60a058188fb502dea5ddf
patch link: https://lore.kernel.org/r/20230131220355.1603527-2-rmoar%40google.com
patch subject: [PATCH v1 1/3] kunit: fix bug in debugfs logs of parameterized tests
config: hexagon-randconfig-r045-20230202 (https://download.01.org/0day-ci/archive/20230203/202302031414.TsTAA8Dr-lkp@intel.com/config)
compiler: clang version 16.0.0 (https://github.com/llvm/llvm-project 4196ca3278f78c6e19246e54ab0ecb364e37d66a)
reproduce (this is a W=1 build):
wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross
chmod +x ~/bin/make.cross
# https://github.com/intel-lab-lkp/linux/commit/c8b669e1d139e1ee08121b184d859e45d7a02940
git remote add linux-review https://github.com/intel-lab-lkp/linux
git fetch --no-tags linux-review Rae-Moar/kunit-fix-bug-in-debugfs-logs-of-parameterized-tests/20230201-060537
git checkout c8b669e1d139e1ee08121b184d859e45d7a02940
# save the config file
mkdir build_dir && cp config build_dir/.config
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=clang make.cross W=1 O=build_dir ARCH=hexagon olddefconfig
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=clang make.cross W=1 O=build_dir ARCH=hexagon SHELL=/bin/bash lib/kunit/
If you fix the issue, kindly add following tag where applicable
| Reported-by: kernel test robot <lkp@intel.com>
All warnings (new ones prefixed by >>):
>> lib/kunit/test.c:115:6: warning: stack frame size (1536) exceeds limit (1024) in 'kunit_log_append' [-Wframe-larger-than]
void kunit_log_append(char *log, const char *fmt, ...)
^
12/1536 (0.78%) spills, 1524/1536 (99.22%) variables
1 warning generated.
vim +/kunit_log_append +115 lib/kunit/test.c
acd8e8407b8fcc David Gow 2021-08-03 110
e2219db280e3fe Alan Maguire 2020-03-26 111 /*
e2219db280e3fe Alan Maguire 2020-03-26 112 * Append formatted message to log, size of which is limited to
e2219db280e3fe Alan Maguire 2020-03-26 113 * KUNIT_LOG_SIZE bytes (including null terminating byte).
e2219db280e3fe Alan Maguire 2020-03-26 114 */
e2219db280e3fe Alan Maguire 2020-03-26 @115 void kunit_log_append(char *log, const char *fmt, ...)
e2219db280e3fe Alan Maguire 2020-03-26 116 {
e2219db280e3fe Alan Maguire 2020-03-26 117 char line[KUNIT_LOG_SIZE];
e2219db280e3fe Alan Maguire 2020-03-26 118 va_list args;
e2219db280e3fe Alan Maguire 2020-03-26 119 int len_left;
e2219db280e3fe Alan Maguire 2020-03-26 120
e2219db280e3fe Alan Maguire 2020-03-26 121 if (!log)
e2219db280e3fe Alan Maguire 2020-03-26 122 return;
e2219db280e3fe Alan Maguire 2020-03-26 123
e2219db280e3fe Alan Maguire 2020-03-26 124 len_left = KUNIT_LOG_SIZE - strlen(log) - 1;
e2219db280e3fe Alan Maguire 2020-03-26 125 if (len_left <= 0)
e2219db280e3fe Alan Maguire 2020-03-26 126 return;
e2219db280e3fe Alan Maguire 2020-03-26 127
e2219db280e3fe Alan Maguire 2020-03-26 128 va_start(args, fmt);
e2219db280e3fe Alan Maguire 2020-03-26 129 vsnprintf(line, sizeof(line), fmt, args);
e2219db280e3fe Alan Maguire 2020-03-26 130 va_end(args);
e2219db280e3fe Alan Maguire 2020-03-26 131
e2219db280e3fe Alan Maguire 2020-03-26 132 strncat(log, line, len_left);
e2219db280e3fe Alan Maguire 2020-03-26 133 }
e2219db280e3fe Alan Maguire 2020-03-26 134 EXPORT_SYMBOL_GPL(kunit_log_append);
e2219db280e3fe Alan Maguire 2020-03-26 135
On Wed, 1 Feb 2023 at 06:04, Rae Moar <rmoar@google.com> wrote: > > Fix bug in debugfs logs that causes parameterized results to not appear > in the log because the log is reintialized (cleared) when each parameter is Nit: s/reintialized/reinitialized > run. > > Ensure these results appear in the debugfs logs and increase log size to > allow for the size of parameterized results. > > Signed-off-by: Rae Moar <rmoar@google.com> > --- This looks pretty good to me, but we may need to restrict the size of a single log line separately from that of the whole log. (It'd also be nice to include a before/after in the commit description.) With the stack size issue fixed, though, this looks good to me: Reviewed-by: David Gow <davidgow@google.com> Cheers, -- David > include/kunit/test.h | 2 +- > lib/kunit/test.c | 3 ++- > 2 files changed, 3 insertions(+), 2 deletions(-) > > diff --git a/include/kunit/test.h b/include/kunit/test.h > index 87ea90576b50..0a077a4c067c 100644 > --- a/include/kunit/test.h > +++ b/include/kunit/test.h > @@ -34,7 +34,7 @@ DECLARE_STATIC_KEY_FALSE(kunit_running); > struct kunit; > > /* Size of log associated with test. */ > -#define KUNIT_LOG_SIZE 512 > +#define KUNIT_LOG_SIZE 1500 This is used both as the overall log size, and the size of a single line in kunit_log_append. As the latter involves a local 'line' array, it can bloat out stack usage. Could we either restrict the maximum line length separately, or rework kunit_log_append() to not use a local variable? (I imagine we could just vsnprintf() directly into the log buffer. We could make two sprintf calls to calculate the length required to maintain some atomicity as well (this could open us up to time-of-check/time-of-use vulnerabilities, but I think the vulnerability ship has sailed if you're passing untrusted pointers into the kunit_log macro anyway)) > > /* Maximum size of parameter description string. */ > #define KUNIT_PARAM_DESC_SIZE 128 > diff --git a/lib/kunit/test.c b/lib/kunit/test.c > index 51cae59d8aae..66ba93b8222c 100644 > --- a/lib/kunit/test.c > +++ b/lib/kunit/test.c > @@ -437,7 +437,6 @@ static void kunit_run_case_catch_errors(struct kunit_suite *suite, > struct kunit_try_catch_context context; > struct kunit_try_catch *try_catch; > > - kunit_init_test(test, test_case->name, test_case->log); > try_catch = &test->try_catch; > > kunit_try_catch_init(try_catch, > @@ -533,6 +532,8 @@ int kunit_run_tests(struct kunit_suite *suite) > struct kunit_result_stats param_stats = { 0 }; > test_case->status = KUNIT_SKIPPED; > > + kunit_init_test(&test, test_case->name, test_case->log); > + > if (!test_case->generate_params) { > /* Non-parameterised test. */ > kunit_run_case_catch_errors(suite, test_case, &test); > -- > 2.39.1.456.gfc5497dd1b-goog >
On Thu, Feb 9, 2023 at 12:06 AM David Gow <davidgow@google.com> wrote: > > On Wed, 1 Feb 2023 at 06:04, Rae Moar <rmoar@google.com> wrote: > > > > Fix bug in debugfs logs that causes parameterized results to not appear > > in the log because the log is reintialized (cleared) when each parameter is > Hi David! > Nit: s/reintialized/reinitialized > Oops. Thanks for pointing this out. Will fix in v2. > > run. > > > > Ensure these results appear in the debugfs logs and increase log size to > > allow for the size of parameterized results. > > > > Signed-off-by: Rae Moar <rmoar@google.com> > > --- > > This looks pretty good to me, but we may need to restrict the size of > a single log line separately from that of the whole log. > > (It'd also be nice to include a before/after in the commit description.) Yes, as mentioned in the other patches, I will add an individual "before and after" comparison to each of the patches in v2. This is much clearer than just the overall comparison in the cover letter. > > With the stack size issue fixed, though, this looks good to me: > Reviewed-by: David Gow <davidgow@google.com> > > Cheers, > -- David > > > include/kunit/test.h | 2 +- > > lib/kunit/test.c | 3 ++- > > 2 files changed, 3 insertions(+), 2 deletions(-) > > > > diff --git a/include/kunit/test.h b/include/kunit/test.h > > index 87ea90576b50..0a077a4c067c 100644 > > --- a/include/kunit/test.h > > +++ b/include/kunit/test.h > > @@ -34,7 +34,7 @@ DECLARE_STATIC_KEY_FALSE(kunit_running); > > struct kunit; > > > > /* Size of log associated with test. */ > > -#define KUNIT_LOG_SIZE 512 > > +#define KUNIT_LOG_SIZE 1500 > > This is used both as the overall log size, and the size of a single > line in kunit_log_append. > > As the latter involves a local 'line' array, it can bloat out stack usage. > > Could we either restrict the maximum line length separately, or rework > kunit_log_append() to not use a local variable? > (I imagine we could just vsnprintf() directly into the log buffer. We > could make two sprintf calls to calculate the length required to > maintain some atomicity as well (this could open us up to > time-of-check/time-of-use vulnerabilities, but I think the > vulnerability ship has sailed if you're passing untrusted pointers > into the kunit_log macro anyway)) > Thanks for your help here. I will play around with these two options. Although, I think I am leaning toward restricting the maximum line length separately. Thanks! -Rae > > > > /* Maximum size of parameter description string. */ > > #define KUNIT_PARAM_DESC_SIZE 128 > > diff --git a/lib/kunit/test.c b/lib/kunit/test.c > > index 51cae59d8aae..66ba93b8222c 100644 > > --- a/lib/kunit/test.c > > +++ b/lib/kunit/test.c > > @@ -437,7 +437,6 @@ static void kunit_run_case_catch_errors(struct kunit_suite *suite, > > struct kunit_try_catch_context context; > > struct kunit_try_catch *try_catch; > > > > - kunit_init_test(test, test_case->name, test_case->log); > > try_catch = &test->try_catch; > > > > kunit_try_catch_init(try_catch, > > @@ -533,6 +532,8 @@ int kunit_run_tests(struct kunit_suite *suite) > > struct kunit_result_stats param_stats = { 0 }; > > test_case->status = KUNIT_SKIPPED; > > > > + kunit_init_test(&test, test_case->name, test_case->log); > > + > > if (!test_case->generate_params) { > > /* Non-parameterised test. */ > > kunit_run_case_catch_errors(suite, test_case, &test); > > -- > > 2.39.1.456.gfc5497dd1b-goog > >
diff --git a/include/kunit/test.h b/include/kunit/test.h index 87ea90576b50..0a077a4c067c 100644 --- a/include/kunit/test.h +++ b/include/kunit/test.h @@ -34,7 +34,7 @@ DECLARE_STATIC_KEY_FALSE(kunit_running); struct kunit; /* Size of log associated with test. */ -#define KUNIT_LOG_SIZE 512 +#define KUNIT_LOG_SIZE 1500 /* Maximum size of parameter description string. */ #define KUNIT_PARAM_DESC_SIZE 128 diff --git a/lib/kunit/test.c b/lib/kunit/test.c index 51cae59d8aae..66ba93b8222c 100644 --- a/lib/kunit/test.c +++ b/lib/kunit/test.c @@ -437,7 +437,6 @@ static void kunit_run_case_catch_errors(struct kunit_suite *suite, struct kunit_try_catch_context context; struct kunit_try_catch *try_catch; - kunit_init_test(test, test_case->name, test_case->log); try_catch = &test->try_catch; kunit_try_catch_init(try_catch, @@ -533,6 +532,8 @@ int kunit_run_tests(struct kunit_suite *suite) struct kunit_result_stats param_stats = { 0 }; test_case->status = KUNIT_SKIPPED; + kunit_init_test(&test, test_case->name, test_case->log); + if (!test_case->generate_params) { /* Non-parameterised test. */ kunit_run_case_catch_errors(suite, test_case, &test);
Fix bug in debugfs logs that causes parameterized results to not appear in the log because the log is reintialized (cleared) when each parameter is run. Ensure these results appear in the debugfs logs and increase log size to allow for the size of parameterized results. Signed-off-by: Rae Moar <rmoar@google.com> --- include/kunit/test.h | 2 +- lib/kunit/test.c | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-)