share/man/man9/module.9

   1 .\" -*- nroff -*-
   2 .\"
   3 .\" Copyright (c) 2000 Alexander Langer
   4 .\"
   5 .\" All rights reserved.
   6 .\"
   7 .\" This program is free software.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  19 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  20 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  21 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  22 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  23 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28 .\"
  29 .\" $FreeBSD: src/share/man/man9/module.9,v 1.5.2.2 2001/08/17 13:08:54 ru Exp $
  30 .\"
  31 .Dd March 1, 2001
  32 .Dt MODULE 9
  33 .Os
  34 .Sh NAME
  35 .Nm module
  36 .Nd structure describing a kernel module
  37 .Sh DESCRIPTION
  38 Each module in the kernel is described by a
  39 .Vt module_t
  40 structure.
  41 The structure contains the name of the device, a unique ID number,
  42 a pointer to an event handler function and to an argument,
  43 which is given to the event handler,
  44 as well as some kernel internal data.
  45 .Pp
  46 The
  47 .Xr DECLARE_MODULE 9
  48 macro
  49 registers the module with the system.
  50 When the module is loaded, the event handler function is called with
  51 the
  52 .Fa what
  53 argument set to
  54 .Dv MOD_LOAD .
  55 On unload,
  56 .Fa what
  57 is set to
  58 .Dv MOD_UNLOAD .
  59 When the system is shutting down,
  60 .Fa what
  61 contains the value of
  62 .Dv MOD_SHUTDOWN .
  63 .Sh EXAMPLES
  64 .Bd -literal
  65 #include <sys/param.h>
  66 #include <sys/kernel.h>
  67 #include <sys/module.h>
  68
  69 static int foo_handler(module_t mod, int /*modeventtype_t*/ what,
  70                        void *arg);
  71
  72 static moduledata_t mod_data= {
  73         "foo",
  74         foo_handler,
  75         0
  76 };
  77
  78 MODULE_VERSION(foo, 1);
  79 MODULE_DEPEND(foo, bar, 1, 3, 4);
  80
  81 DECLARE_MODULE(foo, mod_data, SI_SUB_EXEC, SI_ORDER_ANY);
  82 .Ed
  83 .Sh SEE ALSO
  84 .Xr DECLARE_MODULE 9 ,
  85 .Xr DEV_MODULE 9 ,
  86 .Xr DRIVER_MODULE 9 ,
  87 .Xr MODULE_DEPEND 9 ,
  88 .Xr MODULE_VERSION 9 ,
  89 .Xr SYSCALL_MODULE 9
  90 .Pp
  91 .Pa /usr/share/examples/kld
  92 .Sh AUTHORS
  93 This man page was written by
  94 .An Alexander Langer Aq alex@FreeBSD.org .