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