2 * Kprobes-based tracing events
4 * Created by Masami Hiramatsu <mhiramat@redhat.com>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 #include <linux/module.h>
21 #include <linux/uaccess.h>
22 #include <linux/kprobes.h>
23 #include <linux/seq_file.h>
24 #include <linux/slab.h>
25 #include <linux/smp.h>
26 #include <linux/debugfs.h>
27 #include <linux/types.h>
28 #include <linux/string.h>
29 #include <linux/ctype.h>
30 #include <linux/ptrace.h>
31 #include <linux/perf_event.h>
32 #include <linux/stringify.h>
33 #include <linux/limits.h>
34 #include <asm/bitsperlong.h>
37 #include "trace_output.h"
39 #define MAX_TRACE_ARGS 128
40 #define MAX_ARGSTR_LEN 63
41 #define MAX_EVENT_NAME_LEN 64
42 #define MAX_STRING_SIZE PATH_MAX
43 #define KPROBE_EVENT_SYSTEM "kprobes"
45 /* Reserved field names */
46 #define FIELD_STRING_IP "__probe_ip"
47 #define FIELD_STRING_RETIP "__probe_ret_ip"
48 #define FIELD_STRING_FUNC "__probe_func"
50 const char *reserved_field_names
[] = {
53 "common_preempt_count",
61 /* Printing function type */
62 typedef int (*print_type_func_t
)(struct trace_seq
*, const char *, void *,
64 #define PRINT_TYPE_FUNC_NAME(type) print_type_##type
65 #define PRINT_TYPE_FMT_NAME(type) print_type_format_##type
67 /* Printing in basic type function template */
68 #define DEFINE_BASIC_PRINT_TYPE_FUNC(type, fmt, cast) \
69 static __kprobes int PRINT_TYPE_FUNC_NAME(type)(struct trace_seq *s, \
71 void *data, void *ent)\
73 return trace_seq_printf(s, " %s=" fmt, name, (cast)*(type *)data);\
75 static const char PRINT_TYPE_FMT_NAME(type)[] = fmt;
77 DEFINE_BASIC_PRINT_TYPE_FUNC(u8
, "%x", unsigned int)
78 DEFINE_BASIC_PRINT_TYPE_FUNC(u16
, "%x", unsigned int)
79 DEFINE_BASIC_PRINT_TYPE_FUNC(u32
, "%lx", unsigned long)
80 DEFINE_BASIC_PRINT_TYPE_FUNC(u64
, "%llx", unsigned long long)
81 DEFINE_BASIC_PRINT_TYPE_FUNC(s8
, "%d", int)
82 DEFINE_BASIC_PRINT_TYPE_FUNC(s16
, "%d", int)
83 DEFINE_BASIC_PRINT_TYPE_FUNC(s32
, "%ld", long)
84 DEFINE_BASIC_PRINT_TYPE_FUNC(s64
, "%lld", long long)
86 /* data_rloc: data relative location, compatible with u32 */
87 #define make_data_rloc(len, roffs) \
88 (((u32)(len) << 16) | ((u32)(roffs) & 0xffff))
89 #define get_rloc_len(dl) ((u32)(dl) >> 16)
90 #define get_rloc_offs(dl) ((u32)(dl) & 0xffff)
92 static inline void *get_rloc_data(u32
*dl
)
94 return (u8
*)dl
+ get_rloc_offs(*dl
);
97 /* For data_loc conversion */
98 static inline void *get_loc_data(u32
*dl
, void *ent
)
100 return (u8
*)ent
+ get_rloc_offs(*dl
);
104 * Convert data_rloc to data_loc:
105 * data_rloc stores the offset from data_rloc itself, but data_loc
106 * stores the offset from event entry.
108 #define convert_rloc_to_loc(dl, offs) ((u32)(dl) + (offs))
110 /* For defining macros, define string/string_size types */
112 typedef u32 string_size
;
114 /* Print type function for string type */
115 static __kprobes
int PRINT_TYPE_FUNC_NAME(string
)(struct trace_seq
*s
,
117 void *data
, void *ent
)
119 int len
= *(u32
*)data
>> 16;
122 return trace_seq_printf(s
, " %s=(fault)", name
);
124 return trace_seq_printf(s
, " %s=\"%s\"", name
,
125 (const char *)get_loc_data(data
, ent
));
127 static const char PRINT_TYPE_FMT_NAME(string
)[] = "\\\"%s\\\"";
129 /* Data fetch function type */
130 typedef void (*fetch_func_t
)(struct pt_regs
*, void *, void *);
137 static __kprobes
void call_fetch(struct fetch_param
*fprm
,
138 struct pt_regs
*regs
, void *dest
)
140 return fprm
->fn(regs
, fprm
->data
, dest
);
143 #define FETCH_FUNC_NAME(method, type) fetch_##method##_##type
145 * Define macro for basic types - we don't need to define s* types, because
146 * we have to care only about bitwidth at recording time.
148 #define DEFINE_BASIC_FETCH_FUNCS(method) \
149 DEFINE_FETCH_##method(u8) \
150 DEFINE_FETCH_##method(u16) \
151 DEFINE_FETCH_##method(u32) \
152 DEFINE_FETCH_##method(u64)
154 #define CHECK_FETCH_FUNCS(method, fn) \
155 (((FETCH_FUNC_NAME(method, u8) == fn) || \
156 (FETCH_FUNC_NAME(method, u16) == fn) || \
157 (FETCH_FUNC_NAME(method, u32) == fn) || \
158 (FETCH_FUNC_NAME(method, u64) == fn) || \
159 (FETCH_FUNC_NAME(method, string) == fn) || \
160 (FETCH_FUNC_NAME(method, string_size) == fn)) \
163 /* Data fetch function templates */
164 #define DEFINE_FETCH_reg(type) \
165 static __kprobes void FETCH_FUNC_NAME(reg, type)(struct pt_regs *regs, \
166 void *offset, void *dest) \
168 *(type *)dest = (type)regs_get_register(regs, \
169 (unsigned int)((unsigned long)offset)); \
171 DEFINE_BASIC_FETCH_FUNCS(reg
)
172 /* No string on the register */
173 #define fetch_reg_string NULL
174 #define fetch_reg_string_size NULL
176 #define DEFINE_FETCH_stack(type) \
177 static __kprobes void FETCH_FUNC_NAME(stack, type)(struct pt_regs *regs,\
178 void *offset, void *dest) \
180 *(type *)dest = (type)regs_get_kernel_stack_nth(regs, \
181 (unsigned int)((unsigned long)offset)); \
183 DEFINE_BASIC_FETCH_FUNCS(stack
)
184 /* No string on the stack entry */
185 #define fetch_stack_string NULL
186 #define fetch_stack_string_size NULL
188 #define DEFINE_FETCH_retval(type) \
189 static __kprobes void FETCH_FUNC_NAME(retval, type)(struct pt_regs *regs,\
190 void *dummy, void *dest) \
192 *(type *)dest = (type)regs_return_value(regs); \
194 DEFINE_BASIC_FETCH_FUNCS(retval
)
195 /* No string on the retval */
196 #define fetch_retval_string NULL
197 #define fetch_retval_string_size NULL
199 #define DEFINE_FETCH_memory(type) \
200 static __kprobes void FETCH_FUNC_NAME(memory, type)(struct pt_regs *regs,\
201 void *addr, void *dest) \
204 if (probe_kernel_address(addr, retval)) \
207 *(type *)dest = retval; \
209 DEFINE_BASIC_FETCH_FUNCS(memory
)
211 * Fetch a null-terminated string. Caller MUST set *(u32 *)dest with max
212 * length and relative data location.
214 static __kprobes
void FETCH_FUNC_NAME(memory
, string
)(struct pt_regs
*regs
,
215 void *addr
, void *dest
)
218 int maxlen
= get_rloc_len(*(u32
*)dest
);
219 u8
*dst
= get_rloc_data(dest
);
221 mm_segment_t old_fs
= get_fs();
225 * Try to get string again, since the string can be changed while
231 ret
= __copy_from_user_inatomic(dst
++, src
++, 1);
232 while (dst
[-1] && ret
== 0 && src
- (u8
*)addr
< maxlen
);
237 if (ret
< 0) { /* Failed to fetch string */
238 ((u8
*)get_rloc_data(dest
))[0] = '\0';
239 *(u32
*)dest
= make_data_rloc(0, get_rloc_offs(*(u32
*)dest
));
241 *(u32
*)dest
= make_data_rloc(src
- (u8
*)addr
,
242 get_rloc_offs(*(u32
*)dest
));
244 /* Return the length of string -- including null terminal byte */
245 static __kprobes
void FETCH_FUNC_NAME(memory
, string_size
)(struct pt_regs
*regs
,
246 void *addr
, void *dest
)
250 mm_segment_t old_fs
= get_fs();
255 ret
= __copy_from_user_inatomic(&c
, (u8
*)addr
+ len
, 1);
257 } while (c
&& ret
== 0 && len
< MAX_STRING_SIZE
);
261 if (ret
< 0) /* Failed to check the length */
267 /* Memory fetching by symbol */
268 struct symbol_cache
{
274 static unsigned long update_symbol_cache(struct symbol_cache
*sc
)
276 sc
->addr
= (unsigned long)kallsyms_lookup_name(sc
->symbol
);
278 sc
->addr
+= sc
->offset
;
282 static void free_symbol_cache(struct symbol_cache
*sc
)
288 static struct symbol_cache
*alloc_symbol_cache(const char *sym
, long offset
)
290 struct symbol_cache
*sc
;
292 if (!sym
|| strlen(sym
) == 0)
294 sc
= kzalloc(sizeof(struct symbol_cache
), GFP_KERNEL
);
298 sc
->symbol
= kstrdup(sym
, GFP_KERNEL
);
305 update_symbol_cache(sc
);
309 #define DEFINE_FETCH_symbol(type) \
310 static __kprobes void FETCH_FUNC_NAME(symbol, type)(struct pt_regs *regs,\
311 void *data, void *dest) \
313 struct symbol_cache *sc = data; \
315 fetch_memory_##type(regs, (void *)sc->addr, dest); \
319 DEFINE_BASIC_FETCH_FUNCS(symbol
)
320 DEFINE_FETCH_symbol(string
)
321 DEFINE_FETCH_symbol(string_size
)
323 /* Dereference memory access function */
324 struct deref_fetch_param
{
325 struct fetch_param orig
;
329 #define DEFINE_FETCH_deref(type) \
330 static __kprobes void FETCH_FUNC_NAME(deref, type)(struct pt_regs *regs,\
331 void *data, void *dest) \
333 struct deref_fetch_param *dprm = data; \
334 unsigned long addr; \
335 call_fetch(&dprm->orig, regs, &addr); \
337 addr += dprm->offset; \
338 fetch_memory_##type(regs, (void *)addr, dest); \
342 DEFINE_BASIC_FETCH_FUNCS(deref
)
343 DEFINE_FETCH_deref(string
)
344 DEFINE_FETCH_deref(string_size
)
346 static __kprobes
void update_deref_fetch_param(struct deref_fetch_param
*data
)
348 if (CHECK_FETCH_FUNCS(deref
, data
->orig
.fn
))
349 update_deref_fetch_param(data
->orig
.data
);
350 else if (CHECK_FETCH_FUNCS(symbol
, data
->orig
.fn
))
351 update_symbol_cache(data
->orig
.data
);
354 static __kprobes
void free_deref_fetch_param(struct deref_fetch_param
*data
)
356 if (CHECK_FETCH_FUNCS(deref
, data
->orig
.fn
))
357 free_deref_fetch_param(data
->orig
.data
);
358 else if (CHECK_FETCH_FUNCS(symbol
, data
->orig
.fn
))
359 free_symbol_cache(data
->orig
.data
);
363 /* Bitfield fetch function */
364 struct bitfield_fetch_param
{
365 struct fetch_param orig
;
366 unsigned char hi_shift
;
367 unsigned char low_shift
;
370 #define DEFINE_FETCH_bitfield(type) \
371 static __kprobes void FETCH_FUNC_NAME(bitfield, type)(struct pt_regs *regs,\
372 void *data, void *dest) \
374 struct bitfield_fetch_param *bprm = data; \
376 call_fetch(&bprm->orig, regs, &buf); \
378 buf <<= bprm->hi_shift; \
379 buf >>= bprm->low_shift; \
381 *(type *)dest = buf; \
383 DEFINE_BASIC_FETCH_FUNCS(bitfield
)
384 #define fetch_bitfield_string NULL
385 #define fetch_bitfield_string_size NULL
387 static __kprobes
void
388 update_bitfield_fetch_param(struct bitfield_fetch_param
*data
)
391 * Don't check the bitfield itself, because this must be the
392 * last fetch function.
394 if (CHECK_FETCH_FUNCS(deref
, data
->orig
.fn
))
395 update_deref_fetch_param(data
->orig
.data
);
396 else if (CHECK_FETCH_FUNCS(symbol
, data
->orig
.fn
))
397 update_symbol_cache(data
->orig
.data
);
400 static __kprobes
void
401 free_bitfield_fetch_param(struct bitfield_fetch_param
*data
)
404 * Don't check the bitfield itself, because this must be the
405 * last fetch function.
407 if (CHECK_FETCH_FUNCS(deref
, data
->orig
.fn
))
408 free_deref_fetch_param(data
->orig
.data
);
409 else if (CHECK_FETCH_FUNCS(symbol
, data
->orig
.fn
))
410 free_symbol_cache(data
->orig
.data
);
414 /* Default (unsigned long) fetch type */
415 #define __DEFAULT_FETCH_TYPE(t) u##t
416 #define _DEFAULT_FETCH_TYPE(t) __DEFAULT_FETCH_TYPE(t)
417 #define DEFAULT_FETCH_TYPE _DEFAULT_FETCH_TYPE(BITS_PER_LONG)
418 #define DEFAULT_FETCH_TYPE_STR __stringify(DEFAULT_FETCH_TYPE)
432 #define ASSIGN_FETCH_FUNC(method, type) \
433 [FETCH_MTD_##method] = FETCH_FUNC_NAME(method, type)
435 #define __ASSIGN_FETCH_TYPE(_name, ptype, ftype, _size, sign, _fmttype) \
439 .print = PRINT_TYPE_FUNC_NAME(ptype), \
440 .fmt = PRINT_TYPE_FMT_NAME(ptype), \
441 .fmttype = _fmttype, \
443 ASSIGN_FETCH_FUNC(reg, ftype), \
444 ASSIGN_FETCH_FUNC(stack, ftype), \
445 ASSIGN_FETCH_FUNC(retval, ftype), \
446 ASSIGN_FETCH_FUNC(memory, ftype), \
447 ASSIGN_FETCH_FUNC(symbol, ftype), \
448 ASSIGN_FETCH_FUNC(deref, ftype), \
449 ASSIGN_FETCH_FUNC(bitfield, ftype), \
453 #define ASSIGN_FETCH_TYPE(ptype, ftype, sign) \
454 __ASSIGN_FETCH_TYPE(#ptype, ptype, ftype, sizeof(ftype), sign, #ptype)
456 #define FETCH_TYPE_STRING 0
457 #define FETCH_TYPE_STRSIZE 1
459 /* Fetch type information table */
460 static const struct fetch_type
{
461 const char *name
; /* Name of type */
462 size_t size
; /* Byte size of type */
463 int is_signed
; /* Signed flag */
464 print_type_func_t print
; /* Print functions */
465 const char *fmt
; /* Fromat string */
466 const char *fmttype
; /* Name in format file */
467 /* Fetch functions */
468 fetch_func_t fetch
[FETCH_MTD_END
];
469 } fetch_type_table
[] = {
471 [FETCH_TYPE_STRING
] = __ASSIGN_FETCH_TYPE("string", string
, string
,
472 sizeof(u32
), 1, "__data_loc char[]"),
473 [FETCH_TYPE_STRSIZE
] = __ASSIGN_FETCH_TYPE("string_size", u32
,
474 string_size
, sizeof(u32
), 0, "u32"),
476 ASSIGN_FETCH_TYPE(u8
, u8
, 0),
477 ASSIGN_FETCH_TYPE(u16
, u16
, 0),
478 ASSIGN_FETCH_TYPE(u32
, u32
, 0),
479 ASSIGN_FETCH_TYPE(u64
, u64
, 0),
480 ASSIGN_FETCH_TYPE(s8
, u8
, 1),
481 ASSIGN_FETCH_TYPE(s16
, u16
, 1),
482 ASSIGN_FETCH_TYPE(s32
, u32
, 1),
483 ASSIGN_FETCH_TYPE(s64
, u64
, 1),
486 static const struct fetch_type
*find_fetch_type(const char *type
)
491 type
= DEFAULT_FETCH_TYPE_STR
;
493 /* Special case: bitfield */
496 type
= strchr(type
, '/');
500 if (strict_strtoul(type
, 0, &bs
))
504 return find_fetch_type("u8");
506 return find_fetch_type("u16");
508 return find_fetch_type("u32");
510 return find_fetch_type("u64");
516 for (i
= 0; i
< ARRAY_SIZE(fetch_type_table
); i
++)
517 if (strcmp(type
, fetch_type_table
[i
].name
) == 0)
518 return &fetch_type_table
[i
];
523 /* Special function : only accept unsigned long */
524 static __kprobes
void fetch_stack_address(struct pt_regs
*regs
,
525 void *dummy
, void *dest
)
527 *(unsigned long *)dest
= kernel_stack_pointer(regs
);
530 static fetch_func_t
get_fetch_size_function(const struct fetch_type
*type
,
531 fetch_func_t orig_fn
)
535 if (type
!= &fetch_type_table
[FETCH_TYPE_STRING
])
536 return NULL
; /* Only string type needs size function */
537 for (i
= 0; i
< FETCH_MTD_END
; i
++)
538 if (type
->fetch
[i
] == orig_fn
)
539 return fetch_type_table
[FETCH_TYPE_STRSIZE
].fetch
[i
];
541 WARN_ON(1); /* This should not happen */
546 * Kprobe event core functions
550 struct fetch_param fetch
;
551 struct fetch_param fetch_size
;
552 unsigned int offset
; /* Offset from argument entry */
553 const char *name
; /* Name of this argument */
554 const char *comm
; /* Command of this argument */
555 const struct fetch_type
*type
; /* Type of this argument */
558 /* Flags for trace_probe */
559 #define TP_FLAG_TRACE 1
560 #define TP_FLAG_PROFILE 2
561 #define TP_FLAG_REGISTERED 4
564 struct list_head list
;
565 struct kretprobe rp
; /* Use rp.kp for kprobe use */
567 unsigned int flags
; /* For TP_FLAG_* */
568 const char *symbol
; /* symbol name */
569 struct ftrace_event_class
class;
570 struct ftrace_event_call call
;
571 ssize_t size
; /* trace entry size */
572 unsigned int nr_args
;
573 struct probe_arg args
[];
576 #define SIZEOF_TRACE_PROBE(n) \
577 (offsetof(struct trace_probe, args) + \
578 (sizeof(struct probe_arg) * (n)))
581 static __kprobes
int trace_probe_is_return(struct trace_probe
*tp
)
583 return tp
->rp
.handler
!= NULL
;
586 static __kprobes
const char *trace_probe_symbol(struct trace_probe
*tp
)
588 return tp
->symbol
? tp
->symbol
: "unknown";
591 static __kprobes
unsigned long trace_probe_offset(struct trace_probe
*tp
)
593 return tp
->rp
.kp
.offset
;
596 static __kprobes
bool trace_probe_is_enabled(struct trace_probe
*tp
)
598 return !!(tp
->flags
& (TP_FLAG_TRACE
| TP_FLAG_PROFILE
));
601 static __kprobes
bool trace_probe_is_registered(struct trace_probe
*tp
)
603 return !!(tp
->flags
& TP_FLAG_REGISTERED
);
606 static __kprobes
bool trace_probe_has_gone(struct trace_probe
*tp
)
608 return !!(kprobe_gone(&tp
->rp
.kp
));
611 static __kprobes
bool trace_probe_within_module(struct trace_probe
*tp
,
614 int len
= strlen(mod
->name
);
615 const char *name
= trace_probe_symbol(tp
);
616 return strncmp(mod
->name
, name
, len
) == 0 && name
[len
] == ':';
619 static __kprobes
bool trace_probe_is_on_module(struct trace_probe
*tp
)
621 return !!strchr(trace_probe_symbol(tp
), ':');
624 static int register_probe_event(struct trace_probe
*tp
);
625 static void unregister_probe_event(struct trace_probe
*tp
);
627 static DEFINE_MUTEX(probe_lock
);
628 static LIST_HEAD(probe_list
);
630 static int kprobe_dispatcher(struct kprobe
*kp
, struct pt_regs
*regs
);
631 static int kretprobe_dispatcher(struct kretprobe_instance
*ri
,
632 struct pt_regs
*regs
);
634 /* Check the name is good for event/group/fields */
635 static int is_good_name(const char *name
)
637 if (!isalpha(*name
) && *name
!= '_')
639 while (*++name
!= '\0') {
640 if (!isalpha(*name
) && !isdigit(*name
) && *name
!= '_')
647 * Allocate new trace_probe and initialize it (including kprobes).
649 static struct trace_probe
*alloc_trace_probe(const char *group
,
654 int nargs
, int is_return
)
656 struct trace_probe
*tp
;
659 tp
= kzalloc(SIZEOF_TRACE_PROBE(nargs
), GFP_KERNEL
);
664 tp
->symbol
= kstrdup(symbol
, GFP_KERNEL
);
667 tp
->rp
.kp
.symbol_name
= tp
->symbol
;
668 tp
->rp
.kp
.offset
= offs
;
670 tp
->rp
.kp
.addr
= addr
;
673 tp
->rp
.handler
= kretprobe_dispatcher
;
675 tp
->rp
.kp
.pre_handler
= kprobe_dispatcher
;
677 if (!event
|| !is_good_name(event
)) {
682 tp
->call
.class = &tp
->class;
683 tp
->call
.name
= kstrdup(event
, GFP_KERNEL
);
687 if (!group
|| !is_good_name(group
)) {
692 tp
->class.system
= kstrdup(group
, GFP_KERNEL
);
693 if (!tp
->class.system
)
696 INIT_LIST_HEAD(&tp
->list
);
699 kfree(tp
->call
.name
);
705 static void update_probe_arg(struct probe_arg
*arg
)
707 if (CHECK_FETCH_FUNCS(bitfield
, arg
->fetch
.fn
))
708 update_bitfield_fetch_param(arg
->fetch
.data
);
709 else if (CHECK_FETCH_FUNCS(deref
, arg
->fetch
.fn
))
710 update_deref_fetch_param(arg
->fetch
.data
);
711 else if (CHECK_FETCH_FUNCS(symbol
, arg
->fetch
.fn
))
712 update_symbol_cache(arg
->fetch
.data
);
715 static void free_probe_arg(struct probe_arg
*arg
)
717 if (CHECK_FETCH_FUNCS(bitfield
, arg
->fetch
.fn
))
718 free_bitfield_fetch_param(arg
->fetch
.data
);
719 else if (CHECK_FETCH_FUNCS(deref
, arg
->fetch
.fn
))
720 free_deref_fetch_param(arg
->fetch
.data
);
721 else if (CHECK_FETCH_FUNCS(symbol
, arg
->fetch
.fn
))
722 free_symbol_cache(arg
->fetch
.data
);
727 static void free_trace_probe(struct trace_probe
*tp
)
731 for (i
= 0; i
< tp
->nr_args
; i
++)
732 free_probe_arg(&tp
->args
[i
]);
734 kfree(tp
->call
.class->system
);
735 kfree(tp
->call
.name
);
740 static struct trace_probe
*find_trace_probe(const char *event
,
743 struct trace_probe
*tp
;
745 list_for_each_entry(tp
, &probe_list
, list
)
746 if (strcmp(tp
->call
.name
, event
) == 0 &&
747 strcmp(tp
->call
.class->system
, group
) == 0)
752 /* Enable trace_probe - @flag must be TP_FLAG_TRACE or TP_FLAG_PROFILE */
753 static int enable_trace_probe(struct trace_probe
*tp
, int flag
)
758 if (trace_probe_is_enabled(tp
) && trace_probe_is_registered(tp
) &&
759 !trace_probe_has_gone(tp
)) {
760 if (trace_probe_is_return(tp
))
761 ret
= enable_kretprobe(&tp
->rp
);
763 ret
= enable_kprobe(&tp
->rp
.kp
);
769 /* Disable trace_probe - @flag must be TP_FLAG_TRACE or TP_FLAG_PROFILE */
770 static void disable_trace_probe(struct trace_probe
*tp
, int flag
)
773 if (!trace_probe_is_enabled(tp
) && trace_probe_is_registered(tp
)) {
774 if (trace_probe_is_return(tp
))
775 disable_kretprobe(&tp
->rp
);
777 disable_kprobe(&tp
->rp
.kp
);
781 /* Internal register function - just handle k*probes and flags */
782 static int __register_trace_probe(struct trace_probe
*tp
)
786 if (trace_probe_is_registered(tp
))
789 for (i
= 0; i
< tp
->nr_args
; i
++)
790 update_probe_arg(&tp
->args
[i
]);
792 /* Set/clear disabled flag according to tp->flag */
793 if (trace_probe_is_enabled(tp
))
794 tp
->rp
.kp
.flags
&= ~KPROBE_FLAG_DISABLED
;
796 tp
->rp
.kp
.flags
|= KPROBE_FLAG_DISABLED
;
798 if (trace_probe_is_return(tp
))
799 ret
= register_kretprobe(&tp
->rp
);
801 ret
= register_kprobe(&tp
->rp
.kp
);
804 tp
->flags
|= TP_FLAG_REGISTERED
;
806 pr_warning("Could not insert probe at %s+%lu: %d\n",
807 trace_probe_symbol(tp
), trace_probe_offset(tp
), ret
);
808 if (ret
== -ENOENT
&& trace_probe_is_on_module(tp
)) {
809 pr_warning("This probe might be able to register after"
810 "target module is loaded. Continue.\n");
812 } else if (ret
== -EILSEQ
) {
813 pr_warning("Probing address(0x%p) is not an "
814 "instruction boundary.\n",
823 /* Internal unregister function - just handle k*probes and flags */
824 static void __unregister_trace_probe(struct trace_probe
*tp
)
826 if (trace_probe_is_registered(tp
)) {
827 if (trace_probe_is_return(tp
))
828 unregister_kretprobe(&tp
->rp
);
830 unregister_kprobe(&tp
->rp
.kp
);
831 tp
->flags
&= ~TP_FLAG_REGISTERED
;
832 /* Cleanup kprobe for reuse */
833 if (tp
->rp
.kp
.symbol_name
)
834 tp
->rp
.kp
.addr
= NULL
;
838 /* Unregister a trace_probe and probe_event: call with locking probe_lock */
839 static void unregister_trace_probe(struct trace_probe
*tp
)
841 __unregister_trace_probe(tp
);
843 unregister_probe_event(tp
);
846 /* Register a trace_probe and probe_event */
847 static int register_trace_probe(struct trace_probe
*tp
)
849 struct trace_probe
*old_tp
;
852 mutex_lock(&probe_lock
);
854 /* Delete old (same name) event if exist */
855 old_tp
= find_trace_probe(tp
->call
.name
, tp
->call
.class->system
);
857 unregister_trace_probe(old_tp
);
858 free_trace_probe(old_tp
);
861 /* Register new event */
862 ret
= register_probe_event(tp
);
864 pr_warning("Failed to register probe event(%d)\n", ret
);
868 /* Register k*probe */
869 ret
= __register_trace_probe(tp
);
871 unregister_probe_event(tp
);
873 list_add_tail(&tp
->list
, &probe_list
);
876 mutex_unlock(&probe_lock
);
880 /* Module notifier call back, checking event on the module */
881 static int trace_probe_module_callback(struct notifier_block
*nb
,
882 unsigned long val
, void *data
)
884 struct module
*mod
= data
;
885 struct trace_probe
*tp
;
888 if (val
!= MODULE_STATE_COMING
)
891 /* Update probes on coming module */
892 mutex_lock(&probe_lock
);
893 list_for_each_entry(tp
, &probe_list
, list
) {
894 if (trace_probe_within_module(tp
, mod
)) {
895 __unregister_trace_probe(tp
);
896 ret
= __register_trace_probe(tp
);
898 pr_warning("Failed to re-register probe %s on"
900 tp
->call
.name
, mod
->name
, ret
);
903 mutex_unlock(&probe_lock
);
908 static struct notifier_block trace_probe_module_nb
= {
909 .notifier_call
= trace_probe_module_callback
,
910 .priority
= 1 /* Invoked after kprobe module callback */
913 /* Split symbol and offset. */
914 static int split_symbol_offset(char *symbol
, unsigned long *offset
)
922 tmp
= strchr(symbol
, '+');
924 /* skip sign because strict_strtol doesn't accept '+' */
925 ret
= strict_strtoul(tmp
+ 1, 0, offset
);
934 #define PARAM_MAX_ARGS 16
935 #define PARAM_MAX_STACK (THREAD_SIZE / sizeof(unsigned long))
937 static int parse_probe_vars(char *arg
, const struct fetch_type
*t
,
938 struct fetch_param
*f
, int is_return
)
943 if (strcmp(arg
, "retval") == 0) {
945 f
->fn
= t
->fetch
[FETCH_MTD_retval
];
948 } else if (strncmp(arg
, "stack", 5) == 0) {
949 if (arg
[5] == '\0') {
950 if (strcmp(t
->name
, DEFAULT_FETCH_TYPE_STR
) == 0)
951 f
->fn
= fetch_stack_address
;
954 } else if (isdigit(arg
[5])) {
955 ret
= strict_strtoul(arg
+ 5, 10, ¶m
);
956 if (ret
|| param
> PARAM_MAX_STACK
)
959 f
->fn
= t
->fetch
[FETCH_MTD_stack
];
960 f
->data
= (void *)param
;
969 /* Recursive argument parser */
970 static int __parse_probe_arg(char *arg
, const struct fetch_type
*t
,
971 struct fetch_param
*f
, int is_return
)
980 ret
= parse_probe_vars(arg
+ 1, t
, f
, is_return
);
982 case '%': /* named register */
983 ret
= regs_query_register_offset(arg
+ 1);
985 f
->fn
= t
->fetch
[FETCH_MTD_reg
];
986 f
->data
= (void *)(unsigned long)ret
;
990 case '@': /* memory or symbol */
991 if (isdigit(arg
[1])) {
992 ret
= strict_strtoul(arg
+ 1, 0, ¶m
);
995 f
->fn
= t
->fetch
[FETCH_MTD_memory
];
996 f
->data
= (void *)param
;
998 ret
= split_symbol_offset(arg
+ 1, &offset
);
1001 f
->data
= alloc_symbol_cache(arg
+ 1, offset
);
1003 f
->fn
= t
->fetch
[FETCH_MTD_symbol
];
1006 case '+': /* deref memory */
1007 arg
++; /* Skip '+', because strict_strtol() rejects it. */
1009 tmp
= strchr(arg
, '(');
1013 ret
= strict_strtol(arg
, 0, &offset
);
1017 tmp
= strrchr(arg
, ')');
1019 struct deref_fetch_param
*dprm
;
1020 const struct fetch_type
*t2
= find_fetch_type(NULL
);
1022 dprm
= kzalloc(sizeof(struct deref_fetch_param
),
1026 dprm
->offset
= offset
;
1027 ret
= __parse_probe_arg(arg
, t2
, &dprm
->orig
,
1032 f
->fn
= t
->fetch
[FETCH_MTD_deref
];
1033 f
->data
= (void *)dprm
;
1038 if (!ret
&& !f
->fn
) { /* Parsed, but do not find fetch method */
1039 pr_info("%s type has no corresponding fetch method.\n",
1046 #define BYTES_TO_BITS(nb) ((BITS_PER_LONG * (nb)) / sizeof(long))
1048 /* Bitfield type needs to be parsed into a fetch function */
1049 static int __parse_bitfield_probe_arg(const char *bf
,
1050 const struct fetch_type
*t
,
1051 struct fetch_param
*f
)
1053 struct bitfield_fetch_param
*bprm
;
1054 unsigned long bw
, bo
;
1060 bprm
= kzalloc(sizeof(*bprm
), GFP_KERNEL
);
1064 f
->fn
= t
->fetch
[FETCH_MTD_bitfield
];
1065 f
->data
= (void *)bprm
;
1067 bw
= simple_strtoul(bf
+ 1, &tail
, 0); /* Use simple one */
1068 if (bw
== 0 || *tail
!= '@')
1072 bo
= simple_strtoul(bf
, &tail
, 0);
1073 if (tail
== bf
|| *tail
!= '/')
1076 bprm
->hi_shift
= BYTES_TO_BITS(t
->size
) - (bw
+ bo
);
1077 bprm
->low_shift
= bprm
->hi_shift
+ bo
;
1078 return (BYTES_TO_BITS(t
->size
) < (bw
+ bo
)) ? -EINVAL
: 0;
1081 /* String length checking wrapper */
1082 static int parse_probe_arg(char *arg
, struct trace_probe
*tp
,
1083 struct probe_arg
*parg
, int is_return
)
1088 if (strlen(arg
) > MAX_ARGSTR_LEN
) {
1089 pr_info("Argument is too long.: %s\n", arg
);
1092 parg
->comm
= kstrdup(arg
, GFP_KERNEL
);
1094 pr_info("Failed to allocate memory for command '%s'.\n", arg
);
1097 t
= strchr(parg
->comm
, ':');
1099 arg
[t
- parg
->comm
] = '\0';
1102 parg
->type
= find_fetch_type(t
);
1104 pr_info("Unsupported type: %s\n", t
);
1107 parg
->offset
= tp
->size
;
1108 tp
->size
+= parg
->type
->size
;
1109 ret
= __parse_probe_arg(arg
, parg
->type
, &parg
->fetch
, is_return
);
1110 if (ret
>= 0 && t
!= NULL
)
1111 ret
= __parse_bitfield_probe_arg(t
, parg
->type
, &parg
->fetch
);
1113 parg
->fetch_size
.fn
= get_fetch_size_function(parg
->type
,
1115 parg
->fetch_size
.data
= parg
->fetch
.data
;
1120 /* Return 1 if name is reserved or already used by another argument */
1121 static int conflict_field_name(const char *name
,
1122 struct probe_arg
*args
, int narg
)
1125 for (i
= 0; i
< ARRAY_SIZE(reserved_field_names
); i
++)
1126 if (strcmp(reserved_field_names
[i
], name
) == 0)
1128 for (i
= 0; i
< narg
; i
++)
1129 if (strcmp(args
[i
].name
, name
) == 0)
1134 static int create_trace_probe(int argc
, char **argv
)
1138 * - Add kprobe: p[:[GRP/]EVENT] [MOD:]KSYM[+OFFS]|KADDR [FETCHARGS]
1139 * - Add kretprobe: r[:[GRP/]EVENT] [MOD:]KSYM[+0] [FETCHARGS]
1141 * $retval : fetch return value
1142 * $stack : fetch stack address
1143 * $stackN : fetch Nth of stack (N:0-)
1144 * @ADDR : fetch memory at ADDR (ADDR should be in kernel)
1145 * @SYM[+|-offs] : fetch memory at SYM +|- offs (SYM is a data symbol)
1146 * %REG : fetch register REG
1147 * Dereferencing memory fetch:
1148 * +|-offs(ARG) : fetch memory at ARG +|- offs address.
1149 * Alias name of args:
1150 * NAME=FETCHARG : set NAME as alias of FETCHARG.
1152 * FETCHARG:TYPE : use TYPE instead of unsigned long.
1154 struct trace_probe
*tp
;
1156 int is_return
= 0, is_delete
= 0;
1157 char *symbol
= NULL
, *event
= NULL
, *group
= NULL
;
1159 unsigned long offset
= 0;
1161 char buf
[MAX_EVENT_NAME_LEN
];
1163 /* argc must be >= 1 */
1164 if (argv
[0][0] == 'p')
1166 else if (argv
[0][0] == 'r')
1168 else if (argv
[0][0] == '-')
1171 pr_info("Probe definition must be started with 'p', 'r' or"
1176 if (argv
[0][1] == ':') {
1177 event
= &argv
[0][2];
1178 if (strchr(event
, '/')) {
1180 event
= strchr(group
, '/') + 1;
1182 if (strlen(group
) == 0) {
1183 pr_info("Group name is not specified\n");
1187 if (strlen(event
) == 0) {
1188 pr_info("Event name is not specified\n");
1193 group
= KPROBE_EVENT_SYSTEM
;
1197 pr_info("Delete command needs an event name.\n");
1200 mutex_lock(&probe_lock
);
1201 tp
= find_trace_probe(event
, group
);
1203 mutex_unlock(&probe_lock
);
1204 pr_info("Event %s/%s doesn't exist.\n", group
, event
);
1207 /* delete an event */
1208 unregister_trace_probe(tp
);
1209 free_trace_probe(tp
);
1210 mutex_unlock(&probe_lock
);
1215 pr_info("Probe point is not specified.\n");
1218 if (isdigit(argv
[1][0])) {
1220 pr_info("Return probe point must be a symbol.\n");
1223 /* an address specified */
1224 ret
= strict_strtoul(&argv
[1][0], 0, (unsigned long *)&addr
);
1226 pr_info("Failed to parse address.\n");
1230 /* a symbol specified */
1232 /* TODO: support .init module functions */
1233 ret
= split_symbol_offset(symbol
, &offset
);
1235 pr_info("Failed to parse symbol.\n");
1238 if (offset
&& is_return
) {
1239 pr_info("Return probe must be used without offset.\n");
1243 argc
-= 2; argv
+= 2;
1247 /* Make a new event name */
1249 snprintf(buf
, MAX_EVENT_NAME_LEN
, "%c_%s_%ld",
1250 is_return
? 'r' : 'p', symbol
, offset
);
1252 snprintf(buf
, MAX_EVENT_NAME_LEN
, "%c_0x%p",
1253 is_return
? 'r' : 'p', addr
);
1256 tp
= alloc_trace_probe(group
, event
, addr
, symbol
, offset
, argc
,
1259 pr_info("Failed to allocate trace_probe.(%d)\n",
1264 /* parse arguments */
1266 for (i
= 0; i
< argc
&& i
< MAX_TRACE_ARGS
; i
++) {
1267 /* Increment count for freeing args in error case */
1270 /* Parse argument name */
1271 arg
= strchr(argv
[i
], '=');
1274 tp
->args
[i
].name
= kstrdup(argv
[i
], GFP_KERNEL
);
1277 /* If argument name is omitted, set "argN" */
1278 snprintf(buf
, MAX_EVENT_NAME_LEN
, "arg%d", i
+ 1);
1279 tp
->args
[i
].name
= kstrdup(buf
, GFP_KERNEL
);
1282 if (!tp
->args
[i
].name
) {
1283 pr_info("Failed to allocate argument[%d] name.\n", i
);
1288 if (!is_good_name(tp
->args
[i
].name
)) {
1289 pr_info("Invalid argument[%d] name: %s\n",
1290 i
, tp
->args
[i
].name
);
1295 if (conflict_field_name(tp
->args
[i
].name
, tp
->args
, i
)) {
1296 pr_info("Argument[%d] name '%s' conflicts with "
1297 "another field.\n", i
, argv
[i
]);
1302 /* Parse fetch argument */
1303 ret
= parse_probe_arg(arg
, tp
, &tp
->args
[i
], is_return
);
1305 pr_info("Parse error at argument[%d]. (%d)\n", i
, ret
);
1310 ret
= register_trace_probe(tp
);
1316 free_trace_probe(tp
);
1320 static void release_all_trace_probes(void)
1322 struct trace_probe
*tp
;
1324 mutex_lock(&probe_lock
);
1325 /* TODO: Use batch unregistration */
1326 while (!list_empty(&probe_list
)) {
1327 tp
= list_entry(probe_list
.next
, struct trace_probe
, list
);
1328 unregister_trace_probe(tp
);
1329 free_trace_probe(tp
);
1331 mutex_unlock(&probe_lock
);
1334 /* Probes listing interfaces */
1335 static void *probes_seq_start(struct seq_file
*m
, loff_t
*pos
)
1337 mutex_lock(&probe_lock
);
1338 return seq_list_start(&probe_list
, *pos
);
1341 static void *probes_seq_next(struct seq_file
*m
, void *v
, loff_t
*pos
)
1343 return seq_list_next(v
, &probe_list
, pos
);
1346 static void probes_seq_stop(struct seq_file
*m
, void *v
)
1348 mutex_unlock(&probe_lock
);
1351 static int probes_seq_show(struct seq_file
*m
, void *v
)
1353 struct trace_probe
*tp
= v
;
1356 seq_printf(m
, "%c", trace_probe_is_return(tp
) ? 'r' : 'p');
1357 seq_printf(m
, ":%s/%s", tp
->call
.class->system
, tp
->call
.name
);
1360 seq_printf(m
, " 0x%p", tp
->rp
.kp
.addr
);
1361 else if (tp
->rp
.kp
.offset
)
1362 seq_printf(m
, " %s+%u", trace_probe_symbol(tp
),
1365 seq_printf(m
, " %s", trace_probe_symbol(tp
));
1367 for (i
= 0; i
< tp
->nr_args
; i
++)
1368 seq_printf(m
, " %s=%s", tp
->args
[i
].name
, tp
->args
[i
].comm
);
1369 seq_printf(m
, "\n");
1374 static const struct seq_operations probes_seq_op
= {
1375 .start
= probes_seq_start
,
1376 .next
= probes_seq_next
,
1377 .stop
= probes_seq_stop
,
1378 .show
= probes_seq_show
1381 static int probes_open(struct inode
*inode
, struct file
*file
)
1383 if ((file
->f_mode
& FMODE_WRITE
) &&
1384 (file
->f_flags
& O_TRUNC
))
1385 release_all_trace_probes();
1387 return seq_open(file
, &probes_seq_op
);
1390 static int command_trace_probe(const char *buf
)
1393 int argc
= 0, ret
= 0;
1395 argv
= argv_split(GFP_KERNEL
, buf
, &argc
);
1400 ret
= create_trace_probe(argc
, argv
);
1406 #define WRITE_BUFSIZE 4096
1408 static ssize_t
probes_write(struct file
*file
, const char __user
*buffer
,
1409 size_t count
, loff_t
*ppos
)
1416 kbuf
= kmalloc(WRITE_BUFSIZE
, GFP_KERNEL
);
1421 while (done
< count
) {
1422 size
= count
- done
;
1423 if (size
>= WRITE_BUFSIZE
)
1424 size
= WRITE_BUFSIZE
- 1;
1425 if (copy_from_user(kbuf
, buffer
+ done
, size
)) {
1430 tmp
= strchr(kbuf
, '\n');
1433 size
= tmp
- kbuf
+ 1;
1434 } else if (done
+ size
< count
) {
1435 pr_warning("Line length is too long: "
1436 "Should be less than %d.", WRITE_BUFSIZE
);
1441 /* Remove comments */
1442 tmp
= strchr(kbuf
, '#');
1446 ret
= command_trace_probe(kbuf
);
1456 static const struct file_operations kprobe_events_ops
= {
1457 .owner
= THIS_MODULE
,
1458 .open
= probes_open
,
1460 .llseek
= seq_lseek
,
1461 .release
= seq_release
,
1462 .write
= probes_write
,
1465 /* Probes profiling interfaces */
1466 static int probes_profile_seq_show(struct seq_file
*m
, void *v
)
1468 struct trace_probe
*tp
= v
;
1470 seq_printf(m
, " %-44s %15lu %15lu\n", tp
->call
.name
, tp
->nhit
,
1476 static const struct seq_operations profile_seq_op
= {
1477 .start
= probes_seq_start
,
1478 .next
= probes_seq_next
,
1479 .stop
= probes_seq_stop
,
1480 .show
= probes_profile_seq_show
1483 static int profile_open(struct inode
*inode
, struct file
*file
)
1485 return seq_open(file
, &profile_seq_op
);
1488 static const struct file_operations kprobe_profile_ops
= {
1489 .owner
= THIS_MODULE
,
1490 .open
= profile_open
,
1492 .llseek
= seq_lseek
,
1493 .release
= seq_release
,
1496 /* Sum up total data length for dynamic arraies (strings) */
1497 static __kprobes
int __get_data_size(struct trace_probe
*tp
,
1498 struct pt_regs
*regs
)
1503 for (i
= 0; i
< tp
->nr_args
; i
++)
1504 if (unlikely(tp
->args
[i
].fetch_size
.fn
)) {
1505 call_fetch(&tp
->args
[i
].fetch_size
, regs
, &len
);
1512 /* Store the value of each argument */
1513 static __kprobes
void store_trace_args(int ent_size
, struct trace_probe
*tp
,
1514 struct pt_regs
*regs
,
1515 u8
*data
, int maxlen
)
1519 u32
*dl
; /* Data (relative) location */
1521 for (i
= 0; i
< tp
->nr_args
; i
++) {
1522 if (unlikely(tp
->args
[i
].fetch_size
.fn
)) {
1524 * First, we set the relative location and
1525 * maximum data length to *dl
1527 dl
= (u32
*)(data
+ tp
->args
[i
].offset
);
1528 *dl
= make_data_rloc(maxlen
, end
- tp
->args
[i
].offset
);
1529 /* Then try to fetch string or dynamic array data */
1530 call_fetch(&tp
->args
[i
].fetch
, regs
, dl
);
1531 /* Reduce maximum length */
1532 end
+= get_rloc_len(*dl
);
1533 maxlen
-= get_rloc_len(*dl
);
1534 /* Trick here, convert data_rloc to data_loc */
1535 *dl
= convert_rloc_to_loc(*dl
,
1536 ent_size
+ tp
->args
[i
].offset
);
1538 /* Just fetching data normally */
1539 call_fetch(&tp
->args
[i
].fetch
, regs
,
1540 data
+ tp
->args
[i
].offset
);
1544 /* Kprobe handler */
1545 static __kprobes
void kprobe_trace_func(struct kprobe
*kp
, struct pt_regs
*regs
)
1547 struct trace_probe
*tp
= container_of(kp
, struct trace_probe
, rp
.kp
);
1548 struct kprobe_trace_entry_head
*entry
;
1549 struct ring_buffer_event
*event
;
1550 struct ring_buffer
*buffer
;
1551 int size
, dsize
, pc
;
1552 unsigned long irq_flags
;
1553 struct ftrace_event_call
*call
= &tp
->call
;
1557 local_save_flags(irq_flags
);
1558 pc
= preempt_count();
1560 dsize
= __get_data_size(tp
, regs
);
1561 size
= sizeof(*entry
) + tp
->size
+ dsize
;
1563 event
= trace_current_buffer_lock_reserve(&buffer
, call
->event
.type
,
1564 size
, irq_flags
, pc
);
1568 entry
= ring_buffer_event_data(event
);
1569 entry
->ip
= (unsigned long)kp
->addr
;
1570 store_trace_args(sizeof(*entry
), tp
, regs
, (u8
*)&entry
[1], dsize
);
1572 if (!filter_current_check_discard(buffer
, call
, entry
, event
))
1573 trace_nowake_buffer_unlock_commit_regs(buffer
, event
,
1574 irq_flags
, pc
, regs
);
1577 /* Kretprobe handler */
1578 static __kprobes
void kretprobe_trace_func(struct kretprobe_instance
*ri
,
1579 struct pt_regs
*regs
)
1581 struct trace_probe
*tp
= container_of(ri
->rp
, struct trace_probe
, rp
);
1582 struct kretprobe_trace_entry_head
*entry
;
1583 struct ring_buffer_event
*event
;
1584 struct ring_buffer
*buffer
;
1585 int size
, pc
, dsize
;
1586 unsigned long irq_flags
;
1587 struct ftrace_event_call
*call
= &tp
->call
;
1589 local_save_flags(irq_flags
);
1590 pc
= preempt_count();
1592 dsize
= __get_data_size(tp
, regs
);
1593 size
= sizeof(*entry
) + tp
->size
+ dsize
;
1595 event
= trace_current_buffer_lock_reserve(&buffer
, call
->event
.type
,
1596 size
, irq_flags
, pc
);
1600 entry
= ring_buffer_event_data(event
);
1601 entry
->func
= (unsigned long)tp
->rp
.kp
.addr
;
1602 entry
->ret_ip
= (unsigned long)ri
->ret_addr
;
1603 store_trace_args(sizeof(*entry
), tp
, regs
, (u8
*)&entry
[1], dsize
);
1605 if (!filter_current_check_discard(buffer
, call
, entry
, event
))
1606 trace_nowake_buffer_unlock_commit_regs(buffer
, event
,
1607 irq_flags
, pc
, regs
);
1610 /* Event entry printers */
1612 print_kprobe_event(struct trace_iterator
*iter
, int flags
,
1613 struct trace_event
*event
)
1615 struct kprobe_trace_entry_head
*field
;
1616 struct trace_seq
*s
= &iter
->seq
;
1617 struct trace_probe
*tp
;
1621 field
= (struct kprobe_trace_entry_head
*)iter
->ent
;
1622 tp
= container_of(event
, struct trace_probe
, call
.event
);
1624 if (!trace_seq_printf(s
, "%s: (", tp
->call
.name
))
1627 if (!seq_print_ip_sym(s
, field
->ip
, flags
| TRACE_ITER_SYM_OFFSET
))
1630 if (!trace_seq_puts(s
, ")"))
1633 data
= (u8
*)&field
[1];
1634 for (i
= 0; i
< tp
->nr_args
; i
++)
1635 if (!tp
->args
[i
].type
->print(s
, tp
->args
[i
].name
,
1636 data
+ tp
->args
[i
].offset
, field
))
1639 if (!trace_seq_puts(s
, "\n"))
1642 return TRACE_TYPE_HANDLED
;
1644 return TRACE_TYPE_PARTIAL_LINE
;
1648 print_kretprobe_event(struct trace_iterator
*iter
, int flags
,
1649 struct trace_event
*event
)
1651 struct kretprobe_trace_entry_head
*field
;
1652 struct trace_seq
*s
= &iter
->seq
;
1653 struct trace_probe
*tp
;
1657 field
= (struct kretprobe_trace_entry_head
*)iter
->ent
;
1658 tp
= container_of(event
, struct trace_probe
, call
.event
);
1660 if (!trace_seq_printf(s
, "%s: (", tp
->call
.name
))
1663 if (!seq_print_ip_sym(s
, field
->ret_ip
, flags
| TRACE_ITER_SYM_OFFSET
))
1666 if (!trace_seq_puts(s
, " <- "))
1669 if (!seq_print_ip_sym(s
, field
->func
, flags
& ~TRACE_ITER_SYM_OFFSET
))
1672 if (!trace_seq_puts(s
, ")"))
1675 data
= (u8
*)&field
[1];
1676 for (i
= 0; i
< tp
->nr_args
; i
++)
1677 if (!tp
->args
[i
].type
->print(s
, tp
->args
[i
].name
,
1678 data
+ tp
->args
[i
].offset
, field
))
1681 if (!trace_seq_puts(s
, "\n"))
1684 return TRACE_TYPE_HANDLED
;
1686 return TRACE_TYPE_PARTIAL_LINE
;
1690 #define DEFINE_FIELD(type, item, name, is_signed) \
1692 ret = trace_define_field(event_call, #type, name, \
1693 offsetof(typeof(field), item), \
1694 sizeof(field.item), is_signed, \
1700 static int kprobe_event_define_fields(struct ftrace_event_call
*event_call
)
1703 struct kprobe_trace_entry_head field
;
1704 struct trace_probe
*tp
= (struct trace_probe
*)event_call
->data
;
1706 DEFINE_FIELD(unsigned long, ip
, FIELD_STRING_IP
, 0);
1707 /* Set argument names as fields */
1708 for (i
= 0; i
< tp
->nr_args
; i
++) {
1709 ret
= trace_define_field(event_call
, tp
->args
[i
].type
->fmttype
,
1711 sizeof(field
) + tp
->args
[i
].offset
,
1712 tp
->args
[i
].type
->size
,
1713 tp
->args
[i
].type
->is_signed
,
1721 static int kretprobe_event_define_fields(struct ftrace_event_call
*event_call
)
1724 struct kretprobe_trace_entry_head field
;
1725 struct trace_probe
*tp
= (struct trace_probe
*)event_call
->data
;
1727 DEFINE_FIELD(unsigned long, func
, FIELD_STRING_FUNC
, 0);
1728 DEFINE_FIELD(unsigned long, ret_ip
, FIELD_STRING_RETIP
, 0);
1729 /* Set argument names as fields */
1730 for (i
= 0; i
< tp
->nr_args
; i
++) {
1731 ret
= trace_define_field(event_call
, tp
->args
[i
].type
->fmttype
,
1733 sizeof(field
) + tp
->args
[i
].offset
,
1734 tp
->args
[i
].type
->size
,
1735 tp
->args
[i
].type
->is_signed
,
1743 static int __set_print_fmt(struct trace_probe
*tp
, char *buf
, int len
)
1748 const char *fmt
, *arg
;
1750 if (!trace_probe_is_return(tp
)) {
1752 arg
= "REC->" FIELD_STRING_IP
;
1754 fmt
= "(%lx <- %lx)";
1755 arg
= "REC->" FIELD_STRING_FUNC
", REC->" FIELD_STRING_RETIP
;
1758 /* When len=0, we just calculate the needed length */
1759 #define LEN_OR_ZERO (len ? len - pos : 0)
1761 pos
+= snprintf(buf
+ pos
, LEN_OR_ZERO
, "\"%s", fmt
);
1763 for (i
= 0; i
< tp
->nr_args
; i
++) {
1764 pos
+= snprintf(buf
+ pos
, LEN_OR_ZERO
, " %s=%s",
1765 tp
->args
[i
].name
, tp
->args
[i
].type
->fmt
);
1768 pos
+= snprintf(buf
+ pos
, LEN_OR_ZERO
, "\", %s", arg
);
1770 for (i
= 0; i
< tp
->nr_args
; i
++) {
1771 if (strcmp(tp
->args
[i
].type
->name
, "string") == 0)
1772 pos
+= snprintf(buf
+ pos
, LEN_OR_ZERO
,
1776 pos
+= snprintf(buf
+ pos
, LEN_OR_ZERO
, ", REC->%s",
1782 /* return the length of print_fmt */
1786 static int set_print_fmt(struct trace_probe
*tp
)
1791 /* First: called with 0 length to calculate the needed length */
1792 len
= __set_print_fmt(tp
, NULL
, 0);
1793 print_fmt
= kmalloc(len
+ 1, GFP_KERNEL
);
1797 /* Second: actually write the @print_fmt */
1798 __set_print_fmt(tp
, print_fmt
, len
+ 1);
1799 tp
->call
.print_fmt
= print_fmt
;
1804 #ifdef CONFIG_PERF_EVENTS
1806 /* Kprobe profile handler */
1807 static __kprobes
void kprobe_perf_func(struct kprobe
*kp
,
1808 struct pt_regs
*regs
)
1810 struct trace_probe
*tp
= container_of(kp
, struct trace_probe
, rp
.kp
);
1811 struct ftrace_event_call
*call
= &tp
->call
;
1812 struct kprobe_trace_entry_head
*entry
;
1813 struct hlist_head
*head
;
1814 int size
, __size
, dsize
;
1817 dsize
= __get_data_size(tp
, regs
);
1818 __size
= sizeof(*entry
) + tp
->size
+ dsize
;
1819 size
= ALIGN(__size
+ sizeof(u32
), sizeof(u64
));
1820 size
-= sizeof(u32
);
1821 if (WARN_ONCE(size
> PERF_MAX_TRACE_SIZE
,
1822 "profile buffer not large enough"))
1825 entry
= perf_trace_buf_prepare(size
, call
->event
.type
, regs
, &rctx
);
1829 entry
->ip
= (unsigned long)kp
->addr
;
1830 memset(&entry
[1], 0, dsize
);
1831 store_trace_args(sizeof(*entry
), tp
, regs
, (u8
*)&entry
[1], dsize
);
1833 head
= this_cpu_ptr(call
->perf_events
);
1834 perf_trace_buf_submit(entry
, size
, rctx
, entry
->ip
, 1, regs
, head
);
1837 /* Kretprobe profile handler */
1838 static __kprobes
void kretprobe_perf_func(struct kretprobe_instance
*ri
,
1839 struct pt_regs
*regs
)
1841 struct trace_probe
*tp
= container_of(ri
->rp
, struct trace_probe
, rp
);
1842 struct ftrace_event_call
*call
= &tp
->call
;
1843 struct kretprobe_trace_entry_head
*entry
;
1844 struct hlist_head
*head
;
1845 int size
, __size
, dsize
;
1848 dsize
= __get_data_size(tp
, regs
);
1849 __size
= sizeof(*entry
) + tp
->size
+ dsize
;
1850 size
= ALIGN(__size
+ sizeof(u32
), sizeof(u64
));
1851 size
-= sizeof(u32
);
1852 if (WARN_ONCE(size
> PERF_MAX_TRACE_SIZE
,
1853 "profile buffer not large enough"))
1856 entry
= perf_trace_buf_prepare(size
, call
->event
.type
, regs
, &rctx
);
1860 entry
->func
= (unsigned long)tp
->rp
.kp
.addr
;
1861 entry
->ret_ip
= (unsigned long)ri
->ret_addr
;
1862 store_trace_args(sizeof(*entry
), tp
, regs
, (u8
*)&entry
[1], dsize
);
1864 head
= this_cpu_ptr(call
->perf_events
);
1865 perf_trace_buf_submit(entry
, size
, rctx
, entry
->ret_ip
, 1, regs
, head
);
1867 #endif /* CONFIG_PERF_EVENTS */
1870 int kprobe_register(struct ftrace_event_call
*event
, enum trace_reg type
)
1872 struct trace_probe
*tp
= (struct trace_probe
*)event
->data
;
1875 case TRACE_REG_REGISTER
:
1876 return enable_trace_probe(tp
, TP_FLAG_TRACE
);
1877 case TRACE_REG_UNREGISTER
:
1878 disable_trace_probe(tp
, TP_FLAG_TRACE
);
1881 #ifdef CONFIG_PERF_EVENTS
1882 case TRACE_REG_PERF_REGISTER
:
1883 return enable_trace_probe(tp
, TP_FLAG_PROFILE
);
1884 case TRACE_REG_PERF_UNREGISTER
:
1885 disable_trace_probe(tp
, TP_FLAG_PROFILE
);
1893 int kprobe_dispatcher(struct kprobe
*kp
, struct pt_regs
*regs
)
1895 struct trace_probe
*tp
= container_of(kp
, struct trace_probe
, rp
.kp
);
1897 if (tp
->flags
& TP_FLAG_TRACE
)
1898 kprobe_trace_func(kp
, regs
);
1899 #ifdef CONFIG_PERF_EVENTS
1900 if (tp
->flags
& TP_FLAG_PROFILE
)
1901 kprobe_perf_func(kp
, regs
);
1903 return 0; /* We don't tweek kernel, so just return 0 */
1907 int kretprobe_dispatcher(struct kretprobe_instance
*ri
, struct pt_regs
*regs
)
1909 struct trace_probe
*tp
= container_of(ri
->rp
, struct trace_probe
, rp
);
1911 if (tp
->flags
& TP_FLAG_TRACE
)
1912 kretprobe_trace_func(ri
, regs
);
1913 #ifdef CONFIG_PERF_EVENTS
1914 if (tp
->flags
& TP_FLAG_PROFILE
)
1915 kretprobe_perf_func(ri
, regs
);
1917 return 0; /* We don't tweek kernel, so just return 0 */
1920 static struct trace_event_functions kretprobe_funcs
= {
1921 .trace
= print_kretprobe_event
1924 static struct trace_event_functions kprobe_funcs
= {
1925 .trace
= print_kprobe_event
1928 static int register_probe_event(struct trace_probe
*tp
)
1930 struct ftrace_event_call
*call
= &tp
->call
;
1933 /* Initialize ftrace_event_call */
1934 INIT_LIST_HEAD(&call
->class->fields
);
1935 if (trace_probe_is_return(tp
)) {
1936 call
->event
.funcs
= &kretprobe_funcs
;
1937 call
->class->define_fields
= kretprobe_event_define_fields
;
1939 call
->event
.funcs
= &kprobe_funcs
;
1940 call
->class->define_fields
= kprobe_event_define_fields
;
1942 if (set_print_fmt(tp
) < 0)
1944 ret
= register_ftrace_event(&call
->event
);
1946 kfree(call
->print_fmt
);
1950 call
->class->reg
= kprobe_register
;
1952 ret
= trace_add_event_call(call
);
1954 pr_info("Failed to register kprobe event: %s\n", call
->name
);
1955 kfree(call
->print_fmt
);
1956 unregister_ftrace_event(&call
->event
);
1961 static void unregister_probe_event(struct trace_probe
*tp
)
1963 /* tp->event is unregistered in trace_remove_event_call() */
1964 trace_remove_event_call(&tp
->call
);
1965 kfree(tp
->call
.print_fmt
);
1968 /* Make a debugfs interface for controlling probe points */
1969 static __init
int init_kprobe_trace(void)
1971 struct dentry
*d_tracer
;
1972 struct dentry
*entry
;
1974 if (register_module_notifier(&trace_probe_module_nb
))
1977 d_tracer
= tracing_init_dentry();
1981 entry
= debugfs_create_file("kprobe_events", 0644, d_tracer
,
1982 NULL
, &kprobe_events_ops
);
1984 /* Event list interface */
1986 pr_warning("Could not create debugfs "
1987 "'kprobe_events' entry\n");
1989 /* Profile interface */
1990 entry
= debugfs_create_file("kprobe_profile", 0444, d_tracer
,
1991 NULL
, &kprobe_profile_ops
);
1994 pr_warning("Could not create debugfs "
1995 "'kprobe_profile' entry\n");
1998 fs_initcall(init_kprobe_trace
);
2001 #ifdef CONFIG_FTRACE_STARTUP_TEST
2004 * The "__used" keeps gcc from removing the function symbol
2005 * from the kallsyms table.
2007 static __used
int kprobe_trace_selftest_target(int a1
, int a2
, int a3
,
2008 int a4
, int a5
, int a6
)
2010 return a1
+ a2
+ a3
+ a4
+ a5
+ a6
;
2013 static __init
int kprobe_trace_self_tests_init(void)
2016 int (*target
)(int, int, int, int, int, int);
2017 struct trace_probe
*tp
;
2019 target
= kprobe_trace_selftest_target
;
2021 pr_info("Testing kprobe tracing: ");
2023 ret
= command_trace_probe("p:testprobe kprobe_trace_selftest_target "
2024 "$stack $stack0 +0($stack)");
2025 if (WARN_ON_ONCE(ret
)) {
2026 pr_warning("error on probing function entry.\n");
2029 /* Enable trace point */
2030 tp
= find_trace_probe("testprobe", KPROBE_EVENT_SYSTEM
);
2031 if (WARN_ON_ONCE(tp
== NULL
)) {
2032 pr_warning("error on getting new probe.\n");
2035 enable_trace_probe(tp
, TP_FLAG_TRACE
);
2038 ret
= command_trace_probe("r:testprobe2 kprobe_trace_selftest_target "
2040 if (WARN_ON_ONCE(ret
)) {
2041 pr_warning("error on probing function return.\n");
2044 /* Enable trace point */
2045 tp
= find_trace_probe("testprobe2", KPROBE_EVENT_SYSTEM
);
2046 if (WARN_ON_ONCE(tp
== NULL
)) {
2047 pr_warning("error on getting new probe.\n");
2050 enable_trace_probe(tp
, TP_FLAG_TRACE
);
2056 ret
= target(1, 2, 3, 4, 5, 6);
2058 ret
= command_trace_probe("-:testprobe");
2059 if (WARN_ON_ONCE(ret
)) {
2060 pr_warning("error on deleting a probe.\n");
2064 ret
= command_trace_probe("-:testprobe2");
2065 if (WARN_ON_ONCE(ret
)) {
2066 pr_warning("error on deleting a probe.\n");
2071 release_all_trace_probes();
2073 pr_cont("NG: Some tests are failed. Please check them.\n");
2079 late_initcall(kprobe_trace_self_tests_init
);