share/man/man9/at_exit.9

   1 .\"
   2 .\" Copyright (c) 1996 Julian Elischer
   3 .\"
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD: src/share/man/man9/at_exit.9,v 1.10.2.7 2001/12/17 11:30:18 ru Exp $
  27 .\" $DragonFly: src/share/man/man9/at_exit.9,v 1.2 2003/06/17 04:37:01 dillon Exp $
  28 .\" "
  29 .Dd August 15, 1996
  30 .Os
  31 .Dt AT_EXIT 9
  32 .Sh NAME
  33 .Nm at_exit ,
  34 .Nm rm_at_exit
  35 .Nd ask that a function be run at exit
  36 .Sh SYNOPSIS
  37 .In sys/types.h
  38 .In sys/systm.h
  39 .Ft typedef\ void ( exitlist_fn ) ( struct\ proc\ * ) ;
  40 .Pp
  41 .Ft int
  42 .Fn at_exit "exitlist_fn func"
  43 .Ft int
  44 .Fn rm_at_exit "exitlist_fn func"
  45 .Sh DESCRIPTION
  46 The
  47 .Nm
  48 facility allows a kernel module to ensure that it is notified
  49 at any process exit.
  50 The function
  51 .Fa func
  52 is called with the a pointer to the exiting process's proc structure.
  53 .Pp
  54 If the requirement for notification is removed, then the function
  55 .Fn rm_at_exit
  56 must be called with the exact
  57 .Fa func
  58 argument as the corresponding call to
  59 .Fn at_exit .
  60 .Sh RETURN VALUES
  61 The
  62 .Fa at_exit
  63 function returns an errno, 0 meaning success.  The
  64 .Fn rm_at_exit
  65 function returns the number of items removed (should be 0 or 1).
  66 .Sh SEE ALSO
  67 .Xr _exit 2
  68 .Sh HISTORY
  69 The
  70 .Fn at_exit
  71 function appeared in
  72 .Fx 2.2 .
  73 .Sh AUTHORS
  74 The function was written by
  75 .An Julian Elischer Aq julian@FreeBSD.org .