xref: /freebsd/lib/libsys/modnext.2 (revision 8269e7673cf033aba67dab8264fe719920c70f87)
1*8269e767SBrooks Davis.\"
2*8269e767SBrooks Davis.\" Copyright (c) 1999 Chris Costello
3*8269e767SBrooks Davis.\" All rights reserved.
4*8269e767SBrooks Davis.\"
5*8269e767SBrooks Davis.\" Redistribution and use in source and binary forms, with or without
6*8269e767SBrooks Davis.\" modification, are permitted provided that the following conditions
7*8269e767SBrooks Davis.\" are met:
8*8269e767SBrooks Davis.\" 1. Redistributions of source code must retain the above copyright
9*8269e767SBrooks Davis.\"    notice, this list of conditions and the following disclaimer.
10*8269e767SBrooks Davis.\" 2. Redistributions in binary form must reproduce the above copyright
11*8269e767SBrooks Davis.\"    notice, this list of conditions and the following disclaimer in the
12*8269e767SBrooks Davis.\"    documentation and/or other materials provided with the distribution.
13*8269e767SBrooks Davis.\"
14*8269e767SBrooks Davis.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15*8269e767SBrooks Davis.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16*8269e767SBrooks Davis.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17*8269e767SBrooks Davis.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18*8269e767SBrooks Davis.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19*8269e767SBrooks Davis.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20*8269e767SBrooks Davis.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21*8269e767SBrooks Davis.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22*8269e767SBrooks Davis.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23*8269e767SBrooks Davis.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24*8269e767SBrooks Davis.\" SUCH DAMAGE.
25*8269e767SBrooks Davis.\"
26*8269e767SBrooks Davis.Dd September 28, 2000
27*8269e767SBrooks Davis.Dt MODNEXT 2
28*8269e767SBrooks Davis.Os
29*8269e767SBrooks Davis.Sh NAME
30*8269e767SBrooks Davis.Nm modnext
31*8269e767SBrooks Davis.Nd return the modid of the next kernel module
32*8269e767SBrooks Davis.Sh LIBRARY
33*8269e767SBrooks Davis.Lb libc
34*8269e767SBrooks Davis.Sh SYNOPSIS
35*8269e767SBrooks Davis.In sys/param.h
36*8269e767SBrooks Davis.In sys/module.h
37*8269e767SBrooks Davis.Ft int
38*8269e767SBrooks Davis.Fn modnext "int modid"
39*8269e767SBrooks Davis.Ft int
40*8269e767SBrooks Davis.Fn modfnext "int modid"
41*8269e767SBrooks Davis.Sh DESCRIPTION
42*8269e767SBrooks DavisThe
43*8269e767SBrooks Davis.Fn modnext
44*8269e767SBrooks Davissystem call
45*8269e767SBrooks Davisreturns the modid of the next kernel module (that is, the one after
46*8269e767SBrooks Davis.Va modid )
47*8269e767SBrooks Davisor 0 if
48*8269e767SBrooks Davis.Va modid
49*8269e767SBrooks Davisis the last module in the list.
50*8269e767SBrooks Davis.Pp
51*8269e767SBrooks DavisIf the
52*8269e767SBrooks Davis.Va modid
53*8269e767SBrooks Davisvalue is 0, then
54*8269e767SBrooks Davis.Fn modnext
55*8269e767SBrooks Daviswill return the modid of the first module.
56*8269e767SBrooks DavisThe
57*8269e767SBrooks Davis.Fn modfnext
58*8269e767SBrooks Davissystem call
59*8269e767SBrooks Davismust always be given a valid modid.
60*8269e767SBrooks Davis.Sh RETURN VALUES
61*8269e767SBrooks DavisThe
62*8269e767SBrooks Davis.Fn modnext
63*8269e767SBrooks Davissystem call
64*8269e767SBrooks Davisreturns the modid of the next module (see
65*8269e767SBrooks Davis.Sx DESCRIPTION )
66*8269e767SBrooks Davisor 0.
67*8269e767SBrooks DavisIf an error
68*8269e767SBrooks Davisoccurs,
69*8269e767SBrooks Davis.Va errno
70*8269e767SBrooks Davisis set to indicate the error.
71*8269e767SBrooks Davis.Sh ERRORS
72*8269e767SBrooks DavisThe only error set by
73*8269e767SBrooks Davis.Fn modnext
74*8269e767SBrooks Davisis
75*8269e767SBrooks Davis.Er ENOENT ,
76*8269e767SBrooks Daviswhich is set when
77*8269e767SBrooks Davis.Va modid
78*8269e767SBrooks Davisrefers to a kernel module that does not exist (is not loaded).
79*8269e767SBrooks Davis.Sh SEE ALSO
80*8269e767SBrooks Davis.Xr kldfind 2 ,
81*8269e767SBrooks Davis.Xr kldfirstmod 2 ,
82*8269e767SBrooks Davis.Xr kldload 2 ,
83*8269e767SBrooks Davis.Xr kldnext 2 ,
84*8269e767SBrooks Davis.Xr kldstat 2 ,
85*8269e767SBrooks Davis.Xr kldsym 2 ,
86*8269e767SBrooks Davis.Xr kldunload 2 ,
87*8269e767SBrooks Davis.Xr modfind 2 ,
88*8269e767SBrooks Davis.Xr modstat 2 ,
89*8269e767SBrooks Davis.Xr kld 4 ,
90*8269e767SBrooks Davis.Xr kldstat 8
91*8269e767SBrooks Davis.Sh HISTORY
92*8269e767SBrooks DavisThe
93*8269e767SBrooks Davis.Nm kld
94*8269e767SBrooks Davisinterface first appeared in
95*8269e767SBrooks Davis.Fx 3.0 .
96