[dragonfly.git] / sys / net / netmsg.h

/*
 * Copyright (c) 2003 Jeffrey Hsu
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by Jeffrey M. Hsu.
 * 4. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * $DragonFly: src/sys/net/netmsg.h,v 1.10 2008/10/27 02:56:30 sephe Exp $
 */

#ifndef _NET_NETMSG_H_
#define _NET_NETMSG_H_

#ifndef _SYS_THREAD_H_
#include <sys/thread.h>
#endif
#ifndef _SYS_PROTOSW_H_
#include <sys/protosw.h>
#endif

struct pktinfo;

typedef void (*netisr_fn_t)(netmsg_t);
typedef void (*netisr_ru_t)(void);
typedef void (*netisr_cpufn_t)(struct mbuf **, int);
typedef void (*netisr_hashck_t)(struct mbuf *, const struct pktinfo *);

#if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)

/*
 * The base netmsg prefixes all netmsgs and includes an embedded LWKT
 * message.
 */
struct netmsg_base {
	struct lwkt_msg		lmsg;
	netisr_fn_t		nm_dispatch;
	struct socket		*nm_so;
};

typedef struct netmsg_base *netmsg_base_t;

/*
 * NETISR messages
 *
 * NOTE: netmsg_packet is embedded in mbufs.
 */
TAILQ_HEAD(notifymsglist, netmsg_so_notify);

struct netmsg_packet {
	struct netmsg_base	base;
	struct mbuf		*nm_packet;
	int			nm_nxt;
};

struct netmsg_pr_timeout {
	struct netmsg_base	base;
};

struct netmsg_so_notify;
typedef __boolean_t (*msg_predicate_fn_t)(struct netmsg_so_notify *);

struct netmsg_so_notify {
	struct netmsg_base	base;
	msg_predicate_fn_t	nm_predicate;
	int			nm_fflags; /* flags e.g. FNONBLOCK */
	int			nm_etype;  /* receive or send event */
	TAILQ_ENTRY(netmsg_so_notify) nm_list;
};

struct netmsg_so_notify_abort {
	struct netmsg_base	base;
	struct netmsg_so_notify	*nm_notifymsg;
};

#define NM_REVENT	0x1		/* event on receive buffer */
#define NM_SEVENT	0x2		/* event on send buffer */

/*
 * User protocol requests messages.
 */
struct netmsg_pru_abort {
	struct netmsg_base	base;
};

struct netmsg_pru_accept {
	struct netmsg_base	base;
	struct sockaddr		**nm_nam;
};

struct netmsg_pru_attach {
	struct netmsg_base	base;
	int			nm_proto;
	struct pru_attach_info	*nm_ai;
};

struct netmsg_pru_bind {
	struct netmsg_base	base;
	struct sockaddr		*nm_nam;
	struct thread		*nm_td;
};

struct netmsg_pru_connect {
	struct netmsg_base	base;
	struct sockaddr		*nm_nam;
	struct thread		*nm_td;
	struct mbuf		*nm_m;		/* connect with send */
	int			nm_flags;	/* connect with send */
	int			nm_reconnect;	/* message control */
};

#define NMSG_RECONNECT_RECONNECT	0x0001	/* thread port change */
#define NMSG_RECONNECT_NAMALLOC		0x0002	/* nm_nam allocated */
#define NMSG_RECONNECT_PUSH		0x0004	/* call tcp_output */
#define NMSG_RECONNECT_FALLBACK		0x0008	/* fallback to ipv4 */

struct netmsg_pru_connect2 {
	struct netmsg_base	base;
	struct socket		*nm_so1;
	struct socket		*nm_so2;
};

struct netmsg_pru_control {
	struct netmsg_base	base;
	u_long			nm_cmd;
	caddr_t			nm_data;
	struct ifnet		*nm_ifp;
	struct thread		*nm_td;
};

struct netmsg_pru_detach {
	struct netmsg_base	base;
};

struct netmsg_pru_disconnect {
	struct netmsg_base	base;
};

struct netmsg_pru_listen {
	struct netmsg_base	base;
	struct thread		*nm_td;
};

