sys/netgraph/one2many/ng_one2many.h

   1
   2 /*
   3  * ng_one2many.h
   4  *
   5  * Copyright (c) 2000 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_one2many.h,v 1.1.2.3 2002/07/02 23:44:02 archie Exp $
  40  */
  41
  42 #ifndef _NETGRAPH_NG_ONE2MANY_H_
  43 #define _NETGRAPH_NG_ONE2MANY_H_
  44
  45 /* Node type name and magic cookie */
  46 #define NG_ONE2MANY_NODE_TYPE           "one2many"
  47 #define NGM_ONE2MANY_COOKIE             971111383
  48
  49 /* Hook names */
  50 #define NG_ONE2MANY_HOOK_ONE            "one"
  51 #define NG_ONE2MANY_HOOK_MANY_PREFIX    "many"   /* append decimal integer */
  52 #define NG_ONE2MANY_HOOK_MANY_FMT       "many%d" /* for use with printf(3) */
  53
  54 /* Maximum number of supported "many" links */
  55 #define NG_ONE2MANY_MAX_LINKS           64
  56
  57 /* Link number used to indicate the "one" hook */
  58 #define NG_ONE2MANY_ONE_LINKNUM         (-1)
  59
  60 /* Algorithms for outgoing packet distribution (XXX only one so far) */
  61 #define NG_ONE2MANY_XMIT_ROUNDROBIN     1       /* round-robin delivery */
  62
  63 /* Algorithms for detecting link failure (XXX only one so far) */
  64 #define NG_ONE2MANY_FAIL_MANUAL         1       /* use enabledLinks[] array */
  65
  66 /* Node configuration structure */
  67 struct ng_one2many_config {
  68         u_int32_t       xmitAlg;                /* how to distribute packets */
  69         u_int32_t       failAlg;                /* how to detect link failure */
  70         u_char          enabledLinks[NG_ONE2MANY_MAX_LINKS];
  71 };
  72
  73 /* Keep this in sync with the above structure definition */
  74 #define NG_ONE2MANY_CONFIG_TYPE_INFO(atype)     {               \
  75           { "xmitAlg",          &ng_parse_uint32_type   },      \
  76           { "failAlg",          &ng_parse_uint32_type   },      \
  77           { "enabledLinks",     (atype)                 },      \
  78           { NULL }                                              \
  79 }
  80
  81 /* Statistics structure (one for each link) */
  82 struct ng_one2many_link_stats {
  83         u_int64_t       recvOctets;     /* total octets rec'd on link */
  84         u_int64_t       recvPackets;    /* total pkts rec'd on link */
  85         u_int64_t       xmitOctets;     /* total octets xmit'd on link */
  86         u_int64_t       xmitPackets;    /* total pkts xmit'd on link */
  87 };
  88
  89 /* Keep this in sync with the above structure definition */
  90 #define NG_ONE2MANY_LINK_STATS_TYPE_INFO        {               \
  91           { "recvOctets",       &ng_parse_uint64_type   },      \
  92           { "recvPackets",      &ng_parse_uint64_type   },      \
  93           { "xmitOctets",       &ng_parse_uint64_type   },      \
  94           { "xmitPackets",      &ng_parse_uint64_type   },      \
  95           { NULL }                                              \
  96 }
  97
  98 /* Netgraph control messages */
  99 enum {
 100         NGM_ONE2MANY_SET_CONFIG,        /* set configuration */
 101         NGM_ONE2MANY_GET_CONFIG,        /* get configuration */
 102         NGM_ONE2MANY_GET_STATS,         /* get link stats */
 103         NGM_ONE2MANY_CLR_STATS,         /* clear link stats */
 104         NGM_ONE2MANY_GETCLR_STATS,      /* atomically get & clear link stats */
 105 };
 106
 107 #endif /* _NETGRAPH_NG_ONE2MANY_H_ */
 108