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 July 15, 2008 27.Dt MODSTAT 2 28.Os 29.Sh NAME 30.Nm modstat 31.Nd get status of kernel module 32.Sh LIBRARY 33.Lb libc 34.Sh SYNOPSIS 35.In sys/param.h 36.In sys/module.h 37.Ft int 38.Fn modstat "int modid" "struct module_stat *stat" 39.Sh DESCRIPTION 40The 41.Fn modstat 42system call writes the info for the kernel module referred to by 43.Fa modid 44into 45.Fa stat . 46.Bd -literal 47struct module_stat { 48 int version; /* set to sizeof(module_stat) */ 49 char name[MAXMODNAME]; 50 int refs; 51 int id; 52 modspecific_t data; 53}; 54typedef union modspecific { 55 int intval; 56 u_int uintval; 57 long longval; 58 u_long ulongval; 59} modspecific_t; 60.Ed 61.Bl -tag -width XXXaddress 62.It version 63This field is set to the size of the structure mentioned above by the code 64calling 65.Fn modstat , 66and not 67.Fn modstat 68itself. 69.It name 70The name of the module referred to by 71.Fa modid . 72.It refs 73The number of modules referenced by 74.Fa modid . 75.It id 76The id of the module specified in 77.Fa modid . 78.It data 79Module specific data. 80.El 81.Sh RETURN VALUES 82.Rv -std modstat 83.Sh ERRORS 84The information for the module referred to by 85.Fa modid 86is filled into the structure pointed to by 87.Fa stat 88unless: 89.Bl -tag -width Er 90.It Bq Er ENOENT 91The module was not found (probably not loaded). 92.It Bq Er EINVAL 93The version specified in the 94.Fa version 95field of stat is not the proper version. 96You would need to rebuild world, the 97kernel, or your application, if this error occurs, given that you did properly 98fill in the 99.Fa version 100field. 101.It Bq Er EFAULT 102There was a problem copying one, some, or all of the fields into 103.Fa stat 104in the 105.Xr copyout 9 106function. 107.El 108.Sh SEE ALSO 109.Xr kldfind 2 , 110.Xr kldfirstmod 2 , 111.Xr kldload 2 , 112.Xr kldnext 2 , 113.Xr kldstat 2 , 114.Xr kldsym 2 , 115.Xr kldunload 2 , 116.Xr modfind 2 , 117.Xr modfnext 2 , 118.Xr modnext 2 , 119.Xr kld 4 , 120.Xr kldstat 8 121.Sh HISTORY 122The 123.Nm kld 124interface first appeared in 125.Fx 3.0 . 126