2 * Copyright (c) 1982, 1986, 1989, 1993
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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 * 4. Neither the name of the University nor the names of its contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * From: @(#)if.h 8.1 (Berkeley) 6/10/93
33 #ifndef _NET_IF_CLONE_H_
34 #define _NET_IF_CLONE_H_
38 #define IFC_CLONE_INITIALIZER(name, data, maxunit, \
39 attach, match, create, destroy) \
40 { { 0 }, name, maxunit, NULL, 0, data, attach, match, create, destroy }
43 * Structure describing a `cloning' interface.
46 * (c) const until freeing
47 * (d) driver specific data, may need external protection.
48 * (e) locked by if_cloners_mtx
49 * (i) locked by ifc_mtx mtx
52 LIST_ENTRY(if_clone) ifc_list; /* (e) On list of cloners */
53 const char *ifc_name; /* (c) Name of device, e.g. `gif' */
54 int ifc_maxunit; /* (c) Maximum unit number */
55 unsigned char *ifc_units; /* (i) Bitmap to handle units. */
56 /* Considered private, access */
57 /* via ifc_(alloc|free)_unit(). */
58 int ifc_bmlen; /* (c) Bitmap length. */
59 void *ifc_data; /* (*) Data for ifc_* functions. */
61 /* (c) Driver specific cloning functions. Called with no locks held. */
62 void (*ifc_attach)(struct if_clone *);
63 int (*ifc_match)(struct if_clone *, const char *);
64 int (*ifc_create)(struct if_clone *, char *, size_t, caddr_t);
65 int (*ifc_destroy)(struct if_clone *, struct ifnet *);
67 long ifc_refcnt; /* (i) Refrence count. */
68 struct mtx ifc_mtx; /* Muted to protect members. */
69 LIST_HEAD(, ifnet) ifc_iflist; /* (i) List of cloned interfaces */
72 void if_clone_init(void);
73 void if_clone_attach(struct if_clone *);
74 void if_clone_detach(struct if_clone *);
75 void vnet_if_clone_init(void);
77 int if_clone_create(char *, size_t, caddr_t);
78 int if_clone_destroy(const char *);
79 int if_clone_destroyif(struct if_clone *, struct ifnet *);
80 int if_clone_list(struct if_clonereq *);
82 int ifc_name2unit(const char *name, int *unit);
83 int ifc_alloc_unit(struct if_clone *, int *);
84 void ifc_free_unit(struct if_clone *, int);
87 * The ifc_simple functions, structures, and macros implement basic
88 * cloning as in 5.[012].
91 struct ifc_simple_data {
92 int ifcs_minifs; /* minimum number of interfaces */
94 int (*ifcs_create)(struct if_clone *, int, caddr_t);
95 void (*ifcs_destroy)(struct ifnet *);
98 /* interface clone event */
99 typedef void (*if_clone_event_handler_t)(void *, struct if_clone *);
100 EVENTHANDLER_DECLARE(if_clone_event, if_clone_event_handler_t);
102 #define IFC_SIMPLE_DECLARE(name, minifs) \
103 struct ifc_simple_data name##_cloner_data = \
104 {minifs, name##_clone_create, name##_clone_destroy}; \
105 struct if_clone name##_cloner = \
106 IFC_CLONE_INITIALIZER(#name, &name##_cloner_data, IF_MAXUNIT, \
107 ifc_simple_attach, ifc_simple_match, ifc_simple_create, ifc_simple_destroy)
109 void ifc_simple_attach(struct if_clone *);
110 int ifc_simple_match(struct if_clone *, const char *);
111 int ifc_simple_create(struct if_clone *, char *, size_t, caddr_t);
112 int ifc_simple_destroy(struct if_clone *, struct ifnet *);
116 #endif /* !_NET_IF_CLONE_H_ */