mirror of
https://github.com/freebsd/freebsd-src.git
synced 2026-10-30 12:25:10 +01:00
Enji Cooper
89cc4cdf44
r307873 (by marcel):
Include <stdarg.h> instead of <machine/stdarg.h> when compiled as
part of libsbuf. The former is the standard header, and allows us
to compile libsbuf on macOS/linux.
r314397 (by scottl):
Implement sbuf_prf(), which takes an sbuf and outputs it
to stdout in the non-kernel case and to the console+log
in the kernel case. For the kernel case it hooks the
putbuf() machinery underneath printf(9) so that the buffer
is written completely atomically and without a copy into
another temporary buffer. This is useful for fixing
compound console/log messages that become broken and
interleaved when multiple threads are competing for the
console.
r314399 (by scottl):
Add prototype for sbuf_putbuf()
r314419 (by jkim):
Include stdio.h to fix libsbuf build.
r314420 (by scottl):
Provide a comment on why stdio.h needs to be included.
r314533 (by scottl):
Expose the sbuf_putbuf() symbol to libsbuf. There are a few other symbols
that are present but not exposed, like get/set/clear flags, not sure if they
need to be exposed at this point.
r316553:
sbuf(3): expose sbuf_{clear,get,set}_flags(3) via libsbuf
These functions were added to sbuf(9) in r279992, but never
exposed to userspace. Expose them now so they can be used/tested.
113 lines
4.2 KiB
C
113 lines
4.2 KiB
C
/*-
|
|
* Copyright (c) 2000-2008 Poul-Henning Kamp
|
|
* Copyright (c) 2000-2008 Dag-Erling Coïdan Smørgrav
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer
|
|
* in this position and unchanged.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
* SUCH DAMAGE.
|
|
*
|
|
* $FreeBSD$
|
|
*/
|
|
|
|
#ifndef _SYS_SBUF_H_
|
|
#define _SYS_SBUF_H_
|
|
|
|
#include <sys/_types.h>
|
|
|
|
struct sbuf;
|
|
typedef int (sbuf_drain_func)(void *, const char *, int);
|
|
|
|
/*
|
|
* Structure definition
|
|
*/
|
|
struct sbuf {
|
|
char *s_buf; /* storage buffer */
|
|
sbuf_drain_func *s_drain_func; /* drain function */
|
|
void *s_drain_arg; /* user-supplied drain argument */
|
|
int s_error; /* current error code */
|
|
ssize_t s_size; /* size of storage buffer */
|
|
ssize_t s_len; /* current length of string */
|
|
#define SBUF_FIXEDLEN 0x00000000 /* fixed length buffer (default) */
|
|
#define SBUF_AUTOEXTEND 0x00000001 /* automatically extend buffer */
|
|
#define SBUF_INCLUDENUL 0x00000002 /* nulterm byte is counted in len */
|
|
#define SBUF_USRFLAGMSK 0x0000ffff /* mask of flags the user may specify */
|
|
#define SBUF_DYNAMIC 0x00010000 /* s_buf must be freed */
|
|
#define SBUF_FINISHED 0x00020000 /* set by sbuf_finish() */
|
|
#define SBUF_DYNSTRUCT 0x00080000 /* sbuf must be freed */
|
|
#define SBUF_INSECTION 0x00100000 /* set by sbuf_start_section() */
|
|
int s_flags; /* flags */
|
|
ssize_t s_sect_len; /* current length of section */
|
|
};
|
|
|
|
#ifndef HD_COLUMN_MASK
|
|
#define HD_COLUMN_MASK 0xff
|
|
#define HD_DELIM_MASK 0xff00
|
|
#define HD_OMIT_COUNT (1 << 16)
|
|
#define HD_OMIT_HEX (1 << 17)
|
|
#define HD_OMIT_CHARS (1 << 18)
|
|
#endif /* HD_COLUMN_MASK */
|
|
|
|
__BEGIN_DECLS
|
|
/*
|
|
* API functions
|
|
*/
|
|
struct sbuf *sbuf_new(struct sbuf *, char *, int, int);
|
|
#define sbuf_new_auto() \
|
|
sbuf_new(NULL, NULL, 0, SBUF_AUTOEXTEND)
|
|
int sbuf_get_flags(struct sbuf *);
|
|
void sbuf_clear_flags(struct sbuf *, int);
|
|
void sbuf_set_flags(struct sbuf *, int);
|
|
void sbuf_clear(struct sbuf *);
|
|
int sbuf_setpos(struct sbuf *, ssize_t);
|
|
int sbuf_bcat(struct sbuf *, const void *, size_t);
|
|
int sbuf_bcpy(struct sbuf *, const void *, size_t);
|
|
int sbuf_cat(struct sbuf *, const char *);
|
|
int sbuf_cpy(struct sbuf *, const char *);
|
|
int sbuf_printf(struct sbuf *, const char *, ...)
|
|
__printflike(2, 3);
|
|
int sbuf_vprintf(struct sbuf *, const char *, __va_list)
|
|
__printflike(2, 0);
|
|
int sbuf_putc(struct sbuf *, int);
|
|
void sbuf_set_drain(struct sbuf *, sbuf_drain_func *, void *);
|
|
int sbuf_trim(struct sbuf *);
|
|
int sbuf_error(const struct sbuf *);
|
|
int sbuf_finish(struct sbuf *);
|
|
char *sbuf_data(struct sbuf *);
|
|
ssize_t sbuf_len(struct sbuf *);
|
|
int sbuf_done(const struct sbuf *);
|
|
void sbuf_delete(struct sbuf *);
|
|
void sbuf_start_section(struct sbuf *, ssize_t *);
|
|
ssize_t sbuf_end_section(struct sbuf *, ssize_t, size_t, int);
|
|
void sbuf_hexdump(struct sbuf *, const void *, int, const char *,
|
|
int);
|
|
void sbuf_putbuf(struct sbuf *);
|
|
|
|
#ifdef _KERNEL
|
|
struct uio;
|
|
struct sbuf *sbuf_uionew(struct sbuf *, struct uio *, int *);
|
|
int sbuf_bcopyin(struct sbuf *, const void *, size_t);
|
|
int sbuf_copyin(struct sbuf *, const void *, size_t);
|
|
#endif
|
|
__END_DECLS
|
|
|
|
#endif
|