History log of /freebsd-10.0-release/share/man/man9/sbuf.9
Revision Date Author Comments
(<<< Hide modified files)
(Show modified files >>>)
# 259065 07-Dec-2013 gjb

- Copy stable/10 (r259064) to releng/10.0 as part of the
10.0-RELEASE cycle.
- Update __FreeBSD_version [1]
- Set branch name to -RC1

[1] 10.0-CURRENT __FreeBSD_version value ended at '55', so
start releng/10.0 at '100' so the branch is started with
a value ending in zero.

Approved by: re (implicit)
Sponsored by: The FreeBSD Foundation

# 256281 10-Oct-2013 gjb

Copy head (r256279) to stable/10 as part of the 10.0-RELEASE cycle.

Approved by: re (implicit)
Sponsored by: The FreeBSD Foundation


# 249379 11-Apr-2013 trociny

Document sbuf_start_section() and sbuf_end_section() functions.

MFC after: 1 month


# 249241 07-Apr-2013 trociny

Fix synopsis for sbuf_len.

MFC after: 3 days


# 228784 21-Dec-2011 jh

Follow style(9) more closely in the example.


# 228359 09-Dec-2011 jh

sbuf_data() hasn't returned NULL for overflowed buffers since r71721.


# 228358 09-Dec-2011 jh

- Fix markup.
- Remove trailing whitespace.


# 222176 22-May-2011 uqs

Re-encode files from ISO-8859-1 to UTF-8


# 222095 19-May-2011 phk

When adding examples to man-pages, try to make them at least
look like they might work.

Prodded by: Vadim Goncharov


# 222034 17-May-2011 phk

Try to explain what sbufs do and add an example to show it.

Clarify return values.


# 220155 30-Mar-2011 ae

Remove duplicate sentence.


# 217916 26-Jan-2011 mdf

Explicitly wire the user buffer rather than doing it implicitly in
sbuf_new_for_sysctl(9). This allows using an sbuf with a SYSCTL_OUT
drain for extremely large amounts of data where the caller knows that
appropriate references are held, and sleeping is not an issue.

Inspired by: rwatson


# 217830 25-Jan-2011 mdf

Document sbuf_new_for_sysctl(9).

Pointed out by: lstewart


# 212425 10-Sep-2010 mdf

Replace sbuf_overflowed() with sbuf_error(), which returns any error
code associated with overflow or with the drain function. While this
function is not expected to be used often, it produces more information
in the form of an errno that sbuf_overflowed() did.


# 212367 09-Sep-2010 mdf

Add drain functionality to sbufs. The drain is a function that is
called when the sbuf internal buffer is filled. For kernel sbufs with a
drain, the internal buffer will never be expanded. For userland sbufs
with a drain, the internal buffer may still be expanded by
sbuf_[v]printf(3).

Sbufs now have three basic uses:
1) static string manipulation. Overflow is marked.
2) dynamic string manipulation. Overflow triggers string growth.
3) drained string manipulation. Overflow triggers draining.

In all cases the manipulation is 'safe' in that overflow is detected and
managed.

Reviewed by: phk (the previous version)


# 212364 09-Sep-2010 mdf

Fix small errors in the sbuf(9) man page.


# 192265 17-May-2009 brueffer

Document sbuf_new_auto().

