1 // Copyright 2013 The Chromium Authors
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4
5 #include "net/spdy/spdy_buffer.h"
6
7 #include <cstddef>
8 #include <cstring>
9 #include <string>
10 #include <utility>
11
12 #include "base/functional/bind.h"
13 #include "base/functional/callback.h"
14 #include "base/memory/ref_counted.h"
15 #include "net/base/io_buffer.h"
16 #include "net/third_party/quiche/src/quiche/spdy/core/spdy_protocol.h"
17 #include "net/third_party/quiche/src/quiche/spdy/test_tools/spdy_test_utils.h"
18 #include "testing/gtest/include/gtest/gtest.h"
19
20 namespace net {
21
22 namespace {
23
24 const char kData[] = "hello!\0hi.";
25 const size_t kDataSize = std::size(kData);
26
27 class SpdyBufferTest : public ::testing::Test {};
28
29 // Make a string from the data remaining in |buffer|.
BufferToString(const SpdyBuffer & buffer)30 std::string BufferToString(const SpdyBuffer& buffer) {
31 return std::string(buffer.GetRemainingData(), buffer.GetRemainingSize());
32 }
33
34 // Construct a SpdyBuffer from a spdy::SpdySerializedFrame and make sure its
35 // data is same as the original data.
TEST_F(SpdyBufferTest,FrameConstructor)36 TEST_F(SpdyBufferTest, FrameConstructor) {
37 SpdyBuffer buffer(std::make_unique<spdy::SpdySerializedFrame>(
38 spdy::test::MakeSerializedFrame(const_cast<char*>(kData), kDataSize)));
39
40 EXPECT_EQ(kDataSize, buffer.GetRemainingSize());
41 EXPECT_EQ(
42 std::string_view(kData, kDataSize),
43 std::string_view(buffer.GetRemainingData(), buffer.GetRemainingSize()));
44 }
45
46 // Construct a SpdyBuffer from a const char*/size_t pair and make sure
47 // it makes a copy of the data.
TEST_F(SpdyBufferTest,DataConstructor)48 TEST_F(SpdyBufferTest, DataConstructor) {
49 std::string data(kData, kDataSize);
50 SpdyBuffer buffer(data.data(), data.size());
51 // This mutation shouldn't affect |buffer|'s data.
52 data[0] = 'H';
53
54 EXPECT_NE(kData, buffer.GetRemainingData());
55 EXPECT_EQ(kDataSize, buffer.GetRemainingSize());
56 EXPECT_EQ(std::string(kData, kDataSize), BufferToString(buffer));
57 }
58
IncrementBy(size_t * x,SpdyBuffer::ConsumeSource expected_consume_source,size_t delta,SpdyBuffer::ConsumeSource consume_source)59 void IncrementBy(size_t* x,
60 SpdyBuffer::ConsumeSource expected_consume_source,
61 size_t delta,
62 SpdyBuffer::ConsumeSource consume_source) {
63 EXPECT_EQ(expected_consume_source, consume_source);
64 *x += delta;
65 }
66
67 // Construct a SpdyBuffer and call Consume() on it, which should
68 // update the remaining data pointer and size appropriately, as well
69 // as calling the consume callbacks.
TEST_F(SpdyBufferTest,Consume)70 TEST_F(SpdyBufferTest, Consume) {
71 SpdyBuffer buffer(kData, kDataSize);
72
73 size_t x1 = 0;
74 size_t x2 = 0;
75 buffer.AddConsumeCallback(
76 base::BindRepeating(&IncrementBy, &x1, SpdyBuffer::CONSUME));
77 buffer.AddConsumeCallback(
78 base::BindRepeating(&IncrementBy, &x2, SpdyBuffer::CONSUME));
79
80 EXPECT_EQ(std::string(kData, kDataSize), BufferToString(buffer));
81
82 buffer.Consume(5);
83 EXPECT_EQ(std::string(kData + 5, kDataSize - 5), BufferToString(buffer));
84 EXPECT_EQ(5u, x1);
85 EXPECT_EQ(5u, x2);
86
87 buffer.Consume(kDataSize - 5);
88 EXPECT_EQ(0u, buffer.GetRemainingSize());
89 EXPECT_EQ(kDataSize, x1);
90 EXPECT_EQ(kDataSize, x2);
91 }
92
93 // Construct a SpdyBuffer and attach a ConsumeCallback to it. The
94 // callback should be called when the SpdyBuffer is destroyed.
TEST_F(SpdyBufferTest,ConsumeOnDestruction)95 TEST_F(SpdyBufferTest, ConsumeOnDestruction) {
96 size_t x = 0;
97
98 {
99 SpdyBuffer buffer(kData, kDataSize);
100 buffer.AddConsumeCallback(
101 base::BindRepeating(&IncrementBy, &x, SpdyBuffer::DISCARD));
102 }
103
104 EXPECT_EQ(kDataSize, x);
105 }
106
107 // Make sure the IOBuffer returned by GetIOBufferForRemainingData()
108 // points to the buffer's remaining data and isn't updated by
109 // Consume().
TEST_F(SpdyBufferTest,GetIOBufferForRemainingData)110 TEST_F(SpdyBufferTest, GetIOBufferForRemainingData) {
111 SpdyBuffer buffer(kData, kDataSize);
112
113 buffer.Consume(5);
114 scoped_refptr<IOBuffer> io_buffer = buffer.GetIOBufferForRemainingData();
115 size_t io_buffer_size = buffer.GetRemainingSize();
116 const std::string expectedData(kData + 5, kDataSize - 5);
117 EXPECT_EQ(expectedData, std::string(io_buffer->data(), io_buffer_size));
118
119 buffer.Consume(kDataSize - 5);
120 EXPECT_EQ(expectedData, std::string(io_buffer->data(), io_buffer_size));
121 }
122
123 // Make sure the IOBuffer returned by GetIOBufferForRemainingData()
124 // outlives the buffer itself.
TEST_F(SpdyBufferTest,IOBufferForRemainingDataOutlivesBuffer)125 TEST_F(SpdyBufferTest, IOBufferForRemainingDataOutlivesBuffer) {
126 auto buffer = std::make_unique<SpdyBuffer>(kData, kDataSize);
127 scoped_refptr<IOBuffer> io_buffer = buffer->GetIOBufferForRemainingData();
128 buffer.reset();
129
130 // This will cause a use-after-free error if |io_buffer| doesn't
131 // outlive |buffer|.
132 std::memcpy(io_buffer->data(), kData, kDataSize);
133 }
134
135 } // namespace
136
137 } // namespace net
138