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