xref: /titanic_50/usr/src/uts/common/inet/udp_impl.h (revision b249c65cf0a7400e86a36ddab5c3fce085809859)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef	_UDP_IMPL_H
27 #define	_UDP_IMPL_H
28 
29 #pragma ident	"%Z%%M%	%I%	%E% SMI"
30 
31 /*
32  * UDP implementation private declarations.  These interfaces are
33  * used to build the IP module and are not meant to be accessed
34  * by any modules except IP itself.  They are undocumented and are
35  * subject to change without notice.
36  */
37 
38 #ifdef	__cplusplus
39 extern "C" {
40 #endif
41 
42 #ifdef _KERNEL
43 
44 #include <sys/int_types.h>
45 #include <sys/netstack.h>
46 
47 #include <netinet/in.h>
48 #include <netinet/ip6.h>
49 
50 #include <inet/common.h>
51 #include <inet/ip.h>
52 #include <inet/optcom.h>
53 
54 #define	UDP_MOD_ID		5607
55 
56 typedef struct udp_bits_s {
57 
58 	uint32_t
59 
60 	udpb_debug : 1,		/* SO_DEBUG "socket" option. */
61 	udpb_dontroute : 1,	/* SO_DONTROUTE "socket" option. */
62 	udpb_broadcast : 1,	/* SO_BROADCAST "socket" option. */
63 	udpb_useloopback : 1,	/* SO_USELOOPBACK "socket" option */
64 
65 	udpb_reuseaddr : 1,	/* SO_REUSEADDR "socket" option. */
66 	udpb_dgram_errind : 1,	/* SO_DGRAM_ERRIND option */
67 	udpb_recvdstaddr : 1,	/* IP_RECVDSTADDR option */
68 	udpb_recvopts : 1,	/* IP_RECVOPTS option */
69 
70 	udpb_unspec_source : 1,	/* IP*_UNSPEC_SRC option */
71 	udpb_ip_recvpktinfo : 1,	/* IPV6_RECVPKTINFO option  */
72 	udpb_ipv6_recvhoplimit : 1,	/* IPV6_RECVHOPLIMIT option */
73 	udpb_ipv6_recvhopopts : 1,	/* IPV6_RECVHOPOPTS option */
74 
75 	udpb_ipv6_recvdstopts : 1,	/* IPV6_RECVDSTOPTS option */
76 	udpb_ipv6_recvrthdr : 1,	/* IPV6_RECVRTHDR option */
77 	udpb_ipv6_recvtclass : 1,	/* IPV6_RECVTCLASS */
78 	udpb_ipv6_recvpathmtu : 1,	/* IPV6_RECVPATHMTU */
79 
80 	udpb_anon_priv_bind : 1,
81 	udpb_exclbind : 1,		/* ``exclusive'' binding */
82 	udpb_recvif : 1,		/* IP_RECVIF option */
83 	udpb_recvslla : 1,		/* IP_RECVSLLA option */
84 
85 	udpb_recvttl : 1,		/* IP_RECVTTL option */
86 	udpb_recvucred : 1,		/* IP_RECVUCRED option */
87 	udpb_old_ipv6_recvdstopts : 1,	/* old form of IPV6_DSTOPTS */
88 	udpb_ipv6_recvrthdrdstopts : 1,	/* IPV6_RECVRTHDRDSTOPTS */
89 
90 	udpb_rcvhdr : 1,		/* UDP_RCVHDR option */
91 	udpb_issocket : 1,		/* socket mode */
92 	udpb_direct_sockfs : 1,		/* direct calls to/from sockfs */
93 	udpb_timestamp : 1,		/* SO_TIMESTAMP "socket" option */
94 
95 	udpb_nat_t_endpoint : 1,	/* UDP_NAT_T_ENDPOINT option */
96 	udpb_pad_to_bit_31 : 3;
97 } udp_bits_t;
98 
99 #define	udp_debug	udp_bits.udpb_debug
100 #define	udp_dontroute	udp_bits.udpb_dontroute
101 #define	udp_broadcast	udp_bits.udpb_broadcast
102 #define	udp_useloopback	udp_bits.udpb_useloopback
103 
104 #define	udp_reuseaddr		udp_bits.udpb_reuseaddr
105 #define	udp_dgram_errind	udp_bits.udpb_dgram_errind
106 #define	udp_recvdstaddr		udp_bits.udpb_recvdstaddr
107 #define	udp_recvopts		udp_bits.udpb_recvopts
108 
109 #define	udp_unspec_source	udp_bits.udpb_unspec_source
110 #define	udp_ip_recvpktinfo	udp_bits.udpb_ip_recvpktinfo
111 #define	udp_ipv6_recvhoplimit	udp_bits.udpb_ipv6_recvhoplimit
112 #define	udp_ipv6_recvhopopts	udp_bits.udpb_ipv6_recvhopopts
113 
114 #define	udp_ipv6_recvdstopts	udp_bits.udpb_ipv6_recvdstopts
115 #define	udp_ipv6_recvrthdr	udp_bits.udpb_ipv6_recvrthdr
116 #define	udp_ipv6_recvtclass	udp_bits.udpb_ipv6_recvtclass
117 #define	udp_ipv6_recvpathmtu	udp_bits.udpb_ipv6_recvpathmtu
118 
119 #define	udp_anon_priv_bind	udp_bits.udpb_anon_priv_bind
120 #define	udp_exclbind		udp_bits.udpb_exclbind
121 #define	udp_recvif		udp_bits.udpb_recvif
122 #define	udp_recvslla		udp_bits.udpb_recvslla
123 
124 #define	udp_recvttl		udp_bits.udpb_recvttl
125 #define	udp_recvucred		udp_bits.udpb_recvucred
126 #define	udp_old_ipv6_recvdstopts	udp_bits.udpb_old_ipv6_recvdstopts
127 #define	udp_ipv6_recvrthdrdstopts	udp_bits.udpb_ipv6_recvrthdrdstopts
128 
129 #define	udp_rcvhdr		udp_bits.udpb_rcvhdr
130 #define	udp_issocket		udp_bits.udpb_issocket
131 #define	udp_direct_sockfs	udp_bits.udpb_direct_sockfs
132 #define	udp_timestamp		udp_bits.udpb_timestamp
133 
134 #define	udp_nat_t_endpoint	udp_bits.udpb_nat_t_endpoint
135 
136 /*
137  * Bind hash list size and hash function.  It has to be a power of 2 for
138  * hashing.
139  */
140 #define	UDP_BIND_FANOUT_SIZE	512
141 #define	UDP_BIND_HASH(lport, size) \
142 	((ntohs((uint16_t)lport)) & (size - 1))
143 
144 /* UDP bind fanout hash structure. */
145 typedef struct udp_fanout_s {
146 	struct udp_s *uf_udp;
147 	kmutex_t uf_lock;
148 #if defined(_LP64) || defined(_I32LPx)
149 	char	uf_pad[48];
150 #else
151 	char	uf_pad[56];
152 #endif
153 } udp_fanout_t;
154 
155 /*
156  * dev_q is the write side queue of the entity below IP.
157  * If there is a module below IP, we can't optimize by looking
158  * at q_first of the queue below IP. If the driver is directly
159  * below IP and if the q_first is NULL, we optimize by not doing
160  * the canput check
161  */
162 #define	DEV_Q_IS_FLOW_CTLED(dev_q)					\
163 	(((dev_q)->q_next != NULL || (dev_q)->q_first != NULL) &&	\
164 	!canput(dev_q))
165 
166 /* Kstats */
167 typedef struct udp_stat {			/* Class "net" kstats */
168 	kstat_named_t	udp_ip_send;
169 	kstat_named_t	udp_ip_ire_send;
170 	kstat_named_t	udp_ire_null;
171 	kstat_named_t	udp_drain;
172 	kstat_named_t	udp_sock_fallback;
173 	kstat_named_t	udp_rrw_busy;
174 	kstat_named_t	udp_rrw_msgcnt;
175 	kstat_named_t	udp_out_sw_cksum;
176 	kstat_named_t	udp_out_sw_cksum_bytes;
177 	kstat_named_t	udp_out_opt;
178 	kstat_named_t	udp_out_err_notconn;
179 	kstat_named_t	udp_out_err_output;
180 	kstat_named_t	udp_out_err_tudr;
181 	kstat_named_t	udp_in_pktinfo;
182 	kstat_named_t	udp_in_recvdstaddr;
183 	kstat_named_t	udp_in_recvopts;
184 	kstat_named_t	udp_in_recvif;
185 	kstat_named_t	udp_in_recvslla;
186 	kstat_named_t	udp_in_recvucred;
187 	kstat_named_t	udp_in_recvttl;
188 	kstat_named_t	udp_in_recvhopopts;
189 	kstat_named_t	udp_in_recvhoplimit;
190 	kstat_named_t	udp_in_recvdstopts;
191 	kstat_named_t	udp_in_recvrtdstopts;
192 	kstat_named_t	udp_in_recvrthdr;
193 	kstat_named_t	udp_in_recvpktinfo;
194 	kstat_named_t	udp_in_recvtclass;
195 	kstat_named_t	udp_in_timestamp;
196 	kstat_named_t	udp_ip_rcvpktinfo;
197 	kstat_named_t	udp_direct_send;
198 	kstat_named_t	udp_bwsq_send;
199 	kstat_named_t	udp_connected_direct_send;
200 	kstat_named_t	udp_connected_bwsq_send;
201 #ifdef DEBUG
202 	kstat_named_t	udp_data_conn;
203 	kstat_named_t	udp_data_notconn;
204 #endif
205 
206 } udp_stat_t;
207 
208 /* Named Dispatch Parameter Management Structure */
209 typedef struct udpparam_s {
210 	uint32_t udp_param_min;
211 	uint32_t udp_param_max;
212 	uint32_t udp_param_value;
213 	char	*udp_param_name;
214 } udpparam_t;
215 
216 #define	UDP_NUM_EPRIV_PORTS	64
217 
218 /*
219  * UDP stack instances
220  */
221 struct udp_stack {
222 	netstack_t	*us_netstack;	/* Common netstack */
223 
224 	uint_t		us_bind_fanout_size;
225 	udp_fanout_t	*us_bind_fanout;
226 
227 	int		us_num_epriv_ports;
228 	in_port_t	us_epriv_ports[UDP_NUM_EPRIV_PORTS];
229 
230 	/* Hint not protected by any lock */
231 	in_port_t	us_next_port_to_try;
232 
233 	IDP		us_nd;	/* Points to table of UDP ND variables. */
234 	udpparam_t	*us_param_arr; 	/* ndd variable table */
235 
236 	kstat_t		*us_mibkp;	/* kstats exporting mib data */
237 	kstat_t		*us_kstat;
238 	udp_stat_t	us_statistics;
239 
240 	mib2_udp_t	us_udp_mib;	/* SNMP fixed size info */
241 
242 /*
243  * This controls the rate some ndd info report functions can be used
244  * by non-priviledged users.  It stores the last time such info is
245  * requested.  When those report functions are called again, this
246  * is checked with the current time and compare with the ndd param
247  * udp_ndd_get_info_interval.
248  */
249 	clock_t		us_last_ndd_get_info_time;
250 
251 /*
252  * The smallest anonymous port in the priviledged port range which UDP
253  * looks for free port.  Use in the option UDP_ANONPRIVBIND.
254  */
255 	in_port_t	us_min_anonpriv_port;
256 
257 };
258 typedef struct udp_stack udp_stack_t;
259 
260 /* Internal udp control structure, one per open stream */
261 typedef	struct udp_s {
262 	krwlock_t	udp_rwlock;	/* Protects most of udp_t */
263 	t_scalar_t	udp_pending_op;	/* The current TPI operation */
264 	/*
265 	 * Following fields up to udp_ipversion protected by conn_lock,
266 	 * and the fanout lock i.e.uf_lock. Need both locks to change the
267 	 * field, either lock is sufficient for reading the field.
268 	 */
269 	uint32_t	udp_state;	/* TPI state */
270 	in_port_t	udp_port;	/* Port bound to this stream */
271 	in_port_t	udp_dstport;	/* Connected port */
272 	in6_addr_t	udp_v6src;	/* Source address of this stream */
273 	in6_addr_t	udp_bound_v6src; /* Explicitly bound address */
274 	in6_addr_t	udp_v6dst;	/* Connected destination */
275 	/*
276 	 * IP format that packets transmitted from this struct should use.
277 	 * Value can be IP4_VERSION or IPV6_VERSION.
278 	 */
279 	ushort_t	udp_ipversion;
280 
281 	/* Written to only once at the time of opening the endpoint */
282 	sa_family_t	udp_family;	/* Family from socket() call */
283 
284 	/* Following protected by udp_rwlock */
285 	uint32_t	udp_flowinfo;	/* Connected flow id and tclass */
286 	uint32_t	udp_max_hdr_len; /* For write offset in stream head */
287 	uint32_t	udp_ip_snd_options_len; /* Len of IPv4 options */
288 	uchar_t		*udp_ip_snd_options;    /* Ptr to IPv4 options */
289 	uint32_t	udp_ip_rcv_options_len; /* Len of IPv4 options recvd */
290 	uchar_t		*udp_ip_rcv_options;    /* Ptr to IPv4 options recvd */
291 	uchar_t		udp_multicast_ttl;	/* IP*_MULTICAST_TTL/HOPS */
292 	ipaddr_t	udp_multicast_if_addr;  /* IP_MULTICAST_IF option */
293 	uint_t		udp_multicast_if_index;	/* IPV6_MULTICAST_IF option */
294 	int		udp_bound_if;		/* IP*_BOUND_IF option */
295 
296 	/* Written to only once at the time of opening the endpoint */
297 	conn_t		*udp_connp;
298 
299 	/* Following protected by udp_rwlock */
300 	udp_bits_t	udp_bits;		/* Bit fields defined above */
301 	uint8_t		udp_type_of_service;	/* IP_TOS option */
302 	uint8_t		udp_ttl;		/* TTL or hoplimit */
303 	ip6_pkt_t	udp_sticky_ipp;		/* Sticky options */
304 	uint8_t		*udp_sticky_hdrs;	/* Prebuilt IPv6 hdrs */
305 	uint_t		udp_sticky_hdrs_len;	/* Incl. ip6h and any ip6i */
306 
307 	/* Following 2 fields protected by the uf_lock */
308 	struct udp_s	*udp_bind_hash; /* Bind hash chain */
309 	struct udp_s	**udp_ptpbhn; /* Pointer to previous bind hash next. */
310 
311 	kmutex_t	udp_drain_lock;		/* lock for udp_rcv_list */
312 	/* Protected by udp_drain_lock */
313 	boolean_t	udp_drain_qfull;	/* drain queue is full */
314 
315 	/* Following protected by udp_rwlock */
316 	mblk_t		*udp_rcv_list_head;	/* b_next chain of mblks */
317 	mblk_t		*udp_rcv_list_tail;	/* last mblk in chain */
318 	uint_t		udp_rcv_cnt;		/* total data in rcv_list */
319 	uint_t		udp_rcv_msgcnt;		/* total msgs in rcv_list */
320 	size_t		udp_rcv_hiwat;		/* receive high watermark */
321 	uint_t		udp_label_len;		/* length of security label */
322 	uint_t		udp_label_len_v6;	/* len of v6 security label */
323 	in6_addr_t 	udp_v6lastdst;		/* most recent destination */
324 
325 	uint64_t	udp_open_time;	/* time when this was opened */
326 	pid_t		udp_open_pid;	/* process id when this was opened */
327 	udp_stack_t	*udp_us;		/* Stack instance for zone */
328 } udp_t;
329 
330 /* UDP Protocol header */
331 /* UDP Protocol header aligned */
332 typedef	struct udpahdr_s {
333 	in_port_t	uha_src_port;		/* Source port */
334 	in_port_t	uha_dst_port;		/* Destination port */
335 	uint16_t	uha_length;		/* UDP length */
336 	uint16_t	uha_checksum;		/* UDP checksum */
337 } udpha_t;
338 
339 #define	us_wroff_extra			us_param_arr[0].udp_param_value
340 #define	us_ipv4_ttl			us_param_arr[1].udp_param_value
341 #define	us_ipv6_hoplimit		us_param_arr[2].udp_param_value
342 #define	us_smallest_nonpriv_port	us_param_arr[3].udp_param_value
343 #define	us_do_checksum			us_param_arr[4].udp_param_value
344 #define	us_smallest_anon_port		us_param_arr[5].udp_param_value
345 #define	us_largest_anon_port		us_param_arr[6].udp_param_value
346 #define	us_xmit_hiwat			us_param_arr[7].udp_param_value
347 #define	us_xmit_lowat			us_param_arr[8].udp_param_value
348 #define	us_recv_hiwat			us_param_arr[9].udp_param_value
349 #define	us_max_buf			us_param_arr[10].udp_param_value
350 #define	us_ndd_get_info_interval	us_param_arr[11].udp_param_value
351 
352 
353 #define	UDP_STAT(us, x)		((us)->us_statistics.x.value.ui64++)
354 #define	UDP_STAT_UPDATE(us, x, n)	\
355 			((us)->us_statistics.x.value.ui64 += (n))
356 
357 #ifdef DEBUG
358 #define	UDP_DBGSTAT(us, x)	UDP_STAT(us, x)
359 #else
360 #define	UDP_DBGSTAT(us, x)
361 #endif /* DEBUG */
362 
363 extern int	udp_opt_default(queue_t *, t_scalar_t, t_scalar_t, uchar_t *);
364 extern int	udp_opt_get(queue_t *, t_scalar_t, t_scalar_t, uchar_t *);
365 extern int	udp_opt_set(queue_t *, uint_t, int, int, uint_t, uchar_t *,
366 		    uint_t *, uchar_t *, void *, cred_t *, mblk_t *);
367 extern mblk_t	*udp_snmp_get(queue_t *, mblk_t *);
368 extern int	udp_snmp_set(queue_t *, t_scalar_t, t_scalar_t, uchar_t *, int);
369 extern void	udp_close_free(conn_t *);
370 extern void	udp_quiesce_conn(conn_t *);
371 extern void	udp_ddi_init(void);
372 extern void	udp_ddi_destroy(void);
373 extern void	udp_resume_bind(conn_t *, mblk_t *);
374 extern void	udp_output(conn_t *connp, mblk_t *mp, struct sockaddr *addr,
375 		    socklen_t addrlen);
376 extern void	udp_wput(queue_t *, mblk_t *);
377 
378 extern int	udp_opt_default(queue_t *q, t_scalar_t level, t_scalar_t name,
379     uchar_t *ptr);
380 extern int	udp_opt_get(queue_t *q, t_scalar_t level, t_scalar_t name,
381     uchar_t *ptr);
382 extern int	udp_opt_set(queue_t *q, uint_t optset_context,
383     int level, int name, uint_t inlen, uchar_t *invalp, uint_t *outlenp,
384     uchar_t *outvalp, void *thisdg_attrs, cred_t *cr, mblk_t *mblk);
385 
386 /*
387  * Object to represent database of options to search passed to
388  * {sock,tpi}optcom_req() interface routine to take care of option
389  * management and associated methods.
390  */
391 extern optdb_obj_t	udp_opt_obj;
392 extern uint_t		udp_max_optsize;
393 
394 #endif	/*  _KERNEL */
395 
396 #ifdef	__cplusplus
397 }
398 #endif
399 
400 #endif	/* _UDP_IMPL_H */
401