sys/netgraph/tee/ng_tee.h

   1
   2 /*
   3  * ng_tee.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: Archie Cobbs <archie@freebsd.org>
  38  *
  39  * $FreeBSD: src/sys/netgraph/ng_tee.h,v 1.3.2.3 2002/07/02 23:44:03 archie Exp $
  40  * $Whistle: ng_tee.h,v 1.2 1999/01/20 00:22:14 archie Exp $
  41  */
  42
  43 #ifndef _NETGRAPH_TEE_H_
  44 #define _NETGRAPH_TEE_H_
  45
  46 /* Node type name and magic cookie */
  47 #define NG_TEE_NODE_TYPE        "tee"
  48 #define NGM_TEE_COOKIE          916107047
  49
  50 /* Hook names */
  51 #define NG_TEE_HOOK_RIGHT       "right"
  52 #define NG_TEE_HOOK_LEFT        "left"
  53 #define NG_TEE_HOOK_RIGHT2LEFT  "right2left"
  54 #define NG_TEE_HOOK_LEFT2RIGHT  "left2right"
  55
  56 /* Statistics structure for one hook */
  57 struct ng_tee_hookstat {
  58         u_int64_t       inOctets;
  59         u_int64_t       inFrames;
  60         u_int64_t       outOctets;
  61         u_int64_t       outFrames;
  62 };
  63
  64 /* Keep this in sync with the above structure definition */
  65 #define NG_TEE_HOOKSTAT_INFO    {                               \
  66           { "inOctets",         &ng_parse_uint64_type   },      \
  67           { "inFrames",         &ng_parse_uint64_type   },      \
  68           { "outOctets",        &ng_parse_uint64_type   },      \
  69           { "outFrames",        &ng_parse_uint64_type   },      \
  70           { NULL }                                              \
  71 }
  72
  73 /* Statistics structure returned by NGM_TEE_GET_STATS */
  74 struct ng_tee_stats {
  75         struct ng_tee_hookstat  right;
  76         struct ng_tee_hookstat  left;
  77         struct ng_tee_hookstat  right2left;
  78         struct ng_tee_hookstat  left2right;
  79 };
  80
  81 /* Keep this in sync with the above structure definition */
  82 #define NG_TEE_STATS_INFO(hstype)       {                       \
  83           { "right",            (hstype)                },      \
  84           { "left",             (hstype)                },      \
  85           { "right2left",       (hstype)                },      \
  86           { "left2right",       (hstype)                },      \
  87           { NULL }                                              \
  88 }
  89
  90 /* Netgraph commands */
  91 enum {
  92         NGM_TEE_GET_STATS = 1,          /* get stats */
  93         NGM_TEE_CLR_STATS,              /* clear stats */
  94         NGM_TEE_GETCLR_STATS,           /* atomically get and clear stats */
  95 };
  96
  97 #endif /* _NETGRAPH_TEE_H_ */