From mboxrd@z Thu Jan 1 00:00:00 1970 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 4150BC00140 for ; Thu, 18 Aug 2022 15:56:23 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232752AbiHRP4V (ORCPT ); Thu, 18 Aug 2022 11:56:21 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:50736 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1344664AbiHRPzx (ORCPT ); Thu, 18 Aug 2022 11:55:53 -0400 Received: from mail-qv1-xf2c.google.com (mail-qv1-xf2c.google.com [IPv6:2607:f8b0:4864:20::f2c]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id D68612D1CD for ; Thu, 18 Aug 2022 08:53:54 -0700 (PDT) Received: by mail-qv1-xf2c.google.com with SMTP id u10so1464932qvp.12 for ; Thu, 18 Aug 2022 08:53:54 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=joelfernandes.org; s=google; h=in-reply-to:content-disposition:mime-version:references:message-id :subject:cc:to:from:date:from:to:cc; bh=LqvAclootoU2W0/pp2IxA3VkdIzT+EcMbsWeHXyjoIk=; b=ULeWbHzUKqnKUycrBXTKB4oAjs889mEalvJN3O9tVYw+wgybCTBYl9Ce4PM8A9k9DM ZZdqyYhIz1PwIKfJm06PvioihPScZIVK0Pofh4vto/HrZzH9utD3RYcBSBeMUhYbfjV9 nuUy0wjkKQj7IjwflbfkrPs4EshJy5WYEmn+E= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=in-reply-to:content-disposition:mime-version:references:message-id :subject:cc:to:from:date:x-gm-message-state:from:to:cc; bh=LqvAclootoU2W0/pp2IxA3VkdIzT+EcMbsWeHXyjoIk=; b=qgIvjDFmRgrQgVFGktzj+v63Mrgl/S3ameHoPHddHkqut2J/4TAkXAveelqUrtP7s8 m0lKzvp+5M3i6WPkoV0xurjfRlwdqgvhKx0h+jeLF5y3gFlTeDm+tQnjXJy9mpHgrRXw czN+gEvQei9wX5RvmpQvSuWvoCsz2ZZiRxf/bwukSgwFI4+cxcOZd3FE/tNBaViRVNbk ids3yxFObXK2hVKyY+H1hILmKI12aX3cxN1Z4RYqTv0mgGLZZu4yIgGkpUW17AHB9PN8 ORu2BuyImQg6kwHjIqaGBxePFlm9Kycu7B+IkjGCRJzbHBizbGhwiLkTTap2BApbHEXY xO4Q== X-Gm-Message-State: ACgBeo1XrWKEkJZYH9xsfkJNo0bFyoLZlfp64GKbk0INguofuxvWmXmu z8pxguTZY7tyybfX7jsAST4nbw== X-Google-Smtp-Source: AA6agR4SBoQ02Gaq+iBnWu5sufgXL7wS2GOYI0RbT+sfE2jQru2DQwU62u4gEv0qd+72BdP382DhuQ== X-Received: by 2002:a0c:a9d6:0:b0:496:a9fd:8595 with SMTP id c22-20020a0ca9d6000000b00496a9fd8595mr3002642qvb.108.1660838033981; Thu, 18 Aug 2022 08:53:53 -0700 (PDT) Received: from localhost (228.221.150.34.bc.googleusercontent.com. [34.150.221.228]) by smtp.gmail.com with ESMTPSA id bs43-20020a05620a472b00b006b9b7879964sm1785413qkb.28.2022.08.18.08.53.53 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 18 Aug 2022 08:53:53 -0700 (PDT) Date: Thu, 18 Aug 2022 15:53:52 +0000 From: Joel Fernandes To: Jeff Xie Cc: rostedt@goodmis.org, mingo@redhat.com, mhiramat@kernel.org, zanussi@kernel.org, linux-kernel@vger.kernel.org, chensong_2000@189.cn, Jonathan Corbet , Bagas Sanjaya , linux-doc@vger.kernel.org Subject: Re: [PATCH v14 4/4] Documentation: trace/objtrace: Add documentation for objtrace Message-ID: References: <20220628145552.349839-1-xiehuan09@gmail.com> <20220628145552.349839-5-xiehuan09@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20220628145552.349839-5-xiehuan09@gmail.com> Precedence: bulk List-ID: X-Mailing-List: linux-doc@vger.kernel.org On Tue, Jun 28, 2022 at 10:55:52PM +0800, Jeff Xie wrote: > Add documentation explaining how to use objtrace trigger to get the value > of the object. > > Cc: Jonathan Corbet > Cc: Bagas Sanjaya > Cc: linux-doc@vger.kernel.org > Signed-off-by: Jeff Xie > Reviewed-by: Masami Hiramatsu (Google) > --- > Changelog: > v14: > - make documentation more readable and fix literal code block by Bagas Sanjaya > > Documentation/trace/events.rst | 87 ++++++++++++++++++++++++++++++++++ > 1 file changed, 87 insertions(+) > > diff --git a/Documentation/trace/events.rst b/Documentation/trace/events.rst > index c47f381d0c00..c15f1d25d4a0 100644 > --- a/Documentation/trace/events.rst > +++ b/Documentation/trace/events.rst > @@ -546,6 +546,93 @@ 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, by only need to set the objtrace (a new > + trigger), we can get the value of object that is set by kprobe event. > + > + For example, for the function bio_add_page(): > + > + .. code-block:: c > + > + 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 as first parameter (arg1) to > + to the function: > + > + .. code-block:: > + > + # echo 'p bio_add_page arg1=$arg1' > ./kprobe_events > + > + Secondly, we can get the value dynamically based on the object: > + > + .. code-block:: > + > + 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 No offense but this documentation is not well written and hard to read. Admittedly though I am just casually browsing through, so apologies. So basically, 0x28 is the offset of the u32 within the bio, that you want to track down, as it passes through functions? The example is good, but I suggest breakdown each of the commands separated by ':' and document those as well. Cool feature though, I can see myself using it for something (dunno what yet) :) thanks, - Joel > + > + # 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 > ============================ > > -- > 2.25.1 >