Skip to content

[FLINK-25796][network] Avoid record copy for result partition of sort-shuffle if there are enough buffers for better performance #18505

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

[FLINK-25796][network] Avoid record copy for result partition of sort-shuffle if there are enough buffers for better performance #18505

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 24 additions & 17 deletions ...time/io/network/partition/SortBuffer.java → ...time/io/network/partition/DataBuffer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,48 +21,55 @@
import org.apache.flink.core.memory.MemorySegment;
import org.apache.flink.runtime.io.network.buffer.Buffer;

import javax.annotation.Nullable;

import java.io.IOException;
import java.nio.ByteBuffer;

/**
* Data of different channels can be appended to a {@link SortBuffer} and after the {@link
* SortBuffer} is finished, the appended data can be copied from it in channel index order.
* Data of different channels can be appended to a {@link DataBuffer} and after the {@link
* DataBuffer} is full or finished, the appended data can be copied from it in channel index order.
*
* <p>The lifecycle of a {@link DataBuffer} can be: new, write, [read, reset, write], finish, read,
* release. There can be multiple [read, reset, write] operations before finish.
*/
public interface SortBuffer {
public interface DataBuffer {

/**
* Appends data of the specified channel to this {@link SortBuffer} and returns true if all
* bytes of the source buffer is copied to this {@link SortBuffer} successfully, otherwise if
* returns false, nothing will be copied.
* Appends data of the specified channel to this {@link DataBuffer} and returns true if this
* {@link DataBuffer} is full.
*/
boolean append(ByteBuffer source, int targetChannel, Buffer.DataType dataType)
throws IOException;

/**
* Copies data in this {@link SortBuffer} to the target {@link MemorySegment} in channel index
* Copies data in this {@link DataBuffer} to the target {@link MemorySegment} in channel index
* order and returns {@link BufferWithChannel} which contains the copied data and the
* corresponding channel index.
*/
BufferWithChannel copyIntoSegment(MemorySegment target);
BufferWithChannel getNextBuffer(@Nullable MemorySegment transitBuffer);

/** Returns the number of records written to this {@link SortBuffer}. */
long numRecords();
/** Returns the total number of records written to this {@link DataBuffer}. */
long numTotalRecords();

/** Returns the number of bytes written to this {@link SortBuffer}. */
long numBytes();
/** Returns the total number of bytes written to this {@link DataBuffer}. */
long numTotalBytes();

/** Returns true if there is still data can be consumed in this {@link SortBuffer}. */
/** Returns true if not all data appended to this {@link DataBuffer} is consumed. */
boolean hasRemaining();

/** Finishes this {@link SortBuffer} which means no record can be appended any more. */
/** Resets this {@link DataBuffer} to be reused for data appending. */
void reset();

/** Finishes this {@link DataBuffer} which means no record can be appended any more. */
void finish();

/** Whether this {@link SortBuffer} is finished or not. */
/** Whether this {@link DataBuffer} is finished or not. */
boolean isFinished();

/** Releases this {@link SortBuffer} which releases all resources. */
/** Releases this {@link DataBuffer} which releases all resources. */
void release();

/** Whether this {@link SortBuffer} is released or not. */
/** Whether this {@link DataBuffer} is released or not. */
boolean isReleased();
}
313 changes: 313 additions & 0 deletions ...time/src/main/java/org/apache/flink/runtime/io/network/partition/HashBasedDataBuffer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,313 @@
/*
* 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.partition;

import org.apache.flink.core.memory.MemorySegment;
import org.apache.flink.core.memory.MemorySegmentFactory;
import org.apache.flink.runtime.io.network.buffer.Buffer;
import org.apache.flink.runtime.io.network.buffer.BufferBuilder;
import org.apache.flink.runtime.io.network.buffer.BufferConsumer;
import org.apache.flink.runtime.io.network.buffer.BufferPool;
import org.apache.flink.runtime.io.network.buffer.FreeingBufferRecycler;
import org.apache.flink.runtime.io.network.buffer.NetworkBuffer;

import javax.annotation.Nullable;

import java.io.IOException;
import java.nio.ByteBuffer;
import java.util.ArrayDeque;

import static org.apache.flink.util.Preconditions.checkArgument;
import static org.apache.flink.util.Preconditions.checkNotNull;
import static org.apache.flink.util.Preconditions.checkState;

/**
* * A {@link DataBuffer} implementation which sorts all appended records only by subpartition
* index. Records of the same subpartition keep the appended order.
*
* <p>Different from the {@link SortBasedDataBuffer}, in this {@link DataBuffer} implementation,
* memory segment boundary serves as the nature data boundary of different subpartitions, which
* means that one memory segment can never contain data from different subpartitions.
*/
public class HashBasedDataBuffer implements DataBuffer {

/** A buffer pool to request memory segments from. */
private final BufferPool bufferPool;

/** Number of guaranteed buffers can be allocated from the buffer pool for data sort. */
private final int numGuaranteedBuffers;

/** Buffers containing data for all subpartitions. */
private final ArrayDeque<BufferConsumer>[] buffers;

// ---------------------------------------------------------------------------------------------
// Statistics and states
// ---------------------------------------------------------------------------------------------

/** Total number of bytes already appended to this sort buffer. */
private long numTotalBytes;

/** Total number of records already appended to this sort buffer. */
private long numTotalRecords;

/** Whether this sort buffer is full and ready to read data from. */
private boolean isFull;

/** Whether this sort buffer is finished. One can only read a finished sort buffer. */
private boolean isFinished;

/** Whether this sort buffer is released. A released sort buffer can not be used. */
private boolean isReleased;

// ---------------------------------------------------------------------------------------------
// For writing
// ---------------------------------------------------------------------------------------------

/** Partial buffers to be appended data for each channel. */
private final BufferBuilder[] builders;

/** Total number of network buffers already occupied currently by this sort buffer. */
private int numBuffersOccupied;

// ---------------------------------------------------------------------------------------------
// For reading
// ---------------------------------------------------------------------------------------------

/** Used to index the current available channel to read data from. */
private int readOrderIndex;

/** Data of different subpartitions in this sort buffer will be read in this order. */
private final int[] subpartitionReadOrder;

/** Total number of bytes already read from this sort buffer. */
private long numTotalBytesRead;

public HashBasedDataBuffer(
BufferPool bufferPool,
int numSubpartitions,
int numGuaranteedBuffers,
@Nullable int[] customReadOrder) {
checkArgument(numGuaranteedBuffers > 0, "No guaranteed buffers for sort.");

this.bufferPool = checkNotNull(bufferPool);
this.numGuaranteedBuffers = numGuaranteedBuffers;

this.builders = new BufferBuilder[numSubpartitions];
this.buffers = new ArrayDeque[numSubpartitions];
for (int channel = 0; channel < numSubpartitions; ++channel) {
this.buffers[channel] = new ArrayDeque<>();
}

this.subpartitionReadOrder = new int[numSubpartitions];
if (customReadOrder != null) {
checkArgument(customReadOrder.length == numSubpartitions, "Illegal data read order.");
System.arraycopy(customReadOrder, 0, this.subpartitionReadOrder, 0, numSubpartitions);
} else {
for (int channel = 0; channel < numSubpartitions; ++channel) {
this.subpartitionReadOrder[channel] = channel;
}
}
}

/**
* Partial data of the target record can be written if this {@link HashBasedDataBuffer} is full.
* The remaining data of the target record will be written to the next data region (a new data
* buffer or this data buffer after reset).
*/
@Override
public boolean append(ByteBuffer source, int targetChannel, Buffer.DataType dataType)
throws IOException {
checkArgument(source.hasRemaining(), "Cannot append empty data.");
checkState(!isFull, "Sort buffer is already full.");
checkState(!isFinished, "Sort buffer is already finished.");
checkState(!isReleased, "Sort buffer is already released.");

int totalBytes = source.remaining();
if (dataType.isBuffer()) {
writeRecord(source, targetChannel);
} else {
writeEvent(source, targetChannel, dataType);
}

isFull = source.hasRemaining();
if (!isFull) {
++numTotalRecords;
}
numTotalBytes += totalBytes - source.remaining();
return isFull;
}

private void writeEvent(ByteBuffer source, int targetChannel, Buffer.DataType dataType) {
BufferBuilder builder = builders[targetChannel];
if (builder != null) {
builder.finish();
buffers[targetChannel].add(builder.createBufferConsumerFromBeginning());
builder.close();
builders[targetChannel] = null;
}

MemorySegment segment =
MemorySegmentFactory.allocateUnpooledOffHeapMemory(source.remaining());
segment.put(0, source, segment.size());
BufferConsumer consumer =
new BufferConsumer(
new NetworkBuffer(segment, FreeingBufferRecycler.INSTANCE, dataType),
segment.size());
buffers[targetChannel].add(consumer);
}

private void writeRecord(ByteBuffer source, int targetChannel) throws IOException {
do {
BufferBuilder builder = builders[targetChannel];
if (builder == null) {
builder = requestBufferFromPool();
if (builder == null) {
break;
}
++numBuffersOccupied;
builders[targetChannel] = builder;
}

builder.append(source);
if (builder.isFull()) {
builder.finish();
buffers[targetChannel].add(builder.createBufferConsumerFromBeginning());
builder.close();
builders[targetChannel] = null;
}
} while (source.hasRemaining());
}

private BufferBuilder requestBufferFromPool() throws IOException {
try {
// blocking request buffers if there is still guaranteed memory
if (numBuffersOccupied < numGuaranteedBuffers) {
return bufferPool.requestBufferBuilderBlocking();
}
} catch (InterruptedException e) {
throw new IOException("Interrupted while requesting buffer.", e);
}

return bufferPool.requestBufferBuilder();
}

@Override
public BufferWithChannel getNextBuffer(MemorySegment transitBuffer) {
checkState(isFull, "Sort buffer is not ready to be read.");
checkState(!isReleased, "Sort buffer is already released.");

BufferWithChannel buffer = null;
if (!hasRemaining() || readOrderIndex >= subpartitionReadOrder.length) {
return null;
}

int targetChannel = subpartitionReadOrder[readOrderIndex];
while (buffer == null) {
BufferConsumer consumer = buffers[targetChannel].poll();
if (consumer != null) {
buffer = new BufferWithChannel(consumer.build(), targetChannel);
numBuffersOccupied -= buffer.getBuffer().isBuffer() ? 1 : 0;
numTotalBytesRead += buffer.getBuffer().readableBytes();
consumer.close();
} else {
if (++readOrderIndex >= subpartitionReadOrder.length) {
break;
}
targetChannel = subpartitionReadOrder[readOrderIndex];
}
}
return buffer;
}

@Override
public long numTotalRecords() {
return numTotalRecords;
}

@Override
public long numTotalBytes() {
return numTotalBytes;
}

@Override
public boolean hasRemaining() {
return numTotalBytesRead < numTotalBytes;
}

@Override
public void reset() {
checkState(!isFinished, "Sort buffer has been finished.");
checkState(!isReleased, "Sort buffer has been released.");

isFull = false;
readOrderIndex = 0;
}

@Override
public void finish() {
checkState(!isFull, "DataBuffer must not be full.");
checkState(!isFinished, "DataBuffer is already finished.");

isFull = true;
isFinished = true;
for (int channel = 0; channel < builders.length; ++channel) {
BufferBuilder builder = builders[channel];
if (builder != null) {
builder.finish();
buffers[channel].add(builder.createBufferConsumerFromBeginning());
builder.close();
builders[channel] = null;
}
}
}

@Override
public boolean isFinished() {
return isFinished;
}

@Override
public void release() {
if (isReleased) {
return;
}
isReleased = true;

for (int channel = 0; channel < builders.length; ++channel) {
BufferBuilder builder = builders[channel];
if (builder != null) {
builder.close();
builders[channel] = null;
}
}

for (ArrayDeque<BufferConsumer> buffer : buffers) {
BufferConsumer consumer = buffer.poll();
while (consumer != null) {
consumer.close();
consumer = buffer.poll();
}
}
}

@Override
public boolean isReleased() {
return isReleased;
}
}
Loading