From patchwork Mon Jul 17 15:24:47 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Masami Hiramatsu (Google)" X-Patchwork-Id: 121429 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:c923:0:b0:3e4:2afc:c1 with SMTP id j3csp1206945vqt; Mon, 17 Jul 2023 09:12:42 -0700 (PDT) X-Google-Smtp-Source: APBJJlGR66Ib67cwSq1mHATzKY73R3xH9DPlRvAZqzLLjhpFo0TxZ8RaiG0fuKgMsJZ2GhhWCYFm X-Received: by 2002:a17:90a:a24:b0:263:560a:e794 with SMTP id o33-20020a17090a0a2400b00263560ae794mr10982386pjo.21.1689610361752; Mon, 17 Jul 2023 09:12:41 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1689610361; cv=none; d=google.com; s=arc-20160816; b=LcaSC76BkMRJHDbj1NCo9XxpxdgKcfIRYotiCRsT1hVzvu9nNUTfgb5UVNOCcKrEJ0 T+Du2v5nYEpHsyheHu99l9Fbx1FOVqrZw+sIIWBTIXZmjabvHDLIp3MIPVouaCnO3TZg S/lA8d/L3ww07+6yiRnYUOnscsTwXRkoA20CZwcd6KIXJTSq6puDe59ddi3svhxy5/tI AsIqM4Kg5n3BLZ3JAuykFz2CIEXEdqB7Zi82dt3VwrNS6Kw4vdAx1Eu5ujI9E9JIgOKM DD1mOHiz6mcSQmT+vVZT9EPJD8BJBCK8myaqHbdwozU2meG7mJZT3ibTcpw4afLxmQIE VOsQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :user-agent:references:in-reply-to:message-id:date:subject:cc:to :from:dkim-signature; bh=MLuFie6pRhtxDNy+0DvVcaknVAblcQ4eK2OO8w/kiMg=; fh=raxTTJvC+dSJYbgfX5JG5gvrVjxTZXczN0HF8iDayLY=; b=mxkQZrZBVFmxYOaf7ibPLHkr+YGRmoihaMsD0t8CRuWqaCinBrE22zztYec6fnrFpi rGWx4o8aenAHyCGecw4UpyTUQxdT81mZARbXxysAjI9bM8VzRTa4Hb5gNXuG8U9UIqyI 7/Dxx+81JexB5LH/TENZmwrgETXsxxSDBF4Sqn/C0+me0aws4Uoj+lXFbzo08dQer9oF Td1GNxzVT4VEUj5FAOQshx779xqSmWrHDFOm0Lmxxn0PwkassXNnUhgXM5eHIDbPob2A Ky52ULMXmXrKLwho/fsqeoD2jR1lErOqzjdJPjebDstejF8BFy+X0j8n1i5OjSrXm8vS aq6g== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@kernel.org header.s=k20201202 header.b=M0QIKRYq; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id lp6-20020a17090b4a8600b00263860e1f4csi6129768pjb.16.2023.07.17.09.12.28; Mon, 17 Jul 2023 09:12:41 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@kernel.org header.s=k20201202 header.b=M0QIKRYq; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231681AbjGQPZ6 (ORCPT + 99 others); Mon, 17 Jul 2023 11:25:58 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:57774 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232077AbjGQPZW (ORCPT ); Mon, 17 Jul 2023 11:25:22 -0400 Received: from dfw.source.kernel.org (dfw.source.kernel.org [IPv6:2604:1380:4641:c500::1]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 8137E1709; Mon, 17 Jul 2023 08:24:53 -0700 (PDT) Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by dfw.source.kernel.org (Postfix) with ESMTPS id C343E6111E; Mon, 17 Jul 2023 15:24:52 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 4DF3FC433C7; Mon, 17 Jul 2023 15:24:50 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1689607492; bh=jfsyJNrolIUjYdnOxE9K/vaKVHqekN0muXVvxqmYTwY=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=M0QIKRYqbqOunmlZej0c6MOtavCWOma/HQor1eBeB5aUhCj9cCes5zRUs0EzehPsd 3ZQHFe7jGl3p7a+a3jCxwpZ1wPwGEbCfbGPrbda3oKZ6unysYT6coxbgWNCz8Pu3Ev m7xu4WRWzCaZdRD6Xbu4CqWPgLT5W6Qkx6xKTU23PXgASD0YLan0E/Y0SqyGl4V0a0 3K05gn6FEy626Qhjtkjz6vgioW2Q+tqYg5U2rKLVPVFsyL3umvYBDhRx38B5Bfy7q+ zbFByA7C0PZRE3oU+dhZM/9Uhuzwak/bmBU0KHEQkGAQhwyN3GFck1UY8t8wRkLlm9 7LKpuJFjpofPA== From: "Masami Hiramatsu (Google)" To: linux-trace-kernel@vger.kernel.org Cc: linux-kernel@vger.kernel.org, Steven Rostedt , mhiramat@kernel.org, Martin KaFai Lau , bpf@vger.kernel.org, Sven Schnelle , Alexei Starovoitov Subject: [PATCH v2 9/9] Documentation: tracing: Update fprobe event example with BTF field Date: Tue, 18 Jul 2023 00:24:47 +0900 Message-Id: <168960748753.34107.1941635032108706544.stgit@devnote2> X-Mailer: git-send-email 2.25.1 In-Reply-To: <168960739768.34107.15145201749042174448.stgit@devnote2> References: <168960739768.34107.15145201749042174448.stgit@devnote2> User-Agent: StGit/0.19 MIME-Version: 1.0 X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF, RCVD_IN_DNSWL_BLOCKED,SPF_HELO_NONE,SPF_PASS,T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1771684874367581039 X-GMAIL-MSGID: 1771684874367581039 From: Masami Hiramatsu (Google) Update fprobe event example with BTF data structure field specification. Signed-off-by: Masami Hiramatsu (Google) Reviewed-by: Alan Maguire --- Changes in v2: - Remove 'retval' and use '$retval'. --- Documentation/trace/fprobetrace.rst | 50 ++++++++++++++++++++++------------- 1 file changed, 32 insertions(+), 18 deletions(-) diff --git a/Documentation/trace/fprobetrace.rst b/Documentation/trace/fprobetrace.rst index 7297f9478459..e9e764fadf14 100644 --- a/Documentation/trace/fprobetrace.rst +++ b/Documentation/trace/fprobetrace.rst @@ -79,9 +79,9 @@ automatically set by the given name. :: f:fprobes/myprobe vfs_read count=count pos=pos It also chooses the fetch type from BTF information. For example, in the above -example, the ``count`` is unsigned long, and the ``pos`` is a pointer. Thus, both -are converted to 64bit unsigned long, but only ``pos`` has "%Lx" print-format as -below :: +example, the ``count`` is unsigned long, and the ``pos`` is a pointer. Thus, +both are converted to 64bit unsigned long, but only ``pos`` has "%Lx" +print-format as below :: # cat events/fprobes/myprobe/format name: myprobe @@ -105,9 +105,33 @@ is expanded to all function arguments of the function or the tracepoint. :: # cat dynamic_events f:fprobes/myprobe vfs_read file=file buf=buf count=count pos=pos -BTF also affects the ``$retval``. If user doesn't set any type, the retval type is -automatically picked from the BTF. If the function returns ``void``, ``$retval`` -is rejected. +BTF also affects the ``$retval``. If user doesn't set any type, the retval +type is automatically picked from the BTF. If the function returns ``void``, +``$retval`` is rejected. + +You can access the data fields of a data structure using allow operator ``->`` +(for pointer type) and dot operator ``.`` (for data structure type.):: + +# echo 't sched_switch preempt prev_pid=prev->pid next_pid=next->pid' >> dynamic_events + +This data field access is available for the return value via ``$retval``, +e.g. ``$retval->name``. + +For these BTF arguments and fields, ``:string`` and ``:ustring`` change the +behavior. If these are used for BTF argument or field, it checks whether +the BTF type of the argument or the data field is ``char *`` or ``char []``, +or not. If not, it rejects applying the string types. Also, with the BTF +support, you don't need a memory dereference operator (``+0(PTR)``) for +accessing the string pointed by a ``PTR``. It automatically adds the memory +dereference operator according to the BTF type. e.g. :: + +# echo 't sched_switch prev->comm:string' >> dynamic_events +# echo 'f getname_flags%return $retval->name:string' >> dynamic_events + +The ``prev->comm`` is an embedded char array in the data structure, and +``$retval->name`` is a char pointer in the data structure. But in both +cases, you can use ``:string`` type to get the string. + Usage examples -------------- @@ -161,10 +185,10 @@ parameters. This means you can access any field values in the task structure pointed by the ``prev`` and ``next`` arguments. For example, usually ``task_struct::start_time`` is not traced, but with this -traceprobe event, you can trace it as below. +traceprobe event, you can trace that field as below. :: - # echo 't sched_switch comm=+1896(next):string start_time=+1728(next):u64' > dynamic_events + # echo 't sched_switch comm=next->comm:string next->start_time' > dynamic_events # head -n 20 trace | tail # TASK-PID CPU# ||||| TIMESTAMP FUNCTION # | | | ||||| | | @@ -176,13 +200,3 @@ traceprobe event, you can trace it as below. -0 [000] d..3. 5606.690317: sched_switch: (__probestub_sched_switch+0x4/0x10) comm="kworker/0:1" usage=1 start_time=137000000 kworker/0:1-14 [000] d..3. 5606.690339: sched_switch: (__probestub_sched_switch+0x4/0x10) comm="swapper/0" usage=2 start_time=0 -0 [000] d..3. 5606.692368: sched_switch: (__probestub_sched_switch+0x4/0x10) comm="kworker/0:1" usage=1 start_time=137000000 - -Currently, to find the offset of a specific field in the data structure, -you need to build kernel with debuginfo and run `perf probe` command with -`-D` option. e.g. -:: - - # perf probe -D "__probestub_sched_switch next->comm:string next->start_time" - p:probe/__probestub_sched_switch __probestub_sched_switch+0 comm=+1896(%cx):string start_time=+1728(%cx):u64 - -And replace the ``%cx`` with the ``next``.