1 // SPDX-License-Identifier: GPL-2.0
3 * Common code for probe-based Dynamic events.
5 * This code was copied from kernel/trace/trace_kprobe.c written by
6 * Masami Hiramatsu <masami.hiramatsu.pt@hitachi.com>
8 * Updates to make this generic:
9 * Copyright (C) IBM Corporation, 2010-2011
10 * Author: Srikar Dronamraju
12 #define pr_fmt(fmt) "trace_probe: " fmt
14 #include "trace_probe.h"
16 static const char *reserved_field_names[] = {
19 "common_preempt_count",
27 /* Printing in basic type function template */
28 #define DEFINE_BASIC_PRINT_TYPE_FUNC(tname, type, fmt) \
29 int PRINT_TYPE_FUNC_NAME(tname)(struct trace_seq *s, void *data, void *ent)\
31 trace_seq_printf(s, fmt, *(type *)data); \
32 return !trace_seq_has_overflowed(s); \
34 const char PRINT_TYPE_FMT_NAME(tname)[] = fmt;
36 DEFINE_BASIC_PRINT_TYPE_FUNC(u8, u8, "%u")
37 DEFINE_BASIC_PRINT_TYPE_FUNC(u16, u16, "%u")
38 DEFINE_BASIC_PRINT_TYPE_FUNC(u32, u32, "%u")
39 DEFINE_BASIC_PRINT_TYPE_FUNC(u64, u64, "%Lu")
40 DEFINE_BASIC_PRINT_TYPE_FUNC(s8, s8, "%d")
41 DEFINE_BASIC_PRINT_TYPE_FUNC(s16, s16, "%d")
42 DEFINE_BASIC_PRINT_TYPE_FUNC(s32, s32, "%d")
43 DEFINE_BASIC_PRINT_TYPE_FUNC(s64, s64, "%Ld")
44 DEFINE_BASIC_PRINT_TYPE_FUNC(x8, u8, "0x%x")
45 DEFINE_BASIC_PRINT_TYPE_FUNC(x16, u16, "0x%x")
46 DEFINE_BASIC_PRINT_TYPE_FUNC(x32, u32, "0x%x")
47 DEFINE_BASIC_PRINT_TYPE_FUNC(x64, u64, "0x%Lx")
49 int PRINT_TYPE_FUNC_NAME(symbol)(struct trace_seq *s, void *data, void *ent)
51 trace_seq_printf(s, "%pS", (void *)*(unsigned long *)data);
52 return !trace_seq_has_overflowed(s);
54 const char PRINT_TYPE_FMT_NAME(symbol)[] = "%pS";
56 /* Print type function for string type */
57 int PRINT_TYPE_FUNC_NAME(string)(struct trace_seq *s, void *data, void *ent)
59 int len = *(u32 *)data >> 16;
62 trace_seq_puts(s, "(fault)");
64 trace_seq_printf(s, "\"%s\"",
65 (const char *)get_loc_data(data, ent));
66 return !trace_seq_has_overflowed(s);
69 const char PRINT_TYPE_FMT_NAME(string)[] = "\\\"%s\\\"";
71 /* Fetch type information table */
72 static const struct fetch_type probe_fetch_types[] = {
74 __ASSIGN_FETCH_TYPE("string", string, string, sizeof(u32), 1,
77 ASSIGN_FETCH_TYPE(u8, u8, 0),
78 ASSIGN_FETCH_TYPE(u16, u16, 0),
79 ASSIGN_FETCH_TYPE(u32, u32, 0),
80 ASSIGN_FETCH_TYPE(u64, u64, 0),
81 ASSIGN_FETCH_TYPE(s8, u8, 1),
82 ASSIGN_FETCH_TYPE(s16, u16, 1),
83 ASSIGN_FETCH_TYPE(s32, u32, 1),
84 ASSIGN_FETCH_TYPE(s64, u64, 1),
85 ASSIGN_FETCH_TYPE_ALIAS(x8, u8, u8, 0),
86 ASSIGN_FETCH_TYPE_ALIAS(x16, u16, u16, 0),
87 ASSIGN_FETCH_TYPE_ALIAS(x32, u32, u32, 0),
88 ASSIGN_FETCH_TYPE_ALIAS(x64, u64, u64, 0),
89 ASSIGN_FETCH_TYPE_ALIAS(symbol, ADDR_FETCH_TYPE, ADDR_FETCH_TYPE, 0),
94 static const struct fetch_type *find_fetch_type(const char *type)
99 type = DEFAULT_FETCH_TYPE_STR;
101 /* Special case: bitfield */
105 type = strchr(type, '/');
110 if (kstrtoul(type, 0, &bs))
115 return find_fetch_type("u8");
117 return find_fetch_type("u16");
119 return find_fetch_type("u32");
121 return find_fetch_type("u64");
127 for (i = 0; probe_fetch_types[i].name; i++) {
128 if (strcmp(type, probe_fetch_types[i].name) == 0)
129 return &probe_fetch_types[i];
136 /* Split symbol and offset. */
137 int traceprobe_split_symbol_offset(char *symbol, long *offset)
145 tmp = strpbrk(symbol, "+-");
147 ret = kstrtol(tmp, 0, offset);
157 /* @buf must has MAX_EVENT_NAME_LEN size */
158 int traceprobe_parse_event_name(const char **pevent, const char **pgroup,
161 const char *slash, *event = *pevent;
164 slash = strchr(event, '/');
166 if (slash == event) {
167 pr_info("Group name is not specified\n");
170 if (slash - event + 1 > MAX_EVENT_NAME_LEN) {
171 pr_info("Group name is too long\n");
174 strlcpy(buf, event, slash - event + 1);
181 pr_info("Event name is not specified\n");
183 } else if (len > MAX_EVENT_NAME_LEN) {
184 pr_info("Event name is too long\n");
190 #define PARAM_MAX_STACK (THREAD_SIZE / sizeof(unsigned long))
192 static int parse_probe_vars(char *arg, const struct fetch_type *t,
193 struct fetch_insn *code, unsigned int flags)
199 if (strcmp(arg, "retval") == 0) {
200 if (flags & TPARG_FL_RETURN)
201 code->op = FETCH_OP_RETVAL;
204 } else if ((len = str_has_prefix(arg, "stack"))) {
205 if (arg[len] == '\0') {
206 code->op = FETCH_OP_STACKP;
207 } else if (isdigit(arg[len])) {
208 ret = kstrtoul(arg + len, 10, ¶m);
209 if (ret || ((flags & TPARG_FL_KERNEL) &&
210 param > PARAM_MAX_STACK))
213 code->op = FETCH_OP_STACK;
214 code->param = (unsigned int)param;
218 } else if (strcmp(arg, "comm") == 0) {
219 code->op = FETCH_OP_COMM;
220 #ifdef CONFIG_HAVE_FUNCTION_ARG_ACCESS_API
221 } else if (((flags & TPARG_FL_MASK) ==
222 (TPARG_FL_KERNEL | TPARG_FL_FENTRY)) &&
223 (len = str_has_prefix(arg, "arg"))) {
224 if (!isdigit(arg[len]))
226 ret = kstrtoul(arg + len, 10, ¶m);
227 if (ret || !param || param > PARAM_MAX_STACK)
229 code->op = FETCH_OP_ARG;
230 code->param = (unsigned int)param - 1;
238 /* Recursive argument parser */
240 parse_probe_arg(char *arg, const struct fetch_type *type,
241 struct fetch_insn **pcode, struct fetch_insn *end,
244 struct fetch_insn *code = *pcode;
252 ret = parse_probe_vars(arg + 1, type, code, flags);
255 case '%': /* named register */
256 ret = regs_query_register_offset(arg + 1);
258 code->op = FETCH_OP_REG;
259 code->param = (unsigned int)ret;
264 case '@': /* memory, file-offset or symbol */
265 if (isdigit(arg[1])) {
266 ret = kstrtoul(arg + 1, 0, ¶m);
270 code->op = FETCH_OP_IMM;
271 code->immediate = param;
272 } else if (arg[1] == '+') {
273 /* kprobes don't support file offsets */
274 if (flags & TPARG_FL_KERNEL)
277 ret = kstrtol(arg + 2, 0, &offset);
281 code->op = FETCH_OP_FOFFS;
282 code->immediate = (unsigned long)offset; // imm64?
284 /* uprobes don't support symbols */
285 if (!(flags & TPARG_FL_KERNEL))
288 /* Preserve symbol for updating */
289 code->op = FETCH_NOP_SYMBOL;
290 code->data = kstrdup(arg + 1, GFP_KERNEL);
296 code->op = FETCH_OP_IMM;
299 /* These are fetching from memory */
303 code->op = FETCH_OP_DEREF;
304 code->offset = offset;
307 case '+': /* deref memory */
308 arg++; /* Skip '+', because kstrtol() rejects it. */
311 tmp = strchr(arg, '(');
316 ret = kstrtol(arg, 0, &offset);
321 tmp = strrchr(arg, ')');
324 const struct fetch_type *t2 = find_fetch_type(NULL);
327 ret = parse_probe_arg(arg, t2, &code, end, flags);
330 if (code->op == FETCH_OP_COMM)
336 code->op = FETCH_OP_DEREF;
337 code->offset = offset;
341 if (!ret && code->op == FETCH_OP_NOP) {
342 /* Parsed, but do not find fetch method */
348 #define BYTES_TO_BITS(nb) ((BITS_PER_LONG * (nb)) / sizeof(long))
350 /* Bitfield type needs to be parsed into a fetch function */
351 static int __parse_bitfield_probe_arg(const char *bf,
352 const struct fetch_type *t,
353 struct fetch_insn **pcode)
355 struct fetch_insn *code = *pcode;
356 unsigned long bw, bo;
362 bw = simple_strtoul(bf + 1, &tail, 0); /* Use simple one */
364 if (bw == 0 || *tail != '@')
368 bo = simple_strtoul(bf, &tail, 0);
370 if (tail == bf || *tail != '/')
373 if (code->op != FETCH_OP_NOP)
377 code->op = FETCH_OP_MOD_BF;
378 code->lshift = BYTES_TO_BITS(t->size) - (bw + bo);
379 code->rshift = BYTES_TO_BITS(t->size) - bw;
380 code->basesize = t->size;
382 return (BYTES_TO_BITS(t->size) < (bw + bo)) ? -EINVAL : 0;
385 /* String length checking wrapper */
386 static int traceprobe_parse_probe_arg_body(char *arg, ssize_t *size,
387 struct probe_arg *parg, unsigned int flags)
389 struct fetch_insn *code, *scode, *tmp = NULL;
393 if (strlen(arg) > MAX_ARGSTR_LEN) {
394 pr_info("Argument is too long.: %s\n", arg);
397 parg->comm = kstrdup(arg, GFP_KERNEL);
399 pr_info("Failed to allocate memory for command '%s'.\n", arg);
402 t = strchr(arg, ':');
405 t2 = strchr(++t, '[');
408 parg->count = simple_strtoul(t2 + 1, &t2, 0);
409 if (strcmp(t2, "]") || parg->count == 0)
411 if (parg->count > MAX_ARRAY_LEN)
416 * The default type of $comm should be "string", and it can't be
419 if (!t && strcmp(arg, "$comm") == 0)
420 parg->type = find_fetch_type("string");
422 parg->type = find_fetch_type(t);
424 pr_info("Unsupported type: %s\n", t);
427 parg->offset = *size;
428 *size += parg->type->size * (parg->count ?: 1);
431 len = strlen(parg->type->fmttype) + 6;
432 parg->fmt = kmalloc(len, GFP_KERNEL);
435 snprintf(parg->fmt, len, "%s[%d]", parg->type->fmttype,
439 code = tmp = kzalloc(sizeof(*code) * FETCH_INSN_MAX, GFP_KERNEL);
442 code[FETCH_INSN_MAX - 1].op = FETCH_OP_END;
444 ret = parse_probe_arg(arg, parg->type, &code, &code[FETCH_INSN_MAX - 1],
449 /* Store operation */
450 if (!strcmp(parg->type->name, "string")) {
451 if (code->op != FETCH_OP_DEREF && code->op != FETCH_OP_IMM &&
452 code->op != FETCH_OP_COMM) {
453 pr_info("string only accepts memory or address.\n");
457 if (code->op != FETCH_OP_DEREF || parg->count) {
459 * IMM and COMM is pointing actual address, those must
460 * be kept, and if parg->count != 0, this is an array
461 * of string pointers instead of string address itself.
464 if (code->op != FETCH_OP_NOP) {
469 code->op = FETCH_OP_ST_STRING; /* In DEREF case, replace it */
470 code->size = parg->type->size;
471 parg->dynamic = true;
472 } else if (code->op == FETCH_OP_DEREF) {
473 code->op = FETCH_OP_ST_MEM;
474 code->size = parg->type->size;
477 if (code->op != FETCH_OP_NOP) {
481 code->op = FETCH_OP_ST_RAW;
482 code->size = parg->type->size;
485 /* Modify operation */
487 ret = __parse_bitfield_probe_arg(t, parg->type, &code);
491 /* Loop(Array) operation */
493 if (scode->op != FETCH_OP_ST_MEM &&
494 scode->op != FETCH_OP_ST_STRING) {
495 pr_info("array only accepts memory or address\n");
500 if (code->op != FETCH_OP_NOP) {
504 code->op = FETCH_OP_LP_ARRAY;
505 code->param = parg->count;
508 code->op = FETCH_OP_END;
510 /* Shrink down the code buffer */
511 parg->code = kzalloc(sizeof(*code) * (code - tmp + 1), GFP_KERNEL);
515 memcpy(parg->code, tmp, sizeof(*code) * (code - tmp + 1));
519 for (code = tmp; code < tmp + FETCH_INSN_MAX; code++)
520 if (code->op == FETCH_NOP_SYMBOL)
528 /* Return 1 if name is reserved or already used by another argument */
529 static int traceprobe_conflict_field_name(const char *name,
530 struct probe_arg *args, int narg)
534 for (i = 0; i < ARRAY_SIZE(reserved_field_names); i++)
535 if (strcmp(reserved_field_names[i], name) == 0)
538 for (i = 0; i < narg; i++)
539 if (strcmp(args[i].name, name) == 0)
545 int traceprobe_parse_probe_arg(struct trace_probe *tp, int i, char *arg,
548 struct probe_arg *parg = &tp->args[i];
552 /* Increment count for freeing args in error case */
555 body = strchr(arg, '=');
557 parg->name = kmemdup_nul(arg, body - arg, GFP_KERNEL);
560 /* If argument name is omitted, set "argN" */
561 parg->name = kasprintf(GFP_KERNEL, "arg%d", i + 1);
567 if (!is_good_name(parg->name)) {
568 pr_info("Invalid argument[%d] name: %s\n",
573 if (traceprobe_conflict_field_name(parg->name, tp->args, i)) {
574 pr_info("Argument[%d]: '%s' conflicts with another field.\n",
579 /* Parse fetch argument */
580 ret = traceprobe_parse_probe_arg_body(body, &tp->size, parg, flags);
582 pr_info("Parse error at argument[%d]. (%d)\n", i, ret);
586 void traceprobe_free_probe_arg(struct probe_arg *arg)
588 struct fetch_insn *code = arg->code;
590 while (code && code->op != FETCH_OP_END) {
591 if (code->op == FETCH_NOP_SYMBOL)
601 int traceprobe_update_arg(struct probe_arg *arg)
603 struct fetch_insn *code = arg->code;
609 while (code && code->op != FETCH_OP_END) {
610 if (code->op == FETCH_NOP_SYMBOL) {
611 if (code[1].op != FETCH_OP_IMM)
614 tmp = strpbrk(code->data, "+-");
617 ret = traceprobe_split_symbol_offset(code->data,
623 (unsigned long)kallsyms_lookup_name(code->data);
626 if (!code[1].immediate)
628 code[1].immediate += offset;
635 /* When len=0, we just calculate the needed length */
636 #define LEN_OR_ZERO (len ? len - pos : 0)
637 static int __set_print_fmt(struct trace_probe *tp, char *buf, int len,
640 struct probe_arg *parg;
643 const char *fmt, *arg;
647 arg = "REC->" FIELD_STRING_IP;
649 fmt = "(%lx <- %lx)";
650 arg = "REC->" FIELD_STRING_FUNC ", REC->" FIELD_STRING_RETIP;
653 pos += snprintf(buf + pos, LEN_OR_ZERO, "\"%s", fmt);
655 for (i = 0; i < tp->nr_args; i++) {
657 pos += snprintf(buf + pos, LEN_OR_ZERO, " %s=", parg->name);
659 pos += snprintf(buf + pos, LEN_OR_ZERO, "{%s",
661 for (j = 1; j < parg->count; j++)
662 pos += snprintf(buf + pos, LEN_OR_ZERO, ",%s",
664 pos += snprintf(buf + pos, LEN_OR_ZERO, "}");
666 pos += snprintf(buf + pos, LEN_OR_ZERO, "%s",
670 pos += snprintf(buf + pos, LEN_OR_ZERO, "\", %s", arg);
672 for (i = 0; i < tp->nr_args; i++) {
675 if (strcmp(parg->type->name, "string") == 0)
676 fmt = ", __get_str(%s[%d])";
678 fmt = ", REC->%s[%d]";
679 for (j = 0; j < parg->count; j++)
680 pos += snprintf(buf + pos, LEN_OR_ZERO,
683 if (strcmp(parg->type->name, "string") == 0)
684 fmt = ", __get_str(%s)";
687 pos += snprintf(buf + pos, LEN_OR_ZERO,
692 /* return the length of print_fmt */
697 int traceprobe_set_print_fmt(struct trace_probe *tp, bool is_return)
702 /* First: called with 0 length to calculate the needed length */
703 len = __set_print_fmt(tp, NULL, 0, is_return);
704 print_fmt = kmalloc(len + 1, GFP_KERNEL);
708 /* Second: actually write the @print_fmt */
709 __set_print_fmt(tp, print_fmt, len + 1, is_return);
710 tp->call.print_fmt = print_fmt;
715 int traceprobe_define_arg_fields(struct trace_event_call *event_call,
716 size_t offset, struct trace_probe *tp)
720 /* Set argument names as fields */
721 for (i = 0; i < tp->nr_args; i++) {
722 struct probe_arg *parg = &tp->args[i];
723 const char *fmt = parg->type->fmttype;
724 int size = parg->type->size;
730 ret = trace_define_field(event_call, fmt, parg->name,
731 offset + parg->offset, size,
732 parg->type->is_signed,