summaryrefslogtreecommitdiffstats
path: root/lpsm_shutdown.3.in
blob: ba0477218e0f8aa972e2bf1058b3a06b6c63c072 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
.\" -*- nroff -*- ---------------------------------------------------------
.\"   
.\"   Copyright 2001-2008 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.
.\"
.\" -----------------------------------------------------------------------
.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),
.BR lpsm_checkpoint (3),
.BR lpsm (7).
.SH BUGS
The persistent memory system is not currently thread-safe.