tracing: Add trace_array_init_printk() to initialize instance trace_printk() buffers
Steven Rostedt
maintainerFrom: "Steven Rostedt (VMware)" <[email protected]>
As trace_array_printk() used with not global instances will not add noise to the main buffer, they are OK to have in the kernel (unlike trace_printk()). This require the subsystem to create their own tracing instance, and the trace_array_printk() only writes into those instances.
Add trace_array_init_printk() to initialize the trace_printk() buffers without printing out the WARNING message.
--- kernel/trace/trace.c | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+)
kernel/trace/trace.c +43 -0
@@ -3129,6 +3129,9 @@ static int alloc_percpu_trace_buffer(void) {struct trace_buffer_struct *buffers; +if (trace_percpu_buffer) +return 0 ; + buffers = alloc_percpu(struct trace_buffer_struct);if (MEM_FAIL (!buffers,"Could not allocate percpu trace_printk buffer" ))return -ENOMEM ;
@@ -3331,6 +3334,26 @@ int trace_array_vprintk(struct trace_array *tr,return __trace_array_vprintk (tr->array_buffer.buffer, ip, fmt, args); } +/** +* trace_array_printk - Print a message to a specific instance +* @tr: The instance trace_array descriptor +* @ip: The instruction pointer that this is called from. +* @fmt: The format to print (printf format) +* +* If a subsystem sets up its own instance, they have the right to +* printk strings into their tracing instance buffer using this +* function. Note, this function will not write into the top level +* buffer (use trace_printk() for that), as writing into the top level +* buffer should only have events that can be individually disabled. +* trace_printk() is only used for debugging a kernel, and should not +* be ever encorporated in normal use. +* +* trace_array_printk() can be used, as it will not add noise to the +* top level tracing buffer. +* +* Note, trace_array_init_printk() must be called on @tr before this +* can be used. +*/ __printf(3, 0)int trace_array_printk (struct trace_array *tr,unsigned long ip,const char *fmt, ...)
@@ -3355,6 +3378,26 @@ int trace_array_printk(struct trace_array *tr, }EXPORT_SYMBOL_GPL (trace_array_printk); +/** +* trace_array_init_printk - Initialize buffers for trace_array_printk() +* @tr: The trace array to initialize the buffers for +* +* As trace_array_printk() only writes into instances, they are OK to +* have in the kernel (unlike trace_printk()). This needs to be called +* before trace_array_printk() can be used on a trace_array. +*/ +int trace_array_init_printk (struct trace_array *tr) +{ +if (!tr) +return -ENOENT ; + +/* This is only allowed for created instances */ +if (tr == &global_trace) +return -EINVAL ; + +return alloc_percpu_trace_buffer (); +} + __printf(3, 4)int trace_array_printk_buf (struct trace_buffer *buffer,unsigned long ip,const char *fmt, ...)
Signature · 1 line
2.25.4
Sean Paul
Reviewed-byQuoted 8 lines · Steven Rostedt
From: "Steven Rostedt (VMware)" <[email protected]>
As
trace_array_printk()used with not global instances will not add noise to the main buffer, they are OK to have in the kernel (unliketrace_printk()). This require the subsystem to create their own tracing instance, and thetrace_array_printk()only writes into those instances.
Quoted 4 lines
Add
trace_array_init_printk()to initialize thetrace_printk()buffers without printing out the WARNING message.Reported-by Sean Paul <[email protected]>
With the addition of exporting the symbol (which you pointed out on IRC), this LGTM. Thanks again for being so accommodating!
Quoted 76 lines
Signed-off-by Steven Rostedt (VMware) <[email protected]>--- kernel/trace/trace.c | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+)kernel/trace/trace.c +43
-1@@ -3129,6 +3129,9 @@ static int alloc_percpu_trace_buffer(void) {struct trace_buffer_struct *buffers; +if (trace_percpu_buffer) +return 0 ; + buffers = alloc_percpu(struct trace_buffer_struct);if (MEM_FAIL (!buffers,"Could not allocate percpu trace_printk buffer" ))return -ENOMEM ;@@ -3331,6 +3334,26 @@ int trace_array_vprintk(struct trace_array *tr,return __trace_array_vprintk (tr->array_buffer.buffer, ip, fmt, args); } +/** +* trace_array_printk - Print a message to a specific instance +* @tr: The instance trace_array descriptor +* @ip: The instruction pointer that this is called from. +* @fmt: The format to print (printf format) +* +* If a subsystem sets up its own instance, they have the right to +* printk strings into their tracing instance buffer using this +* function. Note, this function will not write into the top level +* buffer (use trace_printk() for that), as writing into the top level +* buffer should only have events that can be individually disabled. +* trace_printk() is only used for debugging a kernel, and should not +* be ever encorporated in normal use. +* +* trace_array_printk() can be used, as it will not add noise to the +* top level tracing buffer. +* +* Note, trace_array_init_printk() must be called on @tr before this +* can be used. +*/ __printf(3, 0)int trace_array_printk (struct trace_array *tr,unsigned long ip,const char *fmt, ...)@@ -3355,6 +3378,26 @@ int trace_array_printk(struct trace_array *tr, }EXPORT_SYMBOL_GPL (trace_array_printk); +/** +* trace_array_init_printk - Initialize buffers for trace_array_printk() +* @tr: The trace array to initialize the buffers for +* +* As trace_array_printk() only writes into instances, they are OK to +* have in the kernel (unlike trace_printk()). This needs to be called +* before trace_array_printk() can be used on a trace_array. +*/ +int trace_array_init_printk (struct trace_array *tr) +{ +if (!tr) +return -ENOENT ; + +/* This is only allowed for created instances */ +if (tr == &global_trace) +return -EINVAL ; + +return alloc_percpu_trace_buffer (); +} + __printf(3, 4)int trace_array_printk_buf (struct trace_buffer *buffer,unsigned long ip,const char *fmt, ...) --2.25.4
kernel test robot
build botThank you for the patch! Perhaps something to improve:
Hi Steven,
Thank you for the patch! Perhaps something to improve:
[auto build test WARNING on tip/perf/core]
[also build test WARNING on linux/master linus/master v5.8 next-20200806] [If your patch is applied to the wrong git tree, kindly drop us a note. And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch]
url: https://github.com/0day-ci/linux/commits/Steven-Rostedt/tracing-Add-trace_array_init_printk-to-initialize-instance-trace_printk-buffers/20200807-005937 base: https://git.kernel.org/pub/scm/linux/kernel/git/tip/tip.git d903b6d029d66e6478562d75ea18d89098f7b7e8 config: i386-randconfig-r031-20200805 (attached as .config) compiler: gcc-9 (Debian 9.3.0-15) 9.3.0 reproduce (this is a W=1 build): # save the attached .config to linux build tree make W=1 ARCH=i386
If you fix the issue, kindly add following tag as appropriate
All warnings (new ones prefixed by >>):
>> kernel/trace/trace.c:3393:5: warning: no previous prototype for 'trace_array_init_printk' [-Wmissing-prototypes]
3393 | int trace_array_init_printk(struct trace_array *tr)
| ^~~~~~~~~~~~~~~~~~~~~~~
kernel/trace/trace.c:1535:37: warning: 'tracing_max_lat_fops' defined but not used [-Wunused-const-variable=]
1535 | static const struct file_operations tracing_max_lat_fops;
| ^~~~~~~~~~~~~~~~~~~~vim +/trace_array_init_printk +3393 kernel/trace/trace.c
3384
3385 /**
3386 * trace_array_init_printk - Initialize buffers for trace_array_printk()
3387 * @tr: The trace array to initialize the buffers for
3388 *
3389 * As trace_array_printk() only writes into instances, they are OK to
3390 * have in the kernel (unlike trace_printk()). This needs to be called
3391 * before trace_array_printk() can be used on a trace_array.
3392 */
> 3393 int trace_array_init_printk(struct trace_array *tr)
3394 {
3395 if (!tr)
3396 return -ENOENT;
3397
3398 /* This is only allowed for created instances */
3399 if (tr == &global_trace)
3400 return -EINVAL;
3401
3402 return alloc_percpu_trace_buffer();
3403 }
3404
---
0-DAY CI Kernel Test Service, Intel Corporation
https://lists.01.org/hyperkitty/list/kbuild-all(a)lists.01.org
kernel test robot
build botThank you for the patch! Perhaps something to improve:
Hi Steven,
Thank you for the patch! Perhaps something to improve:
[auto build test WARNING on tip/perf/core]
[also build test WARNING on linux/master linus/master v5.8 next-20200806] [If your patch is applied to the wrong git tree, kindly drop us a note. And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch]
url: https://github.com/0day-ci/linux/commits/Steven-Rostedt/tracing-Add-trace_array_init_printk-to-initialize-instance-trace_printk-buffers/20200807-005937 base: https://git.kernel.org/pub/scm/linux/kernel/git/tip/tip.git d903b6d029d66e6478562d75ea18d89098f7b7e8 config: riscv-randconfig-r035-20200805 (attached as .config) compiler: clang version 12.0.0 (https://github.com/llvm/llvm-project 076b120bebfd727b502208601012a44ab2e1028e)
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
# install riscv cross compiling tool for clang build
# apt-get install binutils-riscv64-linux-gnu
# save the attached .config to linux build tree
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=clang make.cross ARCH=riscv
If you fix the issue, kindly add following tag as appropriate
All warnings (new ones prefixed by >>):
In file included from include/linux/blk-cgroup.h:17:
In file included from include/linux/cgroup.h:26:
In file included from include/linux/kernel_stat.h:9:
In file included from include/linux/interrupt.h:11:
In file included from include/linux/hardirq.h:10:
In file included from ./arch/riscv/include/generated/asm/hardirq.h:1:
In file included from include/asm-generic/hardirq.h:13:
In file included from include/linux/irq.h:20:
In file included from include/linux/io.h:13:
In file included from arch/riscv/include/asm/io.h:148:
include/asm-generic/io.h:572:9: warning: performing pointer arithmetic on a null pointer has undefined behavior [-Wnull-pointer-arithmetic]
return inl(addr);
^~~~~~~~~
arch/riscv/include/asm/io.h:56:76: note: expanded from macro 'inl'
#define inl(c) ({ u32 __v; __io_pbr(); __v = readl_cpu((void*)(PCI_IOBASE + (c))); __io_par(__v); __v; })
~~~~~~~~~~ ^
arch/riscv/include/asm/mmio.h:95:76: note: expanded from macro 'readl_cpu'
#define readl_cpu(c) ({ u32 __r = le32_to_cpu((__force __le32)__raw_readl(c)); __r; })
^
include/uapi/linux/byteorder/little_endian.h:34:51: note: expanded from macro '__le32_to_cpu'
#define __le32_to_cpu(x) ((__force __u32)(__le32)(x))
^
In file included from kernel/trace/trace.c:18:
In file included from include/linux/writeback.h:14:
In file included from include/linux/blk-cgroup.h:17:
In file included from include/linux/cgroup.h:26:
In file included from include/linux/kernel_stat.h:9:
In file included from include/linux/interrupt.h:11:
In file included from include/linux/hardirq.h:10:
In file included from ./arch/riscv/include/generated/asm/hardirq.h:1:
In file included from include/asm-generic/hardirq.h:13:
In file included from include/linux/irq.h:20:
In file included from include/linux/io.h:13:
In file included from arch/riscv/include/asm/io.h:148:
include/asm-generic/io.h:580:2: warning: performing pointer arithmetic on a null pointer has undefined behavior [-Wnull-pointer-arithmetic]
outb(value, addr);
^~~~~~~~~~~~~~~~~
arch/riscv/include/asm/io.h:58:68: note: expanded from macro 'outb'
#define outb(v,c) ({ __io_pbw(); writeb_cpu((v),(void*)(PCI_IOBASE + (c))); __io_paw(); })
~~~~~~~~~~ ^
arch/riscv/include/asm/mmio.h:97:52: note: expanded from macro 'writeb_cpu'
#define writeb_cpu(v, c) ((void)__raw_writeb((v), (c)))
^
In file included from kernel/trace/trace.c:18:
In file included from include/linux/writeback.h:14:
In file included from include/linux/blk-cgroup.h:17:
In file included from include/linux/cgroup.h:26:
In file included from include/linux/kernel_stat.h:9:
In file included from include/linux/interrupt.h:11:
In file included from include/linux/hardirq.h:10:
In file included from ./arch/riscv/include/generated/asm/hardirq.h:1:
In file included from include/asm-generic/hardirq.h:13:
In file included from include/linux/irq.h:20:
In file included from include/linux/io.h:13:
In file included from arch/riscv/include/asm/io.h:148:
include/asm-generic/io.h:588:2: warning: performing pointer arithmetic on a null pointer has undefined behavior [-Wnull-pointer-arithmetic]
outw(value, addr);
^~~~~~~~~~~~~~~~~
arch/riscv/include/asm/io.h:59:68: note: expanded from macro 'outw'
#define outw(v,c) ({ __io_pbw(); writew_cpu((v),(void*)(PCI_IOBASE + (c))); __io_paw(); })
~~~~~~~~~~ ^
arch/riscv/include/asm/mmio.h:98:76: note: expanded from macro 'writew_cpu'
#define writew_cpu(v, c) ((void)__raw_writew((__force u16)cpu_to_le16(v), (c)))
^
In file included from kernel/trace/trace.c:18:
In file included from include/linux/writeback.h:14:
In file included from include/linux/blk-cgroup.h:17:
In file included from include/linux/cgroup.h:26:
In file included from include/linux/kernel_stat.h:9:
In file included from include/linux/interrupt.h:11:
In file included from include/linux/hardirq.h:10:
In file included from ./arch/riscv/include/generated/asm/hardirq.h:1:
In file included from include/asm-generic/hardirq.h:13:
In file included from include/linux/irq.h:20:
In file included from include/linux/io.h:13:
In file included from arch/riscv/include/asm/io.h:148:
include/asm-generic/io.h:596:2: warning: performing pointer arithmetic on a null pointer has undefined behavior [-Wnull-pointer-arithmetic]
outl(value, addr);
^~~~~~~~~~~~~~~~~
arch/riscv/include/asm/io.h:60:68: note: expanded from macro 'outl'
#define outl(v,c) ({ __io_pbw(); writel_cpu((v),(void*)(PCI_IOBASE + (c))); __io_paw(); })
~~~~~~~~~~ ^
arch/riscv/include/asm/mmio.h:99:76: note: expanded from macro 'writel_cpu'
#define writel_cpu(v, c) ((void)__raw_writel((__force u32)cpu_to_le32(v), (c)))
^
In file included from kernel/trace/trace.c:18:
In file included from include/linux/writeback.h:14:
In file included from include/linux/blk-cgroup.h:17:
In file included from include/linux/cgroup.h:26:
In file included from include/linux/kernel_stat.h:9:
In file included from include/linux/interrupt.h:11:
In file included from include/linux/hardirq.h:10:
In file included from ./arch/riscv/include/generated/asm/hardirq.h:1:
In file included from include/asm-generic/hardirq.h:13:
In file included from include/linux/irq.h:20:
In file included from include/linux/io.h:13:
In file included from arch/riscv/include/asm/io.h:148:
include/asm-generic/io.h:1017:55: warning: performing pointer arithmetic on a null pointer has undefined behavior [-Wnull-pointer-arithmetic]
return (port > MMIO_UPPER_LIMIT) ? NULL : PCI_IOBASE + port;
~~~~~~~~~~ ^
>> kernel/trace/trace.c:3393:5: warning: no previous prototype for function 'trace_array_init_printk' [-Wmissing-prototypes]
int trace_array_init_printk(struct trace_array *tr)
^ kernel/trace/trace.c:3393:1: note: declare 'static' if the function is not intended to be used outside of this translation unit int trace_array_init_printk(struct trace_array *tr)
^
static
8 warnings generated.
vim +/trace_array_init_printk +3393 kernel/trace/trace.c
3384
3385 /**
3386 * trace_array_init_printk - Initialize buffers for trace_array_printk()
3387 * @tr: The trace array to initialize the buffers for
3388 *
3389 * As trace_array_printk() only writes into instances, they are OK to
3390 * have in the kernel (unlike trace_printk()). This needs to be called
3391 * before trace_array_printk() can be used on a trace_array.
3392 */
> 3393 int trace_array_init_printk(struct trace_array *tr)
3394 {
3395 if (!tr)
3396 return -ENOENT;
3397
3398 /* This is only allowed for created instances */
3399 if (tr == &global_trace)
3400 return -EINVAL;
3401
3402 return alloc_percpu_trace_buffer();
3403 }
3404
---
0-DAY CI Kernel Test Service, Intel Corporation
https://lists.01.org/hyperkitty/list/kbuild-all(a)lists.01.org