From patchwork Mon Oct 30 14:47:44 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Steven Rostedt X-Patchwork-Id: 159775 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:d641:0:b0:403:3b70:6f57 with SMTP id cy1csp2271589vqb; Mon, 30 Oct 2023 07:48:19 -0700 (PDT) X-Google-Smtp-Source: AGHT+IGbx5YBhvA19g5g96HOnoEkDfzbH4grQ8XyXKzzPc1p0JrWztzk12Y0vzskoYKjU8bU6FxA X-Received: by 2002:a17:903:2445:b0:1cc:507c:edeb with SMTP id l5-20020a170903244500b001cc507cedebmr3272941pls.0.1698677299062; Mon, 30 Oct 2023 07:48:19 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1698677299; cv=none; d=google.com; s=arc-20160816; b=CccEShEEzjMJP/4u3I6BdCTbl4C/Z7fqIxbUcW+wzmCZrnFTu1NXHyNj9EGKLbq/+A W0wTf1HUZX2HB2cKPZQ6ssST22MV+J7sA0XRve+yt4WsUSIRRqo1rUS4kNFBTKkZqQk4 H4uBYDwyyuHqbajoKWGOVt187ARDkE+8MAeQd6TyR0xEPjXL+qwHqNzPpUlS+jhYp1DQ WsahDs5iDpSRFbCHE/fjHtJGiYL94EQ+xefTvjj4feBQKcLTKbOIz0V0i3605/yb9ZdC 6AqrZoHmDrM3PfGGjiIqzjQBflSKQokdqq9mPimbHDx7j8pbrb7Uo/KLptSpf5ddS8jn Otzw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :message-id:subject:cc:to:from:date; bh=3sQcCkJXlBATH9eXgKl6pSMpxus79zYC21C0IaXYNQA=; fh=zCy9ClUT3ZrgXs8J4P//YPVGGPbjO+oLKYbG79aDRMk=; b=RTaZfNwBEqAOsTwWAh2eTbzAScLigoLk+SCsg5Mc2QdoTtZ7RCKu7q3PYgL3kVE0t7 /Nw2VLCmi/Fqmdyv4ew0hYdt7I+OYwUpYNE3ammttQhl0wf/OPli8ZhiQSriK676UaYv gK1bdIbc2I4iTHMOGWFeNEOKkTjtU+zx2TXx5gQ2gSgv1LBSD6zM5ztlzNjozHXfbU4J sbcgMFpGwVNzkiGI5aldQqB0pCYc5Il8ua52LGcuTA++IIrRE/hVeei/HFziOVnVannl LthkrWNbmiuTvhznQitMJUsnceJSS1LU9UOxBpj/h92kWlVXgn4m4kuU7J4eaIDBn3jK Q5gQ== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:6 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: from pete.vger.email (pete.vger.email. [2620:137:e000::3:6]) by mx.google.com with ESMTPS id z13-20020a1709027e8d00b001c59b6ed118si5120193pla.157.2023.10.30.07.48.18 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 30 Oct 2023 07:48:19 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:6 as permitted sender) client-ip=2620:137:e000::3:6; Authentication-Results: mx.google.com; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:6 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: from out1.vger.email (depot.vger.email [IPv6:2620:137:e000::3:0]) by pete.vger.email (Postfix) with ESMTP id 27F55805DC69; Mon, 30 Oct 2023 07:48:16 -0700 (PDT) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.10 at pete.vger.email Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233371AbjJ3Orv (ORCPT + 31 others); Mon, 30 Oct 2023 10:47:51 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:44194 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231598AbjJ3Oru (ORCPT ); Mon, 30 Oct 2023 10:47:50 -0400 Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id B78C3C2 for ; Mon, 30 Oct 2023 07:47:47 -0700 (PDT) Received: by smtp.kernel.org (Postfix) with ESMTPSA id A4D22C433C7; Mon, 30 Oct 2023 14:47:46 +0000 (UTC) Date: Mon, 30 Oct 2023 10:47:44 -0400 From: Steven Rostedt To: LKML Cc: Masami Hiramatsu , Mark Rutland , Kees Cook Subject: [for-next][PATCH] seq_buf: Introduce DECLARE_SEQ_BUF and seq_buf_str() Message-ID: <20231030104744.11e776ce@gandalf.local.home> X-Mailer: Claws Mail 3.19.1 (GTK+ 2.24.33; x86_64-pc-linux-gnu) MIME-Version: 1.0 X-Spam-Status: No, score=-0.8 required=5.0 tests=HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS autolearn=unavailable autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on pete.vger.email Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (pete.vger.email [0.0.0.0]); Mon, 30 Oct 2023 07:48:16 -0700 (PDT) X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1781192247538654867 X-GMAIL-MSGID: 1781192247538654867 git://git.kernel.org/pub/scm/linux/kernel/git/trace/linux-trace.git trace/for-next Head SHA1: dcc4e5728eeaeda84878ca0018758cff1abfca21 Kees Cook (1): seq_buf: Introduce DECLARE_SEQ_BUF and seq_buf_str() ---- include/linux/seq_buf.h | 21 +++++++++++++++++---- kernel/trace/trace.c | 11 +---------- lib/seq_buf.c | 4 +--- 3 files changed, 19 insertions(+), 17 deletions(-) --------------------------- commit dcc4e5728eeaeda84878ca0018758cff1abfca21 Author: Kees Cook Date: Fri Oct 27 08:56:38 2023 -0700 seq_buf: Introduce DECLARE_SEQ_BUF and seq_buf_str() Solve two ergonomic issues with struct seq_buf; 1) Too much boilerplate is required to initialize: struct seq_buf s; char buf[32]; seq_buf_init(s, buf, sizeof(buf)); Instead, we can build this directly on the stack. Provide DECLARE_SEQ_BUF() macro to do this: DECLARE_SEQ_BUF(s, 32); 2) %NUL termination is fragile and requires 2 steps to get a valid C String (and is a layering violation exposing the "internals" of seq_buf): seq_buf_terminate(s); do_something(s->buffer); Instead, we can just return s->buffer directly after terminating it in the refactored seq_buf_terminate(), now known as seq_buf_str(): do_something(seq_buf_str(s)); Link: https://lore.kernel.org/linux-trace-kernel/20231027155634.make.260-kees@kernel.org Link: https://lore.kernel.org/linux-trace-kernel/20231026194033.it.702-kees@kernel.org/ Cc: Yosry Ahmed Cc: "Matthew Wilcox (Oracle)" Cc: Christoph Hellwig Cc: Justin Stitt Cc: Kent Overstreet Cc: Petr Mladek Cc: Andy Shevchenko Cc: Rasmus Villemoes Cc: Sergey Senozhatsky Cc: Masami Hiramatsu Cc: Greg Kroah-Hartman Cc: Arnd Bergmann Cc: Jonathan Corbet Cc: Yun Zhou Cc: Jacob Keller Cc: Zhen Lei Signed-off-by: Kees Cook Signed-off-by: Steven Rostedt (Google) diff --git a/include/linux/seq_buf.h b/include/linux/seq_buf.h index 8483e4b2d0d2..5fb1f12c33f9 100644 --- a/include/linux/seq_buf.h +++ b/include/linux/seq_buf.h @@ -21,9 +21,18 @@ struct seq_buf { size_t len; }; +#define DECLARE_SEQ_BUF(NAME, SIZE) \ + char __ ## NAME ## _buffer[SIZE] = ""; \ + struct seq_buf NAME = { \ + .buffer = &__ ## NAME ## _buffer, \ + .size = SIZE, \ + } + static inline void seq_buf_clear(struct seq_buf *s) { s->len = 0; + if (s->size) + s->buffer[0] = '\0'; } static inline void @@ -69,8 +78,8 @@ static inline unsigned int seq_buf_used(struct seq_buf *s) } /** - * seq_buf_terminate - Make sure buffer is nul terminated - * @s: the seq_buf descriptor to terminate. + * seq_buf_str - get %NUL-terminated C string from seq_buf + * @s: the seq_buf handle * * This makes sure that the buffer in @s is nul terminated and * safe to read as a string. @@ -81,16 +90,20 @@ static inline unsigned int seq_buf_used(struct seq_buf *s) * * After this function is called, s->buffer is safe to use * in string operations. + * + * Returns @s->buf after making sure it is terminated. */ -static inline void seq_buf_terminate(struct seq_buf *s) +static inline const char *seq_buf_str(struct seq_buf *s) { if (WARN_ON(s->size == 0)) - return; + return ""; if (seq_buf_buffer_left(s)) s->buffer[s->len] = 0; else s->buffer[s->size - 1] = 0; + + return s->buffer; } /** diff --git a/kernel/trace/trace.c b/kernel/trace/trace.c index d629065c2383..2539cfc20a97 100644 --- a/kernel/trace/trace.c +++ b/kernel/trace/trace.c @@ -3828,15 +3828,6 @@ static bool trace_safe_str(struct trace_iterator *iter, const char *str, return false; } -static const char *show_buffer(struct trace_seq *s) -{ - struct seq_buf *seq = &s->seq; - - seq_buf_terminate(seq); - - return seq->buffer; -} - static DEFINE_STATIC_KEY_FALSE(trace_no_verify); static int test_can_verify_check(const char *fmt, ...) @@ -3976,7 +3967,7 @@ void trace_check_vprintf(struct trace_iterator *iter, const char *fmt, */ if (WARN_ONCE(!trace_safe_str(iter, str, star, len), "fmt: '%s' current_buffer: '%s'", - fmt, show_buffer(&iter->seq))) { + fmt, seq_buf_str(&iter->seq.seq))) { int ret; /* Try to safely read the string */ diff --git a/lib/seq_buf.c b/lib/seq_buf.c index b7477aefff53..23518f77ea9c 100644 --- a/lib/seq_buf.c +++ b/lib/seq_buf.c @@ -109,9 +109,7 @@ void seq_buf_do_printk(struct seq_buf *s, const char *lvl) if (s->size == 0 || s->len == 0) return; - seq_buf_terminate(s); - - start = s->buffer; + start = seq_buf_str(s); while ((lf = strchr(start, '\n'))) { int len = lf - start + 1;