ip_ire.h revision 11042:2d6e217af1b4 
159243Sobrien/*
259243Sobrien * CDDL HEADER START
359243Sobrien *
459243Sobrien * The contents of this file are subject to the terms of the
559243Sobrien * Common Development and Distribution License (the "License").
659243Sobrien * You may not use this file except in compliance with the License.
759243Sobrien *
859243Sobrien * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
959243Sobrien * or http://www.opensolaris.org/os/licensing.
1059243Sobrien * See the License for the specific language governing permissions
1159243Sobrien * and limitations under the License.
1259243Sobrien *
1359243Sobrien * When distributing Covered Code, include this CDDL HEADER in each
1459243Sobrien * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
1559243Sobrien * If applicable, add the following below this CDDL HEADER, with the
1659243Sobrien * fields enclosed by brackets "[]" replaced with your own identifying
1759243Sobrien * information: Portions Copyright [yyyy] [name of copyright owner]
1859243Sobrien *
1959243Sobrien * CDDL HEADER END
2059243Sobrien */
2159243Sobrien/*
2259243Sobrien * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
2359243Sobrien * Use is subject to license terms.
2459243Sobrien */
2559243Sobrien/* Copyright (c) 1990 Mentat Inc. */
2659243Sobrien
2759243Sobrien#ifndef	_INET_IP_IRE_H
2859243Sobrien#define	_INET_IP_IRE_H
2959243Sobrien
3059243Sobrien#ifdef	__cplusplus
3159243Sobrienextern "C" {
3259243Sobrien#endif
3359243Sobrien
3459243Sobrien#define	IPV6_LL_PREFIXLEN	10	/* Number of bits in link-local pref */
3559243Sobrien
3659243Sobrien#define	IP_CACHE_TABLE_SIZE	256
3759243Sobrien#define	IP_MASK_TABLE_SIZE	(IP_ABITS + 1)		/* 33 ptrs */
3859243Sobrien
3959243Sobrien#define	IP6_FTABLE_HASH_SIZE	32	/* size of each hash table in ptrs */
4059243Sobrien#define	IP6_CACHE_TABLE_SIZE	256
4159243Sobrien#define	IP6_MASK_TABLE_SIZE	(IPV6_ABITS + 1)	/* 129 ptrs */
42
43/*
44 * We use the common modulo hash function.  In ip_ire_init(), we make
45 * sure that the cache table size is always a power of 2.  That's why
46 * we can use & instead of %.  Also note that we try hard to make sure
47 * the lower bits of an address capture most info from the whole address.
48 * The reason being that since our hash table is probably a lot smaller
49 * than 2^32 buckets so the lower bits are the most important.
50 */
51#define	IRE_ADDR_HASH(addr, table_size) \
52	(((addr) ^ ((addr) >> 8) ^ ((addr) >> 16) ^ ((addr) >> 24)) &	\
53	((table_size) - 1))
54
55/*
56 * To make a byte-order neutral hash for IPv6, just take all the
57 * bytes in the bottom 32 bits into account.
58 */
59#define	IRE_ADDR_HASH_V6(addr, table_size) 				\
60	IRE_ADDR_HASH((addr).s6_addr32[3], table_size)
61
62/* This assumes that the ftable size is a power of 2. */
63#define	IRE_ADDR_MASK_HASH_V6(addr, mask, table_size) 			\
64	((((addr).s6_addr8[8] & (mask).s6_addr8[8]) ^ 			\
65	((addr).s6_addr8[9] & (mask).s6_addr8[9]) ^			\
66	((addr).s6_addr8[10] & (mask).s6_addr8[10]) ^ 			\
67	((addr).s6_addr8[13] & (mask).s6_addr8[13]) ^ 			\
68	((addr).s6_addr8[14] & (mask).s6_addr8[14]) ^ 			\
69	((addr).s6_addr8[15] & (mask).s6_addr8[15])) & ((table_size) - 1))
70
71#define	IRE_HIDDEN_TYPE(ire_type) ((ire_type) &			\
72	(IRE_HOST | IRE_PREFIX | IRE_DEFAULT | IRE_IF_ALL | IRE_BROADCAST))
73
74/*
75 * match parameter definitions for IRE lookup routines.
76 */
77#define	MATCH_IRE_DSTONLY	0x0000	/* Match just the address */
78#define	MATCH_IRE_TYPE		0x0001	/* Match IRE type */
79#define	MATCH_IRE_MASK		0x0002	/* Match IRE mask */
80#define	MATCH_IRE_SHORTERMASK	0x0004	/* A mask shorter than the argument */
81#define	MATCH_IRE_GW		0x0008	/* Match IRE gateway */
82#define	MATCH_IRE_ILL		0x0010	/* Match IRE on the ill */
83#define	MATCH_IRE_ZONEONLY	0x0020	/* Match IREs in specified zone, ie */
84					/* don't match IRE_LOCALs from other */
85					/* zones or shared IREs */
86#define	MATCH_IRE_SECATTR	0x0040	/* Match gateway security attributes */
87#define	MATCH_IRE_TESTHIDDEN 	0x0080	/* Match ire_testhidden IREs */
88
89#define	MAX_IRE_RECURSION	4	/* Max IREs in ire_route_recursive */
90
91
92/*
93 * We use atomics so that we get an accurate accounting on the ires.
94 * Otherwise we can't determine leaks correctly.
95 */
96#define	BUMP_IRE_STATS(ire_stats, x) atomic_add_64(&(ire_stats).x, 1)
97
98#ifdef _KERNEL
99struct ts_label_s;
100struct nce_s;
101/*
102 * structure for passing args between ire_ftable_lookup and ire_find_best_route
103 */
104typedef struct ire_ftable_args_s {
105	in6_addr_t		ift_addr_v6;
106	in6_addr_t		ift_mask_v6;
107	in6_addr_t		ift_gateway_v6;
108#define	ift_addr		V4_PART_OF_V6(ift_addr_v6)
109#define	ift_mask		V4_PART_OF_V6(ift_mask_v6)
110#define	ift_gateway		V4_PART_OF_V6(ift_gateway_v6)
111	int			ift_type;
112	const ill_t		*ift_ill;
113	zoneid_t		ift_zoneid;
114	const ts_label_t	*ift_tsl;
115	int			ift_flags;
116	ire_t			*ift_best_ire;
117} ire_ftable_args_t;
118
119extern	ipaddr_t	ip_plen_to_mask(uint_t);
120extern	in6_addr_t	*ip_plen_to_mask_v6(uint_t, in6_addr_t *);
121
122extern	int	ip_ire_advise(queue_t *, mblk_t *, cred_t *);
123extern	int	ip_ire_delete(queue_t *, mblk_t *, cred_t *);
124extern	void	ip_ire_reclaim(void *);
125
126extern	int	ip_mask_to_plen(ipaddr_t);
127extern	int	ip_mask_to_plen_v6(const in6_addr_t *);
128
129extern	ire_t	*ire_add(ire_t *);
130extern	ire_t	*ire_add_v6(ire_t *);
131extern	int	ire_atomic_start(irb_t *irb_ptr, ire_t *ire);
132extern	void	ire_atomic_end(irb_t *irb_ptr, ire_t *ire);
133
134extern	ire_t	*ire_create(uchar_t *, uchar_t *, uchar_t *,
135    ushort_t, ill_t *, zoneid_t, uint_t, tsol_gc_t *, ip_stack_t *);
136
137extern	ire_t	**ire_create_bcast(ill_t *, ipaddr_t, zoneid_t, ire_t **);
138extern	ire_t	*ire_create_if_clone(ire_t *, const in6_addr_t *, uint_t *);
139extern	ire_t	*ire_lookup_bcast(ill_t *, ipaddr_t, zoneid_t);
140extern	int	ire_init_v4(ire_t *, uchar_t *, uchar_t *, uchar_t *,
141    ushort_t, ill_t *, zoneid_t, uint_t, tsol_gc_t *, ip_stack_t *);
142extern	int	ire_init_v6(ire_t *, const in6_addr_t *, const in6_addr_t *,
143    const in6_addr_t *, ushort_t, ill_t *, zoneid_t, uint_t, tsol_gc_t *,
144    ip_stack_t *);
145
146extern	int	ire_init_common(ire_t *, ushort_t, ill_t *, zoneid_t, uint_t,
147    uchar_t, tsol_gc_t *, ip_stack_t *);
148
149extern	ire_t	*ire_create_v6(const in6_addr_t *, const in6_addr_t *,
150    const in6_addr_t *, ushort_t, ill_t *, zoneid_t, uint_t,
151    tsol_gc_t *, ip_stack_t *);
152
153extern	void	ire_delete(ire_t *);
154extern	void	ire_delete_v6(ire_t *);
155
156/*
157 * ire_pref used to make sure we don't set up routing loops in the ire_dep
158 * chain.
159 */
160extern	int	ire_pref(ire_t *);
161extern	boolean_t ire_dep_build(ire_t *[], uint_t [], uint_t);
162extern	void	ire_dep_delete_if_clone(ire_t *);
163extern	void	ire_dep_incr_generation(ire_t *);
164extern	void	ire_dep_remove(ire_t *);
165extern	void	ire_dep_unbuild(ire_t *[], uint_t);
166extern	uint_t	ire_dep_validate_generations(ire_t *);
167extern	void	ire_dep_invalidate_generations(ire_t *);
168extern	boolean_t ire_determine_nce_capable(ire_t *);
169
170extern	void	ire_flush_cache_v4(ire_t *, int);
171extern	void	ire_flush_cache_v6(ire_t *, int);
172
173extern	ire_t	*ire_ftable_lookup_v4(ipaddr_t, ipaddr_t, ipaddr_t, int,
174    const ill_t *, zoneid_t, const struct ts_label_s *, int, uint32_t,
175    ip_stack_t *, uint_t *);
176extern	ire_t	*ire_ftable_lookup_v6(const in6_addr_t *, const in6_addr_t *,
177    const in6_addr_t *, int, const ill_t *, zoneid_t,
178    const struct ts_label_s *, int, uint32_t, ip_stack_t *, uint_t *);
179
180extern	ire_t	*ire_ftable_lookup_simple_v4(ipaddr_t, uint32_t, ip_stack_t *,
181    uint_t *);
182extern	ire_t	*ire_ftable_lookup_simple_v6(const in6_addr_t *, uint32_t,
183    ip_stack_t *, uint_t *);
184
185extern boolean_t ire_gateway_ok_zone_v4(ipaddr_t, zoneid_t, ill_t *,
186    const ts_label_t *, ip_stack_t *, boolean_t);
187extern boolean_t ire_gateway_ok_zone_v6(const in6_addr_t *, zoneid_t, ill_t *,
188    const ts_label_t *, ip_stack_t *, boolean_t);
189
190extern ire_t	*ire_alt_local(ire_t *, zoneid_t, const ts_label_t *,
191    const ill_t *, uint_t *);
192
193extern  ill_t	*ire_lookup_multi_ill_v4(ipaddr_t, zoneid_t, ip_stack_t *,
194    boolean_t *, ipaddr_t *);
195extern  ill_t	*ire_lookup_multi_ill_v6(const in6_addr_t *, zoneid_t,
196    ip_stack_t *, boolean_t *, in6_addr_t *);
197
198extern	ire_t	*ire_nexthop(ire_t *);
199extern	ill_t	*ire_nexthop_ill(ire_t *);
200extern	ill_t	*ire_nce_ill(ire_t *);
201
202extern	ire_t	*ire_reject(ip_stack_t *, boolean_t);
203extern	ire_t	*ire_blackhole(ip_stack_t *, boolean_t);
204extern	ire_t	*ire_multicast(ill_t *);
205
206/* The different ire_recvfn functions */
207extern void	ire_recv_forward_v4(ire_t *, mblk_t *, void *,
208    ip_recv_attr_t *);
209extern void	ire_recv_noroute_v4(ire_t *, mblk_t *, void *,
210    ip_recv_attr_t *);
211extern void	ire_recv_broadcast_v4(ire_t *, mblk_t *, void *,
212    ip_recv_attr_t *);
213extern void	ire_recv_multicast_v4(ire_t *, mblk_t *, void *,
214    ip_recv_attr_t *);
215extern void	ire_recv_multirt_v4(ire_t *, mblk_t *, void *,
216    ip_recv_attr_t *);
217extern void	ire_recv_loopback_v4(ire_t *, mblk_t *, void *,
218    ip_recv_attr_t *);
219extern void	ire_recv_local_v4(ire_t *, mblk_t *, void *,
220    ip_recv_attr_t *);
221extern void	ire_recv_noaccept_v4(ire_t *, mblk_t *, void *,
222    ip_recv_attr_t *);
223
224extern void	ire_recv_forward_v6(ire_t *, mblk_t *, void *,
225    ip_recv_attr_t *);
226extern void	ire_recv_noroute_v6(ire_t *, mblk_t *, void *,
227    ip_recv_attr_t *);
228extern void	ire_recv_multicast_v6(ire_t *, mblk_t *, void *,
229    ip_recv_attr_t *);
230extern void	ire_recv_multirt_v6(ire_t *, mblk_t *, void *,
231    ip_recv_attr_t *);
232extern void	ire_recv_loopback_v6(ire_t *, mblk_t *, void *,
233    ip_recv_attr_t *);
234extern void	ire_recv_local_v6(ire_t *, mblk_t *, void *, ip_recv_attr_t *);
235extern void	ire_recv_noaccept_v6(ire_t *, mblk_t *, void *,
236    ip_recv_attr_t *);
237
238extern	void	irb_refhold(irb_t *);
239extern	void	irb_refhold_locked(irb_t *);
240extern	void	irb_refrele(irb_t *);
241extern  void	irb_increment_generation(irb_t *);
242
243extern	void	ire_refhold(ire_t *);
244extern	void	ire_refhold_notr(ire_t *);
245extern	void	ire_refhold_locked(ire_t *);
246extern	void	ire_refrele(ire_t *);
247extern	void	ire_refrele_notr(ire_t *);
248extern	void	ire_make_condemned(ire_t *);
249extern	boolean_t ire_no_good(ire_t *);
250extern	nce_t	*ire_handle_condemned_nce(nce_t *, ire_t *, ipha_t *, ip6_t *,
251    boolean_t);
252
253extern ire_t   	*ire_round_robin(irb_t *, ire_ftable_args_t *, uint_t,
254    ire_t *, ip_stack_t *);
255
256extern ire_t	*ire_route_recursive_v4(ipaddr_t, uint_t, const ill_t *,
257    zoneid_t, const ts_label_t *, uint_t, boolean_t, uint32_t, ip_stack_t *,
258    ipaddr_t *, tsol_ire_gw_secattr_t **, uint_t *);
259extern ire_t	*ire_route_recursive_v6(const in6_addr_t *, uint_t,
260    const ill_t *, zoneid_t, const ts_label_t *, uint_t, boolean_t, uint32_t,
261    ip_stack_t *, in6_addr_t *, tsol_ire_gw_secattr_t **, uint_t *);
262extern ire_t	*ire_route_recursive_dstonly_v4(ipaddr_t, boolean_t,
263    uint32_t, ip_stack_t *);
264extern ire_t	*ire_route_recursive_dstonly_v6(const in6_addr_t *, boolean_t,
265    uint32_t, ip_stack_t *);
266extern ire_t	*ire_route_recursive_impl_v4(ire_t *ire, ipaddr_t, uint_t,
267    const ill_t *, zoneid_t, const ts_label_t *, uint_t, boolean_t, uint32_t,
268    ip_stack_t *, ipaddr_t *, tsol_ire_gw_secattr_t **, uint_t *);
269extern ire_t	*ire_route_recursive_impl_v6(ire_t *ire, const in6_addr_t *,
270    uint_t, const ill_t *, zoneid_t, const ts_label_t *, uint_t, boolean_t,
271    uint32_t, ip_stack_t *, in6_addr_t *, tsol_ire_gw_secattr_t **, uint_t *);
272
273/* The different ire_sendfn functions */
274extern int	ire_send_local_v4(ire_t *, mblk_t *, void *,
275    ip_xmit_attr_t *, uint32_t *);
276extern int	ire_send_multirt_v4(ire_t *, mblk_t *, void *,
277    ip_xmit_attr_t *, uint32_t *);
278extern int	ire_send_noroute_v4(ire_t *, mblk_t *, void *,
279    ip_xmit_attr_t *, uint32_t *);
280extern int	ire_send_multicast_v4(ire_t *, mblk_t *, void *,
281    ip_xmit_attr_t *, uint32_t *);
282extern int	ire_send_broadcast_v4(ire_t *, mblk_t *, void *,
283    ip_xmit_attr_t *, uint32_t *);
284extern int	ire_send_wire_v4(ire_t *, mblk_t *, void *,
285    ip_xmit_attr_t *, uint32_t *);
286extern int	ire_send_local_v6(ire_t *, mblk_t *, void *,
287    ip_xmit_attr_t *, uint32_t *);
288extern int	ire_send_multirt_v6(ire_t *, mblk_t *, void *,
289    ip_xmit_attr_t *, uint32_t *);
290extern int	ire_send_noroute_v6(ire_t *, mblk_t *, void *,
291    ip_xmit_attr_t *, uint32_t *);
292extern int	ire_send_multicast_v6(ire_t *, mblk_t *, void *,
293    ip_xmit_attr_t *, uint32_t *);
294extern int	ire_send_wire_v6(ire_t *, mblk_t *, void *,
295    ip_xmit_attr_t *, uint32_t *);
296
297extern nce_t	*ire_to_nce_pkt(ire_t *, mblk_t *);
298extern nce_t	*ire_to_nce(ire_t *, ipaddr_t, const in6_addr_t *);
299
300/* Different ire_postfragfn functions */
301extern int	ip_xmit(mblk_t *, struct nce_s *,
302    iaflags_t, uint_t, uint32_t, zoneid_t, zoneid_t, uintptr_t *);
303extern int	ip_postfrag_loopcheck(mblk_t *, struct nce_s *,
304    iaflags_t, uint_t, uint32_t, zoneid_t, zoneid_t, uintptr_t *);
305extern int	ip_postfrag_multirt_v4(mblk_t *, struct nce_s *,
306    iaflags_t, uint_t, uint32_t, zoneid_t, zoneid_t, uintptr_t *);
307extern int	ip_postfrag_multirt_v6(mblk_t *, struct nce_s *,
308    iaflags_t, uint_t, uint32_t, zoneid_t, zoneid_t, uintptr_t *);
309
310extern void	ip_postfrag_loopback(mblk_t *, struct nce_s *,
311    iaflags_t, uint_t, zoneid_t);
312extern int	ire_revalidate_nce(ire_t *);
313
314extern ire_t	*ip_select_route_pkt(mblk_t *, ip_xmit_attr_t *,
315    uint_t *, int *, boolean_t *);
316extern ire_t	*ip_select_route(const in6_addr_t *, ip_xmit_attr_t *,
317    uint_t *, in6_addr_t *, int *, boolean_t *);
318extern ire_t	*ip_select_route_v4(ipaddr_t, ip_xmit_attr_t *,
319    uint_t *, ipaddr_t *, int *, boolean_t *);
320extern ire_t	*ip_select_route_v6(const in6_addr_t *, ip_xmit_attr_t *,
321    uint_t *, in6_addr_t *, int *, boolean_t *);
322
323extern	void	ire_walk(pfv_t, void *, ip_stack_t *);
324extern	void	ire_walk_ill(uint_t, uint_t, pfv_t, void *, ill_t *);
325extern	void	ire_walk_v4(pfv_t, void *, zoneid_t, ip_stack_t *);
326extern  void	ire_walk_ill_tables(uint_t match_flags, uint_t ire_type,
327    pfv_t func, void *arg, size_t ftbl_sz, size_t htbl_sz,
328    irb_t **ipftbl, ill_t *ill,
329    zoneid_t zoneid, ip_stack_t *);
330extern	void	ire_walk_v6(pfv_t, void *, zoneid_t, ip_stack_t *);
331
332extern boolean_t	ire_match_args(ire_t *, ipaddr_t, ipaddr_t, ipaddr_t,
333    int, const ill_t *, zoneid_t, const struct ts_label_s *, int);
334extern boolean_t	ire_match_args_v6(ire_t *, const in6_addr_t *,
335    const in6_addr_t *, const in6_addr_t *, int, const ill_t *, zoneid_t,
336    const ts_label_t *, int);
337
338extern  struct nce_s	*arp_nce_init(ill_t *, in_addr_t, int);
339extern  boolean_t	ire_walk_ill_match(uint_t, uint_t, ire_t *, ill_t *,
340    zoneid_t, ip_stack_t *);
341extern  void ire_increment_generation(ire_t *);
342extern  void ire_increment_multicast_generation(ip_stack_t *, boolean_t);
343
344#endif /* _KERNEL */
345
346#ifdef	__cplusplus
347}
348#endif
349
350#endif	/* _INET_IP_IRE_H */
351