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