diff mbox series

[3/4] tracing: Add trace_array_puts() to write into instance

Message ID 20230111145842.694147820@goodmis.org (mailing list archive)
State Superseded
Headers show
Series tracing: Addition of tracing instances via kernel command line | expand

Commit Message

Steven Rostedt Jan. 11, 2023, 2:56 p.m. UTC 
From: "Steven Rostedt (Google)" <rostedt@goodmis.org>

Add a generic trace_array_puts() that can be used to "trace_puts()" into
an allocated trace_array instance. This is just another variant of
trace_array_printk().

Signed-off-by: Steven Rostedt (Google) <rostedt@goodmis.org>
---
 include/linux/trace.h | 13 +++++++++++++
 kernel/trace/trace.c  | 27 +++++++++++++++++----------
 2 files changed, 30 insertions(+), 10 deletions(-)

Comments

Ross Zwisler Jan. 12, 2023, 11:26 p.m. UTC | #1 
On Wed, Jan 11, 2023 at 09:56:39AM -0500, Steven Rostedt wrote:
> From: "Steven Rostedt (Google)" <rostedt@goodmis.org>
> 
> Add a generic trace_array_puts() that can be used to "trace_puts()" into
> an allocated trace_array instance. This is just another variant of
> trace_array_printk().
> 
> Signed-off-by: Steven Rostedt (Google) <rostedt@goodmis.org>
> ---
>  include/linux/trace.h | 13 +++++++++++++
>  kernel/trace/trace.c  | 27 +++++++++++++++++----------
>  2 files changed, 30 insertions(+), 10 deletions(-)
> 
> diff --git a/include/linux/trace.h b/include/linux/trace.h
> index 80ffda871749..afe61949e83a 100644
> --- a/include/linux/trace.h
> +++ b/include/linux/trace.h
> @@ -33,6 +33,19 @@ struct trace_array;
>  int register_ftrace_export(struct trace_export *export);
>  int unregister_ftrace_export(struct trace_export *export);
>  
> +/**
> + * trace_array_puts - write a constant string into the trace buffer.
> + * @tr:    The trace array to write to
> + * @ip:	   The address of the caller

@ip is not an arg to trace_array_puts(), an can be dropped from the comment.

Other than that, you can add:

Reviewed-by: Ross Zwisler <zwisler@google.com>
Steven Rostedt Jan. 13, 2023, midnight UTC | #2 
On Thu, 12 Jan 2023 16:26:27 -0700
Ross Zwisler <zwisler@google.com> wrote:

> > +/**
> > + * trace_array_puts - write a constant string into the trace buffer.
> > + * @tr:    The trace array to write to
> > + * @ip:	   The address of the caller  
> 
> @ip is not an arg to trace_array_puts(), an can be dropped from the comment.

Good catch.

My first version had it, and then I realized I didn't like it (to be in
sync with the internal version of __trace_puts()". But I forgot to update
the kernel doc. Thanks for pointing that out.

> 
> Other than that, you can add:
> 
> Reviewed-by: Ross Zwisler <zwisler@google.com>

Thanks,

-- Steve
diff mbox series

Patch

diff --git a/include/linux/trace.h b/include/linux/trace.h
index 80ffda871749..afe61949e83a 100644
--- a/include/linux/trace.h
+++ b/include/linux/trace.h
@@ -33,6 +33,19 @@  struct trace_array;
 int register_ftrace_export(struct trace_export *export);
 int unregister_ftrace_export(struct trace_export *export);
 
+/**
+ * trace_array_puts - write a constant string into the trace buffer.
+ * @tr:    The trace array to write to
+ * @ip:	   The address of the caller
+ * @str:   The constant string to write
+ */
+#define trace_array_puts(tr, str)					\
+	({								\
+		str ? __trace_array_puts(tr, _THIS_IP_, str, strlen(str)) : -1;	\
+	})
+int __trace_array_puts(struct trace_array *tr, unsigned long ip,
+		       const char *str, int size);
+
 void trace_printk_init_buffers(void);
 __printf(3, 4)
 int trace_array_printk(struct trace_array *tr, unsigned long ip,
diff --git a/kernel/trace/trace.c b/kernel/trace/trace.c
index e8c52a8d712e..3cb9bbc0f076 100644
--- a/kernel/trace/trace.c
+++ b/kernel/trace/trace.c
@@ -1024,13 +1024,8 @@  __buffer_unlock_commit(struct trace_buffer *buffer, struct ring_buffer_event *ev
 		ring_buffer_unlock_commit(buffer);
 }
 
-/**
- * __trace_puts - write a constant string into the trace buffer.
- * @ip:	   The address of the caller
- * @str:   The constant string to write
- * @size:  The size of the string.
- */
-int __trace_puts(unsigned long ip, const char *str, int size)
+int __trace_array_puts(struct trace_array *tr, unsigned long ip,
+		       const char *str, int size)
 {
 	struct ring_buffer_event *event;
 	struct trace_buffer *buffer;
@@ -1038,7 +1033,7 @@  int __trace_puts(unsigned long ip, const char *str, int size)
 	unsigned int trace_ctx;
 	int alloc;
 
-	if (!(global_trace.trace_flags & TRACE_ITER_PRINTK))
+	if (!(tr->trace_flags & TRACE_ITER_PRINTK))
 		return 0;
 
 	if (unlikely(tracing_selftest_running || tracing_disabled))
@@ -1047,7 +1042,7 @@  int __trace_puts(unsigned long ip, const char *str, int size)
 	alloc = sizeof(*entry) + size + 2; /* possible \n added */
 
 	trace_ctx = tracing_gen_ctx();
-	buffer = global_trace.array_buffer.buffer;
+	buffer = tr->array_buffer.buffer;
 	ring_buffer_nest_start(buffer);
 	event = __trace_buffer_lock_reserve(buffer, TRACE_PRINT, alloc,
 					    trace_ctx);
@@ -1069,11 +1064,23 @@  int __trace_puts(unsigned long ip, const char *str, int size)
 		entry->buf[size] = '\0';
 
 	__buffer_unlock_commit(buffer, event);
-	ftrace_trace_stack(&global_trace, buffer, trace_ctx, 4, NULL);
+	ftrace_trace_stack(tr, buffer, trace_ctx, 4, NULL);
  out:
 	ring_buffer_nest_end(buffer);
 	return size;
 }
+EXPORT_SYMBOL_GPL(__trace_array_puts);
+
+/**
+ * __trace_puts - write a constant string into the trace buffer.
+ * @ip:	   The address of the caller
+ * @str:   The constant string to write
+ * @size:  The size of the string.
+ */
+int __trace_puts(unsigned long ip, const char *str, int size)
+{
+	return __trace_array_puts(&global_trace, ip, str, size);
+}
 EXPORT_SYMBOL_GPL(__trace_puts);
 
 /**