Skip to contentSkip to conversation

tracing: Decrement trace_array when bootconfig creates an instance

PATCH In review Steven Rostedt 2 participants 3 messages Jan 25, 2020 Tracing

lore
Share & tools
lore

Steven Rostedt

author maintainer
#0 lore raw

PATCH 1/1 tracing: Decrement trace_array when bootconfig creates an instance

From: "Steven Rostedt (VMware)" <[email protected]>

The trace_array_get_by_name() creates a ftrace instance and trace_array_put() is used to remove the reference. Even though the trace_array_get_by_name() creates the instance, it also adds a reference count to it, that prevents user space from removing it.

As the bootconfig just creates the instance on boot up, it should still be used where it can be deleted by user space after boot. A trace_array_put() is required to let that happen. Otherwise, the created instance can not be removed.

Also, change the documentation on trace_array_get_by_name() to make this not be so confusing.

Fixes 4f712a4d04a4e ("tracing/boot: Add instance node support")
---
 kernel/trace/trace.c      | 4 ++++
 kernel/trace/trace_boot.c | 1 +
 2 files changed, 5 insertions(+)
kernel/trace/trace.c +4 -0
index 6fed9b0a8d58..0a5569b1cace 100644
@@ -8602,6 +8602,10 @@ static int instance_mkdir(const char *name)
  * NOTE: This function increments the reference counter associated with the
  * trace array returned. This makes sure it cannot be freed while in use.
  * Use trace_array_put() once the trace array is no longer needed.
+ * If the trace_array is to be freed, trace_array_destroy() needs to
+ * be called after the trace_array_put(), or simply let user space delete
+ * it from the tracefs instances directory. But until the
+ * trace_array_put() is called, user space can not delete it.
  *
  */
 struct trace_array *trace_array_get_by_name(const char *name)
kernel/trace/trace_boot.c +1 -0
index cd541ac1cbc1..2f616cd926b0 100644
@@ -327,6 +327,7 @@ trace_boot_init_instances(struct xbc_node *node)
 			continue;
 		}
 		trace_boot_init_one_instance(tr, inode);
+		trace_array_put(tr);
 	}
 }
 
Signature · 1 line
2.20.1
maintainer Acked-by on v1 1/1
#1 lore raw
Quoted 8 lines · On Fri, 24 Jan 2020 20:59:27 -0500 Steven Rostedt <[email protected]> wrote:

From: "Steven Rostedt (VMware)" <[email protected]>

The trace_array_get_by_name() creates a ftrace instance and trace_array_put() is used to remove the reference. Even though the trace_array_get_by_name() creates the instance, it also adds a reference count to it, that prevents user space from removing it.

Quoted 7 lines

As the bootconfig just creates the instance on boot up, it should still be used where it can be deleted by user space after boot. A trace_array_put() is required to let that happen. Otherwise, the created instance can not be removed.

Also, change the documentation on trace_array_get_by_name() to make this not be so confusing.

Good catch! I misunderstood trace_array_put() would remove the instance.

Thank you!

Quoted 38 lines
Fixes 4f712a4d04a4e ("tracing/boot: Add instance node support")
---
 kernel/trace/trace.c      | 4 ++++
 kernel/trace/trace_boot.c | 1 +
 2 files changed, 5 insertions(+)
kernel/trace/trace.c +4 -0
index 6fed9b0a8d58..0a5569b1cace 100644
@@ -8602,6 +8602,10 @@ static int instance_mkdir(const char *name)
  * NOTE: This function increments the reference counter associated with the
  * trace array returned. This makes sure it cannot be freed while in use.
  * Use trace_array_put() once the trace array is no longer needed.
+ * If the trace_array is to be freed, trace_array_destroy() needs to
+ * be called after the trace_array_put(), or simply let user space delete
+ * it from the tracefs instances directory. But until the
+ * trace_array_put() is called, user space can not delete it.
  *
  */
 struct trace_array *trace_array_get_by_name(const char *name)
kernel/trace/trace_boot.c +1 -0
index cd541ac1cbc1..2f616cd926b0 100644
@@ -327,6 +327,7 @@ trace_boot_init_instances(struct xbc_node *node)
 			continue;
 		}
 		trace_boot_init_one_instance(tr, inode);
+		trace_array_put(tr);
 	}
 }
 
Signature · 1 line
2.20.1
Signature · 1 line
Masami Hiramatsu <[email protected]>
author maintainer
#2 lore raw
Quoted 16 lines · On Sat, 25 Jan 2020 11:23:00 +0900 Masami Hiramatsu <[email protected]> wrote:
Quoted 13 lines · On Fri, 24 Jan 2020 20:59:27 -0500 Steven Rostedt <[email protected]> wrote:

From: "Steven Rostedt (VMware)" <[email protected]>

The trace_array_get_by_name() creates a ftrace instance and trace_array_put() is used to remove the reference. Even though the trace_array_get_by_name() creates the instance, it also adds a reference count to it, that prevents user space from removing it.

As the bootconfig just creates the instance on boot up, it should still be used where it can be deleted by user space after boot. A trace_array_put() is required to let that happen. Otherwise, the created instance can not be removed.

Quoted 4 lines
Quoted 2 lines

Also, change the documentation on trace_array_get_by_name() to make this not be so confusing.

Good catch! I misunderstood trace_array_put() would remove the instance.

I figured as much, which is why I included the documentation update.

Quoted 2 lines

Thanks!

-- Steve