sys/netgraph/ng_bridge.h

   1 /*
   2  * ng_bridge.h
   3  */
   4
   5 /*-
   6  * Copyright (c) 2000 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: Archie Cobbs <archie@freebsd.org>
  39  *
  40  * $FreeBSD$
  41  */
  42
  43 #ifndef _NETGRAPH_NG_BRIDGE_H_
  44 #define _NETGRAPH_NG_BRIDGE_H_
  45
  46 /* Node type name and magic cookie */
  47 #define NG_BRIDGE_NODE_TYPE             "bridge"
  48 #define NGM_BRIDGE_COOKIE               1569321993
  49
  50 /* Hook names */
  51 #define NG_BRIDGE_HOOK_LINK_PREFIX      "link"   /* append decimal integer */
  52 #define NG_BRIDGE_HOOK_LINK_FMT         "link%d" /* for use with printf(3) */
  53 #define NG_BRIDGE_HOOK_UPLINK_PREFIX    "uplink" /* append decimal integer */
  54 #define NG_BRIDGE_HOOK_UPLINK_FMT       "uplink%d" /* for use with printf(3) */
  55
  56 /* Node configuration structure */
  57 struct ng_bridge_config {
  58         u_char          debugLevel;             /* debug level */
  59         u_int32_t       loopTimeout;            /* link loopback mute time */
  60         u_int32_t       maxStaleness;           /* max host age before nuking */
  61         u_int32_t       minStableAge;           /* min time for a stable host */
  62 };
  63
  64 /* Keep this in sync with the above structure definition */
  65 #define NG_BRIDGE_CONFIG_TYPE_INFO      {                       \
  66           { "debugLevel",       &ng_parse_uint8_type    },      \
  67           { "loopTimeout",      &ng_parse_uint32_type   },      \
  68           { "maxStaleness",     &ng_parse_uint32_type   },      \
  69           { "minStableAge",     &ng_parse_uint32_type   },      \
  70           { NULL }                                              \
  71 }
  72
  73 /* Statistics structure (one for each link) */
  74 struct ng_bridge_link_stats {
  75         u_int64_t       recvOctets;     /* total octets rec'd on link */
  76         u_int64_t       recvPackets;    /* total pkts rec'd on link */
  77         u_int64_t       recvMulticasts; /* multicast pkts rec'd on link */
  78         u_int64_t       recvBroadcasts; /* broadcast pkts rec'd on link */
  79         u_int64_t       recvUnknown;    /* pkts rec'd with unknown dest addr */
  80         u_int64_t       recvRunts;      /* pkts rec'd less than 14 bytes */
  81         u_int64_t       recvInvalid;    /* pkts rec'd with bogus source addr */
  82         u_int64_t       xmitOctets;     /* total octets xmit'd on link */
  83         u_int64_t       xmitPackets;    /* total pkts xmit'd on link */
  84         u_int64_t       xmitMulticasts; /* multicast pkts xmit'd on link */
  85         u_int64_t       xmitBroadcasts; /* broadcast pkts xmit'd on link */
  86         u_int64_t       loopDrops;      /* pkts dropped due to loopback */
  87         u_int64_t       loopDetects;    /* number of loop detections */
  88         u_int64_t       memoryFailures; /* times couldn't get mem or mbuf */
  89 };
  90
  91 /* Keep this in sync with the above structure definition */
  92 #define NG_BRIDGE_STATS_TYPE_INFO       {                       \
  93           { "recvOctets",       &ng_parse_uint64_type   },      \
  94           { "recvPackets",      &ng_parse_uint64_type   },      \
  95           { "recvMulticast",    &ng_parse_uint64_type   },      \
  96           { "recvBroadcast",    &ng_parse_uint64_type   },      \
  97           { "recvUnknown",      &ng_parse_uint64_type   },      \
  98           { "recvRunts",        &ng_parse_uint64_type   },      \
  99           { "recvInvalid",      &ng_parse_uint64_type   },      \
 100           { "xmitOctets",       &ng_parse_uint64_type   },      \
 101           { "xmitPackets",      &ng_parse_uint64_type   },      \
 102           { "xmitMulticasts",   &ng_parse_uint64_type   },      \
 103           { "xmitBroadcasts",   &ng_parse_uint64_type   },      \
 104           { "loopDrops",        &ng_parse_uint64_type   },      \
 105           { "loopDetects",      &ng_parse_uint64_type   },      \
 106           { "memoryFailures",   &ng_parse_uint64_type   },      \
 107           { NULL }                                              \
 108 }
 109
 110 struct ng_bridge_link;
 111 typedef struct ng_bridge_link *link_p;
 112
 113 /* external representation of the host */
 114 struct ng_bridge_hostent {
 115         u_char          addr[6];                /* ethernet address */
 116         char            hook[NG_HOOKSIZ];       /* link where addr can be found */
 117         u_int16_t       age;                    /* seconds ago entry was created */
 118         u_int16_t       staleness;              /* seconds ago host last heard from */
 119 };
 120
 121 /* Keep this in sync with the above structure definition */
 122 #define NG_BRIDGE_HOST_TYPE_INFO(entype)        {               \
 123           { "addr",             (entype)                },      \
 124           { "hook",             &ng_parse_hookbuf_type  },      \
 125           { "age",              &ng_parse_uint16_type   },      \
 126           { "staleness",        &ng_parse_uint16_type   },      \
 127           { NULL }                                              \
 128 }
 129
 130 /* Structure returned by NGM_BRIDGE_GET_TABLE */
 131 struct ng_bridge_host_ary {
 132         u_int32_t                       numHosts;
 133         struct ng_bridge_hostent        hosts[];
 134 };
 135
 136 /* Keep this in sync with the above structure definition */
 137 #define NG_BRIDGE_HOST_ARY_TYPE_INFO(harytype)  {               \
 138           { "numHosts",         &ng_parse_uint32_type   },      \
 139           { "hosts",            (harytype)              },      \
 140           { NULL }                                              \
 141 }
 142
 143 struct ng_bridge_move_host {
 144         u_char          addr[ETHER_ADDR_LEN];   /* ethernet address */
 145         char            hook[NG_HOOKSIZ];       /* link where addr can be found */
 146 };
 147 /* Keep this in sync with the above structure definition */
 148 #define NG_BRIDGE_MOVE_HOST_TYPE_INFO(entype)   {               \
 149           { "addr",             (entype)                },      \
 150           { "hook",             &ng_parse_hookbuf_type  },      \
 151 }
 152
 153 /* Netgraph control messages */
 154 enum {
 155         NGM_BRIDGE_SET_CONFIG = 1,      /* set node configuration */
 156         NGM_BRIDGE_GET_CONFIG,          /* get node configuration */
 157         NGM_BRIDGE_RESET,               /* reset (forget) all information */
 158         NGM_BRIDGE_GET_STATS,           /* get link stats */
 159         NGM_BRIDGE_CLR_STATS,           /* clear link stats */
 160         NGM_BRIDGE_GETCLR_STATS,        /* atomically get & clear link stats */
 161         NGM_BRIDGE_GET_TABLE,           /* get link table */
 162         NGM_BRIDGE_SET_PERSISTENT,      /* set persistent mode */
 163         NGM_BRIDGE_MOVE_HOST,           /* move a host to a link */
 164 };
 165
 166 #endif /* _NETGRAPH_NG_BRIDGE_H_ */