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