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