1/*	$KAME: if_gif.h,v 1.17 2000/09/11 11:36:41 sumikawa Exp $	*/
2
3/*-
4 * SPDX-License-Identifier: BSD-3-Clause
5 *
6 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
7 * Copyright (c) 2018 Andrey V. Elsukov <ae@FreeBSD.org>
8 * All rights reserved.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 *    notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 *    notice, this list of conditions and the following disclaimer in the
17 *    documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the project nor the names of its contributors
19 *    may be used to endorse or promote products derived from this software
20 *    without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * SUCH DAMAGE.
33 */
34
35#ifndef _NET_IF_GIF_H_
36#define _NET_IF_GIF_H_
37
38#ifdef _KERNEL
39
40struct ip;
41struct ip6_hdr;
42
43extern	void (*ng_gif_input_p)(struct ifnet *ifp, struct mbuf **mp,
44		int af);
45extern	void (*ng_gif_input_orphan_p)(struct ifnet *ifp, struct mbuf *m,
46		int af);
47extern	int  (*ng_gif_output_p)(struct ifnet *ifp, struct mbuf **mp);
48extern	void (*ng_gif_attach_p)(struct ifnet *ifp);
49extern	void (*ng_gif_detach_p)(struct ifnet *ifp);
50
51struct gif_softc {
52	struct ifnet		*gif_ifp;
53	int			gif_family;
54	int			gif_flags;
55	u_int			gif_fibnum;
56	u_int			gif_options;
57	void			*gif_netgraph;	/* netgraph node info */
58	union {
59		void		*hdr;
60		struct ip	*iphdr;
61		struct ip6_hdr	*ip6hdr;
62	} gif_uhdr;
63
64	CK_LIST_ENTRY(gif_softc) chain;
65	CK_LIST_ENTRY(gif_softc) srchash;
66};
67CK_LIST_HEAD(gif_list, gif_softc);
68MALLOC_DECLARE(M_GIF);
69
70#ifndef GIF_HASH_SIZE
71#define	GIF_HASH_SIZE	(1 << 4)
72#endif
73
74#define	GIF2IFP(sc)	((sc)->gif_ifp)
75#define	gif_iphdr	gif_uhdr.iphdr
76#define	gif_hdr		gif_uhdr.hdr
77#define	gif_ip6hdr	gif_uhdr.ip6hdr
78
79#define GIF_MTU		(1280)	/* Default MTU */
80#define	GIF_MTU_MIN	(1280)	/* Minimum MTU */
81#define	GIF_MTU_MAX	(8192)	/* Maximum MTU */
82
83struct etherip_header {
84#if BYTE_ORDER == LITTLE_ENDIAN
85	u_int	eip_resvl:4,	/* reserved */
86		eip_ver:4;	/* version */
87#endif
88#if BYTE_ORDER == BIG_ENDIAN
89	u_int	eip_ver:4,	/* version */
90		eip_resvl:4;	/* reserved */
91#endif
92	u_int8_t eip_resvh;	/* reserved */
93} __packed;
94
95#define ETHERIP_VERSION			0x3
96
97#define	GIF_WAIT()	epoch_wait_preempt(net_epoch_preempt)
98
99/* Prototypes */
100struct gif_list *gif_hashinit(void);
101void gif_hashdestroy(struct gif_list *);
102
103void gif_input(struct mbuf *, struct ifnet *, int, uint8_t);
104int gif_output(struct ifnet *, struct mbuf *, const struct sockaddr *,
105	       struct route *);
106
107void in_gif_init(void);
108void in_gif_uninit(void);
109int in_gif_output(struct ifnet *, struct mbuf *, int, uint8_t);
110int in_gif_ioctl(struct gif_softc *, u_long, caddr_t);
111int in_gif_setopts(struct gif_softc *, u_int);
112
113void in6_gif_init(void);
114void in6_gif_uninit(void);
115int in6_gif_output(struct ifnet *, struct mbuf *, int, uint8_t);
116int in6_gif_ioctl(struct gif_softc *, u_long, caddr_t);
117int in6_gif_setopts(struct gif_softc *, u_int);
118#endif /* _KERNEL */
119
120#define GIFGOPTS	_IOWR('i', 150, struct ifreq)
121#define GIFSOPTS	_IOW('i', 151, struct ifreq)
122
123#define	GIF_IGNORE_SOURCE	0x0002
124#define	GIF_OPTMASK		(GIF_IGNORE_SOURCE)
125
126#endif /* _NET_IF_GIF_H_ */
127