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