Parcel.h revision e2f499fb734bc30a1e1c947112caa0727349b6ed
13564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay/* 23564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay * Copyright (C) 2005 The Android Open Source Project 33564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay * 43564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay * Licensed under the Apache License, Version 2.0 (the "License"); 53564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay * you may not use this file except in compliance with the License. 63564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay * You may obtain a copy of the License at 73564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay * 83564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay * http://www.apache.org/licenses/LICENSE-2.0 93564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay * 103564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay * Unless required by applicable law or agreed to in writing, software 113564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay * distributed under the License is distributed on an "AS IS" BASIS, 123564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 133564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay * See the License for the specific language governing permissions and 143564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay * limitations under the License. 153564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay */ 163564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay 173564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay#ifndef ANDROID_PARCEL_H 183564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay#define ANDROID_PARCEL_H 193564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay 203564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay#include <cutils/native_handle.h> 213564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay#include <utils/Errors.h> 223564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay#include <utils/RefBase.h> 233564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay#include <utils/String16.h> 243564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay#include <utils/Vector.h> 253564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay#include <utils/Flattenable.h> 263564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay#include <linux/binder.h> 27d5b2af1544629d48175d857785db32f2b8957f3aBen Kwa 283564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay// --------------------------------------------------------------------------- 293564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKaynamespace android { 303564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay 313564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKaytemplate <typename T> class Flattenable; 323564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKaytemplate <typename T> class LightFlattenable; 333564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKayclass IBinder; 343564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKayclass IPCThreadState; 353564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKayclass ProcessState; 363564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKayclass String8; 373564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKayclass TextOutput; 38b8436af1b84a31b2ba3d50510ebf10bb721f2b6cTomasz Mikolajewski 393564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKayclass Parcel { 403564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay friend class IPCThreadState; 413564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKaypublic: 423564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay class ReadableBlob; 433564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay class WritableBlob; 443564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay 453564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay Parcel(); 463564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay ~Parcel(); 47b8436af1b84a31b2ba3d50510ebf10bb721f2b6cTomasz Mikolajewski 48b8436af1b84a31b2ba3d50510ebf10bb721f2b6cTomasz Mikolajewski const uint8_t* data() const; 493564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay size_t dataSize() const; 503564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay size_t dataAvail() const; 51b8436af1b84a31b2ba3d50510ebf10bb721f2b6cTomasz Mikolajewski size_t dataPosition() const; 523564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay size_t dataCapacity() const; 533564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay 54b8436af1b84a31b2ba3d50510ebf10bb721f2b6cTomasz Mikolajewski status_t setDataSize(size_t size); 553564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay void setDataPosition(size_t pos) const; 563564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay status_t setDataCapacity(size_t size); 573564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay 583564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay status_t setData(const uint8_t* buffer, size_t len); 593564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay 607a3b811122b6db0ac103630c2b7acde1d9f4c128Steve McKay status_t appendFrom(const Parcel *parcel, 617a3b811122b6db0ac103630c2b7acde1d9f4c128Steve McKay size_t start, size_t len); 623564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay 633564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay bool allowFds() const; 643564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay bool pushAllowFds(bool allowFds); 653564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay void restoreAllowFds(bool lastValue); 663564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay 673564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay bool hasFileDescriptors() const; 683564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay 693564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay // Writes the RPC header. 703564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay status_t writeInterfaceToken(const String16& interface); 713564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay 723564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay // Parses the RPC header, returning true if the interface name 733564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay // in the header matches the expected interface from the caller. 743564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay // 753564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay // Additionally, enforceInterface does part of the work of 763564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay // propagating the StrictMode policy mask, populating the current 773564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay // IPCThreadState, which as an optimization may optionally be 78748ea8cc785b6f037518703308ffd3eb2a151c5aTomasz Mikolajewski // passed in. 79748ea8cc785b6f037518703308ffd3eb2a151c5aTomasz Mikolajewski bool enforceInterface(const String16& interface, 80748ea8cc785b6f037518703308ffd3eb2a151c5aTomasz Mikolajewski IPCThreadState* threadState = NULL) const; 81748ea8cc785b6f037518703308ffd3eb2a151c5aTomasz Mikolajewski bool checkInterface(IBinder*) const; 82748ea8cc785b6f037518703308ffd3eb2a151c5aTomasz Mikolajewski 830fa97e85e45505b58e5b5956541277f61aa5458bTomasz Mikolajewski void freeData(); 843564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay 853564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKayprivate: 860fa97e85e45505b58e5b5956541277f61aa5458bTomasz Mikolajewski const binder_size_t* objects() const; 87db87543d82f1916b0372f732045f0bc2860ed3f2Tomasz Mikolajewski 880fa97e85e45505b58e5b5956541277f61aa5458bTomasz Mikolajewskipublic: 8956d950c5e6c25ce3bfa2a19ae1a4ef122fc76fdfSteve McKay size_t objectsCount() const; 903564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay 913564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay status_t errorCheck() const; 923564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay void setError(status_t err); 93d5b2af1544629d48175d857785db32f2b8957f3aBen Kwa 943564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay status_t write(const void* data, size_t len); 953564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay void* writeInplace(size_t len); 963564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay status_t writeUnpadded(const void* data, size_t len); 973564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay status_t writeInt32(int32_t val); 983564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay status_t writeUint32(uint32_t val); 993564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay status_t writeInt64(int64_t val); 1003564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay status_t writeUint64(uint64_t val); 1013564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay status_t writeFloat(float val); 102b8436af1b84a31b2ba3d50510ebf10bb721f2b6cTomasz Mikolajewski status_t writeDouble(double val); 103b8436af1b84a31b2ba3d50510ebf10bb721f2b6cTomasz Mikolajewski status_t writeCString(const char* str); 1043564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay status_t writeString8(const String8& str); 1053564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay status_t writeString16(const String16& str); 1063564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay status_t writeString16(const char16_t* str, size_t len); 1073564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay status_t writeStrongBinder(const sp<IBinder>& val); 1083564543e1ece2211a2d5b729fbbf8dd7ac94944cSteve McKay status_t writeWeakBinder(const wp<IBinder>& val); 109 status_t writeInt32Array(size_t len, const int32_t *val); 110 status_t writeByteArray(size_t len, const uint8_t *val); 111 112 template<typename T> 113 status_t write(const Flattenable<T>& val); 114 115 template<typename T> 116 status_t write(const LightFlattenable<T>& val); 117 118 119 // Place a native_handle into the parcel (the native_handle's file- 120 // descriptors are dup'ed, so it is safe to delete the native_handle 121 // when this function returns). 122 // Doesn't take ownership of the native_handle. 123 status_t writeNativeHandle(const native_handle* handle); 124 125 // Place a file descriptor into the parcel. The given fd must remain 126 // valid for the lifetime of the parcel. 127 // The Parcel does not take ownership of the given fd unless you ask it to. 128 status_t writeFileDescriptor(int fd, bool takeOwnership = false); 129 130 // Place a file descriptor into the parcel. A dup of the fd is made, which 131 // will be closed once the parcel is destroyed. 132 status_t writeDupFileDescriptor(int fd); 133 134 // Writes a blob to the parcel. 135 // If the blob is small, then it is stored in-place, otherwise it is 136 // transferred by way of an anonymous shared memory region. Prefer sending 137 // immutable blobs if possible since they may be subsequently transferred between 138 // processes without further copying whereas mutable blobs always need to be copied. 139 // The caller should call release() on the blob after writing its contents. 140 status_t writeBlob(size_t len, bool mutableCopy, WritableBlob* outBlob); 141 142 // Write an existing immutable blob file descriptor to the parcel. 143 // This allows the client to send the same blob to multiple processes 144 // as long as it keeps a dup of the blob file descriptor handy for later. 145 status_t writeDupImmutableBlobFileDescriptor(int fd); 146 147 status_t writeObject(const flat_binder_object& val, bool nullMetaData); 148 149 // Like Parcel.java's writeNoException(). Just writes a zero int32. 150 // Currently the native implementation doesn't do any of the StrictMode 151 // stack gathering and serialization that the Java implementation does. 152 status_t writeNoException(); 153 154 void remove(size_t start, size_t amt); 155 156 status_t read(void* outData, size_t len) const; 157 const void* readInplace(size_t len) const; 158 int32_t readInt32() const; 159 status_t readInt32(int32_t *pArg) const; 160 uint32_t readUint32() const; 161 status_t readUint32(uint32_t *pArg) const; 162 int64_t readInt64() const; 163 status_t readInt64(int64_t *pArg) const; 164 uint64_t readUint64() const; 165 status_t readUint64(uint64_t *pArg) const; 166 float readFloat() const; 167 status_t readFloat(float *pArg) const; 168 double readDouble() const; 169 status_t readDouble(double *pArg) const; 170 intptr_t readIntPtr() const; 171 status_t readIntPtr(intptr_t *pArg) const; 172 173 const char* readCString() const; 174 String8 readString8() const; 175 String16 readString16() const; 176 const char16_t* readString16Inplace(size_t* outLen) const; 177 sp<IBinder> readStrongBinder() const; 178 wp<IBinder> readWeakBinder() const; 179 180 template<typename T> 181 status_t read(Flattenable<T>& val) const; 182 183 template<typename T> 184 status_t read(LightFlattenable<T>& val) const; 185 186 // Like Parcel.java's readExceptionCode(). Reads the first int32 187 // off of a Parcel's header, returning 0 or the negative error 188 // code on exceptions, but also deals with skipping over rich 189 // response headers. Callers should use this to read & parse the 190 // response headers rather than doing it by hand. 191 int32_t readExceptionCode() const; 192 193 // Retrieve native_handle from the parcel. This returns a copy of the 194 // parcel's native_handle (the caller takes ownership). The caller 195 // must free the native_handle with native_handle_close() and 196 // native_handle_delete(). 197 native_handle* readNativeHandle() const; 198 199 200 // Retrieve a file descriptor from the parcel. This returns the raw fd 201 // in the parcel, which you do not own -- use dup() to get your own copy. 202 int readFileDescriptor() const; 203 204 // Reads a blob from the parcel. 205 // The caller should call release() on the blob after reading its contents. 206 status_t readBlob(size_t len, ReadableBlob* outBlob) const; 207 208 const flat_binder_object* readObject(bool nullMetaData) const; 209 210 // Explicitly close all file descriptors in the parcel. 211 void closeFileDescriptors(); 212 213 // Debugging: get metrics on current allocations. 214 static size_t getGlobalAllocSize(); 215 static size_t getGlobalAllocCount(); 216 217private: 218 typedef void (*release_func)(Parcel* parcel, 219 const uint8_t* data, size_t dataSize, 220 const binder_size_t* objects, size_t objectsSize, 221 void* cookie); 222 223 uintptr_t ipcData() const; 224 size_t ipcDataSize() const; 225 uintptr_t ipcObjects() const; 226 size_t ipcObjectsCount() const; 227 void ipcSetDataReference(const uint8_t* data, size_t dataSize, 228 const binder_size_t* objects, size_t objectsCount, 229 release_func relFunc, void* relCookie); 230 231public: 232 void print(TextOutput& to, uint32_t flags = 0) const; 233 234private: 235 Parcel(const Parcel& o); 236 Parcel& operator=(const Parcel& o); 237 238 status_t finishWrite(size_t len); 239 void releaseObjects(); 240 void acquireObjects(); 241 status_t growData(size_t len); 242 status_t restartWrite(size_t desired); 243 status_t continueWrite(size_t desired); 244 status_t writePointer(uintptr_t val); 245 status_t readPointer(uintptr_t *pArg) const; 246 uintptr_t readPointer() const; 247 void freeDataNoInit(); 248 void initState(); 249 void scanForFds() const; 250 251 template<class T> 252 status_t readAligned(T *pArg) const; 253 254 template<class T> T readAligned() const; 255 256 template<class T> 257 status_t writeAligned(T val); 258 259 status_t mError; 260 uint8_t* mData; 261 size_t mDataSize; 262 size_t mDataCapacity; 263 mutable size_t mDataPos; 264 binder_size_t* mObjects; 265 size_t mObjectsSize; 266 size_t mObjectsCapacity; 267 mutable size_t mNextObjectHint; 268 269 mutable bool mFdsKnown; 270 mutable bool mHasFds; 271 bool mAllowFds; 272 273 release_func mOwner; 274 void* mOwnerCookie; 275 276 class Blob { 277 public: 278 Blob(); 279 ~Blob(); 280 281 void clear(); 282 void release(); 283 inline size_t size() const { return mSize; } 284 inline int fd() const { return mFd; }; 285 inline bool isMutable() const { return mMutable; } 286 287 protected: 288 void init(int fd, void* data, size_t size, bool isMutable); 289 290 int mFd; // owned by parcel so not closed when released 291 void* mData; 292 size_t mSize; 293 bool mMutable; 294 }; 295 296 class FlattenableHelperInterface { 297 protected: 298 ~FlattenableHelperInterface() { } 299 public: 300 virtual size_t getFlattenedSize() const = 0; 301 virtual size_t getFdCount() const = 0; 302 virtual status_t flatten(void* buffer, size_t size, int* fds, size_t count) const = 0; 303 virtual status_t unflatten(void const* buffer, size_t size, int const* fds, size_t count) = 0; 304 }; 305 306 template<typename T> 307 class FlattenableHelper : public FlattenableHelperInterface { 308 friend class Parcel; 309 const Flattenable<T>& val; 310 explicit FlattenableHelper(const Flattenable<T>& val) : val(val) { } 311 312 public: 313 virtual size_t getFlattenedSize() const { 314 return val.getFlattenedSize(); 315 } 316 virtual size_t getFdCount() const { 317 return val.getFdCount(); 318 } 319 virtual status_t flatten(void* buffer, size_t size, int* fds, size_t count) const { 320 return val.flatten(buffer, size, fds, count); 321 } 322 virtual status_t unflatten(void const* buffer, size_t size, int const* fds, size_t count) { 323 return const_cast<Flattenable<T>&>(val).unflatten(buffer, size, fds, count); 324 } 325 }; 326 status_t write(const FlattenableHelperInterface& val); 327 status_t read(FlattenableHelperInterface& val) const; 328 329public: 330 class ReadableBlob : public Blob { 331 friend class Parcel; 332 public: 333 inline const void* data() const { return mData; } 334 inline void* mutableData() { return isMutable() ? mData : NULL; } 335 }; 336 337 class WritableBlob : public Blob { 338 friend class Parcel; 339 public: 340 inline void* data() { return mData; } 341 }; 342 343private: 344 size_t mBlobAshmemSize; 345 size_t mOpenAshmemSize; 346 347public: 348 size_t getBlobAshmemSize() const; 349 size_t getOpenAshmemSize() const; 350}; 351 352// --------------------------------------------------------------------------- 353 354template<typename T> 355status_t Parcel::write(const Flattenable<T>& val) { 356 const FlattenableHelper<T> helper(val); 357 return write(helper); 358} 359 360template<typename T> 361status_t Parcel::write(const LightFlattenable<T>& val) { 362 size_t size(val.getFlattenedSize()); 363 if (!val.isFixedSize()) { 364 status_t err = writeInt32(size); 365 if (err != NO_ERROR) { 366 return err; 367 } 368 } 369 if (size) { 370 void* buffer = writeInplace(size); 371 if (buffer == NULL) 372 return NO_MEMORY; 373 return val.flatten(buffer, size); 374 } 375 return NO_ERROR; 376} 377 378template<typename T> 379status_t Parcel::read(Flattenable<T>& val) const { 380 FlattenableHelper<T> helper(val); 381 return read(helper); 382} 383 384template<typename T> 385status_t Parcel::read(LightFlattenable<T>& val) const { 386 size_t size; 387 if (val.isFixedSize()) { 388 size = val.getFlattenedSize(); 389 } else { 390 int32_t s; 391 status_t err = readInt32(&s); 392 if (err != NO_ERROR) { 393 return err; 394 } 395 size = s; 396 } 397 if (size) { 398 void const* buffer = readInplace(size); 399 return buffer == NULL ? NO_MEMORY : 400 val.unflatten(buffer, size); 401 } 402 return NO_ERROR; 403} 404 405// --------------------------------------------------------------------------- 406 407inline TextOutput& operator<<(TextOutput& to, const Parcel& parcel) 408{ 409 parcel.print(to); 410 return to; 411} 412 413// --------------------------------------------------------------------------- 414 415// Generic acquire and release of objects. 416void acquire_object(const sp<ProcessState>& proc, 417 const flat_binder_object& obj, const void* who, size_t* outAshmemSize); 418void release_object(const sp<ProcessState>& proc, 419 const flat_binder_object& obj, const void* who, size_t* outAshmemSize); 420 421void flatten_binder(const sp<ProcessState>& proc, 422 const sp<IBinder>& binder, flat_binder_object* out); 423void flatten_binder(const sp<ProcessState>& proc, 424 const wp<IBinder>& binder, flat_binder_object* out); 425status_t unflatten_binder(const sp<ProcessState>& proc, 426 const flat_binder_object& flat, sp<IBinder>* out); 427status_t unflatten_binder(const sp<ProcessState>& proc, 428 const flat_binder_object& flat, wp<IBinder>* out); 429 430}; // namespace android 431 432// --------------------------------------------------------------------------- 433 434#endif // ANDROID_PARCEL_H 435