fdoray | f432952 | 2016-03-17 10:57:42 +0900 | [diff] [blame] | 1 | // Copyright 2016 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 "base/task_scheduler/sequence.h" |
| 6 | |
fdoray | 66f5a34 | 2016-07-22 06:22:59 +0900 | [diff] [blame] | 7 | #include <utility> |
| 8 | |
| 9 | #include "base/bind.h" |
fdoray | f432952 | 2016-03-17 10:57:42 +0900 | [diff] [blame] | 10 | #include "base/macros.h" |
fdoray | 66f5a34 | 2016-07-22 06:22:59 +0900 | [diff] [blame] | 11 | #include "base/memory/ptr_util.h" |
fdoray | d7a33a6 | 2016-10-12 21:21:27 +0900 | [diff] [blame^] | 12 | #include "base/test/gtest_util.h" |
fdoray | f432952 | 2016-03-17 10:57:42 +0900 | [diff] [blame] | 13 | #include "base/time/time.h" |
| 14 | #include "testing/gtest/include/gtest/gtest.h" |
| 15 | |
| 16 | namespace base { |
| 17 | namespace internal { |
| 18 | |
| 19 | namespace { |
| 20 | |
fdoray | 66f5a34 | 2016-07-22 06:22:59 +0900 | [diff] [blame] | 21 | |
fdoray | f432952 | 2016-03-17 10:57:42 +0900 | [diff] [blame] | 22 | class TaskSchedulerSequenceTest : public testing::Test { |
| 23 | public: |
| 24 | TaskSchedulerSequenceTest() |
| 25 | : task_a_owned_( |
| 26 | new Task(FROM_HERE, |
| 27 | Closure(), |
fdoray | 97e4358 | 2016-04-19 02:46:30 +0900 | [diff] [blame] | 28 | TaskTraits().WithPriority(TaskPriority::BACKGROUND), |
fdoray | 01ddcba | 2016-04-26 12:19:16 +0900 | [diff] [blame] | 29 | TimeDelta())), |
fdoray | f432952 | 2016-03-17 10:57:42 +0900 | [diff] [blame] | 30 | task_b_owned_( |
| 31 | new Task(FROM_HERE, |
| 32 | Closure(), |
fdoray | 97e4358 | 2016-04-19 02:46:30 +0900 | [diff] [blame] | 33 | TaskTraits().WithPriority(TaskPriority::USER_VISIBLE), |
fdoray | 01ddcba | 2016-04-26 12:19:16 +0900 | [diff] [blame] | 34 | TimeDelta())), |
fdoray | f432952 | 2016-03-17 10:57:42 +0900 | [diff] [blame] | 35 | task_c_owned_( |
| 36 | new Task(FROM_HERE, |
| 37 | Closure(), |
fdoray | 97e4358 | 2016-04-19 02:46:30 +0900 | [diff] [blame] | 38 | TaskTraits().WithPriority(TaskPriority::USER_BLOCKING), |
fdoray | 01ddcba | 2016-04-26 12:19:16 +0900 | [diff] [blame] | 39 | TimeDelta())), |
fdoray | f432952 | 2016-03-17 10:57:42 +0900 | [diff] [blame] | 40 | task_d_owned_( |
| 41 | new Task(FROM_HERE, |
| 42 | Closure(), |
fdoray | 97e4358 | 2016-04-19 02:46:30 +0900 | [diff] [blame] | 43 | TaskTraits().WithPriority(TaskPriority::USER_BLOCKING), |
fdoray | 01ddcba | 2016-04-26 12:19:16 +0900 | [diff] [blame] | 44 | TimeDelta())), |
fdoray | f432952 | 2016-03-17 10:57:42 +0900 | [diff] [blame] | 45 | task_e_owned_( |
| 46 | new Task(FROM_HERE, |
| 47 | Closure(), |
fdoray | 97e4358 | 2016-04-19 02:46:30 +0900 | [diff] [blame] | 48 | TaskTraits().WithPriority(TaskPriority::BACKGROUND), |
fdoray | 01ddcba | 2016-04-26 12:19:16 +0900 | [diff] [blame] | 49 | TimeDelta())), |
fdoray | f432952 | 2016-03-17 10:57:42 +0900 | [diff] [blame] | 50 | task_a_(task_a_owned_.get()), |
| 51 | task_b_(task_b_owned_.get()), |
| 52 | task_c_(task_c_owned_.get()), |
| 53 | task_d_(task_d_owned_.get()), |
| 54 | task_e_(task_e_owned_.get()) {} |
| 55 | |
| 56 | protected: |
| 57 | // Tasks to be handed off to a Sequence for testing. |
dcheng | cc8e4d8 | 2016-04-05 06:25:51 +0900 | [diff] [blame] | 58 | std::unique_ptr<Task> task_a_owned_; |
| 59 | std::unique_ptr<Task> task_b_owned_; |
| 60 | std::unique_ptr<Task> task_c_owned_; |
| 61 | std::unique_ptr<Task> task_d_owned_; |
| 62 | std::unique_ptr<Task> task_e_owned_; |
fdoray | f432952 | 2016-03-17 10:57:42 +0900 | [diff] [blame] | 63 | |
| 64 | // Raw pointers to those same tasks for verification. This is needed because |
| 65 | // the scoped_ptrs above no longer point to the tasks once they have been |
| 66 | // moved into a Sequence. |
| 67 | const Task* task_a_; |
| 68 | const Task* task_b_; |
| 69 | const Task* task_c_; |
| 70 | const Task* task_d_; |
| 71 | const Task* task_e_; |
| 72 | |
| 73 | private: |
| 74 | DISALLOW_COPY_AND_ASSIGN(TaskSchedulerSequenceTest); |
| 75 | }; |
| 76 | |
fdoray | f432952 | 2016-03-17 10:57:42 +0900 | [diff] [blame] | 77 | } // namespace |
| 78 | |
fdoray | d7a33a6 | 2016-10-12 21:21:27 +0900 | [diff] [blame^] | 79 | TEST_F(TaskSchedulerSequenceTest, PushTakeRemove) { |
fdoray | f432952 | 2016-03-17 10:57:42 +0900 | [diff] [blame] | 80 | scoped_refptr<Sequence> sequence(new Sequence); |
| 81 | |
| 82 | // Push task A in the sequence. Its sequenced time should be updated and it |
| 83 | // should be in front of the sequence. |
| 84 | EXPECT_TRUE(sequence->PushTask(std::move(task_a_owned_))); |
| 85 | EXPECT_FALSE(task_a_->sequenced_time.is_null()); |
fdoray | d7a33a6 | 2016-10-12 21:21:27 +0900 | [diff] [blame^] | 86 | EXPECT_EQ(task_a_->traits.priority(), sequence->PeekTaskTraits().priority()); |
fdoray | f432952 | 2016-03-17 10:57:42 +0900 | [diff] [blame] | 87 | |
| 88 | // Push task B, C and D in the sequence. Their sequenced time should be |
| 89 | // updated and task A should always remain in front of the sequence. |
| 90 | EXPECT_FALSE(sequence->PushTask(std::move(task_b_owned_))); |
| 91 | EXPECT_FALSE(task_b_->sequenced_time.is_null()); |
fdoray | d7a33a6 | 2016-10-12 21:21:27 +0900 | [diff] [blame^] | 92 | EXPECT_EQ(task_a_->traits.priority(), sequence->PeekTaskTraits().priority()); |
fdoray | f432952 | 2016-03-17 10:57:42 +0900 | [diff] [blame] | 93 | |
| 94 | EXPECT_FALSE(sequence->PushTask(std::move(task_c_owned_))); |
| 95 | EXPECT_FALSE(task_c_->sequenced_time.is_null()); |
fdoray | d7a33a6 | 2016-10-12 21:21:27 +0900 | [diff] [blame^] | 96 | EXPECT_EQ(task_a_->traits.priority(), sequence->PeekTaskTraits().priority()); |
fdoray | f432952 | 2016-03-17 10:57:42 +0900 | [diff] [blame] | 97 | |
| 98 | EXPECT_FALSE(sequence->PushTask(std::move(task_d_owned_))); |
| 99 | EXPECT_FALSE(task_d_->sequenced_time.is_null()); |
fdoray | d7a33a6 | 2016-10-12 21:21:27 +0900 | [diff] [blame^] | 100 | EXPECT_EQ(task_a_->traits.priority(), sequence->PeekTaskTraits().priority()); |
fdoray | f432952 | 2016-03-17 10:57:42 +0900 | [diff] [blame] | 101 | |
fdoray | d7a33a6 | 2016-10-12 21:21:27 +0900 | [diff] [blame^] | 102 | // Get the task in front of the sequence. It should be task A. |
| 103 | EXPECT_EQ(task_a_, sequence->TakeTask().get()); |
fdoray | f432952 | 2016-03-17 10:57:42 +0900 | [diff] [blame] | 104 | |
fdoray | d7a33a6 | 2016-10-12 21:21:27 +0900 | [diff] [blame^] | 105 | // Remove the empty slot. Task B should now be in front. |
| 106 | EXPECT_FALSE(sequence->Pop()); |
| 107 | EXPECT_EQ(task_b_, sequence->TakeTask().get()); |
fdoray | f432952 | 2016-03-17 10:57:42 +0900 | [diff] [blame] | 108 | |
fdoray | d7a33a6 | 2016-10-12 21:21:27 +0900 | [diff] [blame^] | 109 | // Remove the empty slot. Task C should now be in front. |
| 110 | EXPECT_FALSE(sequence->Pop()); |
| 111 | EXPECT_EQ(task_c_, sequence->TakeTask().get()); |
fdoray | f432952 | 2016-03-17 10:57:42 +0900 | [diff] [blame] | 112 | |
fdoray | d7a33a6 | 2016-10-12 21:21:27 +0900 | [diff] [blame^] | 113 | // Remove the empty slot. Task D should now be in front. |
| 114 | EXPECT_FALSE(sequence->Pop()); |
| 115 | EXPECT_EQ(task_d_, sequence->TakeTask().get()); |
| 116 | |
| 117 | // Push task E in the sequence. Its sequenced time should be updated. |
fdoray | f432952 | 2016-03-17 10:57:42 +0900 | [diff] [blame] | 118 | EXPECT_FALSE(sequence->PushTask(std::move(task_e_owned_))); |
| 119 | EXPECT_FALSE(task_e_->sequenced_time.is_null()); |
fdoray | f432952 | 2016-03-17 10:57:42 +0900 | [diff] [blame] | 120 | |
fdoray | d7a33a6 | 2016-10-12 21:21:27 +0900 | [diff] [blame^] | 121 | // Remove the empty slot. Task E should now be in front. |
| 122 | EXPECT_FALSE(sequence->Pop()); |
| 123 | EXPECT_EQ(task_e_, sequence->TakeTask().get()); |
fdoray | f432952 | 2016-03-17 10:57:42 +0900 | [diff] [blame] | 124 | |
fdoray | d7a33a6 | 2016-10-12 21:21:27 +0900 | [diff] [blame^] | 125 | // Remove the empty slot. The sequence should now be empty. |
| 126 | EXPECT_TRUE(sequence->Pop()); |
fdoray | f432952 | 2016-03-17 10:57:42 +0900 | [diff] [blame] | 127 | } |
| 128 | |
| 129 | TEST_F(TaskSchedulerSequenceTest, GetSortKey) { |
| 130 | scoped_refptr<Sequence> sequence(new Sequence); |
| 131 | |
| 132 | // Push task A in the sequence. The highest priority is from task A |
| 133 | // (BACKGROUND). Task A is in front of the sequence. |
| 134 | sequence->PushTask(std::move(task_a_owned_)); |
gab | 558d9d9 | 2016-04-29 04:44:45 +0900 | [diff] [blame] | 135 | EXPECT_EQ(SequenceSortKey(TaskPriority::BACKGROUND, task_a_->sequenced_time), |
| 136 | sequence->GetSortKey()); |
fdoray | f432952 | 2016-03-17 10:57:42 +0900 | [diff] [blame] | 137 | |
| 138 | // Push task B in the sequence. The highest priority is from task B |
| 139 | // (USER_VISIBLE). Task A is still in front of the sequence. |
| 140 | sequence->PushTask(std::move(task_b_owned_)); |
gab | 558d9d9 | 2016-04-29 04:44:45 +0900 | [diff] [blame] | 141 | EXPECT_EQ( |
| 142 | SequenceSortKey(TaskPriority::USER_VISIBLE, task_a_->sequenced_time), |
| 143 | sequence->GetSortKey()); |
fdoray | f432952 | 2016-03-17 10:57:42 +0900 | [diff] [blame] | 144 | |
| 145 | // Push task C in the sequence. The highest priority is from task C |
| 146 | // (USER_BLOCKING). Task A is still in front of the sequence. |
| 147 | sequence->PushTask(std::move(task_c_owned_)); |
gab | 558d9d9 | 2016-04-29 04:44:45 +0900 | [diff] [blame] | 148 | EXPECT_EQ( |
| 149 | SequenceSortKey(TaskPriority::USER_BLOCKING, task_a_->sequenced_time), |
| 150 | sequence->GetSortKey()); |
fdoray | f432952 | 2016-03-17 10:57:42 +0900 | [diff] [blame] | 151 | |
| 152 | // Push task D in the sequence. The highest priority is from tasks C/D |
| 153 | // (USER_BLOCKING). Task A is still in front of the sequence. |
| 154 | sequence->PushTask(std::move(task_d_owned_)); |
gab | 558d9d9 | 2016-04-29 04:44:45 +0900 | [diff] [blame] | 155 | EXPECT_EQ( |
| 156 | SequenceSortKey(TaskPriority::USER_BLOCKING, task_a_->sequenced_time), |
| 157 | sequence->GetSortKey()); |
fdoray | f432952 | 2016-03-17 10:57:42 +0900 | [diff] [blame] | 158 | |
| 159 | // Pop task A. The highest priority is still USER_BLOCKING. The task in front |
| 160 | // of the sequence is now task B. |
fdoray | d7a33a6 | 2016-10-12 21:21:27 +0900 | [diff] [blame^] | 161 | sequence->TakeTask(); |
| 162 | sequence->Pop(); |
gab | 558d9d9 | 2016-04-29 04:44:45 +0900 | [diff] [blame] | 163 | EXPECT_EQ( |
| 164 | SequenceSortKey(TaskPriority::USER_BLOCKING, task_b_->sequenced_time), |
| 165 | sequence->GetSortKey()); |
fdoray | f432952 | 2016-03-17 10:57:42 +0900 | [diff] [blame] | 166 | |
| 167 | // Pop task B. The highest priority is still USER_BLOCKING. The task in front |
| 168 | // of the sequence is now task C. |
fdoray | d7a33a6 | 2016-10-12 21:21:27 +0900 | [diff] [blame^] | 169 | sequence->TakeTask(); |
| 170 | sequence->Pop(); |
gab | 558d9d9 | 2016-04-29 04:44:45 +0900 | [diff] [blame] | 171 | EXPECT_EQ( |
| 172 | SequenceSortKey(TaskPriority::USER_BLOCKING, task_c_->sequenced_time), |
| 173 | sequence->GetSortKey()); |
fdoray | f432952 | 2016-03-17 10:57:42 +0900 | [diff] [blame] | 174 | |
| 175 | // Pop task C. The highest priority is still USER_BLOCKING. The task in front |
| 176 | // of the sequence is now task D. |
fdoray | d7a33a6 | 2016-10-12 21:21:27 +0900 | [diff] [blame^] | 177 | sequence->TakeTask(); |
| 178 | sequence->Pop(); |
gab | 558d9d9 | 2016-04-29 04:44:45 +0900 | [diff] [blame] | 179 | EXPECT_EQ( |
| 180 | SequenceSortKey(TaskPriority::USER_BLOCKING, task_d_->sequenced_time), |
| 181 | sequence->GetSortKey()); |
fdoray | f432952 | 2016-03-17 10:57:42 +0900 | [diff] [blame] | 182 | |
| 183 | // Push task E in the sequence. The highest priority is still USER_BLOCKING. |
| 184 | // The task in front of the sequence is still task D. |
| 185 | sequence->PushTask(std::move(task_e_owned_)); |
gab | 558d9d9 | 2016-04-29 04:44:45 +0900 | [diff] [blame] | 186 | EXPECT_EQ( |
| 187 | SequenceSortKey(TaskPriority::USER_BLOCKING, task_d_->sequenced_time), |
| 188 | sequence->GetSortKey()); |
fdoray | f432952 | 2016-03-17 10:57:42 +0900 | [diff] [blame] | 189 | |
| 190 | // Pop task D. The highest priority is now from task E (BACKGROUND). The |
| 191 | // task in front of the sequence is now task E. |
fdoray | d7a33a6 | 2016-10-12 21:21:27 +0900 | [diff] [blame^] | 192 | sequence->TakeTask(); |
| 193 | sequence->Pop(); |
gab | 558d9d9 | 2016-04-29 04:44:45 +0900 | [diff] [blame] | 194 | EXPECT_EQ(SequenceSortKey(TaskPriority::BACKGROUND, task_e_->sequenced_time), |
| 195 | sequence->GetSortKey()); |
fdoray | f432952 | 2016-03-17 10:57:42 +0900 | [diff] [blame] | 196 | } |
| 197 | |
fdoray | d7a33a6 | 2016-10-12 21:21:27 +0900 | [diff] [blame^] | 198 | // Verify that a DCHECK fires if Pop() is called on a sequence whose front slot |
| 199 | // isn't empty. |
| 200 | TEST_F(TaskSchedulerSequenceTest, PopNonEmptyFrontSlot) { |
fdoray | 66f5a34 | 2016-07-22 06:22:59 +0900 | [diff] [blame] | 201 | scoped_refptr<Sequence> sequence(new Sequence); |
fdoray | d7a33a6 | 2016-10-12 21:21:27 +0900 | [diff] [blame^] | 202 | sequence->PushTask( |
| 203 | MakeUnique<Task>(FROM_HERE, Bind(&DoNothing), TaskTraits(), TimeDelta())); |
fdoray | 66f5a34 | 2016-07-22 06:22:59 +0900 | [diff] [blame] | 204 | |
fdoray | d7a33a6 | 2016-10-12 21:21:27 +0900 | [diff] [blame^] | 205 | EXPECT_DCHECK_DEATH({ sequence->Pop(); }); |
| 206 | } |
fdoray | 66f5a34 | 2016-07-22 06:22:59 +0900 | [diff] [blame] | 207 | |
fdoray | d7a33a6 | 2016-10-12 21:21:27 +0900 | [diff] [blame^] | 208 | // Verify that a DCHECK fires if TakeTask() is called on a sequence whose front |
| 209 | // slot is empty. |
| 210 | TEST_F(TaskSchedulerSequenceTest, TakeEmptyFrontSlot) { |
| 211 | scoped_refptr<Sequence> sequence(new Sequence); |
| 212 | sequence->PushTask( |
| 213 | MakeUnique<Task>(FROM_HERE, Bind(&DoNothing), TaskTraits(), TimeDelta())); |
| 214 | |
| 215 | EXPECT_TRUE(sequence->TakeTask()); |
| 216 | EXPECT_DCHECK_DEATH({ sequence->TakeTask(); }); |
| 217 | } |
| 218 | |
| 219 | // Verify that a DCHECK fires if TakeTask() is called on an empty sequence. |
| 220 | TEST_F(TaskSchedulerSequenceTest, TakeEmptySequence) { |
| 221 | scoped_refptr<Sequence> sequence(new Sequence); |
| 222 | EXPECT_DCHECK_DEATH({ sequence->TakeTask(); }); |
fdoray | 66f5a34 | 2016-07-22 06:22:59 +0900 | [diff] [blame] | 223 | } |
| 224 | |
fdoray | f432952 | 2016-03-17 10:57:42 +0900 | [diff] [blame] | 225 | } // namespace internal |
| 226 | } // namespace base |