Gitiles
Code Review Sign In
gerrit.omnirom.org / android_frameworks_native / 16d7c90ff1bb4f0771b38ec604c405698b001a44 / . / libs / binder / tests / binderRpcWireProtocolTest.cpp
blob: 46e963089a6b7c9d60b49c70b2c5e39943c9c858 [file] [log] [blame]
Steven Moreland59640db2021-07-22 17:19:31 -0700[diff] [blame]1/*
2 * Copyright (C) 2021 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
17#include <android-base/hex.h>
18#include <android-base/logging.h>
19#include <android-base/macros.h>
20#include <android-base/properties.h>
21#include <android-base/strings.h>
22#include <binder/Parcel.h>
23#include <binder/RpcSession.h>
24#include <gtest/gtest.h>
25
26#include "../Debug.h"
27
28namespace android {
29
30static const int32_t kInt32Array[] = {-1, 0, 17};
31static const uint8_t kByteArray[] = {0, 17, 255};
32enum EnumInt8 : int8_t { Int8A, Int8B };
33enum EnumInt32 : int32_t { Int32A, Int32B };
34enum EnumInt64 : int64_t { Int64A, Int64B };
35struct AParcelable : Parcelable {
36 status_t writeToParcel(Parcel* parcel) const { return parcel->writeInt32(37); }
37 status_t readFromParcel(const Parcel*) { return OK; }
38};
39
40// clang-format off
41constexpr size_t kFillFunIndexLineBase = __LINE__ + 2;
42static const std::vector<std::function<void(Parcel* p)>> kFillFuns {
43 [](Parcel* p) { ASSERT_EQ(OK, p->writeInterfaceToken(String16(u"tok"))); },
44 [](Parcel* p) { ASSERT_EQ(OK, p->writeInt32(-1)); },
45 [](Parcel* p) { ASSERT_EQ(OK, p->writeInt32(0)); },
46 [](Parcel* p) { ASSERT_EQ(OK, p->writeInt32(17)); },
47 [](Parcel* p) { ASSERT_EQ(OK, p->writeUint32(0)); },
48 [](Parcel* p) { ASSERT_EQ(OK, p->writeUint32(1)); },
49 [](Parcel* p) { ASSERT_EQ(OK, p->writeUint32(10003)); },
50 [](Parcel* p) { ASSERT_EQ(OK, p->writeInt64(-1)); },
51 [](Parcel* p) { ASSERT_EQ(OK, p->writeInt64(0)); },
52 [](Parcel* p) { ASSERT_EQ(OK, p->writeInt64(17)); },
53 [](Parcel* p) { ASSERT_EQ(OK, p->writeUint64(0)); },
54 [](Parcel* p) { ASSERT_EQ(OK, p->writeUint64(1)); },
55 [](Parcel* p) { ASSERT_EQ(OK, p->writeUint64(10003)); },
56 [](Parcel* p) { ASSERT_EQ(OK, p->writeFloat(0.0f)); },
57 [](Parcel* p) { ASSERT_EQ(OK, p->writeFloat(0.1f)); },
58 [](Parcel* p) { ASSERT_EQ(OK, p->writeFloat(9.1f)); },
59 [](Parcel* p) { ASSERT_EQ(OK, p->writeDouble(0.0)); },
60 [](Parcel* p) { ASSERT_EQ(OK, p->writeDouble(0.1)); },
61 [](Parcel* p) { ASSERT_EQ(OK, p->writeDouble(9.1)); },
62 [](Parcel* p) { ASSERT_EQ(OK, p->writeCString("")); },
63 [](Parcel* p) { ASSERT_EQ(OK, p->writeCString("a")); },
64 [](Parcel* p) { ASSERT_EQ(OK, p->writeCString("baba")); },
65 [](Parcel* p) { ASSERT_EQ(OK, p->writeString8(String8(""))); },
66 [](Parcel* p) { ASSERT_EQ(OK, p->writeString8(String8("a"))); },
67 [](Parcel* p) { ASSERT_EQ(OK, p->writeString8(String8("baba"))); },
68 [](Parcel* p) { ASSERT_EQ(OK, p->writeString16(String16(u""))); },
69 [](Parcel* p) { ASSERT_EQ(OK, p->writeString16(String16(u"a"))); },
70 [](Parcel* p) { ASSERT_EQ(OK, p->writeString16(String16(u"baba"))); },
71 [](Parcel* p) { ASSERT_EQ(OK, p->writeStrongBinder(nullptr)); },
72 [](Parcel* p) { ASSERT_EQ(OK, p->writeInt32Array(arraysize(kInt32Array), kInt32Array)); },
73 [](Parcel* p) { ASSERT_EQ(OK, p->writeByteArray(arraysize(kByteArray), kByteArray)); },
74 [](Parcel* p) { ASSERT_EQ(OK, p->writeBool(true)); },
75 [](Parcel* p) { ASSERT_EQ(OK, p->writeBool(false)); },
76 [](Parcel* p) { ASSERT_EQ(OK, p->writeChar('a')); },
77 [](Parcel* p) { ASSERT_EQ(OK, p->writeChar('?')); },
78 [](Parcel* p) { ASSERT_EQ(OK, p->writeChar('\0')); },
79 [](Parcel* p) { ASSERT_EQ(OK, p->writeByte(-128)); },
80 [](Parcel* p) { ASSERT_EQ(OK, p->writeByte(0)); },
81 [](Parcel* p) { ASSERT_EQ(OK, p->writeByte(127)); },
82 [](Parcel* p) { ASSERT_EQ(OK, p->writeUtf8AsUtf16(std::string(""))); },
83 [](Parcel* p) { ASSERT_EQ(OK, p->writeUtf8AsUtf16(std::string("a"))); },
84 [](Parcel* p) { ASSERT_EQ(OK, p->writeUtf8AsUtf16(std::string("abab"))); },
85 [](Parcel* p) { ASSERT_EQ(OK, p->writeUtf8AsUtf16(std::nullopt)); },
86 [](Parcel* p) { ASSERT_EQ(OK, p->writeUtf8AsUtf16(std::optional<std::string>(""))); },
87 [](Parcel* p) { ASSERT_EQ(OK, p->writeUtf8AsUtf16(std::optional<std::string>("a"))); },
88 [](Parcel* p) { ASSERT_EQ(OK, p->writeUtf8AsUtf16(std::optional<std::string>("abab"))); },
89 [](Parcel* p) { ASSERT_EQ(OK, p->writeByteVector(std::optional<std::vector<int8_t>>(std::nullopt))); },
90 [](Parcel* p) { ASSERT_EQ(OK, p->writeByteVector(std::optional<std::vector<int8_t>>({-1, 0, 17}))); },
91 [](Parcel* p) { ASSERT_EQ(OK, p->writeByteVector(std::vector<int8_t>({}))); },
92 [](Parcel* p) { ASSERT_EQ(OK, p->writeByteVector(std::vector<int8_t>({-1, 0, 17}))); },
93 [](Parcel* p) { ASSERT_EQ(OK, p->writeByteVector(std::optional<std::vector<uint8_t>>(std::nullopt))); },
94 [](Parcel* p) { ASSERT_EQ(OK, p->writeByteVector(std::optional<std::vector<uint8_t>>({0, 1, 17}))); },
95 [](Parcel* p) { ASSERT_EQ(OK, p->writeByteVector(std::vector<uint8_t>({}))); },
96 [](Parcel* p) { ASSERT_EQ(OK, p->writeByteVector(std::vector<uint8_t>({0, 1, 17}))); },
97 [](Parcel* p) { ASSERT_EQ(OK, p->writeInt32Vector(std::optional<std::vector<int32_t>>(std::nullopt))); },
98 [](Parcel* p) { ASSERT_EQ(OK, p->writeInt32Vector(std::optional<std::vector<int32_t>>({-1, 0, 17}))); },
99 [](Parcel* p) { ASSERT_EQ(OK, p->writeInt32Vector(std::vector<int32_t>({}))); },
100 [](Parcel* p) { ASSERT_EQ(OK, p->writeInt32Vector(std::vector<int32_t>({-1, 0, 17}))); },
101 [](Parcel* p) { ASSERT_EQ(OK, p->writeInt64Vector(std::optional<std::vector<int64_t>>(std::nullopt))); },
102 [](Parcel* p) { ASSERT_EQ(OK, p->writeInt64Vector(std::optional<std::vector<int64_t>>({-1, 0, 17}))); },
103 [](Parcel* p) { ASSERT_EQ(OK, p->writeInt64Vector(std::vector<int64_t>({}))); },
104 [](Parcel* p) { ASSERT_EQ(OK, p->writeInt64Vector(std::vector<int64_t>({-1, 0, 17}))); },
105 [](Parcel* p) { ASSERT_EQ(OK, p->writeUint64Vector(std::optional<std::vector<uint64_t>>(std::nullopt))); },
106 [](Parcel* p) { ASSERT_EQ(OK, p->writeUint64Vector(std::optional<std::vector<uint64_t>>({0, 1, 17}))); },
107 [](Parcel* p) { ASSERT_EQ(OK, p->writeUint64Vector(std::vector<uint64_t>({}))); },
108 [](Parcel* p) { ASSERT_EQ(OK, p->writeUint64Vector(std::vector<uint64_t>({0, 1, 17}))); },
109 [](Parcel* p) { ASSERT_EQ(OK, p->writeFloatVector(std::optional<std::vector<float>>(std::nullopt))); },
110 [](Parcel* p) { ASSERT_EQ(OK, p->writeFloatVector(std::optional<std::vector<float>>({0.0f, 0.1f, 9.1f}))); },
111 [](Parcel* p) { ASSERT_EQ(OK, p->writeFloatVector(std::vector<float>({}))); },
112 [](Parcel* p) { ASSERT_EQ(OK, p->writeFloatVector(std::vector<float>({0.0f, 0.1f, 9.1f}))); },
113 [](Parcel* p) { ASSERT_EQ(OK, p->writeDoubleVector(std::optional<std::vector<double>>(std::nullopt))); },
114 [](Parcel* p) { ASSERT_EQ(OK, p->writeDoubleVector(std::optional<std::vector<double>>({0.0, 0.1, 9.1}))); },
115 [](Parcel* p) { ASSERT_EQ(OK, p->writeDoubleVector(std::vector<double>({}))); },
116 [](Parcel* p) { ASSERT_EQ(OK, p->writeDoubleVector(std::vector<double>({0.0, 0.1, 9.1}))); },
117 [](Parcel* p) { ASSERT_EQ(OK, p->writeBoolVector(std::optional<std::vector<bool>>(std::nullopt))); },
118 [](Parcel* p) { ASSERT_EQ(OK, p->writeBoolVector(std::optional<std::vector<bool>>({true, false}))); },
119 [](Parcel* p) { ASSERT_EQ(OK, p->writeBoolVector(std::vector<bool>({}))); },
120 [](Parcel* p) { ASSERT_EQ(OK, p->writeBoolVector(std::vector<bool>({true, false}))); },
121 [](Parcel* p) { ASSERT_EQ(OK, p->writeCharVector(std::optional<std::vector<char16_t>>(std::nullopt))); },
122 [](Parcel* p) { ASSERT_EQ(OK, p->writeCharVector(std::optional<std::vector<char16_t>>({'a', '\0', '?'}))); },
123 [](Parcel* p) { ASSERT_EQ(OK, p->writeCharVector(std::vector<char16_t>({}))); },
124 [](Parcel* p) { ASSERT_EQ(OK, p->writeCharVector(std::vector<char16_t>({'a', '\0', '?'}))); },
125 [](Parcel* p) { ASSERT_EQ(OK, p->writeString16Vector(std::optional<std::vector<std::optional<String16>>>(std::nullopt))); },
126 [](Parcel* p) { ASSERT_EQ(OK, p->writeString16Vector(std::optional<std::vector<std::optional<String16>>>({std::nullopt, String16(), String16(u"a")}))); },
127 [](Parcel* p) { ASSERT_EQ(OK, p->writeString16Vector(std::vector<std::optional<String16>>({}))); },
128 [](Parcel* p) { ASSERT_EQ(OK, p->writeString16Vector(std::vector<std::optional<String16>>({std::nullopt, String16(), String16(u"a")}))); },
129 [](Parcel* p) { ASSERT_EQ(OK, p->writeUtf8VectorAsUtf16Vector(std::optional<std::vector<std::optional<std::string>>>(std::nullopt))); },
130 [](Parcel* p) { ASSERT_EQ(OK, p->writeUtf8VectorAsUtf16Vector(std::optional<std::vector<std::optional<std::string>>>({std::nullopt, std::string(), std::string("a")}))); },
131 [](Parcel* p) { ASSERT_EQ(OK, p->writeUtf8VectorAsUtf16Vector(std::vector<std::optional<std::string>>({}))); },
132 [](Parcel* p) { ASSERT_EQ(OK, p->writeUtf8VectorAsUtf16Vector(std::vector<std::optional<std::string>>({std::nullopt, std::string(), std::string("a")}))); },
133 [](Parcel* p) { ASSERT_EQ(OK, p->writeStrongBinderVector(std::optional<std::vector<sp<IBinder>>>(std::nullopt))); },
134 [](Parcel* p) { ASSERT_EQ(OK, p->writeStrongBinderVector(std::optional<std::vector<sp<IBinder>>>({nullptr}))); },
135 [](Parcel* p) { ASSERT_EQ(OK, p->writeStrongBinderVector(std::vector<sp<IBinder>>({}))); },
136 [](Parcel* p) { ASSERT_EQ(OK, p->writeStrongBinderVector(std::vector<sp<IBinder>>({nullptr}))); },
137 [](Parcel* p) { ASSERT_EQ(OK, p->writeEnumVector(std::optional<std::vector<EnumInt8>>(std::nullopt))); },
138 [](Parcel* p) { ASSERT_EQ(OK, p->writeEnumVector(std::optional<std::vector<EnumInt8>>({Int8A, Int8B}))); },
139 [](Parcel* p) { ASSERT_EQ(OK, p->writeEnumVector(std::vector<EnumInt8>({Int8A, Int8B}))); },
140 [](Parcel* p) { ASSERT_EQ(OK, p->writeEnumVector(std::optional<std::vector<EnumInt32>>(std::nullopt))); },
141 [](Parcel* p) { ASSERT_EQ(OK, p->writeEnumVector(std::optional<std::vector<EnumInt32>>({Int32A, Int32B}))); },
142 [](Parcel* p) { ASSERT_EQ(OK, p->writeEnumVector(std::vector<EnumInt32>({Int32A, Int32B}))); },
143 [](Parcel* p) { ASSERT_EQ(OK, p->writeEnumVector(std::optional<std::vector<EnumInt64>>(std::nullopt))); },
144 [](Parcel* p) { ASSERT_EQ(OK, p->writeEnumVector(std::optional<std::vector<EnumInt64>>({Int64A, Int64B}))); },
145 [](Parcel* p) { ASSERT_EQ(OK, p->writeEnumVector(std::vector<EnumInt64>({Int64A, Int64B}))); },
146 [](Parcel* p) { ASSERT_EQ(OK, p->writeParcelableVector(std::optional<std::vector<std::optional<AParcelable>>>(std::nullopt))); },
147 [](Parcel* p) { ASSERT_EQ(OK, p->writeParcelableVector(std::optional<std::vector<std::optional<AParcelable>>>({AParcelable()}))); },
148 [](Parcel* p) { ASSERT_EQ(OK, p->writeParcelableVector(std::vector<AParcelable>({AParcelable()}))); },
149 [](Parcel* p) { ASSERT_EQ(OK, p->writeNullableParcelable(std::optional<AParcelable>(std::nullopt))); },
150 [](Parcel* p) { ASSERT_EQ(OK, p->writeNullableParcelable(std::optional<AParcelable>(AParcelable()))); },
151 [](Parcel* p) { ASSERT_EQ(OK, p->writeParcelable(AParcelable())); },
152 [](Parcel* p) { ASSERT_EQ(OK, p->writeVectorSize(std::vector<int32_t>({0, 1, 17}))); },
153 [](Parcel* p) { ASSERT_EQ(OK, p->writeVectorSize(std::vector<AParcelable>({}))); },
154 [](Parcel* p) { ASSERT_EQ(OK, p->writeVectorSize(std::optional<std::vector<int32_t>>(std::nullopt))); },
155 [](Parcel* p) { ASSERT_EQ(OK, p->writeVectorSize(std::optional<std::vector<int32_t>>({0, 1, 17}))); },
156 [](Parcel* p) { ASSERT_EQ(OK, p->writeNoException()); },
157};
158// clang-format on
159
160static void setParcelForRpc(Parcel* p, uint32_t version) {
161 auto session = RpcSession::make();
162 CHECK(session->setProtocolVersion(version));
163 CHECK_EQ(OK, session->addNullDebuggingClient());
164 p->markForRpc(session);
165}
166
167static std::string buildRepr(uint32_t version) {
168 std::string result;
169 for (size_t i = 0; i < kFillFuns.size(); i++) {
170 if (i != 0) result += "|";
171 Parcel p;
172 setParcelForRpc(&p, version);
173 kFillFuns[i](&p);
174
175 result += base::HexString(p.data(), p.dataSize());
176 }
177 return result;
178}
179
180static void checkRepr(const std::string& repr, uint32_t version) {
181 const std::string actualRepr = buildRepr(version);
182
183 auto expected = base::Split(repr, "|");
184 ASSERT_EQ(expected.size(), kFillFuns.size());
185
186 auto actual = base::Split(actualRepr, "|");
187 ASSERT_EQ(actual.size(), kFillFuns.size());
188
189 for (size_t i = 0; i < kFillFuns.size(); i++) {
190 EXPECT_EQ(expected[i], actual[i])
191 << "Format mismatch, see " __FILE__ " line " << (kFillFunIndexLineBase + i);
192 }
193
194 // same check as in the loop, but the above error is more clear to debug,
195 // and this error is more clear to be able to update the source file here.
196 EXPECT_EQ(repr, actualRepr);
197}
198
199const std::string kCurrentRepr =
200 "0300000074006f006b000000|ffffffff|00000000|11000000|00000000|01000000|13270000|"
201 "ffffffffffffffff|0000000000000000|1100000000000000|0000000000000000|0100000000000000|"
202 "1327000000000000|00000000|cdcccc3d|9a991141|0000000000000000|9a9999999999b93f|"
203 "3333333333332240|00000000|61000000|6261626100000000|0000000000000000|0100000061000000|"
204 "040000006261626100000000|0000000000000000|0100000061000000|"
205 "04000000620061006200610000000000|0000000000000000|03000000ffffffff0000000011000000|"
206 "030000000011ff00|01000000|00000000|61000000|3f000000|00000000|80ffffff|00000000|7f000000|"
207 "0000000000000000|0100000061000000|04000000610062006100620000000000|ffffffff|"
208 "0000000000000000|0100000061000000|04000000610062006100620000000000|ffffffff|"
209 "03000000ff001100|00000000|03000000ff001100|ffffffff|0300000000011100|00000000|"
210 "0300000000011100|ffffffff|03000000ffffffff0000000011000000|00000000|"
211 "03000000ffffffff0000000011000000|ffffffff|"
212 "03000000ffffffffffffffff00000000000000001100000000000000|00000000|"
213 "03000000ffffffffffffffff00000000000000001100000000000000|ffffffff|"
214 "03000000000000000000000001000000000000001100000000000000|00000000|"
215 "03000000000000000000000001000000000000001100000000000000|ffffffff|"
216 "0300000000000000cdcccc3d9a991141|00000000|0300000000000000cdcccc3d9a991141|ffffffff|"
217 "0300000000000000000000009a9999999999b93f3333333333332240|00000000|"
218 "0300000000000000000000009a9999999999b93f3333333333332240|ffffffff|"
219 "020000000100000000000000|00000000|020000000100000000000000|ffffffff|"
220 "0300000061000000000000003f000000|00000000|0300000061000000000000003f000000|ffffffff|"
221 "03000000ffffffff00000000000000000100000061000000|00000000|"
222 "03000000ffffffff00000000000000000100000061000000|ffffffff|"
223 "03000000ffffffff00000000000000000100000061000000|00000000|"
224 "03000000ffffffff00000000000000000100000061000000|ffffffff|010000000000000000000000|"
225 "00000000|010000000000000000000000|ffffffff|0200000000010000|0200000000010000|ffffffff|"
226 "020000000000000001000000|020000000000000001000000|ffffffff|"
227 "0200000000000000000000000100000000000000|0200000000000000000000000100000000000000|"
228 "ffffffff|010000000100000025000000|010000000100000025000000|00000000|0100000025000000|"
229 "0100000025000000|03000000|00000000|ffffffff|03000000|00000000";
230
231TEST(RpcWire, CurrentVersion) {
232 checkRepr(kCurrentRepr, RPC_WIRE_PROTOCOL_VERSION);
233}
234
235static_assert(RPC_WIRE_PROTOCOL_VERSION == RPC_WIRE_PROTOCOL_VERSION_EXPERIMENTAL,
236 "you better update this test!");
237
238TEST(RpcWire, ReleaseBranchHasFrozenRpcWireProtocol) {
239 if (RPC_WIRE_PROTOCOL_VERSION == RPC_WIRE_PROTOCOL_VERSION_EXPERIMENTAL) {
240 EXPECT_FALSE(base::GetProperty("ro.build.version.codename", "") == "REL")
241 << "Binder RPC wire protocol must be frozen on a release branch!";
242 }
243}
244
245TEST(RpcWire, IfNotExperimentalCodeHasNoExperimentalFeatures) {
246 if (RPC_WIRE_PROTOCOL_VERSION == RPC_WIRE_PROTOCOL_VERSION_EXPERIMENTAL) {
247 GTEST_SKIP() << "Version is experimental, so experimental features are okay.";
248 }
249
250 // if we set the wire protocol version to experimental, none of the code
251 // should introduce a difference (if this fails, it means we have features
252 // which are enabled under experimental mode, but we aren't actually using
253 // or testing them!)
254 checkRepr(kCurrentRepr, RPC_WIRE_PROTOCOL_VERSION_EXPERIMENTAL);
255}
256
257} // namespace android