xref: /freebsd/lib/libsys/kldunload.2 (revision 47ef2a131091508e049ab10cad7f91a3c1342cd9)
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 December 25, 2008
27.Dt KLDUNLOAD 2
28.Os
29.Sh NAME
30.Nm kldunload , kldunloadf
31.Nd unload kld files
32.Sh LIBRARY
33.Lb libc
34.Sh SYNOPSIS
35.In sys/linker.h
36.Ft int
37.Fn kldunload "int fileid"
38.Ft int
39.Fn kldunloadf "int fileid" "int flags"
40.Sh DESCRIPTION
41The
42.Fn kldunload
43system call
44unloads a kld file from the kernel that was previously linked via
45.Xr kldload 2 .
46.Pp
47The
48.Fn kldunloadf
49system call accepts an additional flags argument, which may be one of
50.Dv LINKER_UNLOAD_NORMAL ,
51giving the same behavior as
52.Fn kldunload ,
53or
54.Dv LINKER_UNLOAD_FORCE ,
55which causes the unload to ignore a failure to quiesce the module.
56.Sh RETURN VALUES
57.Rv -std
58.Sh ERRORS
59The file referred to by
60.Fa fileid
61is unloaded unless:
62.Bl -tag -width Er
63.It Bq Er EPERM
64You do not have access to unlink the file from the kernel.
65.It Bq Er ENOENT
66The file was not found.
67.It Bq Er EBUSY
68You attempted to unload a file linked by the kernel.
69.It Bq Er EINVAL
70The
71.Fn kldunloadf
72system call was passed invalid flags.
73.El
74.Sh SEE ALSO
75.Xr kldfind 2 ,
76.Xr kldfirstmod 2 ,
77.Xr kldload 2 ,
78.Xr kldnext 2 ,
79.Xr kldstat 2 ,
80.Xr kldsym 2 ,
81.Xr modfind 2 ,
82.Xr modfnext 2 ,
83.Xr modnext 2 ,
84.Xr modstat 2 ,
85.Xr kld 4 ,
86.Xr kldunload 8
87.Sh HISTORY
88The
89.Nm kld
90interface first appeared in
91.Fx 3.0 .
92