tracing/probes: Cleanup with guard and __free for kprobe and fprobe
Masami Hiramatsu (Google)
maintainerv5 cover tracing/probes: Cleanup with guard and __free for kprobe and fprobe
Hi,
Here is the 5th version of the series to fix and cleanup probe events in ftrace with __free(). The previous series is here;
https://lore.kernel.org/all/173629943548.1450013.12412761424554510119.stgit@devnote2/
In this version, I updated [3/5] according to the comment from Steve.
Thanks,
---
Masami Hiramatsu (Google) (5):
tracing/kprobes: Fix to free objects when failed to copy a symbol
tracing: Use __free() in trace_probe for cleanup
tracing: Use __free() for kprobe events to cleanup tracing/kprobes: Simplify __trace_kprobe_create() by removing gotos
tracing: Adopt __free() and guard() for trace_fprobe.c
kernel/trace/trace_fprobe.c | 129 ++++++++++++++++++++----------------------- kernel/trace/trace_kprobe.c | 130 +++++++++++++++++++++---------------------- kernel/trace/trace_probe.c | 51 ++++++----------- 3 files changed, 141 insertions(+), 169 deletions(-)
--
Masami Hiramatsu (Google) <[email protected]>
Masami Hiramatsu (Google)
maintainerPATCH v5 1/5 tracing/kprobes: Fix to free objects when failed to copy a symbol
From: Masami Hiramatsu (Google) <[email protected]>
In __trace_kprobe_create(), if something fails it must goto error block to free objects. But when strdup() a symbol, it returns without that. Fix it to goto the error block to free objects correctly.
--- kernel/trace/trace_kprobe.c | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-)
kernel/trace/trace_kprobe.c +4 -2
@@ -940,8 +940,10 @@ static int __trace_kprobe_create(int argc, const char *argv[]) }/* a symbol specified */ symbol =kstrdup (argv[1 ],GFP_KERNEL ); -if (!symbol) -return -ENOMEM ; +if (!symbol) { + ret = -ENOMEM ; + goto error; + } tmp =strchr (symbol,'%' );if (tmp) {
Masami Hiramatsu (Google)
maintainerPATCH v5 2/5 tracing: Use __free() in trace_probe for cleanup
In reply to Masami Hiramatsu (Google)From: Masami Hiramatsu (Google) <[email protected]>
Use __free() in trace_probe to cleanup some gotos.
---
Changes in v5:
- Fix to remove kfree() in for loop. Since I confirmed __free(kfree) is called in each iteration.
--- kernel/trace/trace_probe.c | 51 +++++++++++++++----------------------------- 1 file changed, 17 insertions(+), 34 deletions(-)
kernel/trace/trace_probe.c +17 -34
@@ -1409,7 +1409,7 @@ static int traceprobe_parse_probe_arg_body(const char *argv, ssize_t *size, struct traceprobe_parse_context *ctx) {struct fetch_insn *code, *tmp =NULL ; -char *type, *arg; + char *type, *arg __free(kfree) = NULL;int ret, len; len =strlen (argv);
@@ -1426,22 +1426,16 @@ static int traceprobe_parse_probe_arg_body(const char *argv, ssize_t *size,return -ENOMEM ; parg->comm =kstrdup (arg,GFP_KERNEL ); -if (!parg->comm) { - ret = -ENOMEM ; - goto out; - } +if (!parg->comm) +return -ENOMEM ; type =parse_probe_arg_type (arg, parg, ctx); -if (IS_ERR (type)) { - ret =PTR_ERR (type); - goto out; - } +if (IS_ERR (type)) +return PTR_ERR (type); code = tmp =kcalloc (FETCH_INSN_MAX ,sizeof (*code),GFP_KERNEL ); -if (!code) { - ret = -ENOMEM ; - goto out; - } +if (!code) +return -ENOMEM ; code[FETCH_INSN_MAX -1 ].op =FETCH_OP_END ; ctx->last_type =NULL ;
@@ -1497,8 +1491,6 @@ static int traceprobe_parse_probe_arg_body(const char *argv, ssize_t *size,kfree (code->data); }kfree (tmp); -out: -kfree (arg);return ret; }
@@ -1668,7 +1660,7 @@ const char **traceprobe_expand_meta_args(int argc, const char *argv[], {const struct btf_param *params =NULL ;int i, j, n, used, ret, args_idx =-1 ; -const char **new_argv =NULL ; + const char **new_argv __free(kfree) = NULL; ret =argv_has_var_arg (argc, argv, &args_idx, ctx);if (ret <0 )
@@ -1707,7 +1699,7 @@ const char **traceprobe_expand_meta_args(int argc, const char *argv[], ret =sprint_nth_btf_arg (n,"" , buf + used, bufsize - used, ctx);if (ret <0 ) - goto error; +return ERR_PTR (ret); new_argv[j++] = buf + used; used += ret +1 ;
@@ -1721,25 +1713,20 @@ const char **traceprobe_expand_meta_args(int argc, const char *argv[], n =simple_strtoul (argv[i] +4 , &type,10 );if (type && !(*type ==':' || *type =='\0' )) {trace_probe_log_err (0 ,BAD_VAR ); - ret = -ENOENT ; - goto error; +return ERR_PTR (-ENOENT ); }/* Note: $argN starts from $arg1 */ ret =sprint_nth_btf_arg (n -1 , type, buf + used, bufsize - used, ctx);if (ret <0 ) - goto error; +return ERR_PTR (ret); new_argv[j++] = buf + used; used += ret +1 ; }else new_argv[j++] = argv[i]; } -return new_argv; - -error: -kfree (new_argv); -return ERR_PTR (ret); +return_ptr (new_argv); }/* @buf: *buf must be equal to NULL. Caller must to free *buf */
@@ -1747,14 +1734,14 @@ int traceprobe_expand_dentry_args(int argc, const char *argv[], char **buf) {int i, used, ret;const int bufsize =MAX_DENTRY_ARGS_LEN ; -char *tmpbuf =NULL ; + char *tmpbuf __free(kfree) = NULL;if (*buf)return -EINVAL ; used =0 ;for (i =0 ; i < argc; i++) { -char *tmp; + char *tmp __free(kfree) = NULL;char *equal;size_t arg_len;
@@ -1769,7 +1756,7 @@ int traceprobe_expand_dentry_args(int argc, const char *argv[], char **buf) tmp =kstrdup (argv[i],GFP_KERNEL );if (!tmp) - goto nomem; +return -ENOMEM ; equal =strchr (tmp,'=' );if (equal)
@@ -1790,18 +1777,14 @@ int traceprobe_expand_dentry_args(int argc, const char *argv[], char **buf) offsetof(struct file, f_path.dentry), equal ? equal + 1 : tmp); -kfree (tmp);if (ret >= bufsize - used) - goto nomem; +return -ENOMEM ; argv[i] = tmpbuf + used; used += ret +1 ; } - *buf = tmpbuf; + *buf =no_free_ptr (tmpbuf);return 0 ; -nomem: -kfree (tmpbuf); -return -ENOMEM ; }void traceprobe_finish_parse (struct traceprobe_parse_context *ctx)
Masami Hiramatsu (Google)
maintainerPATCH v5 3/5 tracing: Use __free() for kprobe events to cleanup
In reply to Masami Hiramatsu (Google)From: Masami Hiramatsu (Google) <[email protected]>
Use __free() in trace_kprobe.c to cleanup code.
---
Changes in v4:
- Use no_free_ptr(tk)->tp instead of assiging NULL to tk.
Changes in v3:
- Rename to __free(free_trace_kprobe) to clarify what function will be called.
- Add !IS_ERR_OR_NULL() check because alloc_trace_kprobe() returns an error code.
- Prevent freeing 'tk' in create_local_trace_kprobe() when succeeded to register.
Changes in v2:
- Instead of using no_free_ptr(), just assign NULL to the registered pointer.
--- kernel/trace/trace_kprobe.c | 62 ++++++++++++++++++++----------------------- 1 file changed, 29 insertions(+), 33 deletions(-)
kernel/trace/trace_kprobe.c +29 -33
@@ -8,6 +8,7 @@#define pr_fmt (fmt) "trace_kprobe: " fmt#include <linux/bpf-cgroup.h> +#include <linux/cleanup.h> #include <linux/security.h> #include <linux/module.h> #include <linux/uaccess.h>
@@ -257,6 +258,9 @@ static void free_trace_kprobe(struct trace_kprobe *tk) } } +DEFINE_FREE(free_trace_kprobe, struct trace_kprobe *, + if (!IS_ERR_OR_NULL(_T)) free_trace_kprobe(_T)) +/* * Allocate new trace_probe and initialize it (including kprobes). */
@@ -268,7 +272,7 @@ static struct trace_kprobe *alloc_trace_kprobe(const char *group,int maxactive, int nargs, bool is_return) { - struct trace_kprobe *tk; + struct trace_kprobe *tk __free(free_trace_kprobe) = NULL;int ret = -ENOMEM ; tk =kzalloc (struct_size (tk, tp.args, nargs),GFP_KERNEL );
@@ -277,12 +281,12 @@ static struct trace_kprobe *alloc_trace_kprobe(const char *group, tk->nhit = alloc_percpu(unsigned long);if (!tk->nhit) - goto error; +return ERR_PTR (ret);if (symbol) { tk->symbol =kstrdup (symbol,GFP_KERNEL );if (!tk->symbol) - goto error; +return ERR_PTR (ret); tk->rp.kp.symbol_name = tk->symbol; tk->rp.kp.offset = offs; }else
@@ -299,13 +303,10 @@ static struct trace_kprobe *alloc_trace_kprobe(const char *group, ret =trace_probe_init (&tk->tp, event, group, false, nargs);if (ret <0 ) - goto error; +return ERR_PTR (ret);dyn_event_init (&tk->devent, &trace_kprobe_ops); -return tk; -error: -free_trace_kprobe (tk); -return ERR_PTR (ret); +return_ptr (tk); } static struct trace_kprobe *find_trace_kprobe(const char *event,
@@ -866,11 +867,12 @@ static int __trace_kprobe_create(int argc, const char *argv[])* Type of args: * FETCHARG:TYPE : use TYPE instead of unsigned long. */ -struct trace_kprobe *tk =NULL ; + struct trace_kprobe *tk __free(free_trace_kprobe) = NULL;int i, len, new_argc =0 , ret =0 ;bool is_return = false; -char *symbol =NULL , *tmp =NULL ; -const char **new_argv =NULL ; + char *symbol __free(kfree) = NULL; +char *tmp =NULL ; + const char **new_argv __free(kfree) = NULL;const char *event =NULL , *group =KPROBE_EVENT_SYSTEM ;enum probe_print_type ptype;int maxactive =0 ;
@@ -879,7 +881,7 @@ static int __trace_kprobe_create(int argc, const char *argv[])char buf[MAX_EVENT_NAME_LEN ];char gbuf[MAX_EVENT_NAME_LEN ];char abuf[MAX_BTF_ARGS_LEN ]; -char *dbuf =NULL ; + char *dbuf __free(kfree) = NULL;struct traceprobe_parse_context ctx = { .flags =TPARG_FL_KERNEL };switch (argv[0 ][0 ]) {
@@ -936,13 +938,13 @@ static int __trace_kprobe_create(int argc, const char *argv[])/* Check whether uprobe event specified */ if (strchr (argv[1 ],'/' ) &&strchr (argv[1 ],':' )) { ret = -ECANCELED ; - goto error; + goto out; }/* a symbol specified */ symbol =kstrdup (argv[1 ],GFP_KERNEL );if (!symbol) { ret = -ENOMEM ; - goto error; + goto out; } tmp =strchr (symbol,'%' );
@@ -1040,7 +1042,7 @@ static int __trace_kprobe_create(int argc, const char *argv[]) ctx.offset =0 ; ret =traceprobe_parse_probe_arg (&tk->tp, i, argv[i], &ctx);if (ret) - goto error;/* This can be -ENOMEM */ + goto out;/* This can be -ENOMEM */ }/* entry handler for kretprobe */ if (is_return && tk->tp.entry_arg) {
@@ -1051,7 +1053,7 @@ static int __trace_kprobe_create(int argc, const char *argv[]) ptype = is_return ?PROBE_PRINT_RETURN :PROBE_PRINT_NORMAL ; ret =traceprobe_set_print_fmt (&tk->tp, ptype);if (ret <0 ) - goto error; + goto out; ret =register_trace_kprobe (tk);if (ret) {
@@ -1062,21 +1064,20 @@ static int __trace_kprobe_create(int argc, const char *argv[])trace_probe_log_err (0 ,BAD_PROBE_ADDR ); else if (ret != -ENOMEM && ret != -EEXIST)trace_probe_log_err (0 ,FAIL_REG_PROBE ); - goto error; - } + }else +/* +* Here, 'tk' has been registered to the list successfully, +* so we don't need to free it. +*/ + tk =NULL ; out:traceprobe_finish_parse (&ctx);trace_probe_log_clear (); -kfree (new_argv); -kfree (symbol); -kfree (dbuf);return ret; parse_error: ret = -EINVAL ; -error: -free_trace_kprobe (tk); goto out; }
@@ -1898,7 +1899,7 @@ create_local_trace_kprobe(char *func, void *addr, unsigned long offs, bool is_return) {enum probe_print_type ptype; -struct trace_kprobe *tk; + struct trace_kprobe *tk __free(free_trace_kprobe) = NULL;int ret;char *event;
@@ -1929,19 +1930,14 @@ create_local_trace_kprobe(char *func, void *addr, unsigned long offs, ptype =trace_kprobe_is_return (tk) ?PROBE_PRINT_RETURN :PROBE_PRINT_NORMAL ; -if (traceprobe_set_print_fmt (&tk->tp, ptype) <0 ) { - ret = -ENOMEM ; - goto error; - } +if (traceprobe_set_print_fmt (&tk->tp, ptype) <0 ) +return ERR_PTR (-ENOMEM ); ret =__register_trace_kprobe (tk);if (ret <0 ) - goto error; +return ERR_PTR (ret); -return trace_probe_event_call (&tk->tp); -error: -free_trace_kprobe (tk); -return ERR_PTR (ret); +return trace_probe_event_call (&(no_free_ptr (tk)->tp)); }void destroy_local_trace_kprobe (struct trace_event_call *event_call)
Masami Hiramatsu (Google)
maintainerPATCH v5 4/5 tracing/kprobes: Simplify __trace_kprobe_create() by removing gotos
In reply to Masami Hiramatsu (Google)From: Masami Hiramatsu (Google) <[email protected]>
Simplify __trace_kprobe_create() by removing gotos.
--- kernel/trace/trace_kprobe.c | 82 ++++++++++++++++++++++--------------------- 1 file changed, 41 insertions(+), 41 deletions(-)
kernel/trace/trace_kprobe.c +41 -41
@@ -841,7 +841,8 @@ static int validate_probe_symbol(char *symbol)static int trace_kprobe_entry_handler (struct kretprobe_instance *ri,struct pt_regs *regs); -static int __trace_kprobe_create (int argc,const char *argv[]) +static int ___trace_kprobe_create (int argc,const char *argv[], +struct traceprobe_parse_context *ctx) {/* * Argument syntax:
@@ -882,7 +883,6 @@ static int __trace_kprobe_create(int argc, const char *argv[])char gbuf[MAX_EVENT_NAME_LEN ];char abuf[MAX_BTF_ARGS_LEN ]; char *dbuf __free(kfree) = NULL; -struct traceprobe_parse_context ctx = { .flags =TPARG_FL_KERNEL };switch (argv[0 ][0 ]) {case 'r' :
@@ -896,8 +896,6 @@ static int __trace_kprobe_create(int argc, const char *argv[])if (argc <2 )return -ECANCELED ; -trace_probe_log_init ("trace_kprobe" , argc, argv); - event =strchr (&argv[0 ][1 ],':' );if (event) event++;
@@ -905,7 +903,7 @@ static int __trace_kprobe_create(int argc, const char *argv[])if (isdigit (argv[0 ][1 ])) {if (!is_return) {trace_probe_log_err (1 ,BAD_MAXACT_TYPE ); - goto parse_error; +return -EINVAL ; }if (event) len = event - &argv[0 ][1 ] -1 ;
@@ -913,21 +911,21 @@ static int __trace_kprobe_create(int argc, const char *argv[]) len =strlen (&argv[0 ][1 ]);if (len >MAX_EVENT_NAME_LEN -1 ) {trace_probe_log_err (1 ,BAD_MAXACT ); - goto parse_error; +return -EINVAL ; }memcpy (buf, &argv[0 ][1 ], len); buf[len] ='\0' ; ret =kstrtouint (buf,0 , &maxactive);if (ret || !maxactive) {trace_probe_log_err (1 ,BAD_MAXACT ); - goto parse_error; +return -EINVAL ; }/* kretprobes instances are iterated over via a list. The * maximum should stay reasonable. */ if (maxactive >KRETPROBE_MAXACTIVE_MAX ) {trace_probe_log_err (1 ,MAXACT_TOO_BIG ); - goto parse_error; +return -EINVAL ; } }
@@ -936,16 +934,13 @@ static int __trace_kprobe_create(int argc, const char *argv[])if (kstrtoul (argv[1 ],0 , (unsigned long *)&addr)) {trace_probe_log_set_index (1 );/* Check whether uprobe event specified */ -if (strchr (argv[1 ],'/' ) &&strchr (argv[1 ],':' )) { - ret = -ECANCELED ; - goto out; - } +if (strchr (argv[1 ],'/' ) &&strchr (argv[1 ],':' )) +return -ECANCELED ; +/* a symbol specified */ symbol =kstrdup (argv[1 ],GFP_KERNEL ); -if (!symbol) { - ret = -ENOMEM ; - goto out; - } +if (!symbol) +return -ENOMEM ; tmp =strchr (symbol,'%' );if (tmp) {
@@ -954,7 +949,7 @@ static int __trace_kprobe_create(int argc, const char *argv[]) is_return = true; }else {trace_probe_log_err (tmp - symbol,BAD_ADDR_SUFFIX ); - goto parse_error; +return -EINVAL ; } }
@@ -962,7 +957,7 @@ static int __trace_kprobe_create(int argc, const char *argv[]) ret =traceprobe_split_symbol_offset (symbol, &offset);if (ret || offset <0 || offset >UINT_MAX ) {trace_probe_log_err (0 ,BAD_PROBE_ADDR ); - goto parse_error; +return -EINVAL ; } ret =validate_probe_symbol (symbol);if (ret) {
@@ -970,17 +965,17 @@ static int __trace_kprobe_create(int argc, const char *argv[])trace_probe_log_err (0 ,NON_UNIQ_SYMBOL ); else trace_probe_log_err(0, BAD_PROBE_ADDR); - goto parse_error; +return -EINVAL ; }if (is_return) - ctx.flags |=TPARG_FL_RETURN ; + ctx->flags |=TPARG_FL_RETURN ; ret =kprobe_on_func_entry (NULL , symbol, offset);if (ret ==0 && !is_return) - ctx.flags |=TPARG_FL_FENTRY ; + ctx->flags |=TPARG_FL_FENTRY ;/* Defer the ENOENT case until register kprobe */ if (ret == -EINVAL && is_return) {trace_probe_log_err (0 ,BAD_RETPROBE ); - goto parse_error; +return -EINVAL ; } }
@@ -989,7 +984,7 @@ static int __trace_kprobe_create(int argc, const char *argv[]) ret =traceprobe_parse_event_name (&event, &group, gbuf, event - argv[0 ]);if (ret) - goto parse_error; +return ret; }if (!event) {
@@ -1005,26 +1000,24 @@ static int __trace_kprobe_create(int argc, const char *argv[]) } argc -=2 ; argv +=2 ; - ctx.funcname = symbol; + ctx->funcname = symbol; new_argv =traceprobe_expand_meta_args (argc, argv, &new_argc, - abuf,MAX_BTF_ARGS_LEN , &ctx); + abuf,MAX_BTF_ARGS_LEN , ctx);if (IS_ERR (new_argv)) { ret =PTR_ERR (new_argv); new_argv =NULL ; - goto out; +return ret; }if (new_argv) { argc = new_argc; argv = new_argv; } -if (argc >MAX_TRACE_ARGS ) { - ret = -E2BIG ; - goto out; - } +if (argc >MAX_TRACE_ARGS ) +return -E2BIG ; ret =traceprobe_expand_dentry_args (argc, argv, &dbuf);if (ret) - goto out; +return ret;/* setup a probe */ tk = alloc_trace_kprobe(group, event, addr, symbol, offset, maxactive,
@@ -1033,16 +1026,16 @@ static int __trace_kprobe_create(int argc, const char *argv[]) ret =PTR_ERR (tk);/* This must return -ENOMEM, else there is a bug */ WARN_ON_ONCE (ret != -ENOMEM ); - goto out;/* We know tk is not allocated */ +return ret;/* We know tk is not allocated */ }/* parse arguments */ for (i =0 ; i < argc; i++) {trace_probe_log_set_index (i +2 ); - ctx.offset =0 ; - ret =traceprobe_parse_probe_arg (&tk->tp, i, argv[i], &ctx); + ctx->offset =0 ; + ret =traceprobe_parse_probe_arg (&tk->tp, i, argv[i], ctx);if (ret) - goto out;/* This can be -ENOMEM */ +return ret;/* This can be -ENOMEM */ }/* entry handler for kretprobe */ if (is_return && tk->tp.entry_arg) {
@@ -1053,7 +1046,7 @@ static int __trace_kprobe_create(int argc, const char *argv[]) ptype = is_return ?PROBE_PRINT_RETURN :PROBE_PRINT_NORMAL ; ret =traceprobe_set_print_fmt (&tk->tp, ptype);if (ret <0 ) - goto out; +return ret; ret =register_trace_kprobe (tk);if (ret) {
@@ -1071,14 +1064,21 @@ static int __trace_kprobe_create(int argc, const char *argv[])*/ tk =NULL ; -out: +return ret; +} + +static int __trace_kprobe_create (int argc,const char *argv[]) +{ +struct traceprobe_parse_context ctx = { .flags =TPARG_FL_KERNEL }; +int ret; + +trace_probe_log_init ("trace_kprobe" , argc, argv); + + ret =___trace_kprobe_create (argc, argv, &ctx); +traceprobe_finish_parse (&ctx);trace_probe_log_clear ();return ret; - -parse_error: - ret = -EINVAL ; - goto out; }static int trace_kprobe_create (const char *raw_command)
Masami Hiramatsu (Google)
maintainerPATCH v5 5/5 tracing: Adopt __free() and guard() for trace_fprobe.c
In reply to Masami Hiramatsu (Google)From: Masami Hiramatsu (Google) <[email protected]>
Adopt __free() and guard() for trace_fprobe.c to remove gotos.
--- kernel/trace/trace_fprobe.c | 129 ++++++++++++++++++++----------------------- 1 file changed, 60 insertions(+), 69 deletions(-)
kernel/trace/trace_fprobe.c +60 -69
@@ -379,6 +379,9 @@ static void free_trace_fprobe(struct trace_fprobe *tf) } } +/* Since alloc_trace_fprobe() can return error, check the pointer is ERR too. */ +DEFINE_FREE(trace_fprobe, struct trace_fprobe *, if (!IS_ERR_OR_NULL(_T)) free_trace_fprobe(_T)) +/* * Allocate new trace_probe and initialize it (including fprobe). */
@@ -390,7 +393,7 @@ static struct trace_fprobe *alloc_trace_fprobe(const char *group,int maxactive, int nargs, bool is_return) { - struct trace_fprobe *tf; + struct trace_fprobe *tf __free(trace_fprobe) = NULL;int ret = -ENOMEM ; tf =kzalloc (struct_size (tf, tp.args, nargs),GFP_KERNEL );
@@ -399,7 +402,7 @@ static struct trace_fprobe *alloc_trace_fprobe(const char *group, tf->symbol =kstrdup (symbol,GFP_KERNEL );if (!tf->symbol) - goto error; +return ERR_PTR (-ENOMEM );if (is_return) tf->fp.exit_handler = fexit_dispatcher;
@@ -412,13 +415,10 @@ static struct trace_fprobe *alloc_trace_fprobe(const char *group, ret =trace_probe_init (&tf->tp, event, group, false, nargs);if (ret <0 ) - goto error; +return ERR_PTR (ret);dyn_event_init (&tf->devent, &trace_fprobe_ops); -return tf; -error: -free_trace_fprobe (tf); -return ERR_PTR (ret); +return_ptr (tf); } static struct trace_fprobe *find_trace_fprobe(const char *event,
@@ -845,14 +845,12 @@ static int register_trace_fprobe(struct trace_fprobe *tf)struct trace_fprobe *old_tf;int ret; -mutex_lock (&event_mutex); +guard (mutex)(&event_mutex); old_tf =find_trace_fprobe (trace_probe_name (&tf->tp),trace_probe_group_name (&tf->tp)); -if (old_tf) { - ret =append_trace_fprobe (tf, old_tf); - goto end; - } +if (old_tf) +return append_trace_fprobe (tf, old_tf);/* Register new event */ ret =register_fprobe_event (tf);
@@ -862,7 +860,7 @@ static int register_trace_fprobe(struct trace_fprobe *tf)trace_probe_log_err (0 ,EVENT_EXIST ); }else pr_warn ("Failed to register probe event(%d)\n" , ret); - goto end; +return ret; }/* Register fprobe */
@@ -872,8 +870,6 @@ static int register_trace_fprobe(struct trace_fprobe *tf)else dyn_event_add (&tf->devent,trace_probe_event_call (&tf->tp)); -end: -mutex_unlock (&event_mutex);return ret; }
@@ -1034,7 +1030,10 @@ static int parse_symbol_and_return(int argc, const char *argv[],return 0 ; } -static int __trace_fprobe_create (int argc,const char *argv[]) +DEFINE_FREE(module_put, struct module *, if (_T) module_put(_T)) + +static int ___trace_fprobe_create (int argc,const char *argv[], +struct traceprobe_parse_context *ctx) {/* * Argument syntax:
@@ -1060,24 +1059,21 @@ static int __trace_fprobe_create(int argc, const char *argv[])* Type of args: * FETCHARG:TYPE : use TYPE instead of unsigned long. */ -struct trace_fprobe *tf =NULL ; + struct trace_fprobe *tf __free(trace_fprobe) = NULL;int i, len, new_argc =0 , ret =0 ;bool is_return = false; -char *symbol =NULL ; + char *symbol __free(kfree) = NULL;const char *event =NULL , *group =FPROBE_EVENT_SYSTEM ; -const char **new_argv =NULL ; + const char **new_argv __free(kfree) = NULL;int maxactive =0 ;char buf[MAX_EVENT_NAME_LEN ];char gbuf[MAX_EVENT_NAME_LEN ];char sbuf[KSYM_NAME_LEN ];char abuf[MAX_BTF_ARGS_LEN ]; -char *dbuf =NULL ; + char *dbuf __free(kfree) = NULL;bool is_tracepoint = false; -struct module *tp_mod =NULL ; + struct module *tp_mod __free(module_put) = NULL;struct tracepoint *tpoint =NULL ; -struct traceprobe_parse_context ctx = { - .flags =TPARG_FL_KERNEL |TPARG_FL_FPROBE , - };if ((argv[0 ][0 ] !='f' && argv[0 ][0 ] !='t' ) || argc <2 )return -ECANCELED ;
@@ -1087,8 +1083,6 @@ static int __trace_fprobe_create(int argc, const char *argv[]) group =TRACEPOINT_EVENT_SYSTEM ; } -trace_probe_log_init ("trace_fprobe" , argc, argv); - event =strchr (&argv[0 ][1 ],':' );if (event) event++;
@@ -1100,21 +1094,21 @@ static int __trace_fprobe_create(int argc, const char *argv[]) len =strlen (&argv[0 ][1 ]);if (len >MAX_EVENT_NAME_LEN -1 ) {trace_probe_log_err (1 ,BAD_MAXACT ); - goto parse_error; +return -EINVAL ; }memcpy (buf, &argv[0 ][1 ], len); buf[len] ='\0' ; ret =kstrtouint (buf,0 , &maxactive);if (ret || !maxactive) {trace_probe_log_err (1 ,BAD_MAXACT ); - goto parse_error; +return -EINVAL ; }/* fprobe rethook instances are iterated over via a list. The * maximum should stay reasonable. */ if (maxactive >RETHOOK_MAXACTIVE_MAX ) {trace_probe_log_err (1 ,MAXACT_TOO_BIG ); - goto parse_error; +return -EINVAL ; } }
@@ -1123,12 +1117,12 @@ static int __trace_fprobe_create(int argc, const char *argv[])/* a symbol(or tracepoint) must be specified */ ret =parse_symbol_and_return (argc, argv, &symbol, &is_return, is_tracepoint);if (ret <0 ) - goto parse_error; +return -EINVAL ;if (!is_return && maxactive) {trace_probe_log_set_index (0 );trace_probe_log_err (1 ,BAD_MAXACT_TYPE ); - goto parse_error; +return -EINVAL ; }trace_probe_log_set_index (0 );
@@ -1136,7 +1130,7 @@ static int __trace_fprobe_create(int argc, const char *argv[]) ret =traceprobe_parse_event_name (&event, &group, gbuf, event - argv[0 ]);if (ret) - goto parse_error; +return -EINVAL ; }if (!event) {
@@ -1152,49 +1146,44 @@ static int __trace_fprobe_create(int argc, const char *argv[]) }if (is_return) - ctx.flags |=TPARG_FL_RETURN ; + ctx->flags |=TPARG_FL_RETURN ;else - ctx.flags |=TPARG_FL_FENTRY ; + ctx->flags |=TPARG_FL_FENTRY ;if (is_tracepoint) { - ctx.flags |=TPARG_FL_TPOINT ; + ctx->flags |=TPARG_FL_TPOINT ; tpoint =find_tracepoint (symbol, &tp_mod);if (tpoint) { - ctx.funcname =kallsyms_lookup ( + ctx->funcname =kallsyms_lookup ( (unsigned long )tpoint->probestub,NULL ,NULL ,NULL , sbuf); }else if (IS_ENABLED (CONFIG_MODULES )) {/* This *may* be loaded afterwards */ tpoint =TRACEPOINT_STUB ; - ctx.funcname = symbol; + ctx->funcname = symbol; }else {trace_probe_log_set_index (1 );trace_probe_log_err (0 ,NO_TRACEPOINT ); - goto parse_error; +return -EINVAL ; } }else - ctx.funcname = symbol; + ctx->funcname = symbol; argc -=2 ; argv +=2 ; new_argv =traceprobe_expand_meta_args (argc, argv, &new_argc, - abuf,MAX_BTF_ARGS_LEN , &ctx); -if (IS_ERR (new_argv)) { - ret =PTR_ERR (new_argv); - new_argv =NULL ; - goto out; - } + abuf,MAX_BTF_ARGS_LEN , ctx); +if (IS_ERR (new_argv)) +return PTR_ERR (new_argv);if (new_argv) { argc = new_argc; argv = new_argv; } -if (argc >MAX_TRACE_ARGS ) { - ret = -E2BIG ; - goto out; - } +if (argc >MAX_TRACE_ARGS ) +return -E2BIG ; ret =traceprobe_expand_dentry_args (argc, argv, &dbuf);if (ret) - goto out; +return ret;/* setup a probe */ tf = alloc_trace_fprobe(group, event, symbol, tpoint, tp_mod,
@@ -1203,16 +1192,16 @@ static int __trace_fprobe_create(int argc, const char *argv[]) ret =PTR_ERR (tf);/* This must return -ENOMEM, else there is a bug */ WARN_ON_ONCE (ret != -ENOMEM ); - goto out;/* We know tf is not allocated */ +return ret; }/* parse arguments */ for (i =0 ; i < argc; i++) {trace_probe_log_set_index (i +2 ); - ctx.offset =0 ; - ret =traceprobe_parse_probe_arg (&tf->tp, i, argv[i], &ctx); + ctx->offset =0 ; + ret =traceprobe_parse_probe_arg (&tf->tp, i, argv[i], ctx);if (ret) - goto error;/* This can be -ENOMEM */ +return ret;/* This can be -ENOMEM */ }if (is_return && tf->tp.entry_arg) {
@@ -1223,7 +1212,7 @@ static int __trace_fprobe_create(int argc, const char *argv[]) ret =traceprobe_set_print_fmt (&tf->tp, is_return ?PROBE_PRINT_RETURN :PROBE_PRINT_NORMAL );if (ret <0 ) - goto error; +return ret; ret =register_trace_fprobe (tf);if (ret) {
@@ -1234,24 +1223,26 @@ static int __trace_fprobe_create(int argc, const char *argv[])trace_probe_log_err (0 ,BAD_PROBE_ADDR ); else if (ret != -ENOMEM && ret != -EEXIST)trace_probe_log_err (0 ,FAIL_REG_PROBE ); - goto error; - } + ret = -EINVAL ; + }else +/* 'tf' is successfully registered. To avoid freeing, assign NULL. */ + tf =NULL ; -out: -if (tp_mod) -module_put (tp_mod); +return ret; +} + +static int __trace_fprobe_create (int argc,const char *argv[]) +{ +struct traceprobe_parse_context ctx = { + .flags =TPARG_FL_KERNEL |TPARG_FL_FPROBE , + }; +int ret; + +trace_probe_log_init ("trace_fprobe" , argc, argv); + ret =___trace_fprobe_create (argc, argv, &ctx);traceprobe_finish_parse (&ctx);trace_probe_log_clear (); -kfree (new_argv); -kfree (symbol); -kfree (dbuf);return ret; - -parse_error: - ret = -EINVAL ; -error: -free_trace_fprobe (tf); - goto out; }static int trace_fprobe_create (const char *raw_command)
Steven Rostedt
maintainerRe: [PATCH v5 5/5] tracing: Adopt __free() and guard() for trace_fprobe.c
Quoted 7 lines · On Wed, 8 Jan 2025 11:11:30 +0900 "Masami Hiramatsu (Google)"…
kernel/trace/trace_fprobe.c +1
-2@@ -1234,24 +1223,26 @@ static int __trace_fprobe_create(int argc, const char *argv[])trace_probe_log_err (0 ,BAD_PROBE_ADDR ); else if (ret != -ENOMEM && ret != -EEXIST)trace_probe_log_err (0 ,FAIL_REG_PROBE ); - goto error; - } + ret = -EINVAL ;
kernel/trace/trace_fprobe.c static int __trace_fprobe_create(int argc, const char *argv[]) · line 1233
Quoted 10 lines
kernel/trace/trace_fprobe.c +6
-3+ }else +/* 'tf' is successfully registered. To avoid freeing, assign NULL. */ + tf =NULL ; -out: -if (tp_mod) -module_put (tp_mod); +return ret; +} +
Hmm, the above could probably be simplified as:
ret = register_trace_fprobe(tf);
if (ret) {
trace_probe_log_set_index(1);
if (ret == -EILSEQ)
trace_probe_log_err(0, BAD_INSN_BNDRY);
else if (ret == -ENOENT)
trace_probe_log_err(0, BAD_PROBE_ADDR);
else if (ret != -ENOMEM && ret != -EEXIST)
trace_probe_log_err(0, FAIL_REG_PROBE);
return -EINVAL;
}
/* 'tf' is successfully registered. To avoid freeing, assign NULL. */
tf = NULL;
return 0;}
-- Steve
Re: [PATCH v5 1/5] tracing/kprobes: Fix to free objects when failed to copy a symbol
In reply to Masami Hiramatsu (Google)Quoted 11 lines · On Wed, 8 Jan 2025 11:10:46 +0900 "Masami Hiramatsu (Google)"…
From: Masami Hiramatsu (Google) <[email protected]>
In
__trace_kprobe_create(), if something fails it must goto error block to free objects. But whenstrdup()a symbol, it returns without that. Fix it to goto the error block to free objects correctly.Fixes 6212dd29683e ("tracing/kprobes: Use dyn_event framework for kprobe events")Signed-off-by Masami Hiramatsu (Google) <[email protected]>--- kernel/trace/trace_kprobe.c | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-)
-- Steve
Re: [PATCH v5 2/5] tracing: Use __free() in trace_probe for cleanup
In reply to Masami Hiramatsu (Google)Quoted 4 lines · On Wed, 8 Jan 2025 11:10:57 +0900 "Masami Hiramatsu (Google)"…
From: Masami Hiramatsu (Google) <[email protected]>
Use
__free()intrace_probeto cleanup some gotos.
Quoted 8 lines
Signed-off-by Masami Hiramatsu (Google) <[email protected]>---
Changes in v5:
- Fix to removekfree()in for loop. Since I confirmed__free(kfree)is called in each iteration.--- kernel/trace/trace_probe.c | 51 +++++++++++++++----------------------------- 1 file changed, 17 insertions(+), 34 deletions(-)
-- Steve
Re: [PATCH v5 3/5] tracing: Use __free() for kprobe events to cleanup
In reply to Masami Hiramatsu (Google)Quoted 14 lines · On Wed, 8 Jan 2025 11:11:07 +0900 "Masami Hiramatsu (Google)"…
From: Masami Hiramatsu (Google) <[email protected]>
Use
__free()intrace_kprobe.cto cleanup code.Signed-off-by Masami Hiramatsu (Google) <[email protected]>---
Changes in v4:
- Use no_free_ptr(tk)->tp instead of assiging NULL to tk.
Changes in v3:
- Rename to__free(free_trace_kprobe)to clarify what function will be called.
- Add !IS_ERR_OR_NULL() check becausealloc_trace_kprobe()returns an error code.
- Prevent freeing 'tk' increate_local_trace_kprobe()when succeeded to register.
Changes in v2:
- Instead of usingno_free_ptr(), just assign NULL to the registered pointer.
Quoted 3 lines
--- kernel/trace/trace_kprobe.c | 62 ++++++++++++++++++++----------------------- 1 file changed, 29 insertions(+), 33 deletions(-)
-- Steve
Steven Rostedt
maintainerRe: [PATCH v5 4/5] tracing/kprobes: Simplify __trace_kprobe_create() by removing gotos
In reply to Masami Hiramatsu (Google)kernel/trace/trace_kprobe.c static int validate_probe_symbol(char *symbol) · line 846
Quoted 4 lines · On Wed, 8 Jan 2025 11:11:18 +0900 "Masami Hiramatsu (Google)"…
kernel/trace/trace_kprobe.c +2
-1-static int __trace_kprobe_create (int argc,const char *argv[]) +static int ___trace_kprobe_create (int argc,const char *argv[], +struct traceprobe_parse_context *ctx) {
I'm not sure I care about all the underscores. It just adds to confusion.
Maybe just:
static int __create_trace_kprobe(..)
?
-- Steve
Masami Hiramatsu (Google)
maintainerRe: [PATCH v5 4/5] tracing/kprobes: Simplify __trace_kprobe_create() by removing gotos
Quoted 10 lines · On Wed, 8 Jan 2025 10:11:11 -0500 Steven Rostedt <[email protected]> wrote:
kernel/trace/trace_kprobe.c static int validate_probe_symbol(char *symbol) · line 846
Quoted 4 lines · On Wed, 8 Jan 2025 11:11:18 +0900 "Masami Hiramatsu (Google)"…
kernel/trace/trace_kprobe.c +2
-1-static int __trace_kprobe_create (int argc,const char *argv[]) +static int ___trace_kprobe_create (int argc,const char *argv[], +struct traceprobe_parse_context *ctx) {I'm not sure I care about all the underscores. It just adds to confusion.
Quoted 3 lines
Maybe just:
static int
__create_trace_kprobe(..)
Ok. Or __trace_kprobe_create_internal()?
Then it will be
trace_kprobe_create()
-> __trace_kprobe_create()
-> __trace_kprobe_create_internal()
Thanks,
Quoted 4 lines
?
-- Steve
Signature · 1 line
Masami Hiramatsu (Google) <[email protected]>
Masami Hiramatsu (Google)
maintainerRe: [PATCH v5 5/5] tracing: Adopt __free() and guard() for trace_fprobe.c
In reply to Steven RostedtQuoted 23 lines · On Wed, 8 Jan 2025 10:07:36 -0500 Steven Rostedt <[email protected]> wrote:
Quoted 7 lines · On Wed, 8 Jan 2025 11:11:30 +0900 "Masami Hiramatsu (Google)"…
kernel/trace/trace_fprobe.c +1
-2@@ -1234,24 +1223,26 @@ static int __trace_fprobe_create(int argc, const char *argv[])trace_probe_log_err (0 ,BAD_PROBE_ADDR ); else if (ret != -ENOMEM && ret != -EEXIST)trace_probe_log_err (0 ,FAIL_REG_PROBE ); - goto error; - } + ret = -EINVAL ;kernel/trace/trace_fprobe.c static int __trace_fprobe_create(int argc, const char *argv[]) · line 1233
Quoted 10 lines
kernel/trace/trace_fprobe.c +6
-3+ }else +/* 'tf' is successfully registered. To avoid freeing, assign NULL. */ + tf =NULL ; -out: -if (tp_mod) -module_put (tp_mod); +return ret; +} +Hmm, the above could probably be simplified as:
Quoted 16 lines
ret = register_trace_fprobe(tf);
if (ret) {
trace_probe_log_set_index(1);
if (ret == -EILSEQ)
trace_probe_log_err(0, BAD_INSN_BNDRY);
else if (ret == -ENOENT)
trace_probe_log_err(0, BAD_PROBE_ADDR);
else if (ret != -ENOMEM && ret != -EEXIST)
trace_probe_log_err(0, FAIL_REG_PROBE);
return -EINVAL;
}
/* 'tf' is successfully registered. To avoid freeing, assign NULL. */
tf = NULL;
return 0;Indeed. Thanks!
Quoted 3 lines
}
-- Steve
Signature · 1 line
Masami Hiramatsu (Google) <[email protected]>