NetBSD/sbin/modstat/modstat.8

.\" $NetBSD: modstat.8,v 1.28 2020/02/23 00:14:31 wiz Exp $
.\"
.\" Copyright (c) 1993 Christopher G. Demetriou
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"          This product includes software developed for the
.\"          NetBSD Project.  See http://www.NetBSD.org/ for
.\"          information about NetBSD.
.\" 4. The name of the author may not be used to endorse or promote products
.\"    derived from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" <<Id: LICENSE,v 1.2 2000/06/14 15:57:33 cgd Exp>>
.\"
.Dd February 22, 2020
.Dt MODSTAT 8
.Os
.Sh NAME
.Nm modstat
.Nd display status of loaded kernel modules
.Sh SYNOPSIS
.Nm
.Op Fl Aaek
.Op Fl n Ar name | name
.Sh DESCRIPTION
The
.Nm
utility displays the status of any kernel modules present in the kernel.
.Pp
The options are as follows:
.Bl -tag -width indent
.It Fl A
Tells you whether or not modules can be autoloaded at the moment.
This option
.Em does
take into consideration the sysctl
.Li kern.module.autoload .
.It Fl a
Tells you whether or not modules can be autoloaded at the moment.
This option
.Em does not
take into consideration the sysctl
.Li kern.module.autoload .
.It Fl e
Tells you whether or not you may load a module at the moment.
.It Fl k
Display the kernel address of the module's text segment (disabled by default).
.It Fl n Ar name
Display the status of only the module with this name.
Please note that
.Fl n
is optional.
.El
.Pp
In addition to listing the currently loaded modules' name,
the information reported by
.Nm
includes:
.Bl -tag -width Loadaddr
.It Li CLASS
Module class, such as
"vfs", "driver", "exec", "misc" or "secmodel".
.It Li SOURCE
Where the module was loaded from.
.Qq Dv builtin
indicates that the module was built into the running kernel.
.Qq Dv boot
indicates that the module was loaded during system bootstrap.
.Qq Dv filesys
indicates that the module was loaded from the file system.
.It Li SIZE
Size of the module's text section, in bytes.
.It Li FLAG
The module flags:
.Bl -tag -width a -offset indent -compact
.It Dv a
Module is auto-loaded.
.It Dv f
Requires the
.Xr modload 8
flag
.Fl f
(force) to be loaded.
.El
.It Li REFS
Number of references held on the module.
Disabled builtin modules will show a count of \-1 here.
.It Li ADDRESS
The kernel address at which the module's text segment is loaded.
Builtin modules will show 0 here.
This field is only displayed if the
.Fl k
option is specified.
.It Li REQUIRES
Additional modules that must be present.
.El
.Sh EXIT STATUS
The
.Nm
utility exits with a status of 0 on success
and with a nonzero status if an error occurs.
.Sh SEE ALSO
.Xr module 7 ,
.Xr sysctl 7 ,
.Xr modload 8 ,
.Xr modunload 8
.Sh HISTORY
A
.Nm
utility appeared in
.Nx 0.9 .
The
.Nm
command was designed to be similar in functionality
to the corresponding command in
.Tn "SunOS 4.1.3" .
.Nm
was switched to the module framework for
.Nx 5.0 .
.Sh AUTHORS
.An -nosplit
The original
.Nx
implementation was written by
.An Terrence R. Lambert Aq Mt terry@cs.weber.edu .
The switch to the module framework was by
.An Andrew Doran Aq Mt ad@NetBSD.org .
Fix date. 2020-02-23 03:14:31 +03:00			`.\" $NetBSD: modstat.8,v 1.28 2020/02/23 00:14:31 wiz Exp $`
Pull in my modules code for review/test/hacking. 2008-01-16 15:34:50 +03:00			`.\"`
			`.\" Copyright (c) 1993 Christopher G. Demetriou`
			`.\" All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\" 3. All advertising materials mentioning features or use of this software`
			`.\" must display the following acknowledgement:`
			`.\" This product includes software developed for the`
			`.\" NetBSD Project. See http://www.NetBSD.org/ for`
			`.\" information about NetBSD.`
			`.\" 4. The name of the author may not be used to endorse or promote products`
			`.\" derived from this software without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
			`.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES`
			`.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.`
			`.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,`
			`.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT`
			`.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,`
			`.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY`
			`.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT`
			`.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF`
			`.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.`
			`.\"`
			`.\" <<Id: LICENSE,v 1.2 2000/06/14 15:57:33 cgd Exp>>`
			`.\"`
Fix date. 2020-02-23 03:14:31 +03:00			`.Dd February 22, 2020`
Pull in my modules code for review/test/hacking. 2008-01-16 15:34:50 +03:00			`.Dt MODSTAT 8`
			`.Os`
			`.Sh NAME`
			`.Nm modstat`
			`.Nd display status of loaded kernel modules`
			`.Sh SYNOPSIS`
			`.Nm`
