cgroup/tracing: Move taking of spin lock out of trace event handlers

It is unwise to take spin locks from the handlers of trace events.
Mainly, because they can introduce lockups, because it introduces locks
in places that are normally not tested. Worse yet, because trace events
are tucked away in the include/trace/events/ directory, locks that are
taken there are forgotten about.

As a general rule, I tell people never to take any locks in a trace
event handler.

Several cgroup trace event handlers call cgroup_path() which eventually
takes the kernfs_rename_lock spinlock. This injects the spinlock in the
code without people realizing it. It also can cause issues for the
PREEMPT_RT patch, as the spinlock becomes a mutex, and the trace event
handlers are called with preemption disabled.

By moving the calculation of the cgroup_path() out of the trace event
handlers and into a macro (surrounded by a
trace_cgroup_##type##_enabled()), then we could place the cgroup_path
into a string, and pass that to the trace event. Not only does this
remove the taking of the spinlock out of the trace event handler, but
it also means that the cgroup_path() only needs to be called once (it
is currently called twice, once to get the length to reserver the
buffer for, and once again to get the path itself. Now it only needs to
be done once.

Reported-by: Sebastian Andrzej Siewior <bigeasy@linutronix.de>
Signed-off-by: Steven Rostedt (VMware) <rostedt@goodmis.org>
Signed-off-by: Tejun Heo <tj@kernel.org>

1 files changed, 23 insertions, 24 deletions

diff --git a/include/trace/events/cgroup.h b/include/trace/events/cgroup.h
index d74722c2ac8b..a401ff5e7847 100644
--- a/include/trace/events/cgroup.h
+++ b/include/trace/events/cgroup.h
@@ -53,24 +53,22 @@ DEFINE_EVENT(cgroup_root, cgroup_remount,
 
 DECLARE_EVENT_CLASS(cgroup,
 
-        TP_PROTO(struct cgroup *cgrp),
+        TP_PROTO(struct cgroup *cgrp, const char *path),
 
-        TP_ARGS(cgrp),
+        TP_ARGS(cgrp, path),
 
         TP_STRUCT__entry(
                 __field(        int,            root                    )
                 __field(        int,            id                      )
                 __field(        int,            level                   )
-                __dynamic_array(char,           path,
-                                cgroup_path(cgrp, NULL, 0) + 1)
+                __string(       path,           path                    )
         ),
 
         TP_fast_assign(
                 __entry->root = cgrp->root->hierarchy_id;
                 __entry->id = cgrp->id;
                 __entry->level = cgrp->level;
-                cgroup_path(cgrp, __get_dynamic_array(path),
-                                  __get_dynamic_array_len(path));
+                __assign_str(path, path);
         ),
 
         TP_printk("root=%d id=%d level=%d path=%s",
@@ -79,45 +77,45 @@ DECLARE_EVENT_CLASS(cgroup,
 
 DEFINE_EVENT(cgroup, cgroup_mkdir,
 
-        TP_PROTO(struct cgroup *cgroup),
+        TP_PROTO(struct cgroup *cgrp, const char *path),
 
-        TP_ARGS(cgroup)
+        TP_ARGS(cgrp, path)
 );
 
 DEFINE_EVENT(cgroup, cgroup_rmdir,
 
-        TP_PROTO(struct cgroup *cgroup),
+        TP_PROTO(struct cgroup *cgrp, const char *path),
 
-        TP_ARGS(cgroup)
+        TP_ARGS(cgrp, path)
 );
 
 DEFINE_EVENT(cgroup, cgroup_release,
 
-        TP_PROTO(struct cgroup *cgroup),
+        TP_PROTO(struct cgroup *cgrp, const char *path),
 
-        TP_ARGS(cgroup)
+        TP_ARGS(cgrp, path)
 );
 
 DEFINE_EVENT(cgroup, cgroup_rename,
 
-        TP_PROTO(struct cgroup *cgroup),
+        TP_PROTO(struct cgroup *cgrp, const char *path),
 
-        TP_ARGS(cgroup)
+        TP_ARGS(cgrp, path)
 );
 
 DECLARE_EVENT_CLASS(cgroup_migrate,
 
-        TP_PROTO(struct cgroup *dst_cgrp, struct task_struct *task, bool threadgroup),
+        TP_PROTO(struct cgroup *dst_cgrp, const char *path,
+                 struct task_struct *task, bool threadgroup),
 
-        TP_ARGS(dst_cgrp, task, threadgroup),
+        TP_ARGS(dst_cgrp, path, task, threadgroup),
 
         TP_STRUCT__entry(
                 __field(        int,            dst_root                )
                 __field(        int,            dst_id                  )
                 __field(        int,            dst_level               )
-                __dynamic_array(char,           dst_path,
-                                cgroup_path(dst_cgrp, NULL, 0) + 1)
                 __field(        int,            pid                     )
+                __string(       dst_path,       path                    )
                 __string(       comm,           task->comm              )
         ),
 
@@ -125,8 +123,7 @@ DECLARE_EVENT_CLASS(cgroup_migrate,
                 __entry->dst_root = dst_cgrp->root->hierarchy_id;
                 __entry->dst_id = dst_cgrp->id;
                 __entry->dst_level = dst_cgrp->level;
-                cgroup_path(dst_cgrp, __get_dynamic_array(dst_path),
-                                      __get_dynamic_array_len(dst_path));
+                __assign_str(dst_path, path);
                 __entry->pid = task->pid;
                 __assign_str(comm, task->comm);
         ),
@@ -138,16 +135,18 @@ DECLARE_EVENT_CLASS(cgroup_migrate,
 
 DEFINE_EVENT(cgroup_migrate, cgroup_attach_task,
 
-        TP_PROTO(struct cgroup *dst_cgrp, struct task_struct *task, bool threadgroup),
+        TP_PROTO(struct cgroup *dst_cgrp, const char *path,
+                 struct task_struct *task, bool threadgroup),
 
-        TP_ARGS(dst_cgrp, task, threadgroup)
+        TP_ARGS(dst_cgrp, path, task, threadgroup)
 );
 
 DEFINE_EVENT(cgroup_migrate, cgroup_transfer_tasks,
 
-        TP_PROTO(struct cgroup *dst_cgrp, struct task_struct *task, bool threadgroup),
+        TP_PROTO(struct cgroup *dst_cgrp, const char *path,
+                 struct task_struct *task, bool threadgroup),
 
-        TP_ARGS(dst_cgrp, task, threadgroup)
+        TP_ARGS(dst_cgrp, path, task, threadgroup)
 );
 
 #endif /* _TRACE_CGROUP_H */