2 * Infrastructure for statistic tracing (histogram output).
4 * Copyright (C) 2008-2009 Frederic Weisbecker <fweisbec@gmail.com>
6 * Based on the code from trace_branch.c which is
7 * Copyright (C) 2008 Steven Rostedt <srostedt@redhat.com>
12 #include <linux/list.h>
13 #include <linux/rbtree.h>
14 #include <linux/debugfs.h>
15 #include "trace_stat.h"
20 * List of stat red-black nodes from a tracer
21 * We use a such tree to sort quickly the stat
22 * entries from the tracer.
29 /* A stat session is the stats output in one file */
31 struct list_head session_list;
32 struct tracer_stat *ts;
33 struct rb_root stat_root;
34 struct mutex stat_mutex;
38 /* All of the sessions currently in use. Each stat file embed one session */
39 static LIST_HEAD(all_stat_sessions);
40 static DEFINE_MUTEX(all_stat_sessions_mutex);
42 /* The root directory for all stat files */
43 static struct dentry *stat_dir;
46 * Iterate through the rbtree using a post order traversal path
47 * to release the next node.
48 * It won't necessary release one at each iteration
49 * but it will at least advance closer to the next one
52 static struct rb_node *release_next(struct rb_node *node)
54 struct stat_node *snode;
55 struct rb_node *parent = rb_parent(node);
59 else if (node->rb_right)
60 return node->rb_right;
64 else if (parent->rb_left == node)
65 parent->rb_left = NULL;
67 parent->rb_right = NULL;
69 snode = container_of(node, struct stat_node, node);
76 static void __reset_stat_session(struct stat_session *session)
78 struct rb_node *node = session->stat_root.rb_node;
81 node = release_next(node);
83 session->stat_root = RB_ROOT;
86 static void reset_stat_session(struct stat_session *session)
88 mutex_lock(&session->stat_mutex);
89 __reset_stat_session(session);
90 mutex_unlock(&session->stat_mutex);
93 static void destroy_session(struct stat_session *session)
95 debugfs_remove(session->file);
96 __reset_stat_session(session);
97 mutex_destroy(&session->stat_mutex);
101 typedef int (*cmp_stat_t)(void *, void *);
103 static int insert_stat(struct rb_root *root, void *stat, cmp_stat_t cmp)
105 struct rb_node **new = &(root->rb_node), *parent = NULL;
106 struct stat_node *data;
108 data = kzalloc(sizeof(*data), GFP_KERNEL);
114 * Figure out where to put new node
115 * This is a descendent sorting
118 struct stat_node *this;
121 this = container_of(*new, struct stat_node, node);
122 result = cmp(data->stat, this->stat);
126 new = &((*new)->rb_left);
128 new = &((*new)->rb_right);
131 rb_link_node(&data->node, parent, new);
132 rb_insert_color(&data->node, root);
137 * For tracers that don't provide a stat_cmp callback.
138 * This one will force an insertion as right-most node
141 static int dummy_cmp(void *p1, void *p2)
147 * Initialize the stat rbtree at each trace_stat file opening.
148 * All of these copies and sorting are required on all opening
149 * since the stats could have changed between two file sessions.
151 static int stat_seq_init(struct stat_session *session)
153 struct tracer_stat *ts = session->ts;
154 struct rb_root *root = &session->stat_root;
159 mutex_lock(&session->stat_mutex);
160 __reset_stat_session(session);
163 ts->stat_cmp = dummy_cmp;
165 stat = ts->stat_start(ts);
169 ret = insert_stat(root, stat, ts->stat_cmp);
174 * Iterate over the tracer stat entries and store them in an rbtree.
177 stat = ts->stat_next(stat, i);
179 /* End of insertion */
183 ret = insert_stat(root, stat, ts->stat_cmp);
185 goto exit_free_rbtree;
189 mutex_unlock(&session->stat_mutex);
193 __reset_stat_session(session);
194 mutex_unlock(&session->stat_mutex);
199 static void *stat_seq_start(struct seq_file *s, loff_t *pos)
201 struct stat_session *session = s->private;
202 struct rb_node *node;
205 /* Prevent from tracer switch or rbtree modification */
206 mutex_lock(&session->stat_mutex);
208 /* If we are in the beginning of the file, print the headers */
209 if (!*pos && session->ts->stat_headers)
210 return SEQ_START_TOKEN;
212 node = rb_first(&session->stat_root);
213 for (i = 0; node && i < *pos; i++)
214 node = rb_next(node);
219 static void *stat_seq_next(struct seq_file *s, void *p, loff_t *pos)
221 struct stat_session *session = s->private;
222 struct rb_node *node = p;
226 if (p == SEQ_START_TOKEN)
227 return rb_first(&session->stat_root);
229 return rb_next(node);
232 static void stat_seq_stop(struct seq_file *s, void *p)
234 struct stat_session *session = s->private;
235 mutex_unlock(&session->stat_mutex);
238 static int stat_seq_show(struct seq_file *s, void *v)
240 struct stat_session *session = s->private;
241 struct stat_node *l = container_of(v, struct stat_node, node);
243 if (v == SEQ_START_TOKEN)
244 return session->ts->stat_headers(s);
246 return session->ts->stat_show(s, l->stat);
249 static const struct seq_operations trace_stat_seq_ops = {
250 .start = stat_seq_start,
251 .next = stat_seq_next,
252 .stop = stat_seq_stop,
253 .show = stat_seq_show
256 /* The session stat is refilled and resorted at each stat file opening */
257 static int tracing_stat_open(struct inode *inode, struct file *file)
261 struct stat_session *session = inode->i_private;
263 ret = stat_seq_init(session);
267 ret = seq_open(file, &trace_stat_seq_ops);
269 reset_stat_session(session);
273 m = file->private_data;
274 m->private = session;
279 * Avoid consuming memory with our now useless rbtree.
281 static int tracing_stat_release(struct inode *i, struct file *f)
283 struct stat_session *session = i->i_private;
285 reset_stat_session(session);
287 return seq_release(i, f);
290 static const struct file_operations tracing_stat_fops = {
291 .open = tracing_stat_open,
294 .release = tracing_stat_release
297 static int tracing_stat_init(void)
299 struct dentry *d_tracing;
301 d_tracing = tracing_init_dentry();
303 stat_dir = debugfs_create_dir("trace_stat", d_tracing);
305 pr_warning("Could not create debugfs "
306 "'trace_stat' entry\n");
310 static int init_stat_file(struct stat_session *session)
312 if (!stat_dir && tracing_stat_init())
315 session->file = debugfs_create_file(session->ts->name, 0644,
317 session, &tracing_stat_fops);
323 int register_stat_tracer(struct tracer_stat *trace)
325 struct stat_session *session, *node;
331 if (!trace->stat_start || !trace->stat_next || !trace->stat_show)
334 /* Already registered? */
335 mutex_lock(&all_stat_sessions_mutex);
336 list_for_each_entry(node, &all_stat_sessions, session_list) {
337 if (node->ts == trace) {
338 mutex_unlock(&all_stat_sessions_mutex);
342 mutex_unlock(&all_stat_sessions_mutex);
344 /* Init the session */
345 session = kzalloc(sizeof(*session), GFP_KERNEL);
350 INIT_LIST_HEAD(&session->session_list);
351 mutex_init(&session->stat_mutex);
353 ret = init_stat_file(session);
355 destroy_session(session);
360 mutex_lock(&all_stat_sessions_mutex);
361 list_add_tail(&session->session_list, &all_stat_sessions);
362 mutex_unlock(&all_stat_sessions_mutex);
367 void unregister_stat_tracer(struct tracer_stat *trace)
369 struct stat_session *node, *tmp;
371 mutex_lock(&all_stat_sessions_mutex);
372 list_for_each_entry_safe(node, tmp, &all_stat_sessions, session_list) {
373 if (node->ts == trace) {
374 list_del(&node->session_list);
375 destroy_session(node);
379 mutex_unlock(&all_stat_sessions_mutex);