sys/netgraph/ksocket/ng_ksocket.h

   1 /*
   2  * ng_ksocket.h
   3  *
   4  * Copyright (c) 1996-1999 Whistle Communications, Inc.
   5  * All rights reserved.
   6  *
   7  * Subject to the following obligations and disclaimer of warranty, use and
   8  * redistribution of this software, in source or object code forms, with or
   9  * without modifications are expressly permitted by Whistle Communications;
  10  * provided, however, that:
  11  * 1. Any and all reproductions of the source or object code must include the
  12  *    copyright notice above and the following disclaimer of warranties; and
  13  * 2. No rights are granted, in any manner or form, to use Whistle
  14  *    Communications, Inc. trademarks, including the mark "WHISTLE
  15  *    COMMUNICATIONS" on advertising, endorsements, or otherwise except as
  16  *    such appears in the above copyright notice or in the software.
  17  *
  18  * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
  19  * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
  20  * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
  21  * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
  22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
  23  * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
  24  * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
  25  * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
  26  * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
  27  * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
  28  * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
  29  * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
  30  * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
  31  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  32  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  33  * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
  34  * OF SUCH DAMAGE.
  35  *
  36  * Author: Archie Cobbs <archie@freebsd.org>
  37  *
  38  * $FreeBSD: src/sys/netgraph/ng_ksocket.h,v 1.2.2.5 2002/07/02 23:44:02 archie Exp $
  39  * $Whistle: ng_ksocket.h,v 1.1 1999/11/16 20:04:40 archie Exp $
  40  */
  41
  42 #ifndef _NETGRAPH_KSOCKET_H_
  43 #define _NETGRAPH_KSOCKET_H_
  44
  45 #include <sys/types.h>
  46 #include <sys/socket.h>
  47
  48 /* Node type name and magic cookie */
  49 #define NG_KSOCKET_NODE_TYPE    "ksocket"
  50 #define NGM_KSOCKET_COOKIE      942710669
  51
  52 /* For NGM_KSOCKET_SETOPT and NGM_KSOCKET_GETOPT control messages */
  53 struct ng_ksocket_sockopt {
  54         int32_t         level;          /* second arg of [gs]etsockopt() */
  55         int32_t         name;           /* third arg of [gs]etsockopt() */
  56         u_char          value[0];       /* fourth arg of [gs]etsockopt() */
  57 };
  58
  59 /* Max length socket option we can return via NGM_KSOCKET_GETOPT
  60    XXX This should not be necessary, we should dynamically size
  61    XXX the response. Until then.. */
  62 #define NG_KSOCKET_MAX_OPTLEN   1024
  63
  64 /* Keep this in sync with the above structure definition */
  65 #define NG_KSOCKET_SOCKOPT_INFO(svtype) {                       \
  66           { "level",            &ng_parse_int32_type    },      \
  67           { "name",             &ng_parse_int32_type    },      \
  68           { "value",            (svtype)                },      \
  69           { NULL }                                              \
  70 }
  71
  72 /* For NGM_KSOCKET_ACCEPT control message responses */
  73 struct ng_ksocket_accept {
  74         u_int32_t       nodeid;         /* node ID of connected ksocket */
  75         struct sockaddr addr;           /* peer's address (variable length) */
  76 };
  77
  78 /* Keep this in sync with the above structure definition */
  79 #define NGM_KSOCKET_ACCEPT_INFO {                                       \
  80           { "nodeid",           &ng_parse_hint32_type             },    \
  81           { "addr",             &ng_ksocket_generic_sockaddr_type },    \
  82           { NULL }                                                      \
  83 }
  84
  85 /* Netgraph commands */
  86 enum {
  87         NGM_KSOCKET_BIND = 1,
  88         NGM_KSOCKET_LISTEN,
  89         NGM_KSOCKET_ACCEPT,
  90         NGM_KSOCKET_CONNECT,
  91         NGM_KSOCKET_GETNAME,
  92         NGM_KSOCKET_GETPEERNAME,
  93         NGM_KSOCKET_SETOPT,
  94         NGM_KSOCKET_GETOPT,
  95 };
  96
  97 /* Meta information ID's */
  98 #define NG_KSOCKET_META_SOCKADDR        1       /* data is struct sockaddr */
  99
 100 #endif /* _NETGRAPH_KSOCKET_H_ */