org.apache.flink.runtime.io.network.api.serialization.SpanningRecordSerializer Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.apache.flink.runtime.io.network.api.serialization;
import java.io.IOException;
import java.nio.ByteBuffer;
import java.nio.ByteOrder;
import org.apache.flink.core.io.IOReadableWritable;
import org.apache.flink.core.memory.MemorySegment;
import org.apache.flink.metrics.Counter;
import org.apache.flink.runtime.metrics.groups.IOMetricGroup;
import org.apache.flink.runtime.accumulators.AccumulatorRegistry;
import org.apache.flink.runtime.io.network.buffer.Buffer;
import org.apache.flink.runtime.util.DataOutputSerializer;
public class SpanningRecordSerializer implements RecordSerializer {
/** Flag to enable/disable checks, if buffer not set/full or pending serialization */
private static final boolean CHECKED = false;
/** Intermediate data serialization */
private final DataOutputSerializer serializationBuffer;
/** Intermediate buffer for data serialization */
private ByteBuffer dataBuffer;
/** Intermediate buffer for length serialization */
private final ByteBuffer lengthBuffer;
/** Current target {@link Buffer} of the serializer */
private Buffer targetBuffer;
/** Position in current {@link MemorySegment} of target buffer */
private int position;
/** Limit of current {@link MemorySegment} of target buffer */
private int limit;
private AccumulatorRegistry.Reporter reporter;
private transient Counter numBytesOut;
public SpanningRecordSerializer() {
this.serializationBuffer = new DataOutputSerializer(128);
this.lengthBuffer = ByteBuffer.allocate(4);
this.lengthBuffer.order(ByteOrder.BIG_ENDIAN);
// ensure initial state with hasRemaining false (for correct setNextBuffer logic)
this.dataBuffer = this.serializationBuffer.wrapAsByteBuffer();
this.lengthBuffer.position(4);
}
@Override
public SerializationResult addRecord(T record) throws IOException {
if (CHECKED) {
if (this.dataBuffer.hasRemaining()) {
throw new IllegalStateException("Pending serialization of previous record.");
}
}
this.serializationBuffer.clear();
this.lengthBuffer.clear();
// write data and length
record.write(this.serializationBuffer);
int len = this.serializationBuffer.length();
this.lengthBuffer.putInt(0, len);
if (reporter != null) {
reporter.reportNumBytesOut(len);
reporter.reportNumRecordsOut(1);
}
if (numBytesOut != null) {
numBytesOut.inc(len);
}
this.dataBuffer = this.serializationBuffer.wrapAsByteBuffer();
// Copy from intermediate buffers to current target memory segment
copyToTargetBufferFrom(this.lengthBuffer);
copyToTargetBufferFrom(this.dataBuffer);
return getSerializationResult();
}
@Override
public SerializationResult setNextBuffer(Buffer buffer) throws IOException {
this.targetBuffer = buffer;
this.position = 0;
this.limit = buffer.getSize();
if (this.lengthBuffer.hasRemaining()) {
copyToTargetBufferFrom(this.lengthBuffer);
}
if (this.dataBuffer.hasRemaining()) {
copyToTargetBufferFrom(this.dataBuffer);
}
SerializationResult result = getSerializationResult();
// make sure we don't hold onto the large buffers for too long
if (result.isFullRecord()) {
this.serializationBuffer.clear();
this.serializationBuffer.pruneBuffer();
this.dataBuffer = this.serializationBuffer.wrapAsByteBuffer();
}
return result;
}
/**
* Copies as many bytes as possible from the given {@link ByteBuffer} to the {@link MemorySegment} of the target
* {@link Buffer} and advances the current position by the number of written bytes.
*
* @param source the {@link ByteBuffer} to copy data from
*/
private void copyToTargetBufferFrom(ByteBuffer source) {
if (this.targetBuffer == null) {
return;
}
int needed = source.remaining();
int available = this.limit - this.position;
int toCopy = Math.min(needed, available);
this.targetBuffer.getMemorySegment().put(this.position, source, toCopy);
this.position += toCopy;
}
private SerializationResult getSerializationResult() {
if (!this.dataBuffer.hasRemaining() && !this.lengthBuffer.hasRemaining()) {
return (this.position < this.limit)
? SerializationResult.FULL_RECORD
: SerializationResult.FULL_RECORD_MEMORY_SEGMENT_FULL;
}
return SerializationResult.PARTIAL_RECORD_MEMORY_SEGMENT_FULL;
}
@Override
public Buffer getCurrentBuffer() {
if (targetBuffer == null) {
return null;
}
this.targetBuffer.setSize(this.position);
return this.targetBuffer;
}
@Override
public void clearCurrentBuffer() {
targetBuffer = null;
}
@Override
public void clear() {
this.targetBuffer = null;
this.position = 0;
this.limit = 0;
// ensure clear state with hasRemaining false (for correct setNextBuffer logic)
this.dataBuffer.position(this.dataBuffer.limit());
this.lengthBuffer.position(4);
}
@Override
public boolean hasData() {
// either data in current target buffer or intermediate buffers
return this.position > 0 || (this.lengthBuffer.hasRemaining() || this.dataBuffer.hasRemaining());
}
@Override
public void setReporter(AccumulatorRegistry.Reporter reporter) {
this.reporter = reporter;
}
@Override
public void instantiateMetrics(IOMetricGroup metrics) {
numBytesOut = metrics.getBytesOutCounter();
}
}