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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
%%--------------------------------------------------------------------
%%
%% %CopyrightBegin%
%%
%% Copyright Ericsson AB 1999-2016. All Rights Reserved.
%%
%% Licensed under the Apache License, Version 2.0 (the "License");
%% you may not use this file except in compliance with the License.
%% You may obtain a copy of the License at
%%
%% http://www.apache.org/licenses/LICENSE-2.0
%%
%% Unless required by applicable law or agreed to in writing, software
%% distributed under the License is distributed on an "AS IS" BASIS,
%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
%% See the License for the specific language governing permissions and
%% limitations under the License.
%%
%% %CopyrightEnd%
%%
%%
%%----------------------------------------------------------------------
%% File : etrap_logmgr.erl
%% Purpose : Make it easier to use disk_log.
%%----------------------------------------------------------------------
-module(etrap_logmgr).
%%--------------- INCLUDES -----------------------------------
%% Local
-include_lib("ETraP_Common.hrl").
%%--------------- IMPORTS-------------------------------------
%%--------------- EXPORTS-------------------------------------
-export([start/1, stop/1, log_safe/2, log_lazy/2, get_next/2]).
%%------------------------------------------------------------
%% function : start
%% Arguments: LogName - name of the disk_log.
%% Returns :
%% Effect : creating linked log
%%------------------------------------------------------------
start(LogName) ->
case catch disk_log:open([{name, LogName},
{file, LogName},
{type, halt},
{size, infinity}]) of
{ok, LogName} ->
ok;
{error, Reason} ->
?tr_error_msg("Initiating internal log failed: ~p", [Reason]),
exit({error, Reason});
{repaired, LogName, {recovered, _Rec}, {badbytes, _Bad}} ->
ok;
Other ->
?tr_error_msg("Initiating internal log failed: ~p", [Other]),
exit({error, Other})
end.
%%------------------------------------------------------------
%% function : stop
%% Arguments: LogName - name of the disk_log.
%% Returns :
%% Effect :
%%------------------------------------------------------------
stop(LogName) ->
case catch disk_log:close(LogName) of
ok ->
ok;
{error, Reason} ->
?tr_error_msg("Stopping internal log failed: ~p", [Reason]),
{error, Reason};
Other ->
?tr_error_msg("Stopping internal log failed: ~p", [Other]),
{error, Other}
end.
%%------------------------------------------------------------
%% function : log_safe
%% Arguments: LogName - name of the disk_log. If 'dummy' is
%% used nothing should be logged. Reason, reuse code.
%% LogRecord - record to store in the log.
%% Returns :
%% Effect : Writes a logrecord and synchronizes to make sure
%% that the record is stored.
%%------------------------------------------------------------
log_safe(dummy, _) ->
ok;
log_safe(LogName, LogRecord) ->
case write_safe(LogName, LogRecord) of
ok ->
ok;
_ ->
%% We have to catch the exit because in some cases
%% it's not possible to abort action in the 2PC-protocol.
case catch start(LogName) of
ok ->
write_safe(LogName, LogRecord);
{'EXIT', Reason} ->
{error, Reason}
end
end.
write_safe(LogName, LogRecord) ->
case catch disk_log:log(LogName, LogRecord) of
ok -> % wrote to kernel successfully
case catch disk_log:sync(LogName) of
ok -> % Written to disk successfully
ok;
{error, Reason} ->
?tr_error_msg("Internal log write failed: ~p ~p",
[Reason, LogName]),
{error, Reason};
Other ->
?tr_error_msg("Internal log write failed: ~p ~p",
[Other, LogName]),
{error, Other}
end;
{error, Reason} ->
?tr_error_msg("Internal log write failed: ~p ~p", [Reason, LogName]),
{error, Reason};
Other ->
?tr_error_msg("Internal log write failed: ~p ~p", [Other, LogName]),
{error, Other}
end.
%%------------------------------------------------------------
%% function : log_lazy
%% Arguments: LogName - name of the disk_log. If 'dummy' is
%% used nothing should be logged. Reason, reuse code.
%% LogRecord - record to store in the log.
%% Returns :
%% Effect : Writes a logrecord. The record may be lost.
%%------------------------------------------------------------
log_lazy(dummy, _LogRecord) ->
ok;
log_lazy(LogName, LogRecord) ->
case write_lazy(LogName, LogRecord) of
ok ->
ok;
_ ->
%% We have to catch the exit because in some cases
%% it's not possible to abort action in the 2PC-protocol.
case catch start(LogName) of
ok ->
write_lazy(LogName, LogRecord);
{'EXIT', Reason} ->
{error, Reason}
end
end.
write_lazy(LogName, LogRecord) ->
case catch disk_log:log(LogName, LogRecord) of
ok ->
%% wrote to kernel successfully
ok;
{error, Reason} ->
%% Write to kernel failed with Reason
?tr_error_msg("Internal log write failed: ~p", [Reason]),
{error, Reason};
Other ->
%% unknown message received.
?tr_error_msg("Internal log write failed: ~p", [Other]),
{error, Other}
end.
%%------------------------------------------------------------
%% function : get_next
%% Arguments: LogName - name of the disk_log.
%% Cursor - place to read from.
%% Returns : {Cursor, LogRecs} - A cursor and up to N logrecords.
%% eof - the atom 'eof', indicating logfile empty.
%% {error, Reason} - error.
%% Effect :
%% Purpose : Used when performing a REDO scan
%%------------------------------------------------------------
get_next(LogName, Cursor) ->
case catch disk_log:chunk(LogName, Cursor, 1) of
{NewCursor, [Data]} ->
{Data, NewCursor};
eof ->
eof;
{error, Reason} ->
?tr_error_msg("Internal log '~p' read failed: ~p",
[LogName, Reason]),
exit({error, Reason});
_Other ->
?tr_error_msg("Internal log '~p' read failed: 'log_corrupt'", [LogName]),
exit({error, "log_corrupt"})
end.
%%--------------- END OF MODULE ------------------------------
|
