xref: /freebsd/lib/libsys/kldfind.2 (revision 7fdf597e96a02165cfe22ff357b857d5fa15ed8a)
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.Dd March 3, 1999
27.Dt KLDFIND 2
28.Os
29.Sh NAME
30.Nm kldfind
31.Nd returns the fileid of a kld file
32.Sh LIBRARY
33.Lb libc
34.Sh SYNOPSIS
35.In sys/linker.h
36.Ft int
37.Fn kldfind "const char *file"
38.Sh DESCRIPTION
39The
40.Fn kldfind
41system call
42returns the fileid of the kld file referenced by
43.Fa file .
44.Sh RETURN VALUES
45The
46.Fn kldfind
47system call
48returns the fileid of the kld file referenced by
49.Fa file .
50Upon error,
51.Fn kldfind
52returns -1 and sets
53.Va errno
54to indicate the error.
55.Sh ERRORS
56.Va errno
57is set to the following if
58.Fn kldfind
59fails:
60.Bl -tag -width Er
61.It Bq Er EFAULT
62The data required for this operation could not be read from the kernel space.
63.It Bq Er ENOENT
64The 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
80The
81.Nm kld
82interface first appeared in
83.Fx 3.0 .
84