share/man/man4/kld.4

   1 .\" Copyright (c) 1993 Christopher G. Demetriou
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. The name of the author may not be used to endorse or promote products
  13 .\"    derived from this software without specific prior written permission
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd January 13, 2014
  29 .Dt KLD 4
  30 .Os
  31 .Sh NAME
  32 .Nm kld
  33 .Nd dynamic kernel linker facility
  34 .Sh DESCRIPTION
  35 The LKM (Loadable Kernel Modules) facility has been deprecated in
  36 .Fx 3.0
  37 and above in favor of the
  38 .Nm
  39 interface.
  40 This interface, like its
  41 predecessor, allows the system administrator to dynamically add and remove
  42 functionality from a running system.
  43 This ability also helps software
  44 developers to develop new parts of the kernel without constantly rebooting
  45 to test their changes.
  46 .Pp
  47 Various types of modules can be loaded into the system.
  48 There are several defined module types, listed below, which can
  49 be added to the system in a predefined way.
  50 In addition, there
  51 is a generic type, for which the module itself handles loading and
  52 unloading.
  53 .Pp
  54 The
  55 .Fx
  56 system makes extensive use of loadable kernel modules, and provides loadable
  57 versions of most file systems, the
  58 .Tn NFS
  59 client and server, all the screen-savers, and the
  60 .Tn Linux
  61 emulator.
  62 .Nm
  63 modules are placed by default in the
  64 .Pa /boot/kernel
  65 directory along with their matching kernel.
  66 .Pp
  67 The
  68 .Nm
  69 interface is used through the
  70 .Xr kldload 8 ,
  71 .Xr kldunload 8
  72 and
  73 .Xr kldstat 8
  74 programs.
  75 .Pp
  76 The
  77 .Xr kldload 8
  78 program can load either
  79 .Xr a.out 5
  80 or ELF formatted loadable modules.
  81 The
  82 .Xr kldunload 8
  83 program unloads any given loaded module, if no other module is dependent
  84 upon the given module.
  85 The
  86 .Xr kldstat 8
  87 program is used to check the status of the modules currently loaded into the
  88 system.
  89 .Pp
  90 Kernel modules may only be loaded or unloaded if the system security level
  91 .Va kern.securelevel
  92 is less than one.
  93 .Sh "MODULE TYPES"
  94 .Bl -ohang
  95 .It Em "Device Driver modules"
  96 New block and character device
  97 drivers may be loaded into the system with
  98 .Nm .
  99 Device nodes for the loaded drivers are automatically created when a
 100 module is loaded and destroyed when it is unloaded by
 101 .Xr devfs 5 .
 102 You can specify userland programs that will run when new devices
 103 become available as a result of loading modules, or existing devices
 104 go away when modules are unloaded, by configuring
 105 .Xr devd 8 .
 106 .El
 107 .Sh FILES
 108 .Bl -tag -width /usr/include/sys/module.h -compact
 109 .It Pa /boot/kernel
 110 directory containing module binaries built for the kernel also
 111 residing in the directory.
 112 .It Pa /usr/include/sys/module.h
 113 file containing definitions required to compile a
 114 .Nm
 115 module
 116 .It Pa /usr/share/examples/kld
 117 example source code implementing a sample kld module
 118 .El
 119 .Sh SEE ALSO
 120 .Xr kldfind 2 ,
 121 .Xr kldfirstmod 2 ,
 122 .Xr kldload 2 ,
 123 .Xr kldnext 2 ,
 124 .Xr kldstat 2 ,
 125 .Xr kldunload 2 ,
 126 .Xr devfs 5 ,
 127 .Xr devd 8 ,
 128 .Xr kldload 8 ,
 129 .Xr kldstat 8 ,
 130 .Xr kldunload 8 ,
 131 .Xr sysctl 8
 132 .Sh HISTORY
 133 The
 134 .Nm
 135 facility appeared in
 136 .Fx 3.0
 137 and was designed as a replacement for the
 138 .Nm lkm
 139 facility, which was similar in functionality to the loadable kernel modules
 140 facility provided by
 141 .Tn SunOS
 142 4.1.3.
 143 .Sh AUTHORS
 144 The
 145 .Nm
 146 facility was originally implemented by
 147 .An Doug Rabson Aq Mt dfr@FreeBSD.org .
 148 .Sh BUGS
 149 If a module B, is dependent on another module A, but is not compiled with
 150 module A as a dependency, then
 151 .Xr kldload 8
 152 fails to load module B, even if module A is already present in the system.
 153 .Pp
 154 If multiple modules are dependent on module A, and are compiled with module
 155 A as a dependency, then
 156 .Xr kldload 8
 157 loads an instance of module A when any of the modules are loaded.
 158 .Pp
 159 If a custom entry point is used for a module, and the module is compiled as
 160 an
 161 .Sq ELF
 162 binary, then
 163 .Xr kldload 8
 164 fails to execute the entry point.
 165 .Pp
 166 .Xr kldload 8
 167 points the user to read
 168 .Xr dmesg 8
 169 for any error encountered while loading a module.
 170 .Pp
 171 When system internal interfaces change, old modules often cannot
 172 detect this, and such modules when loaded will often cause crashes or
 173 mysterious failures.