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