struct netmsg_pru_peeraddr {
	struct netmsg_base	base;
	struct sockaddr		**nm_nam;
};

struct netmsg_pru_rcvd {
	struct netmsg_base	base;
	int			nm_flags;
};

struct netmsg_pru_rcvoob {
	struct netmsg_base	base;
	struct mbuf		*nm_m;
	int			nm_flags;
};

struct netmsg_pru_send {
	struct netmsg_base	base;
	int			nm_flags;	/* PRUS_xxx */
	struct mbuf		*nm_m;
	struct sockaddr		*nm_addr;
	struct mbuf		*nm_control;
	struct thread		*nm_td;
	/*
	 * XXX hack to be 100% certain netmsg_pru_send can be overwritten
	 * by netmsg_pru_connect
	 */
	char			nm_dummy[sizeof(struct netmsg_pru_connect) -
					 sizeof(struct netmsg_base)];
};

#define PRUS_OOB		0x1
#define PRUS_EOF		0x2
#define PRUS_MORETOCOME		0x4
#define PRUS_NAMALLOC		0x8

struct netmsg_pru_sense {
	struct netmsg_base	base;
	struct stat		*nm_stat;
};

struct netmsg_pru_shutdown {
	struct netmsg_base	base;
};

struct netmsg_pru_sockaddr {
	struct netmsg_base	base;
	struct sockaddr		**nm_nam;
};

struct netmsg_pru_sosend {
	struct netmsg_base	base;
	struct sockaddr		*nm_addr;
	struct uio		*nm_uio;
	struct mbuf		*nm_top;
	struct mbuf		*nm_control;
	int			nm_flags;
	struct thread		*nm_td;
};

struct netmsg_pru_soreceive {
	struct netmsg_base	base;
	struct sockaddr		*nm_addr;
	struct sockaddr		**nm_paddr;
	struct uio		*nm_uio;
	struct sockbuf		*nm_sio;
	struct mbuf		**nm_controlp;
	int			*nm_flagsp;
};

struct netmsg_pr_ctloutput {
	struct netmsg_base	base;
	struct sockopt		*nm_sopt;
};

struct netmsg_pru_ctlinput {
	struct netmsg_base	base;
	int			nm_cmd;
	struct sockaddr		*nm_arg;
	void			*nm_extra;
};

/*
 * Union of all possible netmsgs.  Note that when a netmsg is sent the
 * actual allocated storage is likely only the size of the particular
 * class of message, and not sizeof(union netmsg).
 */
union netmsg {
	struct lwkt_msg			lmsg;		/* base embedded */
	struct netmsg_base		base;		/* base embedded */

	struct netmsg_packet		packet;		/* mbuf embedded */
	struct netmsg_pr_timeout	timeout;
	struct netmsg_so_notify		notify;
	struct netmsg_so_notify_abort	notify_abort;

	struct netmsg_pr_ctloutput	ctloutput;

	struct netmsg_pru_abort		abort;
	struct netmsg_pru_accept	accept;		/* synchronous */
	struct netmsg_pru_attach	attach;
	struct netmsg_pru_bind		bind;
	struct netmsg_pru_connect	connect;
	struct netmsg_pru_connect2	connect2;
	struct netmsg_pru_control	control;	/* synchronous */
	struct netmsg_pru_detach	detach;
	struct netmsg_pru_disconnect	disconnect;
	struct netmsg_pru_listen	listen;
	struct netmsg_pru_peeraddr	peeraddr;
	struct netmsg_pru_rcvd		rcvd;
	struct netmsg_pru_rcvoob	rcvoob;
	struct netmsg_pru_send		send;
	struct netmsg_pru_sense		sense;
	struct netmsg_pru_shutdown	shutdown;
	struct netmsg_pru_sockaddr	sockaddr;
	struct netmsg_pru_sosend	sosend;		/* synchronous */
	struct netmsg_pru_soreceive	soreceive;	/* synchronous */
	struct netmsg_pru_ctlinput	ctlinput;
};

#endif	/* _KERNEL || _KERNEL_STRUCTURES */

