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