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 int
 379 sbuf_drain(struct sbuf *s)
 380 {
 381         int len;
 382
 383         /*
 384          * Immediately return when no work to do,
 385          * or an error has already been accumulated.
 386          */
 387         if ((s->s_len == 0) || (s->s_error != 0))
 388                 return(s->s_error);
 389
 390         if (SBUF_DODRAINTOEOR(s) && s->s_rec_off == 0)
 391                 return (s->s_error = EDEADLK);
 392         len = s->s_drain_func(s->s_drain_arg, s->s_buf,
 393             SBUF_DODRAINTOEOR(s) ? s->s_rec_off : s->s_len);
 394         if (len <= 0) {
 395                 s->s_error = len ? -len : EDEADLK;
 396                 return (s->s_error);
 397         }
 398         KASSERT(len > 0 && len <= s->s_len,
 399             ("Bad drain amount %d for sbuf %p", len, s));
 400         s->s_len -= len;
 401         s->s_rec_off -= len;
 402         /*
 403          * Fast path for the expected case where all the data was
 404          * drained.
 405          */
 406         if (s->s_len == 0)
 407                 return (0);
 408         /*
 409          * Move the remaining characters to the beginning of the
 410          * string.
 411          */
 412         memmove(s->s_buf, s->s_buf + len, s->s_len);
 413         return (0);
 414 }
 415
 416 /*
 417  * Append bytes to an sbuf.  This is the core function for appending
 418  * to an sbuf and is the main place that deals with extending the
 419  * buffer and marking overflow.
 420  */
 421 static void
 422 sbuf_put_bytes(struct sbuf *s, const char *buf, size_t len)
 423 {
 424         size_t n;
 425
 426         assert_sbuf_integrity(s);
 427         assert_sbuf_state(s, 0);
 428
 429         if (s->s_error != 0)
 430                 return;
 431         while (len > 0) {
 432                 if (SBUF_FREESPACE(s) <= 0) {
 433                         /*
 434                          * If there is a drain, use it, otherwise extend the
 435                          * buffer.
 436                          */
 437                         if (s->s_drain_func != NULL)
 438                                 (void)sbuf_drain(s);
 439                         else if (sbuf_extend(s, len > INT_MAX ? INT_MAX : len)
 440                             < 0)
 441                                 s->s_error = ENOMEM;
 442                         if (s->s_error != 0)
 443                                 return;
 444                 }
 445                 n = SBUF_FREESPACE(s);
 446                 if (len < n)
 447                         n = len;
 448                 memcpy(&s->s_buf[s->s_len], buf, n);
 449                 s->s_len += n;
 450                 if (SBUF_ISSECTION(s))
 451                         s->s_sect_len += n;
 452                 len -= n;
 453                 buf += n;
 454         }
 455 }
 456
 457 static void
 458 sbuf_put_byte(struct sbuf *s, char c)
 459 {
 460
 461         sbuf_put_bytes(s, &c, 1);
 462 }
 463
 464 /*
 465  * Append a byte string to an sbuf.
 466  */
 467 int
 468 sbuf_bcat(struct sbuf *s, const void *buf, size_t len)
 469 {
 470
 471         sbuf_put_bytes(s, buf, len);
 472         if (s->s_error != 0)
 473                 return (-1);
 474         return (0);
 475 }
 476
 477 #ifdef _KERNEL
 478 /*
 479  * Copy a byte string from userland into an sbuf.
 480  */
 481 int
 482 sbuf_bcopyin(struct sbuf *s, const void *uaddr, size_t len)
 483 {
 484
 485         assert_sbuf_integrity(s);
 486         assert_sbuf_state(s, 0);
 487         KASSERT(s->s_drain_func == NULL,
 488             ("Nonsensical copyin to sbuf %p with a drain", s));
 489
 490         if (s->s_error != 0)
 491                 return (-1);
 492         if (len == 0)
 493                 return (0);
 494         if (len > SBUF_FREESPACE(s)) {
 495                 sbuf_extend(s, len - SBUF_FREESPACE(s));
 496                 if (SBUF_FREESPACE(s) < len)
 497                         len = SBUF_FREESPACE(s);
 498         }
 499         if (copyin(uaddr, s->s_buf + s->s_len, len) != 0)
 500                 return (-1);
 501         s->s_len += len;
 502
 503         return (0);
 504 }
 505 #endif
 506
 507 /*
 508  * Copy a byte string into an sbuf.
 509  */
 510 int
 511 sbuf_bcpy(struct sbuf *s, const void *buf, size_t len)
 512 {
 513
 514         assert_sbuf_integrity(s);
 515         assert_sbuf_state(s, 0);
 516
 517         sbuf_clear(s);
 518         return (sbuf_bcat(s, buf, len));
 519 }
 520
 521 /*
 522  * Append a string to an sbuf.
 523  */
 524 int
 525 sbuf_cat(struct sbuf *s, const char *str)
 526 {
 527         size_t n;
 528
 529         n = strlen(str);
 530         sbuf_put_bytes(s, str, n);
 531         if (s->s_error != 0)
 532                 return (-1);
 533         return (0);
 534 }
 535
 536 #ifdef _KERNEL
 537 /*
 538  * Append a string from userland to an sbuf.
 539  */
 540 int
 541 sbuf_copyin(struct sbuf *s, const void *uaddr, size_t len)
 542 {
 543         size_t done;
 544
 545         assert_sbuf_integrity(s);
 546         assert_sbuf_state(s, 0);
 547         KASSERT(s->s_drain_func == NULL,
 548             ("Nonsensical copyin to sbuf %p with a drain", s));
 549
 550         if (s->s_error != 0)
 551                 return (-1);
 552
 553         if (len == 0)
 554                 len = SBUF_FREESPACE(s);        /* XXX return 0? */
 555         if (len > SBUF_FREESPACE(s)) {
 556                 sbuf_extend(s, len);
 557                 if (SBUF_FREESPACE(s) < len)
 558                         len = SBUF_FREESPACE(s);
 559         }
 560         switch (copyinstr(uaddr, s->s_buf + s->s_len, len + 1, &done)) {
 561         case ENAMETOOLONG:
 562                 s->s_error = ENOMEM;
 563                 /* fall through */
 564         case 0:
 565                 s->s_len += done - 1;
 566                 if (SBUF_ISSECTION(s))
 567                         s->s_sect_len += done - 1;
 568                 break;
 569         default:
 570                 return (-1);    /* XXX */
 571         }
 572
 573         return (done);
 574 }
 575 #endif
 576
 577 /*
 578  * Copy a string into an sbuf.
 579  */
 580 int
 581 sbuf_cpy(struct sbuf *s, const char *str)
 582 {
 583
 584         assert_sbuf_integrity(s);
 585         assert_sbuf_state(s, 0);
 586
 587         sbuf_clear(s);
 588         return (sbuf_cat(s, str));
 589 }
 590
 591 /*
 592  * Format the given argument list and append the resulting string to an sbuf.
 593  */
 594 #ifdef _KERNEL
 595
 596 /*
 597  * Append a non-NUL character to an sbuf.  This prototype signature is
 598  * suitable for use with kvprintf(9).
 599  */
 600 static void
 601 sbuf_putc_func(int c, void *arg)
 602 {
 603
 604         if (c != '\0')
 605                 sbuf_put_byte(arg, c);
 606 }
 607
 608 int
 609 sbuf_vprintf(struct sbuf *s, const char *fmt, va_list ap)
 610 {
 611
 612         assert_sbuf_integrity(s);
 613         assert_sbuf_state(s, 0);
 614
 615         KASSERT(fmt != NULL,
 616             ("%s called with a NULL format string", __func__));
 617
 618         (void)kvprintf(fmt, sbuf_putc_func, s, 10, ap);
 619         if (s->s_error != 0)
 620                 return (-1);
 621         return (0);
 622 }
 623 #else /* !_KERNEL */
 624 int
 625 sbuf_vprintf(struct sbuf *s, const char *fmt, va_list ap)
 626 {
 627         va_list ap_copy;
 628         int error, len;
 629
 630         assert_sbuf_integrity(s);
 631         assert_sbuf_state(s, 0);
 632
 633         KASSERT(fmt != NULL,
 634             ("%s called with a NULL format string", __func__));
 635
 636         if (s->s_error != 0)
 637                 return (-1);
 638
 639         /*
 640          * For the moment, there is no way to get vsnprintf(3) to hand
 641          * back a character at a time, to push everything into
 642          * sbuf_putc_func() as was done for the kernel.
 643          *
 644          * In userspace, while drains are useful, there's generally
 645          * not a problem attempting to malloc(3) on out of space.  So
 646          * expand a userland sbuf if there is not enough room for the
 647          * data produced by sbuf_[v]printf(3).
 648          */
 649
 650         error = 0;
 651         do {
 652                 va_copy(ap_copy, ap);
 653                 len = vsnprintf(&s->s_buf[s->s_len], SBUF_FREESPACE(s) + 1,
 654                     fmt, ap_copy);
 655                 if (len < 0) {
 656                         s->s_error = errno;
 657                         return (-1);
 658                 }
 659                 va_end(ap_copy);
 660
 661                 if (SBUF_FREESPACE(s) >= len)
 662                         break;
 663                 /* Cannot print with the current available space. */
 664                 if (s->s_drain_func != NULL && s->s_len > 0)
 665                         error = sbuf_drain(s); /* sbuf_drain() sets s_error. */
 666                 else if (sbuf_extend(s, len - SBUF_FREESPACE(s)) != 0)
 667                         s->s_error = error = ENOMEM;
 668         } while (error == 0);
 669
 670         /*
 671          * s->s_len is the length of the string, without the terminating nul.
 672          * When updating s->s_len, we must subtract 1 from the length that
 673          * we passed into vsnprintf() because that length includes the
 674          * terminating nul.
 675          *
 676          * vsnprintf() returns the amount that would have been copied,
 677          * given sufficient space, so don't over-increment s_len.
 678          */
 679         if (SBUF_FREESPACE(s) < len)
 680                 len = SBUF_FREESPACE(s);
 681         s->s_len += len;
 682         if (SBUF_ISSECTION(s))
 683                 s->s_sect_len += len;
 684
 685         KASSERT(s->s_len < s->s_size,
 686             ("wrote past end of sbuf (%d >= %d)", s->s_len, s->s_size));
 687
 688         if (s->s_error != 0)
 689                 return (-1);
 690         return (0);
 691 }
 692 #endif /* _KERNEL */
 693
 694 /*
 695  * Format the given arguments and append the resulting string to an sbuf.
 696  */
 697 int
 698 sbuf_printf(struct sbuf *s, const char *fmt, ...)
 699 {
 700         va_list ap;
 701         int result;
 702
 703         va_start(ap, fmt);
 704         result = sbuf_vprintf(s, fmt, ap);
 705         va_end(ap);
 706         return (result);
 707 }
 708
 709 /*
 710  * Append a character to an sbuf.
 711  */
 712 int
 713 sbuf_putc(struct sbuf *s, int c)
 714 {
 715
 716         sbuf_put_byte(s, c);
 717         if (s->s_error != 0)
 718                 return (-1);
 719         return (0);
 720 }
 721
 722 /*
 723  * Trim whitespace characters from end of an sbuf.
 724  */
 725 int
 726 sbuf_trim(struct sbuf *s)
 727 {
 728
 729         assert_sbuf_integrity(s);
 730         assert_sbuf_state(s, 0);
 731         KASSERT(s->s_drain_func == NULL,
 732             ("%s makes no sense on sbuf %p with drain", __func__, s));
 733
 734         if (s->s_error != 0)
 735                 return (-1);
 736
 737         while (s->s_len > 0 && isspace(s->s_buf[s->s_len-1])) {
 738                 --s->s_len;
 739                 if (SBUF_ISSECTION(s))
 740                         s->s_sect_len--;
 741         }
 742
 743         return (0);
 744 }
 745
 746 /*
 747  * Check if an sbuf has an error.
 748  */
 749 int
 750 sbuf_error(const struct sbuf *s)
 751 {
 752
 753         return (s->s_error);
 754 }
 755
 756 /*
 757  * Finish off an sbuf.
 758  */
 759 int
 760 sbuf_finish(struct sbuf *s)
 761 {
 762
 763         assert_sbuf_integrity(s);
 764         assert_sbuf_state(s, 0);
 765
 766         s->s_buf[s->s_len] = '\0';
 767         if (SBUF_NULINCLUDED(s))
 768                 s->s_len++;
 769         if (s->s_drain_func != NULL) {
 770                 while (s->s_len > 0 && s->s_error == 0)
 771                         s->s_error = sbuf_drain(s);
 772         }
 773         SBUF_SETFLAG(s, SBUF_FINISHED);
 774 #ifdef _KERNEL
 775         return (s->s_error);
 776 #else
 777         if (s->s_error != 0) {
 778                 errno = s->s_error;
 779                 return (-1);
 780         }
 781         return (0);
 782 #endif
 783 }
 784
 785 /*
 786  * Return a pointer to the sbuf data.
 787  */
 788 char *
 789 sbuf_data(struct sbuf *s)
 790 {
 791
 792         assert_sbuf_integrity(s);
 793         assert_sbuf_state(s, SBUF_FINISHED);
 794         KASSERT(s->s_drain_func == NULL,
 795             ("%s makes no sense on sbuf %p with drain", __func__, s));
 796
 797         return (s->s_buf);
 798 }
 799
 800 /*
 801  * Return the length of the sbuf data.
 802  */
 803 ssize_t
 804 sbuf_len(struct sbuf *s)
 805 {
 806
 807         assert_sbuf_integrity(s);
 808         /* don't care if it's finished or not */
 809         KASSERT(s->s_drain_func == NULL,
 810             ("%s makes no sense on sbuf %p with drain", __func__, s));
 811
 812         if (s->s_error != 0)
 813                 return (-1);
 814
 815         /* If finished, nulterm is already in len, else add one. */
 816         if (SBUF_NULINCLUDED(s) && !SBUF_ISFINISHED(s))
 817                 return (s->s_len + 1);
 818         return (s->s_len);
 819 }
 820
 821 /*
 822  * Clear an sbuf, free its buffer if necessary.
 823  */
 824 void
 825 sbuf_delete(struct sbuf *s)
 826 {
 827         int isdyn;
 828
 829         assert_sbuf_integrity(s);
 830         /* don't care if it's finished or not */
 831
 832         if (SBUF_ISDYNAMIC(s))
 833                 SBFREE(s->s_buf);
 834         isdyn = SBUF_ISDYNSTRUCT(s);
 835         memset(s, 0, sizeof(*s));
 836         if (isdyn)
 837                 SBFREE(s);
 838 }
 839
 840 /*
 841  * Check if an sbuf has been finished.
 842  */
 843 int
 844 sbuf_done(const struct sbuf *s)
 845 {
 846
 847         return (SBUF_ISFINISHED(s));
 848 }
 849
 850 /*
 851  * Start a section.
 852  */
 853 void
 854 sbuf_start_section(struct sbuf *s, ssize_t *old_lenp)
 855 {
 856
 857         assert_sbuf_integrity(s);
 858         assert_sbuf_state(s, 0);
 859
 860         if (!SBUF_ISSECTION(s)) {
 861                 KASSERT(s->s_sect_len == 0,
 862                     ("s_sect_len != 0 when starting a section"));
 863                 if (old_lenp != NULL)
 864                         *old_lenp = -1;
 865                 s->s_rec_off = s->s_len;
 866                 SBUF_SETFLAG(s, SBUF_INSECTION);
 867         } else {
 868                 KASSERT(old_lenp != NULL,
 869                     ("s_sect_len should be saved when starting a subsection"));
 870                 *old_lenp = s->s_sect_len;
 871                 s->s_sect_len = 0;
 872         }
 873 }
 874
 875 /*
 876  * End the section padding to the specified length with the specified
 877  * character.
 878  */
 879 ssize_t
 880 sbuf_end_section(struct sbuf *s, ssize_t old_len, size_t pad, int c)
 881 {
 882         ssize_t len;
 883
 884         assert_sbuf_integrity(s);
 885         assert_sbuf_state(s, 0);
 886         KASSERT(SBUF_ISSECTION(s),
 887             ("attempt to end a section when not in a section"));
 888
 889         if (pad > 1) {
 890                 len = roundup(s->s_sect_len, pad) - s->s_sect_len;
 891                 for (; s->s_error == 0 && len > 0; len--)
 892                         sbuf_put_byte(s, c);
 893         }
 894         len = s->s_sect_len;
 895         if (old_len == -1) {
 896                 s->s_rec_off = s->s_sect_len = 0;
 897                 SBUF_CLEARFLAG(s, SBUF_INSECTION);
 898         } else {
 899                 s->s_sect_len += old_len;
 900         }
 901         if (s->s_error != 0)
 902                 return (-1);
 903         return (len);
 904 }