#endif	/* !_NET_NETMSG_H_ */
Commit	Line	Data
8a113dae JH	1	/*
	2	* Copyright (c) 2003 Jeffrey Hsu
	3	* All rights reserved.
	4	*
	5	* Redistribution and use in source and binary forms, with or without
	6	* modification, are permitted provided that the following conditions
	7	* are met:
	8	* 1. Redistributions of source code must retain the above copyright
	9	* notice, this list of conditions and the following disclaimer.
	10	* 2. Redistributions in binary form must reproduce the above copyright
	11	* notice, this list of conditions and the following disclaimer in the
	12	* documentation and/or other materials provided with the distribution.
	13	* 3. All advertising materials mentioning features or use of this software
	14	* must display the following acknowledgement:
	15	* This product includes software developed by Jeffrey M. Hsu.
	16	* 4. The name of the author may not be used to endorse or promote products
	17	* derived from this software without specific prior written permission.
	18	*
	19	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
	20	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
	21	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
	22	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
	23	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
	24	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
	25	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
	26	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	27	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
	28	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	29	*
e3873585	30	* $DragonFly: src/sys/net/netmsg.h,v 1.10 2008/10/27 02:56:30 sephe Exp $
8a113dae JH	31	*/
8a113dae JH	32
1bd40720 MD	33	#ifndef _NET_NETMSG_H_
	34	#define _NET_NETMSG_H_
	35
	36	#ifndef _SYS_THREAD_H_
	37	#include <sys/thread.h>
	38	#endif
	39	#ifndef _SYS_PROTOSW_H_
	40	#include <sys/protosw.h>
	41	#endif
8a113dae	42
e6f77b88 SZ	43	struct pktinfo;
e6f77b88 SZ	44
002c1265	45	typedef void (*netisr_fn_t)(netmsg_t);
c3c96e44 MD	46	typedef void (*netisr_ru_t)(void);
c3c96e44 MD	47	typedef void (netisr_cpufn_t)(struct mbuf *, int);
e6f77b88	48	typedef void (netisr_hashck_t)(struct mbuf , const struct pktinfo *);
4599cf19	49
002c1265 MD	50	#if defined(_KERNEL) \|\| defined(_KERNEL_STRUCTURES)
002c1265 MD	51
4599cf19	52	/*
002c1265 MD	53	* The base netmsg prefixes all netmsgs and includes an embedded LWKT
002c1265 MD	54	* message.
4599cf19	55	*/
002c1265 MD	56	struct netmsg_base {
002c1265 MD	57	struct lwkt_msg lmsg;
c3c96e44 MD	58	netisr_fn_t nm_dispatch;
c3c96e44 MD	59	struct socket *nm_so;
002c1265	60	};
4599cf19	61
002c1265 MD	62	typedef struct netmsg_base *netmsg_base_t;
	63
	64	/*
	65	* NETISR messages
	66	*
	67	* NOTE: netmsg_packet is embedded in mbufs.
	68	*/
	69	TAILQ_HEAD(notifymsglist, netmsg_so_notify);
	70
	71	struct netmsg_packet {
	72	struct netmsg_base base;
	73	struct mbuf *nm_packet;
	74	int nm_nxt;
	75	};
	76
	77	struct netmsg_pr_timeout {
	78	struct netmsg_base base;
	79	};
	80
	81	struct netmsg_so_notify;
	82	typedef __boolean_t (msg_predicate_fn_t)(struct netmsg_so_notify );
	83
	84	struct netmsg_so_notify {
	85	struct netmsg_base base;
	86	msg_predicate_fn_t nm_predicate;
	87	int nm_fflags; /* flags e.g. FNONBLOCK */
	88	int nm_etype; /* receive or send event */
	89	TAILQ_ENTRY(netmsg_so_notify) nm_list;
	90	};
	91
	92	struct netmsg_so_notify_abort {
	93	struct netmsg_base base;
	94	struct netmsg_so_notify *nm_notifymsg;
	95	};
	96
	97	#define NM_REVENT 0x1 /* event on receive buffer */
	98	#define NM_SEVENT 0x2 /* event on send buffer */