Merge the [pgoyette-compat] branch 2019-01-27 05:08:33 +03:00			`.Op Fl Aaek`
			`.Op Fl n Ar name \| name`
Pull in my modules code for review/test/hacking. 2008-01-16 15:34:50 +03:00			`.Sh DESCRIPTION`
			`The`
			`.Nm`
Accept both 'modstat -n name' as well as 'modstat name' to display information about a single module. 2011-08-02 20:46:45 +04:00			`utility displays the status of any kernel modules present in the kernel.`
Pull in my modules code for review/test/hacking. 2008-01-16 15:34:50 +03:00			`.Pp`
			`The options are as follows:`
			`.Bl -tag -width indent`
Add -A, -a, and -e options to modstat(8) along with kernel changes required to support these options. The -e option was requested by martin@ in private chat in order to make writing tests easier (i.e. don't bother testing MODULAR functionaility if it doesn't exist). While there, I added -A and -a since those were quite similar. -A Tells you whether or not modules can be autoloaded at the moment. This option does take into consideration the sysctl kern.module.autoload. -a Tells you whether or not modules can be autoloaded at the moment. This option does not take into consideration the sysctl kern.module.autoload. -e Tells you whether or not you may load a module at the moment. 2012-08-07 05:19:05 +04:00			`.It Fl A`
			`Tells you whether or not modules can be autoloaded at the moment.`
Make the difference between -A and -a clearer by using more markup. 2012-08-12 21:20:19 +04:00			`This option`
			`.Em does`
			`take into consideration the sysctl`
Add -A, -a, and -e options to modstat(8) along with kernel changes required to support these options. The -e option was requested by martin@ in private chat in order to make writing tests easier (i.e. don't bother testing MODULAR functionaility if it doesn't exist). While there, I added -A and -a since those were quite similar. -A Tells you whether or not modules can be autoloaded at the moment. This option does take into consideration the sysctl kern.module.autoload. -a Tells you whether or not modules can be autoloaded at the moment. This option does not take into consideration the sysctl kern.module.autoload. -e Tells you whether or not you may load a module at the moment. 2012-08-07 05:19:05 +04:00			`.Li kern.module.autoload .`
			`.It Fl a`
			`Tells you whether or not modules can be autoloaded at the moment.`
Make the difference between -A and -a clearer by using more markup. 2012-08-12 21:20:19 +04:00			`This option`
			`.Em does not`
			`take into consideration the sysctl`
Add -A, -a, and -e options to modstat(8) along with kernel changes required to support these options. The -e option was requested by martin@ in private chat in order to make writing tests easier (i.e. don't bother testing MODULAR functionaility if it doesn't exist). While there, I added -A and -a since those were quite similar. -A Tells you whether or not modules can be autoloaded at the moment. This option does take into consideration the sysctl kern.module.autoload. -a Tells you whether or not modules can be autoloaded at the moment. This option does not take into consideration the sysctl kern.module.autoload. -e Tells you whether or not you may load a module at the moment. 2012-08-07 05:19:05 +04:00			`.Li kern.module.autoload .`
			`.It Fl e`
			`Tells you whether or not you may load a module at the moment.`
By default, don't display the module load address. Add a -k option to restore display of this field. 2015-12-02 03:56:09 +03:00			`.It Fl k`
Clarify that the -k option only provides the address of the module's text segment. The addresses of any other segments are not available. 2020-02-22 17:26:18 +03:00			`Display the kernel address of the module's text segment (disabled by default).`
Pull in my modules code for review/test/hacking. 2008-01-16 15:34:50 +03:00			`.It Fl n Ar name`
			`Display the status of only the module with this name.`
Accept both 'modstat -n name' as well as 'modstat name' to display information about a single module. 2011-08-02 20:46:45 +04:00			`Please note that`
			`.Fl n`
			`is optional.`
Pull in my modules code for review/test/hacking. 2008-01-16 15:34:50 +03:00			`.El`
			`.Pp`
			`In addition to listing the currently loaded modules' name,`
			`the information reported by`
			`.Nm`
			`includes:`
			`.Bl -tag -width Loadaddr`
			`.It Li CLASS`
			`Module class, such as`
remove lua class 2013-10-24 14:36:25 +04:00			`"vfs", "driver", "exec", "misc" or "secmodel".`
Pull in my modules code for review/test/hacking. 2008-01-16 15:34:50 +03:00			`.It Li SOURCE`
			`Where the module was loaded from.`
".Dv Qo foo Qc" should be ".Qq Dv foo" 2008-11-17 05:22:49 +03:00			`.Qq Dv builtin`
Pull in my modules code for review/test/hacking. 2008-01-16 15:34:50 +03:00			`indicates that the module was built into the running kernel.`
".Dv Qo foo Qc" should be ".Qq Dv foo" 2008-11-17 05:22:49 +03:00			`.Qq Dv boot`
Pull in my modules code for review/test/hacking. 2008-01-16 15:34:50 +03:00			`indicates that the module was loaded during system bootstrap.`
".Dv Qo foo Qc" should be ".Qq Dv foo" 2008-11-17 05:22:49 +03:00			`.Qq Dv filesys`
Pull in my modules code for review/test/hacking. 2008-01-16 15:34:50 +03:00			`indicates that the module was loaded from the file system.`
			`.It Li SIZE`
