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