lib/libcr/sys/kldfind.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: src/lib/libc/sys/kldfind.2,v 1.6.2.7 2001/12/14 18:34:01 ru Exp $
  27 .\"
  28 .Dd March 3, 1999
  29 .Dt KLDFIND 2
  30 .Os
  31 .Sh NAME
  32 .Nm kldfind
  33 .Nd returns the fileid of a kld file
  34 .Sh LIBRARY
  35 .Lb libc
  36 .Sh SYNOPSIS
  37 .In sys/param.h
  38 .In sys/linker.h
  39 .Ft int
  40 .Fn kldfind "const char *file"
  41 .Sh DESCRIPTION
  42 The function
  43 .Fn kldfind
  44 returns the fileid of the kld file referenced by
  45 .Fa file .
  46 .Sh RETURN VALUES
  47 .Fn kldfind
  48 returns the fileid of the kld file referenced by
  49 .Fa file .
  50 Upon error,
  51 .Fn kldfind
  52 returns -1 and sets
  53 .Va errno
  54 to indicate the error.
  55 .Sh ERRORS
  56 .Va errno
  57 is set to the following if
  58 .Fn kldfind
  59 fails:
  60 .Bl -tag -width Er
  61 .It Bq Er EFAULT
  62 The data required for this operation could not be read from the kernel space.
  63 .It Bq Er ENOENT
  64 The file specified is not loaded in the kernel.
  65 .El
  66 .Sh SEE ALSO
  67 .Xr kldfirstmod 2 ,
  68 .Xr kldload 2 ,
  69 .Xr kldnext 2 ,
  70 .Xr kldstat 2 ,
  71 .Xr kldsym 2 ,
  72 .Xr kldunload 2 ,
  73 .Xr modfind 2 ,
  74 .Xr modfnext 2 ,
  75 .Xr modnext 2 ,
  76 .Xr modstat 2 ,
  77 .Xr kld 4 ,
  78 .Xr kldstat 8
  79 .Sh HISTORY
  80 The
  81 .Nm kld
  82 interface first appeared in
  83 .Fx 3.0 .