Received: by 2002:a25:4158:0:0:0:0:0 with SMTP id o85csp6602825yba; Wed, 1 May 2019 16:04:34 -0700 (PDT) X-Google-Smtp-Source: APXvYqymJUsR/MpX++u+c6FxJHGv9mVlETitBpKZOZ3u31pfiy1ozh6NdugXxAp01V9G7xDDviPP X-Received: by 2002:a62:480d:: with SMTP id v13mr548330pfa.125.1556751874734; Wed, 01 May 2019 16:04:34 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1556751874; cv=none; d=google.com; s=arc-20160816; b=p12iYRd9JzzQRCIppTOnRnEv1uq2h2eNrQWUCzC1sxxnxAcFRFKo9+mdA68Ft7WekI SyXyg+UQ6HcShufFaF3jUPPKNzZjYLCRnqk5oeUYhrdZUMRh+Jey5gNtvsvlDvcmx3Uk Itqa81MwhFkwHawKD0EXXZ0AnkNR1wBjQCpAWQqKzJ1On1N3fz6wVAlsvitCa72eDJhd 1CK+ZatjedLq01v+Y4OXBeTrSh1JGTfba4Gd6wLslNKAu22+eoVU8fVYDF5rQpgd7P9k HTZBnm5tEbK7iaGwQKCUZFuAXFPBmH0HQiu2Qc/5fmJPiZVYJrRiUqueYLDn0fFEyTFu zvzg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:cc:to:from:subject:references :mime-version:message-id:in-reply-to:date:dkim-signature; bh=IzqxQT7jsHC3pdKh/vHgviJNyBbjnFac75RkNa3+hdY=; b=bSBOFCEJjM9MIQE5yDeXacMZiNMFfyjMtKrqrRTDPit9G0dhV06DSsXVQDfi36Z4Uh dskvcHLcsCpjNqjbDqShwhu4rJVBBZmShY+lBNJOAVZ5dYqbhDUMsMoQDMmbV4uZK3H6 MEdJZKGAz8kcpSnWAAaUukQsw5OE6+MIED+IKgmDMTLocuQymc6e2Z3gux7GaGc0hSOV 3L15X11LhZMce4r3v6mDG558G3q+9sVntqlitzJpGMMtVmHBaukN03kMLgC3CzWu3qc8 jevIM4AZw7gxkC9s/ceKOJhsdsmDG3dtjSOsbKtIXIahk3jax8Z1hlgcSgdXfBtgj2TD L0jQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@google.com header.s=20161025 header.b=sGJCDhDH; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=google.com Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id s1si14252295pgj.114.2019.05.01.16.04.19; Wed, 01 May 2019 16:04:34 -0700 (PDT) Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Authentication-Results: mx.google.com; dkim=pass header.i=@google.com header.s=20161025 header.b=sGJCDhDH; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=google.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726320AbfEAXDL (ORCPT + 99 others); Wed, 1 May 2019 19:03:11 -0400 Received: from mail-qt1-f202.google.com ([209.85.160.202]:33720 "EHLO mail-qt1-f202.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726310AbfEAXDK (ORCPT ); Wed, 1 May 2019 19:03:10 -0400 Received: by mail-qt1-f202.google.com with SMTP id n39so375365qtn.0 for ; Wed, 01 May 2019 16:03:09 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20161025; h=date:in-reply-to:message-id:mime-version:references:subject:from:to :cc; bh=IzqxQT7jsHC3pdKh/vHgviJNyBbjnFac75RkNa3+hdY=; b=sGJCDhDHzL4+6Xf33NRGdp9J2J2NKagWonrzxFNvxH4esajJdCH1lvWkC+VnYAmoSF F4/6LUSKaWS2597garPIIpQcaFBdzCYRb2fubnUHTmTL1TvdqZMU+AIVRmHyNWsCcgTn zffbgvX2sF+RH6Ci73pr9KOouIRw/b4cQAngonJdX/gI0FDqvbsR9ltQtQxdqCzCqv3a 6OcK1IhALgX7ycvXl93cjEgyGu2i7cMu/nN1dE9w8Ji78YjA0zdrOKtLIxRWf1tGjjnm kkqmaTuZzpQeatG6lNwMGgt01UlLDADWIJay+toOzCYKwPgJu7kYIONbV19QDSHOXTxu 0P2Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:in-reply-to:message-id:mime-version :references:subject:from:to:cc; bh=IzqxQT7jsHC3pdKh/vHgviJNyBbjnFac75RkNa3+hdY=; b=fAHxIQg2bKWSg8JCIvHKWj01QXAuep1mqy4CV9ds23ba/9RxHWc4wmlAoP+gR3ItA5 8/bKHetpuWJ5uQYVZplaWm4qHmS2TPmt25WrIknmazEoe/Ae8OwqbFCgbmYHYrmVmsVU /B5/PHmd5HkZfPFYqqmqhJs+FO5xhSgVT1AhtiaHQHru2TjahcR4akSqGtBtFXLplIkB 3NSXWI7t2ha57DCEOO1Iq9Fzg2VTxuiEviXdM38Z7sCTDalUOu9ichVsxMmAfRDoCEPw Dcx5bce1m56h0VxL9DttFMx+/7KiDdatx/ZWT0DQh+iZ+86Wa8XOhgxreZ00N4Gp5E/T sNzA== X-Gm-Message-State: APjAAAVCmQFlnID65RgsPMNVo3W5Kg43D6iWvUkTGy8Gj8KkIw07HEnn Eb04QL4wVUvpypcmsJPzFsxvZUSKd3fm6c4nwnV8AA== X-Received: by 2002:a0c:96eb:: with SMTP id b40mr633284qvd.131.1556751789360; Wed, 01 May 2019 16:03:09 -0700 (PDT) Date: Wed, 1 May 2019 16:01:12 -0700 In-Reply-To: <20190501230126.229218-1-brendanhiggins@google.com> Message-Id: <20190501230126.229218-4-brendanhiggins@google.com> Mime-Version: 1.0 References: <20190501230126.229218-1-brendanhiggins@google.com> X-Mailer: git-send-email 2.21.0.593.g511ec345e18-goog Subject: [PATCH v2 03/17] kunit: test: add string_stream a std::stream like string builder From: Brendan Higgins To: frowand.list@gmail.com, gregkh@linuxfoundation.org, keescook@google.com, kieran.bingham@ideasonboard.com, mcgrof@kernel.org, robh@kernel.org, sboyd@kernel.org, shuah@kernel.org Cc: devicetree@vger.kernel.org, dri-devel@lists.freedesktop.org, kunit-dev@googlegroups.com, linux-doc@vger.kernel.org, linux-fsdevel@vger.kernel.org, linux-kbuild@vger.kernel.org, linux-kernel@vger.kernel.org, linux-kselftest@vger.kernel.org, linux-nvdimm@lists.01.org, linux-um@lists.infradead.org, Alexander.Levin@microsoft.com, Tim.Bird@sony.com, amir73il@gmail.com, dan.carpenter@oracle.com, dan.j.williams@intel.com, daniel@ffwll.ch, jdike@addtoit.com, joel@jms.id.au, julia.lawall@lip6.fr, khilman@baylibre.com, knut.omang@oracle.com, logang@deltatee.com, mpe@ellerman.id.au, pmladek@suse.com, richard@nod.at, rientjes@google.com, rostedt@goodmis.org, wfg@linux.intel.com, Brendan Higgins Content-Type: text/plain; charset="UTF-8" Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org A number of test features need to do pretty complicated string printing where it may not be possible to rely on a single preallocated string with parameters. So provide a library for constructing the string as you go similar to C++'s std::string. Signed-off-by: Brendan Higgins --- include/kunit/string-stream.h | 51 ++++++++++++ kunit/Makefile | 3 +- kunit/string-stream.c | 144 ++++++++++++++++++++++++++++++++++ 3 files changed, 197 insertions(+), 1 deletion(-) create mode 100644 include/kunit/string-stream.h create mode 100644 kunit/string-stream.c diff --git a/include/kunit/string-stream.h b/include/kunit/string-stream.h new file mode 100644 index 0000000000000..567a4629406da --- /dev/null +++ b/include/kunit/string-stream.h @@ -0,0 +1,51 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/* + * C++ stream style string builder used in KUnit for building messages. + * + * Copyright (C) 2019, Google LLC. + * Author: Brendan Higgins + */ + +#ifndef _KUNIT_STRING_STREAM_H +#define _KUNIT_STRING_STREAM_H + +#include +#include +#include +#include + +struct string_stream_fragment { + struct list_head node; + char *fragment; +}; + +struct string_stream { + size_t length; + struct list_head fragments; + + /* length and fragments are protected by this lock */ + spinlock_t lock; + struct kref refcount; +}; + +struct string_stream *new_string_stream(void); + +void destroy_string_stream(struct string_stream *stream); + +void string_stream_get(struct string_stream *stream); + +int string_stream_put(struct string_stream *stream); + +int string_stream_add(struct string_stream *this, const char *fmt, ...); + +int string_stream_vadd(struct string_stream *this, + const char *fmt, + va_list args); + +char *string_stream_get_string(struct string_stream *this); + +void string_stream_clear(struct string_stream *this); + +bool string_stream_is_empty(struct string_stream *this); + +#endif /* _KUNIT_STRING_STREAM_H */ diff --git a/kunit/Makefile b/kunit/Makefile index 5efdc4dea2c08..275b565a0e81f 100644 --- a/kunit/Makefile +++ b/kunit/Makefile @@ -1 +1,2 @@ -obj-$(CONFIG_KUNIT) += test.o +obj-$(CONFIG_KUNIT) += test.o \ + string-stream.o diff --git a/kunit/string-stream.c b/kunit/string-stream.c new file mode 100644 index 0000000000000..7018194ecf2fa --- /dev/null +++ b/kunit/string-stream.c @@ -0,0 +1,144 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * C++ stream style string builder used in KUnit for building messages. + * + * Copyright (C) 2019, Google LLC. + * Author: Brendan Higgins + */ + +#include +#include +#include + +int string_stream_vadd(struct string_stream *this, + const char *fmt, + va_list args) +{ + struct string_stream_fragment *fragment; + int len; + va_list args_for_counting; + unsigned long flags; + + /* Make a copy because `vsnprintf` could change it */ + va_copy(args_for_counting, args); + + /* Need space for null byte. */ + len = vsnprintf(NULL, 0, fmt, args_for_counting) + 1; + + va_end(args_for_counting); + + fragment = kmalloc(sizeof(*fragment), GFP_KERNEL); + if (!fragment) + return -ENOMEM; + + fragment->fragment = kmalloc(len, GFP_KERNEL); + if (!fragment->fragment) { + kfree(fragment); + return -ENOMEM; + } + + len = vsnprintf(fragment->fragment, len, fmt, args); + spin_lock_irqsave(&this->lock, flags); + this->length += len; + list_add_tail(&fragment->node, &this->fragments); + spin_unlock_irqrestore(&this->lock, flags); + return 0; +} + +int string_stream_add(struct string_stream *this, const char *fmt, ...) +{ + va_list args; + int result; + + va_start(args, fmt); + result = string_stream_vadd(this, fmt, args); + va_end(args); + return result; +} + +void string_stream_clear(struct string_stream *this) +{ + struct string_stream_fragment *fragment, *fragment_safe; + unsigned long flags; + + spin_lock_irqsave(&this->lock, flags); + list_for_each_entry_safe(fragment, + fragment_safe, + &this->fragments, + node) { + list_del(&fragment->node); + kfree(fragment->fragment); + kfree(fragment); + } + this->length = 0; + spin_unlock_irqrestore(&this->lock, flags); +} + +char *string_stream_get_string(struct string_stream *this) +{ + struct string_stream_fragment *fragment; + size_t buf_len = this->length + 1; /* +1 for null byte. */ + char *buf; + unsigned long flags; + + buf = kzalloc(buf_len, GFP_KERNEL); + if (!buf) + return NULL; + + spin_lock_irqsave(&this->lock, flags); + list_for_each_entry(fragment, &this->fragments, node) + strlcat(buf, fragment->fragment, buf_len); + spin_unlock_irqrestore(&this->lock, flags); + + return buf; +} + +bool string_stream_is_empty(struct string_stream *this) +{ + bool is_empty; + unsigned long flags; + + spin_lock_irqsave(&this->lock, flags); + is_empty = list_empty(&this->fragments); + spin_unlock_irqrestore(&this->lock, flags); + + return is_empty; +} + +void destroy_string_stream(struct string_stream *stream) +{ + string_stream_clear(stream); + kfree(stream); +} + +static void string_stream_destroy(struct kref *kref) +{ + struct string_stream *stream = container_of(kref, + struct string_stream, + refcount); + destroy_string_stream(stream); +} + +struct string_stream *new_string_stream(void) +{ + struct string_stream *stream = kzalloc(sizeof(*stream), GFP_KERNEL); + + if (!stream) + return NULL; + + INIT_LIST_HEAD(&stream->fragments); + spin_lock_init(&stream->lock); + kref_init(&stream->refcount); + return stream; +} + +void string_stream_get(struct string_stream *stream) +{ + kref_get(&stream->refcount); +} + +int string_stream_put(struct string_stream *stream) +{ + return kref_put(&stream->refcount, &string_stream_destroy); +} + -- 2.21.0.593.g511ec345e18-goog