xref: /xnu-8796.141.3/libkern/kmod/c_stop.c (revision 1b191cb58250d0705d8a51287127505aa4bc0789)
1*1b191cb5SApple OSS Distributions /*
2*1b191cb5SApple OSS Distributions  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
3*1b191cb5SApple OSS Distributions  *
4*1b191cb5SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*1b191cb5SApple OSS Distributions  *
6*1b191cb5SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*1b191cb5SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*1b191cb5SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*1b191cb5SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*1b191cb5SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*1b191cb5SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*1b191cb5SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*1b191cb5SApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*1b191cb5SApple OSS Distributions  *
15*1b191cb5SApple OSS Distributions  * Please obtain a copy of the License at
16*1b191cb5SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*1b191cb5SApple OSS Distributions  *
18*1b191cb5SApple OSS Distributions  * The Original Code and all software distributed under the License are
19*1b191cb5SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*1b191cb5SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*1b191cb5SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*1b191cb5SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*1b191cb5SApple OSS Distributions  * Please see the License for the specific language governing rights and
24*1b191cb5SApple OSS Distributions  * limitations under the License.
25*1b191cb5SApple OSS Distributions  *
26*1b191cb5SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*1b191cb5SApple OSS Distributions  */
28*1b191cb5SApple OSS Distributions /*
29*1b191cb5SApple 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*1b191cb5SApple OSS Distributions  *
31*1b191cb5SApple 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*1b191cb5SApple OSS Distributions  *   KernelModule.bproj/kmod.make
33*1b191cb5SApple OSS Distributions  *   KernelModule.bproj/CreateKModInfo.perl
34*1b191cb5SApple OSS Distributions  *   KernelModule.bproj/kmodc++/pure.c
35*1b191cb5SApple OSS Distributions  *   KernelModule.bproj/kmodc++/cplus_start.c
36*1b191cb5SApple OSS Distributions  *   KernelModule.bproj/kmodc++/cplus_start.c
37*1b191cb5SApple OSS Distributions  *   KernelModule.bproj/kmodc/c_start.c
38*1b191cb5SApple OSS Distributions  *   KernelModule.bproj/kmodc/c_stop.c
39*1b191cb5SApple OSS Distributions  *
40*1b191cb5SApple 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*1b191cb5SApple OSS Distributions  *
42*1b191cb5SApple OSS Distributions  *   The linkline must look like this.
43*1b191cb5SApple OSS Distributions  *.o -lkmodc++ kmod_info.o -lkmod
44*1b191cb5SApple OSS Distributions  */
45*1b191cb5SApple OSS Distributions #include <mach/mach_types.h>
46*1b191cb5SApple OSS Distributions 
47*1b191cb5SApple OSS Distributions // These global symbols will be defined by CreateInfo script's info.c file.
48*1b191cb5SApple OSS Distributions extern kmod_stop_func_t *_antimain;
49*1b191cb5SApple OSS Distributions 
50*1b191cb5SApple OSS Distributions __private_extern__ kern_return_t
_stop(kmod_info_t * ki,void * data)51*1b191cb5SApple OSS Distributions _stop(kmod_info_t *ki, void *data)
52*1b191cb5SApple OSS Distributions {
53*1b191cb5SApple OSS Distributions 	if (_antimain) {
54*1b191cb5SApple OSS Distributions 		return (*_antimain)(ki, data);
55*1b191cb5SApple OSS Distributions 	} else {
56*1b191cb5SApple OSS Distributions 		return KERN_SUCCESS;
57*1b191cb5SApple OSS Distributions 	}
58*1b191cb5SApple OSS Distributions }
59