5672fac935
MAM is Medium Auxiliary Memory and is most commonly found as flash chips on tapes. This includes support for reading attributes and decoding most known attributes, but does not yet include support for writing attributes or reporting attributes in XML format. libsbuf/Makefile: Add subr_prf.c for the new sbuf_hexdump() function. This function is essentially the same function. libsbuf/Symbol.map: Add a new shared library minor version, and include the sbuf_hexdump() function. libsbuf/Version.def: Add version 1.4 of the libsbuf library. libutil/hexdump.3: Document sbuf_hexdump() alongside hexdump(3), since it is essentially the same function. camcontrol/Makefile: Add attrib.c. camcontrol/attrib.c: Implementation of READ ATTRIBUTE support for camcontrol(8). camcontrol/camcontrol.8: Document the new 'camcontrol attrib' subcommand. camcontrol/camcontrol.c: Add the new 'camcontrol attrib' subcommand. camcontrol/camcontrol.h: Add a function prototype for scsiattrib(). share/man/man9/sbuf.9: Document the existence of sbuf_hexdump() and point users to the hexdump(3) man page for more details. sys/cam/scsi/scsi_all.c: Add a table of known attributes, text descriptions and handler functions. Add a new scsi_attrib_sbuf() function along with a number of other related functions that help decode attributes. scsi_attrib_ascii_sbuf() decodes ASCII format attributes. scsi_attrib_int_sbuf() decodes binary format attributes, and will pass them off to scsi_attrib_hexdump_sbuf() if they're bigger than 8 bytes. scsi_attrib_vendser_sbuf() decodes the vendor and drive serial number attribute. scsi_attrib_volcoh_sbuf() decodes the Volume Coherency Information attribute that LTFS writes out. sys/cam/scsi/scsi_all.h: Add a number of attribute-related structure definitions and other defines. Add function prototypes for all of the functions added in scsi_all.c. sys/kern/subr_prf.c: Add a new function, sbuf_hexdump(). This is the same as the existing hexdump(9) function, except that it puts the result in an sbuf. This also changes subr_prf.c so that it can be compiled in userland for includsion in libsbuf. We should work to change this so that the kernel hexdump implementation is a wrapper around sbuf_hexdump() with a statically allocated sbuf with a drain. That will require a drain function that goes to the kernel printf() buffer that can take a non-NUL terminated string as input. That is because an sbuf isn't NUL-terminated until it is finished, and we don't want to finish it while we're still using it. We should also work to consolidate the userland hexdump and kernel hexdump implemenatations, which are currently separate. This would also mean making applications that currently link in libutil link in libsbuf. sys/sys/sbuf.h: Add the prototype for sbuf_hexdump(), and add another copy of the hexdump flag values if they aren't already defined. Ideally the flags should be defined in one place but the implemenation makes it difficult to do properly. (See above.) Sponsored by: Spectra Logic Corporation MFC after: 1 week
112 lines
4.2 KiB
C
112 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);
|
|
|
|
#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
|