sys/kern/subr_sbuf.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2000-2008 Poul-Henning Kamp
   5  * Copyright (c) 2000-2008 Dag-Erling Coïdan Smørgrav
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer
  13  *    in this position and unchanged.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28  * SUCH DAMAGE.
  29  */
  30
  31 #include <sys/cdefs.h>
  32 __FBSDID("$FreeBSD$");
  33
  34 #include <sys/param.h>
  35
  36 #ifdef _KERNEL
  37 #include <sys/ctype.h>
  38 #include <sys/errno.h>
  39 #include <sys/kernel.h>
  40 #include <sys/limits.h>
  41 #include <sys/malloc.h>
  42 #include <sys/systm.h>
  43 #include <sys/uio.h>
  44 #include <machine/stdarg.h>
  45 #else /* _KERNEL */
  46 #include <ctype.h>
  47 #include <errno.h>
  48 #include <limits.h>
  49 #include <stdarg.h>
  50 #include <stdio.h>
  51 #include <stdlib.h>
  52 #include <string.h>
  53 #endif /* _KERNEL */
  54
  55 #include <sys/sbuf.h>
  56
  57 #ifdef _KERNEL
  58 static MALLOC_DEFINE(M_SBUF, "sbuf", "string buffers");
  59 #define SBMALLOC(size, flags)   malloc(size, M_SBUF, (flags) | M_ZERO)
  60 #define SBFREE(buf)             free(buf, M_SBUF)
  61 #else /* _KERNEL */
  62 #define KASSERT(e, m)
  63 #define SBMALLOC(size, flags)   calloc(1, size)
  64 #define SBFREE(buf)             free(buf)
  65 #endif /* _KERNEL */
  66
  67 /*
  68  * Predicates
  69  */
  70 #define SBUF_ISDYNAMIC(s)       ((s)->s_flags & SBUF_DYNAMIC)
  71 #define SBUF_ISDYNSTRUCT(s)     ((s)->s_flags & SBUF_DYNSTRUCT)
  72 #define SBUF_ISFINISHED(s)      ((s)->s_flags & SBUF_FINISHED)
  73 #define SBUF_HASROOM(s)         ((s)->s_len < (s)->s_size - 1)
  74 #define SBUF_FREESPACE(s)       ((s)->s_size - ((s)->s_len + 1))
  75 #define SBUF_CANEXTEND(s)       ((s)->s_flags & SBUF_AUTOEXTEND)
  76 #define SBUF_ISSECTION(s)       ((s)->s_flags & SBUF_INSECTION)
  77 #define SBUF_NULINCLUDED(s)     ((s)->s_flags & SBUF_INCLUDENUL)
  78 #define SBUF_ISDRAINTOEOR(s)    ((s)->s_flags & SBUF_DRAINTOEOR)
  79 #define SBUF_DODRAINTOEOR(s)    (SBUF_ISSECTION(s) && SBUF_ISDRAINTOEOR(s))
  80 #define SBUF_MALLOCFLAG(s)      \
  81         (((s)->s_flags & SBUF_NOWAIT) ? M_NOWAIT : M_WAITOK)
  82
  83 /*
  84  * Set / clear flags
  85  */
  86 #define SBUF_SETFLAG(s, f)      do { (s)->s_flags |= (f); } while (0)
  87 #define SBUF_CLEARFLAG(s, f)    do { (s)->s_flags &= ~(f); } while (0)
  88
  89 #define SBUF_MINSIZE             2              /* Min is 1 byte + nulterm. */
  90 #define SBUF_MINEXTENDSIZE      16              /* Should be power of 2. */
  91
  92 #ifdef PAGE_SIZE
  93 #define SBUF_MAXEXTENDSIZE      PAGE_SIZE
  94 #define SBUF_MAXEXTENDINCR      PAGE_SIZE
  95 #else
  96 #define SBUF_MAXEXTENDSIZE      4096
  97 #define SBUF_MAXEXTENDINCR      4096
  98 #endif
  99
 100 /*
 101  * Debugging support
 102  */
 103 #if defined(_KERNEL) && defined(INVARIANTS)
 104
 105 static void
 106 _assert_sbuf_integrity(const char *fun, struct sbuf *s)
 107 {
 108
 109         KASSERT(s != NULL,
 110             ("%s called with a NULL sbuf pointer", fun));
 111         KASSERT(s->s_buf != NULL,
 112             ("%s called with uninitialized or corrupt sbuf", fun));
 113         if (SBUF_ISFINISHED(s) && SBUF_NULINCLUDED(s)) {
 114                 KASSERT(s->s_len <= s->s_size,
 115                     ("wrote past end of sbuf (%jd >= %jd)",
 116                     (intmax_t)s->s_len, (intmax_t)s->s_size));
 117         } else {
 118                 KASSERT(s->s_len < s->s_size,
 119                     ("wrote past end of sbuf (%jd >= %jd)",
 120                     (intmax_t)s->s_len, (intmax_t)s->s_size));
 121         }
 122 }
 123
 124 static void
 125 _assert_sbuf_state(const char *fun, struct sbuf *s, int state)
 126 {
 127
 128         KASSERT((s->s_flags & SBUF_FINISHED) == state,
 129             ("%s called with %sfinished or corrupt sbuf", fun,
 130             (state ? "un" : "")));
 131 }
 132
 133 #define assert_sbuf_integrity(s) _assert_sbuf_integrity(__func__, (s))
 134 #define assert_sbuf_state(s, i)  _assert_sbuf_state(__func__, (s), (i))
 135
 136 #else /* _KERNEL && INVARIANTS */
 137
 138 #define assert_sbuf_integrity(s) do { } while (0)
 139 #define assert_sbuf_state(s, i)  do { } while (0)
 140
 141 #endif /* _KERNEL && INVARIANTS */
 142
 143 #ifdef CTASSERT
 144 CTASSERT(powerof2(SBUF_MAXEXTENDSIZE));
 145 CTASSERT(powerof2(SBUF_MAXEXTENDINCR));
 146 #endif
 147
 148 static int
 149 sbuf_extendsize(int size)
 150 {
 151         int newsize;
 152
 153         if (size < (int)SBUF_MAXEXTENDSIZE) {
 154                 newsize = SBUF_MINEXTENDSIZE;
 155                 while (newsize < size)
 156                         newsize *= 2;
 157         } else {
 158                 newsize = roundup2(size, SBUF_MAXEXTENDINCR);
 159         }
 160         KASSERT(newsize >= size, ("%s: %d < %d\n", __func__, newsize, size));
 161         return (newsize);
 162 }
 163
 164 /*
 165  * Extend an sbuf.
 166  */
 167 static int
 168 sbuf_extend(struct sbuf *s, int addlen)
 169 {
 170         char *newbuf;
 171         int newsize;
 172
 173         if (!SBUF_CANEXTEND(s))
 174                 return (-1);
 175         newsize = sbuf_extendsize(s->s_size + addlen);
 176         newbuf = SBMALLOC(newsize, SBUF_MALLOCFLAG(s));
 177         if (newbuf == NULL)
 178                 return (-1);
 179         memcpy(newbuf, s->s_buf, s->s_size);
 180         if (SBUF_ISDYNAMIC(s))
 181                 SBFREE(s->s_buf);
 182         else
 183                 SBUF_SETFLAG(s, SBUF_DYNAMIC);
 184         s->s_buf = newbuf;
 185         s->s_size = newsize;
 186         return (0);
 187 }
 188
 189 /*
 190  * Initialize the internals of an sbuf.
 191  * If buf is non-NULL, it points to a static or already-allocated string
 192  * big enough to hold at least length characters.
 193  */
 194 static struct sbuf *
 195 sbuf_newbuf(struct sbuf *s, char *buf, int length, int flags)
 196 {
 197
 198         memset(s, 0, sizeof(*s));
 199         s->s_flags = flags;
 200         s->s_size = length;
 201         s->s_buf = buf;
 202
 203         if (!SBUF_CANEXTEND(s)) {
 204                 KASSERT(s->s_size >= SBUF_MINSIZE,
 205                     ("attempt to create an sbuf smaller than %d bytes",
 206                     SBUF_MINSIZE));
 207         }
 208
 209         if (s->s_buf != NULL)
 210                 return (s);
 211
 212         if (SBUF_CANEXTEND(s))
 213                 s->s_size = sbuf_extendsize(s->s_size);
 214
 215         s->s_buf = SBMALLOC(s->s_size, SBUF_MALLOCFLAG(s));
 216         if (s->s_buf == NULL)
 217                 return (NULL);
 218         SBUF_SETFLAG(s, SBUF_DYNAMIC);
 219         return (s);
 220 }
 221
 222 /*
 223  * Initialize an sbuf.
 224  * If buf is non-NULL, it points to a static or already-allocated string
 225  * big enough to hold at least length characters.
 226  */
 227 struct sbuf *
 228 sbuf_new(struct sbuf *s, char *buf, int length, int flags)
 229 {
 230
 231         KASSERT(length >= 0,
 232             ("attempt to create an sbuf of negative length (%d)", length));
 233         KASSERT((flags & ~SBUF_USRFLAGMSK) == 0,
 234             ("%s called with invalid flags", __func__));
 235
 236         flags &= SBUF_USRFLAGMSK;
 237         if (s != NULL)
 238                 return (sbuf_newbuf(s, buf, length, flags));
 239
 240         s = SBMALLOC(sizeof(*s), (flags & SBUF_NOWAIT) ? M_NOWAIT : M_WAITOK);
 241         if (s == NULL)
 242                 return (NULL);
 243         if (sbuf_newbuf(s, buf, length, flags) == NULL) {
 244                 SBFREE(s);
 245                 return (NULL);
 246         }
 247         SBUF_SETFLAG(s, SBUF_DYNSTRUCT);
 248         return (s);
 249 }
 250
 251 #ifdef _KERNEL
 252 /*
 253  * Create an sbuf with uio data
 254  */
 255 struct sbuf *
 256 sbuf_uionew(struct sbuf *s, struct uio *uio, int *error)
 257 {
 258
 259         KASSERT(uio != NULL,
 260             ("%s called with NULL uio pointer", __func__));
 261         KASSERT(error != NULL,
 262             ("%s called with NULL error pointer", __func__));
 263
 264         if (uio->uio_resid >= INT_MAX || uio->uio_resid < SBUF_MINSIZE - 1) {
 265                 *error = EINVAL;
 266                 return (NULL);
 267         }
 268         s = sbuf_new(s, NULL, uio->uio_resid + 1, 0);
 269         if (s == NULL) {
 270                 *error = ENOMEM;
 271                 return (NULL);
 272         }
 273         *error = uiomove(s->s_buf, uio->uio_resid, uio);
 274         if (*error != 0) {
 275                 sbuf_delete(s);
 276                 return (NULL);
 277         }
 278         s->s_len = s->s_size - 1;
 279         if (SBUF_ISSECTION(s))
 280                 s->s_sect_len = s->s_size - 1;
 281         *error = 0;
 282         return (s);
 283 }
 284 #endif
 285
 286 int
 287 sbuf_get_flags(struct sbuf *s)
 288 {
 289
 290         return (s->s_flags & SBUF_USRFLAGMSK);
 291 }
 292
 293 void
 294 sbuf_clear_flags(struct sbuf *s, int flags)
 295 {
 296
 297         s->s_flags &= ~(flags & SBUF_USRFLAGMSK);
 298 }
 299
 300 void
 301 sbuf_set_flags(struct sbuf *s, int flags)
 302 {
 303
 304
 305         s->s_flags |= (flags & SBUF_USRFLAGMSK);
 306 }
 307
 308 /*
 309  * Clear an sbuf and reset its position.
 310  */
 311 void
 312 sbuf_clear(struct sbuf *s)
 313 {
 314
 315         assert_sbuf_integrity(s);
 316         /* don't care if it's finished or not */
 317
 318         SBUF_CLEARFLAG(s, SBUF_FINISHED);
 319         s->s_error = 0;
 320         s->s_len = 0;
 321         s->s_rec_off = 0;
 322         s->s_sect_len = 0;
 323 }
 324
 325 /*
 326  * Set the sbuf's end position to an arbitrary value.
 327  * Effectively truncates the sbuf at the new position.
 328  */
 329 int
 330 sbuf_setpos(struct sbuf *s, ssize_t pos)
 331 {
 332
 333         assert_sbuf_integrity(s);
 334         assert_sbuf_state(s, 0);
 335
 336         KASSERT(pos >= 0,
 337             ("attempt to seek to a negative position (%jd)", (intmax_t)pos));
 338         KASSERT(pos < s->s_size,
 339             ("attempt to seek past end of sbuf (%jd >= %jd)",
 340             (intmax_t)pos, (intmax_t)s->s_size));
 341         KASSERT(!SBUF_ISSECTION(s),
 342             ("attempt to seek when in a section"));
 343
 344         if (pos < 0 || pos > s->s_len)
 345                 return (-1);
 346         s->s_len = pos;
 347         return (0);
 348 }
 349
 350 /*
 351  * Drain into a counter.  Counts amount of data without producing output.
 352  * Useful for cases like sysctl, where user may first request only size.
 353  * This allows to avoid pointless allocation/freeing of large buffers.
 354  */
 355 int
 356 sbuf_count_drain(void *arg, const char *data __unused, int len)
 357 {
 358         size_t *sizep;
 359
 360         sizep = (size_t *)arg;
 361         *sizep += len;
 362         return (len);
 363 }
 364
 365 /*
 366  * Set up a drain function and argument on an sbuf to flush data to
 367  * when the sbuf buffer overflows.
 368  */
 369 void
 370 sbuf_set_drain(struct sbuf *s, sbuf_drain_func *func, void *ctx)
 371 {
 372
 373         assert_sbuf_state(s, 0);
 374         assert_sbuf_integrity(s);
 375         KASSERT(func == s->s_drain_func || s->s_len == 0,
 376             ("Cannot change drain to %p on non-empty sbuf %p", func, s));
 377         s->s_drain_func = func;
 378         s->s_drain_arg = ctx;
 379 }
 380
 381 /*
 382  * Call the drain and process the return.
 383  */
 384 int
 385 sbuf_drain(struct sbuf *s)
 386 {
 387         int len;
 388
 389         /*
 390          * Immediately return when no work to do,
 391          * or an error has already been accumulated.
 392          */
 393         if ((s->s_len == 0) || (s->s_error != 0))
 394                 return(s->s_error);
 395
 396         if (SBUF_DODRAINTOEOR(s) && s->s_rec_off == 0)
 397                 return (s->s_error = EDEADLK);
 398         len = s->s_drain_func(s->s_drain_arg, s->s_buf,
 399             SBUF_DODRAINTOEOR(s) ? s->s_rec_off : s->s_len);
 400         if (len <= 0) {
 401                 s->s_error = len ? -len : EDEADLK;
 402                 return (s->s_error);
 403         }
 404         KASSERT(len > 0 && len <= s->s_len,
 405             ("Bad drain amount %d for sbuf %p", len, s));
 406         s->s_len -= len;
 407         s->s_rec_off -= len;
 408         /*
 409          * Fast path for the expected case where all the data was
 410          * drained.
 411          */
 412         if (s->s_len == 0)
 413                 return (0);
 414         /*
 415          * Move the remaining characters to the beginning of the
 416          * string.
 417          */
 418         memmove(s->s_buf, s->s_buf + len, s->s_len);
 419         return (0);
 420 }
 421
 422 /*
 423  * Append bytes to an sbuf.  This is the core function for appending
 424  * to an sbuf and is the main place that deals with extending the
 425  * buffer and marking overflow.
 426  */
 427 static void
 428 sbuf_put_bytes(struct sbuf *s, const char *buf, size_t len)
 429 {
 430         size_t n;
 431
 432         assert_sbuf_integrity(s);
 433         assert_sbuf_state(s, 0);
 434
 435         if (s->s_error != 0)
 436                 return;
 437         while (len > 0) {
 438                 if (SBUF_FREESPACE(s) <= 0) {
 439                         /*
 440                          * If there is a drain, use it, otherwise extend the
 441                          * buffer.
 442                          */
 443                         if (s->s_drain_func != NULL)
 444                                 (void)sbuf_drain(s);
 445                         else if (sbuf_extend(s, len > INT_MAX ? INT_MAX : len)
 446                             < 0)
 447                                 s->s_error = ENOMEM;
 448                         if (s->s_error != 0)
 449                                 return;
 450                 }
 451                 n = SBUF_FREESPACE(s);
 452                 if (len < n)
 453                         n = len;
 454                 memcpy(&s->s_buf[s->s_len], buf, n);
 455                 s->s_len += n;
 456                 if (SBUF_ISSECTION(s))
 457                         s->s_sect_len += n;
 458                 len -= n;
 459                 buf += n;
 460         }
 461 }
 462
 463 static void
 464 sbuf_put_byte(struct sbuf *s, char c)
 465 {
 466
 467         sbuf_put_bytes(s, &c, 1);
 468 }
 469
 470 /*
 471  * Append a byte string to an sbuf.
 472  */
 473 int
 474 sbuf_bcat(struct sbuf *s, const void *buf, size_t len)
 475 {
 476
 477         sbuf_put_bytes(s, buf, len);
 478         if (s->s_error != 0)
 479                 return (-1);
 480         return (0);
 481 }
 482
 483 #ifdef _KERNEL
 484 /*
 485  * Copy a byte string from userland into an sbuf.
 486  */
 487 int
 488 sbuf_bcopyin(struct sbuf *s, const void *uaddr, size_t len)
 489 {
 490
 491         assert_sbuf_integrity(s);
 492         assert_sbuf_state(s, 0);
 493         KASSERT(s->s_drain_func == NULL,
 494             ("Nonsensical copyin to sbuf %p with a drain", s));
 495
 496         if (s->s_error != 0)
 497                 return (-1);
 498         if (len == 0)
 499                 return (0);
 500         if (len > SBUF_FREESPACE(s)) {
 501                 sbuf_extend(s, len - SBUF_FREESPACE(s));
 502                 if (SBUF_FREESPACE(s) < len)
 503                         len = SBUF_FREESPACE(s);
 504         }
 505         if (copyin(uaddr, s->s_buf + s->s_len, len) != 0)
 506                 return (-1);
 507         s->s_len += len;
 508
 509         return (0);
 510 }
 511 #endif
 512
 513 /*
 514  * Copy a byte string into an sbuf.
 515  */
 516 int
 517 sbuf_bcpy(struct sbuf *s, const void *buf, size_t len)
 518 {
 519
 520         assert_sbuf_integrity(s);
 521         assert_sbuf_state(s, 0);
 522
 523         sbuf_clear(s);
 524         return (sbuf_bcat(s, buf, len));
 525 }
 526
 527 /*
 528  * Append a string to an sbuf.
 529  */
 530 int
 531 sbuf_cat(struct sbuf *s, const char *str)
 532 {
 533         size_t n;
 534
 535         n = strlen(str);
 536         sbuf_put_bytes(s, str, n);
 537         if (s->s_error != 0)
 538                 return (-1);
 539         return (0);
 540 }
 541
 542 #ifdef _KERNEL
 543 /*
 544  * Append a string from userland to an sbuf.
 545  */
 546 int
 547 sbuf_copyin(struct sbuf *s, const void *uaddr, size_t len)
 548 {
 549         size_t done;
 550
 551         assert_sbuf_integrity(s);
 552         assert_sbuf_state(s, 0);
 553         KASSERT(s->s_drain_func == NULL,
 554             ("Nonsensical copyin to sbuf %p with a drain", s));
 555
 556         if (s->s_error != 0)
 557                 return (-1);
 558
 559         if (len == 0)
 560                 len = SBUF_FREESPACE(s);        /* XXX return 0? */
 561         if (len > SBUF_FREESPACE(s)) {
 562                 sbuf_extend(s, len);
 563                 if (SBUF_FREESPACE(s) < len)
 564                         len = SBUF_FREESPACE(s);
 565         }
 566         switch (copyinstr(uaddr, s->s_buf + s->s_len, len + 1, &done)) {
 567         case ENAMETOOLONG:
 568                 s->s_error = ENOMEM;
 569                 /* fall through */
 570         case 0:
 571                 s->s_len += done - 1;
 572                 if (SBUF_ISSECTION(s))
 573                         s->s_sect_len += done - 1;
 574                 break;
 575         default:
 576                 return (-1);    /* XXX */
 577         }
 578
 579         return (done);
 580 }
 581 #endif
 582
 583 /*
 584  * Copy a string into an sbuf.
 585  */
 586 int
 587 sbuf_cpy(struct sbuf *s, const char *str)
 588 {
 589
 590         assert_sbuf_integrity(s);
 591         assert_sbuf_state(s, 0);
 592
 593         sbuf_clear(s);
 594         return (sbuf_cat(s, str));
 595 }
 596
 597 /*
 598  * Format the given argument list and append the resulting string to an sbuf.
 599  */
 600 #ifdef _KERNEL
 601
 602 /*
 603  * Append a non-NUL character to an sbuf.  This prototype signature is
 604  * suitable for use with kvprintf(9).
 605  */
 606 static void
 607 sbuf_putc_func(int c, void *arg)
 608 {
 609
 610         if (c != '\0')
 611                 sbuf_put_byte(arg, c);
 612 }
 613
 614 int
 615 sbuf_vprintf(struct sbuf *s, const char *fmt, va_list ap)
 616 {
 617
 618         assert_sbuf_integrity(s);
 619         assert_sbuf_state(s, 0);
 620
 621         KASSERT(fmt != NULL,
 622             ("%s called with a NULL format string", __func__));
 623
 624         (void)kvprintf(fmt, sbuf_putc_func, s, 10, ap);
 625         if (s->s_error != 0)
 626                 return (-1);
 627         return (0);
 628 }
 629 #else /* !_KERNEL */
 630 int
 631 sbuf_vprintf(struct sbuf *s, const char *fmt, va_list ap)
 632 {
 633         va_list ap_copy;
 634         int error, len;
 635
 636         assert_sbuf_integrity(s);
 637         assert_sbuf_state(s, 0);
 638
 639         KASSERT(fmt != NULL,
 640             ("%s called with a NULL format string", __func__));
 641
 642         if (s->s_error != 0)
 643                 return (-1);
 644
 645         /*
 646          * For the moment, there is no way to get vsnprintf(3) to hand
 647          * back a character at a time, to push everything into
 648          * sbuf_putc_func() as was done for the kernel.
 649          *
 650          * In userspace, while drains are useful, there's generally
 651          * not a problem attempting to malloc(3) on out of space.  So
 652          * expand a userland sbuf if there is not enough room for the
 653          * data produced by sbuf_[v]printf(3).
 654          */
 655
 656         error = 0;
 657         do {
 658                 va_copy(ap_copy, ap);
 659                 len = vsnprintf(&s->s_buf[s->s_len], SBUF_FREESPACE(s) + 1,
 660                     fmt, ap_copy);
 661                 if (len < 0) {
 662                         s->s_error = errno;
 663                         return (-1);
 664                 }
 665                 va_end(ap_copy);
 666
 667                 if (SBUF_FREESPACE(s) >= len)
 668                         break;
 669                 /* Cannot print with the current available space. */
 670                 if (s->s_drain_func != NULL && s->s_len > 0)
 671                         error = sbuf_drain(s); /* sbuf_drain() sets s_error. */
 672                 else if (sbuf_extend(s, len - SBUF_FREESPACE(s)) != 0)
 673                         s->s_error = error = ENOMEM;
 674         } while (error == 0);
 675
 676         /*
 677          * s->s_len is the length of the string, without the terminating nul.
 678          * When updating s->s_len, we must subtract 1 from the length that
 679          * we passed into vsnprintf() because that length includes the
 680          * terminating nul.
 681          *
 682          * vsnprintf() returns the amount that would have been copied,
 683          * given sufficient space, so don't over-increment s_len.
 684          */
 685         if (SBUF_FREESPACE(s) < len)
 686                 len = SBUF_FREESPACE(s);
 687         s->s_len += len;
 688         if (SBUF_ISSECTION(s))
 689                 s->s_sect_len += len;
 690
 691         KASSERT(s->s_len < s->s_size,
 692             ("wrote past end of sbuf (%d >= %d)", s->s_len, s->s_size));
 693
 694         if (s->s_error != 0)
 695                 return (-1);
 696         return (0);
 697 }
 698 #endif /* _KERNEL */
 699
 700 /*
 701  * Format the given arguments and append the resulting string to an sbuf.
 702  */
 703 int
 704 sbuf_printf(struct sbuf *s, const char *fmt, ...)
 705 {
 706         va_list ap;
 707         int result;
 708
 709         va_start(ap, fmt);
 710         result = sbuf_vprintf(s, fmt, ap);
 711         va_end(ap);
 712         return (result);
 713 }
 714
 715 /*
 716  * Append a character to an sbuf.
 717  */
 718 int
 719 sbuf_putc(struct sbuf *s, int c)
 720 {
 721
 722         sbuf_put_byte(s, c);
 723         if (s->s_error != 0)
 724                 return (-1);
 725         return (0);
 726 }
 727
 728 /*
 729  * Trim whitespace characters from end of an sbuf.
 730  */
 731 int
 732 sbuf_trim(struct sbuf *s)
 733 {
 734
 735         assert_sbuf_integrity(s);
 736         assert_sbuf_state(s, 0);
 737         KASSERT(s->s_drain_func == NULL,
 738             ("%s makes no sense on sbuf %p with drain", __func__, s));
 739
 740         if (s->s_error != 0)
 741                 return (-1);
 742
 743         while (s->s_len > 0 && isspace(s->s_buf[s->s_len-1])) {
 744                 --s->s_len;
 745                 if (SBUF_ISSECTION(s))
 746                         s->s_sect_len--;
 747         }
 748
 749         return (0);
 750 }
 751
 752 /*
 753  * Check if an sbuf has an error.
 754  */
 755 int
 756 sbuf_error(const struct sbuf *s)
 757 {
 758
 759         return (s->s_error);
 760 }
 761
 762 /*
 763  * Finish off an sbuf.
 764  */
 765 int
 766 sbuf_finish(struct sbuf *s)
 767 {
 768
 769         assert_sbuf_integrity(s);
 770         assert_sbuf_state(s, 0);
 771
 772         s->s_buf[s->s_len] = '\0';
 773         if (SBUF_NULINCLUDED(s))
 774                 s->s_len++;
 775         if (s->s_drain_func != NULL) {
 776                 while (s->s_len > 0 && s->s_error == 0)
 777                         s->s_error = sbuf_drain(s);
 778         }
 779         SBUF_SETFLAG(s, SBUF_FINISHED);
 780 #ifdef _KERNEL
 781         return (s->s_error);
 782 #else
 783         if (s->s_error != 0) {
 784                 errno = s->s_error;
 785                 return (-1);
 786         }
 787         return (0);
 788 #endif
 789 }
 790
 791 /*
 792  * Return a pointer to the sbuf data.
 793  */
 794 char *
 795 sbuf_data(struct sbuf *s)
 796 {
 797
 798         assert_sbuf_integrity(s);
 799         assert_sbuf_state(s, SBUF_FINISHED);
 800         KASSERT(s->s_drain_func == NULL,
 801             ("%s makes no sense on sbuf %p with drain", __func__, s));
 802
 803         return (s->s_buf);
 804 }
 805
 806 /*
 807  * Return the length of the sbuf data.
 808  */
 809 ssize_t
 810 sbuf_len(struct sbuf *s)
 811 {
 812
 813         assert_sbuf_integrity(s);
 814         /* don't care if it's finished or not */
 815         KASSERT(s->s_drain_func == NULL,
 816             ("%s makes no sense on sbuf %p with drain", __func__, s));
 817
 818         if (s->s_error != 0)
 819                 return (-1);
 820
 821         /* If finished, nulterm is already in len, else add one. */
 822         if (SBUF_NULINCLUDED(s) && !SBUF_ISFINISHED(s))
 823                 return (s->s_len + 1);
 824         return (s->s_len);
 825 }
 826
 827 /*
 828  * Clear an sbuf, free its buffer if necessary.
 829  */
 830 void
 831 sbuf_delete(struct sbuf *s)
 832 {
 833         int isdyn;
 834
 835         assert_sbuf_integrity(s);
 836         /* don't care if it's finished or not */
 837
 838         if (SBUF_ISDYNAMIC(s))
 839                 SBFREE(s->s_buf);
 840         isdyn = SBUF_ISDYNSTRUCT(s);
 841         memset(s, 0, sizeof(*s));
 842         if (isdyn)
 843                 SBFREE(s);
 844 }
 845
 846 /*
 847  * Check if an sbuf has been finished.
 848  */
 849 int
 850 sbuf_done(const struct sbuf *s)
 851 {
 852
 853         return (SBUF_ISFINISHED(s));
 854 }
 855
 856 /*
 857  * Start a section.
 858  */
 859 void
 860 sbuf_start_section(struct sbuf *s, ssize_t *old_lenp)
 861 {
 862
 863         assert_sbuf_integrity(s);
 864         assert_sbuf_state(s, 0);
 865
 866         if (!SBUF_ISSECTION(s)) {
 867                 KASSERT(s->s_sect_len == 0,
 868                     ("s_sect_len != 0 when starting a section"));
 869                 if (old_lenp != NULL)
 870                         *old_lenp = -1;
 871                 s->s_rec_off = s->s_len;
 872                 SBUF_SETFLAG(s, SBUF_INSECTION);
 873         } else {
 874                 KASSERT(old_lenp != NULL,
 875                     ("s_sect_len should be saved when starting a subsection"));
 876                 *old_lenp = s->s_sect_len;
 877                 s->s_sect_len = 0;
 878         }
 879 }
 880
 881 /*
 882  * End the section padding to the specified length with the specified
 883  * character.
 884  */
 885 ssize_t
 886 sbuf_end_section(struct sbuf *s, ssize_t old_len, size_t pad, int c)
 887 {
 888         ssize_t len;
 889
 890         assert_sbuf_integrity(s);
 891         assert_sbuf_state(s, 0);
 892         KASSERT(SBUF_ISSECTION(s),
 893             ("attempt to end a section when not in a section"));
 894
 895         if (pad > 1) {
 896                 len = roundup(s->s_sect_len, pad) - s->s_sect_len;
 897                 for (; s->s_error == 0 && len > 0; len--)
 898                         sbuf_put_byte(s, c);
 899         }
 900         len = s->s_sect_len;
 901         if (old_len == -1) {
 902                 s->s_rec_off = s->s_sect_len = 0;
 903                 SBUF_CLEARFLAG(s, SBUF_INSECTION);
 904         } else {
 905                 s->s_sect_len += old_len;
 906         }
 907         if (s->s_error != 0)
 908                 return (-1);
 909         return (len);
 910 }