History

tracing: Make tracepoint_printk a static_key

Currently, when tracepoint_printk is set (enabled by the "tp_printk" kernel command line), it causes trace events to print via printk(). This is a very dangerous operation, but is useful for debugging. The issue is, it's seldom used, but it is always checked even if it's not enabled by the kernel command line. Instead of having this feature called by a branch against a variable, turn that variable into a static key, and this will remove the test and jump. To simplify things, the functions output_printk() and trace_event_buffer_commit() were moved from trace_events.c to trace.c.

Steven Rostedt (Red Hat) committed 9 years ago

Commit 42391741 parent 929ddbf4 files · +83 −41Browse files

Unified · Split

4 files
  1. include/linux/ftrace.h +4 −0
  2. kernel/sysctl.c +1 −1
  3. kernel/trace/trace.c +78 −0
  4. kernel/trace/trace_events.c +0 −40
include/linux/ftrace.h+4−0
@@ -945,6 +945,10 @@ extern int __disable_trace_on_warning; · 944 unmodified lines
945945 #define INIT_TRACE_RECURSION .trace_recursion = 0,
946946 #endif
947947
948+int tracepoint_printk_sysctl(struct ctl_table *table, int write,
949+ void __user *buffer, size_t *lenp,
950+ loff_t *ppos);
951+
948952 #else /* CONFIG_TRACING */
949953 static inline void disable_trace_on_warning(void) { }
950954 #endif /* CONFIG_TRACING */
kernel/sysctl.c+1−1
@@ -634,7 +634,7 @@ static struct ctl_table kern_table[] = { · 633 unmodified lines
634634 .data = &tracepoint_printk,
635635 .maxlen = sizeof(tracepoint_printk),
636636 .mode = 0644,
637− .proc_handler = proc_dointvec,
637+ .proc_handler = tracepoint_printk_sysctl,
638638 },
639639 #endif
640640 #ifdef CONFIG_KEXEC_CORE
kernel/trace/trace.c+78−0
@@ -69,6 +69,7 @@ bool __read_mostly tracing_selftest_disabled; · 68 unmodified lines
6969 /* Pipe tracepoints to printk */
7070 struct trace_iterator *tracepoint_print_iter;
7171 int tracepoint_printk;
72+static DEFINE_STATIC_KEY_FALSE(tracepoint_printk_key);
7273
7374 /* For tracers that don't implement custom flags */
7475 static struct tracer_opt dummy_tracer_opt[] = {
@@ -2116,6 +2117,81 @@ trace_event_buffer_lock_reserve(struct ring_buffer **current_rb, · 2041 unmodified lines
21162117 }
21172118 EXPORT_SYMBOL_GPL(trace_event_buffer_lock_reserve);
21182119
2120+static DEFINE_SPINLOCK(tracepoint_iter_lock);
2121+static DEFINE_MUTEX(tracepoint_printk_mutex);
2122+
2123+static void output_printk(struct trace_event_buffer *fbuffer)
2124+{
2125+ struct trace_event_call *event_call;
2126+ struct trace_event *event;
2127+ unsigned long flags;
2128+ struct trace_iterator *iter = tracepoint_print_iter;
2129+
2130+ /* We should never get here if iter is NULL */
2131+ if (WARN_ON_ONCE(!iter))
2132+ return;
2133+
2134+ event_call = fbuffer->trace_file->event_call;
2135+ if (!event_call || !event_call->event.funcs ||
2136+ !event_call->event.funcs->trace)
2137+ return;
2138+
2139+ event = &fbuffer->trace_file->event_call->event;
2140+
2141+ spin_lock_irqsave(&tracepoint_iter_lock, flags);
2142+ trace_seq_init(&iter->seq);
2143+ iter->ent = fbuffer->entry;
2144+ event_call->event.funcs->trace(iter, 0, event);
2145+ trace_seq_putc(&iter->seq, 0);
2146+ printk("%s", iter->seq.buffer);
2147+
2148+ spin_unlock_irqrestore(&tracepoint_iter_lock, flags);
2149+}
2150+
2151+int tracepoint_printk_sysctl(struct ctl_table *table, int write,
2152+ void __user *buffer, size_t *lenp,
2153+ loff_t *ppos)
2154+{
2155+ int save_tracepoint_printk;
2156+ int ret;
2157+
2158+ mutex_lock(&tracepoint_printk_mutex);
2159+ save_tracepoint_printk = tracepoint_printk;
2160+
2161+ ret = proc_dointvec(table, write, buffer, lenp, ppos);
2162+
2163+ /*
2164+ * This will force exiting early, as tracepoint_printk
2165+ * is always zero when tracepoint_printk_iter is not allocated
2166+ */
2167+ if (!tracepoint_print_iter)
2168+ tracepoint_printk = 0;
2169+
2170+ if (save_tracepoint_printk == tracepoint_printk)
2171+ goto out;
2172+
2173+ if (tracepoint_printk)
2174+ static_key_enable(&tracepoint_printk_key.key);
2175+ else
2176+ static_key_disable(&tracepoint_printk_key.key);
2177+
2178+ out:
2179+ mutex_unlock(&tracepoint_printk_mutex);
2180+
2181+ return ret;
2182+}
2183+
2184+void trace_event_buffer_commit(struct trace_event_buffer *fbuffer)
2185+{
2186+ if (static_key_false(&tracepoint_printk_key.key))
2187+ output_printk(fbuffer);
2188+
2189+ event_trigger_unlock_commit(fbuffer->trace_file, fbuffer->buffer,
2190+ fbuffer->event, fbuffer->entry,
2191+ fbuffer->flags, fbuffer->pc);
2192+}
2193+EXPORT_SYMBOL_GPL(trace_event_buffer_commit);
2194+
21192195 void trace_buffer_unlock_commit_regs(struct trace_array *tr,
21202196 struct ring_buffer *buffer,
21212197 struct ring_buffer_event *event,
@@ -7977,6 +8053,8 @@ void __init trace_init(void) · 5855 unmodified lines
79778053 kmalloc(sizeof(*tracepoint_print_iter), GFP_KERNEL);
79788054 if (WARN_ON(!tracepoint_print_iter))
79798055 tracepoint_printk = 0;
8056+ else
8057+ static_key_enable(&tracepoint_printk_key.key);
79808058 }
79818059 tracer_alloc_buffers();
79828060 trace_event_init();
kernel/trace/trace_events.c+0−40
@@ -283,46 +283,6 @@ void *trace_event_buffer_reserve(struct trace_event_buffer *fbuffer, · 282 unmodified lines
283283 }
284284 EXPORT_SYMBOL_GPL(trace_event_buffer_reserve);
285285
286−static DEFINE_SPINLOCK(tracepoint_iter_lock);
287−
288−static void output_printk(struct trace_event_buffer *fbuffer)
289−{
290− struct trace_event_call *event_call;
291− struct trace_event *event;
292− unsigned long flags;
293− struct trace_iterator *iter = tracepoint_print_iter;
294−
295− if (!iter)
296− return;
297−
298− event_call = fbuffer->trace_file->event_call;
299− if (!event_call || !event_call->event.funcs ||
300− !event_call->event.funcs->trace)
301− return;
302−
303− event = &fbuffer->trace_file->event_call->event;
304−
305− spin_lock_irqsave(&tracepoint_iter_lock, flags);
306− trace_seq_init(&iter->seq);
307− iter->ent = fbuffer->entry;
308− event_call->event.funcs->trace(iter, 0, event);
309− trace_seq_putc(&iter->seq, 0);
310− printk("%s", iter->seq.buffer);
311−
312− spin_unlock_irqrestore(&tracepoint_iter_lock, flags);
313−}
314−
315−void trace_event_buffer_commit(struct trace_event_buffer *fbuffer)
316−{
317− if (tracepoint_printk)
318− output_printk(fbuffer);
319−
320− event_trigger_unlock_commit(fbuffer->trace_file, fbuffer->buffer,
321− fbuffer->event, fbuffer->entry,
322− fbuffer->flags, fbuffer->pc);
323−}
324−EXPORT_SYMBOL_GPL(trace_event_buffer_commit);
325−
326286 int trace_event_reg(struct trace_event_call *call,
327287 enum trace_reg type, void *data)
328288 {

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t