From patchwork Fri Jan 12 10:17:52 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Masami Hiramatsu (Google)" X-Patchwork-Id: 187694 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:693c:2614:b0:101:6a76:bbe3 with SMTP id mm20csp79596dyc; Fri, 12 Jan 2024 02:22:58 -0800 (PST) X-Google-Smtp-Source: AGHT+IExQgbfHvqRCsFqMM9HVVHysXsDOVpgDzfShzIlFjnIeYidhQ+k1c3njjkYMZGPyXL1xPTz X-Received: by 2002:a05:6214:d0b:b0:680:d83:dc9c with SMTP id 11-20020a0562140d0b00b006800d83dc9cmr686566qvh.101.1705054978241; Fri, 12 Jan 2024 02:22:58 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1705054978; cv=none; d=google.com; s=arc-20160816; b=WT5HMuFhHFg5f4p9dnnqmmOHdkSKq5oEvagZCK7PJ7vqxwcQCTChS0anSgq6i4X1T/ gG+oAhEXltcVKZBdUzmk5Z4ee6o+80xMypvedJpxJ8sdF6fA4fY2ML3Jwng+0yrFYfWL rVTUf8Py8gY7zdYIntmD54uyQBsUfx8CAhM6rp0t3gP2tZvxA0USgg15LsdB5MnvtNac BwZnDo8WIJwxwsPD89pjBfDlciVg52UJHnE571ebhT32aMDwrGUle6adOM/RoHlCXaB7 Lc17kixmkB/I831hZ1rQb3I+dahyzH9q/Fe6gVwKe4BCe4m1pAY2O1UPCeMtKRjZYOdK Qg5g== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=content-transfer-encoding:mime-version:list-unsubscribe :list-subscribe:list-id:precedence:user-agent:references:in-reply-to :message-id:date:subject:cc:to:from:dkim-signature; bh=g/RVfnmZcQdfRZB+YRyiXpHH94CCdK1xBgexCLFpl6s=; fh=SIgps5XdV0XNwjZfT2uAI7g3mrspDldK9Qs8qQAfoa4=; b=IWWYBSkIplVw0EYT/FCVMYra8E/Iwa5HXBiwJV7tYhsdBiiOpTpXB2QPSP+HZtGeuA DS1Ad2Uer06zgz0eBefDu+LTrVoZDfDsbyFyLt4vZ47Ww4KAb1u7zEdmOvs67k2amMTY ve6cLh+L69BiBFe2kR5H3ahMun5yrWIhcN+QIwebfXa1xAhQQ73shvVNiuWvwRvwSD6Q 6zVp/tleQWDyV/izLJ+adS6rTrWOjmVoyodELSX2lKvJVB7juUZMrY5tUU2E7/oZi7+W 7kDtT6ad4p0dbie6niJIxY4BsZ94svbe13guxfg8uLWEwrg0Y/8bc3rlIusQ6Nc85tHi itcA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@kernel.org header.s=k20201202 header.b=f2z9gtUA; spf=pass (google.com: domain of linux-kernel+bounces-24585-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) smtp.mailfrom="linux-kernel+bounces-24585-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: from ny.mirrors.kernel.org (ny.mirrors.kernel.org. [147.75.199.223]) by mx.google.com with ESMTPS id r5-20020a0ccc05000000b0067f6e471793si2537717qvk.553.2024.01.12.02.22.58 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 12 Jan 2024 02:22:58 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-24585-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) client-ip=147.75.199.223; Authentication-Results: mx.google.com; dkim=pass header.i=@kernel.org header.s=k20201202 header.b=f2z9gtUA; spf=pass (google.com: domain of linux-kernel+bounces-24585-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) smtp.mailfrom="linux-kernel+bounces-24585-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: from smtp.subspace.kernel.org (wormhole.subspace.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ny.mirrors.kernel.org (Postfix) with ESMTPS id 0EE811C24EBF for ; Fri, 12 Jan 2024 10:22:58 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id 0E4876280A; Fri, 12 Jan 2024 10:18:02 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="f2z9gtUA" Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 404BC5D90A; Fri, 12 Jan 2024 10:17:58 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id E3262C433F1; Fri, 12 Jan 2024 10:17:54 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1705054678; bh=8t7YVZmoVUR7dCk/2nFP4SmQbrkuMwJVZH30PnGw0sc=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=f2z9gtUAWIjEDs9pfVTmI6Zy2S9KhTEAr4uRe1HUHIokgTpq4u59CeZFnN5+AkPWh CGwyaj9gjzVtULbi8P2ZnK6nNyNfgbOG+jHrd0LMn9s6rkd9QYmbuwmkYRfSYO5msU DZaPnMVoglrPX4PuMRm7leKECaoBqVAfKqpdqkowhtekw8Bibu6PQJ8b7Ha0NT7X5q yI2S+C2yYbL7pWtiGwge8L9JBeYDByEbKb8BVgQN2r3Vq+lMZtc6BqBIX9FBTXimSv ApgS1tIfuEj08EoSVUNxW3tBxXbifc73LWam6TelHgIivaByLTXrSd6uA1g6ibIkGX Dub11J9U2j5vg== From: "Masami Hiramatsu (Google)" To: Alexei Starovoitov , Steven Rostedt , Florent Revest Cc: linux-trace-kernel@vger.kernel.org, LKML , Martin KaFai Lau , bpf , Sven Schnelle , Alexei Starovoitov , Jiri Olsa , Arnaldo Carvalho de Melo , Daniel Borkmann , Alan Maguire , Mark Rutland , Peter Zijlstra , Thomas Gleixner , Guo Ren Subject: [PATCH v6 36/36] Documentation: probes: Update fprobe on function-graph tracer Date: Fri, 12 Jan 2024 19:17:52 +0900 Message-Id: <170505467231.459169.5422331995958897132.stgit@devnote2> X-Mailer: git-send-email 2.34.1 In-Reply-To: <170505424954.459169.10630626365737237288.stgit@devnote2> References: <170505424954.459169.10630626365737237288.stgit@devnote2> User-Agent: StGit/0.19 Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1787879728882069082 X-GMAIL-MSGID: 1787879728882069082 From: Masami Hiramatsu (Google) Update fprobe documentation for the new fprobe on function-graph tracer. This includes some bahvior changes and pt_regs to ftrace_regs interface change. Signed-off-by: Masami Hiramatsu (Google) --- Changes in v2: - Update @fregs parameter explanation. --- Documentation/trace/fprobe.rst | 42 ++++++++++++++++++++++++++-------------- 1 file changed, 27 insertions(+), 15 deletions(-) diff --git a/Documentation/trace/fprobe.rst b/Documentation/trace/fprobe.rst index 196f52386aaa..f58bdc64504f 100644 --- a/Documentation/trace/fprobe.rst +++ b/Documentation/trace/fprobe.rst @@ -9,9 +9,10 @@ Fprobe - Function entry/exit probe Introduction ============ -Fprobe is a function entry/exit probe mechanism based on ftrace. -Instead of using ftrace full feature, if you only want to attach callbacks -on function entry and exit, similar to the kprobes and kretprobes, you can +Fprobe is a function entry/exit probe mechanism based on the function-graph +tracer. +Instead of tracing all functions, if you want to attach callbacks on specific +function entry and exit, similar to the kprobes and kretprobes, you can use fprobe. Compared with kprobes and kretprobes, fprobe gives faster instrumentation for multiple functions with single handler. This document describes how to use fprobe. @@ -91,12 +92,14 @@ The prototype of the entry/exit callback function are as follows: .. code-block:: c - int entry_callback(struct fprobe *fp, unsigned long entry_ip, unsigned long ret_ip, struct pt_regs *regs, void *entry_data); + int entry_callback(struct fprobe *fp, unsigned long entry_ip, unsigned long ret_ip, struct ftrace_regs *fregs, void *entry_data); - void exit_callback(struct fprobe *fp, unsigned long entry_ip, unsigned long ret_ip, struct pt_regs *regs, void *entry_data); + void exit_callback(struct fprobe *fp, unsigned long entry_ip, unsigned long ret_ip, struct ftrace_regs *fregs, void *entry_data); -Note that the @entry_ip is saved at function entry and passed to exit handler. -If the entry callback function returns !0, the corresponding exit callback will be cancelled. +Note that the @entry_ip is saved at function entry and passed to exit +handler. +If the entry callback function returns !0, the corresponding exit callback +will be cancelled. @fp This is the address of `fprobe` data structure related to this handler. @@ -112,12 +115,10 @@ If the entry callback function returns !0, the corresponding exit callback will This is the return address that the traced function will return to, somewhere in the caller. This can be used at both entry and exit. -@regs - This is the `pt_regs` data structure at the entry and exit. Note that - the instruction pointer of @regs may be different from the @entry_ip - in the entry_handler. If you need traced instruction pointer, you need - to use @entry_ip. On the other hand, in the exit_handler, the instruction - pointer of @regs is set to the current return address. +@fregs + This is the `ftrace_regs` data structure at the entry and exit. This + includes the function parameters, or the return values. So user can + access thos values via appropriate `ftrace_regs_*` APIs. @entry_data This is a local storage to share the data between entry and exit handlers. @@ -125,6 +126,17 @@ If the entry callback function returns !0, the corresponding exit callback will and `entry_data_size` field when registering the fprobe, the storage is allocated and passed to both `entry_handler` and `exit_handler`. +Entry data size and exit handlers on the same function +====================================================== + +Since the entry data is passed via per-task stack and it is has limited size, +the entry data size per probe is limited to `15 * sizeof(long)`. You also need +to take care that the different fprobes are probing on the same function, this +limit becomes smaller. The entry data size is aligned to `sizeof(long)` and +each fprobe which has exit handler uses a `sizeof(long)` space on the stack, +you should keep the number of fprobes on the same function as small as +possible. + Share the callbacks with kprobes ================================ @@ -165,8 +177,8 @@ This counter counts up when; - fprobe fails to take ftrace_recursion lock. This usually means that a function which is traced by other ftrace users is called from the entry_handler. - - fprobe fails to setup the function exit because of the shortage of rethook - (the shadow stack for hooking the function return.) + - fprobe fails to setup the function exit because of failing to allocate the + data buffer from the per-task shadow stack. The `fprobe::nmissed` field counts up in both cases. Therefore, the former skips both of entry and exit callback and the latter skips the exit