Skip to contentSkip to conversation

printk: add dummy vprintk_emit for when CONFIG_PRINTK=n

PATCH In review Brendan Higgins 3 participants 6 messages Aug 27, 2019 – Aug 28, 2019

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 printk: add dummy vprintk_emit for when CONFIG_PRINTK=n

Previously vprintk_emit was only defined when CONFIG_PRINTK=y, this caused a build failure in kunit/test.c when CONFIG_PRINTK was not set. Add a no-op dummy so that callers don't have to ifdef around this.

Note: It has been suggested that this go in through the kselftest tree along with the KUnit patches, because KUnit depends on this. See the second link for the discussion on this.

---
 include/linux/printk.h | 7 +++++++
 1 file changed, 7 insertions(+)
include/linux/printk.h +7 -0
index cefd374c47b1..85b7970615a9 100644
@@ -206,6 +206,13 @@ extern void printk_safe_init(void);
 extern void printk_safe_flush(void);
 extern void printk_safe_flush_on_panic(void);
 #else
+static inline __printf(5, 0)
+int vprintk_emit(int facility, int level,
+		 const char *dict, size_t dictlen,
+		 const char *fmt, va_list args)
+{
+	return 0;
+}
 static inline __printf(1, 0)
 int vprintk(const char *s, va_list args)
 {
Signature · 1 line
2.23.0.187.g17f5b7556c-goog
Acked-by on v1 1/1
#1 lore raw
Quoted 8 lines · Brendan Higgins

Previously vprintk_emit was only defined when CONFIG_PRINTK=y, this caused a build failure in kunit/test.c when CONFIG_PRINTK was not set. Add a no-op dummy so that callers don't have to ifdef around this.

Note: It has been suggested that this go in through the kselftest tree along with the KUnit patches, because KUnit depends on this. See the second link for the discussion on this.

Quoted 5 lines

Thanks.

Quoted 23 lines
---
 include/linux/printk.h | 7 +++++++
 1 file changed, 7 insertions(+)
include/linux/printk.h +7 -0
index cefd374c47b1..85b7970615a9 100644
@@ -206,6 +206,13 @@ extern void printk_safe_init(void);
 extern void printk_safe_flush(void);
 extern void printk_safe_flush_on_panic(void);
 #else
+static inline __printf(5, 0)
+int vprintk_emit(int facility, int level,
+		 const char *dict, size_t dictlen,
+		 const char *fmt, va_list args)
+{
+	return 0;
+}
 static inline __printf(1, 0)
 int vprintk(const char *s, va_list args)
 {
Signature · 1 line
~Randy
#2 lore raw
In reply to Brendan Higgins
Quoted 7 lines · Brendan Higgins

Previously vprintk_emit was only defined when CONFIG_PRINTK=y, this caused a build failure in kunit/test.c when CONFIG_PRINTK was not set. Add a no-op dummy so that callers don't have to ifdef around this.

Note: It has been suggested that this go in through the kselftest tree along with the KUnit patches, because KUnit depends on this. See the second link for the discussion on this.

Is there any reason for kunit to use vprintk_emit()? Can you switch to pr_err()/pr_info()/pr_foo()?

vprintk_emit() function is pretty internal. It's not static because drivers/base/core.c wants to add some extra payload to printk() messages (extended headers, etc).

	-ss
#3 lore raw
Quoted 9 lines · Sergey Senozhatsky
Quoted 7 lines · Brendan Higgins

Previously vprintk_emit was only defined when CONFIG_PRINTK=y, this caused a build failure in kunit/test.c when CONFIG_PRINTK was not set. Add a no-op dummy so that callers don't have to ifdef around this.

Note: It has been suggested that this go in through the kselftest tree along with the KUnit patches, because KUnit depends on this. See the second link for the discussion on this.

Quoted 6 lines

Is there any reason for kunit to use vprintk_emit()? Can you switch to pr_err()/pr_info()/pr_foo()?

vprintk_emit() function is pretty internal. It's not static because drivers/base/core.c wants to add some extra payload to printk() messages (extended headers, etc).

I actually use it in a very similar way as dev_printk() does. I am using it to define an equivalent kunit_printk(), which takes a log level, and adds its own test information to the log.

What I have now is:

static int kunit_vprintk_emit(int level, const char *fmt, va_list args)

{
	return vprintk_emit(0, level, NULL, 0, fmt, args);
}

static int kunit_printk_emit(int level, const char *fmt, ...)

{
	va_list args;
	int ret;

	va_start(args, fmt);
	ret = kunit_vprintk_emit(level, fmt, args);
	va_end(args);

	return ret;
}

static void kunit_vprintk(const struct kunit *test,
const char *level, struct va_format *vaf)

{
	kunit_printk_emit(level[1] - '0', "\t# %s: %pV", test->name, vaf);
}

The closest thing I can do without vprintk_emit is:

static void kunit_vprintk(const struct kunit *test,
const char *level, struct va_format *vaf)

{
	printk("%s\t# %s: %pV", level, test->name, vaf);
}

But checkpatch complains:

WARNING: printk() should include KERN_<LEVEL> facility level

Based on the printk() implementation, it looks like it should be fine to provide the level via format string since the formatting is performed before the log level is checked; nevertheless, it seemed to me like vprintk_emit was closer to what I wanted (again, it's what dev_printk uses). Shuah and Tim seemed to agree with me:

https://lore.kernel.org/linux-kselftest/[email protected]/

Nevertheless, I probably don't want add any custom dict entries.

Really, what I think I want is a printk_level().

Thoughts?

#4 lore raw

On (08/27/19 21:45), Brendan Higgins wrote:
[..]

Quoted 23 lines

I actually use it in a very similar way as dev_printk() does. I am using it to define an equivalent kunit_printk(), which takes a log level, and adds its own test information to the log.

What I have now is:

static int kunit_vprintk_emit(int level, const char *fmt, va_list args)

{
	return vprintk_emit(0, level, NULL, 0, fmt, args);
}

static int kunit_printk_emit(int level, const char *fmt, ...)

{
	va_list args;
	int ret;

	va_start(args, fmt);
	ret = kunit_vprintk_emit(level, fmt, args);
	va_end(args);

	return ret;
}
Quoted 6 lines

static void kunit_vprintk(const struct kunit *test,
const char *level, struct va_format *vaf)

{
	kunit_printk_emit(level[1] - '0', "\t# %s: %pV", test->name, vaf);
}

Basically, for prefixes we have pr_fmt().

#define pr_fmt(fmt) "module name: " fmt

but pr_fmt() is mostly for static prefixes. If that doesn't work for you, then maybe you can tweak kunit_foo() macros?

E.g. something like this

#define kunit_info(test, fmt, ...)                                   \
	printk(KERN_INFO "\t# %s: " pr_fmt(fmt), (test)->name, ##__VA_ARGS__)
#define kunit_err(test, fmt, ...)                                    \
	printk(KERN_ERR "\t# %s: " pr_fmt(fmt), (test)->name, ##__VA_ARGS__)
#define kunit_debug(test, fmt, ...)                                  \
	printk(KERN_DEBUG "\t# %s: " pr_fmt(fmt), (test)->name, ##__VA_ARGS__)

Would that do the trick? Am I missing something?

	-ss
#5 lore raw
Quoted 33 lines · Sergey Senozhatsky

On (08/27/19 21:45), Brendan Higgins wrote:
[..]

Quoted 23 lines

I actually use it in a very similar way as dev_printk() does. I am using it to define an equivalent kunit_printk(), which takes a log level, and adds its own test information to the log.

What I have now is:

static int kunit_vprintk_emit(int level, const char *fmt, va_list args)

{
      return vprintk_emit(0, level, NULL, 0, fmt, args);
}

static int kunit_printk_emit(int level, const char *fmt, ...)

{
      va_list args;
      int ret;

      va_start(args, fmt);
      ret = kunit_vprintk_emit(level, fmt, args);
      va_end(args);

      return ret;
}
Quoted 6 lines

static void kunit_vprintk(const struct kunit *test,
const char *level, struct va_format *vaf)

{
      kunit_printk_emit(level[1] - '0', "\t# %s: %pV", test->name, vaf);
}
Quoted 6 lines

Basically, for prefixes we have pr_fmt().

#define pr_fmt(fmt) "module name: " fmt

but pr_fmt() is mostly for static prefixes. If that doesn't work for you, then maybe you can tweak kunit_foo() macros?

That doesn't work. The prefix is dynamic.

Quoted 5 lines

E.g. something like this

#define kunit_info(test, fmt, ...)                                   \
        printk(KERN_INFO "\t# %s: " pr_fmt(fmt), (test)->name, ##__VA_ARGS__)
Quoted 7 lines
#define kunit_err(test, fmt, ...)                                    \
        printk(KERN_ERR "\t# %s: " pr_fmt(fmt), (test)->name, ##__VA_ARGS__)
#define kunit_debug(test, fmt, ...)                                  \
        printk(KERN_DEBUG "\t# %s: " pr_fmt(fmt), (test)->name, ##__VA_ARGS__)

Would that do the trick? Am I missing something?

This appears to work. I will send out a patch that incorporates this.

Thanks!