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 */
119 CTASSERT(powerof2(SBUF_MAXEXTENDSIZE));
120 CTASSERT(powerof2(SBUF_MAXEXTENDINCR));
123 sbuf_extendsize(int size)
127 if (size < (int)SBUF_MAXEXTENDSIZE) {
128 newsize = SBUF_MINEXTENDSIZE;
129 while (newsize < size)
132 newsize = roundup2(size, SBUF_MAXEXTENDINCR);
134 KASSERT(newsize >= size, ("%s: %d < %d\n", __func__, newsize, size));
143 sbuf_extend(struct sbuf *s, int addlen)
148 if (!SBUF_CANEXTEND(s))
150 newsize = sbuf_extendsize(s->s_size + addlen);
151 newbuf = SBMALLOC(newsize);
154 bcopy(s->s_buf, newbuf, s->s_size);
155 if (SBUF_ISDYNAMIC(s))
158 SBUF_SETFLAG(s, SBUF_DYNAMIC);
165 * Initialize an sbuf.
166 * If buf is non-NULL, it points to a static or already-allocated string
167 * big enough to hold at least length characters.
170 sbuf_new(struct sbuf *s, char *buf, int length, int flags)
174 ("attempt to create an sbuf of negative length (%d)", length));
175 KASSERT((flags & ~SBUF_USRFLAGMSK) == 0,
176 ("%s called with invalid flags", __func__));
178 flags &= SBUF_USRFLAGMSK;
180 s = SBMALLOC(sizeof(*s));
183 bzero(s, sizeof(*s));
185 SBUF_SETFLAG(s, SBUF_DYNSTRUCT);
187 bzero(s, sizeof(*s));
195 if (flags & SBUF_AUTOEXTEND)
196 s->s_size = sbuf_extendsize(s->s_size);
197 s->s_buf = SBMALLOC(s->s_size);
198 if (s->s_buf == NULL) {
199 if (SBUF_ISDYNSTRUCT(s))
203 SBUF_SETFLAG(s, SBUF_DYNAMIC);
209 * Create an sbuf with uio data
212 sbuf_uionew(struct sbuf *s, struct uio *uio, int *error)
216 ("%s called with NULL uio pointer", __func__));
217 KASSERT(error != NULL,
218 ("%s called with NULL error pointer", __func__));
220 s = sbuf_new(s, NULL, uio->uio_resid + 1, 0);
225 *error = uiomove(s->s_buf, uio->uio_resid, uio);
230 s->s_len = s->s_size - 1;
237 * Clear an sbuf and reset its position.
240 sbuf_clear(struct sbuf *s)
243 assert_sbuf_integrity(s);
244 /* don't care if it's finished or not */
246 SBUF_CLEARFLAG(s, SBUF_FINISHED);
247 SBUF_CLEARFLAG(s, SBUF_OVERFLOWED);
252 * Set the sbuf's end position to an arbitrary value.
253 * Effectively truncates the sbuf at the new position.
256 sbuf_setpos(struct sbuf *s, int pos)
259 assert_sbuf_integrity(s);
260 assert_sbuf_state(s, 0);
263 ("attempt to seek to a negative position (%d)", pos));
264 KASSERT(pos < s->s_size,
265 ("attempt to seek past end of sbuf (%d >= %d)", pos, s->s_size));
267 if (pos < 0 || pos > s->s_len)
274 * Append a byte string to an sbuf.
277 sbuf_bcat(struct sbuf *s, const void *buf, size_t len)
279 const char *str = buf;
281 assert_sbuf_integrity(s);
282 assert_sbuf_state(s, 0);
284 if (SBUF_HASOVERFLOWED(s))
287 if (!SBUF_HASROOM(s) && sbuf_extend(s, len) < 0)
289 s->s_buf[s->s_len++] = *str++;
292 SBUF_SETFLAG(s, SBUF_OVERFLOWED);
300 * Copy a byte string from userland into an sbuf.
303 sbuf_bcopyin(struct sbuf *s, const void *uaddr, size_t len)
306 assert_sbuf_integrity(s);
307 assert_sbuf_state(s, 0);
309 if (SBUF_HASOVERFLOWED(s))
313 if (len > SBUF_FREESPACE(s)) {
314 sbuf_extend(s, len - SBUF_FREESPACE(s));
315 len = min(len, SBUF_FREESPACE(s));
317 if (copyin(uaddr, s->s_buf + s->s_len, len) != 0)
326 * Copy a byte string into an sbuf.
329 sbuf_bcpy(struct sbuf *s, const void *buf, size_t len)
332 assert_sbuf_integrity(s);
333 assert_sbuf_state(s, 0);
336 return (sbuf_bcat(s, buf, len));
340 * Append a string to an sbuf.
343 sbuf_cat(struct sbuf *s, const char *str)
346 assert_sbuf_integrity(s);
347 assert_sbuf_state(s, 0);
349 if (SBUF_HASOVERFLOWED(s))
353 if (!SBUF_HASROOM(s) && sbuf_extend(s, strlen(str)) < 0)
355 s->s_buf[s->s_len++] = *str++;
358 SBUF_SETFLAG(s, SBUF_OVERFLOWED);
366 * Append a string from userland to an sbuf.
369 sbuf_copyin(struct sbuf *s, const void *uaddr, size_t len)
373 assert_sbuf_integrity(s);
374 assert_sbuf_state(s, 0);
376 if (SBUF_HASOVERFLOWED(s))
380 len = SBUF_FREESPACE(s); /* XXX return 0? */
381 if (len > SBUF_FREESPACE(s)) {
383 len = min(len, SBUF_FREESPACE(s));
385 switch (copyinstr(uaddr, s->s_buf + s->s_len, len + 1, &done)) {
387 SBUF_SETFLAG(s, SBUF_OVERFLOWED);
390 s->s_len += done - 1;
393 return (-1); /* XXX */
401 * Copy a string into an sbuf.
404 sbuf_cpy(struct sbuf *s, const char *str)
407 assert_sbuf_integrity(s);
408 assert_sbuf_state(s, 0);
411 return (sbuf_cat(s, str));
415 * Format the given argument list and append the resulting string to an sbuf.
418 sbuf_vprintf(struct sbuf *s, const char *fmt, va_list ap)
423 assert_sbuf_integrity(s);
424 assert_sbuf_state(s, 0);
427 ("%s called with a NULL format string", __func__));
429 if (SBUF_HASOVERFLOWED(s))
433 va_copy(ap_copy, ap);
434 len = vsnprintf(&s->s_buf[s->s_len], SBUF_FREESPACE(s) + 1,
437 } while (len > SBUF_FREESPACE(s) &&
438 sbuf_extend(s, len - SBUF_FREESPACE(s)) == 0);
441 * s->s_len is the length of the string, without the terminating nul.
442 * When updating s->s_len, we must subtract 1 from the length that
443 * we passed into vsnprintf() because that length includes the
446 * vsnprintf() returns the amount that would have been copied,
447 * given sufficient space, hence the min() calculation below.
449 s->s_len += min(len, SBUF_FREESPACE(s));
450 if (!SBUF_HASROOM(s) && !SBUF_CANEXTEND(s))
451 SBUF_SETFLAG(s, SBUF_OVERFLOWED);
453 KASSERT(s->s_len < s->s_size,
454 ("wrote past end of sbuf (%d >= %d)", s->s_len, s->s_size));
456 if (SBUF_HASOVERFLOWED(s))
462 * Format the given arguments and append the resulting string to an sbuf.
465 sbuf_printf(struct sbuf *s, const char *fmt, ...)
471 result = sbuf_vprintf(s, fmt, ap);
477 * Append a character to an sbuf.
480 sbuf_putc(struct sbuf *s, int c)
483 assert_sbuf_integrity(s);
484 assert_sbuf_state(s, 0);
486 if (SBUF_HASOVERFLOWED(s))
488 if (!SBUF_HASROOM(s) && sbuf_extend(s, 1) < 0) {
489 SBUF_SETFLAG(s, SBUF_OVERFLOWED);
493 s->s_buf[s->s_len++] = c;
498 * Trim whitespace characters from end of an sbuf.
501 sbuf_trim(struct sbuf *s)
504 assert_sbuf_integrity(s);
505 assert_sbuf_state(s, 0);
507 if (SBUF_HASOVERFLOWED(s))
510 while (s->s_len && isspace(s->s_buf[s->s_len-1]))
517 * Check if an sbuf overflowed
520 sbuf_overflowed(struct sbuf *s)
523 return (SBUF_HASOVERFLOWED(s));
527 * Finish off an sbuf.
530 sbuf_finish(struct sbuf *s)
533 assert_sbuf_integrity(s);
534 assert_sbuf_state(s, 0);
536 s->s_buf[s->s_len] = '\0';
537 SBUF_CLEARFLAG(s, SBUF_OVERFLOWED);
538 SBUF_SETFLAG(s, SBUF_FINISHED);
542 * Return a pointer to the sbuf data.
545 sbuf_data(struct sbuf *s)
548 assert_sbuf_integrity(s);
549 assert_sbuf_state(s, SBUF_FINISHED);
555 * Return the length of the sbuf data.
558 sbuf_len(struct sbuf *s)
561 assert_sbuf_integrity(s);
562 /* don't care if it's finished or not */
564 if (SBUF_HASOVERFLOWED(s))
570 * Clear an sbuf, free its buffer if necessary.
573 sbuf_delete(struct sbuf *s)
577 assert_sbuf_integrity(s);
578 /* don't care if it's finished or not */
580 if (SBUF_ISDYNAMIC(s))
582 isdyn = SBUF_ISDYNSTRUCT(s);
583 bzero(s, sizeof(*s));
589 * Check if an sbuf has been finished.
592 sbuf_done(struct sbuf *s)
595 return (SBUF_ISFINISHED(s));