sys/netgraph/ng_sample.h

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