Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit6557834

Browse files
committed
Add Generic WAL interface
This interface is designed to give an access to WAL for extensions whichcould implement new access method, for example. Previously it wasimpossible because restoring from custom WAL would need to access systemcatalog to find a redo custom function. This patch suggests generic wayto describe changes on page with standart layout.Bump XLOG_PAGE_MAGIC because of new record type.Author: Alexander Korotkov with a help of Petr Jelinek, Markus Nullmeier andminor editorization by myReviewers: Petr Jelinek, Alvaro Herrera, Teodor Sigaev, Jim Nasby,Michael Paquier
1 parentc202ecf commit6557834

File tree

14 files changed

+685
-6
lines changed

14 files changed

+685
-6
lines changed

‎doc/src/sgml/filelist.sgml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,7 @@
100100
<!ENTITY sources SYSTEM "sources.sgml">
101101
<!ENTITY storage SYSTEM "storage.sgml">
102102
<!ENTITY tablesample-method SYSTEM "tablesample-method.sgml">
103+
<!ENTITY generic-wal SYSTEM "generic-wal.sgml">
103104

104105
<!-- contrib information -->
105106
<!ENTITY contrib SYSTEM "contrib.sgml">

‎doc/src/sgml/generic-wal.sgml

Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
<!-- doc/src/sgml/generic-wal.sgml -->
2+
3+
<chapter id="generic-wal">
4+
<title>Generic WAL records</title>
5+
6+
<para>
7+
Despite all built-in access methods and WAL-logged modules having their own
8+
types of WAL records, there is also a generic WAL record type, which describes
9+
changes to pages in a generic way. This is useful for extensions that
10+
provide custom access methods, because they cannot register their own
11+
WAL redo routines.
12+
</para>
13+
14+
<para>
15+
The API for contructing generic WAL records is defined in
16+
<filename>generic_xlog.h</> and implemented in <filename>generic_xlog.c</>.
17+
Each generic WAL record must be constructed by following these steps:
18+
19+
<orderedlist>
20+
<listitem>
21+
<para>
22+
<function>state = GenericXLogStart(relation)</> &mdash; start
23+
construction of a generic xlog record for the given relation.
24+
</para>
25+
</listitem>
26+
27+
<listitem>
28+
<para>
29+
<function>page = GenericXLogRegister(state, buffer, isNew)</> &mdash;
30+
register one or more buffers (one at a time) for the current generic
31+
xlog record. This function returns a copy of the page image, where
32+
modifications can be made. The second argument indicates if the page
33+
is new (eventually, this will result in a full page image being put into
34+
the xlog record).
35+
</para>
36+
</listitem>
37+
38+
<listitem>
39+
<para>
40+
Apply modifications to page images obtained in the previous step.
41+
</para>
42+
</listitem>
43+
44+
<listitem>
45+
<para>
46+
<function>GenericXLogAbort(state)</> &mdash; finish construction of
47+
a generic xlog record.
48+
</para>
49+
</listitem>
50+
</orderedlist>
51+
</para>
52+
53+
<para>
54+
The xlog record construction can be canceled between any of the above
55+
steps by calling <function>GenericXLogAbort()</>. This will discard all
56+
changes to the page image copies.
57+
</para>
58+
59+
<para>
60+
Please note the following points when constructing generic xlog records:
61+
<itemizedlist>
62+
<listitem>
63+
<para>
64+
No direct modifications of page images are allowed! All modifications
65+
must be done in copies acquired from <function>GenericXLogRegister()</>.
66+
In other words, code which makes generic xlog records must never call
67+
<function>BufferGetPage()</>.
68+
</para>
69+
</listitem>
70+
71+
<listitem>
72+
<para>
73+
Registrations of buffers (step 2) and modifications of page images
74+
(step 3) can be mixed freely, i.e., both steps may be repeated in any
75+
sequence. The only restriction is that you can modify a page image
76+
only after the registration of the corresponding buffer.
77+
</para>
78+
</listitem>
79+
80+
<listitem>
81+
<para>
82+
After registration, the buffer can also be unregistered by calling
83+
<function>GenericXLogUnregister(buffer)</>. In this case, the changes
84+
made to that particular page image copy will be discarded.
85+
</para>
86+
</listitem>
87+
88+
<listitem>
89+
<para>
90+
Generic xlog assumes that pages are using standard layout. I.e., all
91+
information between pd_lower and pd_upper will be discarded.
92+
</para>
93+
</listitem>
94+
95+
<listitem>
96+
<para>
97+
The maximum number of buffers that can be simultaneously registered
98+
for a generic xlog is <literal>MAX_GENERIC_XLOG_PAGES</>. An error will
99+
be thrown if this limit is exceeded.
100+
</para>
101+
</listitem>
102+
<listitem>
103+
<para>
104+
Since you modify copies of page images, <function>GenericXLogStart()</>
105+
does not start a critical section. Thus, you can do memory allocation,
106+
error throwing, etc. between <function>GenericXLogStart()</> and
107+
<function>GenericXLogFinish()</>. The actual critical section is present
108+
inside <function>GenericXLogFinish()</>.
109+
</para>
110+
</listitem>
111+
<listitem>
112+
<para>
113+
<function>GenericXLogFinish()</> takes care of marking buffers as dirty
114+
and setting their LSNs. You do not need to do this explicitly.
115+
</para>
116+
</listitem>
117+
<listitem>
118+
<para>
119+
For unlogged relations, everything works the same except there is no
120+
WAL record produced. Thus, you typically do not need to do any explicit
121+
checks for unlogged relations.
122+
</para>
123+
</listitem>
124+
<listitem>
125+
<para>
126+
If a registered buffer is not new, the generic xlog record contains
127+
a delta between the old and the new page images. This delta is produced
128+
using per byte comparison. The current delta mechanism is not effective
129+
for moving data within a page and may be improved in the future.
130+
</para>
131+
</listitem>
132+
<listitem>
133+
<para>
134+
The generic xlog redo function will acquire exclusive locks to buffers
135+
in the same order as they were registered. After redoing all changes,
136+
the locks will be released in the same order.
137+
</para>
138+
</listitem>
139+
</itemizedlist>
140+
</para>
141+
</chapter>

