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