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