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