xref: /dragonfly/sys/net/if_clone.h (revision bb54c3a2a4a6207be408250820bde132dab4af2d)
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. 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.
16  *
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
27  * SUCH DAMAGE.
28  *
29  *        From: @(#)if.h      8.1 (Berkeley) 6/10/93
30  * $FreeBSD: src/sys/net/if_var.h,v 1.18.2.16 2003/04/15 18:11:19 fjoe Exp $
31  * $FreeBSD: src/sys/net/if.h,v 1.58.2.9 2002/08/30 14:23:38 sobomax Exp $
32  */
33 
34 #ifndef   _NET_IF_CLONE_H_
35 #define   _NET_IF_CLONE_H_
36 
37 #include <sys/cdefs.h>
38 
39 #if __BSD_VISIBLE
40 /*
41  * Structure used to query names of interface cloners.
42  */
43 struct if_clonereq {
44           int       ifcr_total;                   /* total cloners (out) */
45           int       ifcr_count;                   /* room for this many in user buffer */
46           char      *ifcr_buffer;                 /* buffer for cloner names */
47 };
48 #endif /* __BSD_VISIBLE */
49 
50 #ifdef _KERNEL
51 
52 #include <sys/eventhandler.h>
53 #include <sys/queue.h>
54 
55 /*
56  * Structure describing a `cloning' interface.
57  */
58 struct if_clone {
59           LIST_ENTRY(if_clone) ifc_list;          /* on list of cloners */
60           const char          *ifc_name;          /* name of device, e.g. `gif' */
61           int                 ifc_minifs;         /* minimum number of interfaces */
62           int                 ifc_maxunit;        /* maximum unit number */
63           unsigned char       *ifc_units;         /* bitmap to handle units */
64           int                 ifc_bmlen;          /* bitmap length */
65 
66           int                 (*ifc_create)(struct if_clone *, int,
67                                               caddr_t, caddr_t);
68           int                 (*ifc_destroy)(struct ifnet *);
69 };
70 
71 #define IF_CLONE_INITIALIZER(name, create, destroy, minifs, maxunit)  \
72           { { 0 }, name, minifs, maxunit, NULL, 0, create, destroy }
73 
74 /* interface clone event */
75 typedef void (*if_clone_event_handler_t)(void *, struct if_clone *);
76 EVENTHANDLER_DECLARE(if_clone_event, if_clone_event_handler_t);
77 
78 int       if_clone_attach(struct if_clone *ifc);
79 void      if_clone_detach(struct if_clone *ifc);
80 int       if_clone_create(char *name, int len, caddr_t params, caddr_t data);
81 int       if_clone_destroy(const char *name);
82 int       if_clone_list(struct if_clonereq *ifcr);
83 
84 #endif /* _KERNEL */
85 
86 #endif /* !_NET_IF_CLONE_H_ */
87