usr/src/lib/libdtrace/common/dt_buf.h

   1 /*
   2  * CDDL HEADER START
   3  *
   4  * The contents of this file are subject to the terms of the
   5  * Common Development and Distribution License, Version 1.0 only
   6  * (the "License").  You may not use this file except in compliance
   7  * with the License.
   8  *
   9  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  10  * or http://www.opensolaris.org/os/licensing.
  11  * See the License for the specific language governing permissions
  12  * and limitations under the License.
  13  *
  14  * When distributing Covered Code, include this CDDL HEADER in each
  15  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  16  * If applicable, add the following below this CDDL HEADER, with the
  17  * fields enclosed by brackets "[]" replaced with your own identifying
  18  * information: Portions Copyright [yyyy] [name of copyright owner]
  19  *
  20  * CDDL HEADER END
  21  */
  22 /*
  23  * Copyright 2005 Sun Microsystems, Inc.  All rights reserved.
  24  * Use is subject to license terms.
  25  */
  26
  27 #ifndef _DT_BUF_H
  28 #define _DT_BUF_H
  29
  30 #pragma ident   "%Z%%M% %I%     %E% SMI"
  31
  32 #ifdef  __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 #include <dtrace.h>
  37
  38 typedef struct dt_buf {
  39         const char *dbu_name;   /* string name for debugging */
  40         uchar_t *dbu_buf;       /* buffer base address */
  41         uchar_t *dbu_ptr;       /* current buffer location */
  42         size_t dbu_len;         /* buffer size in bytes */
  43         int dbu_err;            /* errno value if error */
  44         int dbu_resizes;        /* number of resizes */
  45 } dt_buf_t;
  46
  47 extern void dt_buf_create(dtrace_hdl_t *, dt_buf_t *, const char *, size_t);
  48 extern void dt_buf_destroy(dtrace_hdl_t *, dt_buf_t *);
  49 extern void dt_buf_reset(dtrace_hdl_t *, dt_buf_t *);
  50
  51 extern void dt_buf_write(dtrace_hdl_t *, dt_buf_t *,
  52     const void *, size_t, size_t);
  53
  54 extern void dt_buf_concat(dtrace_hdl_t *, dt_buf_t *,
  55     const dt_buf_t *, size_t);
  56
  57 extern size_t dt_buf_offset(const dt_buf_t *, size_t);
  58 extern size_t dt_buf_len(const dt_buf_t *);
  59
  60 extern int dt_buf_error(const dt_buf_t *);
  61 extern void *dt_buf_ptr(const dt_buf_t *);
  62
  63 extern void *dt_buf_claim(dtrace_hdl_t *, dt_buf_t *);
  64
  65 #ifdef  __cplusplus
  66 }
  67 #endif
  68
  69 #endif  /* _DT_BUF_H */