4 * Copyright (C) 2008 Lai Jiangshan <laijs@cn.fujitsu.com>
7 #include <linux/seq_file.h>
8 #include <linux/uaccess.h>
9 #include <linux/kernel.h>
10 #include <linux/ftrace.h>
11 #include <linux/string.h>
12 #include <linux/module.h>
13 #include <linux/mutex.h>
14 #include <linux/ctype.h>
15 #include <linux/list.h>
16 #include <linux/slab.h>
23 * modules trace_printk()'s formats are autosaved in struct trace_bprintk_fmt
24 * which are queued on trace_bprintk_fmt_list.
26 static LIST_HEAD(trace_bprintk_fmt_list
);
28 /* serialize accesses to trace_bprintk_fmt_list */
29 static DEFINE_MUTEX(btrace_mutex
);
31 struct trace_bprintk_fmt
{
32 struct list_head list
;
36 static inline struct trace_bprintk_fmt
*lookup_format(const char *fmt
)
38 struct trace_bprintk_fmt
*pos
;
39 list_for_each_entry(pos
, &trace_bprintk_fmt_list
, list
) {
40 if (!strcmp(pos
->fmt
, fmt
))
47 void hold_module_trace_bprintk_format(const char **start
, const char **end
)
52 /* allocate the trace_printk per cpu buffers */
54 trace_printk_init_buffers();
56 mutex_lock(&btrace_mutex
);
57 for (iter
= start
; iter
< end
; iter
++) {
58 struct trace_bprintk_fmt
*tb_fmt
= lookup_format(*iter
);
65 tb_fmt
= kmalloc(sizeof(*tb_fmt
), GFP_KERNEL
);
67 fmt
= kmalloc(strlen(*iter
) + 1, GFP_KERNEL
);
69 list_add_tail(&tb_fmt
->list
, &trace_bprintk_fmt_list
);
78 mutex_unlock(&btrace_mutex
);
81 static int module_trace_bprintk_format_notify(struct notifier_block
*self
,
82 unsigned long val
, void *data
)
84 struct module
*mod
= data
;
85 if (mod
->num_trace_bprintk_fmt
) {
86 const char **start
= mod
->trace_bprintk_fmt_start
;
87 const char **end
= start
+ mod
->num_trace_bprintk_fmt
;
89 if (val
== MODULE_STATE_COMING
)
90 hold_module_trace_bprintk_format(start
, end
);
96 * The debugfs/tracing/printk_formats file maps the addresses with
97 * the ASCII formats that are used in the bprintk events in the
98 * buffer. For userspace tools to be able to decode the events from
99 * the buffer, they need to be able to map the address with the format.
101 * The addresses of the bprintk formats are in their own section
102 * __trace_printk_fmt. But for modules we copy them into a link list.
103 * The code to print the formats and their addresses passes around the
104 * address of the fmt string. If the fmt address passed into the seq
105 * functions is within the kernel core __trace_printk_fmt section, then
106 * it simply uses the next pointer in the list.
108 * When the fmt pointer is outside the kernel core __trace_printk_fmt
109 * section, then we need to read the link list pointers. The trick is
110 * we pass the address of the string to the seq function just like
111 * we do for the kernel core formats. To get back the structure that
112 * holds the format, we simply use containerof() and then go to the
113 * next format in the list.
116 find_next_mod_format(int start_index
, void *v
, const char **fmt
, loff_t
*pos
)
118 struct trace_bprintk_fmt
*mod_fmt
;
120 if (list_empty(&trace_bprintk_fmt_list
))
124 * v will point to the address of the fmt record from t_next
125 * v will be NULL from t_start.
126 * If this is the first pointer or called from start
127 * then we need to walk the list.
129 if (!v
|| start_index
== *pos
) {
130 struct trace_bprintk_fmt
*p
;
132 /* search the module list */
133 list_for_each_entry(p
, &trace_bprintk_fmt_list
, list
) {
134 if (start_index
== *pos
)
143 * v points to the address of the fmt field in the mod list
144 * structure that holds the module print format.
146 mod_fmt
= container_of(v
, typeof(*mod_fmt
), fmt
);
147 if (mod_fmt
->list
.next
== &trace_bprintk_fmt_list
)
150 mod_fmt
= container_of(mod_fmt
->list
.next
, typeof(*mod_fmt
), list
);
152 return &mod_fmt
->fmt
;
155 static void format_mod_start(void)
157 mutex_lock(&btrace_mutex
);
160 static void format_mod_stop(void)
162 mutex_unlock(&btrace_mutex
);
165 #else /* !CONFIG_MODULES */
167 module_trace_bprintk_format_notify(struct notifier_block
*self
,
168 unsigned long val
, void *data
)
172 static inline const char **
173 find_next_mod_format(int start_index
, void *v
, const char **fmt
, loff_t
*pos
)
177 static inline void format_mod_start(void) { }
178 static inline void format_mod_stop(void) { }
179 #endif /* CONFIG_MODULES */
181 static bool __read_mostly trace_printk_enabled
= true;
183 void trace_printk_control(bool enabled
)
185 trace_printk_enabled
= enabled
;
188 __initdata_or_module
static
189 struct notifier_block module_trace_bprintk_format_nb
= {
190 .notifier_call
= module_trace_bprintk_format_notify
,
193 int __trace_bprintk(unsigned long ip
, const char *fmt
, ...)
201 if (!trace_printk_enabled
)
205 ret
= trace_vbprintk(ip
, fmt
, ap
);
209 EXPORT_SYMBOL_GPL(__trace_bprintk
);
211 int __ftrace_vbprintk(unsigned long ip
, const char *fmt
, va_list ap
)
216 if (!trace_printk_enabled
)
219 return trace_vbprintk(ip
, fmt
, ap
);
221 EXPORT_SYMBOL_GPL(__ftrace_vbprintk
);
223 int __trace_printk(unsigned long ip
, const char *fmt
, ...)
228 if (!trace_printk_enabled
)
232 ret
= trace_vprintk(ip
, fmt
, ap
);
236 EXPORT_SYMBOL_GPL(__trace_printk
);
238 int __ftrace_vprintk(unsigned long ip
, const char *fmt
, va_list ap
)
240 if (!trace_printk_enabled
)
243 return trace_vprintk(ip
, fmt
, ap
);
245 EXPORT_SYMBOL_GPL(__ftrace_vprintk
);
247 static const char **find_next(void *v
, loff_t
*pos
)
249 const char **fmt
= v
;
253 start_index
= __stop___trace_bprintk_fmt
- __start___trace_bprintk_fmt
;
255 if (*pos
< start_index
)
256 return __start___trace_bprintk_fmt
+ *pos
;
259 * The __tracepoint_str section is treated the same as the
260 * __trace_printk_fmt section. The difference is that the
261 * __trace_printk_fmt section should only be used by trace_printk()
262 * in a debugging environment, as if anything exists in that section
263 * the trace_prink() helper buffers are allocated, which would just
264 * waste space in a production environment.
266 * The __tracepoint_str sections on the other hand are used by
267 * tracepoints which need to map pointers to their strings to
268 * the ASCII text for userspace.
270 last_index
= start_index
;
271 start_index
= __stop___tracepoint_str
- __start___tracepoint_str
;
273 if (*pos
< last_index
+ start_index
)
274 return __start___tracepoint_str
+ (*pos
- last_index
);
276 start_index
+= last_index
;
277 return find_next_mod_format(start_index
, v
, fmt
, pos
);
281 t_start(struct seq_file
*m
, loff_t
*pos
)
284 return find_next(NULL
, pos
);
287 static void *t_next(struct seq_file
*m
, void * v
, loff_t
*pos
)
290 return find_next(v
, pos
);
293 static int t_show(struct seq_file
*m
, void *v
)
295 const char **fmt
= v
;
296 const char *str
= *fmt
;
302 seq_printf(m
, "0x%lx : \"", *(unsigned long *)fmt
);
305 * Tabs and new lines need to be converted.
307 for (i
= 0; str
[i
]; i
++) {
330 static void t_stop(struct seq_file
*m
, void *p
)
335 static const struct seq_operations show_format_seq_ops
= {
343 ftrace_formats_open(struct inode
*inode
, struct file
*file
)
345 return seq_open(file
, &show_format_seq_ops
);
348 static const struct file_operations ftrace_formats_fops
= {
349 .open
= ftrace_formats_open
,
352 .release
= seq_release
,
355 static __init
int init_trace_printk_function_export(void)
357 struct dentry
*d_tracer
;
359 d_tracer
= tracing_init_dentry();
360 if (IS_ERR(d_tracer
))
363 trace_create_file("printk_formats", 0444, d_tracer
,
364 NULL
, &ftrace_formats_fops
);
369 fs_initcall(init_trace_printk_function_export
);
371 static __init
int init_trace_printk(void)
373 return register_module_notifier(&module_trace_bprintk_format_nb
);
376 early_initcall(init_trace_printk
);