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