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