From nobody Tue Feb 10 23:01:07 2026 Received: from mail-wm1-f73.google.com (mail-wm1-f73.google.com [209.85.128.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 094195C911 for ; Tue, 26 Mar 2024 10:08:39 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.73 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1711447721; cv=none; b=u6gVGr0SiJF+5ukmopCrZvF+S03LXpQwYl/hmJGSE/xdgiH9IGOfoRpMW4q8zwwBp7T2qGoSEmKC19Aqwt/X8NH6ql83sAgML68i9dQc8oE3Bhj6vD7GO4gW/Zj3MsllbEYcpHvTjR52qtyavK9c2/gzwBkGPARN2fWGmR1y7/o= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1711447721; c=relaxed/simple; bh=fmGO1bl7uIIHf3GZWx4iYgb5Kr3yiA9pjGjZZE++s/g=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=auLvFs7BZklLUCkLhmD/QoACc6y7kcl2fu20qhZONpqHhwXGg+PiSlwafJOusJ0vt2fxqmA54u4djNqZnpKyozl3if7bb2Queh7ogzyaD43Dic9rpp9EoOP/px+aGWCrnPri3CV3AgQ9owLReyfRE9TSP0QjDYl7bApMwZIbJYI= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com; spf=pass smtp.mailfrom=flex--vdonnefort.bounces.google.com; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b=Vwgx5YiM; arc=none smtp.client-ip=209.85.128.73 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 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="Vwgx5YiM" Received: by mail-wm1-f73.google.com with SMTP id 5b1f17b1804b1-4147ddecd52so18334085e9.0 for ; Tue, 26 Mar 2024 03:08:39 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1711447718; x=1712052518; 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=3D5T04RutDX7ZRsYqi7kr5/lV+ciJTNJOpTaA63uf9M=; b=Vwgx5YiM1eLpvv+eSS5uAX30MEjkWWoH+3qjVOaUjTWkANpe563IYDESNAo72hGS+M ixgEeI7Stur/gqhcYWyKQWa2vJaAFjCfEgDFbLoqIPrrTXuoY8fjM2cFppD3wIlMF3VV iHDjITuLsgTdmd5OG+NxGAjjCpg2ZgZCn68HLu2PBMicrxJ4hNOep0+DNnAhgE7QerrE IDA+LdXDV29GnrMSb8HEAaVeh6Rf6h+xcvkB7AsBK4JxIbuSLa74D9e8dG/KPUZUaDgR +dLeDHBQJo7xXdb16srOT9gWWeN8tsSSFrEJIijn8W7PWtJNFghuq2C3QbP8quKyga3d Lo1w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1711447718; x=1712052518; 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=3D5T04RutDX7ZRsYqi7kr5/lV+ciJTNJOpTaA63uf9M=; b=lhuCbNnq6gwGsfRv06ghkez2TD8xKrabU/cEeNfqMv3I158kf8Fn9+9cIMmZ89GA9H 8BWOKRarynWDtyHi4ryY3/S0oH/6bJxEKanDXudQVwh5x8UOPORaYhVDCU69EOPt6VEt wK2RU2C4wM77c3ejpHaj794YFJ5HST+H7cur+MvVpgyKAEPq4LMn9OV+n/s7042UVbWk dEXj0R75uwg/yeet1au6vMv41/EHw3xlD4l13w+hjY80ijqo31IRzBY9XEOYMSYHTSkQ fUx3MvKprJRWPxk4DhzfyYueBxfkllJ7TFriUfyjzffMvrQk7z27jbLl05g3cQhvVRFQ Jp7w== X-Forwarded-Encrypted: i=1; AJvYcCVIS/7CdpbTuRzCkya3XSZNe4Cc3FmQcIc401LPXjJZv/TuT5qnH0LjKN06Zc48wxhyOHcv+sGKyuLJUX7216YaqQ+138EI8yDcpDqp X-Gm-Message-State: AOJu0YyXCRYjgKc3fom19+YrHj5pn+OK9/aQnWMJbGq17mdwybN11pX1 lST8Enn0A46/4ROszuPt4l1DGMOiyr9Z8G/EzdskXBSI17ipym+o8KLMLW61jiPoAIghAbw+FUu CPkBrvgeAI/z0o9JB4w== X-Google-Smtp-Source: AGHT+IGmT0qe/QFYxKgVByBYm8E3je0a+ZMF/017YeJ3F3HMFUeB8IlBDeUvw5gM6vC51gp9kygoLOjDS8Vrfks3 X-Received: from vdonnefort.c.googlers.com ([fda3:e722:ac3:cc00:28:9cb1:c0a8:2eea]) (user=vdonnefort job=sendgmr) by 2002:a05:600c:1c1a:b0:413:fae6:4bac with SMTP id j26-20020a05600c1c1a00b00413fae64bacmr29535wms.2.1711447718687; Tue, 26 Mar 2024 03:08:38 -0700 (PDT) Date: Tue, 26 Mar 2024 10:08:26 +0000 In-Reply-To: <20240326100830.1326610-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: <20240326100830.1326610-1-vdonnefort@google.com> X-Mailer: git-send-email 2.44.0.396.g6e790dbe36-goog Message-ID: <20240326100830.1326610-2-vdonnefort@google.com> Subject: [PATCH v19 RESEND 1/5] ring-buffer: allocate sub-buffers with __GFP_COMP From: Vincent Donnefort To: rostedt@goodmis.org, mhiramat@kernel.org, linux-kernel@vger.kernel.org, linux-trace-kernel@vger.kernel.org Cc: mathieu.desnoyers@efficios.com, kernel-team@android.com, Vincent Donnefort Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" In preparation for the ring-buffer memory mapping, allocate compound pages for the ring-buffer sub-buffers to enable us to map them to user-space with vm_insert_pages(). Signed-off-by: Vincent Donnefort diff --git a/kernel/trace/ring_buffer.c b/kernel/trace/ring_buffer.c index 25476ead681b..cc9ebe593571 100644 --- a/kernel/trace/ring_buffer.c +++ b/kernel/trace/ring_buffer.c @@ -1524,7 +1524,7 @@ static int __rb_allocate_pages(struct ring_buffer_per= _cpu *cpu_buffer, list_add(&bpage->list, pages); =20 page =3D alloc_pages_node(cpu_to_node(cpu_buffer->cpu), - mflags | __GFP_ZERO, + mflags | __GFP_COMP | __GFP_ZERO, cpu_buffer->buffer->subbuf_order); if (!page) goto free_pages; @@ -1609,7 +1609,7 @@ rb_allocate_cpu_buffer(struct trace_buffer *buffer, l= ong nr_pages, int cpu) =20 cpu_buffer->reader_page =3D bpage; =20 - page =3D alloc_pages_node(cpu_to_node(cpu), GFP_KERNEL | __GFP_ZERO, + page =3D alloc_pages_node(cpu_to_node(cpu), GFP_KERNEL | __GFP_COMP | __G= FP_ZERO, cpu_buffer->buffer->subbuf_order); if (!page) goto fail_free_reader; @@ -5579,7 +5579,7 @@ ring_buffer_alloc_read_page(struct trace_buffer *buff= er, int cpu) goto out; =20 page =3D alloc_pages_node(cpu_to_node(cpu), - GFP_KERNEL | __GFP_NORETRY | __GFP_ZERO, + GFP_KERNEL | __GFP_NORETRY | __GFP_COMP | __GFP_ZERO, cpu_buffer->buffer->subbuf_order); if (!page) { kfree(bpage); --=20 2.44.0.396.g6e790dbe36-goog From nobody Tue Feb 10 23:01:07 2026 Received: from mail-yw1-f202.google.com (mail-yw1-f202.google.com [209.85.128.202]) (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 BB0B56773D for ; Tue, 26 Mar 2024 10:08:41 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.202 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1711447724; cv=none; b=CF/GH9YZdUMUeJZ7L3HruLQ1HdCEQ6KBI885v/uovsOo1DWaHvlVok9sycQCG52amphdm4GNeN/L5gYfWVLL0FsQQNcaQNekGsL0buln4hWEF8vLxk8S9l9+HoC9CXChR0qCA10GXLQ6+2nXQwHB5VYQ996rODJYAmQO/3YzSdA= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1711447724; c=relaxed/simple; bh=qIwgjhtk54aUI710Ai2ujKSjhNDqy/BIWhgY/6X9Anw=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=pJUc2T3AiwX+oi3NAGUqPoNWYFduf7V13YJFqdJ/zp2XrW4HVDrcc4bFeEn7H+mKEz1YF6ZP8RAReHZqSVXwVl/gPLRl10cRethDRD+EohoAwAH/MEv2gHYa46x6x23IT1HMV+5r3Jw5aU050VC3dd9aCoksZvsl6JEnouEjmT8= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com; spf=pass smtp.mailfrom=flex--vdonnefort.bounces.google.com; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b=a8d7xoOw; arc=none smtp.client-ip=209.85.128.202 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 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="a8d7xoOw" Received: by mail-yw1-f202.google.com with SMTP id 00721157ae682-60ccc3cfa39so80616817b3.2 for ; Tue, 26 Mar 2024 03:08:41 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1711447720; x=1712052520; 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=5jIMRt/32GRgE1eetSdAND17lpYq06dNuYebVWRM2Sg=; b=a8d7xoOwTs2e8UEUEejMsq38aFviJOL1zIbJxBz2M/qAk5Kycs6rYjN8pPp4YPy6pH iYBpnCCSOGYcSridcyHA5R/Z/PQHwZu8H6hL2Xj5yHhJ/GSFhaMHWweOgGAcdM4r5YXz 86bhPU0Qg6yylxCqcSy8RuxnLK1hi/RIQjq3etU5u6uHz6JoS21dn9m0C2gvNEh+93n/ 85WDCdE9uZ1WqSLx0dGm9eITSuHOmCS6MagXCm9JqlmNYYt+D9lXUbu8u/4Se0mYVZIr aOBu4JO1woWuDJi7UQPlEWBt8OVRHEYb5sljDyqtKTuccokr0BBi6OUDLLdqFXExH3hT HKqA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1711447720; x=1712052520; 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=5jIMRt/32GRgE1eetSdAND17lpYq06dNuYebVWRM2Sg=; b=vOavxa/ARW+fTpAhX3Ih08r6Dj/iq2CbDxShG087ZWmgSsK/swndAwhZwmHPKX3JZI CqGAc+I1/WYxEjVStCcT/H3lhfsfmGILJYLvoefjX3Qkk454ZpGXJjb2Jz0dwikt1gSS HMhEYwQIkZjG4bYjxSBkIf3lWH26wWtx4fEZ44xGkBQL1Uf5QrjUmhZCC0hTBKA3MJ+Z rz/Wv1Z6FpvN2WZr03Nwlr02bKKGeWTGBBC+K6Ip3OgXyjFM0d29qCUZU3WKleqR3SC+ zhhpBpdqctSvdcDkBWzil66QPkDzPAssfoxFTD2MXk7UBWnxclwIGb11aPXr6tAQyRPW s6ag== X-Forwarded-Encrypted: i=1; AJvYcCXo/U3rGLemZQzOZ3Yyi/yKpZMijzh3ab98YdW1p/uKO+IS/yXcgWd/9GwvQwJlbNKAWIxB6mXRlY+hSgJ3J+b+blxP+G5KfW4H8LDC X-Gm-Message-State: AOJu0Yx2gBJeIZI4b+fkisvGRUhmf/k0F/bmJ5JW1AQ31+cqRALjJoM8 uwqozj4wjFm63oVTVT+71FbkM/JvPcfJ00W9D68+ys9BqrXj22GWf8UkvHxMl/N7Gm18ko3Txzf IO3FyIBp6RnT2L0DrQw== X-Google-Smtp-Source: AGHT+IFwXZZ1Wx4DE4vsbszM9l2ter4BS6DmyHMqF/FJAV0QEj5Ht+N6qtgumOfrgAx7TdKMgokT0D3vnHNcXOKY X-Received: from vdonnefort.c.googlers.com ([fda3:e722:ac3:cc00:28:9cb1:c0a8:2eea]) (user=vdonnefort job=sendgmr) by 2002:a05:6902:100a:b0:dc6:ff2b:7e1b with SMTP id w10-20020a056902100a00b00dc6ff2b7e1bmr2932842ybt.4.1711447720760; Tue, 26 Mar 2024 03:08:40 -0700 (PDT) Date: Tue, 26 Mar 2024 10:08:27 +0000 In-Reply-To: <20240326100830.1326610-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: <20240326100830.1326610-1-vdonnefort@google.com> X-Mailer: git-send-email 2.44.0.396.g6e790dbe36-goog Message-ID: <20240326100830.1326610-3-vdonnefort@google.com> Subject: [PATCH v19 RESEND 2/5] ring-buffer: Introducing ring-buffer mapping functions From: Vincent Donnefort To: rostedt@goodmis.org, mhiramat@kernel.org, linux-kernel@vger.kernel.org, linux-trace-kernel@vger.kernel.org Cc: mathieu.desnoyers@efficios.com, kernel-team@android.com, Vincent Donnefort , linux-mm@kvack.org Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" In preparation for allowing the user-space to map a ring-buffer, add a set of mapping functions: ring_buffer_{map,unmap}() And controls on the ring-buffer: ring_buffer_map_get_reader() /* swap reader and head */ Mapping the ring-buffer also involves: A unique ID for each subbuf of the ring-buffer, currently they are only identified through their in-kernel VA. A meta-page, where are stored ring-buffer statistics and a description for the current reader The linear mapping exposes the meta-page, and each subbuf of the ring-buffer, ordered following their unique ID, assigned during the first mapping. Once mapped, no subbuf can get in or out of the ring-buffer: the buffer size will remain unmodified and the splice enabling functions will in reality simply memcpy the data instead of swapping subbufs. CC: Signed-off-by: Vincent Donnefort diff --git a/include/linux/ring_buffer.h b/include/linux/ring_buffer.h index dc5ae4e96aee..96d2140b471e 100644 --- a/include/linux/ring_buffer.h +++ b/include/linux/ring_buffer.h @@ -6,6 +6,8 @@ #include #include =20 +#include + struct trace_buffer; struct ring_buffer_iter; =20 @@ -223,4 +225,8 @@ int trace_rb_cpu_prepare(unsigned int cpu, struct hlist= _node *node); #define trace_rb_cpu_prepare NULL #endif =20 +int ring_buffer_map(struct trace_buffer *buffer, int cpu, + struct vm_area_struct *vma); +int ring_buffer_unmap(struct trace_buffer *buffer, int cpu); +int ring_buffer_map_get_reader(struct trace_buffer *buffer, int cpu); #endif /* _LINUX_RING_BUFFER_H */ diff --git a/include/uapi/linux/trace_mmap.h b/include/uapi/linux/trace_mma= p.h new file mode 100644 index 000000000000..ffcd8dfcaa4f --- /dev/null +++ b/include/uapi/linux/trace_mmap.h @@ -0,0 +1,46 @@ +/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ +#ifndef _TRACE_MMAP_H_ +#define _TRACE_MMAP_H_ + +#include + +/** + * struct trace_buffer_meta - Ring-buffer Meta-page description + * @meta_page_size: Size of this meta-page. + * @meta_struct_len: Size of this structure. + * @subbuf_size: Size of each sub-buffer. + * @nr_subbufs: Number of subbfs in the ring-buffer, including the reader. + * @reader.lost_events: Number of events lost at the time of the reader sw= ap. + * @reader.id: subbuf ID of the current reader. ID range [0 : @nr_subbufs= - 1] + * @reader.read: Number of bytes read on the reader subbuf. + * @flags: Placeholder for now, 0 until new features are supported. + * @entries: Number of entries in the ring-buffer. + * @overrun: Number of entries lost in the ring-buffer. + * @read: Number of entries that have been read. + * @Reserved1: Reserved for future use. + * @Reserved2: Reserved for future use. + */ +struct trace_buffer_meta { + __u32 meta_page_size; + __u32 meta_struct_len; + + __u32 subbuf_size; + __u32 nr_subbufs; + + struct { + __u64 lost_events; + __u32 id; + __u32 read; + } reader; + + __u64 flags; + + __u64 entries; + __u64 overrun; + __u64 read; + + __u64 Reserved1; + __u64 Reserved2; +}; + +#endif /* _TRACE_MMAP_H_ */ diff --git a/kernel/trace/ring_buffer.c b/kernel/trace/ring_buffer.c index cc9ebe593571..1dc932e7963c 100644 --- a/kernel/trace/ring_buffer.c +++ b/kernel/trace/ring_buffer.c @@ -9,6 +9,7 @@ #include #include #include +#include #include #include #include @@ -338,6 +339,7 @@ struct buffer_page { local_t entries; /* entries on this page */ unsigned long real_end; /* real end of data */ unsigned order; /* order of the page */ + u32 id; /* ID for external mapping */ struct buffer_data_page *page; /* Actual data page */ }; =20 @@ -484,6 +486,12 @@ struct ring_buffer_per_cpu { u64 read_stamp; /* pages removed since last reset */ unsigned long pages_removed; + + unsigned int mapped; + struct mutex mapping_lock; + unsigned long *subbuf_ids; /* ID to subbuf VA */ + struct trace_buffer_meta *meta_page; + /* ring buffer pages to update, > 0 to add, < 0 to remove */ long nr_pages_to_update; struct list_head new_pages; /* new pages to add */ @@ -1599,6 +1607,7 @@ rb_allocate_cpu_buffer(struct trace_buffer *buffer, l= ong nr_pages, int cpu) init_irq_work(&cpu_buffer->irq_work.work, rb_wake_up_waiters); init_waitqueue_head(&cpu_buffer->irq_work.waiters); init_waitqueue_head(&cpu_buffer->irq_work.full_waiters); + mutex_init(&cpu_buffer->mapping_lock); =20 bpage =3D kzalloc_node(ALIGN(sizeof(*bpage), cache_line_size()), GFP_KERNEL, cpu_to_node(cpu)); @@ -1789,8 +1798,6 @@ bool ring_buffer_time_stamp_abs(struct trace_buffer *= buffer) return buffer->time_stamp_abs; } =20 -static void rb_reset_cpu(struct ring_buffer_per_cpu *cpu_buffer); - static inline unsigned long rb_page_entries(struct buffer_page *bpage) { return local_read(&bpage->entries) & RB_WRITE_MASK; @@ -5211,6 +5218,22 @@ static void rb_clear_buffer_page(struct buffer_page = *page) page->read =3D 0; } =20 +static void rb_update_meta_page(struct ring_buffer_per_cpu *cpu_buffer) +{ + struct trace_buffer_meta *meta =3D cpu_buffer->meta_page; + + meta->reader.read =3D cpu_buffer->reader_page->read; + meta->reader.id =3D cpu_buffer->reader_page->id; + meta->reader.lost_events =3D cpu_buffer->lost_events; + + meta->entries =3D local_read(&cpu_buffer->entries); + meta->overrun =3D local_read(&cpu_buffer->overrun); + meta->read =3D cpu_buffer->read; + + /* Some archs do not have data cache coherency between kernel and user-sp= ace */ + flush_dcache_folio(virt_to_folio(cpu_buffer->meta_page)); +} + static void rb_reset_cpu(struct ring_buffer_per_cpu *cpu_buffer) { @@ -5255,6 +5278,9 @@ rb_reset_cpu(struct ring_buffer_per_cpu *cpu_buffer) cpu_buffer->lost_events =3D 0; cpu_buffer->last_overrun =3D 0; =20 + if (cpu_buffer->mapped) + rb_update_meta_page(cpu_buffer); + rb_head_page_activate(cpu_buffer); cpu_buffer->pages_removed =3D 0; } @@ -5469,6 +5495,12 @@ int ring_buffer_swap_cpu(struct trace_buffer *buffer= _a, cpu_buffer_a =3D buffer_a->buffers[cpu]; cpu_buffer_b =3D buffer_b->buffers[cpu]; =20 + /* It's up to the callers to not try to swap mapped buffers */ + if (WARN_ON_ONCE(cpu_buffer_a->mapped || cpu_buffer_b->mapped)) { + ret =3D -EBUSY; + goto out; + } + /* At least make sure the two buffers are somewhat the same */ if (cpu_buffer_a->nr_pages !=3D cpu_buffer_b->nr_pages) goto out; @@ -5733,7 +5765,8 @@ int ring_buffer_read_page(struct trace_buffer *buffer, * Otherwise, we can simply swap the page with the one passed in. */ if (read || (len < (commit - read)) || - cpu_buffer->reader_page =3D=3D cpu_buffer->commit_page) { + cpu_buffer->reader_page =3D=3D cpu_buffer->commit_page || + cpu_buffer->mapped) { struct buffer_data_page *rpage =3D cpu_buffer->reader_page->page; unsigned int rpos =3D read; unsigned int pos =3D 0; @@ -5956,6 +5989,11 @@ int ring_buffer_subbuf_order_set(struct trace_buffer= *buffer, int order) =20 cpu_buffer =3D buffer->buffers[cpu]; =20 + if (cpu_buffer->mapped) { + err =3D -EBUSY; + goto error; + } + /* Update the number of pages to match the new size */ nr_pages =3D old_size * buffer->buffers[cpu]->nr_pages; nr_pages =3D DIV_ROUND_UP(nr_pages, buffer->subbuf_size); @@ -6057,6 +6095,358 @@ int ring_buffer_subbuf_order_set(struct trace_buffe= r *buffer, int order) } EXPORT_SYMBOL_GPL(ring_buffer_subbuf_order_set); =20 +static int rb_alloc_meta_page(struct ring_buffer_per_cpu *cpu_buffer) +{ + struct page *page; + + if (cpu_buffer->meta_page) + return 0; + + page =3D alloc_page(GFP_USER | __GFP_ZERO); + if (!page) + return -ENOMEM; + + cpu_buffer->meta_page =3D page_to_virt(page); + + return 0; +} + +static void rb_free_meta_page(struct ring_buffer_per_cpu *cpu_buffer) +{ + unsigned long addr =3D (unsigned long)cpu_buffer->meta_page; + + free_page(addr); + cpu_buffer->meta_page =3D NULL; +} + +static void rb_setup_ids_meta_page(struct ring_buffer_per_cpu *cpu_buffer, + unsigned long *subbuf_ids) +{ + struct trace_buffer_meta *meta =3D cpu_buffer->meta_page; + unsigned int nr_subbufs =3D cpu_buffer->nr_pages + 1; + struct buffer_page *first_subbuf, *subbuf; + int id =3D 0; + + subbuf_ids[id] =3D (unsigned long)cpu_buffer->reader_page->page; + cpu_buffer->reader_page->id =3D id++; + + first_subbuf =3D subbuf =3D rb_set_head_page(cpu_buffer); + do { + if (WARN_ON(id >=3D nr_subbufs)) + break; + + subbuf_ids[id] =3D (unsigned long)subbuf->page; + subbuf->id =3D id; + + rb_inc_page(&subbuf); + id++; + } while (subbuf !=3D first_subbuf); + + /* install subbuf ID to kern VA translation */ + cpu_buffer->subbuf_ids =3D subbuf_ids; + + /* __rb_map_vma() pads the meta-page to align it with the sub-buffers */ + meta->meta_page_size =3D PAGE_SIZE << cpu_buffer->buffer->subbuf_order; + meta->meta_struct_len =3D sizeof(*meta); + meta->nr_subbufs =3D nr_subbufs; + meta->subbuf_size =3D cpu_buffer->buffer->subbuf_size + BUF_PAGE_HDR_SIZE; + + rb_update_meta_page(cpu_buffer); +} + +static struct ring_buffer_per_cpu * +rb_get_mapped_buffer(struct trace_buffer *buffer, int cpu) +{ + struct ring_buffer_per_cpu *cpu_buffer; + + if (!cpumask_test_cpu(cpu, buffer->cpumask)) + return ERR_PTR(-EINVAL); + + cpu_buffer =3D buffer->buffers[cpu]; + + mutex_lock(&cpu_buffer->mapping_lock); + + if (!cpu_buffer->mapped) { + mutex_unlock(&cpu_buffer->mapping_lock); + return ERR_PTR(-ENODEV); + } + + return cpu_buffer; +} + +static void rb_put_mapped_buffer(struct ring_buffer_per_cpu *cpu_buffer) +{ + mutex_unlock(&cpu_buffer->mapping_lock); +} + +/* + * Fast-path for rb_buffer_(un)map(). Called whenever the meta-page doesn'= t need + * to be set-up or torn-down. + */ +static int __rb_inc_dec_mapped(struct ring_buffer_per_cpu *cpu_buffer, + bool inc) +{ + unsigned long flags; + + lockdep_assert_held(&cpu_buffer->mapping_lock); + + if (inc && cpu_buffer->mapped =3D=3D UINT_MAX) + return -EBUSY; + + if (WARN_ON(!inc && cpu_buffer->mapped =3D=3D 0)) + return -EINVAL; + + mutex_lock(&cpu_buffer->buffer->mutex); + raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags); + + if (inc) + cpu_buffer->mapped++; + else + cpu_buffer->mapped--; + + raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags); + mutex_unlock(&cpu_buffer->buffer->mutex); + + return 0; +} + +#define subbuf_page(off, start) \ + virt_to_page((void *)((start) + ((off) << PAGE_SHIFT))) + +#define foreach_subbuf_page(sub_order, start, page) \ + page =3D subbuf_page(0, (start)); \ + for (int __off =3D 0; __off < (1 << (sub_order)); \ + __off++, page =3D subbuf_page(__off, (start))) + +/* + * +--------------+ pgoff =3D=3D 0 + * | meta page | + * +--------------+ pgoff =3D=3D 1 + * | 000000000 | + * +--------------+ pgoff =3D=3D (1 << subbuf_order) + * | subbuffer 0 | + * | | + * +--------------+ pgoff =3D=3D (2 * (1 << subbuf_order)) + * | subbuffer 1 | + * | | + * ... + */ +static int __rb_map_vma(struct ring_buffer_per_cpu *cpu_buffer, + struct vm_area_struct *vma) +{ + unsigned long nr_subbufs, nr_pages, vma_pages, pgoff =3D vma->vm_pgoff; + unsigned int subbuf_pages, subbuf_order; + struct page **pages; + int p =3D 0, s =3D 0; + int err; + + lockdep_assert_held(&cpu_buffer->mapping_lock); + + subbuf_order =3D cpu_buffer->buffer->subbuf_order; + subbuf_pages =3D 1 << subbuf_order; + + if (subbuf_order && pgoff % subbuf_pages) + return -EINVAL; + + nr_subbufs =3D cpu_buffer->nr_pages + 1; + nr_pages =3D ((nr_subbufs + 1) << subbuf_order) - pgoff; + + vma_pages =3D (vma->vm_end - vma->vm_start) >> PAGE_SHIFT; + if (!vma_pages || vma_pages > nr_pages) + return -EINVAL; + + nr_pages =3D vma_pages; + + pages =3D kcalloc(nr_pages, sizeof(*pages), GFP_KERNEL); + if (!pages) + return -ENOMEM; + + if (!pgoff) { + unsigned long meta_page_padding; + + pages[p++] =3D virt_to_page(cpu_buffer->meta_page); + + /* + * Pad with the zero-page to align the meta-page with the + * sub-buffers. + */ + meta_page_padding =3D subbuf_pages - 1; + while (meta_page_padding-- && p < nr_pages) + pages[p++] =3D ZERO_PAGE(0); + } else { + /* Skip the meta-page */ + pgoff -=3D subbuf_pages; + + s +=3D pgoff / subbuf_pages; + } + + while (s < nr_subbufs && p < nr_pages) { + struct page *page; + + foreach_subbuf_page(subbuf_order, cpu_buffer->subbuf_ids[s], page) { + if (p >=3D nr_pages) + break; + + pages[p++] =3D page; + } + s++; + } + + err =3D vm_insert_pages(vma, vma->vm_start, pages, &nr_pages); + + kfree(pages); + + return err; +} + +int ring_buffer_map(struct trace_buffer *buffer, int cpu, + struct vm_area_struct *vma) +{ + struct ring_buffer_per_cpu *cpu_buffer; + unsigned long flags, *subbuf_ids; + int err =3D 0; + + if (!cpumask_test_cpu(cpu, buffer->cpumask)) + return -EINVAL; + + cpu_buffer =3D buffer->buffers[cpu]; + + mutex_lock(&cpu_buffer->mapping_lock); + + if (cpu_buffer->mapped) { + err =3D __rb_map_vma(cpu_buffer, vma); + if (!err) + err =3D __rb_inc_dec_mapped(cpu_buffer, true); + mutex_unlock(&cpu_buffer->mapping_lock); + return err; + } + + /* prevent another thread from changing buffer/sub-buffer sizes */ + mutex_lock(&buffer->mutex); + + err =3D rb_alloc_meta_page(cpu_buffer); + if (err) + goto unlock; + + /* subbuf_ids include the reader while nr_pages does not */ + subbuf_ids =3D kcalloc(cpu_buffer->nr_pages + 1, sizeof(*subbuf_ids), GFP= _KERNEL); + if (!subbuf_ids) { + rb_free_meta_page(cpu_buffer); + err =3D -ENOMEM; + goto unlock; + } + + atomic_inc(&cpu_buffer->resize_disabled); + + /* + * Lock all readers to block any subbuf swap until the subbuf IDs are + * assigned. + */ + raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags); + rb_setup_ids_meta_page(cpu_buffer, subbuf_ids); + raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags); + + err =3D __rb_map_vma(cpu_buffer, vma); + if (!err) { + raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags); + cpu_buffer->mapped =3D 1; + raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags); + } else { + kfree(cpu_buffer->subbuf_ids); + cpu_buffer->subbuf_ids =3D NULL; + rb_free_meta_page(cpu_buffer); + } +unlock: + mutex_unlock(&buffer->mutex); + mutex_unlock(&cpu_buffer->mapping_lock); + + return err; +} + +int ring_buffer_unmap(struct trace_buffer *buffer, int cpu) +{ + struct ring_buffer_per_cpu *cpu_buffer; + unsigned long flags; + int err =3D 0; + + if (!cpumask_test_cpu(cpu, buffer->cpumask)) + return -EINVAL; + + cpu_buffer =3D buffer->buffers[cpu]; + + mutex_lock(&cpu_buffer->mapping_lock); + + if (!cpu_buffer->mapped) { + err =3D -ENODEV; + goto out; + } else if (cpu_buffer->mapped > 1) { + __rb_inc_dec_mapped(cpu_buffer, false); + goto out; + } + + mutex_lock(&buffer->mutex); + raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags); + + cpu_buffer->mapped =3D 0; + + raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags); + + kfree(cpu_buffer->subbuf_ids); + cpu_buffer->subbuf_ids =3D NULL; + rb_free_meta_page(cpu_buffer); + atomic_dec(&cpu_buffer->resize_disabled); + + mutex_unlock(&buffer->mutex); +out: + mutex_unlock(&cpu_buffer->mapping_lock); + + return err; +} + +int ring_buffer_map_get_reader(struct trace_buffer *buffer, int cpu) +{ + struct ring_buffer_per_cpu *cpu_buffer; + unsigned long reader_size; + unsigned long flags; + + cpu_buffer =3D rb_get_mapped_buffer(buffer, cpu); + if (IS_ERR(cpu_buffer)) + return (int)PTR_ERR(cpu_buffer); + + raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags); +consume: + if (rb_per_cpu_empty(cpu_buffer)) + goto out; + + reader_size =3D rb_page_size(cpu_buffer->reader_page); + + /* + * There are data to be read on the current reader page, we can + * return to the caller. But before that, we assume the latter will read + * everything. Let's update the kernel reader accordingly. + */ + if (cpu_buffer->reader_page->read < reader_size) { + while (cpu_buffer->reader_page->read < reader_size) + rb_advance_reader(cpu_buffer); + goto out; + } + + if (WARN_ON(!rb_get_reader_page(cpu_buffer))) + goto out; + + goto consume; +out: + /* Some archs do not have data cache coherency between kernel and user-sp= ace */ + flush_dcache_folio(virt_to_folio(cpu_buffer->reader_page->page)); + + rb_update_meta_page(cpu_buffer); + + raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags); + rb_put_mapped_buffer(cpu_buffer); + + return 0; +} + /* * We only allocate new buffers, never free them if the CPU goes down. * If we were to free the buffer, then the user would lose any trace that = was in --=20 2.44.0.396.g6e790dbe36-goog From nobody Tue Feb 10 23:01:07 2026 Received: from mail-yb1-f202.google.com (mail-yb1-f202.google.com [209.85.219.202]) (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 00CFF6BB54 for ; Tue, 26 Mar 2024 10:08:43 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.219.202 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1711447725; cv=none; b=kj7gXHYknqzSVmMUGc0lCZjvk+rZbG1WxyRvcAspoiliX4WYFqz+JX0Rp50cxZCWWntaHtG3HWfB//0prqg57kaWjfK2CiFvqK73UXROahCJ9oi2gh93ZE3y1dLu5WH0b9K6eu+OI339gCHbDVj9h9P4tb6F6/l+S43Bo6uH4EY= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1711447725; c=relaxed/simple; bh=ZmhpIE3l5BOVIxGJvay7l81ORxc7pkw+ha+uDBiliws=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=txQ1XXSPJKG6UP9k/bDlSVT1T4Bo4uq4HFEZM8D+KkCKLyAknpmUAJ2qaq9b/1joRokk6VtSCC+wE36jWUZYXGjdhvQBwxOqkxRDo/O26Jco2sg+5BRtE712lz+dzKyFTbVFkRQFhVD5IaKGdnd21gS6bwu1u9/q2+qSzQqMii4= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com; spf=pass smtp.mailfrom=flex--vdonnefort.bounces.google.com; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b=ilVqDPKX; arc=none smtp.client-ip=209.85.219.202 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 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="ilVqDPKX" Received: by mail-yb1-f202.google.com with SMTP id 3f1490d57ef6-dcc0bcf9256so6713644276.3 for ; Tue, 26 Mar 2024 03:08:43 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1711447723; x=1712052523; 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=OyI4CnSC0ToIvIdFLh4rwYAojfcnvHwWob+aFyszGhQ=; b=ilVqDPKXYkgYXiR6eUCCRf2ms6SCOsUCXuzUWgg/6eDBjhusiZjj5FYSagzPhdPfBF ib9FlB6Vx3TGnHBhC/zWldjU90RiUhS/nwaBcuobXUnzxAKCksQ4S1SZwy0aQqfxiXPp SG+EBrlJc0CRKINrNwtNQK6kT2mW8o8Y61iPQhlomdS7t8ilVryz4jBvRBUDR1GqvI55 z/CIpGD5Rr2zQEcpyXIRY4aDzrezE/Dd2kB7+XfDbkvhiiTG3NK5HT3iJbY8wuTuZplD F9CobEN07qaEA2UyVeEY2P3yH7TXYYv0lKndTdiDOZW8VRrkXzE7UX+soKf9Utr4W64j KI6A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1711447723; x=1712052523; 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=OyI4CnSC0ToIvIdFLh4rwYAojfcnvHwWob+aFyszGhQ=; b=oOVxEdi7c1JGTpGEdVdtmRNe/hHUf53n3q/li2AiwK7oHOGSHkQJJM9JxNV+UYO2ZE S89JaJr5aewAz90pWoy+GWeMKjXpBsDsxLL16eD4z8iUrkY97CI4hAcbH9sLV2a2C6He VyduS50mdLTminzOYuyZcf9PP9EgRbRyI4uWZBuDpRXokbpJ2upELXfWN2uP3/wOjF/c x78JaaJtkl4u6BXKMvsBX2TgsxgnPPb0DU9z+iXkr1vxtC4xNR1G1o7LIAv/XV+tLCmH q5YdO57+luif6NyN9qGAx9WN4jlAWFhGgK0UEMrqxzxebKsY0UzuaroTedkEheS9S3/Z 6B9w== X-Forwarded-Encrypted: i=1; AJvYcCXKeSg7NBE4awuvdDknHYKGbWGwI/glcBfErzUB9QriE2qZ9AhrZysOog3oPGQ44MCMrNlQKtEZ5m86i6Q/3rj9X6IW2bwM8INa/H8r X-Gm-Message-State: AOJu0YxSfomAbW6Kwsdlnu5zbRtX/dgtZtL91OTzdJZ1u6P+lglogLR5 xQ6bFkS/2jrSlvej+d0fQWZVFUMabQFQMZpLL6N1mfyB+GTFuPU65bsQFzKo+QuGBxY4JZJP1qu pZQTbVnOihb15NX4DaQ== X-Google-Smtp-Source: AGHT+IFLBQXGvzGvl+FqYKWO0kLis/bgrKgWpiHsGKVdG5tD2QW/YzExtK7Ok0IJIsNql7aDOpiZkXeABAKerp4k X-Received: from vdonnefort.c.googlers.com ([fda3:e722:ac3:cc00:28:9cb1:c0a8:2eea]) (user=vdonnefort job=sendgmr) by 2002:a05:6902:160e:b0:dda:d7cf:5c2c with SMTP id bw14-20020a056902160e00b00ddad7cf5c2cmr367269ybb.13.1711447723008; Tue, 26 Mar 2024 03:08:43 -0700 (PDT) Date: Tue, 26 Mar 2024 10:08:28 +0000 In-Reply-To: <20240326100830.1326610-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: <20240326100830.1326610-1-vdonnefort@google.com> X-Mailer: git-send-email 2.44.0.396.g6e790dbe36-goog Message-ID: <20240326100830.1326610-4-vdonnefort@google.com> Subject: [PATCH v19 RESEND 3/5] 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: mathieu.desnoyers@efficios.com, kernel-team@android.com, Vincent Donnefort , linux-mm@kvack.org Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" 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 subbuffer constituting the ring-buffer, ordered by their unique page ID: * Meta-page -- include/uapi/linux/trace_mmap.h for a description * Subbuf ID 0 * Subbuf ID 1 ... It is therefore easy to translate a subbuf ID into an offset in the mapping: reader_id =3D meta->reader->id; reader_offset =3D meta->meta_page_size + reader_id * meta->subbuf_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. Mapping will prevent snapshot and buffer size modifications. CC: Signed-off-by: Vincent Donnefort diff --git a/include/uapi/linux/trace_mmap.h b/include/uapi/linux/trace_mma= p.h index ffcd8dfcaa4f..d25b9d504a7c 100644 --- a/include/uapi/linux/trace_mmap.h +++ b/include/uapi/linux/trace_mmap.h @@ -43,4 +43,6 @@ struct trace_buffer_meta { __u64 Reserved2; }; =20 +#define TRACE_MMAP_IOCTL_GET_READER _IO('T', 0x1) + #endif /* _TRACE_MMAP_H_ */ diff --git a/kernel/trace/trace.c b/kernel/trace/trace.c index 233d1af39fff..0f37aa9860fd 100644 --- a/kernel/trace/trace.c +++ b/kernel/trace/trace.c @@ -1191,6 +1191,12 @@ static void tracing_snapshot_instance_cond(struct tr= ace_array *tr, return; } =20 + if (tr->mapped) { + trace_array_puts(tr, "*** BUFFER MEMORY MAPPED ***\n"); + trace_array_puts(tr, "*** Can not use snapshot (sorry) ***\n"); + return; + } + local_irq_save(flags); update_max_tr(tr, current, smp_processor_id(), cond_data); local_irq_restore(flags); @@ -1323,7 +1329,7 @@ static int tracing_arm_snapshot_locked(struct trace_a= rray *tr) lockdep_assert_held(&trace_types_lock); =20 spin_lock(&tr->snapshot_trigger_lock); - if (tr->snapshot =3D=3D UINT_MAX) { + if (tr->snapshot =3D=3D UINT_MAX || tr->mapped) { spin_unlock(&tr->snapshot_trigger_lock); return -EBUSY; } @@ -6068,7 +6074,7 @@ static void tracing_set_nop(struct trace_array *tr) { if (tr->current_trace =3D=3D &nop_trace) return; -=09 + tr->current_trace->enabled--; =20 if (tr->current_trace->reset) @@ -8194,15 +8200,32 @@ tracing_buffers_splice_read(struct file *file, loff= _t *ppos, return ret; } =20 -/* An ioctl call with cmd 0 to the ring buffer file will wake up all waite= rs */ static long tracing_buffers_ioctl(struct file *file, unsigned int cmd, uns= igned long arg) { struct ftrace_buffer_info *info =3D file->private_data; struct trace_iterator *iter =3D &info->iter; + int err; + + if (cmd =3D=3D TRACE_MMAP_IOCTL_GET_READER) { + if (!(file->f_flags & O_NONBLOCK)) { + err =3D ring_buffer_wait(iter->array_buffer->buffer, + iter->cpu_file, + iter->tr->buffer_percent, + NULL, NULL); + if (err) + return err; + } =20 - if (cmd) - return -ENOIOCTLCMD; + return ring_buffer_map_get_reader(iter->array_buffer->buffer, + iter->cpu_file); + } else if (cmd) { + return -ENOTTY; + } =20 + /* + * An ioctl call with cmd 0 to the ring buffer file will wake up all + * waiters + */ mutex_lock(&trace_types_lock); =20 /* Make sure the waiters see the new wait_index */ @@ -8214,6 +8237,94 @@ static long tracing_buffers_ioctl(struct file *file,= unsigned int cmd, unsigned return 0; } =20 +static vm_fault_t tracing_buffers_mmap_fault(struct vm_fault *vmf) +{ + return VM_FAULT_SIGBUS; +} + +#ifdef CONFIG_TRACER_MAX_TRACE +static int get_snapshot_map(struct trace_array *tr) +{ + int err =3D 0; + + /* + * Called with mmap_lock held. lockdep would be unhappy if we would now + * take trace_types_lock. Instead use the specific + * snapshot_trigger_lock. + */ + spin_lock(&tr->snapshot_trigger_lock); + + if (tr->snapshot || tr->mapped =3D=3D UINT_MAX) + err =3D -EBUSY; + else + tr->mapped++; + + spin_unlock(&tr->snapshot_trigger_lock); + + /* Wait for update_max_tr() to observe iter->tr->mapped */ + if (tr->mapped =3D=3D 1) + synchronize_rcu(); + + return err; + +} +static void put_snapshot_map(struct trace_array *tr) +{ + spin_lock(&tr->snapshot_trigger_lock); + if (!WARN_ON(!tr->mapped)) + tr->mapped--; + spin_unlock(&tr->snapshot_trigger_lock); +} +#else +static inline int get_snapshot_map(struct trace_array *tr) { return 0; } +static inline void put_snapshot_map(struct trace_array *tr) { } +#endif + +static void tracing_buffers_mmap_close(struct vm_area_struct *vma) +{ + struct ftrace_buffer_info *info =3D vma->vm_file->private_data; + struct trace_iterator *iter =3D &info->iter; + + WARN_ON(ring_buffer_unmap(iter->array_buffer->buffer, iter->cpu_file)); + put_snapshot_map(iter->tr); +} + +static void tracing_buffers_mmap_open(struct vm_area_struct *vma) { } + +static const struct vm_operations_struct tracing_buffers_vmops =3D { + .open =3D tracing_buffers_mmap_open, + .close =3D tracing_buffers_mmap_close, + .fault =3D tracing_buffers_mmap_fault, +}; + +static int tracing_buffers_mmap(struct file *filp, struct vm_area_struct *= vma) +{ + struct ftrace_buffer_info *info =3D filp->private_data; + struct trace_iterator *iter =3D &info->iter; + int ret =3D 0; + + if (vma->vm_flags & VM_WRITE || vma->vm_flags & VM_EXEC || + !(vma->vm_flags & VM_MAYSHARE)) + return -EPERM; + + vm_flags_mod(vma, + VM_MIXEDMAP | VM_PFNMAP | + VM_DONTCOPY | VM_DONTDUMP | VM_DONTEXPAND | VM_IO, + VM_MAYWRITE); + + vma->vm_ops =3D &tracing_buffers_vmops; + + ret =3D get_snapshot_map(iter->tr); + if (ret) + return ret; + + ret =3D ring_buffer_map(iter->array_buffer->buffer, iter->cpu_file, vma); + if (ret) + put_snapshot_map(iter->tr); + + return ret; +} + static const struct file_operations tracing_buffers_fops =3D { .open =3D tracing_buffers_open, .read =3D tracing_buffers_read, @@ -8223,6 +8334,7 @@ static const struct file_operations tracing_buffers_f= ops =3D { .splice_read =3D tracing_buffers_splice_read, .unlocked_ioctl =3D tracing_buffers_ioctl, .llseek =3D no_llseek, + .mmap =3D tracing_buffers_mmap, }; =20 static ssize_t diff --git a/kernel/trace/trace.h b/kernel/trace/trace.h index 64450615ca0c..749a182dab48 100644 --- a/kernel/trace/trace.h +++ b/kernel/trace/trace.h @@ -336,6 +336,7 @@ struct trace_array { bool allocated_snapshot; spinlock_t snapshot_trigger_lock; unsigned int snapshot; + unsigned int mapped; unsigned long max_latency; #ifdef CONFIG_FSNOTIFY struct dentry *d_max_latency; --=20 2.44.0.396.g6e790dbe36-goog From nobody Tue Feb 10 23:01:07 2026 Received: from mail-wr1-f74.google.com (mail-wr1-f74.google.com [209.85.221.74]) (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 D9A1B6BFAB for ; Tue, 26 Mar 2024 10:08:46 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.221.74 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1711447728; cv=none; b=DevMKxfd7v+K1KEdLFqardt6OR91bdZFRhJGrUz//GfD68PWJxLeA2kdsOgO9TFENOa5FJyyWRRN22Ro9fDyHzVAasjWQvYzv8yB2Ngkkm7FfZHbCELDnYHLyS56X9P/HKldK4VfiqdOxAiPPFKABeZajJsyxwt6FPfJ/OAuonE= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1711447728; c=relaxed/simple; bh=f5mervW7JwMqtuacV5u33z0c+ZkKALYygYqRjTTFdEY=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=IXQ/J7k8g7BgPHlu3YTuAj9FCoQ6IL0u/ubaLZ/XtB05khIn/98XBiTYie/onNWyFgWjshLFFFobHnhrC103JQFIyrrmIMNSbgmZ4P/60MmmgQUFnVDAEzFQE8opY7r89A0nu9ZmusGhHLkbcbg4hPdETnLEetS4g19Ji4PcK1w= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com; spf=pass smtp.mailfrom=flex--vdonnefort.bounces.google.com; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b=vXamroL6; arc=none smtp.client-ip=209.85.221.74 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 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="vXamroL6" Received: by mail-wr1-f74.google.com with SMTP id ffacd0b85a97d-33ec0700091so3240772f8f.0 for ; Tue, 26 Mar 2024 03:08:46 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1711447725; x=1712052525; 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=VyUYUDwDC6lCJYWgpyLnykCyTck5nvq4IGoYsSlman4=; b=vXamroL6RwIKXWXNOOexq29jThodgz9qTDfS67hejaYJvJQu/JMKbBB3xz8do4PqKv /iwBzwR+K6ii1Exw+v/ZuKs9+Yxhd2aMGtzjlCzUfZsTmISIaXIhtTeDwtYhMjWo03+N ZHdj1k4S47dbAkc6FQagRWy0OFM7IDb+tijpLw3MDrJT4xA7f7Zj5AGkJhUe+F6IoF9g y+fbJItp5d3fJ8Q1b/qVVB1eD+mzZFzN4rcezw18Oggnho38yMY544BwW4c8PdCRUKym jS1p9U7cQCKOPADal6b82RgS2tnjKDuIqP4PDxc6CP1RzJ4lWJ7htSgs+ETQOh6mDCRf ikrg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1711447725; x=1712052525; 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=VyUYUDwDC6lCJYWgpyLnykCyTck5nvq4IGoYsSlman4=; b=VxHQENugUIkyvVy88lAyA1GxW2qUUZayPwsw62SgVwiXR7n2yxIdR5+pMcUQdGTh6p aqWBZ+OKvwHzywugh0WoX0+eIy0U8LhgIRd/e1oHnsYtntbuMPbRDreOnJwwl5FZIhNq 72F2qrnURNcdjzqAbF3uqmTQumqaVcU1UMzdJpvjlf9Yn/Fjltdy9IEygjp7yuF3qyuz 0PtImO+HboumGi1XNU/4IVrE5A8qOpbHktB3qqMGD98IC6YSsaytwHp/QoldyZgJM6aO 8xg2WuaEKZJ3UcoWMiXndTn2zMrFv7EHxSKZtkescbCbExatQ+XMPRMH0igEuWOStCbW YRng== X-Forwarded-Encrypted: i=1; AJvYcCXzcXCC7muqn3ikk2uJNfnt5UH7eyKRYk9EOm+FZdYpMgo7wovnAIsPz9cSE7RfufA3kb0N1plw8VV+yr4ykcG9JSmYMJ47LapR0I9y X-Gm-Message-State: AOJu0YzR0uDo4DJ2TsUv4dRCyOierfFd6SHCu8rb3/p0vTzpObW2dtiq 2L8ilW8QO4I7YNiHqvJkL/VxNKY9M3B7cOXIvShvEIisdCgdMNtr4y7wOP3v/JyJmuD9nvIyREI T1Q8A0UzAgDja8Tmjng== X-Google-Smtp-Source: AGHT+IH4F70bc3bfSgn1n4pyyfvpkUtaiwpQYW99aNyBzg1QxhUTYfy+tRRygUVwy7jjeA27iC/daOaXFoSdKYRw X-Received: from vdonnefort.c.googlers.com ([fda3:e722:ac3:cc00:28:9cb1:c0a8:2eea]) (user=vdonnefort job=sendgmr) by 2002:a05:6000:dd1:b0:33d:f571:fa9 with SMTP id dw17-20020a0560000dd100b0033df5710fa9mr26100wrb.12.1711447725399; Tue, 26 Mar 2024 03:08:45 -0700 (PDT) Date: Tue, 26 Mar 2024 10:08:29 +0000 In-Reply-To: <20240326100830.1326610-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: <20240326100830.1326610-1-vdonnefort@google.com> X-Mailer: git-send-email 2.44.0.396.g6e790dbe36-goog Message-ID: <20240326100830.1326610-5-vdonnefort@google.com> Subject: [PATCH v19 RESEND 4/5] Documentation: tracing: Add ring-buffer mapping From: Vincent Donnefort To: rostedt@goodmis.org, mhiramat@kernel.org, linux-kernel@vger.kernel.org, linux-trace-kernel@vger.kernel.org Cc: mathieu.desnoyers@efficios.com, kernel-team@android.com, Vincent Donnefort Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" It is now possible to mmap() a ring-buffer to stream its content. Add some documentation and a code example. Signed-off-by: Vincent Donnefort diff --git a/Documentation/trace/index.rst b/Documentation/trace/index.rst index 5092d6c13af5..0b300901fd75 100644 --- a/Documentation/trace/index.rst +++ b/Documentation/trace/index.rst @@ -29,6 +29,7 @@ Linux Tracing Technologies timerlat-tracer intel_th ring-buffer-design + ring-buffer-map stm sys-t coresight/index diff --git a/Documentation/trace/ring-buffer-map.rst b/Documentation/trace/= ring-buffer-map.rst new file mode 100644 index 000000000000..0426ab4bcf3d --- /dev/null +++ b/Documentation/trace/ring-buffer-map.rst @@ -0,0 +1,106 @@ +.. SPDX-License-Identifier: GPL-2.0 + +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +Tracefs ring-buffer memory mapping +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +:Author: Vincent Donnefort + +Overview +=3D=3D=3D=3D=3D=3D=3D=3D +Tracefs ring-buffer memory map provides an efficient method to stream data +as no memory copy is necessary. The application mapping the ring-buffer be= comes +then a consumer for that ring-buffer, in a similar fashion to trace_pipe. + +Memory mapping setup +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +The mapping works with a mmap() of the trace_pipe_raw interface. + +The first system page of the mapping contains ring-buffer statistics and +description. It is referred as the meta-page. One of the most important fi= eld of +the meta-page is the reader. It contains the sub-buffer ID which can be sa= fely +read by the mapper (see ring-buffer-design.rst). + +The meta-page is followed by all the sub-buffers, ordered by ascendant ID.= It is +therefore effortless to know where the reader starts in the mapping: + +.. code-block:: c + + reader_id =3D meta->reader->id; + reader_offset =3D meta->meta_page_size + reader_id * meta->subbuf_= size; + +When the application is done with the current reader, it can get a new one= using +the trace_pipe_raw ioctl() TRACE_MMAP_IOCTL_GET_READER. This ioctl also up= dates +the meta-page fields. + +Limitations +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +When a mapping is in place on a Tracefs ring-buffer, it is not possible to +either resize it (either by increasing the entire size of the ring-buffer = or +each subbuf). It is also not possible to use snapshot and causes splice to= copy +the ring buffer data instead of using the copyless swap from the ring buff= er. + +Concurrent readers (either another application mapping that ring-buffer or= the +kernel with trace_pipe) are allowed but not recommended. They will compete= for +the ring-buffer and the output is unpredictable, just like concurrent read= ers on +trace_pipe would be. + +Example +=3D=3D=3D=3D=3D=3D=3D + +.. code-block:: c + + #include + #include + #include + #include + + #include + + #include + #include + + #define TRACE_PIPE_RAW "/sys/kernel/tracing/per_cpu/cpu0/trace_pip= e_raw" + + int main(void) + { + int page_size =3D getpagesize(), fd, reader_id; + unsigned long meta_len, data_len; + struct trace_buffer_meta *meta; + void *map, *reader, *data; + + fd =3D open(TRACE_PIPE_RAW, O_RDONLY | O_NONBLOCK); + if (fd < 0) + exit(EXIT_FAILURE); + + map =3D mmap(NULL, page_size, PROT_READ, MAP_SHARED, fd, 0= ); + if (map =3D=3D MAP_FAILED) + exit(EXIT_FAILURE); + + meta =3D (struct trace_buffer_meta *)map; + meta_len =3D meta->meta_page_size; + + printf("entries: %llu\n", meta->entries); + printf("overrun: %llu\n", meta->overrun); + printf("read: %llu\n", meta->read); + printf("nr_subbufs: %u\n", meta->nr_subbufs); + + data_len =3D meta->subbuf_size * meta->nr_subbufs; + data =3D mmap(NULL, data_len, PROT_READ, MAP_SHARED, fd, m= eta_len); + if (data =3D=3D MAP_FAILED) + exit(EXIT_FAILURE); + + if (ioctl(fd, TRACE_MMAP_IOCTL_GET_READER) < 0) + exit(EXIT_FAILURE); + + reader_id =3D meta->reader.id; + reader =3D data + meta->subbuf_size * reader_id; + + printf("Current reader address: %p\n", reader); + + munmap(data, data_len); + munmap(meta, meta_len); + close (fd); + + return 0; + } --=20 2.44.0.396.g6e790dbe36-goog From nobody Tue Feb 10 23:01:07 2026 Received: from mail-yw1-f202.google.com (mail-yw1-f202.google.com [209.85.128.202]) (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 B1E5E6E616 for ; Tue, 26 Mar 2024 10:08:48 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.202 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1711447730; cv=none; b=RXrLoUe6pDOQM7CtZUmtPH6xatuq8Ca/v43OHWNegOzOz7O50nMh1Sqm3VEnpc+j9pG7PhQcPZR8Yi5O7Pk5KaCjS2gCGXld8SpSQ4mPJ2nIWeYR2nHbzhE4Gjt312YBr3vI9dzKR8zOZbxO6mEChicQBMNRSZt3NbzZR0UwLn8= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1711447730; c=relaxed/simple; bh=X4fNxkqHrvNilL5EJi7n4AWaFPh2JTq2Sk7Rj6AwTU4=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=HgbDSxZvGqrJW58NNqiFEgXzhkIzFNo2MRc9UJtiDeHetCFY3pEX9DFVxYiAcPck6PV8mDghq2dEBgZ/WZI8DrVwhJrTgDXhq7HnYfmBtCjnsIDeZGpYGqAqpKdoGatKwljrZMWm5pccHgtmj62WHWhHvoXkmV2IA6XwRvXleVo= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com; spf=pass smtp.mailfrom=flex--vdonnefort.bounces.google.com; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b=BwNWZq+l; arc=none smtp.client-ip=209.85.128.202 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 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="BwNWZq+l" Received: by mail-yw1-f202.google.com with SMTP id 00721157ae682-60f9d800a29so79334537b3.0 for ; Tue, 26 Mar 2024 03:08:48 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1711447728; x=1712052528; 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=+UuIkN0zX2MQNfbCDwIEOWActo/+STrYH1ER+CouzEs=; b=BwNWZq+lqafTcisbTfYm24Jt9DBkKkLWxSXDn0plcPTVOIISUG+T1mx9HHF/gWhLQ5 6ogNovwLfKMqrKm3WAkBdiSYPg//Yztyz/CUiaTWhYNrR4Ackz1XgpiZH+Xe3qbd7rsD e+6cAfqyKVdoQ/GoiDBrKn1p1YfjTtupCiOEtH5H356g1IrQwi8fH8iZGl2MfA/Ek9aJ moBoUzPLqdJYy30rG1rmoZynhTaHKI1Lq2qZESGNuhgl6eoordKvhXCyfafbNDUTJfv0 va5+guoA1OUmZTVjZxbQpzRddPSf/QdYYKjF6uP/6nRfJSc19cK186DWOfEzcwYBE31H J6Nw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1711447728; x=1712052528; 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=+UuIkN0zX2MQNfbCDwIEOWActo/+STrYH1ER+CouzEs=; b=vi3UH2tzrRBGmtZUX5qg8+dwf59S1W6dfLWYM2sEunFcbUU4lkz6CDPp+dI0hHycgS cdCu+ofy3vbH4XkA79l3YLSArvaeiJ/gROIex2FA1P0y/uhAxxZ1u1xQw2Zvcfm8ZX82 P/U51EZUXP5A+hy73JteEm7bPZ+ub4Mvl7FJVucjKKXB6MR6KHxbUqqPqBytbDbxMKnK XjC+tkDmGW4Q21x/34GFf/X+RKHzlm4IkZfYCu6cjz7GYSHrK1GYTVgDBR2XjBKmZIrm 6bDGuQkVuamjUWeoMMCh8SBrX+CkFioQGaVDOE11wwdxBgtupD5mQr7WJN767WxZAbC9 hRgg== X-Forwarded-Encrypted: i=1; AJvYcCURWUGVu1t1WCCgI0XO+JhlRPXjs1hAU8F2iAEGxQMyMCwuTPnLGyNYo81Av0UpRPdVvpHsy129l25qo4bp/81eTUV9zbMwb8UoHALX X-Gm-Message-State: AOJu0Yx4ALYJaqru8Fjh48JTOCC7TvNcVsN+DhjkXAQ6qQoB+ibokUiy xLrYH0uWanfQnOtINQUcM05vRYhWPJYYuqetdr2EnSuOr/YkV90zULwhxeKmRJQ2fEYgUyPk1I8 7eUz7yF2F0UDzMGJzAA== X-Google-Smtp-Source: AGHT+IGphbkHhDnYiU+Le2PvvIp9ir0PpZ1EMWWjLv2MlMb8vaL3b0z6rqmehPj/QqoAX6ldVak1VKAb1goUFYCO X-Received: from vdonnefort.c.googlers.com ([fda3:e722:ac3:cc00:28:9cb1:c0a8:2eea]) (user=vdonnefort job=sendgmr) by 2002:a81:9105:0:b0:610:f5e6:375a with SMTP id i5-20020a819105000000b00610f5e6375amr1662579ywg.9.1711447727696; Tue, 26 Mar 2024 03:08:47 -0700 (PDT) Date: Tue, 26 Mar 2024 10:08:30 +0000 In-Reply-To: <20240326100830.1326610-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: <20240326100830.1326610-1-vdonnefort@google.com> X-Mailer: git-send-email 2.44.0.396.g6e790dbe36-goog Message-ID: <20240326100830.1326610-6-vdonnefort@google.com> Subject: [PATCH v19 RESEND 5/5] ring-buffer/selftest: Add ring-buffer mapping test From: Vincent Donnefort To: rostedt@goodmis.org, mhiramat@kernel.org, linux-kernel@vger.kernel.org, linux-trace-kernel@vger.kernel.org Cc: mathieu.desnoyers@efficios.com, kernel-team@android.com, Vincent Donnefort , Shuah Khan , Shuah Khan , linux-kselftest@vger.kernel.org Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" This test maps a ring-buffer and validate the meta-page after reset and after emitting few events. Cc: Shuah Khan Cc: Shuah Khan Cc: linux-kselftest@vger.kernel.org Signed-off-by: Vincent Donnefort diff --git a/tools/testing/selftests/ring-buffer/Makefile b/tools/testing/s= elftests/ring-buffer/Makefile new file mode 100644 index 000000000000..627c5fa6d1ab --- /dev/null +++ b/tools/testing/selftests/ring-buffer/Makefile @@ -0,0 +1,8 @@ +# SPDX-License-Identifier: GPL-2.0 +CFLAGS +=3D -Wl,-no-as-needed -Wall +CFLAGS +=3D $(KHDR_INCLUDES) +CFLAGS +=3D -D_GNU_SOURCE + +TEST_GEN_PROGS =3D map_test + +include ../lib.mk diff --git a/tools/testing/selftests/ring-buffer/config b/tools/testing/sel= ftests/ring-buffer/config new file mode 100644 index 000000000000..d936f8f00e78 --- /dev/null +++ b/tools/testing/selftests/ring-buffer/config @@ -0,0 +1,2 @@ +CONFIG_FTRACE=3Dy +CONFIG_TRACER_SNAPSHOT=3Dy diff --git a/tools/testing/selftests/ring-buffer/map_test.c b/tools/testing= /selftests/ring-buffer/map_test.c new file mode 100644 index 000000000000..50a09e1371d4 --- /dev/null +++ b/tools/testing/selftests/ring-buffer/map_test.c @@ -0,0 +1,302 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * Ring-buffer memory mapping tests + * + * Copyright (c) 2024 Vincent Donnefort + */ +#include +#include +#include +#include +#include +#include + +#include + +#include +#include + +#include "../user_events/user_events_selftests.h" /* share tracefs setup */ +#include "../kselftest_harness.h" + +#define TRACEFS_ROOT "/sys/kernel/tracing" + +static int __tracefs_write(const char *path, const char *value) +{ + int fd, ret; + + fd =3D open(path, O_WRONLY | O_TRUNC); + if (fd < 0) + return fd; + + ret =3D write(fd, value, strlen(value)); + + close(fd); + + return ret =3D=3D -1 ? -errno : 0; +} + +static int __tracefs_write_int(const char *path, int value) +{ + char *str; + int ret; + + if (asprintf(&str, "%d", value) < 0) + return -1; + + ret =3D __tracefs_write(path, str); + + free(str); + + return ret; +} + +#define tracefs_write_int(path, value) \ + ASSERT_EQ(__tracefs_write_int((path), (value)), 0) + +#define tracefs_write(path, value) \ + ASSERT_EQ(__tracefs_write((path), (value)), 0) + +static int tracefs_reset(void) +{ + if (__tracefs_write_int(TRACEFS_ROOT"/tracing_on", 0)) + return -1; + if (__tracefs_write(TRACEFS_ROOT"/trace", "")) + return -1; + if (__tracefs_write(TRACEFS_ROOT"/set_event", "")) + return -1; + if (__tracefs_write(TRACEFS_ROOT"/current_tracer", "nop")) + return -1; + + return 0; +} + +struct tracefs_cpu_map_desc { + struct trace_buffer_meta *meta; + int cpu_fd; +}; + +int tracefs_cpu_map(struct tracefs_cpu_map_desc *desc, int cpu) +{ + int page_size =3D getpagesize(); + char *cpu_path; + void *map; + + if (asprintf(&cpu_path, + TRACEFS_ROOT"/per_cpu/cpu%d/trace_pipe_raw", + cpu) < 0) + return -ENOMEM; + + desc->cpu_fd =3D open(cpu_path, O_RDONLY | O_NONBLOCK); + free(cpu_path); + if (desc->cpu_fd < 0) + return -ENODEV; + + map =3D mmap(NULL, page_size, PROT_READ, MAP_SHARED, desc->cpu_fd, 0); + if (map =3D=3D MAP_FAILED) + return -errno; + + desc->meta =3D (struct trace_buffer_meta *)map; + + return 0; +} + +void tracefs_cpu_unmap(struct tracefs_cpu_map_desc *desc) +{ + munmap(desc->meta, desc->meta->meta_page_size); + close(desc->cpu_fd); +} + +FIXTURE(map) { + struct tracefs_cpu_map_desc map_desc; + bool umount; +}; + +FIXTURE_VARIANT(map) { + int subbuf_size; +}; + +FIXTURE_VARIANT_ADD(map, subbuf_size_4k) { + .subbuf_size =3D 4, +}; + +FIXTURE_VARIANT_ADD(map, subbuf_size_8k) { + .subbuf_size =3D 8, +}; + +FIXTURE_SETUP(map) +{ + int cpu =3D sched_getcpu(); + cpu_set_t cpu_mask; + bool fail, umount; + char *message; + + if (!tracefs_enabled(&message, &fail, &umount)) { + if (fail) { + TH_LOG("Tracefs setup failed: %s", message); + ASSERT_FALSE(fail); + } + SKIP(return, "Skipping: %s", message); + } + + self->umount =3D umount; + + ASSERT_GE(cpu, 0); + + ASSERT_EQ(tracefs_reset(), 0); + + tracefs_write_int(TRACEFS_ROOT"/buffer_subbuf_size_kb", variant->subbuf_s= ize); + + ASSERT_EQ(tracefs_cpu_map(&self->map_desc, cpu), 0); + + /* + * Ensure generated events will be found on this very same ring-buffer. + */ + CPU_ZERO(&cpu_mask); + CPU_SET(cpu, &cpu_mask); + ASSERT_EQ(sched_setaffinity(0, sizeof(cpu_mask), &cpu_mask), 0); +} + +FIXTURE_TEARDOWN(map) +{ + tracefs_reset(); + + if (self->umount) + tracefs_unmount(); + + tracefs_cpu_unmap(&self->map_desc); +} + +TEST_F(map, meta_page_check) +{ + struct tracefs_cpu_map_desc *desc =3D &self->map_desc; + int cnt =3D 0; + + ASSERT_EQ(desc->meta->entries, 0); + ASSERT_EQ(desc->meta->overrun, 0); + ASSERT_EQ(desc->meta->read, 0); + + ASSERT_EQ(desc->meta->reader.id, 0); + ASSERT_EQ(desc->meta->reader.read, 0); + + ASSERT_EQ(ioctl(desc->cpu_fd, TRACE_MMAP_IOCTL_GET_READER), 0); + ASSERT_EQ(desc->meta->reader.id, 0); + + tracefs_write_int(TRACEFS_ROOT"/tracing_on", 1); + for (int i =3D 0; i < 16; i++) + tracefs_write_int(TRACEFS_ROOT"/trace_marker", i); +again: + ASSERT_EQ(ioctl(desc->cpu_fd, TRACE_MMAP_IOCTL_GET_READER), 0); + + ASSERT_EQ(desc->meta->entries, 16); + ASSERT_EQ(desc->meta->overrun, 0); + ASSERT_EQ(desc->meta->read, 16); + + ASSERT_EQ(desc->meta->reader.id, 1); + + if (!(cnt++)) + goto again; +} + +TEST_F(map, data_mmap) +{ + struct tracefs_cpu_map_desc *desc =3D &self->map_desc; + unsigned long meta_len, data_len; + void *data; + + meta_len =3D desc->meta->meta_page_size; + data_len =3D desc->meta->subbuf_size * desc->meta->nr_subbufs; + + /* Map all the available subbufs */ + data =3D mmap(NULL, data_len, PROT_READ, MAP_SHARED, + desc->cpu_fd, meta_len); + ASSERT_NE(data, MAP_FAILED); + munmap(data, data_len); + + /* Map all the available subbufs - 1 */ + data_len -=3D desc->meta->subbuf_size; + data =3D mmap(NULL, data_len, PROT_READ, MAP_SHARED, + desc->cpu_fd, meta_len); + ASSERT_NE(data, MAP_FAILED); + munmap(data, data_len); + + /* Overflow the available subbufs by 1 */ + meta_len +=3D desc->meta->subbuf_size * 2; + data =3D mmap(NULL, data_len, PROT_READ, MAP_SHARED, + desc->cpu_fd, meta_len); + ASSERT_EQ(data, MAP_FAILED); + + /* Verify meta-page padding */ + if (desc->meta->meta_page_size > getpagesize()) { + void *addr; + + data_len =3D desc->meta->meta_page_size; + data =3D mmap(NULL, data_len, + PROT_READ, MAP_SHARED, desc->cpu_fd, 0); + ASSERT_NE(data, MAP_FAILED); + + addr =3D (void *)((unsigned long)data + getpagesize()); + ASSERT_EQ(*((int *)addr), 0); + munmap(data, data_len); + } +} + +FIXTURE(snapshot) { + bool umount; +}; + +FIXTURE_SETUP(snapshot) +{ + bool fail, umount; + struct stat sb; + char *message; + + if (stat(TRACEFS_ROOT"/snapshot", &sb)) + SKIP(return, "Skipping: %s", "snapshot not available"); + + if (!tracefs_enabled(&message, &fail, &umount)) { + if (fail) { + TH_LOG("Tracefs setup failed: %s", message); + ASSERT_FALSE(fail); + } + SKIP(return, "Skipping: %s", message); + } + + self->umount =3D umount; +} + +FIXTURE_TEARDOWN(snapshot) +{ + __tracefs_write(TRACEFS_ROOT"/events/sched/sched_switch/trigger", + "!snapshot"); + tracefs_reset(); + + if (self->umount) + tracefs_unmount(); +} + +TEST_F(snapshot, excludes_map) +{ + struct tracefs_cpu_map_desc map_desc; + int cpu =3D sched_getcpu(); + + ASSERT_GE(cpu, 0); + tracefs_write(TRACEFS_ROOT"/events/sched/sched_switch/trigger", + "snapshot"); + ASSERT_EQ(tracefs_cpu_map(&map_desc, cpu), -EBUSY); +} + +TEST_F(snapshot, excluded_by_map) +{ + struct tracefs_cpu_map_desc map_desc; + int cpu =3D sched_getcpu(); + + ASSERT_EQ(tracefs_cpu_map(&map_desc, cpu), 0); + + ASSERT_EQ(__tracefs_write(TRACEFS_ROOT"/events/sched/sched_switch/trigger= ", + "snapshot"), -EBUSY); + ASSERT_EQ(__tracefs_write(TRACEFS_ROOT"/snapshot", + "1"), -EBUSY); +} + +TEST_HARNESS_MAIN --=20 2.44.0.396.g6e790dbe36-goog