1 // Copyright (c) 2013 The Chromium Authors. All rights reserved.
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_read_queue.h"
6 
7 #include <algorithm>
8 #include <cstddef>
9 #include <string>
10 #include <utility>
11 
12 #include "base/bind.h"
13 #include "base/callback.h"
14 #include "base/stl_util.h"
15 #include "net/spdy/spdy_buffer.h"
16 #include "testing/gtest/include/gtest/gtest.h"
17 
18 namespace net {
19 namespace test {
20 namespace {
21 
22 const char kData[] = "SPDY read queue test data.\0Some more data.";
23 const size_t kDataSize = base::size(kData);
24 
25 // Enqueues |data| onto |queue| in chunks of at most |max_buffer_size|
26 // bytes.
EnqueueString(const std::string & data,size_t max_buffer_size,SpdyReadQueue * queue)27 void EnqueueString(const std::string& data,
28                    size_t max_buffer_size,
29                    SpdyReadQueue* queue) {
30   ASSERT_GT(data.size(), 0u);
31   ASSERT_GT(max_buffer_size, 0u);
32   size_t old_total_size = queue->GetTotalSize();
33   for (size_t i = 0; i < data.size();) {
34     size_t buffer_size = std::min(data.size() - i, max_buffer_size);
35     queue->Enqueue(std::unique_ptr<SpdyBuffer>(
36         new SpdyBuffer(data.data() + i, buffer_size)));
37     i += buffer_size;
38     EXPECT_FALSE(queue->IsEmpty());
39     EXPECT_EQ(old_total_size + i, queue->GetTotalSize());
40   }
41 }
42 
43 // Dequeues all bytes in |queue| in chunks of at most
44 // |max_buffer_size| bytes and returns the data as a string.
DrainToString(size_t max_buffer_size,SpdyReadQueue * queue)45 std::string DrainToString(size_t max_buffer_size, SpdyReadQueue* queue) {
46   std::string data;
47 
48   // Pad the buffer so we can detect out-of-bound writes.
49   size_t padding = std::max(static_cast<size_t>(4096), queue->GetTotalSize());
50   size_t buffer_size_with_padding = padding + max_buffer_size + padding;
51   auto buffer = std::make_unique<char[]>(buffer_size_with_padding);
52   std::memset(buffer.get(), 0, buffer_size_with_padding);
53   char* buffer_data = buffer.get() + padding;
54 
55   while (!queue->IsEmpty()) {
56     size_t old_total_size = queue->GetTotalSize();
57     EXPECT_GT(old_total_size, 0u);
58     size_t dequeued_bytes = queue->Dequeue(buffer_data, max_buffer_size);
59 
60     // Make sure |queue| doesn't write past either end of its given
61     // boundaries.
62     for (int i = 1; i <= static_cast<int>(padding); ++i) {
63       EXPECT_EQ('\0', buffer_data[-i]) << -i;
64     }
65     for (size_t i = 0; i < padding; ++i) {
66       EXPECT_EQ('\0', buffer_data[max_buffer_size + i]) << i;
67     }
68 
69     data.append(buffer_data, dequeued_bytes);
70     EXPECT_EQ(dequeued_bytes, std::min(max_buffer_size, dequeued_bytes));
71     EXPECT_EQ(queue->GetTotalSize(), old_total_size - dequeued_bytes);
72   }
73   EXPECT_TRUE(queue->IsEmpty());
74   return data;
75 }
76 
77 // Enqueue a test string with the given enqueue/dequeue max buffer
78 // sizes.
RunEnqueueDequeueTest(size_t enqueue_max_buffer_size,size_t dequeue_max_buffer_size)79 void RunEnqueueDequeueTest(size_t enqueue_max_buffer_size,
80                            size_t dequeue_max_buffer_size) {
81   std::string data(kData, kDataSize);
82   SpdyReadQueue read_queue;
83   EnqueueString(data, enqueue_max_buffer_size, &read_queue);
84   const std::string& drained_data =
85       DrainToString(dequeue_max_buffer_size, &read_queue);
86   EXPECT_EQ(data, drained_data);
87 }
88 
OnBufferDiscarded(bool * discarded,size_t * discarded_bytes,size_t delta,SpdyBuffer::ConsumeSource consume_source)89 void OnBufferDiscarded(bool* discarded,
90                        size_t* discarded_bytes,
91                        size_t delta,
92                        SpdyBuffer::ConsumeSource consume_source) {
93   EXPECT_EQ(SpdyBuffer::DISCARD, consume_source);
94   *discarded = true;
95   *discarded_bytes = delta;
96 }
97 
98 }  // namespace
99 
100 class SpdyReadQueueTest : public ::testing::Test {};
101 
102 // Call RunEnqueueDequeueTest() with various buffer size combinatinos.
103 
TEST_F(SpdyReadQueueTest,LargeEnqueueAndDequeueBuffers)104 TEST_F(SpdyReadQueueTest, LargeEnqueueAndDequeueBuffers) {
105   RunEnqueueDequeueTest(2 * kDataSize, 2 * kDataSize);
106 }
107 
TEST_F(SpdyReadQueueTest,OneByteEnqueueAndDequeueBuffers)108 TEST_F(SpdyReadQueueTest, OneByteEnqueueAndDequeueBuffers) {
109   RunEnqueueDequeueTest(1, 1);
110 }
111 
TEST_F(SpdyReadQueueTest,CoprimeBufferSizes)112 TEST_F(SpdyReadQueueTest, CoprimeBufferSizes) {
113   RunEnqueueDequeueTest(2, 3);
114   RunEnqueueDequeueTest(3, 2);
115 }
116 
TEST_F(SpdyReadQueueTest,Clear)117 TEST_F(SpdyReadQueueTest, Clear) {
118   auto buffer = std::make_unique<SpdyBuffer>(kData, kDataSize);
119   bool discarded = false;
120   size_t discarded_bytes = 0;
121   buffer->AddConsumeCallback(
122       base::BindRepeating(&OnBufferDiscarded, &discarded, &discarded_bytes));
123 
124   SpdyReadQueue read_queue;
125   read_queue.Enqueue(std::move(buffer));
126 
127   EXPECT_FALSE(discarded);
128   EXPECT_EQ(0u, discarded_bytes);
129   EXPECT_FALSE(read_queue.IsEmpty());
130 
131   read_queue.Clear();
132 
133   EXPECT_TRUE(discarded);
134   EXPECT_EQ(kDataSize, discarded_bytes);
135   EXPECT_TRUE(read_queue.IsEmpty());
136 }
137 
138 }  // namespace test
139 }  // namespace net
140