‎doc/src/sgml/postgres.sgml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -247,6 +247,7 @@
247247
&custom-scan;
248248
&geqo;
249249
&indexam;
250+
&generic-wal;
250251
&gist;
251252
&spgist;
252253
&gin;

‎src/backend/access/rmgrdesc/Makefile

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ subdir = src/backend/access/rmgrdesc
88
top_builddir = ../../../..
99
include$(top_builddir)/src/Makefile.global
1010

11-
OBJS = brindesc.o clogdesc.o committsdesc.o dbasedesc.ogindesc.o gistdesc.o\
12-
hashdesc.o heapdesc.o mxactdesc.o nbtdesc.o relmapdesc.o\
13-
replorigindesc.o seqdesc.o smgrdesc.o spgdesc.o\
11+
OBJS = brindesc.o clogdesc.o committsdesc.o dbasedesc.ogenericdesc.o\
12+
gindesc.o gistdesc.ohashdesc.o heapdesc.o mxactdesc.o nbtdesc.o\
13+
relmapdesc.oreplorigindesc.o seqdesc.o smgrdesc.o spgdesc.o\
1414
standbydesc.o tblspcdesc.o xactdesc.o xlogdesc.o
1515

1616
include$(top_srcdir)/src/backend/common.mk
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
/*-------------------------------------------------------------------------
2+
*
3+
* genericdesc.c
4+
* rmgr descriptor routines for access/transam/generic_xlog.c
5+
*
6+
*
7+
* Portions Copyright (c) 1996-2014, PostgreSQL Global Development Group
8+
* Portions Copyright (c) 1994, Regents of the University of California
9+
*
10+
* src/backend/access/rmgrdesc/genericdesc.c
11+
*
12+
*-------------------------------------------------------------------------
13+
*/
14+
#include"postgres.h"
15+
16+
#include"access/generic_xlog.h"
17+
#include"lib/stringinfo.h"
18+
#include"storage/relfilenode.h"
19+
20+
/*
21+
* Description of generic xlog record: write page regions that this record
22+
* overrides.
23+
*/
24+
void
25+
generic_desc(StringInfobuf,XLogReaderState*record)
26+
{
27+
Pointerptr=XLogRecGetData(record),
28+
end=ptr+XLogRecGetDataLen(record);
29+
30+
while (ptr<end)
31+
{
32+
OffsetNumberoffset,
33+
length;
34+
35+
memcpy(&offset,ptr,sizeof(offset));
36+
ptr+=sizeof(offset);
37+
memcpy(&length,ptr,sizeof(length));
38+
ptr+=sizeof(length);
39+
ptr+=length;
40+
41+
if (ptr<end)
42+
appendStringInfo(buf,"offset %u, length %u; ",offset,length);
43+
else
44+
appendStringInfo(buf,"offset %u, length %u",offset,length);
45+
}
46+
47+
return;
48+
}
49+
50+
/*
51+
* Identification of generic xlog record: we don't distinguish any subtypes
52+
* inside generic xlog records.
53+
*/
54+
constchar*
55+
generic_identify(uint8info)
56+
{
57+
return"Generic";
58+
}

‎src/backend/access/transam/Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ subdir = src/backend/access/transam
1212
top_builddir = ../../../..
1313
include$(top_builddir)/src/Makefile.global
1414

15-
OBJS = clog.o commit_ts.o multixact.o parallel.o rmgr.o slru.o subtrans.o\
16-
timeline.o transam.o twophase.o twophase_rmgr.o varsup.o\
15+
OBJS = clog.o commit_ts.ogeneric_xlog.omultixact.o parallel.o rmgr.o slru.o\
16+
subtrans.otimeline.o transam.o twophase.o twophase_rmgr.o varsup.o\
1717
xact.o xlog.o xlogarchive.o xlogfuncs.o\
1818
xloginsert.o xlogreader.o xlogutils.o
1919

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp