ng_ksocket.h revision 131117 
1
2/*
3 * ng_ksocket.h
4 *
5 * Copyright (c) 1996-1999 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: head/sys/netgraph/ng_ksocket.h 131117 2004-06-25 22:59:59Z julian $
40 * $Whistle: ng_ksocket.h,v 1.1 1999/11/16 20:04:40 archie Exp $
41 */
42
43#ifndef _NETGRAPH_NG_KSOCKET_H_
44#define _NETGRAPH_NG_KSOCKET_H_
45
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 */
53struct 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 */
73struct 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 */
86enum {
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#ifdef _KERNEL
98
99/* Structure for sockaddr tag */
100struct sa_tag {
101	struct m_tag	tag;
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