2 * Common code for probe-based Dynamic events.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program; if not, write to the Free Software
15 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 * This code was copied from kernel/trace/trace_kprobe.c written by
18 * Masami Hiramatsu <masami.hiramatsu.pt@hitachi.com>
20 * Updates to make this generic:
21 * Copyright (C) IBM Corporation, 2010-2011
22 * Author: Srikar Dronamraju
24 #define pr_fmt(fmt) "trace_probe: " fmt
26 #include "trace_probe.h"
28 const char *reserved_field_names
[] = {
31 "common_preempt_count",
39 /* Printing in basic type function template */
40 #define DEFINE_BASIC_PRINT_TYPE_FUNC(tname, type, fmt) \
41 int PRINT_TYPE_FUNC_NAME(tname)(struct trace_seq *s, const char *name, \
42 void *data, void *ent) \
44 trace_seq_printf(s, " %s=" fmt, name, *(type *)data); \
45 return !trace_seq_has_overflowed(s); \
47 const char PRINT_TYPE_FMT_NAME(tname)[] = fmt; \
48 NOKPROBE_SYMBOL(PRINT_TYPE_FUNC_NAME(tname));
50 DEFINE_BASIC_PRINT_TYPE_FUNC(u8
, u8
, "%u")
51 DEFINE_BASIC_PRINT_TYPE_FUNC(u16
, u16
, "%u")
52 DEFINE_BASIC_PRINT_TYPE_FUNC(u32
, u32
, "%u")
53 DEFINE_BASIC_PRINT_TYPE_FUNC(u64
, u64
, "%Lu")
54 DEFINE_BASIC_PRINT_TYPE_FUNC(s8
, s8
, "%d")
55 DEFINE_BASIC_PRINT_TYPE_FUNC(s16
, s16
, "%d")
56 DEFINE_BASIC_PRINT_TYPE_FUNC(s32
, s32
, "%d")
57 DEFINE_BASIC_PRINT_TYPE_FUNC(s64
, s64
, "%Ld")
58 DEFINE_BASIC_PRINT_TYPE_FUNC(x8
, u8
, "0x%x")
59 DEFINE_BASIC_PRINT_TYPE_FUNC(x16
, u16
, "0x%x")
60 DEFINE_BASIC_PRINT_TYPE_FUNC(x32
, u32
, "0x%x")
61 DEFINE_BASIC_PRINT_TYPE_FUNC(x64
, u64
, "0x%Lx")
63 /* Print type function for string type */
64 int PRINT_TYPE_FUNC_NAME(string
)(struct trace_seq
*s
, const char *name
,
65 void *data
, void *ent
)
67 int len
= *(u32
*)data
>> 16;
70 trace_seq_printf(s
, " %s=(fault)", name
);
72 trace_seq_printf(s
, " %s=\"%s\"", name
,
73 (const char *)get_loc_data(data
, ent
));
74 return !trace_seq_has_overflowed(s
);
76 NOKPROBE_SYMBOL(PRINT_TYPE_FUNC_NAME(string
));
78 const char PRINT_TYPE_FMT_NAME(string
)[] = "\\\"%s\\\"";
80 #define CHECK_FETCH_FUNCS(method, fn) \
81 (((FETCH_FUNC_NAME(method, u8) == fn) || \
82 (FETCH_FUNC_NAME(method, u16) == fn) || \
83 (FETCH_FUNC_NAME(method, u32) == fn) || \
84 (FETCH_FUNC_NAME(method, u64) == fn) || \
85 (FETCH_FUNC_NAME(method, string) == fn) || \
86 (FETCH_FUNC_NAME(method, string_size) == fn)) \
89 /* Data fetch function templates */
90 #define DEFINE_FETCH_reg(type) \
91 void FETCH_FUNC_NAME(reg, type)(struct pt_regs *regs, void *offset, void *dest) \
93 *(type *)dest = (type)regs_get_register(regs, \
94 (unsigned int)((unsigned long)offset)); \
96 NOKPROBE_SYMBOL(FETCH_FUNC_NAME(reg, type));
97 DEFINE_BASIC_FETCH_FUNCS(reg
)
98 /* No string on the register */
99 #define fetch_reg_string NULL
100 #define fetch_reg_string_size NULL
102 #define DEFINE_FETCH_retval(type) \
103 void FETCH_FUNC_NAME(retval, type)(struct pt_regs *regs, \
104 void *dummy, void *dest) \
106 *(type *)dest = (type)regs_return_value(regs); \
108 NOKPROBE_SYMBOL(FETCH_FUNC_NAME(retval, type));
109 DEFINE_BASIC_FETCH_FUNCS(retval
)
110 /* No string on the retval */
111 #define fetch_retval_string NULL
112 #define fetch_retval_string_size NULL
114 /* Dereference memory access function */
115 struct deref_fetch_param
{
116 struct fetch_param orig
;
119 fetch_func_t fetch_size
;
122 #define DEFINE_FETCH_deref(type) \
123 void FETCH_FUNC_NAME(deref, type)(struct pt_regs *regs, \
124 void *data, void *dest) \
126 struct deref_fetch_param *dprm = data; \
127 unsigned long addr; \
128 call_fetch(&dprm->orig, regs, &addr); \
130 addr += dprm->offset; \
131 dprm->fetch(regs, (void *)addr, dest); \
135 NOKPROBE_SYMBOL(FETCH_FUNC_NAME(deref, type));
136 DEFINE_BASIC_FETCH_FUNCS(deref
)
137 DEFINE_FETCH_deref(string
)
139 void FETCH_FUNC_NAME(deref
, string_size
)(struct pt_regs
*regs
,
140 void *data
, void *dest
)
142 struct deref_fetch_param
*dprm
= data
;
145 call_fetch(&dprm
->orig
, regs
, &addr
);
146 if (addr
&& dprm
->fetch_size
) {
147 addr
+= dprm
->offset
;
148 dprm
->fetch_size(regs
, (void *)addr
, dest
);
150 *(string_size
*)dest
= 0;
152 NOKPROBE_SYMBOL(FETCH_FUNC_NAME(deref
, string_size
));
154 static void update_deref_fetch_param(struct deref_fetch_param
*data
)
156 if (CHECK_FETCH_FUNCS(deref
, data
->orig
.fn
))
157 update_deref_fetch_param(data
->orig
.data
);
158 else if (CHECK_FETCH_FUNCS(symbol
, data
->orig
.fn
))
159 update_symbol_cache(data
->orig
.data
);
161 NOKPROBE_SYMBOL(update_deref_fetch_param
);
163 static void free_deref_fetch_param(struct deref_fetch_param
*data
)
165 if (CHECK_FETCH_FUNCS(deref
, data
->orig
.fn
))
166 free_deref_fetch_param(data
->orig
.data
);
167 else if (CHECK_FETCH_FUNCS(symbol
, data
->orig
.fn
))
168 free_symbol_cache(data
->orig
.data
);
171 NOKPROBE_SYMBOL(free_deref_fetch_param
);
173 /* Bitfield fetch function */
174 struct bitfield_fetch_param
{
175 struct fetch_param orig
;
176 unsigned char hi_shift
;
177 unsigned char low_shift
;
180 #define DEFINE_FETCH_bitfield(type) \
181 void FETCH_FUNC_NAME(bitfield, type)(struct pt_regs *regs, \
182 void *data, void *dest) \
184 struct bitfield_fetch_param *bprm = data; \
186 call_fetch(&bprm->orig, regs, &buf); \
188 buf <<= bprm->hi_shift; \
189 buf >>= bprm->low_shift; \
191 *(type *)dest = buf; \
193 NOKPROBE_SYMBOL(FETCH_FUNC_NAME(bitfield, type));
194 DEFINE_BASIC_FETCH_FUNCS(bitfield
)
195 #define fetch_bitfield_string NULL
196 #define fetch_bitfield_string_size NULL
199 update_bitfield_fetch_param(struct bitfield_fetch_param
*data
)
202 * Don't check the bitfield itself, because this must be the
203 * last fetch function.
205 if (CHECK_FETCH_FUNCS(deref
, data
->orig
.fn
))
206 update_deref_fetch_param(data
->orig
.data
);
207 else if (CHECK_FETCH_FUNCS(symbol
, data
->orig
.fn
))
208 update_symbol_cache(data
->orig
.data
);
212 free_bitfield_fetch_param(struct bitfield_fetch_param
*data
)
215 * Don't check the bitfield itself, because this must be the
216 * last fetch function.
218 if (CHECK_FETCH_FUNCS(deref
, data
->orig
.fn
))
219 free_deref_fetch_param(data
->orig
.data
);
220 else if (CHECK_FETCH_FUNCS(symbol
, data
->orig
.fn
))
221 free_symbol_cache(data
->orig
.data
);
226 void FETCH_FUNC_NAME(comm
, string
)(struct pt_regs
*regs
,
227 void *data
, void *dest
)
229 int maxlen
= get_rloc_len(*(u32
*)dest
);
230 u8
*dst
= get_rloc_data(dest
);
236 ret
= strlcpy(dst
, current
->comm
, maxlen
);
237 *(u32
*)dest
= make_data_rloc(ret
, get_rloc_offs(*(u32
*)dest
));
239 NOKPROBE_SYMBOL(FETCH_FUNC_NAME(comm
, string
));
241 void FETCH_FUNC_NAME(comm
, string_size
)(struct pt_regs
*regs
,
242 void *data
, void *dest
)
244 *(u32
*)dest
= strlen(current
->comm
) + 1;
246 NOKPROBE_SYMBOL(FETCH_FUNC_NAME(comm
, string_size
));
248 static const struct fetch_type
*find_fetch_type(const char *type
,
249 const struct fetch_type
*ftbl
)
254 type
= DEFAULT_FETCH_TYPE_STR
;
256 /* Special case: bitfield */
260 type
= strchr(type
, '/');
265 if (kstrtoul(type
, 0, &bs
))
270 return find_fetch_type("u8", ftbl
);
272 return find_fetch_type("u16", ftbl
);
274 return find_fetch_type("u32", ftbl
);
276 return find_fetch_type("u64", ftbl
);
282 for (i
= 0; ftbl
[i
].name
; i
++) {
283 if (strcmp(type
, ftbl
[i
].name
) == 0)
291 /* Special function : only accept unsigned long */
292 static void fetch_kernel_stack_address(struct pt_regs
*regs
, void *dummy
, void *dest
)
294 *(unsigned long *)dest
= kernel_stack_pointer(regs
);
296 NOKPROBE_SYMBOL(fetch_kernel_stack_address
);
298 static void fetch_user_stack_address(struct pt_regs
*regs
, void *dummy
, void *dest
)
300 *(unsigned long *)dest
= user_stack_pointer(regs
);
302 NOKPROBE_SYMBOL(fetch_user_stack_address
);
304 static fetch_func_t
get_fetch_size_function(const struct fetch_type
*type
,
305 fetch_func_t orig_fn
,
306 const struct fetch_type
*ftbl
)
310 if (type
!= &ftbl
[FETCH_TYPE_STRING
])
311 return NULL
; /* Only string type needs size function */
313 for (i
= 0; i
< FETCH_MTD_END
; i
++)
314 if (type
->fetch
[i
] == orig_fn
)
315 return ftbl
[FETCH_TYPE_STRSIZE
].fetch
[i
];
317 WARN_ON(1); /* This should not happen */
322 /* Split symbol and offset. */
323 int traceprobe_split_symbol_offset(char *symbol
, unsigned long *offset
)
331 tmp
= strchr(symbol
, '+');
333 /* skip sign because kstrtoul doesn't accept '+' */
334 ret
= kstrtoul(tmp
+ 1, 0, offset
);
345 #define PARAM_MAX_STACK (THREAD_SIZE / sizeof(unsigned long))
347 static int parse_probe_vars(char *arg
, const struct fetch_type
*t
,
348 struct fetch_param
*f
, bool is_return
,
354 if (strcmp(arg
, "retval") == 0) {
356 f
->fn
= t
->fetch
[FETCH_MTD_retval
];
359 } else if (strncmp(arg
, "stack", 5) == 0) {
360 if (arg
[5] == '\0') {
361 if (strcmp(t
->name
, DEFAULT_FETCH_TYPE_STR
))
365 f
->fn
= fetch_kernel_stack_address
;
367 f
->fn
= fetch_user_stack_address
;
368 } else if (isdigit(arg
[5])) {
369 ret
= kstrtoul(arg
+ 5, 10, ¶m
);
370 if (ret
|| (is_kprobe
&& param
> PARAM_MAX_STACK
))
373 f
->fn
= t
->fetch
[FETCH_MTD_stack
];
374 f
->data
= (void *)param
;
378 } else if (strcmp(arg
, "comm") == 0) {
379 if (strcmp(t
->name
, "string") != 0 &&
380 strcmp(t
->name
, "string_size") != 0)
382 f
->fn
= t
->fetch
[FETCH_MTD_comm
];
389 /* Recursive argument parser */
390 static int parse_probe_arg(char *arg
, const struct fetch_type
*t
,
391 struct fetch_param
*f
, bool is_return
, bool is_kprobe
,
392 const struct fetch_type
*ftbl
)
401 ret
= parse_probe_vars(arg
+ 1, t
, f
, is_return
, is_kprobe
);
404 case '%': /* named register */
405 ret
= regs_query_register_offset(arg
+ 1);
407 f
->fn
= t
->fetch
[FETCH_MTD_reg
];
408 f
->data
= (void *)(unsigned long)ret
;
413 case '@': /* memory, file-offset or symbol */
414 if (isdigit(arg
[1])) {
415 ret
= kstrtoul(arg
+ 1, 0, ¶m
);
419 f
->fn
= t
->fetch
[FETCH_MTD_memory
];
420 f
->data
= (void *)param
;
421 } else if (arg
[1] == '+') {
422 /* kprobes don't support file offsets */
426 ret
= kstrtol(arg
+ 2, 0, &offset
);
430 f
->fn
= t
->fetch
[FETCH_MTD_file_offset
];
431 f
->data
= (void *)offset
;
433 /* uprobes don't support symbols */
437 ret
= traceprobe_split_symbol_offset(arg
+ 1, &offset
);
441 f
->data
= alloc_symbol_cache(arg
+ 1, offset
);
443 f
->fn
= t
->fetch
[FETCH_MTD_symbol
];
447 case '+': /* deref memory */
448 arg
++; /* Skip '+', because kstrtol() rejects it. */
450 tmp
= strchr(arg
, '(');
455 ret
= kstrtol(arg
, 0, &offset
);
461 tmp
= strrchr(arg
, ')');
464 struct deref_fetch_param
*dprm
;
465 const struct fetch_type
*t2
;
467 t2
= find_fetch_type(NULL
, ftbl
);
469 dprm
= kzalloc(sizeof(struct deref_fetch_param
), GFP_KERNEL
);
474 dprm
->offset
= offset
;
475 dprm
->fetch
= t
->fetch
[FETCH_MTD_memory
];
476 dprm
->fetch_size
= get_fetch_size_function(t
,
478 ret
= parse_probe_arg(arg
, t2
, &dprm
->orig
, is_return
,
483 f
->fn
= t
->fetch
[FETCH_MTD_deref
];
484 f
->data
= (void *)dprm
;
489 if (!ret
&& !f
->fn
) { /* Parsed, but do not find fetch method */
490 pr_info("%s type has no corresponding fetch method.\n", t
->name
);
497 #define BYTES_TO_BITS(nb) ((BITS_PER_LONG * (nb)) / sizeof(long))
499 /* Bitfield type needs to be parsed into a fetch function */
500 static int __parse_bitfield_probe_arg(const char *bf
,
501 const struct fetch_type
*t
,
502 struct fetch_param
*f
)
504 struct bitfield_fetch_param
*bprm
;
505 unsigned long bw
, bo
;
511 bprm
= kzalloc(sizeof(*bprm
), GFP_KERNEL
);
516 f
->fn
= t
->fetch
[FETCH_MTD_bitfield
];
517 f
->data
= (void *)bprm
;
518 bw
= simple_strtoul(bf
+ 1, &tail
, 0); /* Use simple one */
520 if (bw
== 0 || *tail
!= '@')
524 bo
= simple_strtoul(bf
, &tail
, 0);
526 if (tail
== bf
|| *tail
!= '/')
529 bprm
->hi_shift
= BYTES_TO_BITS(t
->size
) - (bw
+ bo
);
530 bprm
->low_shift
= bprm
->hi_shift
+ bo
;
532 return (BYTES_TO_BITS(t
->size
) < (bw
+ bo
)) ? -EINVAL
: 0;
535 /* String length checking wrapper */
536 int traceprobe_parse_probe_arg(char *arg
, ssize_t
*size
,
537 struct probe_arg
*parg
, bool is_return
, bool is_kprobe
,
538 const struct fetch_type
*ftbl
)
543 if (strlen(arg
) > MAX_ARGSTR_LEN
) {
544 pr_info("Argument is too long.: %s\n", arg
);
547 parg
->comm
= kstrdup(arg
, GFP_KERNEL
);
549 pr_info("Failed to allocate memory for command '%s'.\n", arg
);
552 t
= strchr(parg
->comm
, ':');
554 arg
[t
- parg
->comm
] = '\0';
558 * The default type of $comm should be "string", and it can't be
561 if (!t
&& strcmp(arg
, "$comm") == 0)
563 parg
->type
= find_fetch_type(t
, ftbl
);
565 pr_info("Unsupported type: %s\n", t
);
568 parg
->offset
= *size
;
569 *size
+= parg
->type
->size
;
570 ret
= parse_probe_arg(arg
, parg
->type
, &parg
->fetch
, is_return
,
573 if (ret
>= 0 && t
!= NULL
)
574 ret
= __parse_bitfield_probe_arg(t
, parg
->type
, &parg
->fetch
);
577 parg
->fetch_size
.fn
= get_fetch_size_function(parg
->type
,
580 parg
->fetch_size
.data
= parg
->fetch
.data
;
586 /* Return 1 if name is reserved or already used by another argument */
587 int traceprobe_conflict_field_name(const char *name
,
588 struct probe_arg
*args
, int narg
)
592 for (i
= 0; i
< ARRAY_SIZE(reserved_field_names
); i
++)
593 if (strcmp(reserved_field_names
[i
], name
) == 0)
596 for (i
= 0; i
< narg
; i
++)
597 if (strcmp(args
[i
].name
, name
) == 0)
603 void traceprobe_update_arg(struct probe_arg
*arg
)
605 if (CHECK_FETCH_FUNCS(bitfield
, arg
->fetch
.fn
))
606 update_bitfield_fetch_param(arg
->fetch
.data
);
607 else if (CHECK_FETCH_FUNCS(deref
, arg
->fetch
.fn
))
608 update_deref_fetch_param(arg
->fetch
.data
);
609 else if (CHECK_FETCH_FUNCS(symbol
, arg
->fetch
.fn
))
610 update_symbol_cache(arg
->fetch
.data
);
613 void traceprobe_free_probe_arg(struct probe_arg
*arg
)
615 if (CHECK_FETCH_FUNCS(bitfield
, arg
->fetch
.fn
))
616 free_bitfield_fetch_param(arg
->fetch
.data
);
617 else if (CHECK_FETCH_FUNCS(deref
, arg
->fetch
.fn
))
618 free_deref_fetch_param(arg
->fetch
.data
);
619 else if (CHECK_FETCH_FUNCS(symbol
, arg
->fetch
.fn
))
620 free_symbol_cache(arg
->fetch
.data
);
626 static int __set_print_fmt(struct trace_probe
*tp
, char *buf
, int len
,
632 const char *fmt
, *arg
;
636 arg
= "REC->" FIELD_STRING_IP
;
638 fmt
= "(%lx <- %lx)";
639 arg
= "REC->" FIELD_STRING_FUNC
", REC->" FIELD_STRING_RETIP
;
642 /* When len=0, we just calculate the needed length */
643 #define LEN_OR_ZERO (len ? len - pos : 0)
645 pos
+= snprintf(buf
+ pos
, LEN_OR_ZERO
, "\"%s", fmt
);
647 for (i
= 0; i
< tp
->nr_args
; i
++) {
648 pos
+= snprintf(buf
+ pos
, LEN_OR_ZERO
, " %s=%s",
649 tp
->args
[i
].name
, tp
->args
[i
].type
->fmt
);
652 pos
+= snprintf(buf
+ pos
, LEN_OR_ZERO
, "\", %s", arg
);
654 for (i
= 0; i
< tp
->nr_args
; i
++) {
655 if (strcmp(tp
->args
[i
].type
->name
, "string") == 0)
656 pos
+= snprintf(buf
+ pos
, LEN_OR_ZERO
,
660 pos
+= snprintf(buf
+ pos
, LEN_OR_ZERO
, ", REC->%s",
666 /* return the length of print_fmt */
670 int set_print_fmt(struct trace_probe
*tp
, bool is_return
)
675 /* First: called with 0 length to calculate the needed length */
676 len
= __set_print_fmt(tp
, NULL
, 0, is_return
);
677 print_fmt
= kmalloc(len
+ 1, GFP_KERNEL
);
681 /* Second: actually write the @print_fmt */
682 __set_print_fmt(tp
, print_fmt
, len
+ 1, is_return
);
683 tp
->call
.print_fmt
= print_fmt
;