8d420ad8	99
8a113dae JH	100	/*
	101	* User protocol requests messages.
	102	*/
	103	struct netmsg_pru_abort {
002c1265	104	struct netmsg_base base;
8a113dae JH	105	};
	106
	107	struct netmsg_pru_accept {
002c1265	108	struct netmsg_base base;
c3c96e44	109	struct sockaddr **nm_nam;
8a113dae JH	110	};
	111
	112	struct netmsg_pru_attach {
002c1265	113	struct netmsg_base base;
c3c96e44 MD	114	int nm_proto;
c3c96e44 MD	115	struct pru_attach_info *nm_ai;
8a113dae JH	116	};
	117
	118	struct netmsg_pru_bind {
002c1265	119	struct netmsg_base base;
c3c96e44 MD	120	struct sockaddr *nm_nam;
c3c96e44 MD	121	struct thread *nm_td;
8a113dae JH	122	};
	123
	124	struct netmsg_pru_connect {
002c1265	125	struct netmsg_base base;
c3c96e44 MD	126	struct sockaddr *nm_nam;
c3c96e44 MD	127	struct thread *nm_td;
002c1265 MD	128	struct mbuf nm_m; / connect with send */
	129	int nm_flags; /* connect with send */
	130	int nm_reconnect; /* message control */
8a113dae JH	131	};
8a113dae JH	132
002c1265 MD	133	#define NMSG_RECONNECT_RECONNECT 0x0001 /* thread port change */
	134	#define NMSG_RECONNECT_NAMALLOC 0x0002 /* nm_nam allocated */
	135	#define NMSG_RECONNECT_PUSH 0x0004 /* call tcp_output */
	136	#define NMSG_RECONNECT_FALLBACK 0x0008 /* fallback to ipv4 */
	137
8a113dae	138	struct netmsg_pru_connect2 {
002c1265	139	struct netmsg_base base;
c3c96e44 MD	140	struct socket *nm_so1;
c3c96e44 MD	141	struct socket *nm_so2;
8a113dae JH	142	};
	143
	144	struct netmsg_pru_control {
002c1265	145	struct netmsg_base base;
c3c96e44 MD	146	u_long nm_cmd;
	147	caddr_t nm_data;
	148	struct ifnet *nm_ifp;
	149	struct thread *nm_td;
8a113dae JH	150	};
	151
	152	struct netmsg_pru_detach {
002c1265	153	struct netmsg_base base;
8a113dae JH	154	};
	155
	156	struct netmsg_pru_disconnect {
002c1265	157	struct netmsg_base base;
8a113dae JH	158	};
	159
	160	struct netmsg_pru_listen {
002c1265	161	struct netmsg_base base;
c3c96e44	162	struct thread *nm_td;
8a113dae JH	163	};
	164
	165	struct netmsg_pru_peeraddr {
002c1265	166	struct netmsg_base base;
c3c96e44	167	struct sockaddr **nm_nam;
8a113dae JH	168	};
	169
	170	struct netmsg_pru_rcvd {
002c1265	171	struct netmsg_base base;
c3c96e44	172	int nm_flags;
8a113dae JH	173	};
	174
	175	struct netmsg_pru_rcvoob {
002c1265	176	struct netmsg_base base;
c3c96e44 MD	177	struct mbuf *nm_m;
c3c96e44 MD	178	int nm_flags;
8a113dae JH	179	};
	180
	181	struct netmsg_pru_send {
002c1265 MD	182	struct netmsg_base base;
002c1265 MD	183	int nm_flags; /* PRUS_xxx */
c3c96e44 MD	184	struct mbuf *nm_m;
	185	struct sockaddr *nm_addr;
	186	struct mbuf *nm_control;
	187	struct thread *nm_td;
002c1265 MD	188	/*
	189	* XXX hack to be 100% certain netmsg_pru_send can be overwritten
	190	* by netmsg_pru_connect
	191	*/
	192	char nm_dummy[sizeof(struct netmsg_pru_connect) -
	193	sizeof(struct netmsg_base)];
8a113dae JH	194	};
8a113dae JH	195
002c1265 MD	196	#define PRUS_OOB 0x1
	197	#define PRUS_EOF 0x2
	198	#define PRUS_MORETOCOME 0x4
	199	#define PRUS_NAMALLOC 0x8
	200
