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