xref: /freebsd/sys/kern/subr_sbuf.c (revision f4d281428f9eb458ffc19df9a1ed9e2af0950b8e)
160ec4130SDag-Erling Smørgrav /*-
2546d7890SDag-Erling Smørgrav  * Copyright (c) 2000-2008 Poul-Henning Kamp
3546d7890SDag-Erling Smørgrav  * Copyright (c) 2000-2008 Dag-Erling Coïdan Smørgrav
460ec4130SDag-Erling Smørgrav  * All rights reserved.
560ec4130SDag-Erling Smørgrav  *
660ec4130SDag-Erling Smørgrav  * Redistribution and use in source and binary forms, with or without
760ec4130SDag-Erling Smørgrav  * modification, are permitted provided that the following conditions
860ec4130SDag-Erling Smørgrav  * are met:
960ec4130SDag-Erling Smørgrav  * 1. Redistributions of source code must retain the above copyright
1060ec4130SDag-Erling Smørgrav  *    notice, this list of conditions and the following disclaimer
1160ec4130SDag-Erling Smørgrav  *    in this position and unchanged.
1260ec4130SDag-Erling Smørgrav  * 2. Redistributions in binary form must reproduce the above copyright
1360ec4130SDag-Erling Smørgrav  *    notice, this list of conditions and the following disclaimer in the
1460ec4130SDag-Erling Smørgrav  *    documentation and/or other materials provided with the distribution.
1560ec4130SDag-Erling Smørgrav  *
16546d7890SDag-Erling Smørgrav  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17546d7890SDag-Erling Smørgrav  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18546d7890SDag-Erling Smørgrav  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19546d7890SDag-Erling Smørgrav  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20546d7890SDag-Erling Smørgrav  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21546d7890SDag-Erling Smørgrav  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22546d7890SDag-Erling Smørgrav  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23546d7890SDag-Erling Smørgrav  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24546d7890SDag-Erling Smørgrav  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25546d7890SDag-Erling Smørgrav  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26546d7890SDag-Erling Smørgrav  * SUCH DAMAGE.
2760ec4130SDag-Erling Smørgrav  */
2860ec4130SDag-Erling Smørgrav 
29677b542eSDavid E. O'Brien #include <sys/cdefs.h>
30677b542eSDavid E. O'Brien __FBSDID("$FreeBSD$");
31677b542eSDavid E. O'Brien 
3260ec4130SDag-Erling Smørgrav #include <sys/param.h>
333393f8daSKenneth D. Merry 
343393f8daSKenneth D. Merry #ifdef _KERNEL
355b6db477SDag-Erling Smørgrav #include <sys/ctype.h>
364351ba27SMatthew D Fleming #include <sys/errno.h>
3760ec4130SDag-Erling Smørgrav #include <sys/kernel.h>
3860ec4130SDag-Erling Smørgrav #include <sys/malloc.h>
3960ec4130SDag-Erling Smørgrav #include <sys/systm.h>
405b6db477SDag-Erling Smørgrav #include <sys/uio.h>
4160ec4130SDag-Erling Smørgrav #include <machine/stdarg.h>
423393f8daSKenneth D. Merry #else /* _KERNEL */
435b6db477SDag-Erling Smørgrav #include <ctype.h>
444351ba27SMatthew D Fleming #include <errno.h>
453393f8daSKenneth D. Merry #include <stdarg.h>
467195eb40SKelly Yancey #include <stdio.h>
479fa416caSJonathan Lemon #include <stdlib.h>
487195eb40SKelly Yancey #include <string.h>
493393f8daSKenneth D. Merry #endif /* _KERNEL */
5060ec4130SDag-Erling Smørgrav 
515b6db477SDag-Erling Smørgrav #include <sys/sbuf.h>
525b6db477SDag-Erling Smørgrav 
533393f8daSKenneth D. Merry #ifdef _KERNEL
54c711aea6SPoul-Henning Kamp static MALLOC_DEFINE(M_SBUF, "sbuf", "string buffers");
550f7bc112SDag-Erling Smørgrav #define	SBMALLOC(size)		malloc(size, M_SBUF, M_WAITOK|M_ZERO)
563393f8daSKenneth D. Merry #define	SBFREE(buf)		free(buf, M_SBUF)
573393f8daSKenneth D. Merry #else /* _KERNEL */
583393f8daSKenneth D. Merry #define	KASSERT(e, m)
590f7bc112SDag-Erling Smørgrav #define	SBMALLOC(size)		calloc(1, size)
603393f8daSKenneth D. Merry #define	SBFREE(buf)		free(buf)
613393f8daSKenneth D. Merry #endif /* _KERNEL */
6260ec4130SDag-Erling Smørgrav 
634dc14139SDag-Erling Smørgrav /*
644dc14139SDag-Erling Smørgrav  * Predicates
654dc14139SDag-Erling Smørgrav  */
664dc14139SDag-Erling Smørgrav #define	SBUF_ISDYNAMIC(s)	((s)->s_flags & SBUF_DYNAMIC)
67d6479358SDag-Erling Smørgrav #define	SBUF_ISDYNSTRUCT(s)	((s)->s_flags & SBUF_DYNSTRUCT)
684dc14139SDag-Erling Smørgrav #define	SBUF_ISFINISHED(s)	((s)->s_flags & SBUF_FINISHED)
694dc14139SDag-Erling Smørgrav #define	SBUF_HASROOM(s)		((s)->s_len < (s)->s_size - 1)
70eb05ee7aSPoul-Henning Kamp #define	SBUF_FREESPACE(s)	((s)->s_size - ((s)->s_len + 1))
717195eb40SKelly Yancey #define	SBUF_CANEXTEND(s)	((s)->s_flags & SBUF_AUTOEXTEND)
72ddb9b612SMikolaj Golub #define	SBUF_ISSECTION(s)	((s)->s_flags & SBUF_INSECTION)
734dc14139SDag-Erling Smørgrav 
744dc14139SDag-Erling Smørgrav /*
754dc14139SDag-Erling Smørgrav  * Set / clear flags
764dc14139SDag-Erling Smørgrav  */
774dc14139SDag-Erling Smørgrav #define	SBUF_SETFLAG(s, f)	do { (s)->s_flags |= (f); } while (0)
784dc14139SDag-Erling Smørgrav #define	SBUF_CLEARFLAG(s, f)	do { (s)->s_flags &= ~(f); } while (0)
794dc14139SDag-Erling Smørgrav 
807195eb40SKelly Yancey #define	SBUF_MINEXTENDSIZE	16		/* Should be power of 2. */
81eb05ee7aSPoul-Henning Kamp 
82eb05ee7aSPoul-Henning Kamp #ifdef PAGE_SIZE
837195eb40SKelly Yancey #define	SBUF_MAXEXTENDSIZE	PAGE_SIZE
847195eb40SKelly Yancey #define	SBUF_MAXEXTENDINCR	PAGE_SIZE
85eb05ee7aSPoul-Henning Kamp #else
86eb05ee7aSPoul-Henning Kamp #define	SBUF_MAXEXTENDSIZE	4096
87eb05ee7aSPoul-Henning Kamp #define	SBUF_MAXEXTENDINCR	4096
88eb05ee7aSPoul-Henning Kamp #endif
897195eb40SKelly Yancey 
904dc14139SDag-Erling Smørgrav /*
914dc14139SDag-Erling Smørgrav  * Debugging support
924dc14139SDag-Erling Smørgrav  */
933393f8daSKenneth D. Merry #if defined(_KERNEL) && defined(INVARIANTS)
94546d7890SDag-Erling Smørgrav 
9560ec4130SDag-Erling Smørgrav static void
96a5e7c7daSPeter Wemm _assert_sbuf_integrity(const char *fun, struct sbuf *s)
9760ec4130SDag-Erling Smørgrav {
98546d7890SDag-Erling Smørgrav 
9960ec4130SDag-Erling Smørgrav 	KASSERT(s != NULL,
100cab5b963SDag-Erling Smørgrav 	    ("%s called with a NULL sbuf pointer", fun));
10160ec4130SDag-Erling Smørgrav 	KASSERT(s->s_buf != NULL,
1027195eb40SKelly Yancey 	    ("%s called with uninitialized or corrupt sbuf", fun));
10360ec4130SDag-Erling Smørgrav 	KASSERT(s->s_len < s->s_size,
10471c2bc5cSPoul-Henning Kamp 	    ("wrote past end of sbuf (%jd >= %jd)",
10571c2bc5cSPoul-Henning Kamp 	    (intmax_t)s->s_len, (intmax_t)s->s_size));
10660ec4130SDag-Erling Smørgrav }
10760ec4130SDag-Erling Smørgrav 
10860ec4130SDag-Erling Smørgrav static void
109a5e7c7daSPeter Wemm _assert_sbuf_state(const char *fun, struct sbuf *s, int state)
11060ec4130SDag-Erling Smørgrav {
111546d7890SDag-Erling Smørgrav 
11260ec4130SDag-Erling Smørgrav 	KASSERT((s->s_flags & SBUF_FINISHED) == state,
113cab5b963SDag-Erling Smørgrav 	    ("%s called with %sfinished or corrupt sbuf", fun,
11460ec4130SDag-Erling Smørgrav 	    (state ? "un" : "")));
11560ec4130SDag-Erling Smørgrav }
116546d7890SDag-Erling Smørgrav 
117a48740b6SDavid E. O'Brien #define	assert_sbuf_integrity(s) _assert_sbuf_integrity(__func__, (s))
118a48740b6SDavid E. O'Brien #define	assert_sbuf_state(s, i)	 _assert_sbuf_state(__func__, (s), (i))
119546d7890SDag-Erling Smørgrav 
1203393f8daSKenneth D. Merry #else /* _KERNEL && INVARIANTS */
121546d7890SDag-Erling Smørgrav 
12260ec4130SDag-Erling Smørgrav #define	assert_sbuf_integrity(s) do { } while (0)
12360ec4130SDag-Erling Smørgrav #define	assert_sbuf_state(s, i)	 do { } while (0)
124546d7890SDag-Erling Smørgrav 
1253393f8daSKenneth D. Merry #endif /* _KERNEL && INVARIANTS */
12660ec4130SDag-Erling Smørgrav 
127181ff3d5SMatthew D Fleming #ifdef CTASSERT
128f4bafab8SMatthew D Fleming CTASSERT(powerof2(SBUF_MAXEXTENDSIZE));
129f4bafab8SMatthew D Fleming CTASSERT(powerof2(SBUF_MAXEXTENDINCR));
130969292fbSMatthew D Fleming #endif
131f4bafab8SMatthew D Fleming 
1327195eb40SKelly Yancey static int
1337195eb40SKelly Yancey sbuf_extendsize(int size)
1347195eb40SKelly Yancey {
1357195eb40SKelly Yancey 	int newsize;
1367195eb40SKelly Yancey 
137f4bafab8SMatthew D Fleming 	if (size < (int)SBUF_MAXEXTENDSIZE) {
1387195eb40SKelly Yancey 		newsize = SBUF_MINEXTENDSIZE;
139f4bafab8SMatthew D Fleming 		while (newsize < size)
1407195eb40SKelly Yancey 			newsize *= 2;
141f4bafab8SMatthew D Fleming 	} else {
142f4bafab8SMatthew D Fleming 		newsize = roundup2(size, SBUF_MAXEXTENDINCR);
1437195eb40SKelly Yancey 	}
144f5a5dc5dSMatthew D Fleming 	KASSERT(newsize >= size, ("%s: %d < %d\n", __func__, newsize, size));
1457195eb40SKelly Yancey 	return (newsize);
1467195eb40SKelly Yancey }
1477195eb40SKelly Yancey 
1487195eb40SKelly Yancey /*
1497195eb40SKelly Yancey  * Extend an sbuf.
1507195eb40SKelly Yancey  */
1517195eb40SKelly Yancey static int
1527195eb40SKelly Yancey sbuf_extend(struct sbuf *s, int addlen)
1537195eb40SKelly Yancey {
1547195eb40SKelly Yancey 	char *newbuf;
155adecd05bSPietro Cerutti 	int newsize;
1567195eb40SKelly Yancey 
1577195eb40SKelly Yancey 	if (!SBUF_CANEXTEND(s))
1587195eb40SKelly Yancey 		return (-1);
1597195eb40SKelly Yancey 	newsize = sbuf_extendsize(s->s_size + addlen);
160546d7890SDag-Erling Smørgrav 	newbuf = SBMALLOC(newsize);
1617195eb40SKelly Yancey 	if (newbuf == NULL)
1627195eb40SKelly Yancey 		return (-1);
163384bf94cSPoul-Henning Kamp 	memcpy(newbuf, s->s_buf, s->s_size);
1647195eb40SKelly Yancey 	if (SBUF_ISDYNAMIC(s))
1657195eb40SKelly Yancey 		SBFREE(s->s_buf);
1667195eb40SKelly Yancey 	else
1677195eb40SKelly Yancey 		SBUF_SETFLAG(s, SBUF_DYNAMIC);
1687195eb40SKelly Yancey 	s->s_buf = newbuf;
1697195eb40SKelly Yancey 	s->s_size = newsize;
1707195eb40SKelly Yancey 	return (0);
1717195eb40SKelly Yancey }
1727195eb40SKelly Yancey 
17360ec4130SDag-Erling Smørgrav /*
174384bf94cSPoul-Henning Kamp  * Initialize the internals of an sbuf.
175384bf94cSPoul-Henning Kamp  * If buf is non-NULL, it points to a static or already-allocated string
176384bf94cSPoul-Henning Kamp  * big enough to hold at least length characters.
177384bf94cSPoul-Henning Kamp  */
178384bf94cSPoul-Henning Kamp static struct sbuf *
179adecd05bSPietro Cerutti sbuf_newbuf(struct sbuf *s, char *buf, int length, int flags)
180384bf94cSPoul-Henning Kamp {
181384bf94cSPoul-Henning Kamp 
182384bf94cSPoul-Henning Kamp 	memset(s, 0, sizeof(*s));
183384bf94cSPoul-Henning Kamp 	s->s_flags = flags;
184384bf94cSPoul-Henning Kamp 	s->s_size = length;
185384bf94cSPoul-Henning Kamp 	s->s_buf = buf;
186384bf94cSPoul-Henning Kamp 
187384bf94cSPoul-Henning Kamp 	if ((s->s_flags & SBUF_AUTOEXTEND) == 0) {
188311fa10bSRobert Watson 		KASSERT(s->s_size >= 0,
189384bf94cSPoul-Henning Kamp 		    ("attempt to create a too small sbuf"));
190384bf94cSPoul-Henning Kamp 	}
191384bf94cSPoul-Henning Kamp 
192384bf94cSPoul-Henning Kamp 	if (s->s_buf != NULL)
193384bf94cSPoul-Henning Kamp 		return (s);
194384bf94cSPoul-Henning Kamp 
195384bf94cSPoul-Henning Kamp 	if ((flags & SBUF_AUTOEXTEND) != 0)
196384bf94cSPoul-Henning Kamp 		s->s_size = sbuf_extendsize(s->s_size);
197384bf94cSPoul-Henning Kamp 
198384bf94cSPoul-Henning Kamp 	s->s_buf = SBMALLOC(s->s_size);
199384bf94cSPoul-Henning Kamp 	if (s->s_buf == NULL)
200384bf94cSPoul-Henning Kamp 		return (NULL);
201384bf94cSPoul-Henning Kamp 	SBUF_SETFLAG(s, SBUF_DYNAMIC);
202384bf94cSPoul-Henning Kamp 	return (s);
203384bf94cSPoul-Henning Kamp }
204384bf94cSPoul-Henning Kamp 
205384bf94cSPoul-Henning Kamp /*
20660ec4130SDag-Erling Smørgrav  * Initialize an sbuf.
20760ec4130SDag-Erling Smørgrav  * If buf is non-NULL, it points to a static or already-allocated string
20860ec4130SDag-Erling Smørgrav  * big enough to hold at least length characters.
20960ec4130SDag-Erling Smørgrav  */
210d6479358SDag-Erling Smørgrav struct sbuf *
2114dc14139SDag-Erling Smørgrav sbuf_new(struct sbuf *s, char *buf, int length, int flags)
21260ec4130SDag-Erling Smørgrav {
213546d7890SDag-Erling Smørgrav 
2144dc14139SDag-Erling Smørgrav 	KASSERT(length >= 0,
2154dc14139SDag-Erling Smørgrav 	    ("attempt to create an sbuf of negative length (%d)", length));
2167195eb40SKelly Yancey 	KASSERT((flags & ~SBUF_USRFLAGMSK) == 0,
2177195eb40SKelly Yancey 	    ("%s called with invalid flags", __func__));
21860ec4130SDag-Erling Smørgrav 
2197195eb40SKelly Yancey 	flags &= SBUF_USRFLAGMSK;
220384bf94cSPoul-Henning Kamp 	if (s != NULL)
221384bf94cSPoul-Henning Kamp 		return (sbuf_newbuf(s, buf, length, flags));
222384bf94cSPoul-Henning Kamp 
223546d7890SDag-Erling Smørgrav 	s = SBMALLOC(sizeof(*s));
224d6479358SDag-Erling Smørgrav 	if (s == NULL)
225d6479358SDag-Erling Smørgrav 		return (NULL);
226384bf94cSPoul-Henning Kamp 	if (sbuf_newbuf(s, buf, length, flags) == NULL) {
227d6479358SDag-Erling Smørgrav 		SBFREE(s);
228d6479358SDag-Erling Smørgrav 		return (NULL);
229d6479358SDag-Erling Smørgrav 	}
230384bf94cSPoul-Henning Kamp 	SBUF_SETFLAG(s, SBUF_DYNSTRUCT);
231d6479358SDag-Erling Smørgrav 	return (s);
23260ec4130SDag-Erling Smørgrav }
23360ec4130SDag-Erling Smørgrav 
2345b6db477SDag-Erling Smørgrav #ifdef _KERNEL
2355b6db477SDag-Erling Smørgrav /*
2365b6db477SDag-Erling Smørgrav  * Create an sbuf with uio data
2375b6db477SDag-Erling Smørgrav  */
2385b6db477SDag-Erling Smørgrav struct sbuf *
2395b6db477SDag-Erling Smørgrav sbuf_uionew(struct sbuf *s, struct uio *uio, int *error)
2405b6db477SDag-Erling Smørgrav {
241546d7890SDag-Erling Smørgrav 
2425b6db477SDag-Erling Smørgrav 	KASSERT(uio != NULL,
243a48740b6SDavid E. O'Brien 	    ("%s called with NULL uio pointer", __func__));
2445b6db477SDag-Erling Smørgrav 	KASSERT(error != NULL,
245a48740b6SDavid E. O'Brien 	    ("%s called with NULL error pointer", __func__));
2465b6db477SDag-Erling Smørgrav 
2475b6db477SDag-Erling Smørgrav 	s = sbuf_new(s, NULL, uio->uio_resid + 1, 0);
2485b6db477SDag-Erling Smørgrav 	if (s == NULL) {
2495b6db477SDag-Erling Smørgrav 		*error = ENOMEM;
2505b6db477SDag-Erling Smørgrav 		return (NULL);
2515b6db477SDag-Erling Smørgrav 	}
2525b6db477SDag-Erling Smørgrav 	*error = uiomove(s->s_buf, uio->uio_resid, uio);
2535b6db477SDag-Erling Smørgrav 	if (*error != 0) {
2545b6db477SDag-Erling Smørgrav 		sbuf_delete(s);
2555b6db477SDag-Erling Smørgrav 		return (NULL);
2565b6db477SDag-Erling Smørgrav 	}
2575b6db477SDag-Erling Smørgrav 	s->s_len = s->s_size - 1;
258ddb9b612SMikolaj Golub 	if (SBUF_ISSECTION(s))
259ddb9b612SMikolaj Golub 		s->s_sect_len = s->s_size - 1;
2605b6db477SDag-Erling Smørgrav 	*error = 0;
2615b6db477SDag-Erling Smørgrav 	return (s);
2625b6db477SDag-Erling Smørgrav }
2635b6db477SDag-Erling Smørgrav #endif
2645b6db477SDag-Erling Smørgrav 
265*f4d28142SIan Lepore int
266*f4d28142SIan Lepore sbuf_get_flags(struct sbuf *s)
267*f4d28142SIan Lepore {
268*f4d28142SIan Lepore 
269*f4d28142SIan Lepore 	return (s->s_flags & SBUF_USRFLAGMSK);
270*f4d28142SIan Lepore }
271*f4d28142SIan Lepore 
272*f4d28142SIan Lepore void
273*f4d28142SIan Lepore sbuf_clear_flags(struct sbuf *s, int flags)
274*f4d28142SIan Lepore {
275*f4d28142SIan Lepore 
276*f4d28142SIan Lepore 	s->s_flags &= ~(flags & SBUF_USRFLAGMSK);
277*f4d28142SIan Lepore }
278*f4d28142SIan Lepore 
279*f4d28142SIan Lepore void
280*f4d28142SIan Lepore sbuf_set_flags(struct sbuf *s, int flags)
281*f4d28142SIan Lepore {
282*f4d28142SIan Lepore 
283*f4d28142SIan Lepore 
284*f4d28142SIan Lepore 	s->s_flags |= (flags & SBUF_USRFLAGMSK);
285*f4d28142SIan Lepore }
286*f4d28142SIan Lepore 
28760ec4130SDag-Erling Smørgrav /*
2887195eb40SKelly Yancey  * Clear an sbuf and reset its position.
2894dc14139SDag-Erling Smørgrav  */
2904dc14139SDag-Erling Smørgrav void
2914dc14139SDag-Erling Smørgrav sbuf_clear(struct sbuf *s)
2924dc14139SDag-Erling Smørgrav {
293546d7890SDag-Erling Smørgrav 
2944dc14139SDag-Erling Smørgrav 	assert_sbuf_integrity(s);
2959fa2ef3dSDag-Erling Smørgrav 	/* don't care if it's finished or not */
2964dc14139SDag-Erling Smørgrav 
2974dc14139SDag-Erling Smørgrav 	SBUF_CLEARFLAG(s, SBUF_FINISHED);
2984351ba27SMatthew D Fleming 	s->s_error = 0;
2994dc14139SDag-Erling Smørgrav 	s->s_len = 0;
300ddb9b612SMikolaj Golub 	s->s_sect_len = 0;
3014dc14139SDag-Erling Smørgrav }
3024dc14139SDag-Erling Smørgrav 
3034dc14139SDag-Erling Smørgrav /*
3047195eb40SKelly Yancey  * Set the sbuf's end position to an arbitrary value.
3057195eb40SKelly Yancey  * Effectively truncates the sbuf at the new position.
30660ec4130SDag-Erling Smørgrav  */
30760ec4130SDag-Erling Smørgrav int
308adecd05bSPietro Cerutti sbuf_setpos(struct sbuf *s, ssize_t pos)
30960ec4130SDag-Erling Smørgrav {
310546d7890SDag-Erling Smørgrav 
31160ec4130SDag-Erling Smørgrav 	assert_sbuf_integrity(s);
31260ec4130SDag-Erling Smørgrav 	assert_sbuf_state(s, 0);
31360ec4130SDag-Erling Smørgrav 
314adecd05bSPietro Cerutti 	KASSERT(pos >= 0,
315adecd05bSPietro Cerutti 	    ("attempt to seek to a negative position (%jd)", (intmax_t)pos));
31660ec4130SDag-Erling Smørgrav 	KASSERT(pos < s->s_size,
31771c2bc5cSPoul-Henning Kamp 	    ("attempt to seek past end of sbuf (%jd >= %jd)",
31871c2bc5cSPoul-Henning Kamp 	    (intmax_t)pos, (intmax_t)s->s_size));
319ddb9b612SMikolaj Golub 	KASSERT(!SBUF_ISSECTION(s),
320ddb9b612SMikolaj Golub 	    ("attempt to seek when in a section"));
32160ec4130SDag-Erling Smørgrav 
322adecd05bSPietro Cerutti 	if (pos < 0 || pos > s->s_len)
32360ec4130SDag-Erling Smørgrav 		return (-1);
32460ec4130SDag-Erling Smørgrav 	s->s_len = pos;
32560ec4130SDag-Erling Smørgrav 	return (0);
32660ec4130SDag-Erling Smørgrav }
32760ec4130SDag-Erling Smørgrav 
32860ec4130SDag-Erling Smørgrav /*
3294351ba27SMatthew D Fleming  * Set up a drain function and argument on an sbuf to flush data to
3304351ba27SMatthew D Fleming  * when the sbuf buffer overflows.
3314351ba27SMatthew D Fleming  */
3324351ba27SMatthew D Fleming void
3334351ba27SMatthew D Fleming sbuf_set_drain(struct sbuf *s, sbuf_drain_func *func, void *ctx)
3344351ba27SMatthew D Fleming {
3354351ba27SMatthew D Fleming 
3364351ba27SMatthew D Fleming 	assert_sbuf_state(s, 0);
3374351ba27SMatthew D Fleming 	assert_sbuf_integrity(s);
3384351ba27SMatthew D Fleming 	KASSERT(func == s->s_drain_func || s->s_len == 0,
3394351ba27SMatthew D Fleming 	    ("Cannot change drain to %p on non-empty sbuf %p", func, s));
3404351ba27SMatthew D Fleming 	s->s_drain_func = func;
3414351ba27SMatthew D Fleming 	s->s_drain_arg = ctx;
3424351ba27SMatthew D Fleming }
3434351ba27SMatthew D Fleming 
3444351ba27SMatthew D Fleming /*
3454351ba27SMatthew D Fleming  * Call the drain and process the return.
3464351ba27SMatthew D Fleming  */
3474351ba27SMatthew D Fleming static int
3484351ba27SMatthew D Fleming sbuf_drain(struct sbuf *s)
3494351ba27SMatthew D Fleming {
3504351ba27SMatthew D Fleming 	int len;
3514351ba27SMatthew D Fleming 
3524351ba27SMatthew D Fleming 	KASSERT(s->s_len > 0, ("Shouldn't drain empty sbuf %p", s));
3534d369413SMatthew D Fleming 	KASSERT(s->s_error == 0, ("Called %s with error on %p", __func__, s));
3544351ba27SMatthew D Fleming 	len = s->s_drain_func(s->s_drain_arg, s->s_buf, s->s_len);
3554351ba27SMatthew D Fleming 	if (len < 0) {
3564351ba27SMatthew D Fleming 		s->s_error = -len;
3574351ba27SMatthew D Fleming 		return (s->s_error);
3584351ba27SMatthew D Fleming 	}
3594e657159SMatthew D Fleming 	KASSERT(len > 0 && len <= s->s_len,
3604e657159SMatthew D Fleming 	    ("Bad drain amount %d for sbuf %p", len, s));
3614351ba27SMatthew D Fleming 	s->s_len -= len;
3624351ba27SMatthew D Fleming 	/*
3634351ba27SMatthew D Fleming 	 * Fast path for the expected case where all the data was
3644351ba27SMatthew D Fleming 	 * drained.
3654351ba27SMatthew D Fleming 	 */
3664351ba27SMatthew D Fleming 	if (s->s_len == 0)
3674351ba27SMatthew D Fleming 		return (0);
3684351ba27SMatthew D Fleming 	/*
3694351ba27SMatthew D Fleming 	 * Move the remaining characters to the beginning of the
3704351ba27SMatthew D Fleming 	 * string.
3714351ba27SMatthew D Fleming 	 */
3724351ba27SMatthew D Fleming 	memmove(s->s_buf, s->s_buf + len, s->s_len);
3734351ba27SMatthew D Fleming 	return (0);
3744351ba27SMatthew D Fleming }
3754351ba27SMatthew D Fleming 
3764351ba27SMatthew D Fleming /*
37701f6f5fcSMatthew D Fleming  * Append a byte to an sbuf.  This is the core function for appending
37801f6f5fcSMatthew D Fleming  * to an sbuf and is the main place that deals with extending the
37901f6f5fcSMatthew D Fleming  * buffer and marking overflow.
38001f6f5fcSMatthew D Fleming  */
38101f6f5fcSMatthew D Fleming static void
382eb05ee7aSPoul-Henning Kamp sbuf_put_byte(struct sbuf *s, int c)
38301f6f5fcSMatthew D Fleming {
38401f6f5fcSMatthew D Fleming 
38501f6f5fcSMatthew D Fleming 	assert_sbuf_integrity(s);
38601f6f5fcSMatthew D Fleming 	assert_sbuf_state(s, 0);
38701f6f5fcSMatthew D Fleming 
3884d369413SMatthew D Fleming 	if (s->s_error != 0)
38901f6f5fcSMatthew D Fleming 		return;
39001f6f5fcSMatthew D Fleming 	if (SBUF_FREESPACE(s) <= 0) {
3914351ba27SMatthew D Fleming 		/*
3924351ba27SMatthew D Fleming 		 * If there is a drain, use it, otherwise extend the
3934351ba27SMatthew D Fleming 		 * buffer.
3944351ba27SMatthew D Fleming 		 */
3954351ba27SMatthew D Fleming 		if (s->s_drain_func != NULL)
3964351ba27SMatthew D Fleming 			(void)sbuf_drain(s);
3974351ba27SMatthew D Fleming 		else if (sbuf_extend(s, 1) < 0)
3984d369413SMatthew D Fleming 			s->s_error = ENOMEM;
3994d369413SMatthew D Fleming 		if (s->s_error != 0)
40001f6f5fcSMatthew D Fleming 			return;
40101f6f5fcSMatthew D Fleming 	}
40201f6f5fcSMatthew D Fleming 	s->s_buf[s->s_len++] = c;
403ddb9b612SMikolaj Golub 	if (SBUF_ISSECTION(s))
404ddb9b612SMikolaj Golub 		s->s_sect_len++;
40501f6f5fcSMatthew D Fleming }
40601f6f5fcSMatthew D Fleming 
40701f6f5fcSMatthew D Fleming /*
408b0def2b5SDag-Erling Smørgrav  * Append a byte string to an sbuf.
409b0def2b5SDag-Erling Smørgrav  */
410b0def2b5SDag-Erling Smørgrav int
411520df276SDag-Erling Smørgrav sbuf_bcat(struct sbuf *s, const void *buf, size_t len)
412b0def2b5SDag-Erling Smørgrav {
413520df276SDag-Erling Smørgrav 	const char *str = buf;
41401f6f5fcSMatthew D Fleming 	const char *end = str + len;
415d751f0a9SDag-Erling Smørgrav 
416b0def2b5SDag-Erling Smørgrav 	assert_sbuf_integrity(s);
417b0def2b5SDag-Erling Smørgrav 	assert_sbuf_state(s, 0);
418b0def2b5SDag-Erling Smørgrav 
4194d369413SMatthew D Fleming 	if (s->s_error != 0)
420b0def2b5SDag-Erling Smørgrav 		return (-1);
42101f6f5fcSMatthew D Fleming 	for (; str < end; str++) {
422eb05ee7aSPoul-Henning Kamp 		sbuf_put_byte(s, *str);
4234d369413SMatthew D Fleming 		if (s->s_error != 0)
424b0def2b5SDag-Erling Smørgrav 			return (-1);
425b0def2b5SDag-Erling Smørgrav 	}
426b0def2b5SDag-Erling Smørgrav 	return (0);
427b0def2b5SDag-Erling Smørgrav }
428b0def2b5SDag-Erling Smørgrav 
429b0def2b5SDag-Erling Smørgrav #ifdef _KERNEL
430b0def2b5SDag-Erling Smørgrav /*
431b0def2b5SDag-Erling Smørgrav  * Copy a byte string from userland into an sbuf.
432b0def2b5SDag-Erling Smørgrav  */
433b0def2b5SDag-Erling Smørgrav int
434b0def2b5SDag-Erling Smørgrav sbuf_bcopyin(struct sbuf *s, const void *uaddr, size_t len)
435b0def2b5SDag-Erling Smørgrav {
436546d7890SDag-Erling Smørgrav 
437b0def2b5SDag-Erling Smørgrav 	assert_sbuf_integrity(s);
438b0def2b5SDag-Erling Smørgrav 	assert_sbuf_state(s, 0);
4394351ba27SMatthew D Fleming 	KASSERT(s->s_drain_func == NULL,
4404351ba27SMatthew D Fleming 	    ("Nonsensical copyin to sbuf %p with a drain", s));
441b0def2b5SDag-Erling Smørgrav 
4424d369413SMatthew D Fleming 	if (s->s_error != 0)
443b0def2b5SDag-Erling Smørgrav 		return (-1);
444b0def2b5SDag-Erling Smørgrav 	if (len == 0)
445b0def2b5SDag-Erling Smørgrav 		return (0);
4467195eb40SKelly Yancey 	if (len > SBUF_FREESPACE(s)) {
4477195eb40SKelly Yancey 		sbuf_extend(s, len - SBUF_FREESPACE(s));
448c05dbe7aSMatthew D Fleming 		if (SBUF_FREESPACE(s) < len)
449c05dbe7aSMatthew D Fleming 			len = SBUF_FREESPACE(s);
4507195eb40SKelly Yancey 	}
451e3b37322SDag-Erling Smørgrav 	if (copyin(uaddr, s->s_buf + s->s_len, len) != 0)
452e3b37322SDag-Erling Smørgrav 		return (-1);
453fe463496SDag-Erling Smørgrav 	s->s_len += len;
454b0def2b5SDag-Erling Smørgrav 
455b0def2b5SDag-Erling Smørgrav 	return (0);
456b0def2b5SDag-Erling Smørgrav }
457b0def2b5SDag-Erling Smørgrav #endif
458b0def2b5SDag-Erling Smørgrav 
459b0def2b5SDag-Erling Smørgrav /*
460b0def2b5SDag-Erling Smørgrav  * Copy a byte string into an sbuf.
461b0def2b5SDag-Erling Smørgrav  */
462b0def2b5SDag-Erling Smørgrav int
463520df276SDag-Erling Smørgrav sbuf_bcpy(struct sbuf *s, const void *buf, size_t len)
464b0def2b5SDag-Erling Smørgrav {
465546d7890SDag-Erling Smørgrav 
466b0def2b5SDag-Erling Smørgrav 	assert_sbuf_integrity(s);
467b0def2b5SDag-Erling Smørgrav 	assert_sbuf_state(s, 0);
468b0def2b5SDag-Erling Smørgrav 
469b0def2b5SDag-Erling Smørgrav 	sbuf_clear(s);
470520df276SDag-Erling Smørgrav 	return (sbuf_bcat(s, buf, len));
471b0def2b5SDag-Erling Smørgrav }
472b0def2b5SDag-Erling Smørgrav 
473b0def2b5SDag-Erling Smørgrav /*
47460ec4130SDag-Erling Smørgrav  * Append a string to an sbuf.
47560ec4130SDag-Erling Smørgrav  */
47660ec4130SDag-Erling Smørgrav int
4773393f8daSKenneth D. Merry sbuf_cat(struct sbuf *s, const char *str)
47860ec4130SDag-Erling Smørgrav {
479546d7890SDag-Erling Smørgrav 
48060ec4130SDag-Erling Smørgrav 	assert_sbuf_integrity(s);
48160ec4130SDag-Erling Smørgrav 	assert_sbuf_state(s, 0);
48260ec4130SDag-Erling Smørgrav 
4834d369413SMatthew D Fleming 	if (s->s_error != 0)
48460ec4130SDag-Erling Smørgrav 		return (-1);
48560ec4130SDag-Erling Smørgrav 
486c05dbe7aSMatthew D Fleming 	while (*str != '\0') {
487eb05ee7aSPoul-Henning Kamp 		sbuf_put_byte(s, *str++);
4884d369413SMatthew D Fleming 		if (s->s_error != 0)
48960ec4130SDag-Erling Smørgrav 			return (-1);
49060ec4130SDag-Erling Smørgrav 	}
49160ec4130SDag-Erling Smørgrav 	return (0);
49260ec4130SDag-Erling Smørgrav }
49360ec4130SDag-Erling Smørgrav 
494b0def2b5SDag-Erling Smørgrav #ifdef _KERNEL
495b0def2b5SDag-Erling Smørgrav /*
4967195eb40SKelly Yancey  * Append a string from userland to an sbuf.
497b0def2b5SDag-Erling Smørgrav  */
498b0def2b5SDag-Erling Smørgrav int
499b0def2b5SDag-Erling Smørgrav sbuf_copyin(struct sbuf *s, const void *uaddr, size_t len)
500b0def2b5SDag-Erling Smørgrav {
501b0def2b5SDag-Erling Smørgrav 	size_t done;
502b0def2b5SDag-Erling Smørgrav 
503b0def2b5SDag-Erling Smørgrav 	assert_sbuf_integrity(s);
504b0def2b5SDag-Erling Smørgrav 	assert_sbuf_state(s, 0);
5054351ba27SMatthew D Fleming 	KASSERT(s->s_drain_func == NULL,
5064351ba27SMatthew D Fleming 	    ("Nonsensical copyin to sbuf %p with a drain", s));
507b0def2b5SDag-Erling Smørgrav 
5084d369413SMatthew D Fleming 	if (s->s_error != 0)
509b0def2b5SDag-Erling Smørgrav 		return (-1);
510b0def2b5SDag-Erling Smørgrav 
5117195eb40SKelly Yancey 	if (len == 0)
5127195eb40SKelly Yancey 		len = SBUF_FREESPACE(s);	/* XXX return 0? */
5137195eb40SKelly Yancey 	if (len > SBUF_FREESPACE(s)) {
5147195eb40SKelly Yancey 		sbuf_extend(s, len);
515c05dbe7aSMatthew D Fleming 		if (SBUF_FREESPACE(s) < len)
516c05dbe7aSMatthew D Fleming 			len = SBUF_FREESPACE(s);
5177195eb40SKelly Yancey 	}
518b0def2b5SDag-Erling Smørgrav 	switch (copyinstr(uaddr, s->s_buf + s->s_len, len + 1, &done)) {
519b0def2b5SDag-Erling Smørgrav 	case ENAMETOOLONG:
5204d369413SMatthew D Fleming 		s->s_error = ENOMEM;
521b0def2b5SDag-Erling Smørgrav 		/* fall through */
522b0def2b5SDag-Erling Smørgrav 	case 0:
523b0def2b5SDag-Erling Smørgrav 		s->s_len += done - 1;
524ddb9b612SMikolaj Golub 		if (SBUF_ISSECTION(s))
525ddb9b612SMikolaj Golub 			s->s_sect_len += done - 1;
526b0def2b5SDag-Erling Smørgrav 		break;
527b0def2b5SDag-Erling Smørgrav 	default:
528b0def2b5SDag-Erling Smørgrav 		return (-1);	/* XXX */
529b0def2b5SDag-Erling Smørgrav 	}
530b0def2b5SDag-Erling Smørgrav 
53149091c48SPoul-Henning Kamp 	return (done);
532b0def2b5SDag-Erling Smørgrav }
533b0def2b5SDag-Erling Smørgrav #endif
534b0def2b5SDag-Erling Smørgrav 
53560ec4130SDag-Erling Smørgrav /*
53660ec4130SDag-Erling Smørgrav  * Copy a string into an sbuf.
53760ec4130SDag-Erling Smørgrav  */
53860ec4130SDag-Erling Smørgrav int
5393393f8daSKenneth D. Merry sbuf_cpy(struct sbuf *s, const char *str)
54060ec4130SDag-Erling Smørgrav {
541546d7890SDag-Erling Smørgrav 
54260ec4130SDag-Erling Smørgrav 	assert_sbuf_integrity(s);
54360ec4130SDag-Erling Smørgrav 	assert_sbuf_state(s, 0);
54460ec4130SDag-Erling Smørgrav 
5454dc14139SDag-Erling Smørgrav 	sbuf_clear(s);
54660ec4130SDag-Erling Smørgrav 	return (sbuf_cat(s, str));
54760ec4130SDag-Erling Smørgrav }
54860ec4130SDag-Erling Smørgrav 
54960ec4130SDag-Erling Smørgrav /*
5507195eb40SKelly Yancey  * Format the given argument list and append the resulting string to an sbuf.
55160ec4130SDag-Erling Smørgrav  */
55201f6f5fcSMatthew D Fleming #ifdef _KERNEL
553eb05ee7aSPoul-Henning Kamp 
554eb05ee7aSPoul-Henning Kamp /*
555eb05ee7aSPoul-Henning Kamp  * Append a non-NUL character to an sbuf.  This prototype signature is
556eb05ee7aSPoul-Henning Kamp  * suitable for use with kvprintf(9).
557eb05ee7aSPoul-Henning Kamp  */
558eb05ee7aSPoul-Henning Kamp static void
559eb05ee7aSPoul-Henning Kamp sbuf_putc_func(int c, void *arg)
560eb05ee7aSPoul-Henning Kamp {
561eb05ee7aSPoul-Henning Kamp 
562eb05ee7aSPoul-Henning Kamp 	if (c != '\0')
563eb05ee7aSPoul-Henning Kamp 		sbuf_put_byte(arg, c);
564eb05ee7aSPoul-Henning Kamp }
565eb05ee7aSPoul-Henning Kamp 
56601f6f5fcSMatthew D Fleming int
56701f6f5fcSMatthew D Fleming sbuf_vprintf(struct sbuf *s, const char *fmt, va_list ap)
56801f6f5fcSMatthew D Fleming {
56901f6f5fcSMatthew D Fleming 
57001f6f5fcSMatthew D Fleming 	assert_sbuf_integrity(s);
57101f6f5fcSMatthew D Fleming 	assert_sbuf_state(s, 0);
57201f6f5fcSMatthew D Fleming 
57301f6f5fcSMatthew D Fleming 	KASSERT(fmt != NULL,
57401f6f5fcSMatthew D Fleming 	    ("%s called with a NULL format string", __func__));
57501f6f5fcSMatthew D Fleming 
57601f6f5fcSMatthew D Fleming 	(void)kvprintf(fmt, sbuf_putc_func, s, 10, ap);
5774d369413SMatthew D Fleming 	if (s->s_error != 0)
57801f6f5fcSMatthew D Fleming 		return (-1);
57901f6f5fcSMatthew D Fleming 	return (0);
58001f6f5fcSMatthew D Fleming }
58101f6f5fcSMatthew D Fleming #else /* !_KERNEL */
58260ec4130SDag-Erling Smørgrav int
5837195eb40SKelly Yancey sbuf_vprintf(struct sbuf *s, const char *fmt, va_list ap)
58460ec4130SDag-Erling Smørgrav {
585a9a0bbadSPeter Wemm 	va_list ap_copy;
586adecd05bSPietro Cerutti 	int error, len;
58760ec4130SDag-Erling Smørgrav 
58860ec4130SDag-Erling Smørgrav 	assert_sbuf_integrity(s);
58960ec4130SDag-Erling Smørgrav 	assert_sbuf_state(s, 0);
59060ec4130SDag-Erling Smørgrav 
59160ec4130SDag-Erling Smørgrav 	KASSERT(fmt != NULL,
592a48740b6SDavid E. O'Brien 	    ("%s called with a NULL format string", __func__));
59360ec4130SDag-Erling Smørgrav 
5944d369413SMatthew D Fleming 	if (s->s_error != 0)
59560ec4130SDag-Erling Smørgrav 		return (-1);
59660ec4130SDag-Erling Smørgrav 
59701f6f5fcSMatthew D Fleming 	/*
59801f6f5fcSMatthew D Fleming 	 * For the moment, there is no way to get vsnprintf(3) to hand
59901f6f5fcSMatthew D Fleming 	 * back a character at a time, to push everything into
60001f6f5fcSMatthew D Fleming 	 * sbuf_putc_func() as was done for the kernel.
6014351ba27SMatthew D Fleming 	 *
6024351ba27SMatthew D Fleming 	 * In userspace, while drains are useful, there's generally
6034351ba27SMatthew D Fleming 	 * not a problem attempting to malloc(3) on out of space.  So
6044351ba27SMatthew D Fleming 	 * expand a userland sbuf if there is not enough room for the
6054351ba27SMatthew D Fleming 	 * data produced by sbuf_[v]printf(3).
60601f6f5fcSMatthew D Fleming 	 */
60701f6f5fcSMatthew D Fleming 
6084351ba27SMatthew D Fleming 	error = 0;
6097195eb40SKelly Yancey 	do {
610a9a0bbadSPeter Wemm 		va_copy(ap_copy, ap);
6117195eb40SKelly Yancey 		len = vsnprintf(&s->s_buf[s->s_len], SBUF_FREESPACE(s) + 1,
612a9a0bbadSPeter Wemm 		    fmt, ap_copy);
613a9a0bbadSPeter Wemm 		va_end(ap_copy);
6144351ba27SMatthew D Fleming 
6154351ba27SMatthew D Fleming 		if (SBUF_FREESPACE(s) >= len)
6164351ba27SMatthew D Fleming 			break;
6174351ba27SMatthew D Fleming 		/* Cannot print with the current available space. */
6184351ba27SMatthew D Fleming 		if (s->s_drain_func != NULL && s->s_len > 0)
6194351ba27SMatthew D Fleming 			error = sbuf_drain(s);
6204351ba27SMatthew D Fleming 		else
6214351ba27SMatthew D Fleming 			error = sbuf_extend(s, len - SBUF_FREESPACE(s));
6224351ba27SMatthew D Fleming 	} while (error == 0);
62360ec4130SDag-Erling Smørgrav 
6243393f8daSKenneth D. Merry 	/*
6253393f8daSKenneth D. Merry 	 * s->s_len is the length of the string, without the terminating nul.
6263393f8daSKenneth D. Merry 	 * When updating s->s_len, we must subtract 1 from the length that
6273393f8daSKenneth D. Merry 	 * we passed into vsnprintf() because that length includes the
6283393f8daSKenneth D. Merry 	 * terminating nul.
6293393f8daSKenneth D. Merry 	 *
6303393f8daSKenneth D. Merry 	 * vsnprintf() returns the amount that would have been copied,
631c05dbe7aSMatthew D Fleming 	 * given sufficient space, so don't over-increment s_len.
6323393f8daSKenneth D. Merry 	 */
633c05dbe7aSMatthew D Fleming 	if (SBUF_FREESPACE(s) < len)
634c05dbe7aSMatthew D Fleming 		len = SBUF_FREESPACE(s);
635c05dbe7aSMatthew D Fleming 	s->s_len += len;
636ddb9b612SMikolaj Golub 	if (SBUF_ISSECTION(s))
637ddb9b612SMikolaj Golub 		s->s_sect_len += len;
6381a25c86bSPoul-Henning Kamp 	if (!SBUF_HASROOM(s) && !SBUF_CANEXTEND(s))
6394d369413SMatthew D Fleming 		s->s_error = ENOMEM;
6403393f8daSKenneth D. Merry 
64160ec4130SDag-Erling Smørgrav 	KASSERT(s->s_len < s->s_size,
64260ec4130SDag-Erling Smørgrav 	    ("wrote past end of sbuf (%d >= %d)", s->s_len, s->s_size));
64360ec4130SDag-Erling Smørgrav 
6444d369413SMatthew D Fleming 	if (s->s_error != 0)
64560ec4130SDag-Erling Smørgrav 		return (-1);
64660ec4130SDag-Erling Smørgrav 	return (0);
64760ec4130SDag-Erling Smørgrav }
64801f6f5fcSMatthew D Fleming #endif /* _KERNEL */
64960ec4130SDag-Erling Smørgrav 
65060ec4130SDag-Erling Smørgrav /*
6517195eb40SKelly Yancey  * Format the given arguments and append the resulting string to an sbuf.
6527195eb40SKelly Yancey  */
6537195eb40SKelly Yancey int
6547195eb40SKelly Yancey sbuf_printf(struct sbuf *s, const char *fmt, ...)
6557195eb40SKelly Yancey {
6567195eb40SKelly Yancey 	va_list ap;
6577195eb40SKelly Yancey 	int result;
6587195eb40SKelly Yancey 
6597195eb40SKelly Yancey 	va_start(ap, fmt);
6607195eb40SKelly Yancey 	result = sbuf_vprintf(s, fmt, ap);
6617195eb40SKelly Yancey 	va_end(ap);
6627195eb40SKelly Yancey 	return (result);
6637195eb40SKelly Yancey }
6647195eb40SKelly Yancey 
6657195eb40SKelly Yancey /*
66660ec4130SDag-Erling Smørgrav  * Append a character to an sbuf.
66760ec4130SDag-Erling Smørgrav  */
66860ec4130SDag-Erling Smørgrav int
66960ec4130SDag-Erling Smørgrav sbuf_putc(struct sbuf *s, int c)
67060ec4130SDag-Erling Smørgrav {
671546d7890SDag-Erling Smørgrav 
672eb05ee7aSPoul-Henning Kamp 	sbuf_put_byte(s, c);
6734d369413SMatthew D Fleming 	if (s->s_error != 0)
67460ec4130SDag-Erling Smørgrav 		return (-1);
67560ec4130SDag-Erling Smørgrav 	return (0);
67660ec4130SDag-Erling Smørgrav }
67760ec4130SDag-Erling Smørgrav 
67860ec4130SDag-Erling Smørgrav /*
6797195eb40SKelly Yancey  * Trim whitespace characters from end of an sbuf.
6805b6db477SDag-Erling Smørgrav  */
6815b6db477SDag-Erling Smørgrav int
6825b6db477SDag-Erling Smørgrav sbuf_trim(struct sbuf *s)
6835b6db477SDag-Erling Smørgrav {
684546d7890SDag-Erling Smørgrav 
6855b6db477SDag-Erling Smørgrav 	assert_sbuf_integrity(s);
6865b6db477SDag-Erling Smørgrav 	assert_sbuf_state(s, 0);
6874351ba27SMatthew D Fleming 	KASSERT(s->s_drain_func == NULL,
6884351ba27SMatthew D Fleming 	    ("%s makes no sense on sbuf %p with drain", __func__, s));
6895b6db477SDag-Erling Smørgrav 
6904d369413SMatthew D Fleming 	if (s->s_error != 0)
6915b6db477SDag-Erling Smørgrav 		return (-1);
6925b6db477SDag-Erling Smørgrav 
693ddb9b612SMikolaj Golub 	while (s->s_len > 0 && isspace(s->s_buf[s->s_len-1])) {
6945b6db477SDag-Erling Smørgrav 		--s->s_len;
695ddb9b612SMikolaj Golub 		if (SBUF_ISSECTION(s))
696ddb9b612SMikolaj Golub 			s->s_sect_len--;
697ddb9b612SMikolaj Golub 	}
6985b6db477SDag-Erling Smørgrav 
6995b6db477SDag-Erling Smørgrav 	return (0);
7005b6db477SDag-Erling Smørgrav }
7015b6db477SDag-Erling Smørgrav 
7025b6db477SDag-Erling Smørgrav /*
7034d369413SMatthew D Fleming  * Check if an sbuf has an error.
70460ec4130SDag-Erling Smørgrav  */
70560ec4130SDag-Erling Smørgrav int
70671c2bc5cSPoul-Henning Kamp sbuf_error(const struct sbuf *s)
7074dc14139SDag-Erling Smørgrav {
708546d7890SDag-Erling Smørgrav 
7094d369413SMatthew D Fleming 	return (s->s_error);
7104dc14139SDag-Erling Smørgrav }
7114dc14139SDag-Erling Smørgrav 
7124dc14139SDag-Erling Smørgrav /*
7134dc14139SDag-Erling Smørgrav  * Finish off an sbuf.
7144dc14139SDag-Erling Smørgrav  */
7154351ba27SMatthew D Fleming int
71660ec4130SDag-Erling Smørgrav sbuf_finish(struct sbuf *s)
71760ec4130SDag-Erling Smørgrav {
718546d7890SDag-Erling Smørgrav 
71960ec4130SDag-Erling Smørgrav 	assert_sbuf_integrity(s);
72060ec4130SDag-Erling Smørgrav 	assert_sbuf_state(s, 0);
72160ec4130SDag-Erling Smørgrav 
722*f4d28142SIan Lepore 	s->s_buf[s->s_len] = '\0';
723*f4d28142SIan Lepore 	if (s->s_flags & SBUF_INCLUDENUL)
724*f4d28142SIan Lepore 		s->s_len++;
7254d369413SMatthew D Fleming 	if (s->s_drain_func != NULL) {
726eb05ee7aSPoul-Henning Kamp 		while (s->s_len > 0 && s->s_error == 0)
727eb05ee7aSPoul-Henning Kamp 			s->s_error = sbuf_drain(s);
7284d369413SMatthew D Fleming 	}
72960ec4130SDag-Erling Smørgrav 	SBUF_SETFLAG(s, SBUF_FINISHED);
7304351ba27SMatthew D Fleming #ifdef _KERNEL
731eb05ee7aSPoul-Henning Kamp 	return (s->s_error);
7324351ba27SMatthew D Fleming #else
733c532f8c4SJaakko Heinonen 	if (s->s_error != 0) {
734eb05ee7aSPoul-Henning Kamp 		errno = s->s_error;
7354351ba27SMatthew D Fleming 		return (-1);
736c532f8c4SJaakko Heinonen 	}
737eb05ee7aSPoul-Henning Kamp 	return (0);
7384351ba27SMatthew D Fleming #endif
73960ec4130SDag-Erling Smørgrav }
74060ec4130SDag-Erling Smørgrav 
74160ec4130SDag-Erling Smørgrav /*
74260ec4130SDag-Erling Smørgrav  * Return a pointer to the sbuf data.
74360ec4130SDag-Erling Smørgrav  */
74460ec4130SDag-Erling Smørgrav char *
74560ec4130SDag-Erling Smørgrav sbuf_data(struct sbuf *s)
74660ec4130SDag-Erling Smørgrav {
747546d7890SDag-Erling Smørgrav 
74860ec4130SDag-Erling Smørgrav 	assert_sbuf_integrity(s);
74960ec4130SDag-Erling Smørgrav 	assert_sbuf_state(s, SBUF_FINISHED);
7504351ba27SMatthew D Fleming 	KASSERT(s->s_drain_func == NULL,
7514351ba27SMatthew D Fleming 	    ("%s makes no sense on sbuf %p with drain", __func__, s));
75260ec4130SDag-Erling Smørgrav 
753546d7890SDag-Erling Smørgrav 	return (s->s_buf);
75460ec4130SDag-Erling Smørgrav }
75560ec4130SDag-Erling Smørgrav 
75660ec4130SDag-Erling Smørgrav /*
75760ec4130SDag-Erling Smørgrav  * Return the length of the sbuf data.
75860ec4130SDag-Erling Smørgrav  */
75971c2bc5cSPoul-Henning Kamp ssize_t
76060ec4130SDag-Erling Smørgrav sbuf_len(struct sbuf *s)
76160ec4130SDag-Erling Smørgrav {
762546d7890SDag-Erling Smørgrav 
76360ec4130SDag-Erling Smørgrav 	assert_sbuf_integrity(s);
7649fa2ef3dSDag-Erling Smørgrav 	/* don't care if it's finished or not */
7654351ba27SMatthew D Fleming 	KASSERT(s->s_drain_func == NULL,
7664351ba27SMatthew D Fleming 	    ("%s makes no sense on sbuf %p with drain", __func__, s));
76760ec4130SDag-Erling Smørgrav 
7684d369413SMatthew D Fleming 	if (s->s_error != 0)
7694dc14139SDag-Erling Smørgrav 		return (-1);
770*f4d28142SIan Lepore 
771*f4d28142SIan Lepore 	/* If finished, nulterm is already in len, else add one. */
772*f4d28142SIan Lepore 	if ((s->s_flags & (SBUF_INCLUDENUL | SBUF_FINISHED)) == SBUF_INCLUDENUL)
773*f4d28142SIan Lepore 		return (s->s_len + 1);
774546d7890SDag-Erling Smørgrav 	return (s->s_len);
77560ec4130SDag-Erling Smørgrav }
77660ec4130SDag-Erling Smørgrav 
77760ec4130SDag-Erling Smørgrav /*
77860ec4130SDag-Erling Smørgrav  * Clear an sbuf, free its buffer if necessary.
77960ec4130SDag-Erling Smørgrav  */
78060ec4130SDag-Erling Smørgrav void
78160ec4130SDag-Erling Smørgrav sbuf_delete(struct sbuf *s)
78260ec4130SDag-Erling Smørgrav {
783a57094a0SMatthew Dillon 	int isdyn;
784a57094a0SMatthew Dillon 
78560ec4130SDag-Erling Smørgrav 	assert_sbuf_integrity(s);
78660ec4130SDag-Erling Smørgrav 	/* don't care if it's finished or not */
78760ec4130SDag-Erling Smørgrav 
78860ec4130SDag-Erling Smørgrav 	if (SBUF_ISDYNAMIC(s))
7893393f8daSKenneth D. Merry 		SBFREE(s->s_buf);
790a57094a0SMatthew Dillon 	isdyn = SBUF_ISDYNSTRUCT(s);
791384bf94cSPoul-Henning Kamp 	memset(s, 0, sizeof(*s));
792a57094a0SMatthew Dillon 	if (isdyn)
793d6479358SDag-Erling Smørgrav 		SBFREE(s);
79460ec4130SDag-Erling Smørgrav }
795c5f9218bSPoul-Henning Kamp 
796c5f9218bSPoul-Henning Kamp /*
797c5f9218bSPoul-Henning Kamp  * Check if an sbuf has been finished.
798c5f9218bSPoul-Henning Kamp  */
799c5f9218bSPoul-Henning Kamp int
80071c2bc5cSPoul-Henning Kamp sbuf_done(const struct sbuf *s)
801c5f9218bSPoul-Henning Kamp {
802c5f9218bSPoul-Henning Kamp 
803c5f9218bSPoul-Henning Kamp 	return (SBUF_ISFINISHED(s));
804c5f9218bSPoul-Henning Kamp }
805ddb9b612SMikolaj Golub 
806ddb9b612SMikolaj Golub /*
807ddb9b612SMikolaj Golub  * Start a section.
808ddb9b612SMikolaj Golub  */
809ddb9b612SMikolaj Golub void
810ddb9b612SMikolaj Golub sbuf_start_section(struct sbuf *s, ssize_t *old_lenp)
811ddb9b612SMikolaj Golub {
812ddb9b612SMikolaj Golub 
813ddb9b612SMikolaj Golub 	assert_sbuf_integrity(s);
814ddb9b612SMikolaj Golub 	assert_sbuf_state(s, 0);
815ddb9b612SMikolaj Golub 
816ddb9b612SMikolaj Golub 	if (!SBUF_ISSECTION(s)) {
817ddb9b612SMikolaj Golub 		KASSERT(s->s_sect_len == 0,
818ddb9b612SMikolaj Golub 		    ("s_sect_len != 0 when starting a section"));
819ddb9b612SMikolaj Golub 		if (old_lenp != NULL)
820ddb9b612SMikolaj Golub 			*old_lenp = -1;
821ddb9b612SMikolaj Golub 		SBUF_SETFLAG(s, SBUF_INSECTION);
822ddb9b612SMikolaj Golub 	} else {
823ddb9b612SMikolaj Golub 		KASSERT(old_lenp != NULL,
824ddb9b612SMikolaj Golub 		    ("s_sect_len should be saved when starting a subsection"));
825ddb9b612SMikolaj Golub 		*old_lenp = s->s_sect_len;
826ddb9b612SMikolaj Golub 		s->s_sect_len = 0;
827ddb9b612SMikolaj Golub 	}
828ddb9b612SMikolaj Golub }
829ddb9b612SMikolaj Golub 
830ddb9b612SMikolaj Golub /*
831ddb9b612SMikolaj Golub  * End the section padding to the specified length with the specified
832ddb9b612SMikolaj Golub  * character.
833ddb9b612SMikolaj Golub  */
834ddb9b612SMikolaj Golub ssize_t
835ddb9b612SMikolaj Golub sbuf_end_section(struct sbuf *s, ssize_t old_len, size_t pad, int c)
836ddb9b612SMikolaj Golub {
837ddb9b612SMikolaj Golub 	ssize_t len;
838ddb9b612SMikolaj Golub 
839ddb9b612SMikolaj Golub 	assert_sbuf_integrity(s);
840ddb9b612SMikolaj Golub 	assert_sbuf_state(s, 0);
841ddb9b612SMikolaj Golub 	KASSERT(SBUF_ISSECTION(s),
842ddb9b612SMikolaj Golub 	    ("attempt to end a section when not in a section"));
843ddb9b612SMikolaj Golub 
844ddb9b612SMikolaj Golub 	if (pad > 1) {
845ddb9b612SMikolaj Golub 		len = roundup(s->s_sect_len, pad) - s->s_sect_len;
846ddb9b612SMikolaj Golub 		for (; s->s_error == 0 && len > 0; len--)
847ddb9b612SMikolaj Golub 			sbuf_put_byte(s, c);
848ddb9b612SMikolaj Golub 	}
849ddb9b612SMikolaj Golub 	len = s->s_sect_len;
850ddb9b612SMikolaj Golub 	if (old_len == -1) {
851ddb9b612SMikolaj Golub 		s->s_sect_len = 0;
852ddb9b612SMikolaj Golub 		SBUF_CLEARFLAG(s, SBUF_INSECTION);
853ddb9b612SMikolaj Golub 	} else {
854ddb9b612SMikolaj Golub 		s->s_sect_len += old_len;
855ddb9b612SMikolaj Golub 	}
856ddb9b612SMikolaj Golub 	if (s->s_error != 0)
857ddb9b612SMikolaj Golub 		return (-1);
858ddb9b612SMikolaj Golub 	return (len);
859ddb9b612SMikolaj Golub }
860