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.\" $FreeBSD$ 27.\" 28.Dd March 3, 1999 29.Dt KLDSTAT 2 30.Os FreeBSD 31.Sh NAME 32.Nm kldstat 33.Nd get status of kld file 34.Sh SYNOPSIS 35.Fd #include <sys/param.h> 36.Fd #include <sys/linker.h> 37.Ft int 38.Fn kldstat "int fileid" "struct kld_file_stat *stat" 39.Sh DESCRIPTION 40The 41.Fn kldstat 42function writes the info for the file referred to by 43.Va fileid 44into 45.Va stat . 46.Bd -literal 47struct kld_file_stat { 48 int version; /* set to sizeof(linker_file_stat) */ 49 char name[MAXPATHLEN]; 50 int refs; 51 int id; 52 caddr_t address; /* load address */ 53 size_t size; /* size in bytes */ 54}; 55.Ed 56.Pp 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.Va fileid . 68.It refs 69The number of modules referenced by 70.Va fileid . 71.It id 72The id of the file specified in 73.Va fileid . 74.It address 75The load address of the kld file. 76.It size 77The size of the file. 78.Sh RETURN VALUES 79.Fn kldstat 80seems to always return 0. 81.Sh ERRORS 82The information for the file referred to by 83.Va fileid 84is filled into the structure pointed to by 85.Va stat 86unless: 87.Bl -tag -width Er 88.It Bq Er ENOENT 89The file was not found (probably not loaded). 90.It Bq Er EINVAL 91The version specified in the 92.Va version 93field of stat is not the proper version. You would need to rebuild world, the 94kernel, or your application, if this error occurs, given that you did properly 95fill in the 96.Va version 97field. 98.It Bq Er EFAULT 99There was a problem copying one, some, or all of the fields into 100.Va stat 101in the 102.Fn copyout 103function. 104.Sh SEE ALSO 105.Xr kldfind 2 , 106.Xr kldfirstmod 2 , 107.Xr kldload 2 , 108.Xr kldnext 2 , 109.Xr kldunload 2 , 110.Xr kld 4 , 111.Xr kldstat 8 112.Sh HISTORY 113The 114.Nm kld 115interface first appeared in 116.Fx 3.0 . 117