xref: /freebsd/lib/libsys/kldload.2 (revision dabf006a638fdc44cdcf69731de8ac83959db731)
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/linker.h
36.Ft int
37.Fn kldload "const char *file"
38.Sh DESCRIPTION
39The
40.Fn kldload
41system call
42loads a kld file into the kernel using the kernel linker.
43.Sh RETURN VALUES
44The
45.Fn kldload
46system call
47returns the fileid of the kld file which was loaded into the kernel.
48If an error occurs,
49.Fn kldload
50will return -1 and set
51.Va errno
52to indicate the error.
53.Sh ERRORS
54The named file is loaded unless:
55.Bl -tag -width Er
56.It Bq Er EPERM
57You do not have access to read the file or link it with the kernel.
58You should be the root user to be able to use the
59.Nm kld
60system calls.
61.It Bq Er EFAULT
62Bad address encountered when adding kld info into the kernel space.
63.It Bq Er ENOMEM
64There is no memory to load the file into the kernel.
65.It Bq Er ENOENT
66The file was not found.
67.It Bq Er ENOEXEC
68The file format of
69.Fa file
70was unrecognized.
71.It Bq Er EEXIST
72The supplied
73.Fa file
74has already been loaded.
75.El
76.Sh SEE ALSO
77.Xr kldfind 2 ,
78.Xr kldfirstmod 2 ,
79.Xr kldnext 2 ,
80.Xr kldstat 2 ,
81.Xr kldsym 2 ,
82.Xr kldunload 2 ,
83.Xr modfind 2 ,
84.Xr modfnext 2 ,
85.Xr modnext 2 ,
86.Xr modstat 2 ,
87.Xr kld 4 ,
88.Xr kldload 8
89.Sh HISTORY
90The
91.Nm kld
92interface first appeared in
93.Fx 3.0 .
94