-
Notifications
You must be signed in to change notification settings - Fork 45
/
appender.go
352 lines (285 loc) · 13.1 KB
/
appender.go
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
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
/*
Copyright 2016 Stanislav Liberman
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.
*/
package term
import (
"github.com/lirm/aeron-go/aeron/atomic"
"github.com/lirm/aeron-go/aeron/flyweight"
"github.com/lirm/aeron-go/aeron/logbuffer"
"github.com/lirm/aeron-go/aeron/util"
)
const (
// AppenderTripped is returned when the end of the term has been reached and buffer roll was done
AppenderTripped int64 = -1
// AppenderFailed is returned when appending is not possible due to position being outside of the term. ??
AppenderFailed int64 = -2
beginFrag uint8 = 0x80
endFrag uint8 = 0x40
unfragmented uint8 = 0x80 | 0x40
)
// DefaultReservedValueSupplier is the default reserved value provider
var DefaultReservedValueSupplier ReservedValueSupplier = func(termBuffer *atomic.Buffer, termOffset int32, length int32) int64 {
return 0
}
// ReservedValueSupplier is the type definition for a provider of user supplied header data
type ReservedValueSupplier func(termBuffer *atomic.Buffer, termOffset int32, length int32) int64
// HeaderWriter is a helper class for writing frame header to the term
type headerWriter struct {
sessionID int32
streamID int32
}
func (header *headerWriter) fill(defaultHdr *atomic.Buffer) {
header.sessionID = defaultHdr.GetInt32(logbuffer.DataFrameHeader.SessionIDFieldOffset)
header.streamID = defaultHdr.GetInt32(logbuffer.DataFrameHeader.StreamIDFieldOffset)
}
func (header *headerWriter) write(termBuffer *atomic.Buffer, offset, length, termID int32) {
termBuffer.PutInt32Ordered(offset, -length)
termBuffer.PutInt8(offset+logbuffer.DataFrameHeader.VersionFieldOffset, logbuffer.DataFrameHeader.CurrentVersion)
termBuffer.PutUInt8(offset+logbuffer.DataFrameHeader.FlagsFieldOffset, unfragmented)
termBuffer.PutUInt16(offset+logbuffer.DataFrameHeader.TypeFieldOffset, logbuffer.DataFrameHeader.TypeData)
termBuffer.PutInt32(offset+logbuffer.DataFrameHeader.TermOffsetFieldOffset, offset)
termBuffer.PutInt32(offset+logbuffer.DataFrameHeader.SessionIDFieldOffset, header.sessionID)
termBuffer.PutInt32(offset+logbuffer.DataFrameHeader.StreamIDFieldOffset, header.streamID)
termBuffer.PutInt32(offset+logbuffer.DataFrameHeader.TermIDFieldOffset, termID)
}
// Appender type is the term writer
type Appender struct {
termBuffer *atomic.Buffer
tailCounter flyweight.Int64Field
headerWriter headerWriter
}
// MakeAppender is the factory function for term Appenders
func MakeAppender(logBuffers *logbuffer.LogBuffers, partitionIndex int) *Appender {
appender := new(Appender)
appender.termBuffer = logBuffers.Buffer(partitionIndex)
appender.tailCounter = logBuffers.Meta().TailCounter[partitionIndex]
header := logBuffers.Meta().DefaultFrameHeader.Get()
appender.headerWriter.fill(header)
return appender
}
// RawTail is the accessor to the raw value of the tail offset used by Publication
func (appender *Appender) RawTail() int64 {
return appender.tailCounter.Get()
}
// SetRawTail sets the raw value of the tail. It should not be used outside of testing
func (appender *Appender) SetRawTail(v int64) {
appender.tailCounter.Set(v)
}
func (appender *Appender) getAndAddRawTail(alignedLength int32) int64 {
return appender.tailCounter.GetAndAddInt64(int64(alignedLength))
}
// Claim is the interface for using Buffer Claims for zero copy sends
func (appender *Appender) Claim(length int32, claim *logbuffer.Claim) (resultingOffset int64, termID int32) {
frameLength := length + logbuffer.DataFrameHeader.Length
alignedLength := util.AlignInt32(frameLength, logbuffer.FrameAlignment)
rawTail := appender.getAndAddRawTail(alignedLength)
termLength := appender.termBuffer.Capacity()
termID = logbuffer.TermID(rawTail)
termOffset := rawTail & 0xFFFFFFFF
resultingOffset = termOffset + int64(alignedLength)
if resultingOffset > int64(termLength) {
resultingOffset = handleEndOfLogCondition(termID, appender.termBuffer, int32(termOffset),
&appender.headerWriter, termLength)
} else {
offset := int32(termOffset)
appender.headerWriter.write(appender.termBuffer, offset, frameLength, termID)
claim.Wrap(appender.termBuffer, offset, frameLength)
}
return resultingOffset, termID
}
// AppendUnfragmentedMessage appends an unfragmented message in a single frame to the term
func (appender *Appender) AppendUnfragmentedMessage(srcBuffer *atomic.Buffer, srcOffset int32, length int32,
reservedValueSupplier ReservedValueSupplier) (resultingOffset int64, termID int32) {
frameLength := length + logbuffer.DataFrameHeader.Length
alignedLength := util.AlignInt32(frameLength, logbuffer.FrameAlignment)
rawTail := appender.getAndAddRawTail(alignedLength)
termLength := appender.termBuffer.Capacity()
termID = logbuffer.TermID(rawTail)
termOffset := rawTail & 0xFFFFFFFF
resultingOffset = termOffset + int64(alignedLength)
if resultingOffset > int64(termLength) {
resultingOffset = handleEndOfLogCondition(termID, appender.termBuffer, int32(termOffset),
&appender.headerWriter, termLength)
} else {
offset := int32(termOffset)
appender.headerWriter.write(appender.termBuffer, offset, frameLength, termID)
appender.termBuffer.PutBytes(offset+logbuffer.DataFrameHeader.Length, srcBuffer, srcOffset, length)
if nil != reservedValueSupplier {
reservedValue := reservedValueSupplier(appender.termBuffer, offset, frameLength)
appender.termBuffer.PutInt64(offset+logbuffer.DataFrameHeader.ReservedValueFieldOffset, reservedValue)
}
logbuffer.SetFrameLength(appender.termBuffer, offset, frameLength)
}
return resultingOffset, termID
}
// AppendUnfragmentedMessage2 appends the given pair of buffers as an unfragmented message in a single frame to the term
func (appender *Appender) AppendUnfragmentedMessage2(
srcBufferOne *atomic.Buffer, srcOffsetOne int32, lengthOne int32,
srcBufferTwo *atomic.Buffer, srcOffsetTwo int32, lengthTwo int32,
reservedValueSupplier ReservedValueSupplier,
) (resultingOffset int64, termID int32) {
frameLength := lengthOne + lengthTwo + logbuffer.DataFrameHeader.Length
alignedLength := util.AlignInt32(frameLength, logbuffer.FrameAlignment)
rawTail := appender.getAndAddRawTail(alignedLength)
termLength := appender.termBuffer.Capacity()
termID = logbuffer.TermID(rawTail)
termOffset := rawTail & 0xFFFFFFFF
resultingOffset = termOffset + int64(alignedLength)
if resultingOffset > int64(termLength) {
resultingOffset = handleEndOfLogCondition(termID, appender.termBuffer, int32(termOffset),
&appender.headerWriter, termLength)
} else {
offset := int32(termOffset)
dataOffset := offset + logbuffer.DataFrameHeader.Length
appender.headerWriter.write(appender.termBuffer, offset, frameLength, logbuffer.TermID(rawTail))
appender.termBuffer.PutBytes(dataOffset, srcBufferOne, srcOffsetOne, lengthOne)
appender.termBuffer.PutBytes(dataOffset+lengthOne, srcBufferTwo, srcOffsetTwo, lengthTwo)
if nil != reservedValueSupplier {
reservedValue := reservedValueSupplier(appender.termBuffer, offset, frameLength)
appender.termBuffer.PutInt64(offset+logbuffer.DataFrameHeader.ReservedValueFieldOffset, reservedValue)
}
logbuffer.SetFrameLength(appender.termBuffer, offset, frameLength)
}
return resultingOffset, termID
}
// AppendFragmentedMessage appends a message greater than frame length as a batch of fragments
func (appender *Appender) AppendFragmentedMessage(srcBuffer *atomic.Buffer, srcOffset int32, length int32,
maxPayloadLength int32, reservedValueSupplier ReservedValueSupplier) (resultingOffset int64, termID int32) {
numMaxPayloads := length / maxPayloadLength
remainingPayload := length % maxPayloadLength
var lastFrameLength int32
if remainingPayload > 0 {
lastFrameLength = util.AlignInt32(remainingPayload+logbuffer.DataFrameHeader.Length, logbuffer.FrameAlignment)
}
requiredLength := (numMaxPayloads * (maxPayloadLength + logbuffer.DataFrameHeader.Length)) + lastFrameLength
rawTail := appender.getAndAddRawTail(requiredLength)
termLength := appender.termBuffer.Capacity()
termID = logbuffer.TermID(rawTail)
termOffset := rawTail & 0xFFFFFFFF
resultingOffset = termOffset + int64(requiredLength)
if resultingOffset > int64(termLength) {
resultingOffset = handleEndOfLogCondition(termID, appender.termBuffer, int32(termOffset),
&appender.headerWriter, termLength)
} else {
flags := beginFrag
remaining := length
offset := int32(termOffset)
for remaining > 0 {
bytesToWrite := minInt32(remaining, maxPayloadLength)
frameLength := bytesToWrite + logbuffer.DataFrameHeader.Length
alignedLength := util.AlignInt32(frameLength, logbuffer.FrameAlignment)
appender.headerWriter.write(appender.termBuffer, offset, frameLength, termID)
appender.termBuffer.PutBytes(
offset+logbuffer.DataFrameHeader.Length, srcBuffer, srcOffset+(length-remaining), bytesToWrite)
if remaining <= maxPayloadLength {
flags |= endFrag
}
logbuffer.FrameFlags(appender.termBuffer, offset, flags)
reservedValue := reservedValueSupplier(appender.termBuffer, offset, frameLength)
appender.termBuffer.PutInt64(offset+logbuffer.DataFrameHeader.ReservedValueFieldOffset, reservedValue)
logbuffer.SetFrameLength(appender.termBuffer, offset, frameLength)
flags = 0
offset += alignedLength
remaining -= bytesToWrite
}
}
return resultingOffset, termID
}
// AppendFragmentedMessage2 appends the given pair of buffers (with combined length greater than max frame length)
// as a batch of fragments
func (appender *Appender) AppendFragmentedMessage2(
srcBufferOne *atomic.Buffer, srcOffsetOne int32, lengthOne int32,
srcBufferTwo *atomic.Buffer, srcOffsetTwo int32, lengthTwo int32,
maxPayloadLength int32, reservedValueSupplier ReservedValueSupplier,
) (resultingOffset int64, termID int32) {
length := lengthOne + lengthTwo
numMaxPayloads := length / maxPayloadLength
remainingPayload := length % maxPayloadLength
var lastFrameLength int32
if remainingPayload > 0 {
lastFrameLength = util.AlignInt32(remainingPayload+logbuffer.DataFrameHeader.Length, logbuffer.FrameAlignment)
}
requiredLength := (numMaxPayloads * (maxPayloadLength + logbuffer.DataFrameHeader.Length)) + lastFrameLength
rawTail := appender.getAndAddRawTail(requiredLength)
termLength := appender.termBuffer.Capacity()
termID = logbuffer.TermID(rawTail)
termOffset := rawTail & 0xFFFFFFFF
resultingOffset = termOffset + int64(requiredLength)
if resultingOffset > int64(termLength) {
resultingOffset = handleEndOfLogCondition(termID, appender.termBuffer, int32(termOffset),
&appender.headerWriter, termLength)
} else {
flags := beginFrag
remaining := length
frameOffset := int32(termOffset)
var posOne, posTwo int32
for remaining > 0 {
bytesToWrite := minInt32(remaining, maxPayloadLength)
frameLength := bytesToWrite + logbuffer.DataFrameHeader.Length
alignedLength := util.AlignInt32(frameLength, logbuffer.FrameAlignment)
appender.headerWriter.write(appender.termBuffer, frameOffset, frameLength, termID)
var bytesWritten int32
payloadOffset := frameOffset + logbuffer.DataFrameHeader.Length
for bytesWritten < bytesToWrite {
remainingOne := lengthOne - posOne
if remainingOne > 0 {
numBytes := minInt32(bytesToWrite-bytesWritten, remainingOne)
appender.termBuffer.PutBytes(payloadOffset, srcBufferOne, srcOffsetOne+posOne, numBytes)
bytesWritten += numBytes
payloadOffset += numBytes
posOne += numBytes
} else {
numBytes := minInt32(bytesToWrite-bytesWritten, lengthTwo-posTwo)
appender.termBuffer.PutBytes(payloadOffset, srcBufferTwo, srcOffsetTwo+posTwo, numBytes)
bytesWritten += numBytes
payloadOffset += numBytes
posTwo += numBytes
}
}
if remaining <= maxPayloadLength {
flags |= endFrag
}
logbuffer.FrameFlags(appender.termBuffer, frameOffset, flags)
reservedValue := reservedValueSupplier(appender.termBuffer, frameOffset, frameLength)
appender.termBuffer.PutInt64(frameOffset+logbuffer.DataFrameHeader.ReservedValueFieldOffset, reservedValue)
logbuffer.SetFrameLength(appender.termBuffer, frameOffset, frameLength)
flags = 0
frameOffset += alignedLength
remaining -= bytesToWrite
}
}
return resultingOffset, termID
}
func handleEndOfLogCondition(termID int32, termBuffer *atomic.Buffer, termOffset int32, header *headerWriter,
termLength int32) int64 {
newOffset := AppenderFailed
if termOffset <= termLength {
newOffset = AppenderTripped
if termOffset < termLength {
paddingLength := termLength - termOffset
header.write(termBuffer, termOffset, paddingLength, termID)
logbuffer.SetFrameType(termBuffer, termOffset, logbuffer.DataFrameHeader.TypePad)
logbuffer.SetFrameLength(termBuffer, termOffset, paddingLength)
}
}
return newOffset
}
func (appender *Appender) SetTailTermID(termID int32) {
appender.tailCounter.Set(int64(termID) << 32)
}
func minInt32(v1, v2 int32) int32 {
if v1 < v2 {
return v1
} else {
return v2
}
}