xref: /linux/lib/kunit/string-stream.h (revision 03f7c1d2a49acd30e38789cd809d3300721e9b0e)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * C++ stream style string builder used in KUnit for building messages.
4  *
5  * Copyright (C) 2019, Google LLC.
6  * Author: Brendan Higgins <brendanhiggins@google.com>
7  */
8 
9 #ifndef _KUNIT_STRING_STREAM_H
10 #define _KUNIT_STRING_STREAM_H
11 
12 #include <linux/spinlock.h>
13 #include <linux/types.h>
14 #include <linux/stdarg.h>
15 
16 struct string_stream_fragment {
17 	struct list_head node;
18 	char *fragment;
19 };
20 
21 struct string_stream {
22 	size_t length;
23 	struct list_head fragments;
24 	/* length and fragments are protected by this lock */
25 	spinlock_t lock;
26 	struct kunit *test;
27 	gfp_t gfp;
28 };
29 
30 struct kunit;
31 
32 struct string_stream *alloc_string_stream(struct kunit *test, gfp_t gfp);
33 
34 int __printf(2, 3) string_stream_add(struct string_stream *stream,
35 				     const char *fmt, ...);
36 
37 int __printf(2, 0) string_stream_vadd(struct string_stream *stream,
38 				      const char *fmt,
39 				      va_list args);
40 
41 char *string_stream_get_string(struct string_stream *stream);
42 
43 int string_stream_append(struct string_stream *stream,
44 			 struct string_stream *other);
45 
46 bool string_stream_is_empty(struct string_stream *stream);
47 
48 void string_stream_destroy(struct string_stream *stream);
49 
50 #endif /* _KUNIT_STRING_STREAM_H */
51