blob: fe3aed6213c4e5bf0d9db1fb3697feae1ff90944 [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>
Christopher Ferris0170cd02016-07-18 16:57:34 -070030#include <linux/android/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;
Roshan Pius87b64d22016-07-18 12:51:02 -0700249 status_t readString8(String8* pArg) const;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800250 String16 readString16() const;
Casey Dahlin451ff582015-10-19 18:12:18 -0700251 status_t readString16(String16* pArg) const;
Casey Dahlinb9872622015-11-25 15:09:45 -0800252 status_t readString16(std::unique_ptr<String16>* pArg) const;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800253 const char16_t* readString16Inplace(size_t* outLen) const;
254 sp<IBinder> readStrongBinder() const;
Casey Dahlinf0c13772015-10-27 18:33:56 -0700255 status_t readStrongBinder(sp<IBinder>* val) const;
Christopher Wiley35d77ca2016-03-08 10:49:51 -0800256 status_t readNullableStrongBinder(sp<IBinder>* val) const;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800257 wp<IBinder> readWeakBinder() const;
Mathias Agopiane1424282013-07-29 21:24:40 -0700258
Casey Dahlinf0c13772015-10-27 18:33:56 -0700259 template<typename T>
Casey Dahlinb9872622015-11-25 15:09:45 -0800260 status_t readParcelableVector(
261 std::unique_ptr<std::vector<std::unique_ptr<T>>>* val) const;
262 template<typename T>
Christopher Wiley97f048d2015-11-19 06:49:05 -0800263 status_t readParcelableVector(std::vector<T>* val) const;
Casey Dahlinb9872622015-11-25 15:09:45 -0800264
Christopher Wiley97f048d2015-11-19 06:49:05 -0800265 status_t readParcelable(Parcelable* parcelable) const;
266
267 template<typename T>
Casey Dahlinb9872622015-11-25 15:09:45 -0800268 status_t readParcelable(std::unique_ptr<T>* parcelable) const;
269
270 template<typename T>
Casey Dahlineb8e15f2015-11-03 13:50:37 -0800271 status_t readStrongBinder(sp<T>* val) const;
272
Christopher Wiley35d77ca2016-03-08 10:49:51 -0800273 template<typename T>
274 status_t readNullableStrongBinder(sp<T>* val) const;
275
Casey Dahlinb9872622015-11-25 15:09:45 -0800276 status_t readStrongBinderVector(std::unique_ptr<std::vector<sp<IBinder>>>* val) const;
Casey Dahlineb8e15f2015-11-03 13:50:37 -0800277 status_t readStrongBinderVector(std::vector<sp<IBinder>>* val) const;
Casey Dahlinf0c13772015-10-27 18:33:56 -0700278
Casey Dahlinb9872622015-11-25 15:09:45 -0800279 status_t readByteVector(std::unique_ptr<std::vector<int8_t>>* val) const;
Casey Dahlin451ff582015-10-19 18:12:18 -0700280 status_t readByteVector(std::vector<int8_t>* val) const;
Casey Dahlin185d3442016-02-09 11:08:35 -0800281 status_t readByteVector(std::unique_ptr<std::vector<uint8_t>>* val) const;
282 status_t readByteVector(std::vector<uint8_t>* val) const;
Casey Dahlinb9872622015-11-25 15:09:45 -0800283 status_t readInt32Vector(std::unique_ptr<std::vector<int32_t>>* val) const;
Casey Dahlin451ff582015-10-19 18:12:18 -0700284 status_t readInt32Vector(std::vector<int32_t>* val) const;
Casey Dahlinb9872622015-11-25 15:09:45 -0800285 status_t readInt64Vector(std::unique_ptr<std::vector<int64_t>>* val) const;
Casey Dahlin451ff582015-10-19 18:12:18 -0700286 status_t readInt64Vector(std::vector<int64_t>* val) const;
Casey Dahlinb9872622015-11-25 15:09:45 -0800287 status_t readFloatVector(std::unique_ptr<std::vector<float>>* val) const;
Casey Dahlin451ff582015-10-19 18:12:18 -0700288 status_t readFloatVector(std::vector<float>* val) const;
Casey Dahlinb9872622015-11-25 15:09:45 -0800289 status_t readDoubleVector(std::unique_ptr<std::vector<double>>* val) const;
Casey Dahlin451ff582015-10-19 18:12:18 -0700290 status_t readDoubleVector(std::vector<double>* val) const;
Casey Dahlinb9872622015-11-25 15:09:45 -0800291 status_t readBoolVector(std::unique_ptr<std::vector<bool>>* val) const;
Casey Dahlin451ff582015-10-19 18:12:18 -0700292 status_t readBoolVector(std::vector<bool>* val) const;
Casey Dahlinb9872622015-11-25 15:09:45 -0800293 status_t readCharVector(std::unique_ptr<std::vector<char16_t>>* val) const;
Casey Dahlin451ff582015-10-19 18:12:18 -0700294 status_t readCharVector(std::vector<char16_t>* val) const;
Casey Dahlinb9872622015-11-25 15:09:45 -0800295 status_t readString16Vector(
296 std::unique_ptr<std::vector<std::unique_ptr<String16>>>* val) const;
Casey Dahlin451ff582015-10-19 18:12:18 -0700297 status_t readString16Vector(std::vector<String16>* val) const;
Christopher Wiley9a5e32f2016-01-28 16:56:53 -0800298 status_t readUtf8VectorFromUtf16Vector(
299 std::unique_ptr<std::vector<std::unique_ptr<std::string>>>* val) const;
300 status_t readUtf8VectorFromUtf16Vector(std::vector<std::string>* val) const;
Casey Dahlin451ff582015-10-19 18:12:18 -0700301
Mathias Agopiane1424282013-07-29 21:24:40 -0700302 template<typename T>
303 status_t read(Flattenable<T>& val) const;
Brad Fitzpatrick837a0d02010-07-13 15:33:35 -0700304
Mathias Agopian8683fca2012-08-12 19:37:16 -0700305 template<typename T>
306 status_t read(LightFlattenable<T>& val) const;
307
Brad Fitzpatrick837a0d02010-07-13 15:33:35 -0700308 // Like Parcel.java's readExceptionCode(). Reads the first int32
309 // off of a Parcel's header, returning 0 or the negative error
310 // code on exceptions, but also deals with skipping over rich
311 // response headers. Callers should use this to read & parse the
312 // response headers rather than doing it by hand.
313 int32_t readExceptionCode() const;
314
Mathias Agopiana47f02a2009-05-21 16:29:38 -0700315 // Retrieve native_handle from the parcel. This returns a copy of the
316 // parcel's native_handle (the caller takes ownership). The caller
317 // must free the native_handle with native_handle_close() and
318 // native_handle_delete().
319 native_handle* readNativeHandle() const;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800320
321
322 // Retrieve a file descriptor from the parcel. This returns the raw fd
323 // in the parcel, which you do not own -- use dup() to get your own copy.
324 int readFileDescriptor() const;
Jeff Brown5707dbf2011-09-23 21:17:56 -0700325
Casey Dahlin06673e32015-11-23 13:24:23 -0800326 // Retrieve a smart file descriptor from the parcel.
327 status_t readUniqueFileDescriptor(
Christopher Wiley2cf19952016-04-11 11:09:37 -0700328 base::unique_fd* val) const;
Casey Dahlin06673e32015-11-23 13:24:23 -0800329
330
331 // Retrieve a vector of smart file descriptors from the parcel.
332 status_t readUniqueFileDescriptorVector(
Christopher Wiley2cf19952016-04-11 11:09:37 -0700333 std::unique_ptr<std::vector<base::unique_fd>>* val) const;
Casey Dahlinb9872622015-11-25 15:09:45 -0800334 status_t readUniqueFileDescriptorVector(
Christopher Wiley2cf19952016-04-11 11:09:37 -0700335 std::vector<base::unique_fd>* val) const;
Casey Dahlin06673e32015-11-23 13:24:23 -0800336
Jeff Brown5707dbf2011-09-23 21:17:56 -0700337 // Reads a blob from the parcel.
338 // The caller should call release() on the blob after reading its contents.
339 status_t readBlob(size_t len, ReadableBlob* outBlob) const;
340
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800341 const flat_binder_object* readObject(bool nullMetaData) const;
342
343 // Explicitly close all file descriptors in the parcel.
344 void closeFileDescriptors();
Dianne Hackborn7e790af2014-11-11 12:22:53 -0800345
346 // Debugging: get metrics on current allocations.
347 static size_t getGlobalAllocSize();
348 static size_t getGlobalAllocCount();
349
Arve Hjønnevåg84e625a2014-01-28 20:12:59 -0800350private:
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800351 typedef void (*release_func)(Parcel* parcel,
352 const uint8_t* data, size_t dataSize,
Arve Hjønnevåg84e625a2014-01-28 20:12:59 -0800353 const binder_size_t* objects, size_t objectsSize,
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800354 void* cookie);
355
Arve Hjønnevåg84e625a2014-01-28 20:12:59 -0800356 uintptr_t ipcData() const;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800357 size_t ipcDataSize() const;
Arve Hjønnevåg84e625a2014-01-28 20:12:59 -0800358 uintptr_t ipcObjects() const;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800359 size_t ipcObjectsCount() const;
360 void ipcSetDataReference(const uint8_t* data, size_t dataSize,
Arve Hjønnevåg84e625a2014-01-28 20:12:59 -0800361 const binder_size_t* objects, size_t objectsCount,
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800362 release_func relFunc, void* relCookie);
363
Arve Hjønnevåg84e625a2014-01-28 20:12:59 -0800364public:
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800365 void print(TextOutput& to, uint32_t flags = 0) const;
Jeff Brown5707dbf2011-09-23 21:17:56 -0700366
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800367private:
368 Parcel(const Parcel& o);
369 Parcel& operator=(const Parcel& o);
370
371 status_t finishWrite(size_t len);
372 void releaseObjects();
373 void acquireObjects();
374 status_t growData(size_t len);
375 status_t restartWrite(size_t desired);
376 status_t continueWrite(size_t desired);
Serban Constantinescuf683e012013-11-05 16:53:55 +0000377 status_t writePointer(uintptr_t val);
378 status_t readPointer(uintptr_t *pArg) const;
379 uintptr_t readPointer() const;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800380 void freeDataNoInit();
381 void initState();
382 void scanForFds() const;
383
Andreas Huber84a6d042009-08-17 13:33:27 -0700384 template<class T>
385 status_t readAligned(T *pArg) const;
386
387 template<class T> T readAligned() const;
388
389 template<class T>
390 status_t writeAligned(T val);
391
Casey Dahlinb9872622015-11-25 15:09:45 -0800392 status_t writeRawNullableParcelable(const Parcelable*
393 parcelable);
394
Christopher Wiley03d1eb62015-11-19 06:42:40 -0800395 template<typename T, typename U>
396 status_t unsafeReadTypedVector(std::vector<T>* val,
397 status_t(Parcel::*read_func)(U*) const) const;
398 template<typename T>
Casey Dahlinb9872622015-11-25 15:09:45 -0800399 status_t readNullableTypedVector(std::unique_ptr<std::vector<T>>* val,
400 status_t(Parcel::*read_func)(T*) const) const;
401 template<typename T>
Christopher Wiley03d1eb62015-11-19 06:42:40 -0800402 status_t readTypedVector(std::vector<T>* val,
403 status_t(Parcel::*read_func)(T*) const) const;
404 template<typename T, typename U>
405 status_t unsafeWriteTypedVector(const std::vector<T>& val,
406 status_t(Parcel::*write_func)(U));
407 template<typename T>
Casey Dahlinb9872622015-11-25 15:09:45 -0800408 status_t writeNullableTypedVector(const std::unique_ptr<std::vector<T>>& val,
409 status_t(Parcel::*write_func)(const T&));
410 template<typename T>
411 status_t writeNullableTypedVector(const std::unique_ptr<std::vector<T>>& val,
412 status_t(Parcel::*write_func)(T));
413 template<typename T>
Christopher Wiley03d1eb62015-11-19 06:42:40 -0800414 status_t writeTypedVector(const std::vector<T>& val,
415 status_t(Parcel::*write_func)(const T&));
416 template<typename T>
417 status_t writeTypedVector(const std::vector<T>& val,
418 status_t(Parcel::*write_func)(T));
419
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800420 status_t mError;
421 uint8_t* mData;
422 size_t mDataSize;
423 size_t mDataCapacity;
424 mutable size_t mDataPos;
Arve Hjønnevåg84e625a2014-01-28 20:12:59 -0800425 binder_size_t* mObjects;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800426 size_t mObjectsSize;
427 size_t mObjectsCapacity;
428 mutable size_t mNextObjectHint;
429
430 mutable bool mFdsKnown;
431 mutable bool mHasFds;
Dianne Hackborn8938ed22011-09-28 23:19:47 -0400432 bool mAllowFds;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800433
434 release_func mOwner;
435 void* mOwnerCookie;
Jeff Brown5707dbf2011-09-23 21:17:56 -0700436
437 class Blob {
438 public:
439 Blob();
440 ~Blob();
441
Jeff Brown13b16042014-11-11 16:44:25 -0800442 void clear();
Jeff Brown5707dbf2011-09-23 21:17:56 -0700443 void release();
444 inline size_t size() const { return mSize; }
Jeff Brown13b16042014-11-11 16:44:25 -0800445 inline int fd() const { return mFd; };
446 inline bool isMutable() const { return mMutable; }
Jeff Brown5707dbf2011-09-23 21:17:56 -0700447
448 protected:
Jeff Brown13b16042014-11-11 16:44:25 -0800449 void init(int fd, void* data, size_t size, bool isMutable);
Jeff Brown5707dbf2011-09-23 21:17:56 -0700450
Jeff Brown13b16042014-11-11 16:44:25 -0800451 int mFd; // owned by parcel so not closed when released
Jeff Brown5707dbf2011-09-23 21:17:56 -0700452 void* mData;
453 size_t mSize;
Jeff Brown13b16042014-11-11 16:44:25 -0800454 bool mMutable;
Jeff Brown5707dbf2011-09-23 21:17:56 -0700455 };
456
Mathias Agopiane1424282013-07-29 21:24:40 -0700457 class FlattenableHelperInterface {
458 protected:
459 ~FlattenableHelperInterface() { }
460 public:
461 virtual size_t getFlattenedSize() const = 0;
462 virtual size_t getFdCount() const = 0;
463 virtual status_t flatten(void* buffer, size_t size, int* fds, size_t count) const = 0;
464 virtual status_t unflatten(void const* buffer, size_t size, int const* fds, size_t count) = 0;
465 };
466
467 template<typename T>
468 class FlattenableHelper : public FlattenableHelperInterface {
469 friend class Parcel;
470 const Flattenable<T>& val;
471 explicit FlattenableHelper(const Flattenable<T>& val) : val(val) { }
472
473 public:
474 virtual size_t getFlattenedSize() const {
475 return val.getFlattenedSize();
476 }
477 virtual size_t getFdCount() const {
478 return val.getFdCount();
479 }
480 virtual status_t flatten(void* buffer, size_t size, int* fds, size_t count) const {
481 return val.flatten(buffer, size, fds, count);
482 }
483 virtual status_t unflatten(void const* buffer, size_t size, int const* fds, size_t count) {
484 return const_cast<Flattenable<T>&>(val).unflatten(buffer, size, fds, count);
485 }
486 };
487 status_t write(const FlattenableHelperInterface& val);
488 status_t read(FlattenableHelperInterface& val) const;
489
Jeff Brown5707dbf2011-09-23 21:17:56 -0700490public:
491 class ReadableBlob : public Blob {
492 friend class Parcel;
493 public:
494 inline const void* data() const { return mData; }
Jeff Brown13b16042014-11-11 16:44:25 -0800495 inline void* mutableData() { return isMutable() ? mData : NULL; }
Jeff Brown5707dbf2011-09-23 21:17:56 -0700496 };
497
498 class WritableBlob : public Blob {
499 friend class Parcel;
500 public:
501 inline void* data() { return mData; }
502 };
Dan Sandleraa5c2342015-04-10 10:08:45 -0400503
504private:
Adrian Rooscbf37262015-10-22 16:12:53 -0700505 size_t mOpenAshmemSize;
Dan Sandleraa5c2342015-04-10 10:08:45 -0400506
507public:
Adrian Roos6bb31142015-10-22 16:46:12 -0700508 // TODO: Remove once ABI can be changed.
Dan Sandleraa5c2342015-04-10 10:08:45 -0400509 size_t getBlobAshmemSize() const;
Adrian Rooscbf37262015-10-22 16:12:53 -0700510 size_t getOpenAshmemSize() const;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800511};
512
513// ---------------------------------------------------------------------------
514
Mathias Agopian8683fca2012-08-12 19:37:16 -0700515template<typename T>
Mathias Agopiane1424282013-07-29 21:24:40 -0700516status_t Parcel::write(const Flattenable<T>& val) {
517 const FlattenableHelper<T> helper(val);
518 return write(helper);
519}
520
521template<typename T>
Mathias Agopian8683fca2012-08-12 19:37:16 -0700522status_t Parcel::write(const LightFlattenable<T>& val) {
Mathias Agopiane1424282013-07-29 21:24:40 -0700523 size_t size(val.getFlattenedSize());
Mathias Agopian8683fca2012-08-12 19:37:16 -0700524 if (!val.isFixedSize()) {
525 status_t err = writeInt32(size);
526 if (err != NO_ERROR) {
527 return err;
528 }
529 }
Mathias Agopian20985172012-08-31 14:25:22 -0700530 if (size) {
531 void* buffer = writeInplace(size);
Mathias Agopiane1424282013-07-29 21:24:40 -0700532 if (buffer == NULL)
533 return NO_MEMORY;
534 return val.flatten(buffer, size);
Mathias Agopian20985172012-08-31 14:25:22 -0700535 }
536 return NO_ERROR;
Mathias Agopian8683fca2012-08-12 19:37:16 -0700537}
538
539template<typename T>
Mathias Agopiane1424282013-07-29 21:24:40 -0700540status_t Parcel::read(Flattenable<T>& val) const {
541 FlattenableHelper<T> helper(val);
542 return read(helper);
543}
544
545template<typename T>
Mathias Agopian8683fca2012-08-12 19:37:16 -0700546status_t Parcel::read(LightFlattenable<T>& val) const {
547 size_t size;
548 if (val.isFixedSize()) {
Mathias Agopiane1424282013-07-29 21:24:40 -0700549 size = val.getFlattenedSize();
Mathias Agopian8683fca2012-08-12 19:37:16 -0700550 } else {
551 int32_t s;
552 status_t err = readInt32(&s);
553 if (err != NO_ERROR) {
554 return err;
555 }
556 size = s;
557 }
Mathias Agopian20985172012-08-31 14:25:22 -0700558 if (size) {
559 void const* buffer = readInplace(size);
560 return buffer == NULL ? NO_MEMORY :
561 val.unflatten(buffer, size);
562 }
563 return NO_ERROR;
Mathias Agopian8683fca2012-08-12 19:37:16 -0700564}
565
Casey Dahlinf0c13772015-10-27 18:33:56 -0700566template<typename T>
567status_t Parcel::readStrongBinder(sp<T>* val) const {
568 sp<IBinder> tmp;
569 status_t ret = readStrongBinder(&tmp);
570
571 if (ret == OK) {
572 *val = interface_cast<T>(tmp);
573
574 if (val->get() == nullptr) {
575 return UNKNOWN_ERROR;
576 }
577 }
578
579 return ret;
580}
581
Christopher Wiley35d77ca2016-03-08 10:49:51 -0800582template<typename T>
583status_t Parcel::readNullableStrongBinder(sp<T>* val) const {
584 sp<IBinder> tmp;
585 status_t ret = readNullableStrongBinder(&tmp);
586
587 if (ret == OK) {
588 *val = interface_cast<T>(tmp);
589
Christopher Wiley447b00f2016-07-19 09:23:25 -0700590 if (val->get() == nullptr && tmp.get() != nullptr) {
591 ret = UNKNOWN_ERROR;
Christopher Wiley35d77ca2016-03-08 10:49:51 -0800592 }
593 }
Christopher Wiley447b00f2016-07-19 09:23:25 -0700594
595 return ret;
Christopher Wiley35d77ca2016-03-08 10:49:51 -0800596}
597
Christopher Wiley03d1eb62015-11-19 06:42:40 -0800598template<typename T, typename U>
599status_t Parcel::unsafeReadTypedVector(
Casey Dahlinb9872622015-11-25 15:09:45 -0800600 std::vector<T>* val,
601 status_t(Parcel::*read_func)(U*) const) const {
Christopher Wiley03d1eb62015-11-19 06:42:40 -0800602 int32_t size;
603 status_t status = this->readInt32(&size);
604
605 if (status != OK) {
606 return status;
607 }
608
609 if (size < 0) {
610 return UNEXPECTED_NULL;
611 }
612
613 val->resize(size);
614
615 for (auto& v: *val) {
616 status = (this->*read_func)(&v);
617
618 if (status != OK) {
619 return status;
620 }
621 }
622
623 return OK;
624}
625
626template<typename T>
627status_t Parcel::readTypedVector(std::vector<T>* val,
628 status_t(Parcel::*read_func)(T*) const) const {
629 return unsafeReadTypedVector(val, read_func);
630}
631
Casey Dahlinb9872622015-11-25 15:09:45 -0800632template<typename T>
633status_t Parcel::readNullableTypedVector(std::unique_ptr<std::vector<T>>* val,
634 status_t(Parcel::*read_func)(T*) const) const {
635 const int32_t start = dataPosition();
636 int32_t size;
637 status_t status = readInt32(&size);
638 val->reset();
639
640 if (status != OK || size < 0) {
641 return status;
642 }
643
644 setDataPosition(start);
645 val->reset(new std::vector<T>());
646
647 status = unsafeReadTypedVector(val->get(), read_func);
648
649 if (status != OK) {
650 val->reset();
651 }
652
653 return status;
654}
655
Christopher Wiley03d1eb62015-11-19 06:42:40 -0800656template<typename T, typename U>
657status_t Parcel::unsafeWriteTypedVector(const std::vector<T>& val,
658 status_t(Parcel::*write_func)(U)) {
659 if (val.size() > std::numeric_limits<int32_t>::max()) {
660 return BAD_VALUE;
661 }
662
663 status_t status = this->writeInt32(val.size());
664
665 if (status != OK) {
666 return status;
667 }
668
669 for (const auto& item : val) {
670 status = (this->*write_func)(item);
671
672 if (status != OK) {
673 return status;
674 }
675 }
676
677 return OK;
678}
679
680template<typename T>
681status_t Parcel::writeTypedVector(const std::vector<T>& val,
Casey Dahlinb9872622015-11-25 15:09:45 -0800682 status_t(Parcel::*write_func)(const T&)) {
Christopher Wiley03d1eb62015-11-19 06:42:40 -0800683 return unsafeWriteTypedVector(val, write_func);
684}
685
686template<typename T>
687status_t Parcel::writeTypedVector(const std::vector<T>& val,
Casey Dahlinb9872622015-11-25 15:09:45 -0800688 status_t(Parcel::*write_func)(T)) {
Christopher Wiley03d1eb62015-11-19 06:42:40 -0800689 return unsafeWriteTypedVector(val, write_func);
690}
691
Christopher Wiley97f048d2015-11-19 06:49:05 -0800692template<typename T>
Casey Dahlinb9872622015-11-25 15:09:45 -0800693status_t Parcel::writeNullableTypedVector(const std::unique_ptr<std::vector<T>>& val,
694 status_t(Parcel::*write_func)(const T&)) {
695 if (val.get() == nullptr) {
696 return this->writeInt32(-1);
697 }
698
699 return unsafeWriteTypedVector(*val, write_func);
700}
701
702template<typename T>
703status_t Parcel::writeNullableTypedVector(const std::unique_ptr<std::vector<T>>& val,
704 status_t(Parcel::*write_func)(T)) {
705 if (val.get() == nullptr) {
706 return this->writeInt32(-1);
707 }
708
709 return unsafeWriteTypedVector(*val, write_func);
710}
711
712template<typename T>
Christopher Wiley97f048d2015-11-19 06:49:05 -0800713status_t Parcel::readParcelableVector(std::vector<T>* val) const {
Casey Dahlinb9872622015-11-25 15:09:45 -0800714 return unsafeReadTypedVector<T, Parcelable>(val, &Parcel::readParcelable);
715}
716
717template<typename T>
718status_t Parcel::readParcelableVector(std::unique_ptr<std::vector<std::unique_ptr<T>>>* val) const {
719 const int32_t start = dataPosition();
720 int32_t size;
721 status_t status = readInt32(&size);
722 val->reset();
723
724 if (status != OK || size < 0) {
725 return status;
726 }
727
728 setDataPosition(start);
729 val->reset(new std::vector<T>());
730
731 status = unsafeReadTypedVector(val->get(), &Parcel::readParcelable);
732
733 if (status != OK) {
734 val->reset();
735 }
736
737 return status;
738}
739
740template<typename T>
741status_t Parcel::readParcelable(std::unique_ptr<T>* parcelable) const {
742 const int32_t start = dataPosition();
743 int32_t present;
744 status_t status = readInt32(&present);
745 parcelable->reset();
746
747 if (status != OK || !present) {
748 return status;
749 }
750
751 setDataPosition(start);
752 parcelable->reset(new T());
753
754 status = readParcelable(parcelable->get());
755
756 if (status != OK) {
757 parcelable->reset();
758 }
759
760 return status;
761}
762
763template<typename T>
764status_t Parcel::writeNullableParcelable(const std::unique_ptr<T>& parcelable) {
765 return writeRawNullableParcelable(parcelable.get());
Christopher Wiley97f048d2015-11-19 06:49:05 -0800766}
767
768template<typename T>
769status_t Parcel::writeParcelableVector(const std::vector<T>& val) {
Casey Dahlinb9872622015-11-25 15:09:45 -0800770 return unsafeWriteTypedVector<T,const Parcelable&>(val, &Parcel::writeParcelable);
771}
772
773template<typename T>
774status_t Parcel::writeParcelableVector(const std::unique_ptr<std::vector<std::unique_ptr<T>>>& val) {
775 if (val.get() == nullptr) {
776 return this->writeInt32(-1);
777 }
778
779 return unsafeWriteTypedVector(*val, &Parcel::writeParcelable);
Christopher Wiley97f048d2015-11-19 06:49:05 -0800780}
781
Mathias Agopian8683fca2012-08-12 19:37:16 -0700782// ---------------------------------------------------------------------------
783
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800784inline TextOutput& operator<<(TextOutput& to, const Parcel& parcel)
785{
786 parcel.print(to);
787 return to;
788}
789
790// ---------------------------------------------------------------------------
791
792// Generic acquire and release of objects.
793void acquire_object(const sp<ProcessState>& proc,
Ian Pedowitz68803072015-10-22 22:08:10 +0000794 const flat_binder_object& obj, const void* who);
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800795void release_object(const sp<ProcessState>& proc,
Ian Pedowitz68803072015-10-22 22:08:10 +0000796 const flat_binder_object& obj, const void* who);
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800797
798void flatten_binder(const sp<ProcessState>& proc,
799 const sp<IBinder>& binder, flat_binder_object* out);
800void flatten_binder(const sp<ProcessState>& proc,
801 const wp<IBinder>& binder, flat_binder_object* out);
802status_t unflatten_binder(const sp<ProcessState>& proc,
803 const flat_binder_object& flat, sp<IBinder>* out);
804status_t unflatten_binder(const sp<ProcessState>& proc,
805 const flat_binder_object& flat, wp<IBinder>* out);
806
807}; // namespace android
808
809// ---------------------------------------------------------------------------
810
811#endif // ANDROID_PARCEL_H