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
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
32 #include <sys/param.h>
35 #include <sys/ctype.h>
36 #include <sys/kernel.h>
37 #include <sys/malloc.h>
38 #include <sys/systm.h>
40 #include <machine/stdarg.h>
52 static MALLOC_DEFINE(M_SBUF, "sbuf", "string buffers");
53 #define SBMALLOC(size) malloc(size, M_SBUF, M_WAITOK)
54 #define SBFREE(buf) free(buf, M_SBUF)
57 #define SBMALLOC(size) malloc(size)
58 #define SBFREE(buf) free(buf)
59 #define min(x,y) MIN(x,y)
65 #define SBUF_ISDYNAMIC(s) ((s)->s_flags & SBUF_DYNAMIC)
66 #define SBUF_ISDYNSTRUCT(s) ((s)->s_flags & SBUF_DYNSTRUCT)
67 #define SBUF_ISFINISHED(s) ((s)->s_flags & SBUF_FINISHED)
68 #define SBUF_HASOVERFLOWED(s) ((s)->s_flags & SBUF_OVERFLOWED)
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)
76 #define SBUF_SETFLAG(s, f) do { (s)->s_flags |= (f); } while (0)
77 #define SBUF_CLEARFLAG(s, f) do { (s)->s_flags &= ~(f); } while (0)
79 #define SBUF_MINEXTENDSIZE 16 /* Should be power of 2. */
80 #define SBUF_MAXEXTENDSIZE PAGE_SIZE
81 #define SBUF_MAXEXTENDINCR PAGE_SIZE
86 #if defined(_KERNEL) && defined(INVARIANTS)
89 _assert_sbuf_integrity(const char *fun, struct sbuf *s)
93 ("%s called with a NULL sbuf pointer", fun));
94 KASSERT(s->s_buf != NULL,
95 ("%s called with uninitialized or corrupt sbuf", fun));
96 KASSERT(s->s_len < s->s_size,
97 ("wrote past end of sbuf (%d >= %d)", s->s_len, s->s_size));
101 _assert_sbuf_state(const char *fun, struct sbuf *s, int state)
104 KASSERT((s->s_flags & SBUF_FINISHED) == state,
105 ("%s called with %sfinished or corrupt sbuf", fun,
106 (state ? "un" : "")));
109 #define assert_sbuf_integrity(s) _assert_sbuf_integrity(__func__, (s))
110 #define assert_sbuf_state(s, i) _assert_sbuf_state(__func__, (s), (i))
112 #else /* _KERNEL && INVARIANTS */
114 #define assert_sbuf_integrity(s) do { } while (0)
115 #define assert_sbuf_state(s, i) do { } while (0)
117 #endif /* _KERNEL && INVARIANTS */
120 sbuf_extendsize(int size)
124 newsize = SBUF_MINEXTENDSIZE;
125 while (newsize < size) {
126 if (newsize < (int)SBUF_MAXEXTENDSIZE)
129 newsize += SBUF_MAXEXTENDINCR;
139 sbuf_extend(struct sbuf *s, int addlen)
144 if (!SBUF_CANEXTEND(s))
146 newsize = sbuf_extendsize(s->s_size + addlen);
147 newbuf = SBMALLOC(newsize);
150 bcopy(s->s_buf, newbuf, s->s_size);
151 if (SBUF_ISDYNAMIC(s))
154 SBUF_SETFLAG(s, SBUF_DYNAMIC);
161 * Initialize an sbuf.
162 * If buf is non-NULL, it points to a static or already-allocated string
163 * big enough to hold at least length characters.
166 sbuf_new(struct sbuf *s, char *buf, int length, int flags)
170 ("attempt to create an sbuf of negative length (%d)", length));
171 KASSERT((flags & ~SBUF_USRFLAGMSK) == 0,
172 ("%s called with invalid flags", __func__));
174 flags &= SBUF_USRFLAGMSK;
176 s = SBMALLOC(sizeof(*s));
179 bzero(s, sizeof(*s));
181 SBUF_SETFLAG(s, SBUF_DYNSTRUCT);
183 bzero(s, sizeof(*s));
191 if (flags & SBUF_AUTOEXTEND)
192 s->s_size = sbuf_extendsize(s->s_size);
193 s->s_buf = SBMALLOC(s->s_size);
194 if (s->s_buf == NULL) {
195 if (SBUF_ISDYNSTRUCT(s))
199 SBUF_SETFLAG(s, SBUF_DYNAMIC);
205 * Create an sbuf with uio data
208 sbuf_uionew(struct sbuf *s, struct uio *uio, int *error)
212 ("%s called with NULL uio pointer", __func__));
213 KASSERT(error != NULL,
214 ("%s called with NULL error pointer", __func__));
216 s = sbuf_new(s, NULL, uio->uio_resid + 1, 0);
221 *error = uiomove(s->s_buf, uio->uio_resid, uio);
226 s->s_len = s->s_size - 1;
233 * Clear an sbuf and reset its position.
236 sbuf_clear(struct sbuf *s)
239 assert_sbuf_integrity(s);
240 /* don't care if it's finished or not */
242 SBUF_CLEARFLAG(s, SBUF_FINISHED);
243 SBUF_CLEARFLAG(s, SBUF_OVERFLOWED);
248 * Set the sbuf's end position to an arbitrary value.
249 * Effectively truncates the sbuf at the new position.
252 sbuf_setpos(struct sbuf *s, int pos)
255 assert_sbuf_integrity(s);
256 assert_sbuf_state(s, 0);
259 ("attempt to seek to a negative position (%d)", pos));
260 KASSERT(pos < s->s_size,
261 ("attempt to seek past end of sbuf (%d >= %d)", pos, s->s_size));
263 if (pos < 0 || pos > s->s_len)
270 * Append a byte string to an sbuf.
273 sbuf_bcat(struct sbuf *s, const void *buf, size_t len)
275 const char *str = buf;
277 assert_sbuf_integrity(s);
278 assert_sbuf_state(s, 0);
280 if (SBUF_HASOVERFLOWED(s))
283 if (!SBUF_HASROOM(s) && sbuf_extend(s, len) < 0)
285 s->s_buf[s->s_len++] = *str++;
288 SBUF_SETFLAG(s, SBUF_OVERFLOWED);
296 * Copy a byte string from userland into an sbuf.
299 sbuf_bcopyin(struct sbuf *s, const void *uaddr, size_t len)
302 assert_sbuf_integrity(s);
303 assert_sbuf_state(s, 0);
305 if (SBUF_HASOVERFLOWED(s))
309 if (len > SBUF_FREESPACE(s)) {
310 sbuf_extend(s, len - SBUF_FREESPACE(s));
311 len = min(len, SBUF_FREESPACE(s));
313 if (copyin(uaddr, s->s_buf + s->s_len, len) != 0)
322 * Copy a byte string into an sbuf.
325 sbuf_bcpy(struct sbuf *s, const void *buf, size_t len)
328 assert_sbuf_integrity(s);
329 assert_sbuf_state(s, 0);
332 return (sbuf_bcat(s, buf, len));
336 * Append a string to an sbuf.
339 sbuf_cat(struct sbuf *s, const char *str)
342 assert_sbuf_integrity(s);
343 assert_sbuf_state(s, 0);
345 if (SBUF_HASOVERFLOWED(s))
349 if (!SBUF_HASROOM(s) && sbuf_extend(s, strlen(str)) < 0)
351 s->s_buf[s->s_len++] = *str++;
354 SBUF_SETFLAG(s, SBUF_OVERFLOWED);
362 * Append a string from userland to an sbuf.
365 sbuf_copyin(struct sbuf *s, const void *uaddr, size_t len)
369 assert_sbuf_integrity(s);
370 assert_sbuf_state(s, 0);
372 if (SBUF_HASOVERFLOWED(s))
376 len = SBUF_FREESPACE(s); /* XXX return 0? */
377 if (len > SBUF_FREESPACE(s)) {
379 len = min(len, SBUF_FREESPACE(s));
381 switch (copyinstr(uaddr, s->s_buf + s->s_len, len + 1, &done)) {
383 SBUF_SETFLAG(s, SBUF_OVERFLOWED);
386 s->s_len += done - 1;
389 return (-1); /* XXX */
397 * Copy a string into an sbuf.
400 sbuf_cpy(struct sbuf *s, const char *str)
403 assert_sbuf_integrity(s);
404 assert_sbuf_state(s, 0);
407 return (sbuf_cat(s, str));
411 * Format the given argument list and append the resulting string to an sbuf.
414 sbuf_vprintf(struct sbuf *s, const char *fmt, va_list ap)
419 assert_sbuf_integrity(s);
420 assert_sbuf_state(s, 0);
423 ("%s called with a NULL format string", __func__));
425 if (SBUF_HASOVERFLOWED(s))
429 va_copy(ap_copy, ap);
430 len = vsnprintf(&s->s_buf[s->s_len], SBUF_FREESPACE(s) + 1,
433 } while (len > SBUF_FREESPACE(s) &&
434 sbuf_extend(s, len - SBUF_FREESPACE(s)) == 0);
437 * s->s_len is the length of the string, without the terminating nul.
438 * When updating s->s_len, we must subtract 1 from the length that
439 * we passed into vsnprintf() because that length includes the
442 * vsnprintf() returns the amount that would have been copied,
443 * given sufficient space, hence the min() calculation below.
445 s->s_len += min(len, SBUF_FREESPACE(s));
446 if (!SBUF_HASROOM(s) && !SBUF_CANEXTEND(s))
447 SBUF_SETFLAG(s, SBUF_OVERFLOWED);
449 KASSERT(s->s_len < s->s_size,
450 ("wrote past end of sbuf (%d >= %d)", s->s_len, s->s_size));
452 if (SBUF_HASOVERFLOWED(s))
458 * Format the given arguments and append the resulting string to an sbuf.
461 sbuf_printf(struct sbuf *s, const char *fmt, ...)
467 result = sbuf_vprintf(s, fmt, ap);
473 * Append a character to an sbuf.
476 sbuf_putc(struct sbuf *s, int c)
479 assert_sbuf_integrity(s);
480 assert_sbuf_state(s, 0);
482 if (SBUF_HASOVERFLOWED(s))
484 if (!SBUF_HASROOM(s) && sbuf_extend(s, 1) < 0) {
485 SBUF_SETFLAG(s, SBUF_OVERFLOWED);
489 s->s_buf[s->s_len++] = c;
494 * Trim whitespace characters from end of an sbuf.
497 sbuf_trim(struct sbuf *s)
500 assert_sbuf_integrity(s);
501 assert_sbuf_state(s, 0);
503 if (SBUF_HASOVERFLOWED(s))
506 while (s->s_len && isspace(s->s_buf[s->s_len-1]))
513 * Check if an sbuf overflowed
516 sbuf_overflowed(struct sbuf *s)
519 return (SBUF_HASOVERFLOWED(s));
523 * Finish off an sbuf.
526 sbuf_finish(struct sbuf *s)
529 assert_sbuf_integrity(s);
530 assert_sbuf_state(s, 0);
532 s->s_buf[s->s_len] = '\0';
533 SBUF_CLEARFLAG(s, SBUF_OVERFLOWED);
534 SBUF_SETFLAG(s, SBUF_FINISHED);
538 * Return a pointer to the sbuf data.
541 sbuf_data(struct sbuf *s)
544 assert_sbuf_integrity(s);
545 assert_sbuf_state(s, SBUF_FINISHED);
551 * Return the length of the sbuf data.
554 sbuf_len(struct sbuf *s)
557 assert_sbuf_integrity(s);
558 /* don't care if it's finished or not */
560 if (SBUF_HASOVERFLOWED(s))
566 * Clear an sbuf, free its buffer if necessary.
569 sbuf_delete(struct sbuf *s)
573 assert_sbuf_integrity(s);
574 /* don't care if it's finished or not */
576 if (SBUF_ISDYNAMIC(s))
578 isdyn = SBUF_ISDYNSTRUCT(s);
579 bzero(s, sizeof(*s));
585 * Check if an sbuf has been finished.
588 sbuf_done(struct sbuf *s)
591 return (SBUF_ISFINISHED(s));