Skip to content

Commit 0113d46

Browse files
beaubelgraverostedt
authored andcommitted
tracing/user_events: Document auto-cleanup and remove dyn_event refs
Now user_events auto-cleanup upon the last reference by default. This makes it not possible to use the dynamics event file via tracefs. Document that auto-cleanup is enabled by default and remove the refernce to /sys/kernel/tracing/dynamic_events file to make this clear. Link: https://lkml.kernel.org/r/[email protected] Signed-off-by: Beau Belgrave <[email protected]> Signed-off-by: Steven Rostedt (Google) <[email protected]>
1 parent 6170124 commit 0113d46

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

Documentation/trace/user_events.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,6 @@ Programs can view status of the events via
1414
/sys/kernel/tracing/user_events_status and can both register and write
1515
data out via /sys/kernel/tracing/user_events_data.
1616

17-
Programs can also use /sys/kernel/tracing/dynamic_events to register and
18-
delete user based events via the u: prefix. The format of the command to
19-
dynamic_events is the same as the ioctl with the u: prefix applied.
20-
2117
Typically programs will register a set of events that they wish to expose to
2218
tools that can read trace_events (such as ftrace and perf). The registration
2319
process tells the kernel which address and bit to reflect if any tool has
@@ -144,6 +140,9 @@ its name. Delete will only succeed if there are no references left to the
144140
event (in both user and kernel space). User programs should use a separate file
145141
to request deletes than the one used for registration due to this.
146142

143+
**NOTE:** By default events will auto-delete when there are no references left
144+
to the event. Flags in the future may change this logic.
145+
147146
Unregistering
148147
-------------
149148
If after registering an event it is no longer wanted to be updated then it can

0 commit comments

Comments
 (0)