While here, add a missing `-' in phk's name.

MFC after: 3 days


# 162404 18-Sep-2006 ru

Markup fixes.


# 153678 23-Dec-2005 phk

Make sbuf_copyin() return the number of bytes copied on success.

Submitted by: "Wojciech A. Koszek" <dunstan@freebsd.czest.pl>


# 131872 09-Jul-2004 des

Bump document date.

Reminded by: ru


# 131870 09-Jul-2004 des

The type and name of sbuf_b{cat,cpy}()'s second argument have changed.


# 124963 25-Jan-2004 des

I don't normally use my middle name, so remove it from attributions in
man pages (though not from copyright notices). While I'm here, add email
addresses where appropriate.


# 124316 09-Jan-2004 des

Move the description of sbuf_delete() closer to the description of
sbuf_new(), and try to make them both a little clearer.


# 119893 08-Sep-2003 ru

mdoc(7): Use the new feature of the .In macro.


# 104449 04-Oct-2002 phk

Add the new function "sbuf_done()" which returns non-zero if the sbuf is
finished.

This allows sbufs to be used for request/response scenarioes without
needing additional communication flags.

Sponsored by: DARPA & NAI Labs.


# 89204 10-Jan-2002 ru

mdoc(7) police: tidy up the previous delta a bit.


# 88951 06-Jan-2002 kbyanc

Document sbuf_trim() and sbuf_vprintf(); add MLINKs.
Clarify that the contents of a caller-supplied buffer are undefined and
should not be examined directly.

Reviewed by: des


# 87555 09-Dec-2001 arr

- Cross reference the section 9 printf man page since it contains
information with regards to in-kernel format directives that are
not in printf.3


# 84452 04-Oct-2001 bde

Fixed (C) syntax error in synopsis.


# 84306 01-Oct-2001 ru

mdoc(7) police: Use the new .In macro for #include statements.


# 79945 19-Jul-2001 des

4.4 will have sbufs.


# 79538 10-Jul-2001 ru

mdoc(7) police: removed HISTORY info from the .Os call.


# 79341 05-Jul-2001 des

Constify the format string.

Submitted by: Mike Barcroft <mike@q9media.com>
Forgotten by: des


# 79223 04-Jul-2001 ru

mdoc(7) police: mark type with .Vt, sort xrefs.


# 78077 11-Jun-2001 des

Add sbuf_copyin(). Also add 'b' variants of sbuf_{cat,copyin,cpy}() which
ignore NUL bytes in the source string.


# 77989 10-Jun-2001 des

sbuf_new(9) now returns a struct sbuf * instead of an int. If the caller
does not provide a struct sbuf, sbuf_new(9) will allocate one and return
a pointer to it.


# 75870 23-Apr-2001 ru

mdoc(7) police: update HISTORY section.
This interface is not available in 4.3-RELEASE.


# 75650 18-Apr-2001 ru

mdoc(7) police: uppercase document title.


# 74840 27-Mar-2001 ken

Rewrite of the CAM error recovery code.

Some of the major changes include:

- The SCSI error handling portion of cam_periph_error() has
been broken out into a number of subfunctions to better
modularize the code that handles the hierarchy of SCSI errors.
As a result, the code is now much easier to read.

- String handling and error printing has been significantly
revamped. We now use sbufs to do string formatting instead
of using printfs (for the kernel) and snprintf/strncat (for
userland) as before.

There is a new catchall error printing routine,
cam_error_print() and its string-based counterpart,
cam_error_string() that allow the kernel and userland
applications to pass in a CCB and have errors printed out
properly, whether or not they're SCSI errors. Among other
things, this helped eliminate a fair amount of duplicate code
in camcontrol.

We now print out more information than before, including
the CAM status and SCSI status and the error recovery action
taken to remedy the problem.

- sbufs are now available in userland, via libsbuf. This
change was necessary since most of the error printing code
is shared between libcam and the kernel.

- A new transfer settings interface is included in this checkin.
This code is #ifdef'ed out, and is primarily intended to aid
discussion with HBA driver authors on the final form the
interface should take. There is example code in the ahc(4)
driver that implements the HBA driver side of the new
interface. The new transfer settings code won't be enabled
until we're ready to switch all HBA drivers over to the new
interface.

src/Makefile.inc1,
lib/Makefile: Add libsbuf. It must be built before libcam,
since libcam uses sbuf routines.

libcam/Makefile: libcam now depends on libsbuf.

libsbuf/Makefile: Add a makefile for libsbuf. This pulls in the
sbuf sources from sys/kern.

bsd.libnames.mk: Add LIBSBUF.

camcontrol/Makefile: Add -lsbuf. Since camcontrol is statically
linked, we can't depend on the dynamic linker
to pull in libsbuf.

camcontrol.c: Use cam_error_print() instead of checking for
CAM_SCSI_STATUS_ERROR on every failed CCB.

sbuf.9: Change the prototypes for sbuf_cat() and
sbuf_cpy() so that the source string is now a
const char *. This is more in line wth the
standard system string functions, and helps
eliminate warnings when dealing with a const
source buffer.

Fix a typo.

cam.c: Add description strings for the various CAM
error status values, as well as routines to
look up those strings.

Add new cam_error_string() and
cam_error_print() routines for userland and
the kernel.

cam.h: Add a new CAM flag, CAM_RETRY_SELTO.

Add enumerated types for the various options
available with cam_error_print() and
cam_error_string().

cam_ccb.h: Add new transfer negotiation structures/types.

Change inq_len in the ccb_getdev structure to
be "reserved". This field has never been
filled in, and will be removed when we next
bump the CAM version.

cam_debug.h: Fix typo.

cam_periph.c: Modularize cam_periph_error(). The SCSI error
handling part of cam_periph_error() is now
in camperiphscsistatuserror() and
camperiphscsisenseerror().

In cam_periph_lock(), increase the reference
count on the periph while we wait for our lock
attempt to succeed so that the periph won't go
away while we're sleeping.

cam_xpt.c: Add new transfer negotiation code. (ifdefed
out)

Add a new function, xpt_path_string(). This
is a string/sbuf analog to xpt_print_path().

scsi_all.c: Revamp string handing and error printing code.
We now use sbufs for much of the string
formatting code. More of that code is shared
between userland the kernel.

scsi_all.h: Get rid of SS_TURSTART, it wasn't terribly
useful in the first place.

Add a new error action, SS_REQSENSE. (Send a
request sense and then retry the command.)
This is useful when the controller hasn't
performed autosense for some reason.

Change the default actions around a bit.

scsi_cd.c,
scsi_da.c,
scsi_pt.c,
scsi_ses.c: SF_RETRY_SELTO -> CAM_RETRY_SELTO. Selection
timeouts shouldn't be covered by a sense flag.

scsi_pass.[ch]: SF_RETRY_SELTO -> CAM_RETRY_SELTO.

Get rid of the last vestiges of a read/write
interface.

libkern/bsearch.c,
sys/libkern.h,
conf/files: Add bsearch.c, which is needed for some of the
new table lookup routines.

aic7xxx_freebsd.c: Define AHC_NEW_TRAN_SETTINGS if
CAM_NEW_TRAN_CODE is defined.

sbuf.h,
subr_sbuf.c: Add the appropriate #ifdefs so sbufs can
compile and run in userland.

Change sbuf_printf() to use vsnprintf()
instead of kvprintf(), which is only available
in the kernel.

Change the source string for sbuf_cpy() and
sbuf_cat() to be a const char *.

Add __BEGIN_DECLS and __END_DECLS around
function prototypes since they're now exported
to userland.

kdump/mkioctls: Include stdio.h before cam.h since cam.h now
includes a function with a FILE * argument.

Submitted by: gibbs (mostly)
Reviewed by: jdp, marcel (libsbuf makefile changes)
Reviewed by: des (sbuf changes)
Reviewed by: ken


# 72512 15-Feb-2001 bde

Fixed missing and/or wrong and/or extra includes in synopsis.


# 71722 27-Jan-2001 des

Document the changes in subr_sbuf.c rev. 1.2.


# 70012 14-Dec-2000 sheldonh

Grammar fix.


# 69992 13-Dec-2000 des

Add sbuf(9) man page with links to API function names.

Reviewed by: ru