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#include <sys/_eventhandler.h>
41
42#define IFC_NOGROUP 0x1
43
44struct if_clone;
45
46/* Methods. */
47typedef int	ifc_match_t(struct if_clone *, const char *);
48typedef int	ifc_create_t(struct if_clone *, char *, size_t, caddr_t);
49typedef int	ifc_destroy_t(struct if_clone *, struct ifnet *);
50
51typedef int	ifcs_create_t(struct if_clone *, int, caddr_t);
52typedef void	ifcs_destroy_t(struct ifnet *);
53
54/* Interface cloner (de)allocating functions. */
55struct if_clone *
56	if_clone_advanced(const char *, u_int, ifc_match_t, ifc_create_t,
57		      ifc_destroy_t);
58struct if_clone *
59	if_clone_simple(const char *, ifcs_create_t, ifcs_destroy_t, u_int);
60void	if_clone_detach(struct if_clone *);
61
62/* Unit (de)allocating fucntions. */
63int	ifc_name2unit(const char *name, int *unit);
64int	ifc_alloc_unit(struct if_clone *, int *);
65void	ifc_free_unit(struct if_clone *, int);
66const char *ifc_name(struct if_clone *);
67void ifc_flags_set(struct if_clone *, int flags);
68int ifc_flags_get(struct if_clone *);
69
70/* Interface clone event. */
71typedef void (*if_clone_event_handler_t)(void *, struct if_clone *);
72EVENTHANDLER_DECLARE(if_clone_event, if_clone_event_handler_t);
73
74/* The below interfaces used only by net/if.c. */
75void	vnet_if_clone_init(void);
76int	if_clone_create(char *, size_t, caddr_t);
77int	if_clone_destroy(const char *);
78int	if_clone_list(struct if_clonereq *);
79struct if_clone *if_clone_findifc(struct ifnet *);
80void	if_clone_addgroup(struct ifnet *, struct if_clone *);
81
82/* The below interfaces are used only by epair(4). */
83void	if_clone_addif(struct if_clone *, struct ifnet *);
84int	if_clone_destroyif(struct if_clone *, struct ifnet *);
85
86#endif /* _KERNEL */
87#endif /* !_NET_IF_CLONE_H_ */
88