sys/netgraph7/ng_sample.h

   1 /*
   2  * ng_sample.h
   3  */
   4
   5 /*-
   6  * Copyright (c) 1996-1999 Whistle Communications, Inc.
   7  * All rights reserved.
   8  *
   9  * Subject to the following obligations and disclaimer of warranty, use and
  10  * redistribution of this software, in source or object code forms, with or
  11  * without modifications are expressly permitted by Whistle Communications;
  12  * provided, however, that:
  13  * 1. Any and all reproductions of the source or object code must include the
  14  *    copyright notice above and the following disclaimer of warranties; and
  15  * 2. No rights are granted, in any manner or form, to use Whistle
  16  *    Communications, Inc. trademarks, including the mark "WHISTLE
  17  *    COMMUNICATIONS" on advertising, endorsements, or otherwise except as
  18  *    such appears in the above copyright notice or in the software.
  19  *
  20  * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
  21  * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
  22  * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
  23  * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
  24  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
  25  * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
  26  * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
  27  * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
  28  * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
  29  * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
  30  * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
  31  * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
  32  * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
  33  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  34  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  35  * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
  36  * OF SUCH DAMAGE.
  37  *
  38  * Author: Julian Elischer <julian@freebsd.org>
  39  *
  40  * $FreeBSD: src/sys/netgraph/ng_sample.h,v 1.7 2005/01/07 01:45:39 imp Exp $
  41  * $DragonFly: src/sys/netgraph7/ng_sample.h,v 1.2 2008/06/26 23:05:35 dillon Exp $
  42  * $Whistle: ng_sample.h,v 1.3 1999/01/20 00:22:14 archie Exp $
  43  */
  44
  45 #ifndef _NETGRAPH_NG_SAMPLE_H_
  46 #define _NETGRAPH_NG_SAMPLE_H_
  47
  48 /* Node type name. This should be unique among all netgraph node types */
  49 #define NG_XXX_NODE_TYPE        "sample"
  50
  51 /* Node type cookie. Should also be unique. This value MUST change whenever
  52    an incompatible change is made to this header file, to insure consistency.
  53    The de facto method for generating cookies is to take the output of the
  54    date command: date -u +'%s' */
  55 #define NGM_XXX_COOKIE          915491374
  56
  57 /* Number of active DLCI's we can handle */
  58 #define XXX_NUM_DLCIS           16
  59
  60 /* Hook names */
  61 #define NG_XXX_HOOK_DLCI_LEADIN "dlci"
  62 #define NG_XXX_HOOK_DOWNSTREAM  "downstream"
  63 #define NG_XXX_HOOK_DEBUG       "debug"
  64
  65 /* Netgraph commands understood by this node type */
  66 enum {
  67         NGM_XXX_SET_FLAG = 1,
  68         NGM_XXX_GET_STATUS,
  69 };
  70
  71 /* This structure is returned by the NGM_XXX_GET_STATUS command */
  72 struct ngxxxstat {
  73         u_int32_t   packets_in;         /* packets in from downstream */
  74         u_int32_t   packets_out;        /* packets out towards downstream */
  75 };
  76
  77 /*
  78  * This is used to define the 'parse type' for a struct ngxxxstat, which
  79  * is bascially a description of how to convert a binary struct ngxxxstat
  80  * to an ASCII string and back.  See ng_parse.h for more info.
  81  *
  82  * This needs to be kept in sync with the above structure definition
  83  */
  84 #define NG_XXX_STATS_TYPE_INFO  {                               \
  85           { "packets_in",       &ng_parse_uint32_type   },      \
  86           { "packets_out",      &ng_parse_uint32_type   },      \
  87           { NULL }                                              \
  88 }
  89
  90 #endif /* _NETGRAPH_NG_SAMPLE_H_ */