xref: /xnu-10002.81.5/libkern/kmod/README (revision 5e3eaea39dcf651e66cb99ba7d70e32cc4a99587)
1*5e3eaea3SApple OSS Distributions#
2*5e3eaea3SApple OSS Distributions# Subtle combination of files and libraries make up the C++ runtime system for
3*5e3eaea3SApple OSS Distributions# kernel modules.  We are dependant on the KernelModule kmod.make and
4*5e3eaea3SApple OSS Distributions# CreateKModInfo.perl scripts to be exactly instep with both this library
5*5e3eaea3SApple OSS Distributions# module and the libkmod module as well.
6*5e3eaea3SApple OSS Distributions#
7*5e3eaea3SApple OSS Distributions# If you do any maintenance on any of the following files make sure great
8*5e3eaea3SApple OSS Distributions# care is taken to keep them in Sync.
9*5e3eaea3SApple OSS Distributions#    extenTools/KernelModule.bproj/kmod.make
10*5e3eaea3SApple OSS Distributions#    extenTools/KernelModule.bproj/CreateKModInfo.perl
11*5e3eaea3SApple OSS Distributions#    IOKitUser/kmodc++/pure.c
12*5e3eaea3SApple OSS Distributions#    IOKitUser/kmodc++/cplus_start.c
13*5e3eaea3SApple OSS Distributions#    IOKitUser/kmodc++/cplus_start.c
14*5e3eaea3SApple OSS Distributions#    IOKitUser/kmodc/c_start.c
15*5e3eaea3SApple OSS Distributions#    IOKitUser/kmodc/c_stop.c
16*5e3eaea3SApple OSS Distributions#
17*5e3eaea3SApple OSS Distributions# The trick is that the linkline links all of the developers modules.
18*5e3eaea3SApple OSS Distributions# If any static constructors are used .constructors_used will be left as
19*5e3eaea3SApple OSS Distributions# an undefined symbol.  This symbol is exported by the cplus_start.c routine
20*5e3eaea3SApple OSS Distributions# which automatically brings in the appropriate C++ _start routine.  However
21*5e3eaea3SApple OSS Distributions# the actual _start symbol is only required by the kmod_info structure that
22*5e3eaea3SApple OSS Distributions# is created and initialized by the CreateKModInfo.perl script.  If no C++
23*5e3eaea3SApple OSS Distributions# was used the _start will be an undefined symbol that is finally satisfied
24*5e3eaea3SApple OSS Distributions# by the c_start module in the kmod library.
25*5e3eaea3SApple OSS Distributions#
26*5e3eaea3SApple OSS Distributions# The linkline must look like this.
27*5e3eaea3SApple OSS Distributions#    *.o -lkmodc++ kmod_info.o -lkmod
28*5e3eaea3SApple OSS Distributions#
29