bsd/net/init.h

   1 /*
   2  * Copyright (c) 2006 Apple Computer, Inc. All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_OSREFERENCE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License.  The rights granted to you under the
  10  * License may not be used to create, or enable the creation or
  11  * redistribution of, unlawful or unlicensed copies of an Apple operating
  12  * system, or to circumvent, violate, or enable the circumvention or
  13  * violation of, any terms of an Apple operating system software license
  14  * agreement.
  15  *
  16  * Please obtain a copy of the License at
  17  * http://www.opensource.apple.com/apsl/ and read it before using this
  18  * file.
  19  *
  20  * The Original Code and all software distributed under the License are
  21  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  22  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  23  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  25  * Please see the License for the specific language governing rights and
  26  * limitations under the License.
  27  *
  28  * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
  29  */
  30 /*!
  31         @header init.h
  32         This header defines an API to register a function that will be called when
  33         the network stack is being initialized. This gives a kernel extensions an
  34         opportunity to install filters before sockets are created and network
  35         operations occur.
  36  */
  37 #ifndef _NET_INIT_H_
  38 #define _NET_INIT_H_
  39 #include <sys/kernel_types.h>
  40
  41 /*!
  42         @typedef net_init_func_ptr
  43         @discussion net_init_func_ptr will be called once the networking stack
  44                 initialized and before network operations occur.
  45  */
  46 typedef void    (*net_init_func_ptr)(void);
  47
  48 /*!
  49         @function net_init_add
  50         @discussion Add a function to be called during network initialization. Your
  51                 kext must not unload until the function you  register is called if
  52                 net_init_add returns success.
  53         @param init_func A pointer to a function to be called when the stack is
  54                 initialized.
  55         @result EINVAL - the init_func value was NULL.
  56                         EALREADY - the network has already been initialized
  57                         ENOMEM - there was not enough memory to perform this operation
  58                         0 - success
  59  */
  60 errno_t net_init_add(net_init_func_ptr  init_func);
  61
  62 #ifdef BSD_KERNEL_PRIVATE
  63 /* net_init_run is called from bsd_init */
  64 extern void net_init_run(void);
  65 #endif /* BSD_KERNEL_PRIVATE */
  66
  67 #endif /* _NET_INIT_H_ */