Skip to content
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.

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

netty: Eliminate buffer release when there is an error as caller still owns the buffer. #10537

Merged
merged 6 commits into from
Sep 15, 2023
11 changes: 3 additions & 8 deletions netty/src/main/java/io/grpc/netty/NettyAdaptiveCumulator.java
Original file line number Diff line number Diff line change
Expand Up @@ -204,16 +204,11 @@ static void mergeWithCompositeTail(
composite.addFlattenedComponents(true, newTail);
// New tail's ownership transferred to the composite buf.
newTail = null;
in.release();
in = null;
// Restore the reader. In case it fails we restore the reader after releasing/forgetting
// the input and the new tail so that finally block can handles them properly.
composite.readerIndex(prevReader);
// Input buffer was successfully merged with the tail.
// Must be the last line in the try because we release it only on success.
in.release();
} finally {
// Input buffer was merged with the tail.
if (in != null) {
in.release();
}
// If new tail's ownership isn't transferred to the composite buf.
// Release it to prevent a leak.
if (newTail != null) {
Expand Down
16 changes: 12 additions & 4 deletions netty/src/test/java/io/grpc/netty/NettyAdaptiveCumulatorTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -533,18 +533,22 @@ public CompositeByteBuf addFlattenedComponents(boolean increaseWriterIndex,

try {
NettyAdaptiveCumulator.mergeWithCompositeTail(alloc, compositeThrows, in);
in = null; // On success it would be released
fail("Cumulator didn't throw");
} catch (UnsupportedOperationException actualError) {
assertSame(expectedError, actualError);
// Input must be released unless its ownership has been to the composite cumulation.
assertEquals(0, in.refCnt());
// Because of error, ownership shouldn't have changed so should not have been released.
assertEquals(1, in.refCnt());
// Tail released
assertEquals(0, tail.refCnt());
// Composite cumulation is retained
assertEquals(1, compositeThrows.refCnt());
// Composite cumulation loses the tail
assertEquals(0, compositeThrows.numComponents());
} finally {
if (in != null) {
in.release();
}
compositeThrows.release();
}
}
Expand All @@ -569,18 +573,22 @@ public CompositeByteBuf addFlattenedComponents(boolean increaseWriterIndex,

try {
NettyAdaptiveCumulator.mergeWithCompositeTail(mockAlloc, compositeRo, in);
in = null; // On success it would be released
fail("Cumulator didn't throw");
} catch (UnsupportedOperationException actualError) {
assertSame(expectedError, actualError);
// Input must be released unless its ownership has been to the composite cumulation.
assertEquals(0, in.refCnt());
// Because of error, ownership shouldn't have changed so should not have been released.
assertEquals(1, in.refCnt());
// New buffer released
assertEquals(0, newTail.refCnt());
// Composite cumulation is retained
assertEquals(1, compositeRo.refCnt());
// Composite cumulation loses the tail
assertEquals(0, compositeRo.numComponents());
} finally {
if (in != null) {
in.release();
}
compositeRo.release();
}
}
Expand Down