Simplify FileChannelJournalSegmentWriter position tracking
[controller.git] / atomix-storage / src / main / java / io / atomix / storage / journal / FileChannelJournalSegmentWriter.java
1 /*
2  * Copyright 2017-present Open Networking Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package io.atomix.storage.journal;
17
18 import com.esotericsoftware.kryo.KryoException;
19 import io.atomix.storage.journal.index.JournalIndex;
20
21 import java.io.IOException;
22 import java.nio.BufferOverflowException;
23 import java.nio.BufferUnderflowException;
24 import java.nio.ByteBuffer;
25 import java.nio.channels.FileChannel;
26 import java.util.zip.CRC32;
27
28 /**
29  * Segment writer.
30  * <p>
31  * The format of an entry in the log is as follows:
32  * <ul>
33  * <li>64-bit index</li>
34  * <li>8-bit boolean indicating whether a term change is contained in the entry</li>
35  * <li>64-bit optional term</li>
36  * <li>32-bit signed entry length, including the entry type ID</li>
37  * <li>8-bit signed entry type ID</li>
38  * <li>n-bit entry bytes</li>
39  * </ul>
40  *
41  * @author <a href="http://github.com/kuujo">Jordan Halterman</a>
42  */
43 class FileChannelJournalSegmentWriter<E> implements JournalWriter<E> {
44   private static final ByteBuffer ZERO_ENTRY_HEADER = ByteBuffer.wrap(new byte[Integer.BYTES + Integer.BYTES]);
45
46   private final FileChannel channel;
47   private final JournalSegment<E> segment;
48   private final int maxEntrySize;
49   private final JournalIndex index;
50   private final JournalSerdes namespace;
51   private final ByteBuffer memory;
52   private final long firstIndex;
53   private Indexed<E> lastEntry;
54
55   FileChannelJournalSegmentWriter(
56       FileChannel channel,
57       JournalSegment<E> segment,
58       int maxEntrySize,
59       JournalIndex index,
60       JournalSerdes namespace) {
61     this.channel = channel;
62     this.segment = segment;
63     this.maxEntrySize = maxEntrySize;
64     this.index = index;
65     this.memory = ByteBuffer.allocate((maxEntrySize + Integer.BYTES + Integer.BYTES) * 2);
66     memory.limit(0);
67     this.namespace = namespace;
68     this.firstIndex = segment.index();
69     reset(0);
70   }
71
72   @Override
73   public void reset(long index) {
74     long nextIndex = firstIndex;
75
76     // Clear the buffer indexes.
77     try {
78       channel.position(JournalSegmentDescriptor.BYTES);
79
80       // Record the current buffer position.
81       long position = channel.position();
82
83       // Clear memory buffer and read fist chunk
84       memory.clear();
85       channel.read(memory, position);
86       memory.flip();
87
88       // Read the entry length.
89       int length = memory.getInt();
90
91       // If the length is non-zero, read the entry.
92       while (0 < length && length <= maxEntrySize && (index == 0 || nextIndex <= index)) {
93
94         // Read the checksum of the entry.
95         final long checksum = memory.getInt() & 0xFFFFFFFFL;
96
97         // Slice off the entry's bytes
98         final ByteBuffer entryBytes = memory.slice();
99         entryBytes.limit(length);
100
101         // Compute the checksum for the entry bytes.
102         final CRC32 crc32 = new CRC32();
103         crc32.update(entryBytes);
104
105         // If the stored checksum does not equal the computed checksum, do not proceed further
106         if (checksum != crc32.getValue()) {
107           break;
108         }
109
110         entryBytes.rewind();
111         final E entry = namespace.deserialize(entryBytes);
112         lastEntry = new Indexed<>(nextIndex, entry, length);
113         this.index.index(nextIndex, (int) position);
114         nextIndex++;
115
116         // Update the current position for indexing.
117         position = position + Integer.BYTES + Integer.BYTES + length;
118         channel.position(position);
119         memory.position(memory.position() + length);
120
121         // Read more bytes from the segment if necessary.
122         if (memory.remaining() < maxEntrySize) {
123           memory.clear();
124           channel.read(memory, position);
125           memory.flip();
126         }
127
128         length = memory.getInt();
129       }
130     } catch (BufferUnderflowException e) {
131       // No-op, position is only updated on success
132     } catch (IOException e) {
133       throw new StorageException(e);
134     }
135   }
136
137   @Override
138   public long getLastIndex() {
139     return lastEntry != null ? lastEntry.index() : segment.index() - 1;
140   }
141
142   @Override
143   public Indexed<E> getLastEntry() {
144     return lastEntry;
145   }
146
147   @Override
148   public long getNextIndex() {
149     if (lastEntry != null) {
150       return lastEntry.index() + 1;
151     } else {
152       return firstIndex;
153     }
154   }
155
156   @Override
157   public void append(Indexed<E> entry) {
158     final long nextIndex = getNextIndex();
159
160     // If the entry's index is greater than the next index in the segment, skip some entries.
161     if (entry.index() > nextIndex) {
162       throw new IndexOutOfBoundsException("Entry index is not sequential");
163     }
164
165     // If the entry's index is less than the next index, truncate the segment.
166     if (entry.index() < nextIndex) {
167       truncate(entry.index() - 1);
168     }
169     append(entry.entry());
170   }
171
172   @Override
173   @SuppressWarnings("unchecked")
174   public <T extends E> Indexed<T> append(T entry) {
175     // Store the entry index.
176     final long index = getNextIndex();
177
178     try {
179       // Serialize the entry.
180       memory.clear();
181       memory.position(Integer.BYTES + Integer.BYTES);
182       try {
183         namespace.serialize(entry, memory);
184       } catch (KryoException e) {
185         throw new StorageException.TooLarge("Entry size exceeds maximum allowed bytes (" + maxEntrySize + ")");
186       }
187       memory.flip();
188
189       final int length = memory.limit() - (Integer.BYTES + Integer.BYTES);
190
191       // Ensure there's enough space left in the buffer to store the entry.
192       long position = channel.position();
193       if (segment.descriptor().maxSegmentSize() - position < length + Integer.BYTES + Integer.BYTES) {
194         throw new BufferOverflowException();
195       }
196
197       // If the entry length exceeds the maximum entry size then throw an exception.
198       if (length > maxEntrySize) {
199         throw new StorageException.TooLarge("Entry size " + length + " exceeds maximum allowed bytes (" + maxEntrySize + ")");
200       }
201
202       // Compute the checksum for the entry.
203       final CRC32 crc32 = new CRC32();
204       crc32.update(memory.array(), Integer.BYTES + Integer.BYTES, memory.limit() - (Integer.BYTES + Integer.BYTES));
205       final long checksum = crc32.getValue();
206
207       // Create a single byte[] in memory for the entire entry and write it as a batch to the underlying buffer.
208       memory.putInt(0, length);
209       memory.putInt(Integer.BYTES, (int) checksum);
210       channel.write(memory);
211
212       // Update the last entry with the correct index/term/length.
213       Indexed<E> indexedEntry = new Indexed<>(index, entry, length);
214       this.lastEntry = indexedEntry;
215       this.index.index(index, (int) position);
216       return (Indexed<T>) indexedEntry;
217     } catch (IOException e) {
218       throw new StorageException(e);
219     }
220   }
221
222   @Override
223   public void commit(long index) {
224
225   }
226
227   @Override
228   public void truncate(long index) {
229     // If the index is greater than or equal to the last index, skip the truncate.
230     if (index >= getLastIndex()) {
231       return;
232     }
233
234     // Reset the last entry.
235     lastEntry = null;
236
237     // Truncate the index.
238     this.index.truncate(index);
239
240     try {
241       if (index < segment.index()) {
242         // Reset the writer to the first entry.
243         channel.position(JournalSegmentDescriptor.BYTES);
244       } else {
245         // Reset the writer to the given index.
246         reset(index);
247       }
248
249       // Zero the entry header at current channel position.
250       channel.write(ZERO_ENTRY_HEADER.asReadOnlyBuffer(), channel.position());
251     } catch (IOException e) {
252       throw new StorageException(e);
253     }
254   }
255
256   @Override
257   public void flush() {
258     try {
259       if (channel.isOpen()) {
260         channel.force(true);
261       }
262     } catch (IOException e) {
263       throw new StorageException(e);
264     }
265   }
266
267   @Override
268   public void close() {
269     flush();
270   }
271 }