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