lib/libcr/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/libcr/sys/Attic/kldstat.2,v 1.2 2003/06/17 04:26:47 dillon 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 .Pp
  60 .Bl -tag -width XXXaddress
  61 .It version
  62 This field is set to the size of the structure mentioned above by the code
  63 calling
  64 .Fn kldstat ,
  65 and not
  66 .Fn kldstat
  67 itself.
  68 .It name
  69 The name of the file referred to by
  70 .Fa fileid .
  71 .It refs
  72 The number of modules referenced by
  73 .Fa fileid .
  74 .It id
  75 The id of the file specified in
  76 .Fa fileid .
  77 .It address
  78 The load address of the kld file.
  79 .It size
  80 The size of the file.
  81 .El
  82 .Sh RETURN VALUES
  83 .Rv -std kldstat
  84 .Sh ERRORS
  85 The information for the file referred to by
  86 .Fa fileid
  87 is filled into the structure pointed to by
  88 .Fa stat
  89 unless:
  90 .Bl -tag -width Er
  91 .It Bq Er ENOENT
  92 The file was not found (probably not loaded).
  93 .It Bq Er EINVAL
  94 The version specified in the
  95 .Fa version
  96 field of stat is not the proper version.  You would need to rebuild world, the
  97 kernel, or your application, if this error occurs, given that you did properly
  98 fill in the
  99 .Fa version
 100 field.
 101 .It Bq Er EFAULT
 102 There was a problem copying one, some, or all of the fields into
 103 .Fa stat
 104 in the
 105 .Fn copyout
 106 function.
 107 .El
 108 .Sh SEE ALSO
 109 .Xr kldfind 2 ,
 110 .Xr kldfirstmod 2 ,
 111 .Xr kldload 2 ,
 112 .Xr kldnext 2 ,
 113 .Xr kldsym 2 ,
 114 .Xr kldunload 2 ,
 115 .Xr modfind 2 ,
 116 .Xr modfnext 2 ,
 117 .Xr modnext 2 ,
 118 .Xr modstat 2 ,
 119 .Xr kld 4 ,
 120 .Xr kldstat 8
 121 .Sh HISTORY
 122 The
 123 .Nm kld
 124 interface first appeared in
 125 .Fx 3.0 .