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