From patchwork Mon Dec 18 15:14:51 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Vincent Donnefort X-Patchwork-Id: 180478 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7300:24d3:b0:fb:cd0c:d3e with SMTP id r19csp1313601dyi; Mon, 18 Dec 2023 07:17:15 -0800 (PST) X-Google-Smtp-Source: AGHT+IFpcz7fbohzQKol41aEo3nRfujENQSxXoFbVKSurlDX1Ld1o74BlROlkzgcIPvXeS40xIbM X-Received: by 2002:a7b:c84b:0:b0:40c:3820:efeb with SMTP id c11-20020a7bc84b000000b0040c3820efebmr8745422wml.196.1702912634935; Mon, 18 Dec 2023 07:17:14 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1702912634; cv=none; d=google.com; s=arc-20160816; b=CZUKUe0jq6oSokMvdy9gtwkQgUx36gJF2oUX+z7yEjpqCMh2WeAc6WhJGeK+KnF9am E4SRPnmPR2hy9CiVSkvlEQYEGHf95+ZOt9AJfQhgQePZHXzb2RmZ5zTnSXF0CBHEcR6Z rLgyEsVyRYRoI45L/Ud2KK030cLvFihK0q5Rl11Ld9U0Mi7GEJf25kwbve65ktSM7227 VYZC4yL+ZE8f3sXJJH2SfLqNBTat3MjH+ZWBdbIro4H/cBrWn0luPNV40ZmfWjfuGK8w EjcVI3AhEyFodDNzvHC+d1l2JTvfHhAuOxh+YA0vNXtxJcRG7Aw0tCyO2nlW1gEB6rg5 S9vg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=cc:to:from:subject:message-id:references:mime-version :list-unsubscribe:list-subscribe:list-id:precedence:in-reply-to:date :dkim-signature; bh=2cHFqrs/DsZSfDXX/TXsRzQWk2JL/c6Rao0A3y+tqak=; fh=BzJUDniL4L4xFu6YvrY/01a7DDZvz+Mdyin6gi665+Y=; b=LZQy1S4/xBycd7gvsSNgfmwY5jjKrbZmFTaRfVPkZH3hYf9sQ/wKPl7nySxFAbTI8j cD+ktcsCOrpwBjSKyEDiWYARktuA3UsiW2ulTK+S80a6XjAccSNY8Fh7vR8BFM+qlp3K YvZDu6yHUKtbhBlV0IAPzI82pAc4YIA34e7SDY1CroMcscCx8TnjBe80BROpLwKNdqVz qO+dvMnhkkW5gE0EwGFr7lHcGECisqJRvQGPJ+Qr3IHzkrJcuwZYZiDU2VztV0ge8IBa IsZbs1R6hyFT9rUO/VXd4kTi7Y5r84Oi7FCJUGYaavlYBAZkLtBPB02ova0b8zNM1ctC kVtA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@google.com header.s=20230601 header.b="QfLqC/oo"; spf=pass (google.com: domain of linux-kernel+bounces-3909-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) smtp.mailfrom="linux-kernel+bounces-3909-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=google.com Received: from am.mirrors.kernel.org (am.mirrors.kernel.org. [147.75.80.249]) by mx.google.com with ESMTPS id lf28-20020a170907175c00b00a23334f9a19si1768766ejc.277.2023.12.18.07.17.14 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 18 Dec 2023 07:17:14 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-3909-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) client-ip=147.75.80.249; Authentication-Results: mx.google.com; dkim=pass header.i=@google.com header.s=20230601 header.b="QfLqC/oo"; spf=pass (google.com: domain of linux-kernel+bounces-3909-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) smtp.mailfrom="linux-kernel+bounces-3909-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=google.com 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 am.mirrors.kernel.org (Postfix) with ESMTPS id E45A31F23527 for ; Mon, 18 Dec 2023 15:17:02 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id 6A58449896; Mon, 18 Dec 2023 15:15:09 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="QfLqC/oo" X-Original-To: linux-kernel@vger.kernel.org Received: from mail-wr1-f73.google.com (mail-wr1-f73.google.com [209.85.221.73]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 910FD4239B for ; Mon, 18 Dec 2023 15:15:04 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=flex--vdonnefort.bounces.google.com Received: by mail-wr1-f73.google.com with SMTP id ffacd0b85a97d-3334286b720so2799263f8f.1 for ; Mon, 18 Dec 2023 07:15:04 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1702912503; x=1703517303; darn=vger.kernel.org; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:from:to:cc:subject:date:message-id:reply-to; bh=2cHFqrs/DsZSfDXX/TXsRzQWk2JL/c6Rao0A3y+tqak=; b=QfLqC/ooHWvd3efRI7Ab8hrRGvvhllBRzKUbJ3JZpRHUH32NvJUuvu/je8STkAwrHF IgCxtGxsPtjKy+9Bsr4uKULyfvQbaGz4J0rQG0SsuE5DNcxr+g0uuCGHNcI2zw9kTwTp TyE84tendjMpFwI0Vs9hj86lLdHr9k34REWZPgG8xEKSySTKkoo4jkMad6W6KMMNEMUy EBuZEGKktzF0cWDN6jSNU56b7xhRaWhCtohoWX9WK4mqjp73pODwEeUEGudrlkOjJRRB 882EE26q/2kJ+1zSC1OXUtpx9Izzbul0NP4FoHCvPn5MbIzWTU/E8tg30pTChZamRS9g Ucbg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1702912503; x=1703517303; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=2cHFqrs/DsZSfDXX/TXsRzQWk2JL/c6Rao0A3y+tqak=; b=NT1B7+rjdRAs+xnf9RBiGNw7q/XLgQVKDWpjQ+bPWHso/pmrr/vs8BiKjtgv4ENifl LEjjof1JewEOQID2eFbGhaKahpkmE0K2Oevic8IymhMIMGnMOl5OYnrJDHwJZymeSbhf ig7eTC5N+DRa5752Xd/djmsp8MIjwd4FKmXjBCamnwPI0Hgg7RCNf6dact1ZNDS8vGUy rP6X7HcvOd/aDt6XnUjJyXrDWZcVihMyv4evmdirRHu+WNq8yqhjFaRIwyBxT5n+F7a9 Ro/nclBOV+RChoN7CBppXB0QPXyjCDLin4Oe+PwmHTK4HKN6UJk3DW/jP/EuS5L1ghT6 ge8w== X-Gm-Message-State: AOJu0YwMhhSR83fD2j+DG1aL/G0p/kmZjmlcwPxRxgGzOOUJVUqO0neb A1MTw2yQ2Zv7cwtWVd5KQ0bSZkY2Cjmy32YH X-Received: from vdonnefort.c.googlers.com ([fda3:e722:ac3:cc00:28:9cb1:c0a8:2eea]) (user=vdonnefort job=sendgmr) by 2002:a5d:6c6f:0:b0:333:3c3f:a496 with SMTP id r15-20020a5d6c6f000000b003333c3fa496mr83919wrz.14.1702912502553; Mon, 18 Dec 2023 07:15:02 -0800 (PST) Date: Mon, 18 Dec 2023 15:14:51 +0000 In-Reply-To: <20231218151451.944907-1-vdonnefort@google.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: Mime-Version: 1.0 References: <20231218151451.944907-1-vdonnefort@google.com> X-Mailer: git-send-email 2.43.0.472.g3155946c3a-goog Message-ID: <20231218151451.944907-3-vdonnefort@google.com> Subject: [PATCH v7 2/2] tracing: Allow user-space mapping of the ring-buffer From: Vincent Donnefort To: rostedt@goodmis.org, mhiramat@kernel.org, linux-kernel@vger.kernel.org, linux-trace-kernel@vger.kernel.org Cc: kernel-team@android.com, Vincent Donnefort X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1785633319472540050 X-GMAIL-MSGID: 1785633319472540050 Currently, user-space extracts data from the ring-buffer via splice, which is handy for storage or network sharing. However, due to splice limitations, it is imposible to do real-time analysis without a copy. A solution for that problem is to let the user-space map the ring-buffer directly. The mapping is exposed via the per-CPU file trace_pipe_raw. The first element of the mapping is the meta-page. It is followed by each bpage constituting the ring-buffer, ordered by their unique page ID: * Meta-page -- include/uapi/linux/trace_mmap.h for a description * buffer-page ID 0 * buffer-page ID 1 ... It is therefore easy to translate a buffer page ID into an offset in the mapping: reader_id = meta->reader->id; reader_offset = meta->meta_page_size + reader_id * meta->bpage_size; When new data is available, the mapper must call a newly introduced ioctl: TRACE_MMAP_IOCTL_GET_READER. This will update the Meta-page reader ID to point to the next reader containing unread data. Signed-off-by: Vincent Donnefort diff --git a/include/uapi/linux/trace_mmap.h b/include/uapi/linux/trace_mmap.h index 9536f0b7c094..e44563cf5ede 100644 --- a/include/uapi/linux/trace_mmap.h +++ b/include/uapi/linux/trace_mmap.h @@ -26,4 +26,6 @@ struct trace_buffer_meta { __u32 meta_struct_len; /* Len of this struct */ }; +#define TRACE_MMAP_IOCTL_GET_READER _IO('T', 0x1) + #endif /* _UAPI_TRACE_MMAP_H_ */ diff --git a/kernel/trace/trace.c b/kernel/trace/trace.c index c17dd849e6f1..0a4927e56315 100644 --- a/kernel/trace/trace.c +++ b/kernel/trace/trace.c @@ -8590,15 +8590,31 @@ tracing_buffers_splice_read(struct file *file, loff_t *ppos, return ret; } -/* An ioctl call with cmd 0 to the ring buffer file will wake up all waiters */ static long tracing_buffers_ioctl(struct file *file, unsigned int cmd, unsigned long arg) { struct ftrace_buffer_info *info = file->private_data; struct trace_iterator *iter = &info->iter; + int err; - if (cmd) - return -ENOIOCTLCMD; + if (cmd == TRACE_MMAP_IOCTL_GET_READER) { + if (!(file->f_flags & O_NONBLOCK)) { + err = ring_buffer_wait(iter->array_buffer->buffer, + iter->cpu_file, + iter->tr->buffer_percent); + if (err) + return err; + } + return ring_buffer_map_get_reader(iter->array_buffer->buffer, + iter->cpu_file); + } else if (cmd) { + return -ENOTTY; + } + + /* + * An ioctl call with cmd 0 to the ring buffer file will wake up all + * waiters + */ mutex_lock(&trace_types_lock); iter->wait_index++; @@ -8611,6 +8627,62 @@ static long tracing_buffers_ioctl(struct file *file, unsigned int cmd, unsigned return 0; } +static vm_fault_t tracing_buffers_mmap_fault(struct vm_fault *vmf) +{ + struct ftrace_buffer_info *info = vmf->vma->vm_file->private_data; + struct trace_iterator *iter = &info->iter; + vm_fault_t ret = VM_FAULT_SIGBUS; + struct page *page; + + page = ring_buffer_map_fault(iter->array_buffer->buffer, iter->cpu_file, + vmf->pgoff); + if (!page) + return ret; + + get_page(page); + vmf->page = page; + vmf->page->mapping = vmf->vma->vm_file->f_mapping; + vmf->page->index = vmf->pgoff; + + return 0; +} + +static void tracing_buffers_mmap_close(struct vm_area_struct *vma) +{ + struct ftrace_buffer_info *info = vma->vm_file->private_data; + struct trace_iterator *iter = &info->iter; + + ring_buffer_unmap(iter->array_buffer->buffer, iter->cpu_file); +} + +static void tracing_buffers_mmap_open(struct vm_area_struct *vma) +{ + struct ftrace_buffer_info *info = vma->vm_file->private_data; + struct trace_iterator *iter = &info->iter; + + WARN_ON(ring_buffer_map(iter->array_buffer->buffer, iter->cpu_file)); +} + +static const struct vm_operations_struct tracing_buffers_vmops = { + .open = tracing_buffers_mmap_open, + .close = tracing_buffers_mmap_close, + .fault = tracing_buffers_mmap_fault, +}; + +static int tracing_buffers_mmap(struct file *filp, struct vm_area_struct *vma) +{ + struct ftrace_buffer_info *info = filp->private_data; + struct trace_iterator *iter = &info->iter; + + if (vma->vm_flags & VM_WRITE) + return -EPERM; + + vm_flags_mod(vma, VM_DONTCOPY | VM_DONTDUMP, VM_MAYWRITE); + vma->vm_ops = &tracing_buffers_vmops; + + return ring_buffer_map(iter->array_buffer->buffer, iter->cpu_file); +} + static const struct file_operations tracing_buffers_fops = { .open = tracing_buffers_open, .read = tracing_buffers_read, @@ -8619,6 +8691,7 @@ static const struct file_operations tracing_buffers_fops = { .splice_read = tracing_buffers_splice_read, .unlocked_ioctl = tracing_buffers_ioctl, .llseek = no_llseek, + .mmap = tracing_buffers_mmap, }; static ssize_t