Parcel.h revision 5c0106e134366312206702f1b072347e20c90374
1edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project/* 2edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * Copyright (C) 2005 The Android Open Source Project 3edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * 4edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 5edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * you may not use this file except in compliance with the License. 6edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * You may obtain a copy of the License at 7edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * 8edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 9edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * 10edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 11edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 12edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * See the License for the specific language governing permissions and 14edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * limitations under the License. 15edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project */ 16edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 17edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#ifndef ANDROID_PARCEL_H 18edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#define ANDROID_PARCEL_H 19edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 20edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#include <cutils/native_handle.h> 21edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#include <utils/Errors.h> 22edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#include <utils/RefBase.h> 23edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#include <utils/String16.h> 24edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#include <utils/Vector.h> 258683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian#include <utils/Flattenable.h> 26edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 27edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project// --------------------------------------------------------------------------- 28edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectnamespace android { 29edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 30e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopiantemplate <typename T> class Flattenable; 318683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopiantemplate <typename T> class LightFlattenable; 32edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectclass IBinder; 3370081a1511955f53bd0ed7f2aec9a1bf09f0f379Brad Fitzpatrickclass IPCThreadState; 34edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectclass ProcessState; 35edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectclass String8; 36edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectclass TextOutput; 37edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 38edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectstruct flat_binder_object; // defined in support_p/binder_module.h 39edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 40e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopianclass Parcel { 41edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectpublic: 425707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown class ReadableBlob; 435707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown class WritableBlob; 445707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown 45edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project Parcel(); 46edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project ~Parcel(); 47edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 48edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const uint8_t* data() const; 49edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project size_t dataSize() const; 50edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project size_t dataAvail() const; 51edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project size_t dataPosition() const; 52edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project size_t dataCapacity() const; 538938ed2c8e906fc332301b64787728d4d34da571Dianne Hackborn 54edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t setDataSize(size_t size); 55edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void setDataPosition(size_t pos) const; 56edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t setDataCapacity(size_t size); 57edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 58edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t setData(const uint8_t* buffer, size_t len); 59edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 6051faf46e2958c57dab46d9420e585319125c7c42Andreas Huber status_t appendFrom(const Parcel *parcel, 6151faf46e2958c57dab46d9420e585319125c7c42Andreas Huber size_t start, size_t len); 62edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 637746cc318829358bb2c4dc0a03d40a7856a6d13eDianne Hackborn bool pushAllowFds(bool allowFds); 647746cc318829358bb2c4dc0a03d40a7856a6d13eDianne Hackborn void restoreAllowFds(bool lastValue); 658938ed2c8e906fc332301b64787728d4d34da571Dianne Hackborn 66edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project bool hasFileDescriptors() const; 67edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 68702ea9d42f52fc145090c0f0bfbe64993e4b8b33Brad Fitzpatrick // Writes the RPC header. 69edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeInterfaceToken(const String16& interface); 70a877cd85b5a026384542e3271fc310d6a8fe24c6Brad Fitzpatrick 71702ea9d42f52fc145090c0f0bfbe64993e4b8b33Brad Fitzpatrick // Parses the RPC header, returning true if the interface name 72702ea9d42f52fc145090c0f0bfbe64993e4b8b33Brad Fitzpatrick // in the header matches the expected interface from the caller. 7370081a1511955f53bd0ed7f2aec9a1bf09f0f379Brad Fitzpatrick // 7470081a1511955f53bd0ed7f2aec9a1bf09f0f379Brad Fitzpatrick // Additionally, enforceInterface does part of the work of 7570081a1511955f53bd0ed7f2aec9a1bf09f0f379Brad Fitzpatrick // propagating the StrictMode policy mask, populating the current 7670081a1511955f53bd0ed7f2aec9a1bf09f0f379Brad Fitzpatrick // IPCThreadState, which as an optimization may optionally be 7770081a1511955f53bd0ed7f2aec9a1bf09f0f379Brad Fitzpatrick // passed in. 78a877cd85b5a026384542e3271fc310d6a8fe24c6Brad Fitzpatrick bool enforceInterface(const String16& interface, 7970081a1511955f53bd0ed7f2aec9a1bf09f0f379Brad Fitzpatrick IPCThreadState* threadState = NULL) const; 80702ea9d42f52fc145090c0f0bfbe64993e4b8b33Brad Fitzpatrick bool checkInterface(IBinder*) const; 8183c0446f27b9542d6c2e724817b2b2d8d1f55085Mathias Agopian 82edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void freeData(); 83edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 84edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const size_t* objects() const; 85edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project size_t objectsCount() const; 86edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 87edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t errorCheck() const; 88edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void setError(status_t err); 89edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 90edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t write(const void* data, size_t len); 91edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void* writeInplace(size_t len); 92edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeUnpadded(const void* data, size_t len); 93edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeInt32(int32_t val); 94edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeInt64(int64_t val); 95edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeFloat(float val); 96edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeDouble(double val); 9784a6d041e2c69d4d0b69269a0b59e725c9f119a3Andreas Huber status_t writeIntPtr(intptr_t val); 98edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeCString(const char* str); 99edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeString8(const String8& str); 100edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeString16(const String16& str); 101edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeString16(const char16_t* str, size_t len); 102edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeStrongBinder(const sp<IBinder>& val); 103edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeWeakBinder(const wp<IBinder>& val); 1045c0106e134366312206702f1b072347e20c90374Marco Nelissen status_t writeInt32Array(size_t len, const int32_t *val); 105e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian 106e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian template<typename T> 107e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian status_t write(const Flattenable<T>& val); 108edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 1098683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian template<typename T> 1108683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian status_t write(const LightFlattenable<T>& val); 1118683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian 1128683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian 113a47f02afb1e1f2c4abd9379c13903a5dde89d354Mathias Agopian // Place a native_handle into the parcel (the native_handle's file- 114a47f02afb1e1f2c4abd9379c13903a5dde89d354Mathias Agopian // descriptors are dup'ed, so it is safe to delete the native_handle 115a47f02afb1e1f2c4abd9379c13903a5dde89d354Mathias Agopian // when this function returns). 116a47f02afb1e1f2c4abd9379c13903a5dde89d354Mathias Agopian // Doesn't take ownership of the native_handle. 117a47f02afb1e1f2c4abd9379c13903a5dde89d354Mathias Agopian status_t writeNativeHandle(const native_handle* handle); 118edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 119edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // Place a file descriptor into the parcel. The given fd must remain 120edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // valid for the lifetime of the parcel. 12193ff1f985e233fe04412a65041e977c9f0c21f5bJeff Brown // The Parcel does not take ownership of the given fd unless you ask it to. 12293ff1f985e233fe04412a65041e977c9f0c21f5bJeff Brown status_t writeFileDescriptor(int fd, bool takeOwnership = false); 123edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 124edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // Place a file descriptor into the parcel. A dup of the fd is made, which 125edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // will be closed once the parcel is destroyed. 126edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeDupFileDescriptor(int fd); 1275707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown 128cbe36fe1ec21e22e6649d47144c91260ba51d753Mike Lockwood // Writes a raw fd and optional comm channel fd to the parcel as a ParcelFileDescriptor. 129cbe36fe1ec21e22e6649d47144c91260ba51d753Mike Lockwood // A dup's of the fds are made, which will be closed once the parcel is destroyed. 130cbe36fe1ec21e22e6649d47144c91260ba51d753Mike Lockwood // Null values are passed as -1. 131cbe36fe1ec21e22e6649d47144c91260ba51d753Mike Lockwood status_t writeParcelFileDescriptor(int fd, int commChannel = -1); 132cbe36fe1ec21e22e6649d47144c91260ba51d753Mike Lockwood 1335707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown // Writes a blob to the parcel. 1345707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown // If the blob is small, then it is stored in-place, otherwise it is 1355707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown // transferred by way of an anonymous shared memory region. 1365707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown // The caller should call release() on the blob after writing its contents. 1375707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown status_t writeBlob(size_t len, WritableBlob* outBlob); 1385707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown 139edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeObject(const flat_binder_object& val, bool nullMetaData); 140edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 141837a0d0fb2c3fba8082d47d04cb6120af1eb9a54Brad Fitzpatrick // Like Parcel.java's writeNoException(). Just writes a zero int32. 142837a0d0fb2c3fba8082d47d04cb6120af1eb9a54Brad Fitzpatrick // Currently the native implementation doesn't do any of the StrictMode 143837a0d0fb2c3fba8082d47d04cb6120af1eb9a54Brad Fitzpatrick // stack gathering and serialization that the Java implementation does. 144837a0d0fb2c3fba8082d47d04cb6120af1eb9a54Brad Fitzpatrick status_t writeNoException(); 145837a0d0fb2c3fba8082d47d04cb6120af1eb9a54Brad Fitzpatrick 146edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void remove(size_t start, size_t amt); 147edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 148edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t read(void* outData, size_t len) const; 149edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const void* readInplace(size_t len) const; 150edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project int32_t readInt32() const; 151edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t readInt32(int32_t *pArg) const; 152edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project int64_t readInt64() const; 153edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t readInt64(int64_t *pArg) const; 154edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project float readFloat() const; 155edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t readFloat(float *pArg) const; 156edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project double readDouble() const; 157edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t readDouble(double *pArg) const; 15884a6d041e2c69d4d0b69269a0b59e725c9f119a3Andreas Huber intptr_t readIntPtr() const; 15984a6d041e2c69d4d0b69269a0b59e725c9f119a3Andreas Huber status_t readIntPtr(intptr_t *pArg) const; 160edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 161edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const char* readCString() const; 162edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project String8 readString8() const; 163edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project String16 readString16() const; 164edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const char16_t* readString16Inplace(size_t* outLen) const; 165edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project sp<IBinder> readStrongBinder() const; 166edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project wp<IBinder> readWeakBinder() const; 167e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian 168e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian template<typename T> 169e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian status_t read(Flattenable<T>& val) const; 170837a0d0fb2c3fba8082d47d04cb6120af1eb9a54Brad Fitzpatrick 1718683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian template<typename T> 1728683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian status_t read(LightFlattenable<T>& val) const; 1738683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian 174837a0d0fb2c3fba8082d47d04cb6120af1eb9a54Brad Fitzpatrick // Like Parcel.java's readExceptionCode(). Reads the first int32 175837a0d0fb2c3fba8082d47d04cb6120af1eb9a54Brad Fitzpatrick // off of a Parcel's header, returning 0 or the negative error 176837a0d0fb2c3fba8082d47d04cb6120af1eb9a54Brad Fitzpatrick // code on exceptions, but also deals with skipping over rich 177837a0d0fb2c3fba8082d47d04cb6120af1eb9a54Brad Fitzpatrick // response headers. Callers should use this to read & parse the 178837a0d0fb2c3fba8082d47d04cb6120af1eb9a54Brad Fitzpatrick // response headers rather than doing it by hand. 179837a0d0fb2c3fba8082d47d04cb6120af1eb9a54Brad Fitzpatrick int32_t readExceptionCode() const; 180837a0d0fb2c3fba8082d47d04cb6120af1eb9a54Brad Fitzpatrick 181a47f02afb1e1f2c4abd9379c13903a5dde89d354Mathias Agopian // Retrieve native_handle from the parcel. This returns a copy of the 182a47f02afb1e1f2c4abd9379c13903a5dde89d354Mathias Agopian // parcel's native_handle (the caller takes ownership). The caller 183a47f02afb1e1f2c4abd9379c13903a5dde89d354Mathias Agopian // must free the native_handle with native_handle_close() and 184a47f02afb1e1f2c4abd9379c13903a5dde89d354Mathias Agopian // native_handle_delete(). 185a47f02afb1e1f2c4abd9379c13903a5dde89d354Mathias Agopian native_handle* readNativeHandle() const; 186edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 187edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 188edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // Retrieve a file descriptor from the parcel. This returns the raw fd 189edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // in the parcel, which you do not own -- use dup() to get your own copy. 190edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project int readFileDescriptor() const; 1915707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown 192cbe36fe1ec21e22e6649d47144c91260ba51d753Mike Lockwood // Reads a ParcelFileDescriptor from the parcel. Returns the raw fd as 193cbe36fe1ec21e22e6649d47144c91260ba51d753Mike Lockwood // the result, and the optional comm channel fd in outCommChannel. 194cbe36fe1ec21e22e6649d47144c91260ba51d753Mike Lockwood // Null values are returned as -1. 195cbe36fe1ec21e22e6649d47144c91260ba51d753Mike Lockwood int readParcelFileDescriptor(int& outCommChannel) const; 196cbe36fe1ec21e22e6649d47144c91260ba51d753Mike Lockwood 1975707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown // Reads a blob from the parcel. 1985707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown // The caller should call release() on the blob after reading its contents. 1995707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown status_t readBlob(size_t len, ReadableBlob* outBlob) const; 2005707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown 201edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const flat_binder_object* readObject(bool nullMetaData) const; 202edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 203edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // Explicitly close all file descriptors in the parcel. 204edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void closeFileDescriptors(); 205edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 206edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project typedef void (*release_func)(Parcel* parcel, 207edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const uint8_t* data, size_t dataSize, 208edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const size_t* objects, size_t objectsSize, 209edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void* cookie); 210edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 211edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const uint8_t* ipcData() const; 212edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project size_t ipcDataSize() const; 213edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const size_t* ipcObjects() const; 214edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project size_t ipcObjectsCount() const; 215edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void ipcSetDataReference(const uint8_t* data, size_t dataSize, 216edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const size_t* objects, size_t objectsCount, 217edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project release_func relFunc, void* relCookie); 218edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 219edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void print(TextOutput& to, uint32_t flags = 0) const; 2205707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown 221edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectprivate: 222edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project Parcel(const Parcel& o); 223edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project Parcel& operator=(const Parcel& o); 224edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 225edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t finishWrite(size_t len); 226edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void releaseObjects(); 227edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void acquireObjects(); 228edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t growData(size_t len); 229edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t restartWrite(size_t desired); 230edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t continueWrite(size_t desired); 231edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void freeDataNoInit(); 232edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void initState(); 233edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void scanForFds() const; 234edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 23584a6d041e2c69d4d0b69269a0b59e725c9f119a3Andreas Huber template<class T> 23684a6d041e2c69d4d0b69269a0b59e725c9f119a3Andreas Huber status_t readAligned(T *pArg) const; 23784a6d041e2c69d4d0b69269a0b59e725c9f119a3Andreas Huber 23884a6d041e2c69d4d0b69269a0b59e725c9f119a3Andreas Huber template<class T> T readAligned() const; 23984a6d041e2c69d4d0b69269a0b59e725c9f119a3Andreas Huber 24084a6d041e2c69d4d0b69269a0b59e725c9f119a3Andreas Huber template<class T> 24184a6d041e2c69d4d0b69269a0b59e725c9f119a3Andreas Huber status_t writeAligned(T val); 24284a6d041e2c69d4d0b69269a0b59e725c9f119a3Andreas Huber 243edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t mError; 244edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project uint8_t* mData; 245edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project size_t mDataSize; 246edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project size_t mDataCapacity; 247edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project mutable size_t mDataPos; 248edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project size_t* mObjects; 249edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project size_t mObjectsSize; 250edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project size_t mObjectsCapacity; 251edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project mutable size_t mNextObjectHint; 252edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 253edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project mutable bool mFdsKnown; 254edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project mutable bool mHasFds; 2558938ed2c8e906fc332301b64787728d4d34da571Dianne Hackborn bool mAllowFds; 256edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 257edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project release_func mOwner; 258edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void* mOwnerCookie; 2595707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown 2605707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown class Blob { 2615707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown public: 2625707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown Blob(); 2635707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown ~Blob(); 2645707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown 2655707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown void release(); 2665707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown inline size_t size() const { return mSize; } 2675707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown 2685707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown protected: 2695707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown void init(bool mapped, void* data, size_t size); 2705707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown void clear(); 2715707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown 2725707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown bool mMapped; 2735707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown void* mData; 2745707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown size_t mSize; 2755707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown }; 2765707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown 277e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian class FlattenableHelperInterface { 278e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian protected: 279e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian ~FlattenableHelperInterface() { } 280e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian public: 281e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian virtual size_t getFlattenedSize() const = 0; 282e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian virtual size_t getFdCount() const = 0; 283e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian virtual status_t flatten(void* buffer, size_t size, int* fds, size_t count) const = 0; 284e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian virtual status_t unflatten(void const* buffer, size_t size, int const* fds, size_t count) = 0; 285e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian }; 286e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian 287e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian template<typename T> 288e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian class FlattenableHelper : public FlattenableHelperInterface { 289e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian friend class Parcel; 290e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian const Flattenable<T>& val; 291e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian explicit FlattenableHelper(const Flattenable<T>& val) : val(val) { } 292e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian 293e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian public: 294e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian virtual size_t getFlattenedSize() const { 295e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian return val.getFlattenedSize(); 296e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian } 297e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian virtual size_t getFdCount() const { 298e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian return val.getFdCount(); 299e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian } 300e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian virtual status_t flatten(void* buffer, size_t size, int* fds, size_t count) const { 301e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian return val.flatten(buffer, size, fds, count); 302e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian } 303e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian virtual status_t unflatten(void const* buffer, size_t size, int const* fds, size_t count) { 304e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian return const_cast<Flattenable<T>&>(val).unflatten(buffer, size, fds, count); 305e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian } 306e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian }; 307e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian status_t write(const FlattenableHelperInterface& val); 308e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian status_t read(FlattenableHelperInterface& val) const; 309e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian 3105707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brownpublic: 3115707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown class ReadableBlob : public Blob { 3125707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown friend class Parcel; 3135707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown public: 3145707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown inline const void* data() const { return mData; } 3155707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown }; 3165707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown 3175707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown class WritableBlob : public Blob { 3185707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown friend class Parcel; 3195707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown public: 3205707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown inline void* data() { return mData; } 3215707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown }; 322edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project}; 323edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 324edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project// --------------------------------------------------------------------------- 325edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 3268683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopiantemplate<typename T> 327e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopianstatus_t Parcel::write(const Flattenable<T>& val) { 328e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian const FlattenableHelper<T> helper(val); 329e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian return write(helper); 330e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian} 331e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian 332e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopiantemplate<typename T> 3338683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopianstatus_t Parcel::write(const LightFlattenable<T>& val) { 334e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian size_t size(val.getFlattenedSize()); 3358683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian if (!val.isFixedSize()) { 3368683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian status_t err = writeInt32(size); 3378683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian if (err != NO_ERROR) { 3388683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian return err; 3398683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian } 3408683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian } 3412098517e3e12a401005d7a7510d6c4943707b98dMathias Agopian if (size) { 3422098517e3e12a401005d7a7510d6c4943707b98dMathias Agopian void* buffer = writeInplace(size); 343e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian if (buffer == NULL) 344e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian return NO_MEMORY; 345e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian return val.flatten(buffer, size); 3462098517e3e12a401005d7a7510d6c4943707b98dMathias Agopian } 3472098517e3e12a401005d7a7510d6c4943707b98dMathias Agopian return NO_ERROR; 3488683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian} 3498683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian 3508683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopiantemplate<typename T> 351e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopianstatus_t Parcel::read(Flattenable<T>& val) const { 352e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian FlattenableHelper<T> helper(val); 353e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian return read(helper); 354e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian} 355e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian 356e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopiantemplate<typename T> 3578683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopianstatus_t Parcel::read(LightFlattenable<T>& val) const { 3588683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian size_t size; 3598683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian if (val.isFixedSize()) { 360e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian size = val.getFlattenedSize(); 3618683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian } else { 3628683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian int32_t s; 3638683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian status_t err = readInt32(&s); 3648683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian if (err != NO_ERROR) { 3658683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian return err; 3668683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian } 3678683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian size = s; 3688683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian } 3692098517e3e12a401005d7a7510d6c4943707b98dMathias Agopian if (size) { 3702098517e3e12a401005d7a7510d6c4943707b98dMathias Agopian void const* buffer = readInplace(size); 3712098517e3e12a401005d7a7510d6c4943707b98dMathias Agopian return buffer == NULL ? NO_MEMORY : 3722098517e3e12a401005d7a7510d6c4943707b98dMathias Agopian val.unflatten(buffer, size); 3732098517e3e12a401005d7a7510d6c4943707b98dMathias Agopian } 3742098517e3e12a401005d7a7510d6c4943707b98dMathias Agopian return NO_ERROR; 3758683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian} 3768683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian 3778683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian// --------------------------------------------------------------------------- 3788683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian 379edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectinline TextOutput& operator<<(TextOutput& to, const Parcel& parcel) 380edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project{ 381edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project parcel.print(to); 382edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project return to; 383edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project} 384edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 385edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project// --------------------------------------------------------------------------- 386edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 387edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project// Generic acquire and release of objects. 388edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectvoid acquire_object(const sp<ProcessState>& proc, 389edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const flat_binder_object& obj, const void* who); 390edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectvoid release_object(const sp<ProcessState>& proc, 391edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const flat_binder_object& obj, const void* who); 392edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 393edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectvoid flatten_binder(const sp<ProcessState>& proc, 394edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const sp<IBinder>& binder, flat_binder_object* out); 395edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectvoid flatten_binder(const sp<ProcessState>& proc, 396edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const wp<IBinder>& binder, flat_binder_object* out); 397edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectstatus_t unflatten_binder(const sp<ProcessState>& proc, 398edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const flat_binder_object& flat, sp<IBinder>* out); 399edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectstatus_t unflatten_binder(const sp<ProcessState>& proc, 400edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const flat_binder_object& flat, wp<IBinder>* out); 401edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 402edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project}; // namespace android 403edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 404edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project// --------------------------------------------------------------------------- 405edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 406edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#endif // ANDROID_PARCEL_H 407