xref: /freebsd/sys/net/if_clone.h (revision 6829dae12bb055451fa467da4589c43bd03b1e64)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1982, 1986, 1989, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. Neither the name of the University nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  *
31  *	From: @(#)if.h	8.1 (Berkeley) 6/10/93
32  * $FreeBSD$
33  */
34 
35 #ifndef	_NET_IF_CLONE_H_
36 #define	_NET_IF_CLONE_H_
37 
38 #ifdef _KERNEL
39 
40 #define IFC_NOGROUP 0x1
41 
42 struct if_clone;
43 
44 /* Methods. */
45 typedef int	ifc_match_t(struct if_clone *, const char *);
46 typedef int	ifc_create_t(struct if_clone *, char *, size_t, caddr_t);
47 typedef int	ifc_destroy_t(struct if_clone *, struct ifnet *);
48 
49 typedef int	ifcs_create_t(struct if_clone *, int, caddr_t);
50 typedef void	ifcs_destroy_t(struct ifnet *);
51 
52 /* Interface cloner (de)allocating functions. */
53 struct if_clone *
54 	if_clone_advanced(const char *, u_int, ifc_match_t, ifc_create_t,
55 		      ifc_destroy_t);
56 struct if_clone *
57 	if_clone_simple(const char *, ifcs_create_t, ifcs_destroy_t, u_int);
58 void	if_clone_detach(struct if_clone *);
59 
60 /* Unit (de)allocating fucntions. */
61 int	ifc_name2unit(const char *name, int *unit);
62 int	ifc_alloc_unit(struct if_clone *, int *);
63 void	ifc_free_unit(struct if_clone *, int);
64 const char *ifc_name(struct if_clone *);
65 void ifc_flags_set(struct if_clone *, int flags);
66 int ifc_flags_get(struct if_clone *);
67 
68 #ifdef _SYS_EVENTHANDLER_H_
69 /* Interface clone event. */
70 typedef void (*if_clone_event_handler_t)(void *, struct if_clone *);
71 EVENTHANDLER_DECLARE(if_clone_event, if_clone_event_handler_t);
72 #endif
73 
74 /* The below interfaces used only by net/if.c. */
75 void	vnet_if_clone_init(void);
76 int	if_clone_create(char *, size_t, caddr_t);
77 int	if_clone_destroy(const char *);
78 int	if_clone_list(struct if_clonereq *);
79 struct if_clone *if_clone_findifc(struct ifnet *);
80 void	if_clone_addgroup(struct ifnet *, struct if_clone *);
81 
82 /* The below interface used only by epair(4). */
83 int	if_clone_destroyif(struct if_clone *, struct ifnet *);
84 
85 #endif /* _KERNEL */
86 #endif /* !_NET_IF_CLONE_H_ */
87