diff options
Diffstat (limited to 'lpsm_shutdown.3.in')
| -rw-r--r-- | lpsm_shutdown.3.in | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/lpsm_shutdown.3.in b/lpsm_shutdown.3.in new file mode 100644 index 0000000..772e60d --- /dev/null +++ b/lpsm_shutdown.3.in @@ -0,0 +1,55 @@ +.\" -*- nroff -*- --------------------------------------------------------- +.\" +.\" Copyright 2001 H. Peter Anvin - All Rights Reserved +.\" +.\" This program is free software; you can redistribute it and/or modify +.\" it under the terms of the GNU Lesser General Public License as +.\" published by the Free Software Foundation, Inc., +.\" 59 Temple Place Ste 330, Bostom MA 02111-1307, USA; version 2.1, +.\" incorporated herein by reference. +.\" +.\" ----------------------------------------------------------------------- +.\" $Id$ +.TH LPSM_SHUTDOWN 3 "25 October 2001" "LPSM @@VERSION@@" "Linux Persistent Memory" +.SH NAME +lpsm_shutdown \- Terminate access to persistent memory +.SH SYNOPSIS +.nf +.B #include <lpsm.h> +.sp +.BI "void lpsm_shutdown(void);" +.fi +.SH DESCRIPTION +.B lpsm_shutdown() +shuts down the LPSM persistent memory system, frees all resources, and +restores the previous state of the +.B SIGSEGV +signal handler. +.IR "It does not perform a checkpoint before doing so" ; +normally a clean shutdown is performed as: +.nf +.RS +.sp +lpsm_checkpoint(0.0 , PSMSYNC_SYNC); +.nl +lpsm_shutdown(); +.nl +.RE +.fi +.PP +Calling +.B lpsm_shutdown() +followed by +.B lpsm_init() +or +.BR lpsm_arena_init() , +as appropriate, can be used in exceptional events to reinitialize the +arena to the last checkpointed state. This is a very slow operation. +.SH "RETURN VALUES" +.B lpsm_shutdown() +does not return a value. +.SH "SEE ALSO" +.BR lpsm_init (3), +.BR lpsm_arena_init (3). +.SH BUGS +The persistent memory system is not currently thread-safe. |