sys/netgraph7/ng_ksocket.h

   1 /*
   2  * ng_ksocket.h
   3  */
   4
   5 /*-
   6  * Copyright (c) 1996-1999 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: src/sys/netgraph/ng_ksocket.h,v 1.13 2005/10/28 14:41:28 ru Exp $
  41  * $DragonFly: src/sys/netgraph7/ng_ksocket.h,v 1.2 2008/06/26 23:05:35 dillon Exp $
  42  * $Whistle: ng_ksocket.h,v 1.1 1999/11/16 20:04:40 archie Exp $
  43  */
  44
  45 #ifndef _NETGRAPH_NG_KSOCKET_H_
  46 #define _NETGRAPH_NG_KSOCKET_H_
  47
  48 #include <sys/socket.h>
  49
  50 /* Node type name and magic cookie */
  51 #define NG_KSOCKET_NODE_TYPE    "ksocket"
  52 #define NGM_KSOCKET_COOKIE      942710669
  53
  54 /* For NGM_KSOCKET_SETOPT and NGM_KSOCKET_GETOPT control messages */
  55 struct ng_ksocket_sockopt {
  56         int32_t         level;          /* second arg of [gs]etsockopt() */
  57         int32_t         name;           /* third arg of [gs]etsockopt() */
  58         u_char          value[];        /* fourth arg of [gs]etsockopt() */
  59 };
  60
  61 /* Max length socket option we can return via NGM_KSOCKET_GETOPT
  62    XXX This should not be necessary, we should dynamically size
  63    XXX the response. Until then.. */
  64 #define NG_KSOCKET_MAX_OPTLEN   1024
  65
  66 /* Keep this in sync with the above structure definition */
  67 #define NG_KSOCKET_SOCKOPT_INFO(svtype) {                       \
  68           { "level",            &ng_parse_int32_type    },      \
  69           { "name",             &ng_parse_int32_type    },      \
  70           { "value",            (svtype)                },      \
  71           { NULL }                                              \
  72 }
  73
  74 /* For NGM_KSOCKET_ACCEPT control message responses */
  75 struct ng_ksocket_accept {
  76         u_int32_t       nodeid;         /* node ID of connected ksocket */
  77         struct sockaddr addr;           /* peer's address (variable length) */
  78 };
  79
  80 /* Keep this in sync with the above structure definition */
  81 #define NGM_KSOCKET_ACCEPT_INFO {                                       \
  82           { "nodeid",           &ng_parse_hint32_type             },    \
  83           { "addr",             &ng_ksocket_generic_sockaddr_type },    \
  84           { NULL }                                                      \
  85 }
  86
  87 /* Netgraph commands */
  88 enum {
  89         NGM_KSOCKET_BIND = 1,
  90         NGM_KSOCKET_LISTEN,
  91         NGM_KSOCKET_ACCEPT,
  92         NGM_KSOCKET_CONNECT,
  93         NGM_KSOCKET_GETNAME,
  94         NGM_KSOCKET_GETPEERNAME,
  95         NGM_KSOCKET_SETOPT,
  96         NGM_KSOCKET_GETOPT,
  97 };
  98
  99 #ifdef _KERNEL
 100
 101 /* Structure for sockaddr tag */
 102 struct sa_tag {
 103         struct m_tag    tag;
 104         ng_ID_t         id;
 105         struct sockaddr sa;
 106 };
 107
 108 /* Tag information ID's */
 109 #define NG_KSOCKET_TAG_SOCKADDR 1       /* data is struct sockaddr */
 110
 111 #endif /* _KERNEL */
 112 #endif /* _NETGRAPH_NG_KSOCKET_H_ */