8a113dae	201	struct netmsg_pru_sense {
002c1265	202	struct netmsg_base base;
c3c96e44	203	struct stat *nm_stat;
8a113dae JH	204	};
	205
	206	struct netmsg_pru_shutdown {
002c1265	207	struct netmsg_base base;
8a113dae JH	208	};
	209
	210	struct netmsg_pru_sockaddr {
002c1265	211	struct netmsg_base base;
c3c96e44	212	struct sockaddr **nm_nam;
8a113dae JH	213	};
	214
	215	struct netmsg_pru_sosend {
002c1265	216	struct netmsg_base base;
c3c96e44 MD	217	struct sockaddr *nm_addr;
	218	struct uio *nm_uio;
	219	struct mbuf *nm_top;
	220	struct mbuf *nm_control;
	221	int nm_flags;
	222	struct thread *nm_td;
8a113dae JH	223	};
	224
	225	struct netmsg_pru_soreceive {
002c1265	226	struct netmsg_base base;
c3c96e44 MD	227	struct sockaddr *nm_addr;
	228	struct sockaddr **nm_paddr;
	229	struct uio *nm_uio;
	230	struct sockbuf *nm_sio;
	231	struct mbuf **nm_controlp;
	232	int *nm_flagsp;
8a113dae JH	233	};
8a113dae JH	234
002c1265 MD	235	struct netmsg_pr_ctloutput {
002c1265 MD	236	struct netmsg_base base;
c3c96e44	237	struct sockopt *nm_sopt;
e71a125f AE	238	};
e71a125f AE	239
e3873585	240	struct netmsg_pru_ctlinput {
002c1265	241	struct netmsg_base base;
c3c96e44 MD	242	int nm_cmd;
	243	struct sockaddr *nm_arg;
	244	void *nm_extra;
e3873585 SZ	245	};
e3873585 SZ	246
002c1265 MD	247	/*
	248	* Union of all possible netmsgs. Note that when a netmsg is sent the
	249	* actual allocated storage is likely only the size of the particular
	250	* class of message, and not sizeof(union netmsg).
	251	*/
	252	union netmsg {
	253	struct lwkt_msg lmsg; /* base embedded */
	254	struct netmsg_base base; /* base embedded */
	255
	256	struct netmsg_packet packet; /* mbuf embedded */
	257	struct netmsg_pr_timeout timeout;
	258	struct netmsg_so_notify notify;
	259	struct netmsg_so_notify_abort notify_abort;
	260
	261	struct netmsg_pr_ctloutput ctloutput;
	262
	263	struct netmsg_pru_abort abort;
	264	struct netmsg_pru_accept accept; /* synchronous */
	265	struct netmsg_pru_attach attach;
	266	struct netmsg_pru_bind bind;
	267	struct netmsg_pru_connect connect;
	268	struct netmsg_pru_connect2 connect2;
	269	struct netmsg_pru_control control; /* synchronous */
	270	struct netmsg_pru_detach detach;
	271	struct netmsg_pru_disconnect disconnect;
	272	struct netmsg_pru_listen listen;
	273	struct netmsg_pru_peeraddr peeraddr;
	274	struct netmsg_pru_rcvd rcvd;
	275	struct netmsg_pru_rcvoob rcvoob;
	276	struct netmsg_pru_send send;
	277	struct netmsg_pru_sense sense;
	278	struct netmsg_pru_shutdown shutdown;
	279	struct netmsg_pru_sockaddr sockaddr;
	280	struct netmsg_pru_sosend sosend; /* synchronous */
	281	struct netmsg_pru_soreceive soreceive; /* synchronous */
	282	struct netmsg_pru_ctlinput ctlinput;
	283	};
	284
8d420ad8 SZ	285	#endif /* _KERNEL \|\| _KERNEL_STRUCTURES */
	286
	287	#endif /* !_NET_NETMSG_H_ */