From patchwork Sun Jun 26 02:56:01 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jeff Xie X-Patchwork-Id: 12895575 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 3328DC433EF for ; Sun, 26 Jun 2022 02:56:58 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233777AbiFZC45 (ORCPT ); Sat, 25 Jun 2022 22:56:57 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:56432 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233707AbiFZC4y (ORCPT ); Sat, 25 Jun 2022 22:56:54 -0400 Received: from mail-pf1-x42f.google.com (mail-pf1-x42f.google.com [IPv6:2607:f8b0:4864:20::42f]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 9E16813E97; Sat, 25 Jun 2022 19:56:52 -0700 (PDT) Received: by mail-pf1-x42f.google.com with SMTP id x138so3255565pfc.3; Sat, 25 Jun 2022 19:56:52 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=AYpCfkimhU2KJvCb6UeI6/1YJCXd4C14utLIgevMLmY=; b=IxGMmZfepiSGUWbtiwFrs59orNhFTVU3Mhy1/+rbQCblPdBaquOcZcWRlUwrFemAhj YNaC21ar74ijoo2xVoUvA2O5DphIpUXTCqW4g1GyAJQVZYo25cJ98UAdYyefig1IFbOB ewxJAkfMJV1Ho2Kx10tTrcxnLOsPjqg+LHLv83PX2TG2qP24Mdy2xnIY5oKY/HZNFNmY OiniKXWgZXVBJesmbJSJQCMJNG9sJIRac0xtTs5iKhPLsIWKAbczEaezloHqpZy8h26f VQPtu5bbXWSfta6ZZYQOna72Q4A608N0LVzMG6LN/OGBg3Hrx5L5OgEldXft/UVpj31n mylg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=AYpCfkimhU2KJvCb6UeI6/1YJCXd4C14utLIgevMLmY=; b=MIKjMBERiUeRxWD0sHggFxfaYDdlbuq735UodkZ4g11Aj9g5PpHdBhLgMxX7UVSnUq DTYmJHUJkkh4rTd1/TeMfTZsjWzmjWkrRriDCRteCG2XuP0Z/w0oqT0+ezy7jMriz83a m4gMGqNbqHzOqgOLNjm1PL2naVf8+S9qQb17Jx03x+awQjGZhWh6GrNyPySGXSaeH0L8 ZLyECkC74tGnMf9zicogcMPk2bXXQrM4aEdPPkQwZb6bSsTtXBg9CgkycP6Pu3qi8i0j 5/7fzkiVcpB8yIIRidQTBa0kIAtQi4Zoztyz2t+h0XJxc0GzWv2eRH94nkk9RAn18gSC WEjw== X-Gm-Message-State: AJIora+/AU5yaGi7rVDlVCnvJPAe5gfk+en0pkCKDTnBcP9Xjk3d70CK S6TXkvoPQkfGFif6amqQQhY= X-Google-Smtp-Source: AGRyM1uOfa/cSzaqZ8DEI3GiwpY8W6cG6yBjf6D+m80OBQGjA2Nm4I4CkErzPCbLKI0fNEGLOFPZYA== X-Received: by 2002:a05:6a00:181b:b0:525:63b6:7397 with SMTP id y27-20020a056a00181b00b0052563b67397mr7447306pfa.1.1656212212029; Sat, 25 Jun 2022 19:56:52 -0700 (PDT) Received: from localhost.localdomain (li567-56.members.linode.com. [192.155.81.56]) by smtp.gmail.com with ESMTPSA id d15-20020a056a0024cf00b005258df7615bsm1607061pfv.0.2022.06.25.19.56.47 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 25 Jun 2022 19:56:51 -0700 (PDT) From: Jeff Xie To: rostedt@goodmis.org Cc: mingo@redhat.com, mhiramat@kernel.org, zanussi@kernel.org, linux-kernel@vger.kernel.org, linux-kselftest@vger.kernel.org, shuah@kernel.org, linux-doc@vger.kernel.org, corbet@lwn.net, chensong_2000@189.cn, Jeff Xie Subject: [PATCH v13 1/4] trace: Add trace any kernel object Date: Sun, 26 Jun 2022 10:56:01 +0800 Message-Id: <20220626025604.277413-2-xiehuan09@gmail.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20220626025604.277413-1-xiehuan09@gmail.com> References: <20220626025604.277413-1-xiehuan09@gmail.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-kselftest@vger.kernel.org Introduce objtrace trigger to get the call flow by tracing any kernel object in the function parameter. The objtrace trigger makes a list of the target object address from the given event parameter, and records all kernel function calls which has the object address in its parameter. Syntax: objtrace:add:obj[:count][if ] Usage: # echo 'p bio_add_page arg1=$arg1' > kprobe_events # cd events/kprobes/p_bio_add_page_0 # echo 'objtrace:add:arg1:1 if comm == "cat"' > ./trigger # cat /test.txt Signed-off-by: Jeff Xie Acked-by: Masami Hiramatsu (Google) --- include/linux/trace_events.h | 1 + kernel/trace/Kconfig | 10 + kernel/trace/Makefile | 1 + kernel/trace/trace.c | 11 + kernel/trace/trace.h | 21 ++ kernel/trace/trace_entries.h | 17 ++ kernel/trace/trace_events_trigger.c | 5 +- kernel/trace/trace_object.c | 450 ++++++++++++++++++++++++++++ kernel/trace/trace_output.c | 40 +++ 9 files changed, 554 insertions(+), 2 deletions(-) create mode 100644 kernel/trace/trace_object.c diff --git a/include/linux/trace_events.h b/include/linux/trace_events.h index e6e95a9f07a5..f3645166b724 100644 --- a/include/linux/trace_events.h +++ b/include/linux/trace_events.h @@ -693,6 +693,7 @@ enum event_trigger_type { ETT_EVENT_HIST = (1 << 4), ETT_HIST_ENABLE = (1 << 5), ETT_EVENT_EPROBE = (1 << 6), + ETT_TRACE_OBJECT = (1 << 7), }; extern int filter_match_preds(struct event_filter *filter, void *rec); diff --git a/kernel/trace/Kconfig b/kernel/trace/Kconfig index 2c43e327a619..30c34d43dc3f 100644 --- a/kernel/trace/Kconfig +++ b/kernel/trace/Kconfig @@ -276,6 +276,16 @@ config FUNCTION_PROFILER If in doubt, say N. +config TRACE_OBJECT + bool "Trace kernel object in function parameter" + depends on FUNCTION_TRACER + depends on HAVE_FUNCTION_ARG_ACCESS_API + select TRACING + default y + help + You can trace the kernel object in the kernel function parameter. + The kernel object is dynamically specified via event trigger. + config STACK_TRACER bool "Trace max stack" depends on HAVE_FUNCTION_TRACER diff --git a/kernel/trace/Makefile b/kernel/trace/Makefile index 0d261774d6f3..90ecc3c6c9d5 100644 --- a/kernel/trace/Makefile +++ b/kernel/trace/Makefile @@ -71,6 +71,7 @@ obj-$(CONFIG_FUNCTION_GRAPH_TRACER) += trace_functions_graph.o obj-$(CONFIG_TRACE_BRANCH_PROFILING) += trace_branch.o obj-$(CONFIG_BLK_DEV_IO_TRACE) += blktrace.o obj-$(CONFIG_FUNCTION_GRAPH_TRACER) += fgraph.o +obj-$(CONFIG_TRACE_OBJECT) += trace_object.o ifeq ($(CONFIG_BLOCK),y) obj-$(CONFIG_EVENT_TRACING) += blktrace.o endif diff --git a/kernel/trace/trace.c b/kernel/trace/trace.c index f400800bc910..7074ad8bc1a0 100644 --- a/kernel/trace/trace.c +++ b/kernel/trace/trace.c @@ -5627,6 +5627,9 @@ static const char readme_msg[] = "\t enable_hist::\n" "\t disable_hist::\n" #endif +#ifdef CONFIG_TRACE_OBJECT + "\t objtrace:add:obj[:count][if ]\n" +#endif #ifdef CONFIG_STACKTRACE "\t\t stacktrace\n" #endif @@ -9272,6 +9275,9 @@ static struct trace_array *trace_array_create(const char *name) if (ftrace_allocate_ftrace_ops(tr) < 0) goto out_free_tr; + if (allocate_objtrace_data(tr) < 0) + goto out_free_tr; + ftrace_init_trace_array(tr); init_trace_flags_index(tr); @@ -9291,6 +9297,7 @@ static struct trace_array *trace_array_create(const char *name) out_free_tr: ftrace_free_ftrace_ops(tr); + free_objtrace_data(tr); free_trace_buffers(tr); free_cpumask_var(tr->tracing_cpumask); kfree(tr->name); @@ -9384,6 +9391,7 @@ static int __remove_instance(struct trace_array *tr) event_trace_del_tracer(tr); ftrace_clear_pids(tr); ftrace_destroy_function_files(tr); + free_objtrace_data(tr); tracefs_remove(tr->dir); free_percpu(tr->last_func_repeats); free_trace_buffers(tr); @@ -10118,6 +10126,9 @@ __init static int tracer_alloc_buffers(void) goto out_free_savedcmd; } + if (allocate_objtrace_data(&global_trace)) + goto out_free_savedcmd; + if (global_trace.buffer_disabled) tracing_off(); diff --git a/kernel/trace/trace.h b/kernel/trace/trace.h index ff816fb41e48..18220b659555 100644 --- a/kernel/trace/trace.h +++ b/kernel/trace/trace.h @@ -54,6 +54,7 @@ enum trace_type { TRACE_TIMERLAT, TRACE_RAW_DATA, TRACE_FUNC_REPEATS, + TRACE_OBJECT, __TRACE_LAST_TYPE, }; @@ -363,6 +364,9 @@ struct trace_array { cpumask_var_t tracing_cpumask; /* only trace on set CPUs */ int ref; int trace_ref; +#ifdef CONFIG_TRACE_OBJECT + struct objtrace_data *obj_data; +#endif #ifdef CONFIG_FUNCTION_TRACER struct ftrace_ops *ops; struct trace_pid_list __rcu *function_pids; @@ -471,6 +475,7 @@ extern void __ftrace_bad_type(void); TRACE_GRAPH_RET); \ IF_ASSIGN(var, ent, struct func_repeats_entry, \ TRACE_FUNC_REPEATS); \ + IF_ASSIGN(var, ent, struct trace_object_entry, TRACE_OBJECT);\ __ftrace_bad_type(); \ } while (0) @@ -1536,6 +1541,16 @@ static inline int register_trigger_hist_cmd(void) { return 0; } static inline int register_trigger_hist_enable_disable_cmds(void) { return 0; } #endif +#ifdef CONFIG_TRACE_OBJECT +extern int register_trigger_object_cmd(void); +extern int allocate_objtrace_data(struct trace_array *tr); +extern void free_objtrace_data(struct trace_array *tr); +#else +static inline int register_trigger_object_cmd(void) { return 0; } +static inline int allocate_objtrace_data(struct trace_array *tr) { return 0; } +static inline void free_objtrace_data(struct trace_array *tr) { }; +#endif + extern int register_trigger_cmds(void); extern void clear_event_triggers(struct trace_array *tr); @@ -1611,6 +1626,12 @@ extern bool event_trigger_check_remove(const char *glob); extern bool event_trigger_empty_param(const char *param); extern int event_trigger_separate_filter(char *param_and_filter, char **param, char **filter, bool param_required); +extern int register_trigger(char *glob, + struct event_trigger_data *data, + struct trace_event_file *file); +extern void unregister_trigger(char *glob, + struct event_trigger_data *test, + struct trace_event_file *file); extern struct event_trigger_data * event_trigger_alloc(struct event_command *cmd_ops, char *cmd, diff --git a/kernel/trace/trace_entries.h b/kernel/trace/trace_entries.h index cd41e863b51c..bb120d9498a9 100644 --- a/kernel/trace/trace_entries.h +++ b/kernel/trace/trace_entries.h @@ -401,3 +401,20 @@ FTRACE_ENTRY(timerlat, timerlat_entry, __entry->context, __entry->timer_latency) ); + +/* + * trace object entry: + */ +FTRACE_ENTRY(object, trace_object_entry, + + TRACE_OBJECT, + + F_STRUCT( + __field( unsigned long, ip ) + __field( unsigned long, parent_ip ) + __field( unsigned long, object ) + ), + + F_printk(" %ps <-- %ps object:%lx\n", + (void *)__entry->ip, (void *)__entry->parent_ip, __entry->object) +); diff --git a/kernel/trace/trace_events_trigger.c b/kernel/trace/trace_events_trigger.c index cb866c3141af..8bad4eb3b997 100644 --- a/kernel/trace/trace_events_trigger.c +++ b/kernel/trace/trace_events_trigger.c @@ -560,7 +560,7 @@ void update_cond_flag(struct trace_event_file *file) * * Return: 0 on success, errno otherwise */ -static int register_trigger(char *glob, +int register_trigger(char *glob, struct event_trigger_data *data, struct trace_event_file *file) { @@ -605,7 +605,7 @@ static int register_trigger(char *glob, * Usually used directly as the @unreg method in event command * implementations. */ -static void unregister_trigger(char *glob, +void unregister_trigger(char *glob, struct event_trigger_data *test, struct trace_event_file *file) { @@ -1976,6 +1976,7 @@ __init int register_trigger_cmds(void) register_trigger_enable_disable_cmds(); register_trigger_hist_enable_disable_cmds(); register_trigger_hist_cmd(); + register_trigger_object_cmd(); return 0; } diff --git a/kernel/trace/trace_object.c b/kernel/trace/trace_object.c new file mode 100644 index 000000000000..19ec4b1c0186 --- /dev/null +++ b/kernel/trace/trace_object.c @@ -0,0 +1,450 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * trace the kernel object in the kernel function parameter + * Copyright (C) 2021 Jeff Xie + */ + +#define pr_fmt(fmt) "trace_object: " fmt + +#include "trace_output.h" + +#define MAX_TRACED_OBJECT 5 +#define OBJTRACE_CMD_LEN 16 +#define OBJTRACE_CMD_ADD "add" +static LIST_HEAD(obj_data_head); +static const int max_args_num = 6; +static void exit_trace_object(struct trace_array *tr); +static int init_trace_object(struct trace_array *tr); + +struct object_instance { + void *obj; + struct trace_array *tr; +}; + +/* objtrace private data */ +struct objtrace_trigger_data { + struct ftrace_event_field *field; + char objtrace_cmd[OBJTRACE_CMD_LEN]; + struct trace_array *tr; +}; + +/* objtrace data with fops and objtrace_instances */ +struct objtrace_data { + struct list_head head; + struct trace_array *tr; + struct ftrace_ops fops; + int num_traced_obj; + struct object_instance traced_obj[MAX_TRACED_OBJECT]; + raw_spinlock_t obj_data_lock; +}; + +static struct objtrace_data *get_obj_data(struct trace_array *tr) +{ + struct objtrace_data *obj_data = NULL; + + list_for_each_entry(obj_data, &obj_data_head, head) { + if (obj_data->tr == tr) + break; + } + return obj_data; +} + +static bool object_exist(void *obj, struct trace_array *tr) +{ + int i, max; + struct objtrace_data *obj_data; + + obj_data = get_obj_data(tr); + if (!obj_data) + return false; + + max = READ_ONCE(obj_data->num_traced_obj); + smp_rmb(); + for (i = 0; i < max; i++) { + if (obj_data->traced_obj[i].obj == obj) + return true; + } + return false; +} + +static bool object_empty(struct trace_array *tr) +{ + struct objtrace_data *obj_data; + + obj_data = get_obj_data(tr); + if (!obj_data) + return false; + + return !READ_ONCE(obj_data->num_traced_obj); +} + +static void set_trace_object(void *obj, struct trace_array *tr) +{ + unsigned long flags; + struct object_instance *obj_ins; + struct objtrace_data *obj_data; + + if (in_nmi()) + return; + + if (!obj && object_exist(obj, tr)) + return; + + obj_data = get_obj_data(tr); + if (!obj_data) + return; + + /* only this place has write operations */ + raw_spin_lock_irqsave(&obj_data->obj_data_lock, flags); + if (READ_ONCE(obj_data->num_traced_obj) == MAX_TRACED_OBJECT) { + trace_array_printk_buf(tr->array_buffer.buffer, _THIS_IP_, + "object_pool is full, can't trace object:0x%px\n", obj); + goto out; + } + obj_ins = &obj_data->traced_obj[READ_ONCE(obj_data->num_traced_obj)]; + obj_ins->obj = obj; + obj_ins->tr = tr; + /* make sure the num_traced_obj update always appears after traced_obj update */ + smp_wmb(); + obj_data->num_traced_obj++; +out: + raw_spin_unlock_irqrestore(&obj_data->obj_data_lock, flags); +} + +static void submit_trace_object(unsigned long ip, unsigned long parent_ip, + unsigned long object, struct trace_array *tr) +{ + + struct trace_buffer *buffer = tr->array_buffer.buffer; + struct ring_buffer_event *event; + struct trace_object_entry *entry; + unsigned int trace_ctx = 0; + + trace_ctx = tracing_gen_ctx(); + event = trace_buffer_lock_reserve(buffer, TRACE_OBJECT, + sizeof(*entry), trace_ctx); + if (!event) + return; + entry = ring_buffer_event_data(event); + entry->ip = ip; + entry->parent_ip = parent_ip; + entry->object = object; + + trace_buffer_unlock_commit(tr, buffer, event, trace_ctx); +} + +static void +trace_object_events_call(unsigned long ip, unsigned long parent_ip, + struct ftrace_ops *op, struct ftrace_regs *fregs) +{ + struct pt_regs *pt_regs = ftrace_get_regs(fregs); + struct trace_array *tr = op->private; + struct trace_array_cpu *data; + unsigned long obj; + long disabled; + int cpu, n; + + preempt_disable_notrace(); + + cpu = raw_smp_processor_id(); + data = per_cpu_ptr(tr->array_buffer.data, cpu); + disabled = atomic_inc_return(&data->disabled); + if (likely(disabled == 1)) { + if (object_empty(tr)) + goto out; + for (n = 0; n < max_args_num; n++) { + obj = regs_get_kernel_argument(pt_regs, n); + if (object_exist((void *)obj, tr)) + submit_trace_object(ip, parent_ip, obj, tr); + /* The parameters of a function may match multiple objects */ + } + } +out: + atomic_dec(&data->disabled); + preempt_enable_notrace(); +} + +static void +trace_object_trigger(struct event_trigger_data *data, + struct trace_buffer *buffer, void *rec, + struct ring_buffer_event *event) +{ + struct objtrace_trigger_data *obj_data = data->private_data; + struct trace_array *tr = obj_data->tr; + struct ftrace_event_field *field; + void *obj = NULL; + + field = obj_data->field; + memcpy(&obj, rec + field->offset, sizeof(obj)); + set_trace_object(obj, tr); +} + +static void +trace_object_trigger_free(struct event_trigger_data *data) +{ + struct objtrace_trigger_data *obj_data = data->private_data; + + if (WARN_ON_ONCE(data->ref <= 0)) + return; + + data->ref--; + if (!data->ref) { + exit_trace_object(obj_data->tr); + kfree(data->private_data); + trigger_data_free(data); + } +} + +static void +trace_object_count_trigger(struct event_trigger_data *data, + struct trace_buffer *buffer, void *rec, + struct ring_buffer_event *event) +{ + if (!data->count) + return; + + if (data->count != -1) + (data->count)--; + + trace_object_trigger(data, buffer, rec, event); +} + +static int +event_trigger_print(const char *name, struct seq_file *m, + void *data, char *filter_str, void *objtrace_data) +{ + long count = (long)data; + struct objtrace_trigger_data *obj_data = objtrace_data; + + seq_puts(m, name); + + seq_printf(m, ":%s", obj_data->objtrace_cmd); + seq_printf(m, ":%s", obj_data->field->name); + + if (count == -1) + seq_puts(m, ":unlimited"); + else + seq_printf(m, ":count=%ld", count); + + if (filter_str) + seq_printf(m, " if %s\n", filter_str); + else + seq_putc(m, '\n'); + + return 0; +} + +static int event_object_trigger_init(struct event_trigger_data *data) +{ + struct objtrace_trigger_data *obj_data = data->private_data; + int ret; + + if (!data->ref) { + ret = init_trace_object(obj_data->tr); + if (ret) + return ret; + } + data->ref++; + return 0; +} + +static int +trace_object_trigger_print(struct seq_file *m, struct event_trigger_data *data) +{ + return event_trigger_print("objtrace", m, (void *)data->count, + data->filter_str, data->private_data); +} + +static struct event_trigger_ops objecttrace_trigger_ops = { + .trigger = trace_object_trigger, + .print = trace_object_trigger_print, + .init = event_object_trigger_init, + .free = trace_object_trigger_free, +}; + +static struct event_trigger_ops objecttrace_count_trigger_ops = { + .trigger = trace_object_count_trigger, + .print = trace_object_trigger_print, + .init = event_object_trigger_init, + .free = trace_object_trigger_free, +}; + +static struct event_trigger_ops * +objecttrace_get_trigger_ops(char *cmd, char *param) +{ + return param ? &objecttrace_count_trigger_ops : &objecttrace_trigger_ops; +} + +static bool field_exist(struct trace_event_file *file, + struct event_command *cmd_ops, + const char *field_name) +{ + struct event_trigger_data *data; + struct objtrace_trigger_data *obj_data; + + lockdep_assert_held(&event_mutex); + + list_for_each_entry(data, &file->triggers, list) { + if (data->cmd_ops->trigger_type == cmd_ops->trigger_type) { + obj_data = data->private_data; + if (!strcmp(obj_data->field->name, field_name)) + return true; + } + } + + return false; +} + +static int +event_object_trigger_parse(struct event_command *cmd_ops, + struct trace_event_file *file, + char *glob, char *cmd, char *param_and_filter) +{ + struct event_trigger_data *trigger_data; + struct objtrace_trigger_data *obj_data; + struct ftrace_event_field *field; + char *objtrace_cmd, *arg; + char *param, *filter; + int ret; + bool remove; + + remove = event_trigger_check_remove(glob); + + /* + * separate the param and the filter: + * objtrace:add:OBJ[:COUNT] [if filter] + */ + ret = event_trigger_separate_filter(param_and_filter, ¶m, &filter, true); + if (ret) + return ret; + + objtrace_cmd = strsep(¶m, ":"); + if (!objtrace_cmd || strcmp(objtrace_cmd, OBJTRACE_CMD_ADD)) { + pr_err("error objtrace command\n"); + return -EINVAL; + } + + arg = strsep(¶m, ":"); + if (!arg) + return -EINVAL; + + field = trace_find_event_field(file->event_call, arg); + if (!field) + return -EINVAL; + + if (field->size != sizeof(void *)) { + pr_err("the size of the %s should be:%zu\n", field->name, sizeof(void *)); + return -EINVAL; + } + + if (remove && !field_exist(file, cmd_ops, field->name)) + return -ENOENT; + + obj_data = kzalloc(sizeof(*obj_data), GFP_KERNEL); + if (!obj_data) + return -ENOMEM; + + obj_data->field = field; + obj_data->tr = file->tr; + snprintf(obj_data->objtrace_cmd, OBJTRACE_CMD_LEN, objtrace_cmd); + + trigger_data = event_trigger_alloc(cmd_ops, cmd, param, obj_data); + if (!trigger_data) { + kfree(obj_data); + return -ENOMEM; + } + if (remove) { + event_trigger_unregister(cmd_ops, file, glob+1, trigger_data); + kfree(obj_data); + kfree(trigger_data); + return 0; + } + + ret = event_trigger_parse_num(param, trigger_data); + if (ret) + goto out_free; + + ret = event_trigger_set_filter(cmd_ops, file, filter, trigger_data); + if (ret < 0) + goto out_free; + + ret = event_trigger_register(cmd_ops, file, glob, trigger_data); + if (ret) + goto out_free; + + return ret; + + out_free: + event_trigger_reset_filter(cmd_ops, trigger_data); + kfree(obj_data); + kfree(trigger_data); + return ret; +} + +static struct event_command trigger_object_cmd = { + .name = "objtrace", + .trigger_type = ETT_TRACE_OBJECT, + .flags = EVENT_CMD_FL_NEEDS_REC, + .parse = event_object_trigger_parse, + .reg = register_trigger, + .unreg = unregister_trigger, + .get_trigger_ops = objecttrace_get_trigger_ops, + .set_filter = set_trigger_filter, +}; + +__init int register_trigger_object_cmd(void) +{ + int ret; + + ret = register_event_command(&trigger_object_cmd); + WARN_ON(ret < 0); + + return ret; +} + +int allocate_objtrace_data(struct trace_array *tr) +{ + struct objtrace_data *obj_data; + struct ftrace_ops *fops; + + obj_data = kzalloc(sizeof(*obj_data), GFP_KERNEL); + if (!obj_data) + return -ENOMEM; + + raw_spin_lock_init(&obj_data->obj_data_lock); + obj_data->tr = tr; + fops = &obj_data->fops; + fops->func = trace_object_events_call; + fops->flags = FTRACE_OPS_FL_SAVE_REGS; + fops->private = tr; + list_add(&obj_data->head, &obj_data_head); + + tr->obj_data = obj_data; + + return 0; +} + +static int init_trace_object(struct trace_array *tr) +{ + int ret; + + ret = register_ftrace_function(&tr->obj_data->fops); + WARN_ON(ret < 0); + + return ret; +} + +void free_objtrace_data(struct trace_array *tr) +{ + kfree(tr->obj_data); + tr->obj_data = NULL; +} + +static void exit_trace_object(struct trace_array *tr) +{ + struct objtrace_data *obj_data = tr->obj_data; + + obj_data->num_traced_obj = 0; + WARN_ONCE(unregister_ftrace_function(&obj_data->fops), + "can't unregister ftrace for trace object\n"); +} diff --git a/kernel/trace/trace_output.c b/kernel/trace/trace_output.c index 67f47ea27921..34ff7b4dc521 100644 --- a/kernel/trace/trace_output.c +++ b/kernel/trace/trace_output.c @@ -1551,6 +1551,45 @@ static struct trace_event trace_func_repeats_event = { .funcs = &trace_func_repeats_funcs, }; +/* TRACE_OBJECT */ +static enum print_line_t trace_object_print(struct trace_iterator *iter, int flags, + struct trace_event *event) +{ + struct trace_object_entry *field; + struct trace_seq *s = &iter->seq; + + trace_assign_type(field, iter->ent); + print_fn_trace(s, field->ip, field->parent_ip, flags); + trace_seq_printf(s, " object:0x%lx", field->object); + trace_seq_putc(s, '\n'); + + return trace_handle_return(s); +} + +static enum print_line_t trace_object_raw(struct trace_iterator *iter, int flags, + struct trace_event *event) +{ + struct trace_object_entry *field; + + trace_assign_type(field, iter->ent); + + trace_seq_printf(&iter->seq, "%lx %lx\n", + field->ip, + field->parent_ip); + + return trace_handle_return(&iter->seq); +} + +static struct trace_event_functions trace_object_funcs = { + .trace = trace_object_print, + .raw = trace_object_raw, +}; + +static struct trace_event trace_object_event = { + .type = TRACE_OBJECT, + .funcs = &trace_object_funcs, +}; + static struct trace_event *events[] __initdata = { &trace_fn_event, &trace_ctx_event, @@ -1565,6 +1604,7 @@ static struct trace_event *events[] __initdata = { &trace_timerlat_event, &trace_raw_data_event, &trace_func_repeats_event, + &trace_object_event, NULL }; From patchwork Sun Jun 26 02:56:02 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jeff Xie X-Patchwork-Id: 12895576 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 50E76C43334 for ; Sun, 26 Jun 2022 02:57:01 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233834AbiFZC47 (ORCPT ); Sat, 25 Jun 2022 22:56:59 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:56458 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233830AbiFZC46 (ORCPT ); Sat, 25 Jun 2022 22:56:58 -0400 Received: from mail-pl1-x634.google.com (mail-pl1-x634.google.com [IPv6:2607:f8b0:4864:20::634]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 92D6813E97; Sat, 25 Jun 2022 19:56:57 -0700 (PDT) Received: by mail-pl1-x634.google.com with SMTP id o18so5362604plg.2; Sat, 25 Jun 2022 19:56:57 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=1xFp3YccCABYdb/qSiAbIbYGz64YunMLfgN9dTWOVPs=; b=neafXIA+Tvwh+05RT47jIllowolww82eol4Cw/D88GzfLp68GjYSjM/cS19gTeg1nu Z/JrL+upJTJcymS7Ip9dqWQo2maptHDkROsElvgU+etHzsBe1yrtiIPNMQ01aG2jgNhN 0Q0EghMx5pbRa3GWDtOJi5jPKXiRmY8m5dEWaXcnvXOR+1KX9ipHJeBI3lBEtG+j6izz FXqS1ZyAGGlsGzG2e6hoH6l2G4IcypagQUV2Ez3vJvWSY1BlT1UtT8hvdOkRrjQbU/2y a6YiHDsDS3j+3x3Xyljy5l911JTatZbW7Mom/CQoY6XK2EGRHLnsfqGu7QLzVY7tG1mY /Rmg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=1xFp3YccCABYdb/qSiAbIbYGz64YunMLfgN9dTWOVPs=; b=CARKqGJ+DBFpPVXBaNVSzeUYrMydkL1IQGgXjAGcDcKTnF1kWHcRqGig3mu1WBhY+t O8V9jaGWCJ2QqJ9nxc1Ul3zB0PFHAWkWG9/XHGHYPFWF3uJsqW6tDek8mYfFSwU0tlcM rlMkvCCHqxdBxllGmkhj/OvIa/+7a/aIgSpWjxU2L8RImRwSxXdEkLtqEaQGOdGMpEai PA/QIrmXYTWRj2XVeWIp4i/T0aptD5XpEDsOUIPcgXuNq2Y78aHFbHqQDNSrDFq5Ruv/ X1iQjyjLxpK9bPzso1qq6Mz4XhmhORLLRPhlnEMODA9E8Lb6kH7DjyenQIc6D5pTPoyI 6T9g== X-Gm-Message-State: AJIora8/rF9ef5HrB71Z0I+cDtyZZiUb3NsOo8yTL7oglgzXS2x9QRUG ptgexUObzP2kcATsSMOxjwU= X-Google-Smtp-Source: AGRyM1veHMAUopHOCNcbgBFPlKkz0J/G+JMTePUfQRomN94x4ePSTvBaWVrVVq0Fws6cpeUUvHETLA== X-Received: by 2002:a17:90b:3911:b0:1ec:bd65:a307 with SMTP id ob17-20020a17090b391100b001ecbd65a307mr7792538pjb.4.1656212217116; Sat, 25 Jun 2022 19:56:57 -0700 (PDT) Received: from localhost.localdomain (li567-56.members.linode.com. [192.155.81.56]) by smtp.gmail.com with ESMTPSA id d15-20020a056a0024cf00b005258df7615bsm1607061pfv.0.2022.06.25.19.56.52 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 25 Jun 2022 19:56:56 -0700 (PDT) From: Jeff Xie To: rostedt@goodmis.org Cc: mingo@redhat.com, mhiramat@kernel.org, zanussi@kernel.org, linux-kernel@vger.kernel.org, linux-kselftest@vger.kernel.org, shuah@kernel.org, linux-doc@vger.kernel.org, corbet@lwn.net, chensong_2000@189.cn, Jeff Xie Subject: [PATCH v13 2/4] trace/objtrace: Get the value of the object Date: Sun, 26 Jun 2022 10:56:02 +0800 Message-Id: <20220626025604.277413-3-xiehuan09@gmail.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20220626025604.277413-1-xiehuan09@gmail.com> References: <20220626025604.277413-1-xiehuan09@gmail.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-kselftest@vger.kernel.org Using objtrace trigger to get the value of the object which from the kernel function parameter. Syntax: objtrace:add:obj[,offset][:type][:count][if ] Usage: # echo 'p bio_add_page arg1=$arg1' > ./kprobe_events # gdb vmlinux (gdb) p &(((struct bio *)0)->bi_iter.bi_size) $1 = (unsigned int *) 0x28 # echo 'objtrace:add:arg1,0x28:u32:1 if comm == "cat"' > ./events/kprobes/ \ p_bio_add_page_0/trigger # cat /test.txt Signed-off-by: Jeff Xie Acked-by: Masami Hiramatsu (Google) --- kernel/trace/trace.c | 2 +- kernel/trace/trace_entries.h | 5 +- kernel/trace/trace_object.c | 187 ++++++++++++++++++++++++++++++++--- kernel/trace/trace_output.c | 6 +- 4 files changed, 181 insertions(+), 19 deletions(-) diff --git a/kernel/trace/trace.c b/kernel/trace/trace.c index 7074ad8bc1a0..37f5cbfa5347 100644 --- a/kernel/trace/trace.c +++ b/kernel/trace/trace.c @@ -5628,7 +5628,7 @@ static const char readme_msg[] = "\t disable_hist::\n" #endif #ifdef CONFIG_TRACE_OBJECT - "\t objtrace:add:obj[:count][if ]\n" + "\t objtrace:add:obj[,offset][:type][:count][if ]\n" #endif #ifdef CONFIG_STACKTRACE "\t\t stacktrace\n" diff --git a/kernel/trace/trace_entries.h b/kernel/trace/trace_entries.h index bb120d9498a9..2407c45a568c 100644 --- a/kernel/trace/trace_entries.h +++ b/kernel/trace/trace_entries.h @@ -413,8 +413,9 @@ FTRACE_ENTRY(object, trace_object_entry, __field( unsigned long, ip ) __field( unsigned long, parent_ip ) __field( unsigned long, object ) + __field( unsigned long, value ) ), - F_printk(" %ps <-- %ps object:%lx\n", - (void *)__entry->ip, (void *)__entry->parent_ip, __entry->object) + F_printk(" %ps <-- %ps object:%lx value:%lx\n", (void *)__entry->ip, + (void *)__entry->parent_ip, __entry->object, __entry->value) ); diff --git a/kernel/trace/trace_object.c b/kernel/trace/trace_object.c index 19ec4b1c0186..611341abeb7c 100644 --- a/kernel/trace/trace_object.c +++ b/kernel/trace/trace_object.c @@ -16,8 +16,14 @@ static const int max_args_num = 6; static void exit_trace_object(struct trace_array *tr); static int init_trace_object(struct trace_array *tr); +/* + * get the offset from the special object and + * the type size of the value + */ struct object_instance { void *obj; + int obj_offset; + int obj_value_type_size; struct trace_array *tr; }; @@ -25,9 +31,23 @@ struct object_instance { struct objtrace_trigger_data { struct ftrace_event_field *field; char objtrace_cmd[OBJTRACE_CMD_LEN]; + int obj_offset; + int obj_value_type_size; struct trace_array *tr; }; +/* get the type size for the special object */ +struct objtrace_fetch_type { + char *name; + int type_size; +}; + +enum objattr { + OBJ_OFFSET, + OBJ_VAL_TYPE_SIZE, + MAX_OBJ_ATTR +}; + /* objtrace data with fops and objtrace_instances */ struct objtrace_data { struct list_head head; @@ -67,6 +87,35 @@ static bool object_exist(void *obj, struct trace_array *tr) return false; } +static int get_object_attr(void *obj, int objattr, + struct trace_array *tr, int *result) +{ + int i, max; + struct objtrace_data *obj_data; + + obj_data = get_obj_data(tr); + if (!obj_data) + return -EINVAL; + + max = READ_ONCE(obj_data->num_traced_obj); + smp_rmb(); + for (i = 0; i < max; i++) { + if (obj_data->traced_obj[i].obj == obj) { + switch (objattr) { + case OBJ_OFFSET: + *result = obj_data->traced_obj[i].obj_offset; + return 0; + case OBJ_VAL_TYPE_SIZE: + *result = obj_data->traced_obj[i].obj_value_type_size; + return 0; + default: + return -EINVAL; + } + } + } + return -EINVAL; +} + static bool object_empty(struct trace_array *tr) { struct objtrace_data *obj_data; @@ -78,7 +127,8 @@ static bool object_empty(struct trace_array *tr) return !READ_ONCE(obj_data->num_traced_obj); } -static void set_trace_object(void *obj, struct trace_array *tr) +static void set_trace_object(void *obj, int obj_offset, + int obj_value_type_size, struct trace_array *tr) { unsigned long flags; struct object_instance *obj_ins; @@ -103,6 +153,8 @@ static void set_trace_object(void *obj, struct trace_array *tr) } obj_ins = &obj_data->traced_obj[READ_ONCE(obj_data->num_traced_obj)]; obj_ins->obj = obj; + obj_ins->obj_value_type_size = obj_value_type_size; + obj_ins->obj_offset = obj_offset; obj_ins->tr = tr; /* make sure the num_traced_obj update always appears after traced_obj update */ smp_wmb(); @@ -112,7 +164,7 @@ static void set_trace_object(void *obj, struct trace_array *tr) } static void submit_trace_object(unsigned long ip, unsigned long parent_ip, - unsigned long object, struct trace_array *tr) + unsigned long object, unsigned long value, struct trace_array *tr) { struct trace_buffer *buffer = tr->array_buffer.buffer; @@ -129,10 +181,43 @@ static void submit_trace_object(unsigned long ip, unsigned long parent_ip, entry->ip = ip; entry->parent_ip = parent_ip; entry->object = object; + entry->value = value; trace_buffer_unlock_commit(tr, buffer, event, trace_ctx); } +static inline long get_object_value(unsigned long *val, void *obj, int type_size) +{ + char tmp[sizeof(u64)]; + long ret = 0; + + ret = copy_from_kernel_nofault(tmp, obj, sizeof(tmp)); + if (ret) + return ret; + switch (type_size) { + case 1: { + *val = (unsigned long)*(u8 *)tmp; + break; + } + case 2: { + *val = (unsigned long)*(u16 *)tmp; + break; + } + case 4: { + *val = (unsigned long)*(u32 *)tmp; + break; + } + case 8: { + *val = (unsigned long)*(u64 *)tmp; + break; + } + default: + return -EINVAL; + } + + return 0; +} + static void trace_object_events_call(unsigned long ip, unsigned long parent_ip, struct ftrace_ops *op, struct ftrace_regs *fregs) @@ -140,7 +225,8 @@ trace_object_events_call(unsigned long ip, unsigned long parent_ip, struct pt_regs *pt_regs = ftrace_get_regs(fregs); struct trace_array *tr = op->private; struct trace_array_cpu *data; - unsigned long obj; + int ret, val_type_size, obj_offset; + unsigned long obj, val; long disabled; int cpu, n; @@ -154,8 +240,21 @@ trace_object_events_call(unsigned long ip, unsigned long parent_ip, goto out; for (n = 0; n < max_args_num; n++) { obj = regs_get_kernel_argument(pt_regs, n); - if (object_exist((void *)obj, tr)) - submit_trace_object(ip, parent_ip, obj, tr); + if (object_exist((void *)obj, tr)) { + ret = get_object_attr((void *)obj, OBJ_OFFSET, + tr, &obj_offset); + if (unlikely(ret) < 0) + goto out; + ret = get_object_attr((void *)obj, OBJ_VAL_TYPE_SIZE, + tr, &val_type_size); + if (unlikely(ret) < 0) + goto out; + if (get_object_value(&val, (void *)(obj + obj_offset), + val_type_size)) + continue; + + submit_trace_object(ip, parent_ip, obj, val, tr); + } /* The parameters of a function may match multiple objects */ } } @@ -176,9 +275,23 @@ trace_object_trigger(struct event_trigger_data *data, field = obj_data->field; memcpy(&obj, rec + field->offset, sizeof(obj)); - set_trace_object(obj, tr); + /* set the offset from the special object and the type size of the value*/ + set_trace_object(obj, obj_data->obj_offset, + obj_data->obj_value_type_size, tr); } +static const struct objtrace_fetch_type objtrace_fetch_types[] = { + {"u8", 1}, + {"x8", 1}, + {"u16", 2}, + {"x16", 2}, + {"u32", 4}, + {"x32", 4}, + {"u64", 8}, + {"x64", 8}, + {NULL, 0}, +}; + static void trace_object_trigger_free(struct event_trigger_data *data) { @@ -213,14 +326,25 @@ static int event_trigger_print(const char *name, struct seq_file *m, void *data, char *filter_str, void *objtrace_data) { + int i; long count = (long)data; struct objtrace_trigger_data *obj_data = objtrace_data; + const char *value_type_name; seq_puts(m, name); seq_printf(m, ":%s", obj_data->objtrace_cmd); seq_printf(m, ":%s", obj_data->field->name); + if (obj_data->obj_offset) + seq_printf(m, ",0x%x", obj_data->obj_offset); + for (i = 0; objtrace_fetch_types[i].name; i++) { + if (objtrace_fetch_types[i].type_size == obj_data->obj_value_type_size) { + value_type_name = objtrace_fetch_types[i].name; + break; + } + } + seq_printf(m, ":%s", value_type_name); if (count == -1) seq_puts(m, ":unlimited"); else @@ -303,16 +427,18 @@ event_object_trigger_parse(struct event_command *cmd_ops, struct event_trigger_data *trigger_data; struct objtrace_trigger_data *obj_data; struct ftrace_event_field *field; - char *objtrace_cmd, *arg; - char *param, *filter; - int ret; + char *objtrace_cmd, *obj; + char *param, *filter, *str, *type; + int ret, i, def_type_size, obj_value_type_size = 0; + char *tmp_saved_param; + long offset = 0; bool remove; remove = event_trigger_check_remove(glob); /* * separate the param and the filter: - * objtrace:add:OBJ[:COUNT] [if filter] + * objtrace:add:OBJ[,OFFS][:TYPE][:COUNT] [if filter] */ ret = event_trigger_separate_filter(param_and_filter, ¶m, &filter, true); if (ret) @@ -324,11 +450,44 @@ event_object_trigger_parse(struct event_command *cmd_ops, return -EINVAL; } - arg = strsep(¶m, ":"); - if (!arg) + obj = strsep(¶m, ":"); + if (!obj) return -EINVAL; - field = trace_find_event_field(file->event_call, arg); + str = strchr(obj, ','); + if (!str) + offset = 0; + else { + *str++ = '\0'; + ret = kstrtol(str, 0, &offset); + if (ret) + return -EINVAL; + } + def_type_size = sizeof(void *); + if (!param) { + obj_value_type_size = def_type_size; + goto skip_get_type; + } + tmp_saved_param = param; + type = strsep(¶m, ":"); + if (!type) + obj_value_type_size = def_type_size; + /* if this is the trigger count */ + else if (isdigit(type[0])) { + obj_value_type_size = def_type_size; + param = tmp_saved_param; + } else { + for (i = 0; objtrace_fetch_types[i].name; i++) { + if (strcmp(objtrace_fetch_types[i].name, type) == 0) { + obj_value_type_size = objtrace_fetch_types[i].type_size; + break; + } + } + } + if (!obj_value_type_size) + return -EINVAL; +skip_get_type: + field = trace_find_event_field(file->event_call, obj); if (!field) return -EINVAL; @@ -345,6 +504,8 @@ event_object_trigger_parse(struct event_command *cmd_ops, return -ENOMEM; obj_data->field = field; + obj_data->obj_offset = offset; + obj_data->obj_value_type_size = obj_value_type_size; obj_data->tr = file->tr; snprintf(obj_data->objtrace_cmd, OBJTRACE_CMD_LEN, objtrace_cmd); diff --git a/kernel/trace/trace_output.c b/kernel/trace/trace_output.c index 34ff7b4dc521..a45871b52dcc 100644 --- a/kernel/trace/trace_output.c +++ b/kernel/trace/trace_output.c @@ -1561,6 +1561,7 @@ static enum print_line_t trace_object_print(struct trace_iterator *iter, int fla trace_assign_type(field, iter->ent); print_fn_trace(s, field->ip, field->parent_ip, flags); trace_seq_printf(s, " object:0x%lx", field->object); + trace_seq_printf(s, " value:0x%lx", field->value); trace_seq_putc(s, '\n'); return trace_handle_return(s); @@ -1573,9 +1574,8 @@ static enum print_line_t trace_object_raw(struct trace_iterator *iter, int flags trace_assign_type(field, iter->ent); - trace_seq_printf(&iter->seq, "%lx %lx\n", - field->ip, - field->parent_ip); + trace_seq_printf(&iter->seq, "%lx %lx %lx %lx\n", field->ip, + field->parent_ip, field->object, field->value); return trace_handle_return(&iter->seq); } From patchwork Sun Jun 26 02:56:03 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jeff Xie X-Patchwork-Id: 12895577 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 3CE9EC433EF for ; Sun, 26 Jun 2022 02:57:05 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233848AbiFZC5E (ORCPT ); Sat, 25 Jun 2022 22:57:04 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:56496 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233830AbiFZC5D (ORCPT ); Sat, 25 Jun 2022 22:57:03 -0400 Received: from mail-pj1-x102f.google.com (mail-pj1-x102f.google.com [IPv6:2607:f8b0:4864:20::102f]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id D1DCD13F32; Sat, 25 Jun 2022 19:57:01 -0700 (PDT) Received: by mail-pj1-x102f.google.com with SMTP id i8-20020a17090aee8800b001ecc929d14dso8060997pjz.0; Sat, 25 Jun 2022 19:57:01 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=2dN5G1vAgM+iieaUadZcmGZDhYEB0h4tsZbu64ort+c=; b=o5t5YO0FJjS7eQ06MNQBt4EBZwG/pZfu3h0d7yLir9SjcB6MoBt5VeQr1HeBjV4+iA Fld5IYBDgtT8mUzJBttgV7YscsDL1WMpnBxxzUw5fJolRLeZJVF0KehOSrwmFbgD9Bgm IdrPiPg0KapTZCuXetpcq5yTZgeN0V/nis+ViNl1cQLtnalOg/hbtmErwharcRNnxG9X lYp/nFokUC69BIXqW0bk4TBGq9lL3i17heB/ZOAnG7g8bsqq+6hzkc7LeJU9Tu7ntiRO 1k8fXM8Rn9BQwnGlMiuWj7txHaTKabVl9bPmJk05TkdjjYaNOw4G6lk+grim65Ii5ETC rLtw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=2dN5G1vAgM+iieaUadZcmGZDhYEB0h4tsZbu64ort+c=; b=L9yPbixCU3UVLGyVVTR9ag0Crk8YtX3OH5X7jN1rZhoPU4GZSzkD2WW7VtZUvHeOBy JJRiv6JbfuzJVpgc0d1ZVoYHFuvY9/j4FiRnJano5/faP/CHStXVlk9eOc4r6yNzH8tP lOx7Yc72wgk+lCdTo0yqxbMXsXVQrCRNiDjibrtmVPUHJT+A/xS8Zdtk980PDr+Y4AXh JMFe5K4XUlpv/65zVqpepGQ0xg6EjceZLjxlhlb3k0VRuzGd4tQsvjGC287x7JYFTnmE LPjz+0Vxof/Ng+D8gJbGjNd4n3vYVhjaL2mFx8k/I7kUaZis+nFurY8KxPkUIOPhdgU8 hgcg== X-Gm-Message-State: AJIora/bOsmYYqASquQ5b9Y/pKy2Y/IZoTW4FBm6M9KqWUzpTOyy8QGR WE0/29UAO+O1NHhgnz56H9LwpRFtPk3MUrCd X-Google-Smtp-Source: AGRyM1uqtw12aljp7U4E54+bccQZ5Jso7UfBf5W90/F+JEs9rle9ZZpt3a78AsP0xYLozoVp6d1RKA== X-Received: by 2002:a17:90b:17c1:b0:1ed:1b79:8c04 with SMTP id me1-20020a17090b17c100b001ed1b798c04mr13366152pjb.53.1656212221405; Sat, 25 Jun 2022 19:57:01 -0700 (PDT) Received: from localhost.localdomain (li567-56.members.linode.com. [192.155.81.56]) by smtp.gmail.com with ESMTPSA id d15-20020a056a0024cf00b005258df7615bsm1607061pfv.0.2022.06.25.19.56.57 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 25 Jun 2022 19:57:01 -0700 (PDT) From: Jeff Xie To: rostedt@goodmis.org Cc: mingo@redhat.com, mhiramat@kernel.org, zanussi@kernel.org, linux-kernel@vger.kernel.org, linux-kselftest@vger.kernel.org, shuah@kernel.org, linux-doc@vger.kernel.org, corbet@lwn.net, chensong_2000@189.cn, Jeff Xie Subject: [PATCH v13 3/4] selftests/ftrace: Add testcases for objtrace Date: Sun, 26 Jun 2022 10:56:03 +0800 Message-Id: <20220626025604.277413-4-xiehuan09@gmail.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20220626025604.277413-1-xiehuan09@gmail.com> References: <20220626025604.277413-1-xiehuan09@gmail.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-kselftest@vger.kernel.org Add a series of testcases to illustrate correct and incorrect usage of objtrace trigger. Signed-off-by: Jeff Xie Tested-by: Masami Hiramatsu (Google) Acked-by: Masami Hiramatsu (Google) Acked-by: Shuah Khan --- .../ftrace/test.d/trigger/trigger-objtrace.tc | 41 +++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 tools/testing/selftests/ftrace/test.d/trigger/trigger-objtrace.tc diff --git a/tools/testing/selftests/ftrace/test.d/trigger/trigger-objtrace.tc b/tools/testing/selftests/ftrace/test.d/trigger/trigger-objtrace.tc new file mode 100644 index 000000000000..d894442b6a30 --- /dev/null +++ b/tools/testing/selftests/ftrace/test.d/trigger/trigger-objtrace.tc @@ -0,0 +1,41 @@ +#!/bin/sh +# SPDX-License-Identifier: GPL-2.0 +# description: event trigger - test objtrace-trigger +# requires: kprobe_events "objtrace":README + +fail() { #msg + echo $1 + exit_fail +} + +echo 'p bio_add_page arg1=$arg1 arg2=$arg2' > kprobe_events + +FEATURE=`grep objtrace events/kprobes/p_bio_add_page_0/trigger` +if [ -z "$FEATURE" ]; then + echo "objtrace trigger is not supported" + exit_unsupported +fi + +echo "Test objtrace trigger" +echo 'objtrace:add:arg1,0x28:u32:1 if comm == "cat"' > \ + events/kprobes/p_bio_add_page_0/trigger +if [ -z $? ]; then + fail "objtrace trigger syntax error" +fi + +echo "Test objtrace semantic errors" + +# Being lack of objtrace command +! echo 'objtrace:arg1,0x28:u32:1' > events/kprobes/p_bio_add_page_0/trigger +# Bad parameter name +! echo 'objtrace:add:argx:u32:1' > events/kprobes/p_bio_add_page_0/trigger +# The parameter existed on event +! echo 'objtrace:add:arg2:u32:1' > events/kprobes/p_bio_add_page_0/trigger + +echo "reset objtrace trigger" + +echo '!objtrace:add:arg1,0x28:u32' > \ + events/kprobes/p_bio_add_page_0/trigger +echo '-:p_bio_add_page_0' >> ./kprobe_events + +exit 0 From patchwork Sun Jun 26 02:56:04 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jeff Xie X-Patchwork-Id: 12895578 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 64A61C433EF for ; Sun, 26 Jun 2022 02:57:09 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233866AbiFZC5H (ORCPT ); Sat, 25 Jun 2022 22:57:07 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:56534 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233862AbiFZC5G (ORCPT ); Sat, 25 Jun 2022 22:57:06 -0400 Received: from mail-pl1-x630.google.com (mail-pl1-x630.google.com [IPv6:2607:f8b0:4864:20::630]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id BF48C14086; Sat, 25 Jun 2022 19:57:05 -0700 (PDT) Received: by mail-pl1-x630.google.com with SMTP id jh14so5361826plb.1; Sat, 25 Jun 2022 19:57:05 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=n3hhQPO2fW5XY1lD1FShy4GvYT7oXmPJAA+Tu0kaqEM=; b=dyKiLrAygm72qE6EFgzwyNOrfbRkpr7KP6nllT7kft3OxF8MQwkd6Ss0SnL9M3ta4U qSL1mO1d8aoIMVEeEhkoUO4q8RH9lKPnzAg6Opd/L2fjG6RIT7qqTutZyaGGdhZYnP75 4vfdpSfBY2yVKEPurE9tNM8L9epu9ZL9u+HfHLEbgf6G6sk2lWK0kGPlfONzOVBiDMjB /nFLWkqfoFn0K5DcgJvs0c6ycmoN5n1GhbYANzLk6b9n6NhMGDtausPEsFcPao7y5bFi J3zV8Yb5YNeJv1Mc6z2qV8xI2QRyF+SrspAaEOImnQudpC5TAj4u1AefAziasEn4BlBn mM/A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=n3hhQPO2fW5XY1lD1FShy4GvYT7oXmPJAA+Tu0kaqEM=; b=ho+oOPWipTZKVnB+pNJjAqlRQlDqOwOHXX+UNxi05JzgxOey/PzKK84bEPIg5bH+pn gdzHsUoW8BMgP+XL5TZXFUeBBfHGG2meaO5t1zzZ69jV5FtHqhwCZbyg84nkjuqk6wHY 6ZleNYDFerXNHPNeDlEXIvnut6ww0XWRjreqfJAsOBriHMogoJgBGcOZRvLoJbWvAZJT VoBmRyY7UJ+uMcMEHg++KJBTGhS3hcUAQvbPWy2CrhGueinFt5nW6Ma6UV7ek+E2Wy6A /QLxUMo4zk1bFq7dD4wKIx0SpkmOWAlV/L0k0jHnAWo4TGkoDy31dxZMBzTsRpuqAZqu bRrQ== X-Gm-Message-State: AJIora+jWb6yupXTIqPE1g0+Z9JIERWmAyOia6+PGgiIkVYPeMCRTdOF 1M1LWSvlgjiD0eeRvX1sKvE= X-Google-Smtp-Source: AGRyM1uP2nviRZEiBf+6u1N9g0wnWLeZjuMgeWwZZ1sWfg+gXrqAPaUZ1Zx9rtGjTy59Cq66R87PPw== X-Received: by 2002:a17:902:6503:b0:16a:4db1:8d5a with SMTP id b3-20020a170902650300b0016a4db18d5amr7434516plk.133.1656212225260; Sat, 25 Jun 2022 19:57:05 -0700 (PDT) Received: from localhost.localdomain (li567-56.members.linode.com. [192.155.81.56]) by smtp.gmail.com with ESMTPSA id d15-20020a056a0024cf00b005258df7615bsm1607061pfv.0.2022.06.25.19.57.01 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 25 Jun 2022 19:57:04 -0700 (PDT) From: Jeff Xie To: rostedt@goodmis.org Cc: mingo@redhat.com, mhiramat@kernel.org, zanussi@kernel.org, linux-kernel@vger.kernel.org, linux-kselftest@vger.kernel.org, shuah@kernel.org, linux-doc@vger.kernel.org, corbet@lwn.net, chensong_2000@189.cn, Jeff Xie Subject: [PATCH v13 4/4] Documentation: trace/objtrace: Add documentation for objtrace Date: Sun, 26 Jun 2022 10:56:04 +0800 Message-Id: <20220626025604.277413-5-xiehuan09@gmail.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20220626025604.277413-1-xiehuan09@gmail.com> References: <20220626025604.277413-1-xiehuan09@gmail.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-kselftest@vger.kernel.org Added documentation explaining how to use objtrace trigger to get the value of the object. Signed-off-by: Jeff Xie Reviewed-by: Masami Hiramatsu (Google) --- Documentation/trace/events.rst | 83 ++++++++++++++++++++++++++++++++++ 1 file changed, 83 insertions(+) diff --git a/Documentation/trace/events.rst b/Documentation/trace/events.rst index c47f381d0c00..0dc475160133 100644 --- a/Documentation/trace/events.rst +++ b/Documentation/trace/events.rst @@ -546,6 +546,89 @@ The following commands are supported: See Documentation/trace/histogram.rst for details and examples. +- objtrace + + This command provides a way to get the value of any object, The object + can be obtained from the dynamic event(kprobe_event/uprobe_event) or the + static event(tracepoint). + + Usage: + When using the kprobe event, only need to set the objtrace(a new trigger), + we can get the value of the object. The object is from the setting of the + kprobe event. + + For example: + For the function bio_add_page(): + + int bio_add_page(struct bio *bio, struct page *page, + unsigned int len, unsigned int offset) + + Firstly, we can set the base of the object, thus the first string "arg1" + stands for the value of the first parameter of this function bio_add_gage(), + + # echo 'p bio_add_page arg1=$arg1' > ./kprobe_events + + Secondly, we can get the value dynamically based on above object. + + find the offset of the bi_size in struct bio: + $ gdb vmlinux + (gdb) p &(((struct bio *)0)->bi_iter.bi_size) + $1 = (unsigned int *) 0x28 + + # echo 'objtrace:add:arg1,0x28:u32:1 if comm == "cat"' > ./events/kprobes/ \ + p_bio_add_page_0/trigger + + # cd /sys/kernel/debug/tracing/ + # echo 'p bio_add_page arg1=$arg1' > ./kprobe_events + # echo 'objtrace:add:arg1,0x28:u32:1 if comm == "cat"' > ./events/kprobes/p_bio_add_page_0/trigger + + # du -sh /test.txt + 12.0K /test.txt + + # cat /test.txt > /dev/null + # cat ./trace + # tracer: nop + # + # entries-in-buffer/entries-written: 128/128 #P:4 + # + # _-----=> irqs-off/BH-disabled + # / _----=> need-resched + # | / _---=> hardirq/softirq + # || / _--=> preempt-depth + # ||| / _-=> migrate-disable + # |||| / delay + # TASK-PID CPU# ||||| TIMESTAMP FUNCTION + # | | | ||||| | | + cat-117 [002] ...1. 1.602243: __bio_try_merge_page <-bio_add_page object:0xffff88811bee4000 value:0x0 + cat-117 [002] ...1. 1.602244: __bio_add_page <-bio_add_page object:0xffff88811bee4000 value:0x0 + cat-117 [002] ...2. 1.602244: bio_add_page <-ext4_mpage_readpages object:0xffff88811bee4000 value:0x1000 + cat-117 [002] ...1. 1.602245: __bio_try_merge_page <-bio_add_page object:0xffff88811bee4000 value:0x1000 + cat-117 [002] ...1. 1.602245: __bio_add_page <-bio_add_page object:0xffff88811bee4000 value:0x1000 + cat-117 [002] ...2. 1.602245: bio_add_page <-ext4_mpage_readpages object:0xffff88811bee4000 value:0x2000 + cat-117 [002] ...1. 1.602245: __bio_try_merge_page <-bio_add_page object:0xffff88811bee4000 value:0x2000 + cat-117 [002] ...1. 1.602245: __bio_add_page <-bio_add_page object:0xffff88811bee4000 value:0x2000 + cat-117 [002] ...1. 1.602245: submit_bio <-ext4_mpage_readpages object:0xffff88811bee4000 value:0x3000 + cat-117 [002] ...1. 1.602245: submit_bio_noacct <-ext4_mpage_readpages object:0xffff88811bee4000 value:0x3000 + cat-117 [002] ...1. 1.602246: __submit_bio <-submit_bio_noacct object:0xffff88811bee4000 value:0x3000 + cat-117 [002] ...1. 1.602246: submit_bio_checks <-__submit_bio object:0xffff88811bee4000 value:0x3000 + cat-117 [002] ...1. 1.602246: __cond_resched <-submit_bio_checks object:0xffff88811bee4000 value:0x3000 + cat-117 [002] ...1. 1.602246: should_fail_bio <-submit_bio_checks object:0xffff88811bee4000 value:0x3000 + cat-117 [002] ...1. 1.602246: blk_mq_submit_bio <-submit_bio_noacct object:0xffff88811bee4000 value:0x3000 + cat-117 [002] ...1. 1.602246: blk_attempt_plug_merge <-blk_mq_submit_bio object:0xffff88811bee4000 value:0x3000 + cat-117 [002] ...1. 1.602246: blk_mq_sched_bio_merge <-blk_mq_submit_bio object:0xffff88811bee4000 value:0x3000 + cat-117 [002] ...1. 1.602247: __rcu_read_lock <-blk_mq_submit_bio object:0xffff88811bee4000 value:0x3000 + cat-117 [002] ...1. 1.602247: __rcu_read_unlock <-blk_mq_submit_bio object:0xffff88811bee4000 value:0x3000 + cat-117 [002] ...1. 1.602247: __blk_mq_alloc_requests <-blk_mq_submit_bio object:0xffff88811bee4000 value:0x3000 + -0 [002] d..3. 1.602298: bio_endio <-blk_update_request object:0xffff88811bee4000 value:0x0 + -0 [002] d..3. 1.602298: mpage_end_io <-blk_update_request object:0xffff88811bee4000 value:0x0 + -0 [002] d..3. 1.602298: __read_end_io <-blk_update_request object:0xffff88811bee4000 value:0x0 + -0 [002] d..3. 1.602300: bio_put <-blk_update_request object:0xffff88811bee4000 value:0x0 + -0 [002] d..3. 1.602300: bio_free <-blk_update_request object:0xffff88811bee4000 value:0x0 + -0 [002] d..3. 1.602300: mempool_free <-blk_update_request object:0xffff88811bee4000 value:0x0 + -0 [002] d..3. 1.602300: mempool_free_slab <-blk_update_request object:0xffff88811bee4000 value:0x0 + -0 [002] d..3. 1.602300: kmem_cache_free <-blk_update_request object:0xffff88811bee4000 value:0x0 + ... + 7. In-kernel trace event API ============================