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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
|
%%
%% %CopyrightBegin%
%%
%% Copyright Ericsson AB 1998-2009. All Rights Reserved.
%%
%% The contents of this file are subject to the Erlang Public License,
%% Version 1.1, (the "License"); you may not use this file except in
%% compliance with the License. You should have received a copy of the
%% Erlang Public License along with this software. If not, it can be
%% retrieved online at http://www.erlang.org/.
%%
%% Software distributed under the License is distributed on an "AS IS"
%% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
%% the License for the specific language governing rights and limitations
%% under the License.
%%
%% %CopyrightEnd%
%%
%% Read wrap files with internal format
-module(wrap_log_reader).
%%-define(debug, true).
-ifdef(debug).
-define(FORMAT(P, A), io:format(P, A)).
-else.
-define(FORMAT(P, A), ok).
-endif.
-export([open/1, open/2, chunk/1, chunk/2, close/1]).
-include("disk_log.hrl").
-record(wrap_reader,
{fd :: file:fd(),
cont :: dlog_cont(), % disk_log's continuation record
file :: file:filename(), % file name without extension
file_no :: non_neg_integer(), % current file number
mod_time :: file:date_time(), % modification time of current file
first_no :: non_neg_integer() | 'one' % first read file number
}).
%%
%% Exported functions
%%
%% A special case to be handled when appropriate: if current file
%% number is one greater than number of files then the max file number
%% is not yet reached, we are on the first 'round' of filling the wrap
%% files.
-type open_ret() :: {'ok', #wrap_reader{}} | {'error', tuple()}.
-spec open(atom() | string()) -> open_ret().
open(File) when is_atom(File) ->
open(atom_to_list(File));
open(File) when is_list(File) ->
case read_index_file(File) of
%% The special case described above.
{ok, {CurFileNo, _CurFileSz, _TotSz, NoOfFiles}}
when CurFileNo =:= NoOfFiles + 1 ->
FileNo = 1,
?FORMAT("open from ~p Cur = ~p, Sz = ~p, Tot = ~p, NoFiles = ~p~n",
[FileNo, CurFileNo, _CurFileSz, _TotSz, NoOfFiles]),
open_int(File, FileNo, FileNo);
{ok, {CurFileNo, _CurFileSz, _TotSz, NoOfFiles}} ->
FileNo = case (CurFileNo + 1) rem NoOfFiles of
0 -> NoOfFiles;
No -> No
end,
?FORMAT("open from ~p Cur = ~p, Sz = ~p, Tot = ~p, NoFiles = ~p~n",
[FileNo, CurFileNo, _CurFileSz, _TotSz, NoOfFiles]),
open_int(File, FileNo, FileNo);
Error ->
Error
end.
-spec open(atom() | string(), integer()) -> open_ret().
open(File, FileNo) when is_atom(File), is_integer(FileNo) ->
open(atom_to_list(File), FileNo);
open(File, FileNo) when is_list(File), is_integer(FileNo) ->
case read_index_file(File) of
{ok, {_CurFileNo, _CurFileSz, _TotSz, NoOfFiles}}
when NoOfFiles >= FileNo ->
?FORMAT("open file ~p Cur = ~p, Sz = ~p, Tot = ~p, NoFiles = ~p~n",
[FileNo, _CurFileNo, _CurFileSz, _TotSz, NoOfFiles]),
open_int(File, FileNo, one);
%% The special case described above.
{ok, {CurFileNo, _CurFileSz, _TotSz, NoOfFiles}}
when CurFileNo =:= FileNo, CurFileNo =:= NoOfFiles +1 ->
?FORMAT("open file ~p Cur = ~p, Sz = ~p, Tot = ~p, NoFiles = ~p~n",
[FileNo, CurFileNo, _CurFileSz, _TotSz, NoOfFiles]),
open_int(File, FileNo, one);
{ok, {_CurFileNo, _CurFileSz, _TotSz, _NoOfFiles}} ->
{error, {file_not_found, add_ext(File, FileNo)}};
Error ->
Error
end.
-spec close(#wrap_reader{}) -> 'ok' | {'error', atom()}.
close(#wrap_reader{fd = FD}) ->
file:close(FD).
-type chunk_ret() :: {#wrap_reader{}, [term()]}
| {#wrap_reader{}, [term()], non_neg_integer()}
| {#wrap_reader{}, 'eof'}
| {'error', term()}.
-spec chunk(#wrap_reader{}) -> chunk_ret().
chunk(WR = #wrap_reader{}) ->
chunk(WR, ?MAX_CHUNK_SIZE, 0).
-spec chunk(#wrap_reader{}, 'infinity' | pos_integer()) -> chunk_ret().
chunk(WR = #wrap_reader{}, infinity) ->
chunk(WR, ?MAX_CHUNK_SIZE, 0);
chunk(WR = #wrap_reader{}, N) when is_integer(N), N > 0 ->
chunk(WR, N, 0).
%%
%% Local functions
%%
open_int(File, FileNo, FirstFileNo) ->
FName = add_ext(File, FileNo),
case file:open(FName, [raw, binary, read]) of
{ok, Fd} -> %% File exists
case file:read(Fd, ?HEADSZ) of
{ok, Head} ->
case disk_log_1:is_head(Head) of
no ->
file:close(Fd),
{error, {not_a_log_file, FName}};
_ -> % yes or yes_not_closed
case last_mod_time(FName) of
{ok, ModTime} ->
WR = #wrap_reader{fd = Fd, cont = start,
file = File,
file_no = FileNo,
mod_time = ModTime,
first_no = FirstFileNo},
{ok, WR};
{error, E} ->
file:close(Fd),
{error, {file_error, FName, E}}
end
end;
_Other ->
file:close(Fd),
{error, {not_a_log_file, FName}}
end;
_Other ->
{error, {not_a_log_file, FName}}
end.
chunk(WR, N, Bad) ->
#wrap_reader{fd = Fd, cont = Continue, file = File, file_no = CurFileNo,
first_no = FirstFileNo} = WR,
case read_a_chunk(Fd, N, Continue, add_ext(File, CurFileNo)) of
eof ->
case FirstFileNo of
one ->
{WR, eof};
_Else ->
chunk_at_eof(WR, N, Bad)
end;
{ContOut, [], BadBytes} ->
?FORMAT("chunk: empty chunk read, ~p bad bytes~n", [BadBytes]),
chunk(WR#wrap_reader{cont = ContOut}, N, Bad + BadBytes);
{ContOut, Chunk, BadBytes} when Bad + BadBytes =:= 0 ->
{WR#wrap_reader{cont = ContOut}, Chunk};
{ContOut, Chunk, BadBytes} ->
?FORMAT("chunk: total of ~p bad bytes~n", [BadBytes]),
{WR#wrap_reader{cont = ContOut}, Chunk, Bad + BadBytes};
Error ->
Error
end.
read_a_chunk(Fd, N, start, FileName) ->
read_a_chunk(Fd, FileName, 0, [], N);
read_a_chunk(Fd, N, More, FileName) ->
Pos = More#continuation.pos,
B = More#continuation.b,
read_a_chunk(Fd, FileName, Pos, B, N).
read_a_chunk(Fd, FileName, Pos, B, N) ->
R = disk_log_1:chunk_read_only(Fd, FileName, Pos, B, N),
%% Create terms from the binaries returned from chunk_read_only/5.
%% 'foo' will do here since Log is not used in read-only mode.
Log = foo,
case disk_log:ichunk_end(R, Log) of
{C = #continuation{}, S} ->
{C, S, 0};
Else ->
Else
end.
chunk_at_eof(WR, N, Bad) ->
#wrap_reader{file = File, file_no = CurFileNo,
first_no = FirstFileNo} = WR,
case read_index_file(File) of
{ok, IndexFile} ->
{_, _, _, NoOfFiles} = IndexFile,
NewFileNo = case (CurFileNo + 1) rem NoOfFiles of
%% The special case described above.
_ when CurFileNo > NoOfFiles -> 1;
0 when NoOfFiles > 1 -> NoOfFiles;
No when CurFileNo =:= NoOfFiles ->
FileName = add_ext(File, CurFileNo+1),
case file:read_file_info(FileName) of
{ok, _} -> CurFileNo + 1;
_ -> No
end;
No -> No
end,
?FORMAT("chunk: at eof, index file: ~p, FirstFileNo: ~p, "
"CurFileNo: ~p, NoOfFiles: ~p, NewFileNo: ~p~n",
[IndexFile, FirstFileNo, CurFileNo,
NoOfFiles, NewFileNo]),
case {FirstFileNo, NewFileNo} of
{_, 0} -> {WR, eof};
{_, FirstFileNo} -> {WR, eof};
_ -> read_next_file(WR, N, NewFileNo, Bad)
end;
Error ->
Error
end.
%% Read the index file for the File
%% -> {ok, {CurFileNo, CurFileSz, TotSz, NoOfFiles}} | {error, Reason}
read_index_file(File) ->
case catch disk_log_1:read_index_file(File) of
{1, 0, 0, 0} ->
{error, {index_file_not_found, File}};
{error, _Reason} ->
{error, {index_file_not_found, File}};
FileData ->
{ok, FileData}
end.
%% When reading all the index files, this function closes the previous
%% index file and opens the next one.
read_next_file(WR, N, NewFileNo, Bad) ->
#wrap_reader{file = File, file_no = CurFileNo,
mod_time = ModTime, first_no = FirstFileNo} = WR,
%% If current file were closed here, then WR would be in a strange
%% state should an error occur below.
case last_mod_time(add_ext(File, NewFileNo)) of
{ok, NewModTime} ->
OldMT = calendar:datetime_to_gregorian_seconds(ModTime),
NewMT = calendar:datetime_to_gregorian_seconds(NewModTime),
Diff = NewMT - OldMT,
?FORMAT("next: now = ~p~n last mtime = ~p~n"
" mtime = ~p~n diff = ~p~n",
[calendar:local_time(), ModTime, NewModTime, Diff]),
if
Diff < 0 ->
%% The file to be read is older than the one just finished.
{error, {is_wrapped, add_ext(File, CurFileNo)}};
true ->
case open_int(File, NewFileNo, FirstFileNo) of
{ok, NWR} ->
close(WR), %% Now we can safely close the old file.
chunk(NWR, N, Bad);
Error ->
Error
end
end;
{error, EN} ->
{error, {file_error, add_ext(File, NewFileNo), EN}}
end.
%% Get the last modification time of a file
last_mod_time(File) ->
case file:read_file_info(File) of
{ok, FileInfo} ->
{ok, FileInfo#file_info.mtime};
E ->
{error, E}
end.
add_ext(File, Ext) ->
lists:concat([File, ".", Ext]).
|
