LXR linux/net/tipc/dbg.h

   1/*
   2 * net/tipc/dbg.h: Include file for TIPC print buffer routines
   3 *
   4 * Copyright (c) 1997-2006, Ericsson AB
   5 * Copyright (c) 2005-2007, Wind River Systems
   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 are met:
  10 *
  11 * 1. Redistributions of source code must retain the above copyright
  12 *    notice, this list of conditions and the following disclaimer.
  13 * 2. Redistributions in binary form must reproduce the above copyright
  14 *    notice, this list of conditions and the following disclaimer in the
  15 *    documentation and/or other materials provided with the distribution.
  16 * 3. Neither the names of the copyright holders nor the names of its
  17 *    contributors may be used to endorse or promote products derived from
  18 *    this software without specific prior written permission.
  19 *
  20 * Alternatively, this software may be distributed under the terms of the
  21 * GNU General Public License ("GPL") version 2 as published by the Free
  22 * Software Foundation.
  23 *
  24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  28 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  29 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  30 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  31 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  32 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  33 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  34 * POSSIBILITY OF SUCH DAMAGE.
  35 */
  36
  37#ifndef _TIPC_DBG_H
  38#define _TIPC_DBG_H
  39
  40/**
  41 * struct print_buf - TIPC print buffer structure
  42 * @buf: pointer to character array containing print buffer contents
  43 * @size: size of character array
  44 * @crs: pointer to first unused space in character array (i.e. final NUL)
  45 * @echo: echo output to system console if non-zero
  46 */
  47
  48struct print_buf {
  49        char *buf;
  50        u32 size;
  51        char *crs;
  52        int echo;
  53};
  54
  55#define TIPC_PB_MIN_SIZE 64     /* minimum size for a print buffer's array */
  56#define TIPC_PB_MAX_STR 512     /* max printable string (with trailing NUL) */
  57
  58void tipc_printbuf_init(struct print_buf *pb, char *buf, u32 size);
  59void tipc_printbuf_reset(struct print_buf *pb);
  60int  tipc_printbuf_empty(struct print_buf *pb);
  61int  tipc_printbuf_validate(struct print_buf *pb);
  62void tipc_printbuf_move(struct print_buf *pb_to, struct print_buf *pb_from);
  63
  64int tipc_log_resize(int log_size);
  65
  66struct sk_buff *tipc_log_resize_cmd(const void *req_tlv_area,
  67                                    int req_tlv_space);
  68struct sk_buff *tipc_log_dump(void);
  69
  70#endif
  71