diff options
author | dfr <dfr@FreeBSD.org> | 1999-04-04 12:29:31 +0000 |
---|---|---|
committer | dfr <dfr@FreeBSD.org> | 1999-04-04 12:29:31 +0000 |
commit | 40f56a703d888ddf4cea7407a46b86be23d9058c (patch) | |
tree | d2ae5fb17c4404a90848e325d42df45422fccb07 /lib/libc/sys/kldstat.2 | |
parent | ec237a86954e86068e0773decfcbd19e0f51165e (diff) | |
download | FreeBSD-src-40f56a703d888ddf4cea7407a46b86be23d9058c.zip FreeBSD-src-40f56a703d888ddf4cea7407a46b86be23d9058c.tar.gz |
Manpages for the KLD system calls.
PR: docs/10412
Submitted by: Chris Costello <chris@calldei.com>
Diffstat (limited to 'lib/libc/sys/kldstat.2')
-rw-r--r-- | lib/libc/sys/kldstat.2 | 110 |
1 files changed, 110 insertions, 0 deletions
diff --git a/lib/libc/sys/kldstat.2 b/lib/libc/sys/kldstat.2 new file mode 100644 index 0000000..4e46c29 --- /dev/null +++ b/lib/libc/sys/kldstat.2 @@ -0,0 +1,110 @@ +.\" +.\" Copyright (c) 1999 Chris Costello +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $Id$ +.\" +.Dd March 3, 1999 +.Dt KLDSTAT 2 +.Os FreeBSD +.Sh NAME +.Nm kldstat +.Nd get status of kld file +.Sh SYNOPSIS +.Fd #include <sys/linker.h> +.br +.Ft int +.Fn kldstat "int fileid" "struct kld_file_stat *stat" +.Sh DESCRIPTION +The +.Fn kldstat +function writes the info for the file referred to by +.Va fileid +into +.Va stat . +.br +.Bd -literal +struct kld_file_stat { + int version; /* set to sizeof(linker_file_stat) */ + char name[MAXPATHLEN]; + int refs; + int id; + caddr_t address; /* load address */ + size_t size; /* size in bytes */ +}; +.Ed +.Pp +.Bl -tag -width XXXaddress +.It version +This field is set to the size of the structure mentioned above by the code +calling +.Fn kldstat , +and not +.Fn kldstat +itself. +.It name +The name of the file referred to by +.Va fileid . +.It refs +The number of modules referenced by +.Va fileid . +.It id +The id of the file specified in +.Va fileid . +.It address +The load address of the kld file. +.It size +The size of the file. +.Ed +.Sh RETURN VALUES +.Fn kldstat +seems to always return 0. +.Sh ERRORS +The information for the file referred to by +.Va fileid +is filled into the structure pointed to by +.Va stat +unless: +.Bl -tag -width Er +.It Bq Er ENOENT +The file was not found (probably not loaded). +.It Bq Er EINVAL +The version specified in the +.Va version +field of stat is not the proper version. You would need to rebuild world, the +kernel, or your application, if this error occurs, given that you did properly +fill in the +.Va version +field. +.It Bq Er EFAULT +There was a problem copying one, some, or all of the fields into +.Va stat +in the +.Fn copyout +function. +.Ed +.Sh HISTORY +The +.Nm kld +interface first appeared in FreeBSD 3.0. |