1 /*
2 * Copyright (C) 2023, The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 #include "socket/LogEventFilter.h"
17
18 #include <gtest/gtest.h>
19
20 #include <algorithm>
21
22 #ifdef __ANDROID__
23
24 namespace android {
25 namespace os {
26 namespace statsd {
27
28 namespace {
29
30 constexpr int kAtomIdsCount = 100; // Filter size setup
31
generateAtomIds(int rangeStart,int rangeEndInclusive)32 LogEventFilter::AtomIdSet generateAtomIds(int rangeStart, int rangeEndInclusive) {
33 LogEventFilter::AtomIdSet atomIds;
34 for (int i = rangeStart; i <= rangeEndInclusive; ++i) {
35 atomIds.insert(i);
36 }
37 return atomIds;
38 }
39
testGuaranteedUnusedAtomsNotInUse(const LogEventFilter & filter)40 bool testGuaranteedUnusedAtomsNotInUse(const LogEventFilter& filter) {
41 const auto sampleIds = generateAtomIds(10000, 11000);
42 bool atLeastOneInUse = false;
43 for (const auto& atomId : sampleIds) {
44 atLeastOneInUse |= filter.isAtomInUse(atomId);
45 }
46 return !atLeastOneInUse;
47 }
48
49 } // namespace
50
TEST(LogEventFilterTest,TestEmptyFilter)51 TEST(LogEventFilterTest, TestEmptyFilter) {
52 LogEventFilter filter;
53 const auto sampleIds = generateAtomIds(1, kAtomIdsCount);
54 for (const auto& atomId : sampleIds) {
55 EXPECT_FALSE(filter.isAtomInUse(atomId));
56 }
57 }
58
TEST(LogEventFilterTest,TestRemoveNonExistingEmptyFilter)59 TEST(LogEventFilterTest, TestRemoveNonExistingEmptyFilter) {
60 LogEventFilter filter;
61 EXPECT_FALSE(filter.isAtomInUse(1));
62 LogEventFilter::AtomIdSet emptyAtomIdsSet;
63 EXPECT_EQ(0, filter.mTagIdsPerConsumer.size());
64 EXPECT_EQ(0, filter.mLocalTagIds.size());
65 filter.setAtomIds(std::move(emptyAtomIdsSet), reinterpret_cast<LogEventFilter::ConsumerId>(0));
66 EXPECT_FALSE(filter.isAtomInUse(1));
67 EXPECT_EQ(0, filter.mLocalTagIds.size());
68 EXPECT_EQ(0, filter.mTagIdsPerConsumer.size());
69 }
70
TEST(LogEventFilterTest,TestEmptyFilterDisabled)71 TEST(LogEventFilterTest, TestEmptyFilterDisabled) {
72 LogEventFilter filter;
73 filter.setFilteringEnabled(false);
74 const auto sampleIds = generateAtomIds(1, kAtomIdsCount);
75 for (const auto& atomId : sampleIds) {
76 EXPECT_TRUE(filter.isAtomInUse(atomId));
77 }
78 }
79
TEST(LogEventFilterTest,TestNonEmptyFilterFullOverlap)80 TEST(LogEventFilterTest, TestNonEmptyFilterFullOverlap) {
81 LogEventFilter filter;
82 auto filterIds = generateAtomIds(1, kAtomIdsCount);
83 filter.setAtomIds(std::move(filterIds), reinterpret_cast<LogEventFilter::ConsumerId>(0));
84 EXPECT_EQ(1, filter.mTagIdsPerConsumer.size());
85
86 // inner copy updated only during fetch if required
87 EXPECT_EQ(0, filter.mLocalTagIds.size());
88 const auto sampleIds = generateAtomIds(1, kAtomIdsCount);
89 for (const auto& atomId : sampleIds) {
90 EXPECT_TRUE(filter.isAtomInUse(atomId));
91 }
92 EXPECT_EQ(kAtomIdsCount, filter.mLocalTagIds.size());
93 }
94
TEST(LogEventFilterTest,TestNonEmptyFilterPartialOverlap)95 TEST(LogEventFilterTest, TestNonEmptyFilterPartialOverlap) {
96 LogEventFilter filter;
97 auto filterIds = generateAtomIds(1, kAtomIdsCount);
98 filter.setAtomIds(std::move(filterIds), reinterpret_cast<LogEventFilter::ConsumerId>(0));
99 // extra 100 atom ids should be filtered out
100 const auto sampleIds = generateAtomIds(1, kAtomIdsCount + 100);
101 for (const auto& atomId : sampleIds) {
102 bool const atomInUse = atomId <= kAtomIdsCount;
103 EXPECT_EQ(atomInUse, filter.isAtomInUse(atomId));
104 }
105 }
106
TEST(LogEventFilterTest,TestNonEmptyFilterDisabledPartialOverlap)107 TEST(LogEventFilterTest, TestNonEmptyFilterDisabledPartialOverlap) {
108 LogEventFilter filter;
109 auto filterIds = generateAtomIds(1, kAtomIdsCount);
110 filter.setAtomIds(std::move(filterIds), reinterpret_cast<LogEventFilter::ConsumerId>(0));
111 filter.setFilteringEnabled(false);
112 // extra 100 atom ids should be in use due to filter is disabled
113 const auto sampleIds = generateAtomIds(1, kAtomIdsCount + 100);
114 for (const auto& atomId : sampleIds) {
115 EXPECT_TRUE(filter.isAtomInUse(atomId));
116 }
117 }
118
TEST(LogEventFilterTest,TestMultipleConsumerOverlapIdsRemoved)119 TEST(LogEventFilterTest, TestMultipleConsumerOverlapIdsRemoved) {
120 LogEventFilter filter;
121 auto filterIds1 = generateAtomIds(1, kAtomIdsCount);
122 // half of filterIds1 atom ids overlaps with filterIds2
123 auto filterIds2 = generateAtomIds(kAtomIdsCount / 2, kAtomIdsCount * 2);
124 filter.setAtomIds(std::move(filterIds1), reinterpret_cast<LogEventFilter::ConsumerId>(0));
125 filter.setAtomIds(std::move(filterIds2), reinterpret_cast<LogEventFilter::ConsumerId>(1));
126 // inner copy updated only during fetch if required
127 EXPECT_EQ(0, filter.mLocalTagIds.size());
128 const auto sampleIds = generateAtomIds(1, kAtomIdsCount * 2);
129 for (const auto& atomId : sampleIds) {
130 EXPECT_TRUE(filter.isAtomInUse(atomId));
131 }
132 EXPECT_EQ(kAtomIdsCount * 2, filter.mLocalTagIds.size());
133 EXPECT_TRUE(testGuaranteedUnusedAtomsNotInUse(filter));
134
135 // set empty filter for second consumer
136 LogEventFilter::AtomIdSet emptyAtomIdsSet;
137 filter.setAtomIds(std::move(emptyAtomIdsSet), reinterpret_cast<LogEventFilter::ConsumerId>(1));
138 EXPECT_EQ(kAtomIdsCount * 2, filter.mLocalTagIds.size());
139 for (const auto& atomId : sampleIds) {
140 bool const atomInUse = atomId <= kAtomIdsCount;
141 EXPECT_EQ(atomInUse, filter.isAtomInUse(atomId));
142 }
143 EXPECT_EQ(kAtomIdsCount, filter.mLocalTagIds.size());
144 EXPECT_TRUE(testGuaranteedUnusedAtomsNotInUse(filter));
145 }
146
TEST(LogEventFilterTest,TestMultipleConsumerEmptyFilter)147 TEST(LogEventFilterTest, TestMultipleConsumerEmptyFilter) {
148 LogEventFilter filter;
149 auto filterIds1 = generateAtomIds(1, kAtomIdsCount);
150 auto filterIds2 = generateAtomIds(kAtomIdsCount + 1, kAtomIdsCount * 2);
151 filter.setAtomIds(std::move(filterIds1), reinterpret_cast<LogEventFilter::ConsumerId>(0));
152 filter.setAtomIds(std::move(filterIds2), reinterpret_cast<LogEventFilter::ConsumerId>(1));
153 EXPECT_EQ(2, filter.mTagIdsPerConsumer.size());
154 // inner copy updated only during fetch if required
155 EXPECT_EQ(0, filter.mLocalTagIds.size());
156 const auto sampleIds = generateAtomIds(1, kAtomIdsCount * 2);
157 for (const auto& atomId : sampleIds) {
158 EXPECT_TRUE(filter.isAtomInUse(atomId));
159 }
160 EXPECT_EQ(kAtomIdsCount * 2, filter.mLocalTagIds.size());
161 EXPECT_TRUE(testGuaranteedUnusedAtomsNotInUse(filter));
162
163 // set empty filter for first consumer
164 LogEventFilter::AtomIdSet emptyAtomIdsSet;
165 filter.setAtomIds(emptyAtomIdsSet, reinterpret_cast<LogEventFilter::ConsumerId>(0));
166 EXPECT_EQ(1, filter.mTagIdsPerConsumer.size());
167 EXPECT_EQ(kAtomIdsCount * 2, filter.mLocalTagIds.size());
168 for (const auto& atomId : sampleIds) {
169 bool const atomInUse = atomId > kAtomIdsCount;
170 EXPECT_EQ(atomInUse, filter.isAtomInUse(atomId));
171 }
172 EXPECT_EQ(kAtomIdsCount, filter.mLocalTagIds.size());
173 EXPECT_TRUE(testGuaranteedUnusedAtomsNotInUse(filter));
174
175 // set empty filter for second consumer
176 filter.setAtomIds(emptyAtomIdsSet, reinterpret_cast<LogEventFilter::ConsumerId>(1));
177 EXPECT_EQ(0, filter.mTagIdsPerConsumer.size());
178 EXPECT_EQ(kAtomIdsCount, filter.mLocalTagIds.size());
179 for (const auto& atomId : sampleIds) {
180 EXPECT_FALSE(filter.isAtomInUse(atomId));
181 }
182 EXPECT_EQ(0, filter.mLocalTagIds.size());
183 EXPECT_TRUE(testGuaranteedUnusedAtomsNotInUse(filter));
184 }
185
186 } // namespace statsd
187 } // namespace os
188 } // namespace android
189 #else
190 GTEST_LOG_(INFO) << "This test does nothing.\n";
191 #endif
192