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: src/lib/libc/sys/kldstat.2,v 1.5.2.8 2001/12/14 18:34:01 ru Exp $ 27.\" 28.Dd February 10, 2023 29.Dt KLDSTAT 2 30.Os 31.Sh NAME 32.Nm kldstat 33.Nd get status of kld file 34.Sh LIBRARY 35.Lb libc 36.Sh SYNOPSIS 37.In sys/param.h 38.In sys/linker.h 39.Ft int 40.Fn kldstat "int fileid" "struct kld_file_stat *stat" 41.Sh DESCRIPTION 42The 43.Fn kldstat 44function writes the info for the file referred to by 45.Fa fileid 46into 47.Fa stat . 48.Bd -literal 49struct kld_file_stat { 50 int version; /* set to sizeof(linker_file_stat) */ 51 char name[MAXPATHLEN]; 52 char pathname[MAXPATHLEN]; 53 int refs; 54 int id; 55 caddr_t address; /* load address */ 56 size_t size; /* size in bytes */ 57}; 58.Ed 59.Bl -tag -width XXXpathname 60.It version 61This field is set to the size of the structure mentioned above by the code 62calling 63.Fn kldstat , 64and not 65.Fn kldstat 66itself. 67.It name 68The name of the file referred to by 69.Fa fileid . 70.It pathname 71The full path of the file referred to by 72.Fa fileid . 73.It refs 74The number of modules referenced by 75.Fa fileid . 76.It id 77The id of the file specified in 78.Fa fileid . 79.It address 80The load address of the kld file. 81.It size 82The size of the file. 83.El 84.Sh RETURN VALUES 85.Rv -std kldstat 86.Sh ERRORS 87The information for the file referred to by 88.Fa fileid 89is filled into the structure pointed to by 90.Fa stat 91unless: 92.Bl -tag -width Er 93.It Bq Er ENOENT 94The file was not found (probably not loaded). 95.It Bq Er EINVAL 96The version specified in the 97.Fa version 98field of stat is not the proper version. You 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.Fn copyout 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