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 28, 2012 27.Dt KLDSTAT 2 28.Os 29.Sh NAME 30.Nm kldstat 31.Nd get status of 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 kldstat "int fileid" "struct kld_file_stat *stat" 39.Sh DESCRIPTION 40The 41.Fn kldstat 42system call writes the info for the file referred to by 43.Fa fileid 44into 45.Fa stat . 46.Bd -literal 47struct kld_file_stat { 48 int version; /* set to sizeof(struct kld_file_stat) */ 49 char name[MAXPATHLEN]; 50 int refs; 51 int id; 52 caddr_t address; 53 size_t size; 54 char pathname[MAXPATHLEN]; 55}; 56.Ed 57.Bl -tag -width XXXaddress 58.It version 59This field is set to the size of the structure mentioned above by the code 60calling 61.Fn kldstat , 62and not 63.Fn kldstat 64itself. 65.It name 66The name of the file referred to by 67.Fa fileid . 68.It refs 69The number of modules referenced by 70.Fa fileid . 71.It id 72The id of the file specified in 73.Fa fileid . 74.It address 75The load address of the kld file. 76.It size 77The amount of memory in bytes allocated by the file. 78.It pathname 79The full name of the file referred to by 80.Fa fileid , 81including the path. 82.El 83.Sh RETURN VALUES 84.Rv -std kldstat 85.Sh ERRORS 86The information for the file referred to by 87.Fa fileid 88is filled into the structure pointed to by 89.Fa stat 90unless: 91.Bl -tag -width Er 92.It Bq Er ENOENT 93The file was not found (probably not loaded). 94.It Bq Er EINVAL 95The version specified in the 96.Fa version 97field of stat is not the proper version. 98You would need to rebuild world, the 99kernel, or your application, if this error occurs, given that you did properly 100fill in the 101.Fa version 102field. 103.It Bq Er EFAULT 104There was a problem copying one, some, or all of the fields into 105.Fa stat 106in the 107.Xr copyout 9 108function. 109.El 110.Sh SEE ALSO 111.Xr kldfind 2 , 112.Xr kldfirstmod 2 , 113.Xr kldload 2 , 114.Xr kldnext 2 , 115.Xr kldsym 2 , 116.Xr kldunload 2 , 117.Xr modfind 2 , 118.Xr modfnext 2 , 119.Xr modnext 2 , 120.Xr modstat 2 , 121.Xr kld 4 , 122.Xr kldstat 8 123.Sh HISTORY 124The 125.Nm kld 126interface first appeared in 127.Fx 3.0 . 128.Sh BUGS 129The pathname may not be accurate if the file system mounts have 130changed since the module was loaded, or if this function is called 131within a chrooted environment. 132