lib/libc/sys/kldstat.2

   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 .\" $DragonFly: src/lib/libc/sys/kldstat.2,v 1.3 2008/05/02 02:05:04 swildner Exp $
  28 .\"
  29 .Dd March 3, 1999
  30 .Dt KLDSTAT 2
  31 .Os
  32 .Sh NAME
  33 .Nm kldstat
  34 .Nd get status of kld file
  35 .Sh LIBRARY
  36 .Lb libc
  37 .Sh SYNOPSIS
  38 .In sys/param.h
  39 .In sys/linker.h
  40 .Ft int
  41 .Fn kldstat "int fileid" "struct kld_file_stat *stat"
  42 .Sh DESCRIPTION
  43 The
  44 .Fn kldstat
  45 function writes the info for the file referred to by
  46 .Fa fileid
  47 into
  48 .Fa stat .
  49 .Bd -literal
  50 struct kld_file_stat {
  51         int         version;        /* set to sizeof(linker_file_stat) */
  52         char        name[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 XXXaddress
  60 .It version
  61 This field is set to the size of the structure mentioned above by the code
  62 calling
  63 .Fn kldstat ,
  64 and not
  65 .Fn kldstat
  66 itself.
  67 .It name
  68 The name of the file referred to by
  69 .Fa fileid .
  70 .It refs
  71 The number of modules referenced by
  72 .Fa fileid .
  73 .It id
  74 The id of the file specified in
  75 .Fa fileid .
  76 .It address
  77 The load address of the kld file.
  78 .It size
  79 The size of the file.
  80 .El
  81 .Sh RETURN VALUES
  82 .Rv -std kldstat
  83 .Sh ERRORS
  84 The information for the file referred to by
  85 .Fa fileid
  86 is filled into the structure pointed to by
  87 .Fa stat
  88 unless:
  89 .Bl -tag -width Er
  90 .It Bq Er ENOENT
  91 The file was not found (probably not loaded).
  92 .It Bq Er EINVAL
  93 The version specified in the
  94 .Fa version
  95 field of stat is not the proper version.  You would need to rebuild world, the
  96 kernel, or your application, if this error occurs, given that you did properly
  97 fill in the
  98 .Fa version
  99 field.
 100 .It Bq Er EFAULT
 101 There was a problem copying one, some, or all of the fields into
 102 .Fa stat
 103 in the
 104 .Fn copyout
 105 function.
 106 .El
 107 .Sh SEE ALSO
 108 .Xr kldfind 2 ,
 109 .Xr kldfirstmod 2 ,
 110 .Xr kldload 2 ,
 111 .Xr kldnext 2 ,
 112 .Xr kldsym 2 ,
 113 .Xr kldunload 2 ,
 114 .Xr modfind 2 ,
 115 .Xr modfnext 2 ,
 116 .Xr modnext 2 ,
 117 .Xr modstat 2 ,
 118 .Xr kld 4 ,
 119 .Xr kldstat 8
 120 .Sh HISTORY
 121 The
 122 .Nm kld
 123 interface first appeared in
 124 .Fx 3.0 .