Skip to content

Commit b547356

Browse files
authored
Pipeline allows continuations that can produce to front (flutter#9652)
* Make pipeline hold a deque so we can push_front - Also assert that all the DoDraw tasks are executed on the GPU thread. * Add tests for pipeline * Add support for pipeline to push resources to the front
1 parent 8306ee6 commit b547356

5 files changed

Lines changed: 173 additions & 5 deletions

File tree

‎ci/licenses_golden/licenses_flutter‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -454,6 +454,7 @@ FILE: ../../../flutter/shell/common/persistent_cache.cc
454454
FILE: ../../../flutter/shell/common/persistent_cache.h
455455
FILE: ../../../flutter/shell/common/pipeline.cc
456456
FILE: ../../../flutter/shell/common/pipeline.h
457+
FILE: ../../../flutter/shell/common/pipeline_unittests.cc
457458
FILE: ../../../flutter/shell/common/platform_view.cc
458459
FILE: ../../../flutter/shell/common/platform_view.h
459460
FILE: ../../../flutter/shell/common/rasterizer.cc

‎shell/common/BUILD.gn‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,7 @@ test_fixtures("shell_unittests_fixtures") {
152152

153153
shell_host_executable("shell_unittests") {
154154
sources = [
155+
"pipeline_unittests.cc",
155156
"shell_test.cc",
156157
"shell_test.h",
157158
"shell_unittests.cc",

‎shell/common/pipeline.h‎

Lines changed: 34 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@
1010
#include "flutter/fml/synchronization/semaphore.h"
1111
#include "flutter/fml/trace_event.h"
1212

13+
#include <deque>
1314
#include <memory>
1415
#include <mutex>
15-
#include <queue>
1616

1717
namespace flutter {
1818

@@ -88,7 +88,8 @@ class Pipeline : public fml::RefCountedThreadSafe<Pipeline<R>> {
8888
FML_DISALLOW_COPY_AND_ASSIGN(ProducerContinuation);
8989
};
9090

91-
explicit Pipeline(uint32_t depth) : empty_(depth), available_(0) {}
91+
explicit Pipeline(uint32_t depth)
92+
: depth_(depth), empty_(depth), available_(0) {}
9293

9394
~Pipeline() = default;
9495

@@ -105,6 +106,20 @@ class Pipeline : public fml::RefCountedThreadSafe<Pipeline<R>> {
105106
GetNextPipelineTraceID()}; // trace id
106107
}
107108

109+
// Pushes task to the front of the pipeline.
110+
//
111+
// If we exceed the depth completing this continuation, we drop the
112+
// last frame to preserve the depth of the pipeline.
113+
//
114+
// Note: Use |Pipeline::Produce| where possible. This should only be
115+
// used to en-queue high-priority resources.
116+
ProducerContinuation ProduceToFront() {
117+
return ProducerContinuation{
118+
std::bind(&Pipeline::ProducerCommitFront, this, std::placeholders::_1,
119+
std::placeholders::_2), // continuation
120+
GetNextPipelineTraceID()}; // trace id
121+
}
122+
108123
using Consumer = std::function<void(ResourcePtr)>;
109124

110125
FML_WARN_UNUSED_RESULT
@@ -124,7 +139,7 @@ class Pipeline : public fml::RefCountedThreadSafe<Pipeline<R>> {
124139
{
125140
std::scoped_lock lock(queue_mutex_);
126141
std::tie(resource, trace_id) = std::move(queue_.front());
127-
queue_.pop();
142+
queue_.pop_front();
128143
items_count = queue_.size();
129144
}
130145

@@ -143,15 +158,29 @@ class Pipeline : public fml::RefCountedThreadSafe<Pipeline<R>> {
143158
}
144159

145160
private:
161+
uint32_t depth_;
146162
fml::Semaphore empty_;
147163
fml::Semaphore available_;
148164
std::mutex queue_mutex_;
149-
std::queue<std::pair<ResourcePtr, size_t>> queue_;
165+
std::deque<std::pair<ResourcePtr, size_t>> queue_;
150166

151167
void ProducerCommit(ResourcePtr resource, size_t trace_id) {
152168
{
153169
std::scoped_lock lock(queue_mutex_);
154-
queue_.emplace(std::move(resource), trace_id);
170+
queue_.emplace_back(std::move(resource), trace_id);
171+
}
172+
173+
// Ensure the queue mutex is not held as that would be a pessimization.
174+
available_.Signal();
175+
}
176+
177+
void ProducerCommitFront(ResourcePtr resource, size_t trace_id) {
178+
{
179+
std::scoped_lock lock(queue_mutex_);
180+
queue_.emplace_front(std::move(resource), trace_id);
181+
while (queue_.size() > depth_) {
182+
queue_.pop_back();
183+
}
155184
}
156185

157186
// Ensure the queue mutex is not held as that would be a pessimization.

‎shell/common/pipeline_unittests.cc‎

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
// Copyright 2013 The Flutter 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+
#define FML_USED_ON_EMBEDDER
6+
7+
#include <functional>
8+
#include <future>
9+
#include <memory>
10+
11+
#include "flutter/shell/common/pipeline.h"
12+
#include "gtest/gtest.h"
13+
14+
namespace flutter {
15+
namespace testing {
16+
17+
using IntPipeline = Pipeline<int>;
18+
using Continuation = IntPipeline::ProducerContinuation;
19+
20+
TEST(PipelineTest, ConsumeOneVal) {
21+
fml::RefPtr<IntPipeline> pipeline = fml::MakeRefCounted<IntPipeline>(2);
22+
23+
Continuation continuation = pipeline->Produce();
24+
25+
const int test_val = 1;
26+
continuation.Complete(std::make_unique<int>(test_val));
27+
28+
PipelineConsumeResult consume_result = pipeline->Consume(
29+
[&test_val](std::unique_ptr<int> v) { ASSERT_EQ(*v, test_val); });
30+
31+
ASSERT_EQ(consume_result, PipelineConsumeResult::Done);
32+
}
33+
34+
TEST(PipelineTest, ContinuationCanOnlyBeUsedOnce) {
35+
fml::RefPtr<IntPipeline> pipeline = fml::MakeRefCounted<IntPipeline>(2);
36+
37+
Continuation continuation = pipeline->Produce();
38+
39+
const int test_val = 1;
40+
continuation.Complete(std::make_unique<int>(test_val));
41+
42+
PipelineConsumeResult consume_result_1 = pipeline->Consume(
43+
[&test_val](std::unique_ptr<int> v) { ASSERT_EQ(*v, test_val); });
44+
45+
continuation.Complete(std::make_unique<int>(test_val));
46+
ASSERT_EQ(consume_result_1, PipelineConsumeResult::Done);
47+
48+
PipelineConsumeResult consume_result_2 =
49+
pipeline->Consume([](std::unique_ptr<int> v) { FAIL(); });
50+
51+
continuation.Complete(std::make_unique<int>(test_val));
52+
ASSERT_EQ(consume_result_2, PipelineConsumeResult::NoneAvailable);
53+
}
54+
55+
TEST(PipelineTest, PushingMoreThanDepthCompletesFirstSubmission) {
56+
const int depth = 1;
57+
fml::RefPtr<IntPipeline> pipeline = fml::MakeRefCounted<IntPipeline>(depth);
58+
59+
Continuation continuation_1 = pipeline->Produce();
60+
Continuation continuation_2 = pipeline->Produce();
61+
62+
const int test_val_1 = 1, test_val_2 = 2;
63+
continuation_1.Complete(std::make_unique<int>(test_val_1));
64+
continuation_2.Complete(std::make_unique<int>(test_val_2));
65+
66+
PipelineConsumeResult consume_result_1 = pipeline->Consume(
67+
[&test_val_1](std::unique_ptr<int> v) { ASSERT_EQ(*v, test_val_1); });
68+
69+
ASSERT_EQ(consume_result_1, PipelineConsumeResult::Done);
70+
}
71+
72+
TEST(PipelineTest, PushingMultiProcessesInOrder) {
73+
const int depth = 2;
74+
fml::RefPtr<IntPipeline> pipeline = fml::MakeRefCounted<IntPipeline>(depth);
75+
76+
Continuation continuation_1 = pipeline->Produce();
77+
Continuation continuation_2 = pipeline->Produce();
78+
79+
const int test_val_1 = 1, test_val_2 = 2;
80+
continuation_1.Complete(std::make_unique<int>(test_val_1));
81+
continuation_2.Complete(std::make_unique<int>(test_val_2));
82+
83+
PipelineConsumeResult consume_result_1 = pipeline->Consume(
84+
[&test_val_1](std::unique_ptr<int> v) { ASSERT_EQ(*v, test_val_1); });
85+
ASSERT_EQ(consume_result_1, PipelineConsumeResult::MoreAvailable);
86+
87+
PipelineConsumeResult consume_result_2 = pipeline->Consume(
88+
[&test_val_2](std::unique_ptr<int> v) { ASSERT_EQ(*v, test_val_2); });
89+
ASSERT_EQ(consume_result_2, PipelineConsumeResult::Done);
90+
}
91+
92+
TEST(PipelineTest, PushingToFrontOverridesOrder) {
93+
const int depth = 2;
94+
fml::RefPtr<IntPipeline> pipeline = fml::MakeRefCounted<IntPipeline>(depth);
95+
96+
Continuation continuation_1 = pipeline->Produce();
97+
Continuation continuation_2 = pipeline->ProduceToFront();
98+
99+
const int test_val_1 = 1, test_val_2 = 2;
100+
continuation_1.Complete(std::make_unique<int>(test_val_1));
101+
continuation_2.Complete(std::make_unique<int>(test_val_2));
102+
103+
PipelineConsumeResult consume_result_1 = pipeline->Consume(
104+
[&test_val_2](std::unique_ptr<int> v) { ASSERT_EQ(*v, test_val_2); });
105+
ASSERT_EQ(consume_result_1, PipelineConsumeResult::MoreAvailable);
106+
107+
PipelineConsumeResult consume_result_2 = pipeline->Consume(
108+
[&test_val_1](std::unique_ptr<int> v) { ASSERT_EQ(*v, test_val_1); });
109+
ASSERT_EQ(consume_result_2, PipelineConsumeResult::Done);
110+
}
111+
112+
TEST(PipelineTest, PushingToFrontDropsLastResource) {
113+
const int depth = 2;
114+
fml::RefPtr<IntPipeline> pipeline = fml::MakeRefCounted<IntPipeline>(depth);
115+
116+
Continuation continuation_1 = pipeline->Produce();
117+
Continuation continuation_2 = pipeline->Produce();
118+
Continuation continuation_3 = pipeline->ProduceToFront();
119+
120+
const int test_val_1 = 1, test_val_2 = 2, test_val_3 = 3;
121+
continuation_1.Complete(std::make_unique<int>(test_val_1));
122+
continuation_2.Complete(std::make_unique<int>(test_val_2));
123+
continuation_3.Complete(std::make_unique<int>(test_val_3));
124+
125+
PipelineConsumeResult consume_result_1 = pipeline->Consume(
126+
[&test_val_3](std::unique_ptr<int> v) { ASSERT_EQ(*v, test_val_3); });
127+
ASSERT_EQ(consume_result_1, PipelineConsumeResult::MoreAvailable);
128+
129+
PipelineConsumeResult consume_result_2 = pipeline->Consume(
130+
[&test_val_1](std::unique_ptr<int> v) { ASSERT_EQ(*v, test_val_1); });
131+
ASSERT_EQ(consume_result_2, PipelineConsumeResult::Done);
132+
}
133+
134+
} // namespace testing
135+
} // namespace flutter

‎shell/common/rasterizer.cc‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,8 @@ sk_sp<SkImage> Rasterizer::MakeRasterSnapshot(sk_sp<SkPicture> picture,
173173
}
174174

175175
void Rasterizer::DoDraw(std::unique_ptr<flutter::LayerTree> layer_tree) {
176+
FML_DCHECK(task_runners_.GetGPUTaskRunner()->RunsTasksOnCurrentThread());
177+
176178
if (!layer_tree || !surface_) {
177179
return;
178180
}

0 commit comments

Comments
 (0)