From nobody Thu Dec 18 18:02:48 2025 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 8E84612CDA5 for ; Tue, 30 Apr 2024 11:14:02 +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=1714475644; cv=none; b=tKaW8Rmic1dEbIytLEfsv6toIk/DVmpWydHWhhM1gVwetoo4/ay19vGZ+7MiBUZc5bTDpbhYrMLte9H+9FwzkZTy62GT/pvKkEswTZcPfmJehw1NgCHe6Z9uHcrhRFXBJEDg+bL7bNILP4knUwjs/qz8NfMroJn7L7he4jEo82w= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1714475644; c=relaxed/simple; bh=l6oDZivJcyQTCOy+gknzagGu6pD9fjWdRZ/T8AH6uxk=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=Asch1JNKLfNv+SN3gIpXdaJ09warx3YokagTpCV+XZmoIbXnMcAV/0/SNghzYxbkaVJZEbD451RWPEPNhHmbr9ijdrSlllsztadmGVXLo9MzNRVJFEXUxuJkeiwQNY4DAAXQMBu2kq/PRL+oCCQ7jY7el7NY5LwSVh8MhppXvrw= 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=nT+8gAA2; 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="nT+8gAA2" Received: by mail-wr1-f74.google.com with SMTP id ffacd0b85a97d-349cafdc8f0so3335795f8f.1 for ; Tue, 30 Apr 2024 04:14:02 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1714475641; x=1715080441; 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=RPOnWL9RPpAUuW6zSj0DHbUYz85VJ46LckD0gpweWUA=; b=nT+8gAA2qUrfL9l5//e+m1h2J/o7rGv6/m6hWNFVR2kVxqceQ6tUKoHdh5StxJO94A ZWwrCSMZZmS4yej8JCLUU2z/aW4RSma08IQkXRUXc5Wuanfdh+B685Qr9TMS/SCEus0e ZcQOcDyzSkfBYtuHhVu+dCjmN4VD/GbfbLhmBD2kWeD0+qY4wssFRwb6EiTPBErDdS6F GywbabcTHreEsPvy5a+UV8FVnuwYz3Ha9WQ4vrvAEH7kG4+aXFozF4yie9bgEuxZhbWo wxR9q/0krZaAECxYv/BHAPTIDq5yS9Mr+9mVUjinXt13YnbZHsGieeF0MU81g6PC+Yz7 RFMA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1714475641; x=1715080441; 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=RPOnWL9RPpAUuW6zSj0DHbUYz85VJ46LckD0gpweWUA=; b=pT0EBMIkQG2uIeYOVm8YfplzcGBgU+lro6vrm0mt8ErqA3GTo6OHBodN8piPOFEdvk 2UurcO1e+aNyoJ7dAk0thdkP7J9dF/hXkaBcBJuAbSXQwX3vpas3rhIg3gOvtfX7tpwL 7XeWfkya9xPRxFWVC8Ph4GbAZIi/m3V0Hl02VKy7pSE519oDIYvrERMP71vjnduKOBWw en1NvBKp+Nwz97W1bVOmf/cwE4iZ55MhyLXld5C+xKM3I94cQ6zsg3USK+EMB1Y8Z0a5 5z0OMmKO+h7i+B16xFELx2+JH0zv+HMpRevA21bJVPYleB1IU0E4/KnistVdDXS7D+ZC CoIg== X-Forwarded-Encrypted: i=1; AJvYcCWME+hBdsgrt2jNzkjr4xyn9kmAqg88/3h7iFPa1eV+oOdzFWAKl8PM3UlBeuk3kDiSMrtWCA83KO8PwaAvSIwfIYAT2CuOHKqqt5j7 X-Gm-Message-State: AOJu0YwBYdf0wPEhxDBo1kSIetz0KW2RUrFh+W6syvvtH/XCtk4C+Zup Prnu3XW8qujwkUyBoNJ7qw/lXBC15EvUKcM8m0jit1v3dDIBeveaXQLj7/XhQo4BGKmzRGnLtO5 +iDuUpBpegZB3V+NQMw== X-Google-Smtp-Source: AGHT+IGg0qhb/Jba6e9SYF1X563jKL0wCkSy4jPLen+t6O0bQF5/hWi5hJTj+ZQVSBTh2zkExIaXqd4WY26ybQ/A X-Received: from vdonnefort.c.googlers.com ([fda3:e722:ac3:cc00:28:9cb1:c0a8:2eea]) (user=vdonnefort job=sendgmr) by 2002:a05:6000:d46:b0:34d:a111:5021 with SMTP id du6-20020a0560000d4600b0034da1115021mr1931wrb.1.1714475640882; Tue, 30 Apr 2024 04:14:00 -0700 (PDT) Date: Tue, 30 Apr 2024 12:13:50 +0100 In-Reply-To: <20240430111354.637356-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: <20240430111354.637356-1-vdonnefort@google.com> X-Mailer: git-send-email 2.44.0.769.g3c40516874-goog Message-ID: <20240430111354.637356-2-vdonnefort@google.com> Subject: [PATCH v22 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, rdunlap@infradead.org, rppt@kernel.org, david@redhat.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 Acked-by: David Hildenbrand --- 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.769.g3c40516874-goog From nobody Thu Dec 18 18:02:48 2025 Received: from mail-yw1-f201.google.com (mail-yw1-f201.google.com [209.85.128.201]) (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 9774912D76A for ; Tue, 30 Apr 2024 11:14:04 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1714475647; cv=none; b=qKLoArW2pVnjZ09Nvod/PvNyQeaOQu+MMPx+Kku+ZVaAaUGjMK7OOZo3T5h6o9mOroU7WhvRHZ/EJ2mVKV1AyEmHtioht0Keney3HbZgqGjkxGk+FXZmp+LfFAcg1PyYYYTaOYrSq16dNDfuDsNxWP+di4Y3wv2y8IJMYn/8Db0= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1714475647; c=relaxed/simple; bh=9Gf1HB/S7wUG0GHqtbN5A/Un5dV0JbIca30VK48H7OQ=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=IqQLGrgFbifkPZzUWUQyFPc8QfVwLFF1JzIgo8ypNwZIOosbnDdB5DP1ld59GR2NC+NXnEDjIa9jzNjZ/5SiqFegC0WhPyA8PFnLaVfjB8EZNUSQHB8cCsUlN+XCF4p2hvpbfSsK/41/SJJUbvesGJeLAzNPh7KgziY+L+UypmY= 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=JekmaiVC; arc=none smtp.client-ip=209.85.128.201 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="JekmaiVC" Received: by mail-yw1-f201.google.com with SMTP id 00721157ae682-61acc68c1bdso65799097b3.1 for ; Tue, 30 Apr 2024 04:14:04 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1714475643; x=1715080443; 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=SSQdTDz3fxpyLwKZ+H82V6dCozpLG1pk05TTTXmL4go=; b=JekmaiVCHpWGV3HOF6OtyLPN4w8b5gWAhYQit9CAX2t6iWzlxNxTHdNYZKzp1W/fJp kM3XlZ4dqcpsDfWTnCdSVt3xpqKfMWox1GY9kwSHeRALsNFVzt0ce5qwLZc5nj1B/UOv MpccReFhGSGSPH3yaYMNOd1ivpeQwSokV9QPAjlD/rZ4kE/9526O3d+CJxBU5w7p8E/z iocLaIgwSbynd/omzhKTBSSN8Jev7MsOCvH5yxp6Lj2W8PbXh19ugb+sRhlhwGD3+wW/ OymCgdob8fPcOY4CFbaiOUIKonKV3WGvIQp9/sJ5D/fOgd9jeEAtb4HGM7yphJWc+yuN EwtQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1714475643; x=1715080443; 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=SSQdTDz3fxpyLwKZ+H82V6dCozpLG1pk05TTTXmL4go=; b=UiXm230GVuc2SUy4jAM6BzqZSYOaZHey02ym0GaX8uLYpdPTrmgFjMlb4fyDoDQpEs iOuD8PAWFcfdS+xMj59bS9x+MebrVR3NmYS8hdUiVRvbJcnw2uox35HEC6eoll/ApqsL wltKNDlOsQEzGiDaR+8o494BF0raUYXP7T2rzWT11TRQ15OpTNdqcULyy/YWBCv+xwEz J89zHnDpnsSAksHWLtoA4XztprXpyB+4XhjWHxvPHuN3AQgvi+Hqmmdbz2ybPpuU8Gob irqqm8l9FthFn+7r4ZA/cuymypGXQF57+edyCnYe1n0KC6YuFvXHAv39ip/CnujdufMs Gvpw== X-Forwarded-Encrypted: i=1; AJvYcCUY5DUDd7ZjvJbPAVUgGK+lqkwEiYKDoGc/9uavUQliWRLr8GeiJzRsCLUwBroUjERtLB//CMOdWKsr0vpbIysFyc3jN3BSeGZvor8y X-Gm-Message-State: AOJu0Yx1WYaWWlwb953S5P8NqryCGsZfvEUYAaCeYGJJapmmOBrgp9I7 DwSh+ksyXFraVkEtHLYNRaB3p2qYne/AKO9SmZZjSZWVpm+odk/UlXUbYlend65QYnUd1Ga2kpH ptyReTyCOMmsS+S/kkg== X-Google-Smtp-Source: AGHT+IEI68VxNWVakxnGq4gE6qTAXewGqFHFSYPNX1RA6cXedzSDwgp6GpSwURG/LWsTyt/ZAwxDwIJIy9SkLc87 X-Received: from vdonnefort.c.googlers.com ([fda3:e722:ac3:cc00:28:9cb1:c0a8:2eea]) (user=vdonnefort job=sendgmr) by 2002:a81:fe0f:0:b0:61b:ebf1:77a with SMTP id j15-20020a81fe0f000000b0061bebf1077amr242849ywn.0.1714475643635; Tue, 30 Apr 2024 04:14:03 -0700 (PDT) Date: Tue, 30 Apr 2024 12:13:51 +0100 In-Reply-To: <20240430111354.637356-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: <20240430111354.637356-1-vdonnefort@google.com> X-Mailer: git-send-email 2.44.0.769.g3c40516874-goog Message-ID: <20240430111354.637356-3-vdonnefort@google.com> Subject: [PATCH v22 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, rdunlap@infradead.org, rppt@kernel.org, david@redhat.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 Acked-by: David Hildenbrand --- 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..b682e9925539 --- /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: Internal use only. + * @Reserved2: Internal use only. + */ +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..fc66d01ff472 100644 --- a/kernel/trace/ring_buffer.c +++ b/kernel/trace/ring_buffer.c @@ -9,6 +9,7 @@ #include #include #include +#include #include #include #include @@ -26,6 +27,7 @@ #include #include #include +#include =20 #include #include @@ -338,6 +340,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 +487,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 +1608,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 +1799,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 +5219,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 +5279,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 +5496,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 +5766,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 +5990,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 +6096,370 @@ 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; + + meta->meta_page_size =3D PAGE_SIZE; + 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; +} + +/* + * +--------------+ pgoff =3D=3D 0 + * | meta page | + * +--------------+ pgoff =3D=3D 1 + * | subbuffer 0 | + * | | + * +--------------+ pgoff =3D=3D (1 + (1 << subbuf_order)) + * | subbuffer 1 | + * | | + * ... + */ +#ifdef CONFIG_MMU +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; + + /* Refuse MP_PRIVATE or writable mappings */ + if (vma->vm_flags & VM_WRITE || vma->vm_flags & VM_EXEC || + !(vma->vm_flags & VM_MAYSHARE)) + return -EPERM; + + /* + * Make sure the mapping cannot become writable later. Also tell the VM + * to not touch these pages (VM_DONTCOPY | VM_DONTEXPAND). Finally, + * prevent migration, GUP and dump (VM_IO). + */ + vm_flags_mod(vma, VM_DONTCOPY | VM_DONTEXPAND | VM_IO, VM_MAYWRITE); + + lockdep_assert_held(&cpu_buffer->mapping_lock); + + subbuf_order =3D cpu_buffer->buffer->subbuf_order; + subbuf_pages =3D 1 << subbuf_order; + + nr_subbufs =3D cpu_buffer->nr_pages + 1; /* + reader-subbuf */ + nr_pages =3D ((nr_subbufs) << subbuf_order) - pgoff + 1; /* + meta-page */ + + 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) { + pages[p++] =3D virt_to_page(cpu_buffer->meta_page); + + /* + * TODO: Align sub-buffers on their size, once + * vm_insert_pages() supports the zero-page. + */ + } else { + /* Skip the meta-page */ + pgoff--; + + if (pgoff % subbuf_pages) { + err =3D -EINVAL; + goto out; + } + + s +=3D pgoff / subbuf_pages; + } + + while (s < nr_subbufs && p < nr_pages) { + struct page *page =3D virt_to_page(cpu_buffer->subbuf_ids[s]); + int off =3D 0; + + for (; off < (1 << (subbuf_order)); off++, page++) { + if (p >=3D nr_pages) + break; + + pages[p++] =3D page; + } + s++; + } + + err =3D vm_insert_pages(vma, vma->vm_start, pages, &nr_pages); + +out: + kfree(pages); + + return err; +} +#else +static int __rb_map_vma(struct ring_buffer_per_cpu *cpu_buffer, + struct vm_area_struct *vma) +{ + return -EOPNOTSUPP; +} +#endif + +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.769.g3c40516874-goog From nobody Thu Dec 18 18:02:48 2025 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 A48C512DD9A for ; Tue, 30 Apr 2024 11:14:07 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.221.73 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1714475649; cv=none; b=c06zt193AgjPDgfpK6SGaoSKl9CJCm+6VOOjaMkIOtnMmtOe7a4ge8Z1E7nwccnDO0oqWBbzO0J8XMFhfri1Xvk6xWg2njbBFHvraXSupoOOH0/SQiPXe5sYjkoave2dTwN0eaesHcn188rqAUaWZNG3w6XevP/5cGE5xQzPxG4= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1714475649; c=relaxed/simple; bh=VhRUrMgDXvxrbFcK977T8yS4Vw+MmwCzKPPOBPrfvio=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=XpUyPkxvq+lTQGzupJ9H1iA2oB6pIyvXZXjSU0VrzP0CaxKmxafpkFIB0+sku9WaqDcsjW+mPaM3fSfpMbPdAOZbUMzDouaMi0XCx4Dfa6BJkzNTPWmXI/xvrBFCcv7O7hGbnjf6nICwQt0eYdjX6Nx+hupTqHTuR1t9ENlXvNs= 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=jtluxSM2; arc=none smtp.client-ip=209.85.221.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="jtluxSM2" Received: by mail-wr1-f73.google.com with SMTP id ffacd0b85a97d-34a49f5a6baso4829316f8f.3 for ; Tue, 30 Apr 2024 04:14:07 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1714475646; x=1715080446; 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=kaFaT9yjXtresVS5HFOg4DBcxHZeTWd1pZVR5Za+Mxc=; b=jtluxSM27UebhIJwhi94W4784Zm8BxkpnoOp7a9At82813h78MWQHftNeEPkmVBygD IJgpuLs9AQp5VRTQgjULJdhfs1gy331ivXAl52LMAnUdqhyW0r4CfyJ3Ztf+/kLwYv1m okSL0v/B7MLkNxkAwl7AD+/AzyIUg+w4aTEJKGet8e4NU/ejAdfJi86IDa73sLeMaNyM oFClzO/imrh+bSqFt2VK1uXsHRtgKbyI7xT90oV0nBXpWkek5NJJlUIp9KUiWh9ZFPBE TfSK6dSVrSRJpxNdbh4hm0N9JFak8VW3bogKitYsVArqM8EdLcVgT/+oenTc3UrdA3+v qmTg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1714475646; x=1715080446; 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=kaFaT9yjXtresVS5HFOg4DBcxHZeTWd1pZVR5Za+Mxc=; b=gc/r66cGCOOvJD4H4UwMMaQiwr3V0m0/Ns5JrBSLLDyWFNyD2UQ9bZGhbE6lCtMY0W OcRDjhtQSGZ+AyyyUvByhnzBWR6JqX7YREesvKUIzCXemKcbuhzorVWJm0WC9AfH8Hkv y5pJ3qPE4I6/Zdwp4G/BGi+YsStXXmxdZGJfK2JfhH/C+ixUaSYv6FYEbDRKhw9O6Job kkItt8Q9rLgnk2ucGFCrB+cSBGWGVziRcGayoK/wlCSzOi9pymgeWan1r+TkzihqFEZ0 j40pssMEeJnw8Qne1tOyQf5ORk3XrJ57WcmlQ34+urIlFHpwqdmSawDrmHWBmrVmWLYQ Tr2w== X-Forwarded-Encrypted: i=1; AJvYcCW/82LMvf8ggyQAzgwlSpRFJHA68jTdcCY0HIY9D1tNchsTOvBL6ZOkmbVv+0d+EXvYK9RsCXEfvlof87/n1sh90vqK3BnR679qTN9J X-Gm-Message-State: AOJu0YyXc+Cs9goNe+jDoNwrMDD7CKGZv18n6DkhIKd3Tk2XBsbr0aIx tfFrieY91OXzqLGCI+8A8iBXi26TTmbkIeHWtKoa3fd2em/ItQDsvwki5WXGH+Yo7Xzy4hOdKCm YzVFMJyuoP7vs6jganA== X-Google-Smtp-Source: AGHT+IEO2pWfjDCnEIaI11osu0vpD76LPQlxnP+vniPkBaaF4f948j34AMtRFw57ax5xp982MlQPZiRKqJXvorKB X-Received: from vdonnefort.c.googlers.com ([fda3:e722:ac3:cc00:28:9cb1:c0a8:2eea]) (user=vdonnefort job=sendgmr) by 2002:a5d:5850:0:b0:34d:17e1:7eed with SMTP id i16-20020a5d5850000000b0034d17e17eedmr22593wrf.3.1714475646019; Tue, 30 Apr 2024 04:14:06 -0700 (PDT) Date: Tue, 30 Apr 2024 12:13:52 +0100 In-Reply-To: <20240430111354.637356-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: <20240430111354.637356-1-vdonnefort@google.com> X-Mailer: git-send-email 2.44.0.769.g3c40516874-goog Message-ID: <20240430111354.637356-4-vdonnefort@google.com> Subject: [PATCH v22 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, rdunlap@infradead.org, rppt@kernel.org, david@redhat.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 b682e9925539..bd1066754220 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..a35e7f598233 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,76 @@ static long tracing_buffers_ioctl(struct file *file,= unsigned int cmd, unsigned return 0; } =20 +#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 const struct vm_operations_struct tracing_buffers_vmops =3D { + .close =3D tracing_buffers_mmap_close, +}; + +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; + + 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); + + vma->vm_ops =3D &tracing_buffers_vmops; + + return ret; +} + static const struct file_operations tracing_buffers_fops =3D { .open =3D tracing_buffers_open, .read =3D tracing_buffers_read, @@ -8223,6 +8316,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.769.g3c40516874-goog From nobody Thu Dec 18 18:02:48 2025 Received: from mail-wm1-f74.google.com (mail-wm1-f74.google.com [209.85.128.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 E0D3F12DDB3 for ; Tue, 30 Apr 2024 11:14:09 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.74 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1714475651; cv=none; b=NzNG4MJXvETNPcb6aj4RvDtaTAYgMD6u2mHvyRB4TkHhKml19SKm5dC6TbfJXeEjhqHNW1AcwItwSigt/8VusUPggS6+x4OoK2z+eBkn7gQnI/BP3MHBgKhTK3E8HI1Cwi/UuuNTF2ziHBa/oXiRkS2NVBOT/idndXivSBC77FU= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1714475651; c=relaxed/simple; bh=nHh/TTjK2tW0sUwPgbpncHpLmKF71Gsdpp0iLEYgt+E=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=DbxWo99pTEHTTH4e8pTZz8Uk7RcOJ/LkX2UCRsP6tH7jiYwzAoZ9/cr7KoT86BRhoDlGElKq431V3NklZ6IJWxxNUQpFHG2kePbBU9FnIJkuenQMKp2cLbItXf1jyMheVV2Qx95EpQ4Ds9syj6pGr/BeC86OFJa0xknHo1Z+a3E= 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=nI/VL3CY; arc=none smtp.client-ip=209.85.128.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="nI/VL3CY" Received: by mail-wm1-f74.google.com with SMTP id 5b1f17b1804b1-41c05442f92so13674615e9.2 for ; Tue, 30 Apr 2024 04:14:09 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1714475648; x=1715080448; 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=5feaOC8gyTsjpelUvOVH7lOOqHGrllvmXVDESYI+Fsc=; b=nI/VL3CYQVGuUYdqCSXzmTVQ0h7hokk9gTeENYdcLD8L/SWO+oPIwJC8uidEaRkQoI dez0xrr7vJs/c+dBR7yWH0/Jb2xbc2deJyrwLhtaglCYzWqC7F0WA/CT1yEWI6WlVb+7 2rQdTJcAM5Y0rnX8kaQVq8CYxtXcrKviOjoSd0/oaaTVoBGU+X3nR38tJtX79wRxk9HL z6KMQSOgO4yH2KKQWsV7n09W1NavoZd95WlG8N++uQAwFb+3o4IOOIf+4clE82Yl0Lhy dNbMe/FE5eCurq0oDB6YxDPLC7TfMJWqcrUbTHzrBFv5h0oroV3PVDUa81KbjIiyDl9X hPMA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1714475648; x=1715080448; 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=5feaOC8gyTsjpelUvOVH7lOOqHGrllvmXVDESYI+Fsc=; b=L2CMX0C1PPNGpLbGzEZ7lpa+8rWKS8X8GQGibVnx2mdEs2nWk2qHrO5ShuII+/MFgG paw1PaIM/Ranxgv0DQ96rLoHMdeYDQHO33dR/dP6M4wAfAbwTVyw96Zqqdco9hb8vJx8 BAJnTDxB/51l9SEhzFsURv3hKzfXUVOie94DGjXNTpIFrSYPfH4sHdvSB0rSOkF7dHV2 p6Wvk2n+K1imcWM7A4trb0l028l682ww07aQTcioAyKr6Edg1kJ5UuH6Rq5kGNzQVI0t 7PWIfPC7tKUKg8FLE434sTocOh+yLOFxOQbXewVgZOovmyUHAjWPTZ1ZxhWK4+Yi9DKo Lgxw== X-Forwarded-Encrypted: i=1; AJvYcCUG819Fjd1aPrpG1ej+ByLK+qbnLF/pkL3sHMlSLCBHKvedz3RStPjmKAQxGu2wXZUHHDK38zqnh2y8qPopXbA24OCQlWuw7EvqGaAG X-Gm-Message-State: AOJu0YxwovYqVOnAbB1+JnyjvF3xOFKS5iNcwwI2ytTes0rg44Rurh5D 8nM0gf7voCsKLN+RsNnpCN1jI/WEQLlVqHVDIymtDtGhpYhC2aS8qPCntEfi1i0tJh6740m+ZHz 1ZFvvs7RHRJjcHnYw/A== X-Google-Smtp-Source: AGHT+IHdQZNX98+CW4WPw6oiqnopgWVrn9BdwGx8dosY4zm7CCJzu00jhkxhfR15vrmF9r6Xrpm6mzzc25mlCAiT X-Received: from vdonnefort.c.googlers.com ([fda3:e722:ac3:cc00:28:9cb1:c0a8:2eea]) (user=vdonnefort job=sendgmr) by 2002:a05:600c:1d26:b0:418:37e1:3d43 with SMTP id l38-20020a05600c1d2600b0041837e13d43mr137262wms.0.1714475648416; Tue, 30 Apr 2024 04:14:08 -0700 (PDT) Date: Tue, 30 Apr 2024 12:13:53 +0100 In-Reply-To: <20240430111354.637356-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: <20240430111354.637356-1-vdonnefort@google.com> X-Mailer: git-send-email 2.44.0.769.g3c40516874-goog Message-ID: <20240430111354.637356-5-vdonnefort@google.com> Subject: [PATCH v22 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, rdunlap@infradead.org, rppt@kernel.org, david@redhat.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..8e296bcc0d7f --- /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 to as the meta-page. One of the most important +fields of the meta-page is the reader. It contains the sub-buffer ID which= can +be safely read by the mapper (see ring-buffer-design.rst). + +The meta-page is followed by all the sub-buffers, ordered by ascending 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.769.g3c40516874-goog From nobody Thu Dec 18 18:02:48 2025 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 132CF12E1DC for ; Tue, 30 Apr 2024 11:14:12 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.221.73 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1714475654; cv=none; b=E7+rF5jwCUdnXtkYOTyc/WNenCPJTNIBoXHjbcbVynLqbo18Vkp03ZBB8meQ3hh4zPDBV+kH+aHApF96nRLmBDrUiVXBdxviCan0Rk9HAYKstnadCd/ERQvwX+205orm1bnhTAGLHXhaN8T7qU4Oq/CF5Fvv6hCNcyKoXFkjdU8= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1714475654; c=relaxed/simple; bh=O+d59qShzTvBafQqHxGHCWx9WOV1oznH7Tjy6QhzJ58=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=q4B1kOjRqMUM9WLb4MPol0xxJBgDflamTeuqucyMMXGlNFDHEO0SC2gF55b4mi7zENI7obXquLN9bj3vhNbrEVdLbLShDwTwhw2+YIUP98Tr8AkGDkTHU2oIBXy2SAU6Qpugc6J1MftbZDl4aNiqaCmPdoaunpxGq+frOJR41/g= 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=XKybTU0c; arc=none smtp.client-ip=209.85.221.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="XKybTU0c" Received: by mail-wr1-f73.google.com with SMTP id ffacd0b85a97d-34dab4b61d8so45190f8f.0 for ; Tue, 30 Apr 2024 04:14:12 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1714475650; x=1715080450; 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=jZdtNgS1ADfpekPvRs2FP/KMWugpYNDTTPI4F/Zzcws=; b=XKybTU0cxPM/E8VcOhImYdcxXmGcy1fFujR7X+nfuPdnPUrvR2YSt78OnvmYwt/ti5 vdrf/KqzxzfdnkRYWD55snhEkKIMUcqY2IY67koj1KxpQ29+wmcQEF4WUWHVoq+JWXLl 7Tz7F/oF/2I6HojWhQ6r07s6M9pBrdEk2A3mEBi3SbvsnLyJ7P0aN2pZTr/s/Ys3NURL FCCjZ2PqO5i3PLMiaIP4qHYzrhn88aNwOsxwBlKQ3wgdnjFeJzdfli/yJo1zN+K9yD3M 3oKkZp2lAD5q6x1qy9+7KZzYJmpBMi00uz7yYHwbkYWOvS3GYph2qT/NQ92zqZTgnJcY sdYA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1714475650; x=1715080450; 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=jZdtNgS1ADfpekPvRs2FP/KMWugpYNDTTPI4F/Zzcws=; b=wGaLASQ2iHDrf0yT66gPnH7X7B8pTCN6FkGaVWF2MEDKZF0Umue+A/M3qWS3+J/rbw HNxX9dohcwjqlQId0eHBfzw2raWfoj52/n1k8OJRReQXVlC1yQEL9+m2ntNV2zsfOxgk MVFqBHKAPMe+n2+n9hKHdZptz1q5OSYz4K6m5vVm62jvDhlVme+/lZ9YWbuLdBd2RMQK yK5qIbGMorOIdfUCzA/daBHGF+GZ88y1LV2OM9DB0pP197SAjc0IJDv+XubqxR9PxVPY UG68csOi7RvFwkYie6RWUuXClTLT53CrVvtBkz9hWD6ssYQuFdIoVwAMZKnSfnA9PAhS B9ig== X-Forwarded-Encrypted: i=1; AJvYcCVUVXDB+5u2uNbZ9l8iHsloUAie9ue7IZS8hzWr3SUbWpyS5EvnBVUMjRF+wiTuBonLRorho6YBOk2DmY7bSFokxCojDAb3RnMHeB1N X-Gm-Message-State: AOJu0YyQkKhNx/bFiBywkSpptSdAgYxcQlid+RP2vQmV+MWFg5K8w3Yo rgEBvLgTe6KGyuQ2qpKV+MLbg4tBXVihz9rhrad6DZLrWk1JNdh5yURAyn9P+o9ex/j2dgp7IJC Kt8/+5gi0hMw0NS0Lmg== X-Google-Smtp-Source: AGHT+IEjaQoYqVbTdbjHpcIAJgUuhZa9Cbaa8gDrWXUzsTPJIAcWvjxTMvPyJ34sAGSs0Nys+0tnOp1CyXbv7JGa X-Received: from vdonnefort.c.googlers.com ([fda3:e722:ac3:cc00:28:9cb1:c0a8:2eea]) (user=vdonnefort job=sendgmr) by 2002:adf:e0c1:0:b0:34d:713a:647e with SMTP id m1-20020adfe0c1000000b0034d713a647emr4531wri.13.1714475650590; Tue, 30 Apr 2024 04:14:10 -0700 (PDT) Date: Tue, 30 Apr 2024 12:13:54 +0100 In-Reply-To: <20240430111354.637356-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: <20240430111354.637356-1-vdonnefort@google.com> X-Mailer: git-send-email 2.44.0.769.g3c40516874-goog Message-ID: <20240430111354.637356-6-vdonnefort@google.com> Subject: [PATCH v22 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, rdunlap@infradead.org, rppt@kernel.org, david@redhat.com, Vincent Donnefort , Shuah Khan , Shuah Khan , linux-kselftest@vger.kernel.org, Muhammad Usama Anjum 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 Acked-by: Muhammad Usama Anjum Signed-off-by: Vincent Donnefort diff --git a/tools/testing/selftests/ring-buffer/.gitignore b/tools/testing= /selftests/ring-buffer/.gitignore new file mode 100644 index 000000000000..3aed1a2a6c67 --- /dev/null +++ b/tools/testing/selftests/ring-buffer/.gitignore @@ -0,0 +1 @@ +map_test 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..b95eedddbb8c --- /dev/null +++ b/tools/testing/selftests/ring-buffer/map_test.c @@ -0,0 +1,288 @@ +// 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); +} + +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.769.g3c40516874-goog