summaryrefslogtreecommitdiff
path: root/static/netbsd/man9/shutdownhook_establish.9
diff options
context:
space:
mode:
Diffstat (limited to 'static/netbsd/man9/shutdownhook_establish.9')
-rw-r--r--static/netbsd/man9/shutdownhook_establish.9100
1 files changed, 100 insertions, 0 deletions
diff --git a/static/netbsd/man9/shutdownhook_establish.9 b/static/netbsd/man9/shutdownhook_establish.9
new file mode 100644
index 00000000..6f0256f9
--- /dev/null
+++ b/static/netbsd/man9/shutdownhook_establish.9
@@ -0,0 +1,100 @@
+.\" $NetBSD: shutdownhook_establish.9,v 1.11 2024/09/07 19:13:29 rillig Exp $
+.\"
+.\" Copyright (c) 1994 Christopher G. Demetriou
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\" must display the following acknowledgement:
+.\" This product includes software developed for the
+.\" NetBSD Project. See https://www.NetBSD.org/ for
+.\" information about NetBSD.
+.\" 4. The name of the author may not be used to endorse or promote products
+.\" derived from this software without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+.\"
+.\" <<Id: LICENSE,v 1.2 2000/06/14 15:57:33 cgd Exp>>
+.\"
+.Dd May 14, 2009
+.Dt SHUTDOWNHOOK_ESTABLISH 9
+.Os
+.Sh NAME
+.Nm shutdownhook_establish ,
+.Nm shutdownhook_disestablish
+.Nd add or remove a shutdown hook
+.Sh SYNOPSIS
+.Ft void *
+.Fn shutdownhook_establish "void (*fn)(void *)" "void *arg"
+.Ft void
+.Fn shutdownhook_disestablish "void *cookie"
+.Sh DESCRIPTION
+.Em The
+.Nm
+.Em API is deprecated.
+.Pp
+The
+.Fn shutdownhook_establish
+function adds
+.Fa fn
+to the list of hooks invoked by
+.Xr doshutdownhooks 9
+at shutdown.
+When invoked, the hook function
+.Fa fn
+will be passed
+.Fa arg
+as its only argument.
+.Pp
+The
+.Fn shutdownhook_disestablish
+function removes the hook described by the opaque pointer
+.Fa cookie
+from the list of hooks to be invoked at shutdown.
+If
+.Fa cookie
+is invalid, the result of
+.Fn shutdownhook_disestablish
+is undefined.
+.Pp
+Shutdown hooks should be used to perform one-time activities
+that must happen immediately before the kernel exits.
+Because of the environment in which they are run, shutdown hooks cannot
+rely on many system services (including file systems, and timeouts
+and other interrupt-driven services), or even basic system
+integrity (because the system could be rebooting after a crash).
+.Sh RETURN VALUES
+If successful,
+.Fn shutdownhook_establish
+returns an opaque pointer describing the newly-established
+shutdown hook.
+Otherwise, it returns NULL.
+.Sh EXAMPLES
+It may be appropriate to use a shutdown hook to
+disable a device that does direct memory access, so that
+the device will not try to access memory while the system
+is rebooting.
+.Pp
+It may be appropriate to use a shutdown hook to
+inform watchdog timer hardware that the operating system
+is no longer running.
+.Sh SEE ALSO
+.Xr doshutdownhooks 9
+.Sh BUGS
+The names are clumsy, at best.