Note that the size returned by modctl(2) and displayed by modstat(8) is only for the module's text section, not for the entire size of the module. Addresses PR kern-54737 2019-12-05 02:35:36 +03:00			`Size of the module's text section, in bytes.`
print flags symbolically. 2015-11-04 19:04:55 +03:00			`.It Li FLAG`
			`The module flags:`
			`.Bl -tag -width a -offset indent -compact`
			`.It Dv a`
			`Module is auto-loaded.`
			`.It Dv f`
Merge the [pgoyette-compat] branch 2019-01-27 05:08:33 +03:00			`Requires the`
Fix xref. 2015-11-30 00:36:35 +03:00			`.Xr modload 8`
print flags symbolically. 2015-11-04 19:04:55 +03:00			`flag`
			`.Fl f`
			`(force) to be loaded.`
			`.El`
Pull in my modules code for review/test/hacking. 2008-01-16 15:34:50 +03:00			`.It Li REFS`
			`Number of references held on the module.`
note module changes 2010-03-05 21:51:22 +03:00			`Disabled builtin modules will show a count of \-1 here.`
Display the load address of modules. PR bin/47951. 2013-06-26 21:55:38 +04:00			`.It Li ADDRESS`
Note also that the load address (if provided) is also for the module's text segment. 2019-12-07 00:45:14 +03:00			`The kernel address at which the module's text segment is loaded.`
Display the load address of modules. PR bin/47951. 2013-06-26 21:55:38 +04:00			`Builtin modules will show 0 here.`
By default, don't display the module load address. Add a -k option to restore display of this field. 2015-12-02 03:56:09 +03:00			`This field is only displayed if the`
			`.Fl k`
			`option is specified.`
Pull in my modules code for review/test/hacking. 2008-01-16 15:34:50 +03:00			`.It Li REQUIRES`
			`Additional modules that must be present.`
			`.El`
			`.Sh EXIT STATUS`
			`The`
			`.Nm`
			`utility exits with a status of 0 on success`
			`and with a nonzero status if an error occurs.`
			`.Sh SEE ALSO`
Fix xref; module(4) -> module(7). 2010-12-14 19:23:59 +03:00			`.Xr module 7 ,`
Add -A, -a, and -e options to modstat(8) along with kernel changes required to support these options. The -e option was requested by martin@ in private chat in order to make writing tests easier (i.e. don't bother testing MODULAR functionaility if it doesn't exist). While there, I added -A and -a since those were quite similar. -A Tells you whether or not modules can be autoloaded at the moment. This option does take into consideration the sysctl kern.module.autoload. -a Tells you whether or not modules can be autoloaded at the moment. This option does not take into consideration the sysctl kern.module.autoload. -e Tells you whether or not you may load a module at the moment. 2012-08-07 05:19:05 +04:00			`.Xr sysctl 7 ,`
Pull in my modules code for review/test/hacking. 2008-01-16 15:34:50 +03:00			`.Xr modload 8 ,`
			`.Xr modunload 8`
			`.Sh HISTORY`
Document author and the version modstat appeared. Bump date. 2016-09-12 03:15:14 +03:00			`A`
			`.Nm`
			`utility appeared in`
modstat initially lived in src/usr.bin/modstat before being moved to src/modstat. Note the history of the initial implementation and amend AUTHORS section to credit Terrence R. Lambert. Heads up by Matthew Green. 2016-09-12 07:00:27 +03:00			`.Nx 0.9 .`
Pull in my modules code for review/test/hacking. 2008-01-16 15:34:50 +03:00			`The`
			`.Nm`
			`command was designed to be similar in functionality`
			`to the corresponding command in`
			`.Tn "SunOS 4.1.3" .`
modstat initially lived in src/usr.bin/modstat before being moved to src/modstat. Note the history of the initial implementation and amend AUTHORS section to credit Terrence R. Lambert. Heads up by Matthew Green. 2016-09-12 07:00:27 +03:00			`.Nm`
			`was switched to the module framework for`
			`.Nx 5.0 .`
			`.Sh AUTHORS`
Add .An -nosplit. 2016-09-12 09:52:59 +03:00			`.An -nosplit`
modstat initially lived in src/usr.bin/modstat before being moved to src/modstat. Note the history of the initial implementation and amend AUTHORS section to credit Terrence R. Lambert. Heads up by Matthew Green. 2016-09-12 07:00:27 +03:00			`The original`
			`.Nx`
			`implementation was written by`
			`.An Terrence R. Lambert Aq Mt terry@cs.weber.edu .`
			`The switch to the module framework was by`
Document author and the version modstat appeared. Bump date. 2016-09-12 03:15:14 +03:00			`.An Andrew Doran Aq Mt ad@NetBSD.org .`