blob: 97a3376c814a3d95d2507edb659fdfa6e8e20fd5 [file] [log] [blame]
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -08001/*
2 * Copyright (C) 2005 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#ifndef ANDROID_PARCEL_H
18#define ANDROID_PARCEL_H
19
Christopher Wiley9a5e32f2016-01-28 16:56:53 -080020#include <string>
Casey Dahlin451ff582015-10-19 18:12:18 -070021#include <vector>
22
Christopher Wiley83e6b982016-04-19 10:27:00 -070023#include <android-base/unique_fd.h>
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080024#include <cutils/native_handle.h>
25#include <utils/Errors.h>
26#include <utils/RefBase.h>
27#include <utils/String16.h>
28#include <utils/Vector.h>
Mathias Agopian8683fca2012-08-12 19:37:16 -070029#include <utils/Flattenable.h>
Arve Hjønnevåg84e625a2014-01-28 20:12:59 -080030#include <linux/binder.h>
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080031
Casey Dahlinf0c13772015-10-27 18:33:56 -070032#include <binder/IInterface.h>
Christopher Wiley97f048d2015-11-19 06:49:05 -080033#include <binder/Parcelable.h>
Casey Dahlinf0c13772015-10-27 18:33:56 -070034
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080035// ---------------------------------------------------------------------------
36namespace android {
37
Mathias Agopiane1424282013-07-29 21:24:40 -070038template <typename T> class Flattenable;
Mathias Agopian8683fca2012-08-12 19:37:16 -070039template <typename T> class LightFlattenable;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080040class IBinder;
Brad Fitzpatrick70081a12010-07-27 09:49:11 -070041class IPCThreadState;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080042class ProcessState;
43class String8;
44class TextOutput;
45
Mathias Agopiane1424282013-07-29 21:24:40 -070046class Parcel {
Serban Constantinescuf683e012013-11-05 16:53:55 +000047 friend class IPCThreadState;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080048public:
Jeff Brown5707dbf2011-09-23 21:17:56 -070049 class ReadableBlob;
50 class WritableBlob;
51
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080052 Parcel();
53 ~Parcel();
54
55 const uint8_t* data() const;
56 size_t dataSize() const;
57 size_t dataAvail() const;
58 size_t dataPosition() const;
59 size_t dataCapacity() const;
Dianne Hackborn8938ed22011-09-28 23:19:47 -040060
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080061 status_t setDataSize(size_t size);
62 void setDataPosition(size_t pos) const;
63 status_t setDataCapacity(size_t size);
64
65 status_t setData(const uint8_t* buffer, size_t len);
66
Andreas Huber51faf462011-04-13 10:21:56 -070067 status_t appendFrom(const Parcel *parcel,
68 size_t start, size_t len);
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080069
Jeff Brown13b16042014-11-11 16:44:25 -080070 bool allowFds() const;
Dianne Hackborn7746cc32011-10-03 21:09:35 -070071 bool pushAllowFds(bool allowFds);
72 void restoreAllowFds(bool lastValue);
Dianne Hackborn8938ed22011-09-28 23:19:47 -040073
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080074 bool hasFileDescriptors() const;
75
Brad Fitzpatrick702ea9d2010-06-18 13:07:53 -070076 // Writes the RPC header.
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080077 status_t writeInterfaceToken(const String16& interface);
Brad Fitzpatricka877cd82010-07-07 16:06:39 -070078
Brad Fitzpatrick702ea9d2010-06-18 13:07:53 -070079 // Parses the RPC header, returning true if the interface name
80 // in the header matches the expected interface from the caller.
Brad Fitzpatrick70081a12010-07-27 09:49:11 -070081 //
82 // Additionally, enforceInterface does part of the work of
83 // propagating the StrictMode policy mask, populating the current
84 // IPCThreadState, which as an optimization may optionally be
85 // passed in.
Brad Fitzpatricka877cd82010-07-07 16:06:39 -070086 bool enforceInterface(const String16& interface,
Brad Fitzpatrick70081a12010-07-27 09:49:11 -070087 IPCThreadState* threadState = NULL) const;
Brad Fitzpatrick702ea9d2010-06-18 13:07:53 -070088 bool checkInterface(IBinder*) const;
Mathias Agopian83c04462009-05-22 19:00:22 -070089
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080090 void freeData();
91
Arve Hjønnevåg84e625a2014-01-28 20:12:59 -080092private:
93 const binder_size_t* objects() const;
94
95public:
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080096 size_t objectsCount() const;
97
98 status_t errorCheck() const;
99 void setError(status_t err);
100
101 status_t write(const void* data, size_t len);
102 void* writeInplace(size_t len);
103 status_t writeUnpadded(const void* data, size_t len);
104 status_t writeInt32(int32_t val);
Dan Stoza41a0f2f2014-12-01 10:01:10 -0800105 status_t writeUint32(uint32_t val);
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800106 status_t writeInt64(int64_t val);
Ronghua Wu2d13afd2015-03-16 11:11:07 -0700107 status_t writeUint64(uint64_t val);
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800108 status_t writeFloat(float val);
109 status_t writeDouble(double val);
110 status_t writeCString(const char* str);
111 status_t writeString8(const String8& str);
112 status_t writeString16(const String16& str);
Casey Dahlinb9872622015-11-25 15:09:45 -0800113 status_t writeString16(const std::unique_ptr<String16>& str);
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800114 status_t writeString16(const char16_t* str, size_t len);
115 status_t writeStrongBinder(const sp<IBinder>& val);
116 status_t writeWeakBinder(const wp<IBinder>& val);
Marco Nelissen5c0106e2013-10-16 10:57:51 -0700117 status_t writeInt32Array(size_t len, const int32_t *val);
Marco Nelissenf0190bf2014-03-13 14:17:40 -0700118 status_t writeByteArray(size_t len, const uint8_t *val);
Casey Dahlind6848f52015-10-15 15:44:59 -0700119 status_t writeBool(bool val);
120 status_t writeChar(char16_t val);
121 status_t writeByte(int8_t val);
Mathias Agopiane1424282013-07-29 21:24:40 -0700122
Christopher Wiley9a5e32f2016-01-28 16:56:53 -0800123 // Take a UTF8 encoded string, convert to UTF16, write it to the parcel.
124 status_t writeUtf8AsUtf16(const std::string& str);
125 status_t writeUtf8AsUtf16(const std::unique_ptr<std::string>& str);
126
Casey Dahlinb9872622015-11-25 15:09:45 -0800127 status_t writeByteVector(const std::unique_ptr<std::vector<int8_t>>& val);
Casey Dahlin451ff582015-10-19 18:12:18 -0700128 status_t writeByteVector(const std::vector<int8_t>& val);
Casey Dahlin185d3442016-02-09 11:08:35 -0800129 status_t writeByteVector(const std::unique_ptr<std::vector<uint8_t>>& val);
130 status_t writeByteVector(const std::vector<uint8_t>& val);
Casey Dahlinb9872622015-11-25 15:09:45 -0800131 status_t writeInt32Vector(const std::unique_ptr<std::vector<int32_t>>& val);
Casey Dahlin451ff582015-10-19 18:12:18 -0700132 status_t writeInt32Vector(const std::vector<int32_t>& val);
Casey Dahlinb9872622015-11-25 15:09:45 -0800133 status_t writeInt64Vector(const std::unique_ptr<std::vector<int64_t>>& val);
Casey Dahlin451ff582015-10-19 18:12:18 -0700134 status_t writeInt64Vector(const std::vector<int64_t>& val);
Casey Dahlinb9872622015-11-25 15:09:45 -0800135 status_t writeFloatVector(const std::unique_ptr<std::vector<float>>& val);
Casey Dahlin451ff582015-10-19 18:12:18 -0700136 status_t writeFloatVector(const std::vector<float>& val);
Casey Dahlinb9872622015-11-25 15:09:45 -0800137 status_t writeDoubleVector(const std::unique_ptr<std::vector<double>>& val);
Casey Dahlin451ff582015-10-19 18:12:18 -0700138 status_t writeDoubleVector(const std::vector<double>& val);
Casey Dahlinb9872622015-11-25 15:09:45 -0800139 status_t writeBoolVector(const std::unique_ptr<std::vector<bool>>& val);
Casey Dahlin451ff582015-10-19 18:12:18 -0700140 status_t writeBoolVector(const std::vector<bool>& val);
Casey Dahlinb9872622015-11-25 15:09:45 -0800141 status_t writeCharVector(const std::unique_ptr<std::vector<char16_t>>& val);
Casey Dahlin451ff582015-10-19 18:12:18 -0700142 status_t writeCharVector(const std::vector<char16_t>& val);
Casey Dahlinb9872622015-11-25 15:09:45 -0800143 status_t writeString16Vector(
144 const std::unique_ptr<std::vector<std::unique_ptr<String16>>>& val);
Casey Dahlin451ff582015-10-19 18:12:18 -0700145 status_t writeString16Vector(const std::vector<String16>& val);
Christopher Wiley9a5e32f2016-01-28 16:56:53 -0800146 status_t writeUtf8VectorAsUtf16Vector(
147 const std::unique_ptr<std::vector<std::unique_ptr<std::string>>>& val);
148 status_t writeUtf8VectorAsUtf16Vector(const std::vector<std::string>& val);
Casey Dahlin451ff582015-10-19 18:12:18 -0700149
Casey Dahlinb9872622015-11-25 15:09:45 -0800150 status_t writeStrongBinderVector(const std::unique_ptr<std::vector<sp<IBinder>>>& val);
Casey Dahlineb8e15f2015-11-03 13:50:37 -0800151 status_t writeStrongBinderVector(const std::vector<sp<IBinder>>& val);
152
Mathias Agopiane1424282013-07-29 21:24:40 -0700153 template<typename T>
Casey Dahlinb9872622015-11-25 15:09:45 -0800154 status_t writeParcelableVector(const std::unique_ptr<std::vector<std::unique_ptr<T>>>& val);
155 template<typename T>
Christopher Wiley97f048d2015-11-19 06:49:05 -0800156 status_t writeParcelableVector(const std::vector<T>& val);
Casey Dahlinb9872622015-11-25 15:09:45 -0800157
158 template<typename T>
159 status_t writeNullableParcelable(const std::unique_ptr<T>& parcelable);
160
Christopher Wiley97f048d2015-11-19 06:49:05 -0800161 status_t writeParcelable(const Parcelable& parcelable);
162
163 template<typename T>
Mathias Agopiane1424282013-07-29 21:24:40 -0700164 status_t write(const Flattenable<T>& val);
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800165
Mathias Agopian8683fca2012-08-12 19:37:16 -0700166 template<typename T>
167 status_t write(const LightFlattenable<T>& val);
168
169
Mathias Agopiana47f02a2009-05-21 16:29:38 -0700170 // Place a native_handle into the parcel (the native_handle's file-
171 // descriptors are dup'ed, so it is safe to delete the native_handle
Casey Dahlin451ff582015-10-19 18:12:18 -0700172 // when this function returns).
Mathias Agopiana47f02a2009-05-21 16:29:38 -0700173 // Doesn't take ownership of the native_handle.
174 status_t writeNativeHandle(const native_handle* handle);
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800175
176 // Place a file descriptor into the parcel. The given fd must remain
177 // valid for the lifetime of the parcel.
Jeff Brown93ff1f92011-11-04 19:01:44 -0700178 // The Parcel does not take ownership of the given fd unless you ask it to.
179 status_t writeFileDescriptor(int fd, bool takeOwnership = false);
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800180
181 // Place a file descriptor into the parcel. A dup of the fd is made, which
182 // will be closed once the parcel is destroyed.
183 status_t writeDupFileDescriptor(int fd);
Jeff Brown5707dbf2011-09-23 21:17:56 -0700184
Casey Dahlin06673e32015-11-23 13:24:23 -0800185 // Place a file descriptor into the parcel. This will not affect the
186 // semantics of the smart file descriptor. A new descriptor will be
187 // created, and will be closed when the parcel is destroyed.
188 status_t writeUniqueFileDescriptor(
Christopher Wiley2cf19952016-04-11 11:09:37 -0700189 const base::unique_fd& fd);
Casey Dahlin06673e32015-11-23 13:24:23 -0800190
191 // Place a vector of file desciptors into the parcel. Each descriptor is
192 // dup'd as in writeDupFileDescriptor
193 status_t writeUniqueFileDescriptorVector(
Christopher Wiley2cf19952016-04-11 11:09:37 -0700194 const std::unique_ptr<std::vector<base::unique_fd>>& val);
Casey Dahlinb9872622015-11-25 15:09:45 -0800195 status_t writeUniqueFileDescriptorVector(
Christopher Wiley2cf19952016-04-11 11:09:37 -0700196 const std::vector<base::unique_fd>& val);
Casey Dahlin06673e32015-11-23 13:24:23 -0800197
Jeff Brown5707dbf2011-09-23 21:17:56 -0700198 // Writes a blob to the parcel.
199 // If the blob is small, then it is stored in-place, otherwise it is
Jeff Brown13b16042014-11-11 16:44:25 -0800200 // transferred by way of an anonymous shared memory region. Prefer sending
201 // immutable blobs if possible since they may be subsequently transferred between
202 // processes without further copying whereas mutable blobs always need to be copied.
Jeff Brown5707dbf2011-09-23 21:17:56 -0700203 // The caller should call release() on the blob after writing its contents.
Jeff Brown13b16042014-11-11 16:44:25 -0800204 status_t writeBlob(size_t len, bool mutableCopy, WritableBlob* outBlob);
205
206 // Write an existing immutable blob file descriptor to the parcel.
207 // This allows the client to send the same blob to multiple processes
208 // as long as it keeps a dup of the blob file descriptor handy for later.
209 status_t writeDupImmutableBlobFileDescriptor(int fd);
Jeff Brown5707dbf2011-09-23 21:17:56 -0700210
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800211 status_t writeObject(const flat_binder_object& val, bool nullMetaData);
212
Brad Fitzpatrick837a0d02010-07-13 15:33:35 -0700213 // Like Parcel.java's writeNoException(). Just writes a zero int32.
214 // Currently the native implementation doesn't do any of the StrictMode
215 // stack gathering and serialization that the Java implementation does.
216 status_t writeNoException();
217
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800218 void remove(size_t start, size_t amt);
219
220 status_t read(void* outData, size_t len) const;
221 const void* readInplace(size_t len) const;
222 int32_t readInt32() const;
223 status_t readInt32(int32_t *pArg) const;
Dan Stoza41a0f2f2014-12-01 10:01:10 -0800224 uint32_t readUint32() const;
225 status_t readUint32(uint32_t *pArg) const;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800226 int64_t readInt64() const;
227 status_t readInt64(int64_t *pArg) const;
Ronghua Wu2d13afd2015-03-16 11:11:07 -0700228 uint64_t readUint64() const;
229 status_t readUint64(uint64_t *pArg) const;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800230 float readFloat() const;
231 status_t readFloat(float *pArg) const;
232 double readDouble() const;
233 status_t readDouble(double *pArg) const;
Andreas Huber84a6d042009-08-17 13:33:27 -0700234 intptr_t readIntPtr() const;
235 status_t readIntPtr(intptr_t *pArg) const;
Casey Dahlind6848f52015-10-15 15:44:59 -0700236 bool readBool() const;
237 status_t readBool(bool *pArg) const;
238 char16_t readChar() const;
239 status_t readChar(char16_t *pArg) const;
240 int8_t readByte() const;
241 status_t readByte(int8_t *pArg) const;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800242
Christopher Wiley9a5e32f2016-01-28 16:56:53 -0800243 // Read a UTF16 encoded string, convert to UTF8
244 status_t readUtf8FromUtf16(std::string* str) const;
245 status_t readUtf8FromUtf16(std::unique_ptr<std::string>* str) const;
246
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800247 const char* readCString() const;
248 String8 readString8() const;
249 String16 readString16() const;
Casey Dahlin451ff582015-10-19 18:12:18 -0700250 status_t readString16(String16* pArg) const;
Casey Dahlinb9872622015-11-25 15:09:45 -0800251 status_t readString16(std::unique_ptr<String16>* pArg) const;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800252 const char16_t* readString16Inplace(size_t* outLen) const;
253 sp<IBinder> readStrongBinder() const;
Casey Dahlinf0c13772015-10-27 18:33:56 -0700254 status_t readStrongBinder(sp<IBinder>* val) const;
Christopher Wiley35d77ca2016-03-08 10:49:51 -0800255 status_t readNullableStrongBinder(sp<IBinder>* val) const;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800256 wp<IBinder> readWeakBinder() const;
Mathias Agopiane1424282013-07-29 21:24:40 -0700257
Casey Dahlinf0c13772015-10-27 18:33:56 -0700258 template<typename T>
Casey Dahlinb9872622015-11-25 15:09:45 -0800259 status_t readParcelableVector(
260 std::unique_ptr<std::vector<std::unique_ptr<T>>>* val) const;
261 template<typename T>
Christopher Wiley97f048d2015-11-19 06:49:05 -0800262 status_t readParcelableVector(std::vector<T>* val) const;
Casey Dahlinb9872622015-11-25 15:09:45 -0800263
Christopher Wiley97f048d2015-11-19 06:49:05 -0800264 status_t readParcelable(Parcelable* parcelable) const;
265
266 template<typename T>
Casey Dahlinb9872622015-11-25 15:09:45 -0800267 status_t readParcelable(std::unique_ptr<T>* parcelable) const;
268
269 template<typename T>
Casey Dahlineb8e15f2015-11-03 13:50:37 -0800270 status_t readStrongBinder(sp<T>* val) const;
271
Christopher Wiley35d77ca2016-03-08 10:49:51 -0800272 template<typename T>
273 status_t readNullableStrongBinder(sp<T>* val) const;
274
Casey Dahlinb9872622015-11-25 15:09:45 -0800275 status_t readStrongBinderVector(std::unique_ptr<std::vector<sp<IBinder>>>* val) const;
Casey Dahlineb8e15f2015-11-03 13:50:37 -0800276 status_t readStrongBinderVector(std::vector<sp<IBinder>>* val) const;
Casey Dahlinf0c13772015-10-27 18:33:56 -0700277
Casey Dahlinb9872622015-11-25 15:09:45 -0800278 status_t readByteVector(std::unique_ptr<std::vector<int8_t>>* val) const;
Casey Dahlin451ff582015-10-19 18:12:18 -0700279 status_t readByteVector(std::vector<int8_t>* val) const;
Casey Dahlin185d3442016-02-09 11:08:35 -0800280 status_t readByteVector(std::unique_ptr<std::vector<uint8_t>>* val) const;
281 status_t readByteVector(std::vector<uint8_t>* val) const;
Casey Dahlinb9872622015-11-25 15:09:45 -0800282 status_t readInt32Vector(std::unique_ptr<std::vector<int32_t>>* val) const;
Casey Dahlin451ff582015-10-19 18:12:18 -0700283 status_t readInt32Vector(std::vector<int32_t>* val) const;
Casey Dahlinb9872622015-11-25 15:09:45 -0800284 status_t readInt64Vector(std::unique_ptr<std::vector<int64_t>>* val) const;
Casey Dahlin451ff582015-10-19 18:12:18 -0700285 status_t readInt64Vector(std::vector<int64_t>* val) const;
Casey Dahlinb9872622015-11-25 15:09:45 -0800286 status_t readFloatVector(std::unique_ptr<std::vector<float>>* val) const;
Casey Dahlin451ff582015-10-19 18:12:18 -0700287 status_t readFloatVector(std::vector<float>* val) const;
Casey Dahlinb9872622015-11-25 15:09:45 -0800288 status_t readDoubleVector(std::unique_ptr<std::vector<double>>* val) const;
Casey Dahlin451ff582015-10-19 18:12:18 -0700289 status_t readDoubleVector(std::vector<double>* val) const;
Casey Dahlinb9872622015-11-25 15:09:45 -0800290 status_t readBoolVector(std::unique_ptr<std::vector<bool>>* val) const;
Casey Dahlin451ff582015-10-19 18:12:18 -0700291 status_t readBoolVector(std::vector<bool>* val) const;
Casey Dahlinb9872622015-11-25 15:09:45 -0800292 status_t readCharVector(std::unique_ptr<std::vector<char16_t>>* val) const;
Casey Dahlin451ff582015-10-19 18:12:18 -0700293 status_t readCharVector(std::vector<char16_t>* val) const;
Casey Dahlinb9872622015-11-25 15:09:45 -0800294 status_t readString16Vector(
295 std::unique_ptr<std::vector<std::unique_ptr<String16>>>* val) const;
Casey Dahlin451ff582015-10-19 18:12:18 -0700296 status_t readString16Vector(std::vector<String16>* val) const;
Christopher Wiley9a5e32f2016-01-28 16:56:53 -0800297 status_t readUtf8VectorFromUtf16Vector(
298 std::unique_ptr<std::vector<std::unique_ptr<std::string>>>* val) const;
299 status_t readUtf8VectorFromUtf16Vector(std::vector<std::string>* val) const;
Casey Dahlin451ff582015-10-19 18:12:18 -0700300
Mathias Agopiane1424282013-07-29 21:24:40 -0700301 template<typename T>
302 status_t read(Flattenable<T>& val) const;
Brad Fitzpatrick837a0d02010-07-13 15:33:35 -0700303
Mathias Agopian8683fca2012-08-12 19:37:16 -0700304 template<typename T>
305 status_t read(LightFlattenable<T>& val) const;
306
Brad Fitzpatrick837a0d02010-07-13 15:33:35 -0700307 // Like Parcel.java's readExceptionCode(). Reads the first int32
308 // off of a Parcel's header, returning 0 or the negative error
309 // code on exceptions, but also deals with skipping over rich
310 // response headers. Callers should use this to read & parse the
311 // response headers rather than doing it by hand.
312 int32_t readExceptionCode() const;
313
Mathias Agopiana47f02a2009-05-21 16:29:38 -0700314 // Retrieve native_handle from the parcel. This returns a copy of the
315 // parcel's native_handle (the caller takes ownership). The caller
316 // must free the native_handle with native_handle_close() and
317 // native_handle_delete().
318 native_handle* readNativeHandle() const;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800319
320
321 // Retrieve a file descriptor from the parcel. This returns the raw fd
322 // in the parcel, which you do not own -- use dup() to get your own copy.
323 int readFileDescriptor() const;
Jeff Brown5707dbf2011-09-23 21:17:56 -0700324
Casey Dahlin06673e32015-11-23 13:24:23 -0800325 // Retrieve a smart file descriptor from the parcel.
326 status_t readUniqueFileDescriptor(
Christopher Wiley2cf19952016-04-11 11:09:37 -0700327 base::unique_fd* val) const;
Casey Dahlin06673e32015-11-23 13:24:23 -0800328
329
330 // Retrieve a vector of smart file descriptors from the parcel.
331 status_t readUniqueFileDescriptorVector(
Christopher Wiley2cf19952016-04-11 11:09:37 -0700332 std::unique_ptr<std::vector<base::unique_fd>>* val) const;
Casey Dahlinb9872622015-11-25 15:09:45 -0800333 status_t readUniqueFileDescriptorVector(
Christopher Wiley2cf19952016-04-11 11:09:37 -0700334 std::vector<base::unique_fd>* val) const;
Casey Dahlin06673e32015-11-23 13:24:23 -0800335
Jeff Brown5707dbf2011-09-23 21:17:56 -0700336 // Reads a blob from the parcel.
337 // The caller should call release() on the blob after reading its contents.
338 status_t readBlob(size_t len, ReadableBlob* outBlob) const;
339
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800340 const flat_binder_object* readObject(bool nullMetaData) const;
341
342 // Explicitly close all file descriptors in the parcel.
343 void closeFileDescriptors();
Dianne Hackborn7e790af2014-11-11 12:22:53 -0800344
345 // Debugging: get metrics on current allocations.
346 static size_t getGlobalAllocSize();
347 static size_t getGlobalAllocCount();
348
Arve Hjønnevåg84e625a2014-01-28 20:12:59 -0800349private:
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800350 typedef void (*release_func)(Parcel* parcel,
351 const uint8_t* data, size_t dataSize,
Arve Hjønnevåg84e625a2014-01-28 20:12:59 -0800352 const binder_size_t* objects, size_t objectsSize,
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800353 void* cookie);
354
Arve Hjønnevåg84e625a2014-01-28 20:12:59 -0800355 uintptr_t ipcData() const;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800356 size_t ipcDataSize() const;
Arve Hjønnevåg84e625a2014-01-28 20:12:59 -0800357 uintptr_t ipcObjects() const;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800358 size_t ipcObjectsCount() const;
359 void ipcSetDataReference(const uint8_t* data, size_t dataSize,
Arve Hjønnevåg84e625a2014-01-28 20:12:59 -0800360 const binder_size_t* objects, size_t objectsCount,
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800361 release_func relFunc, void* relCookie);
362
Arve Hjønnevåg84e625a2014-01-28 20:12:59 -0800363public:
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800364 void print(TextOutput& to, uint32_t flags = 0) const;
Jeff Brown5707dbf2011-09-23 21:17:56 -0700365
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800366private:
367 Parcel(const Parcel& o);
368 Parcel& operator=(const Parcel& o);
369
370 status_t finishWrite(size_t len);
371 void releaseObjects();
372 void acquireObjects();
373 status_t growData(size_t len);
374 status_t restartWrite(size_t desired);
375 status_t continueWrite(size_t desired);
Serban Constantinescuf683e012013-11-05 16:53:55 +0000376 status_t writePointer(uintptr_t val);
377 status_t readPointer(uintptr_t *pArg) const;
378 uintptr_t readPointer() const;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800379 void freeDataNoInit();
380 void initState();
381 void scanForFds() const;
382
Andreas Huber84a6d042009-08-17 13:33:27 -0700383 template<class T>
384 status_t readAligned(T *pArg) const;
385
386 template<class T> T readAligned() const;
387
388 template<class T>
389 status_t writeAligned(T val);
390
Casey Dahlinb9872622015-11-25 15:09:45 -0800391 status_t writeRawNullableParcelable(const Parcelable*
392 parcelable);
393
Christopher Wiley03d1eb62015-11-19 06:42:40 -0800394 template<typename T, typename U>
395 status_t unsafeReadTypedVector(std::vector<T>* val,
396 status_t(Parcel::*read_func)(U*) const) const;
397 template<typename T>
Casey Dahlinb9872622015-11-25 15:09:45 -0800398 status_t readNullableTypedVector(std::unique_ptr<std::vector<T>>* val,
399 status_t(Parcel::*read_func)(T*) const) const;
400 template<typename T>
Christopher Wiley03d1eb62015-11-19 06:42:40 -0800401 status_t readTypedVector(std::vector<T>* val,
402 status_t(Parcel::*read_func)(T*) const) const;
403 template<typename T, typename U>
404 status_t unsafeWriteTypedVector(const std::vector<T>& val,
405 status_t(Parcel::*write_func)(U));
406 template<typename T>
Casey Dahlinb9872622015-11-25 15:09:45 -0800407 status_t writeNullableTypedVector(const std::unique_ptr<std::vector<T>>& val,
408 status_t(Parcel::*write_func)(const T&));
409 template<typename T>
410 status_t writeNullableTypedVector(const std::unique_ptr<std::vector<T>>& val,
411 status_t(Parcel::*write_func)(T));
412 template<typename T>
Christopher Wiley03d1eb62015-11-19 06:42:40 -0800413 status_t writeTypedVector(const std::vector<T>& val,
414 status_t(Parcel::*write_func)(const T&));
415 template<typename T>
416 status_t writeTypedVector(const std::vector<T>& val,
417 status_t(Parcel::*write_func)(T));
418
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800419 status_t mError;
420 uint8_t* mData;
421 size_t mDataSize;
422 size_t mDataCapacity;
423 mutable size_t mDataPos;
Arve Hjønnevåg84e625a2014-01-28 20:12:59 -0800424 binder_size_t* mObjects;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800425 size_t mObjectsSize;
426 size_t mObjectsCapacity;
427 mutable size_t mNextObjectHint;
428
429 mutable bool mFdsKnown;
430 mutable bool mHasFds;
Dianne Hackborn8938ed22011-09-28 23:19:47 -0400431 bool mAllowFds;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800432
433 release_func mOwner;
434 void* mOwnerCookie;
Jeff Brown5707dbf2011-09-23 21:17:56 -0700435
436 class Blob {
437 public:
438 Blob();
439 ~Blob();
440
Jeff Brown13b16042014-11-11 16:44:25 -0800441 void clear();
Jeff Brown5707dbf2011-09-23 21:17:56 -0700442 void release();
443 inline size_t size() const { return mSize; }
Jeff Brown13b16042014-11-11 16:44:25 -0800444 inline int fd() const { return mFd; };
445 inline bool isMutable() const { return mMutable; }
Jeff Brown5707dbf2011-09-23 21:17:56 -0700446
447 protected:
Jeff Brown13b16042014-11-11 16:44:25 -0800448 void init(int fd, void* data, size_t size, bool isMutable);
Jeff Brown5707dbf2011-09-23 21:17:56 -0700449
Jeff Brown13b16042014-11-11 16:44:25 -0800450 int mFd; // owned by parcel so not closed when released
Jeff Brown5707dbf2011-09-23 21:17:56 -0700451 void* mData;
452 size_t mSize;
Jeff Brown13b16042014-11-11 16:44:25 -0800453 bool mMutable;
Jeff Brown5707dbf2011-09-23 21:17:56 -0700454 };
455
Mathias Agopiane1424282013-07-29 21:24:40 -0700456 class FlattenableHelperInterface {
457 protected:
458 ~FlattenableHelperInterface() { }
459 public:
460 virtual size_t getFlattenedSize() const = 0;
461 virtual size_t getFdCount() const = 0;
462 virtual status_t flatten(void* buffer, size_t size, int* fds, size_t count) const = 0;
463 virtual status_t unflatten(void const* buffer, size_t size, int const* fds, size_t count) = 0;
464 };
465
466 template<typename T>
467 class FlattenableHelper : public FlattenableHelperInterface {
468 friend class Parcel;
469 const Flattenable<T>& val;
470 explicit FlattenableHelper(const Flattenable<T>& val) : val(val) { }
471
472 public:
473 virtual size_t getFlattenedSize() const {
474 return val.getFlattenedSize();
475 }
476 virtual size_t getFdCount() const {
477 return val.getFdCount();
478 }
479 virtual status_t flatten(void* buffer, size_t size, int* fds, size_t count) const {
480 return val.flatten(buffer, size, fds, count);
481 }
482 virtual status_t unflatten(void const* buffer, size_t size, int const* fds, size_t count) {
483 return const_cast<Flattenable<T>&>(val).unflatten(buffer, size, fds, count);
484 }
485 };
486 status_t write(const FlattenableHelperInterface& val);
487 status_t read(FlattenableHelperInterface& val) const;
488
Jeff Brown5707dbf2011-09-23 21:17:56 -0700489public:
490 class ReadableBlob : public Blob {
491 friend class Parcel;
492 public:
493 inline const void* data() const { return mData; }
Jeff Brown13b16042014-11-11 16:44:25 -0800494 inline void* mutableData() { return isMutable() ? mData : NULL; }
Jeff Brown5707dbf2011-09-23 21:17:56 -0700495 };
496
497 class WritableBlob : public Blob {
498 friend class Parcel;
499 public:
500 inline void* data() { return mData; }
501 };
Dan Sandleraa5c2342015-04-10 10:08:45 -0400502
503private:
Adrian Rooscbf37262015-10-22 16:12:53 -0700504 size_t mOpenAshmemSize;
Dan Sandleraa5c2342015-04-10 10:08:45 -0400505
506public:
Adrian Roos6bb31142015-10-22 16:46:12 -0700507 // TODO: Remove once ABI can be changed.
Dan Sandleraa5c2342015-04-10 10:08:45 -0400508 size_t getBlobAshmemSize() const;
Adrian Rooscbf37262015-10-22 16:12:53 -0700509 size_t getOpenAshmemSize() const;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800510};
511
512// ---------------------------------------------------------------------------
513
Mathias Agopian8683fca2012-08-12 19:37:16 -0700514template<typename T>
Mathias Agopiane1424282013-07-29 21:24:40 -0700515status_t Parcel::write(const Flattenable<T>& val) {
516 const FlattenableHelper<T> helper(val);
517 return write(helper);
518}
519
520template<typename T>
Mathias Agopian8683fca2012-08-12 19:37:16 -0700521status_t Parcel::write(const LightFlattenable<T>& val) {
Mathias Agopiane1424282013-07-29 21:24:40 -0700522 size_t size(val.getFlattenedSize());
Mathias Agopian8683fca2012-08-12 19:37:16 -0700523 if (!val.isFixedSize()) {
524 status_t err = writeInt32(size);
525 if (err != NO_ERROR) {
526 return err;
527 }
528 }
Mathias Agopian20985172012-08-31 14:25:22 -0700529 if (size) {
530 void* buffer = writeInplace(size);
Mathias Agopiane1424282013-07-29 21:24:40 -0700531 if (buffer == NULL)
532 return NO_MEMORY;
533 return val.flatten(buffer, size);
Mathias Agopian20985172012-08-31 14:25:22 -0700534 }
535 return NO_ERROR;
Mathias Agopian8683fca2012-08-12 19:37:16 -0700536}
537
538template<typename T>
Mathias Agopiane1424282013-07-29 21:24:40 -0700539status_t Parcel::read(Flattenable<T>& val) const {
540 FlattenableHelper<T> helper(val);
541 return read(helper);
542}
543
544template<typename T>
Mathias Agopian8683fca2012-08-12 19:37:16 -0700545status_t Parcel::read(LightFlattenable<T>& val) const {
546 size_t size;
547 if (val.isFixedSize()) {
Mathias Agopiane1424282013-07-29 21:24:40 -0700548 size = val.getFlattenedSize();
Mathias Agopian8683fca2012-08-12 19:37:16 -0700549 } else {
550 int32_t s;
551 status_t err = readInt32(&s);
552 if (err != NO_ERROR) {
553 return err;
554 }
555 size = s;
556 }
Mathias Agopian20985172012-08-31 14:25:22 -0700557 if (size) {
558 void const* buffer = readInplace(size);
559 return buffer == NULL ? NO_MEMORY :
560 val.unflatten(buffer, size);
561 }
562 return NO_ERROR;
Mathias Agopian8683fca2012-08-12 19:37:16 -0700563}
564
Casey Dahlinf0c13772015-10-27 18:33:56 -0700565template<typename T>
566status_t Parcel::readStrongBinder(sp<T>* val) const {
567 sp<IBinder> tmp;
568 status_t ret = readStrongBinder(&tmp);
569
570 if (ret == OK) {
571 *val = interface_cast<T>(tmp);
572
573 if (val->get() == nullptr) {
574 return UNKNOWN_ERROR;
575 }
576 }
577
578 return ret;
579}
580
Christopher Wiley35d77ca2016-03-08 10:49:51 -0800581template<typename T>
582status_t Parcel::readNullableStrongBinder(sp<T>* val) const {
583 sp<IBinder> tmp;
584 status_t ret = readNullableStrongBinder(&tmp);
585
586 if (ret == OK) {
587 *val = interface_cast<T>(tmp);
588
589 if (val->get() == nullptr) {
590 return UNKNOWN_ERROR;
591 }
592 }
593}
594
Christopher Wiley03d1eb62015-11-19 06:42:40 -0800595template<typename T, typename U>
596status_t Parcel::unsafeReadTypedVector(
Casey Dahlinb9872622015-11-25 15:09:45 -0800597 std::vector<T>* val,
598 status_t(Parcel::*read_func)(U*) const) const {
Christopher Wiley03d1eb62015-11-19 06:42:40 -0800599 int32_t size;
600 status_t status = this->readInt32(&size);
601
602 if (status != OK) {
603 return status;
604 }
605
606 if (size < 0) {
607 return UNEXPECTED_NULL;
608 }
609
610 val->resize(size);
611
612 for (auto& v: *val) {
613 status = (this->*read_func)(&v);
614
615 if (status != OK) {
616 return status;
617 }
618 }
619
620 return OK;
621}
622
623template<typename T>
624status_t Parcel::readTypedVector(std::vector<T>* val,
625 status_t(Parcel::*read_func)(T*) const) const {
626 return unsafeReadTypedVector(val, read_func);
627}
628
Casey Dahlinb9872622015-11-25 15:09:45 -0800629template<typename T>
630status_t Parcel::readNullableTypedVector(std::unique_ptr<std::vector<T>>* val,
631 status_t(Parcel::*read_func)(T*) const) const {
632 const int32_t start = dataPosition();
633 int32_t size;
634 status_t status = readInt32(&size);
635 val->reset();
636
637 if (status != OK || size < 0) {
638 return status;
639 }
640
641 setDataPosition(start);
642 val->reset(new std::vector<T>());
643
644 status = unsafeReadTypedVector(val->get(), read_func);
645
646 if (status != OK) {
647 val->reset();
648 }
649
650 return status;
651}
652
Christopher Wiley03d1eb62015-11-19 06:42:40 -0800653template<typename T, typename U>
654status_t Parcel::unsafeWriteTypedVector(const std::vector<T>& val,
655 status_t(Parcel::*write_func)(U)) {
656 if (val.size() > std::numeric_limits<int32_t>::max()) {
657 return BAD_VALUE;
658 }
659
660 status_t status = this->writeInt32(val.size());
661
662 if (status != OK) {
663 return status;
664 }
665
666 for (const auto& item : val) {
667 status = (this->*write_func)(item);
668
669 if (status != OK) {
670 return status;
671 }
672 }
673
674 return OK;
675}
676
677template<typename T>
678status_t Parcel::writeTypedVector(const std::vector<T>& val,
Casey Dahlinb9872622015-11-25 15:09:45 -0800679 status_t(Parcel::*write_func)(const T&)) {
Christopher Wiley03d1eb62015-11-19 06:42:40 -0800680 return unsafeWriteTypedVector(val, write_func);
681}
682
683template<typename T>
684status_t Parcel::writeTypedVector(const std::vector<T>& val,
Casey Dahlinb9872622015-11-25 15:09:45 -0800685 status_t(Parcel::*write_func)(T)) {
Christopher Wiley03d1eb62015-11-19 06:42:40 -0800686 return unsafeWriteTypedVector(val, write_func);
687}
688
Christopher Wiley97f048d2015-11-19 06:49:05 -0800689template<typename T>
Casey Dahlinb9872622015-11-25 15:09:45 -0800690status_t Parcel::writeNullableTypedVector(const std::unique_ptr<std::vector<T>>& val,
691 status_t(Parcel::*write_func)(const T&)) {
692 if (val.get() == nullptr) {
693 return this->writeInt32(-1);
694 }
695
696 return unsafeWriteTypedVector(*val, write_func);
697}
698
699template<typename T>
700status_t Parcel::writeNullableTypedVector(const std::unique_ptr<std::vector<T>>& val,
701 status_t(Parcel::*write_func)(T)) {
702 if (val.get() == nullptr) {
703 return this->writeInt32(-1);
704 }
705
706 return unsafeWriteTypedVector(*val, write_func);
707}
708
709template<typename T>
Christopher Wiley97f048d2015-11-19 06:49:05 -0800710status_t Parcel::readParcelableVector(std::vector<T>* val) const {
Casey Dahlinb9872622015-11-25 15:09:45 -0800711 return unsafeReadTypedVector<T, Parcelable>(val, &Parcel::readParcelable);
712}
713
714template<typename T>
715status_t Parcel::readParcelableVector(std::unique_ptr<std::vector<std::unique_ptr<T>>>* val) const {
716 const int32_t start = dataPosition();
717 int32_t size;
718 status_t status = readInt32(&size);
719 val->reset();
720
721 if (status != OK || size < 0) {
722 return status;
723 }
724
725 setDataPosition(start);
726 val->reset(new std::vector<T>());
727
728 status = unsafeReadTypedVector(val->get(), &Parcel::readParcelable);
729
730 if (status != OK) {
731 val->reset();
732 }
733
734 return status;
735}
736
737template<typename T>
738status_t Parcel::readParcelable(std::unique_ptr<T>* parcelable) const {
739 const int32_t start = dataPosition();
740 int32_t present;
741 status_t status = readInt32(&present);
742 parcelable->reset();
743
744 if (status != OK || !present) {
745 return status;
746 }
747
748 setDataPosition(start);
749 parcelable->reset(new T());
750
751 status = readParcelable(parcelable->get());
752
753 if (status != OK) {
754 parcelable->reset();
755 }
756
757 return status;
758}
759
760template<typename T>
761status_t Parcel::writeNullableParcelable(const std::unique_ptr<T>& parcelable) {
762 return writeRawNullableParcelable(parcelable.get());
Christopher Wiley97f048d2015-11-19 06:49:05 -0800763}
764
765template<typename T>
766status_t Parcel::writeParcelableVector(const std::vector<T>& val) {
Casey Dahlinb9872622015-11-25 15:09:45 -0800767 return unsafeWriteTypedVector<T,const Parcelable&>(val, &Parcel::writeParcelable);
768}
769
770template<typename T>
771status_t Parcel::writeParcelableVector(const std::unique_ptr<std::vector<std::unique_ptr<T>>>& val) {
772 if (val.get() == nullptr) {
773 return this->writeInt32(-1);
774 }
775
776 return unsafeWriteTypedVector(*val, &Parcel::writeParcelable);
Christopher Wiley97f048d2015-11-19 06:49:05 -0800777}
778
Mathias Agopian8683fca2012-08-12 19:37:16 -0700779// ---------------------------------------------------------------------------
780
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800781inline TextOutput& operator<<(TextOutput& to, const Parcel& parcel)
782{
783 parcel.print(to);
784 return to;
785}
786
787// ---------------------------------------------------------------------------
788
789// Generic acquire and release of objects.
790void acquire_object(const sp<ProcessState>& proc,
Ian Pedowitz68803072015-10-22 22:08:10 +0000791 const flat_binder_object& obj, const void* who);
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800792void release_object(const sp<ProcessState>& proc,
Ian Pedowitz68803072015-10-22 22:08:10 +0000793 const flat_binder_object& obj, const void* who);
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800794
795void flatten_binder(const sp<ProcessState>& proc,
796 const sp<IBinder>& binder, flat_binder_object* out);
797void flatten_binder(const sp<ProcessState>& proc,
798 const wp<IBinder>& binder, flat_binder_object* out);
799status_t unflatten_binder(const sp<ProcessState>& proc,
800 const flat_binder_object& flat, sp<IBinder>* out);
801status_t unflatten_binder(const sp<ProcessState>& proc,
802 const flat_binder_object& flat, wp<IBinder>* out);
803
804}; // namespace android
805
806// ---------------------------------------------------------------------------
807
808#endif // ANDROID_PARCEL_H