sys/net/if_clone.h

   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  * 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.
  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$
  31  */
  32
  33 #ifndef _NET_IF_CLONE_H_
  34 #define _NET_IF_CLONE_H_
  35
  36 #ifdef _KERNEL
  37
  38 struct if_clone;
  39
  40 /* Methods. */
  41 typedef int     ifc_match_t(struct if_clone *, const char *);
  42 typedef int     ifc_create_t(struct if_clone *, char *, size_t, caddr_t);
  43 typedef int     ifc_destroy_t(struct if_clone *, struct ifnet *);
  44
  45 typedef int     ifcs_create_t(struct if_clone *, int, caddr_t);
  46 typedef void    ifcs_destroy_t(struct ifnet *);
  47
  48 /* Interface cloner (de)allocating functions. */
  49 struct if_clone *
  50         if_clone_advanced(const char *, u_int, ifc_match_t, ifc_create_t,
  51                       ifc_destroy_t);
  52 struct if_clone *
  53         if_clone_simple(const char *, ifcs_create_t, ifcs_destroy_t, u_int);
  54 void    if_clone_detach(struct if_clone *);
  55
  56 /* Unit (de)allocating fucntions. */
  57 int     ifc_name2unit(const char *name, int *unit);
  58 int     ifc_alloc_unit(struct if_clone *, int *);
  59 void    ifc_free_unit(struct if_clone *, int);
  60
  61 #ifdef _SYS_EVENTHANDLER_H_
  62 /* Interface clone event. */
  63 typedef void (*if_clone_event_handler_t)(void *, struct if_clone *);
  64 EVENTHANDLER_DECLARE(if_clone_event, if_clone_event_handler_t);
  65 #endif
  66
  67 /* The below interfaces used only by net/if.c. */
  68 void    vnet_if_clone_init(void);
  69 int     if_clone_create(char *, size_t, caddr_t);
  70 int     if_clone_destroy(const char *);
  71 int     if_clone_list(struct if_clonereq *);
  72 struct if_clone *if_clone_findifc(struct ifnet *);
  73 void    if_clone_addgroup(struct ifnet *, struct if_clone *);
  74
  75 /* The below interface used only by epair(4). */
  76 int     if_clone_destroyif(struct if_clone *, struct ifnet *);
  77
  78 #endif /* _KERNEL */
  79 #endif /* !_NET_IF_CLONE_H_ */