2 * Copyright (c) 2000-2008 Poul-Henning Kamp
3 * Copyright (c) 2000-2008 Dag-Erling Coïdan Smørgrav
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer
11 * in this position and unchanged.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * $FreeBSD: head/sys/kern/subr_sbuf.c 255805 2013-09-22 23:47:56Z des $
31 #include <sys/param.h>
34 #include <sys/ctype.h>
35 #include <sys/errno.h>
36 #include <sys/kernel.h>
37 #include <sys/malloc.h>
38 #include <sys/systm.h>
40 #include <machine/stdarg.h>
53 static MALLOC_DEFINE(M_SBUF, "sbuf", "string buffers");
54 #define SBMALLOC(size) kmalloc(size, M_SBUF, M_WAITOK|M_ZERO)
55 #define SBFREE(buf) kfree(buf, M_SBUF)
58 #define SBMALLOC(size) calloc(1, size)
59 #define SBFREE(buf) free(buf)
60 #define kvsnprintf vsnprintf
66 #define SBUF_ISDYNAMIC(s) ((s)->s_flags & SBUF_DYNAMIC)
67 #define SBUF_ISDYNSTRUCT(s) ((s)->s_flags & SBUF_DYNSTRUCT)
68 #define SBUF_ISFINISHED(s) ((s)->s_flags & SBUF_FINISHED)
69 #define SBUF_HASROOM(s) ((s)->s_len < (s)->s_size - 1)
70 #define SBUF_FREESPACE(s) ((s)->s_size - ((s)->s_len + 1))
71 #define SBUF_CANEXTEND(s) ((s)->s_flags & SBUF_AUTOEXTEND)
72 #define SBUF_ISSECTION(s) ((s)->s_flags & SBUF_INSECTION)
77 #define SBUF_SETFLAG(s, f) do { (s)->s_flags |= (f); } while (0)
78 #define SBUF_CLEARFLAG(s, f) do { (s)->s_flags &= ~(f); } while (0)
80 #define SBUF_MINEXTENDSIZE 16 /* Should be power of 2. */
83 #define SBUF_MAXEXTENDSIZE PAGE_SIZE
84 #define SBUF_MAXEXTENDINCR PAGE_SIZE
86 #define SBUF_MAXEXTENDSIZE 4096
87 #define SBUF_MAXEXTENDINCR 4096
93 #if defined(_KERNEL) && defined(INVARIANTS)
96 _assert_sbuf_integrity(const char *fun, struct sbuf *s)
100 ("%s called with a NULL sbuf pointer", fun));
101 KASSERT(s->s_buf != NULL,
102 ("%s called with uninitialized or corrupt sbuf", fun));
103 KASSERT(s->s_len < s->s_size,
104 ("wrote past end of sbuf (%jd >= %jd)",
105 (intmax_t)s->s_len, (intmax_t)s->s_size));
109 _assert_sbuf_state(const char *fun, struct sbuf *s, int state)
112 KASSERT((s->s_flags & SBUF_FINISHED) == state,
113 ("%s called with %sfinished or corrupt sbuf", fun,
114 (state ? "un" : "")));
117 #define assert_sbuf_integrity(s) _assert_sbuf_integrity(__func__, (s))
118 #define assert_sbuf_state(s, i) _assert_sbuf_state(__func__, (s), (i))
120 #else /* _KERNEL && INVARIANTS */
122 #define assert_sbuf_integrity(s) do { } while (0)
123 #define assert_sbuf_state(s, i) do { } while (0)
125 #endif /* _KERNEL && INVARIANTS */
128 CTASSERT(powerof2(SBUF_MAXEXTENDSIZE));
129 CTASSERT(powerof2(SBUF_MAXEXTENDINCR));
133 sbuf_extendsize(int size)
137 if (size < (int)SBUF_MAXEXTENDSIZE) {
138 newsize = SBUF_MINEXTENDSIZE;
139 while (newsize < size)
142 newsize = roundup2(size, SBUF_MAXEXTENDINCR);
144 KASSERT(newsize >= size, ("%s: %d < %d\n", __func__, newsize, size));
152 sbuf_extend(struct sbuf *s, int addlen)
157 if (!SBUF_CANEXTEND(s))
159 newsize = sbuf_extendsize(s->s_size + addlen);
160 newbuf = SBMALLOC(newsize);
163 memcpy(newbuf, s->s_buf, s->s_size);
164 if (SBUF_ISDYNAMIC(s))
167 SBUF_SETFLAG(s, SBUF_DYNAMIC);
174 * Initialize the internals of an sbuf.
175 * If buf is non-NULL, it points to a static or already-allocated string
176 * big enough to hold at least length characters.
179 sbuf_newbuf(struct sbuf *s, char *buf, int length, int flags)
182 memset(s, 0, sizeof(*s));
187 if ((s->s_flags & SBUF_AUTOEXTEND) == 0) {
188 KASSERT(s->s_size >= 0,
189 ("attempt to create a too small sbuf"));
192 if (s->s_buf != NULL)
195 if ((flags & SBUF_AUTOEXTEND) != 0)
196 s->s_size = sbuf_extendsize(s->s_size);
198 s->s_buf = SBMALLOC(s->s_size);
199 if (s->s_buf == NULL)
201 SBUF_SETFLAG(s, SBUF_DYNAMIC);
206 * Initialize an sbuf.
207 * If buf is non-NULL, it points to a static or already-allocated string
208 * big enough to hold at least length characters.
211 sbuf_new(struct sbuf *s, char *buf, int length, int flags)
215 ("attempt to create an sbuf of negative length (%d)", length));
216 KASSERT((flags & ~SBUF_USRFLAGMSK) == 0,
217 ("%s called with invalid flags", __func__));
219 flags &= SBUF_USRFLAGMSK;
221 return (sbuf_newbuf(s, buf, length, flags));
223 s = SBMALLOC(sizeof(*s));
226 if (sbuf_newbuf(s, buf, length, flags) == NULL) {
230 SBUF_SETFLAG(s, SBUF_DYNSTRUCT);
236 * Create an sbuf with uio data
239 sbuf_uionew(struct sbuf *s, struct uio *uio, int *error)
243 ("%s called with NULL uio pointer", __func__));
244 KASSERT(error != NULL,
245 ("%s called with NULL error pointer", __func__));
247 s = sbuf_new(s, NULL, uio->uio_resid + 1, 0);
252 *error = uiomove(s->s_buf, uio->uio_resid, uio);
257 s->s_len = s->s_size - 1;
258 if (SBUF_ISSECTION(s))
259 s->s_sect_len = s->s_size - 1;
266 * Clear an sbuf and reset its position.
269 sbuf_clear(struct sbuf *s)
272 assert_sbuf_integrity(s);
273 /* don't care if it's finished or not */
275 SBUF_CLEARFLAG(s, SBUF_FINISHED);
282 * Set the sbuf's end position to an arbitrary value.
283 * Effectively truncates the sbuf at the new position.
286 sbuf_setpos(struct sbuf *s, ssize_t pos)
289 assert_sbuf_integrity(s);
290 assert_sbuf_state(s, 0);
293 ("attempt to seek to a negative position (%jd)", (intmax_t)pos));
294 KASSERT(pos < s->s_size,
295 ("attempt to seek past end of sbuf (%jd >= %jd)",
296 (intmax_t)pos, (intmax_t)s->s_size));
297 KASSERT(!SBUF_ISSECTION(s),
298 ("attempt to seek when in a section"));
300 if (pos < 0 || pos > s->s_len)
307 * Set up a drain function and argument on an sbuf to flush data to
308 * when the sbuf buffer overflows.
311 sbuf_set_drain(struct sbuf *s, sbuf_drain_func *func, void *ctx)
314 assert_sbuf_state(s, 0);
315 assert_sbuf_integrity(s);
316 KASSERT(func == s->s_drain_func || s->s_len == 0,
317 ("Cannot change drain to %p on non-empty sbuf %p", func, s));
318 s->s_drain_func = func;
319 s->s_drain_arg = ctx;
323 * Call the drain and process the return.
326 sbuf_drain(struct sbuf *s)
330 KASSERT(s->s_len > 0, ("Shouldn't drain empty sbuf %p", s));
331 KASSERT(s->s_error == 0, ("Called %s with error on %p", __func__, s));
332 len = s->s_drain_func(s->s_drain_arg, s->s_buf, s->s_len);
337 KASSERT(len > 0 && len <= s->s_len,
338 ("Bad drain amount %d for sbuf %p", len, s));
341 * Fast path for the expected case where all the data was
347 * Move the remaining characters to the beginning of the
350 memmove(s->s_buf, s->s_buf + len, s->s_len);
355 * Append a byte to an sbuf. This is the core function for appending
356 * to an sbuf and is the main place that deals with extending the
357 * buffer and marking overflow.
360 sbuf_put_byte(struct sbuf *s, int c)
363 assert_sbuf_integrity(s);
364 assert_sbuf_state(s, 0);
368 if (SBUF_FREESPACE(s) <= 0) {
370 * If there is a drain, use it, otherwise extend the
373 if (s->s_drain_func != NULL)
375 else if (sbuf_extend(s, 1) < 0)
380 s->s_buf[s->s_len++] = c;
381 if (SBUF_ISSECTION(s))
386 * Append a byte string to an sbuf.
389 sbuf_bcat(struct sbuf *s, const void *buf, size_t len)
391 const char *str = buf;
392 const char *end = str + len;
394 assert_sbuf_integrity(s);
395 assert_sbuf_state(s, 0);
399 for (; str < end; str++) {
400 sbuf_put_byte(s, *str);
409 * Copy a byte string from userland into an sbuf.
412 sbuf_bcopyin(struct sbuf *s, const void *uaddr, size_t len)
415 assert_sbuf_integrity(s);
416 assert_sbuf_state(s, 0);
417 KASSERT(s->s_drain_func == NULL,
418 ("Nonsensical copyin to sbuf %p with a drain", s));
424 if (len > SBUF_FREESPACE(s)) {
425 sbuf_extend(s, len - SBUF_FREESPACE(s));
426 if (SBUF_FREESPACE(s) < len)
427 len = SBUF_FREESPACE(s);
429 if (copyin(uaddr, s->s_buf + s->s_len, len) != 0)
438 * Copy a byte string into an sbuf.
441 sbuf_bcpy(struct sbuf *s, const void *buf, size_t len)
444 assert_sbuf_integrity(s);
445 assert_sbuf_state(s, 0);
448 return (sbuf_bcat(s, buf, len));
452 * Append a string to an sbuf.
455 sbuf_cat(struct sbuf *s, const char *str)
458 assert_sbuf_integrity(s);
459 assert_sbuf_state(s, 0);
464 while (*str != '\0') {
465 sbuf_put_byte(s, *str++);
474 * Append a string from userland to an sbuf.
477 sbuf_copyin(struct sbuf *s, const void *uaddr, size_t len)
481 assert_sbuf_integrity(s);
482 assert_sbuf_state(s, 0);
483 KASSERT(s->s_drain_func == NULL,
484 ("Nonsensical copyin to sbuf %p with a drain", s));
490 len = SBUF_FREESPACE(s); /* XXX return 0? */
491 if (len > SBUF_FREESPACE(s)) {
493 if (SBUF_FREESPACE(s) < len)
494 len = SBUF_FREESPACE(s);
496 switch (copyinstr(uaddr, s->s_buf + s->s_len, len + 1, &done)) {
501 s->s_len += done - 1;
502 if (SBUF_ISSECTION(s))
503 s->s_sect_len += done - 1;
506 return (-1); /* XXX */
514 * Copy a string into an sbuf.
517 sbuf_cpy(struct sbuf *s, const char *str)
520 assert_sbuf_integrity(s);
521 assert_sbuf_state(s, 0);
524 return (sbuf_cat(s, str));
528 * Format the given argument list and append the resulting string to an sbuf.
533 * Append a non-NUL character to an sbuf. This prototype signature is
534 * suitable for use with kvcprintf(9).
537 sbuf_putc_func(int c, void *arg)
541 sbuf_put_byte(arg, c);
545 sbuf_vprintf(struct sbuf *s, const char *fmt, __va_list ap)
548 assert_sbuf_integrity(s);
549 assert_sbuf_state(s, 0);
552 ("%s called with a NULL format string", __func__));
554 (void)kvcprintf(fmt, sbuf_putc_func, s, 10, ap);
561 sbuf_vprintf(struct sbuf *s, const char *fmt, __va_list ap)
566 assert_sbuf_integrity(s);
567 assert_sbuf_state(s, 0);
570 ("%s called with a NULL format string", __func__));
576 * For the moment, there is no way to get vsnprintf(3) to hand
577 * back a character at a time, to push everything into
578 * sbuf_putc_func() as was done for the kernel.
580 * In userspace, while drains are useful, there's generally
581 * not a problem attempting to malloc(3) on out of space. So
582 * expand a userland sbuf if there is not enough room for the
583 * data produced by sbuf_[v]printf(3).
588 va_copy(ap_copy, ap);
589 len = vsnprintf(&s->s_buf[s->s_len], SBUF_FREESPACE(s) + 1,
593 if (SBUF_FREESPACE(s) >= len)
595 /* Cannot print with the current available space. */
596 if (s->s_drain_func != NULL && s->s_len > 0)
597 error = sbuf_drain(s);
599 error = sbuf_extend(s, len - SBUF_FREESPACE(s));
600 } while (error == 0);
603 * s->s_len is the length of the string, without the terminating nul.
604 * When updating s->s_len, we must subtract 1 from the length that
605 * we passed into vsnprintf() because that length includes the
608 * vsnprintf() returns the amount that would have been copied,
609 * given sufficient space, so don't over-increment s_len.
611 if (SBUF_FREESPACE(s) < len)
612 len = SBUF_FREESPACE(s);
614 if (SBUF_ISSECTION(s))
615 s->s_sect_len += len;
616 if (!SBUF_HASROOM(s) && !SBUF_CANEXTEND(s))
619 KASSERT(s->s_len < s->s_size,
620 ("wrote past end of sbuf (%d >= %d)", s->s_len, s->s_size));
629 * Format the given arguments and append the resulting string to an sbuf.
632 sbuf_printf(struct sbuf *s, const char *fmt, ...)
638 result = sbuf_vprintf(s, fmt, ap);
644 * Append a character to an sbuf.
647 sbuf_putc(struct sbuf *s, int c)
657 * Trim whitespace characters from end of an sbuf.
660 sbuf_trim(struct sbuf *s)
663 assert_sbuf_integrity(s);
664 assert_sbuf_state(s, 0);
665 KASSERT(s->s_drain_func == NULL,
666 ("%s makes no sense on sbuf %p with drain", __func__, s));
671 while (s->s_len > 0 && isspace(s->s_buf[s->s_len-1])) {
673 if (SBUF_ISSECTION(s))
681 * Check if an sbuf has an error.
684 sbuf_error(const struct sbuf *s)
691 * Finish off an sbuf.
694 sbuf_finish(struct sbuf *s)
697 assert_sbuf_integrity(s);
698 assert_sbuf_state(s, 0);
700 if (s->s_drain_func != NULL) {
701 while (s->s_len > 0 && s->s_error == 0)
702 s->s_error = sbuf_drain(s);
704 s->s_buf[s->s_len] = '\0';
705 SBUF_SETFLAG(s, SBUF_FINISHED);
709 if (s->s_error != 0) {
718 * Return a pointer to the sbuf data.
721 sbuf_data(struct sbuf *s)
724 assert_sbuf_integrity(s);
725 assert_sbuf_state(s, SBUF_FINISHED);
726 KASSERT(s->s_drain_func == NULL,
727 ("%s makes no sense on sbuf %p with drain", __func__, s));
733 * Return the length of the sbuf data.
736 sbuf_len(struct sbuf *s)
739 assert_sbuf_integrity(s);
740 /* don't care if it's finished or not */
741 KASSERT(s->s_drain_func == NULL,
742 ("%s makes no sense on sbuf %p with drain", __func__, s));
750 * Clear an sbuf, free its buffer if necessary.
753 sbuf_delete(struct sbuf *s)
757 assert_sbuf_integrity(s);
758 /* don't care if it's finished or not */
760 if (SBUF_ISDYNAMIC(s))
762 isdyn = SBUF_ISDYNSTRUCT(s);
763 memset(s, 0, sizeof(*s));
769 * Check if an sbuf has been finished.
772 sbuf_done(const struct sbuf *s)
775 return (SBUF_ISFINISHED(s));
782 sbuf_start_section(struct sbuf *s, ssize_t *old_lenp)
785 assert_sbuf_integrity(s);
786 assert_sbuf_state(s, 0);
788 if (!SBUF_ISSECTION(s)) {
789 KASSERT(s->s_sect_len == 0,
790 ("s_sect_len != 0 when starting a section"));
791 if (old_lenp != NULL)
793 SBUF_SETFLAG(s, SBUF_INSECTION);
795 KASSERT(old_lenp != NULL,
796 ("s_sect_len should be saved when starting a subsection"));
797 *old_lenp = s->s_sect_len;
803 * End the section padding to the specified length with the specified
807 sbuf_end_section(struct sbuf *s, ssize_t old_len, size_t pad, int c)
811 assert_sbuf_integrity(s);
812 assert_sbuf_state(s, 0);
813 KASSERT(SBUF_ISSECTION(s),
814 ("attempt to end a section when not in a section"));
817 len = roundup(s->s_sect_len, pad) - s->s_sect_len;
818 for (; s->s_error == 0 && len > 0; len--)
824 SBUF_CLEARFLAG(s, SBUF_INSECTION);
826 s->s_sect_len += old_len;