xref: /dragonfly/sys/net/if_clone.h (revision 0db87cb7)
1 /*
2  * Copyright (c) 1982, 1986, 1989, 1993
3  *	The Regents of the University of California.  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 the University of
16  *	California, Berkeley and its contributors.
17  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  *	From: @(#)if.h	8.1 (Berkeley) 6/10/93
34  * $FreeBSD: src/sys/net/if_var.h,v 1.18.2.16 2003/04/15 18:11:19 fjoe Exp $
35  * $FreeBSD: src/sys/net/if.h,v 1.58.2.9 2002/08/30 14:23:38 sobomax Exp $
36  * $DragonFly: src/sys/net/if_clone.h,v 1.1 2008/01/11 11:59:40 sephe Exp $
37  */
38 
39 #ifndef	_NET_IF_CLONE_H_
40 #define	_NET_IF_CLONE_H_
41 
42 #ifdef _KERNEL
43 
44 #ifndef _SYS_QUEUE_H_
45 #include <sys/queue.h>
46 #endif
47 
48 /*
49  * Structure describing a `cloning' interface.
50  */
51 struct if_clone {
52 	LIST_ENTRY(if_clone) ifc_list;	/* on list of cloners */
53 	const char	*ifc_name;	/* name of device, e.g. `gif' */
54 	size_t		ifc_namelen;	/* length of name */
55 	int		ifc_minifs;	/* minimum number of interfaces */
56 	int 		ifc_maxunit;	/* maximum unit number */
57 	unsigned char	*ifc_units;	/* bitmap to handle units */
58 	int 		ifc_bmlen;	/* bitmap length */
59 
60 	int		(*ifc_create)(struct if_clone *, int, caddr_t);
61 	int		(*ifc_destroy)(struct ifnet *);
62 };
63 
64 #define IF_CLONE_INITIALIZER(name, create, destroy, minifs, maxunit)	\
65 { { 0 }, name, sizeof(name) - 1, minifs, maxunit, NULL, 0, create, destroy }
66 
67 /* interface clone event */
68 typedef void (*if_clone_event_handler_t)(void *, struct if_clone *);
69 EVENTHANDLER_DECLARE(if_clone_event, if_clone_event_handler_t);
70 
71 struct if_clonereq;	/* XXX, should move definition from net/if.h */
72 
73 void	if_clone_attach(struct if_clone *);
74 void	if_clone_detach(struct if_clone *);
75 int	if_clone_create(char *, int, caddr_t);
76 int	if_clone_destroy(const char *);
77 int	if_clone_list(struct if_clonereq *);
78 
79 #endif	/* _KERNEL */
80 
81 #endif /* !_NET_IF_CLONE_H_ */
82