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$
  27 .\"
  28 .Dd March 3, 1999
  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
  42 The
  43 .Fn kldstat
  44 system call writes the info for the file referred to by
  45 .Fa fileid
  46 into
  47 .Fa stat .
  48 .Bd -literal
  49 struct kld_file_stat {
  50         int         version;        /* set to sizeof(linker_file_stat) */
  51         char        name[MAXPATHLEN];
  52         int         refs;
  53         int         id;
  54         caddr_t     address;        /* load address */
  55         size_t      size;           /* size in bytes */
  56         char        pathname[MAXPATHLEN];
  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 .It pathname
  82 The full name of the file referred to by
  83 .Fa fileid ,
  84 including the path.
  85 .El
  86 .Sh RETURN VALUES
  87 .Rv -std kldstat
  88 .Sh ERRORS
  89 The information for the file referred to by
  90 .Fa fileid
  91 is filled into the structure pointed to by
  92 .Fa stat
  93 unless:
  94 .Bl -tag -width Er
  95 .It Bq Er ENOENT
  96 The file was not found (probably not loaded).
  97 .It Bq Er EINVAL
  98 The version specified in the
  99 .Fa version
 100 field of stat is not the proper version.
 101 You would need to rebuild world, the
 102 kernel, or your application, if this error occurs, given that you did properly
 103 fill in the
 104 .Fa version
 105 field.
 106 .It Bq Er EFAULT
 107 There was a problem copying one, some, or all of the fields into
 108 .Fa stat
 109 in the
 110 .Xr copyout 9
 111 function.
 112 .El
 113 .Sh SEE ALSO
 114 .Xr kldfind 2 ,
 115 .Xr kldfirstmod 2 ,
 116 .Xr kldload 2 ,
 117 .Xr kldnext 2 ,
 118 .Xr kldsym 2 ,
 119 .Xr kldunload 2 ,
 120 .Xr modfind 2 ,
 121 .Xr modfnext 2 ,
 122 .Xr modnext 2 ,
 123 .Xr modstat 2 ,
 124 .Xr kld 4 ,
 125 .Xr kldstat 8
 126 .Sh HISTORY
 127 The
 128 .Nm kld
 129 interface first appeared in
 130 .Fx 3.0 .
 131 .Sh BUGS
 132 The pathname many not be accurate if the file system mounts have
 133 changed since the module was loaded, or if this function is called
 134 within a chrooted environment.