lib/libc/sys/kldunload.2

   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 .\" $FreeBSD$
  27 .\"
  28 .Dd March 10, 2008
  29 .Dt KLDUNLOAD 2
  30 .Os
  31 .Sh NAME
  32 .Nm kldunload
  33 .Nm kldunloadf
  34 .Nd unload kld files
  35 .Sh LIBRARY
  36 .Lb libc
  37 .Sh SYNOPSIS
  38 .In sys/param.h
  39 .In sys/linker.h
  40 .Ft int
  41 .Fn kldunload "int fileid"
  42 .Ft int
  43 .Fn kldunload "int fileid" "int flags"
  44 .Sh DESCRIPTION
  45 The
  46 .Fn kldunload
  47 system call
  48 unloads a kld file from the kernel that was previously linked via
  49 .Xr kldload 2 .
  50 .Pp
  51 The
  52 .Fn kldunloadf
  53 system call accepts an additional flags argument, which may be one of
  54 .Dv LINKER_UNLOAD_NORMAL ,
  55 giving the same behavior as
  56 .Fn kldunload ,
  57 or
  58 .Dv LINKER_UNLOAD_FORCE ,
  59 which causes the unload to ignore a failure to quiesce the module.
  60 .Sh RETURN VALUES
  61 .Rv -std
  62 .Sh ERRORS
  63 The file referred to by
  64 .Fa fileid
  65 is unloaded unless:
  66 .Bl -tag -width Er
  67 .It Bq Er EPERM
  68 You do not have access to unlink the file from the kernel.
  69 .It Bq Er ENOENT
  70 The file was not found.
  71 .It Bq Er EBUSY
  72 You attempted to unload a file linked by the kernel.
  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
  88 The
  89 .Nm kld
  90 interface first appeared in
  91 .Fx 3.0 .