lib/libutil/kld.3

   1 .\"-
   2 .\" Copyright (c) 2006 Dag-Erling Coïdan Smørgrav
   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 February 18, 2006
  29 .Os
  30 .Dt KLD 3
  31 .Sh NAME
  32 .Nm kld_isloaded ,
  33 .Nm kld_load
  34 .Nd kld utility functions
  35 .Sh LIBRARY
  36 .Lb libutil
  37 .Sh SYNOPSIS
  38 .In libutil.h
  39 .Ft int
  40 .Fn kld_isloaded "const char *name"
  41 .Ft int
  42 .Fn kld_load "const char *name"
  43 .Sh DESCRIPTION
  44 These functions facilitate loading kernel modules from userland
  45 applications.
  46 .Pp
  47 The
  48 .Fn kld_isloaded
  49 function takes a name and returns a non-zero value if a module of that
  50 name is currently loaded.
  51 The name can be either the name of a module file
  52 .Po
  53 .Va cpufreq.ko
  54 .Pc ,
  55 the same name without the
  56 .Pa .ko
  57 extension
  58 .Po
  59 .Va cpufreq
  60 .Pc ,
  61 or the name of a module contained within that file
  62 .Po
  63 .Va cpu/ichss
  64 .Pc .
  65 Only the latter will return correct results if the module is compiled
  66 into the kernel.
  67 .Pp
  68 The
  69 .Fn kld_load
  70 function is a simple wrapper around the
  71 .Fn kldload
  72 function.
  73 It returns zero if and only if the corresponding
  74 .Fn kldload
  75 call succeeded or returned
  76 .Er EEXIST
  77 (signifying that the requested module was already loaded).
  78 .Sh SEE ALSO
  79 .Xr kldfirstmod 2
  80 .Xr kldload 2 ,
  81 .Xr kldnext 2 ,
  82 .Xr kldstat 2 ,
  83 .Xr modfnext 2 ,
  84 .Xr modstat 2
  85 .Sh HISTORY
  86 The
  87 .Fn kld_isloaded
  88 and
  89 .Fn kld_load
  90 functions first appeared in
  91 .Fx 7.0 .
  92 .Sh AUTHORS
  93 The
  94 .Fn kld_isloaded
  95 and
  96 .Fn kld_load
  97 functions and this manual page were written by
  98 .An Dag-Erling Sm\(/orgrav Aq des@FreeBSD.org .