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