xref: /xnu-12377.1.9/libkern/kmod/c_stop.c (revision f6217f891ac0bb64f3d375211650a4c1ff8ca1ea)
1*f6217f89SApple OSS Distributions /*
2*f6217f89SApple OSS Distributions  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
3*f6217f89SApple OSS Distributions  *
4*f6217f89SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*f6217f89SApple OSS Distributions  *
6*f6217f89SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*f6217f89SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*f6217f89SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*f6217f89SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*f6217f89SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*f6217f89SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*f6217f89SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*f6217f89SApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*f6217f89SApple OSS Distributions  *
15*f6217f89SApple OSS Distributions  * Please obtain a copy of the License at
16*f6217f89SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*f6217f89SApple OSS Distributions  *
18*f6217f89SApple OSS Distributions  * The Original Code and all software distributed under the License are
19*f6217f89SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*f6217f89SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*f6217f89SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*f6217f89SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*f6217f89SApple OSS Distributions  * Please see the License for the specific language governing rights and
24*f6217f89SApple OSS Distributions  * limitations under the License.
25*f6217f89SApple OSS Distributions  *
26*f6217f89SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*f6217f89SApple OSS Distributions  */
28*f6217f89SApple OSS Distributions /*
29*f6217f89SApple OSS Distributions  *   Subtle combination of files and libraries make up the C++ runtime system for kernel modules.  We are dependant on the KernelModule kmod.make and CreateKModInfo.perl scripts to be exactly instep with both this library module and the libkmod module as well.
30*f6217f89SApple OSS Distributions  *
31*f6217f89SApple OSS Distributions  *   If you do any maintenance on any of the following files make sure great care is taken to keep them in Sync.
32*f6217f89SApple OSS Distributions  *   KernelModule.bproj/kmod.make
33*f6217f89SApple OSS Distributions  *   KernelModule.bproj/CreateKModInfo.perl
34*f6217f89SApple OSS Distributions  *   KernelModule.bproj/kmodc++/pure.c
35*f6217f89SApple OSS Distributions  *   KernelModule.bproj/kmodc++/cplus_start.c
36*f6217f89SApple OSS Distributions  *   KernelModule.bproj/kmodc++/cplus_start.c
37*f6217f89SApple OSS Distributions  *   KernelModule.bproj/kmodc/c_start.c
38*f6217f89SApple OSS Distributions  *   KernelModule.bproj/kmodc/c_stop.c
39*f6217f89SApple OSS Distributions  *
40*f6217f89SApple OSS Distributions  *   The trick is that the linkline links all of the developers modules.  If any static constructors are used .constructors_used will be left as an undefined symbol.  This symbol is exported by the cplus_start.c routine which automatically brings in the appropriate C++ _start routine.  However the actual _start symbol is only required by the kmod_info structure that is created and initialized by the CreateKModInfo.perl script.  If no C++ was used the _start will be an undefined symbol that is finally satisfied by the c_start module in the kmod library.
41*f6217f89SApple OSS Distributions  *
42*f6217f89SApple OSS Distributions  *   The linkline must look like this.
43*f6217f89SApple OSS Distributions  *.o -lkmodc++ kmod_info.o -lkmod
44*f6217f89SApple OSS Distributions  */
45*f6217f89SApple OSS Distributions #include <mach/mach_types.h>
46*f6217f89SApple OSS Distributions 
47*f6217f89SApple OSS Distributions // These global symbols will be defined by CreateInfo script's info.c file.
48*f6217f89SApple OSS Distributions extern kmod_stop_func_t *_antimain;
49*f6217f89SApple OSS Distributions 
50*f6217f89SApple OSS Distributions __private_extern__ kern_return_t
_stop(kmod_info_t * ki,void * data)51*f6217f89SApple OSS Distributions _stop(kmod_info_t *ki, void *data)
52*f6217f89SApple OSS Distributions {
53*f6217f89SApple OSS Distributions 	if (_antimain) {
54*f6217f89SApple OSS Distributions 		return (*_antimain)(ki, data);
55*f6217f89SApple OSS Distributions 	} else {
56*f6217f89SApple OSS Distributions 		return KERN_SUCCESS;
57*f6217f89SApple OSS Distributions 	}
58*f6217f89SApple OSS Distributions }
59