xref: /freebsd/lib/libsys/kldload.2 (revision f44029e322446469f116bbd26d51ba857083bacb)
1*8269e767SBrooks Davis.\"
2*8269e767SBrooks Davis.\" Copyright (c) 1999 Chris Costello
3*8269e767SBrooks Davis.\" All rights reserved.
4*8269e767SBrooks Davis.\"
5*8269e767SBrooks Davis.\" Redistribution and use in source and binary forms, with or without
6*8269e767SBrooks Davis.\" modification, are permitted provided that the following conditions
7*8269e767SBrooks Davis.\" are met:
8*8269e767SBrooks Davis.\" 1. Redistributions of source code must retain the above copyright
9*8269e767SBrooks Davis.\"    notice, this list of conditions and the following disclaimer.
10*8269e767SBrooks Davis.\" 2. Redistributions in binary form must reproduce the above copyright
11*8269e767SBrooks Davis.\"    notice, this list of conditions and the following disclaimer in the
12*8269e767SBrooks Davis.\"    documentation and/or other materials provided with the distribution.
13*8269e767SBrooks Davis.\"
14*8269e767SBrooks Davis.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15*8269e767SBrooks Davis.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16*8269e767SBrooks Davis.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17*8269e767SBrooks Davis.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18*8269e767SBrooks Davis.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19*8269e767SBrooks Davis.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20*8269e767SBrooks Davis.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21*8269e767SBrooks Davis.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22*8269e767SBrooks Davis.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23*8269e767SBrooks Davis.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24*8269e767SBrooks Davis.\" SUCH DAMAGE.
25*8269e767SBrooks Davis.\"
26*8269e767SBrooks Davis.Dd March 3, 1999
27*8269e767SBrooks Davis.Dt KLDLOAD 2
28*8269e767SBrooks Davis.Os
29*8269e767SBrooks Davis.Sh NAME
30*8269e767SBrooks Davis.Nm kldload
31*8269e767SBrooks Davis.Nd load KLD files into the kernel
32*8269e767SBrooks Davis.Sh LIBRARY
33*8269e767SBrooks Davis.Lb libc
34*8269e767SBrooks Davis.Sh SYNOPSIS
35*8269e767SBrooks Davis.In sys/linker.h
36*8269e767SBrooks Davis.Ft int
37*8269e767SBrooks Davis.Fn kldload "const char *file"
38*8269e767SBrooks Davis.Sh DESCRIPTION
39*8269e767SBrooks DavisThe
40*8269e767SBrooks Davis.Fn kldload
41*8269e767SBrooks Davissystem call
42*8269e767SBrooks Davisloads a kld file into the kernel using the kernel linker.
43*8269e767SBrooks Davis.Sh RETURN VALUES
44*8269e767SBrooks DavisThe
45*8269e767SBrooks Davis.Fn kldload
46*8269e767SBrooks Davissystem call
47*8269e767SBrooks Davisreturns the fileid of the kld file which was loaded into the kernel.
48*8269e767SBrooks DavisIf an error occurs,
49*8269e767SBrooks Davis.Fn kldload
50*8269e767SBrooks Daviswill return -1 and set
51*8269e767SBrooks Davis.Va errno
52*8269e767SBrooks Davisto indicate the error.
53*8269e767SBrooks Davis.Sh ERRORS
54*8269e767SBrooks DavisThe named file is loaded unless:
55*8269e767SBrooks Davis.Bl -tag -width Er
56*8269e767SBrooks Davis.It Bq Er EPERM
57*8269e767SBrooks DavisYou do not have access to read the file or link it with the kernel.
58*8269e767SBrooks DavisYou should be the root user to be able to use the
59*8269e767SBrooks Davis.Nm kld
60*8269e767SBrooks Davissystem calls.
61*8269e767SBrooks Davis.It Bq Er EFAULT
62*8269e767SBrooks DavisBad address encountered when adding kld info into the kernel space.
63*8269e767SBrooks Davis.It Bq Er ENOMEM
64*8269e767SBrooks DavisThere is no memory to load the file into the kernel.
65*8269e767SBrooks Davis.It Bq Er ENOENT
66*8269e767SBrooks DavisThe file was not found.
67*8269e767SBrooks Davis.It Bq Er ENOEXEC
68*8269e767SBrooks DavisThe file format of
69*8269e767SBrooks Davis.Fa file
70*8269e767SBrooks Daviswas unrecognized.
71*8269e767SBrooks Davis.It Bq Er EEXIST
72*8269e767SBrooks DavisThe supplied
73*8269e767SBrooks Davis.Fa file
74*8269e767SBrooks Davishas already been loaded.
75*8269e767SBrooks Davis.El
76*8269e767SBrooks Davis.Sh SEE ALSO
77*8269e767SBrooks Davis.Xr kldfind 2 ,
78*8269e767SBrooks Davis.Xr kldfirstmod 2 ,
79*8269e767SBrooks Davis.Xr kldnext 2 ,
80*8269e767SBrooks Davis.Xr kldstat 2 ,
81*8269e767SBrooks Davis.Xr kldsym 2 ,
82*8269e767SBrooks Davis.Xr kldunload 2 ,
83*8269e767SBrooks Davis.Xr modfind 2 ,
84*8269e767SBrooks Davis.Xr modfnext 2 ,
85*8269e767SBrooks Davis.Xr modnext 2 ,
86*8269e767SBrooks Davis.Xr modstat 2 ,
87*8269e767SBrooks Davis.Xr kld 4 ,
88*8269e767SBrooks Davis.Xr kldload 8
89*8269e767SBrooks Davis.Sh HISTORY
90*8269e767SBrooks DavisThe
91*8269e767SBrooks Davis.Nm kld
92*8269e767SBrooks Davisinterface first appeared in
93*8269e767SBrooks Davis.Fx 3.0 .
94