Parcel.h revision 41a0f2f86c0ca7d2fef50aef6215987f445a7231
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> 2684e625ac1e01f5a9c3ed16664da6498212ed662bArve Hjønnevåg#include <linux/binder.h> 27edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 28edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project// --------------------------------------------------------------------------- 29edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectnamespace android { 30edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 31e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopiantemplate <typename T> class Flattenable; 328683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopiantemplate <typename T> class LightFlattenable; 33edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectclass IBinder; 3470081a1511955f53bd0ed7f2aec9a1bf09f0f379Brad Fitzpatrickclass IPCThreadState; 35edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectclass ProcessState; 36edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectclass String8; 37edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectclass TextOutput; 38edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 39e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopianclass Parcel { 40f683e0163a84d93448b9388126902242367cd961Serban Constantinescu friend class IPCThreadState; 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 8484e625ac1e01f5a9c3ed16664da6498212ed662bArve Hjønnevågprivate: 8584e625ac1e01f5a9c3ed16664da6498212ed662bArve Hjønnevåg const binder_size_t* objects() const; 8684e625ac1e01f5a9c3ed16664da6498212ed662bArve Hjønnevåg 8784e625ac1e01f5a9c3ed16664da6498212ed662bArve Hjønnevågpublic: 88edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project size_t objectsCount() const; 89edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 90edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t errorCheck() const; 91edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void setError(status_t err); 92edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 93edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t write(const void* data, size_t len); 94edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void* writeInplace(size_t len); 95edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeUnpadded(const void* data, size_t len); 96edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeInt32(int32_t val); 9741a0f2f86c0ca7d2fef50aef6215987f445a7231Dan Stoza status_t writeUint32(uint32_t val); 98edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeInt64(int64_t val); 99edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeFloat(float val); 100edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeDouble(double val); 101edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeCString(const char* str); 102edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeString8(const String8& str); 103edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeString16(const String16& str); 104edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeString16(const char16_t* str, size_t len); 105edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeStrongBinder(const sp<IBinder>& val); 106edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeWeakBinder(const wp<IBinder>& val); 1075c0106e134366312206702f1b072347e20c90374Marco Nelissen status_t writeInt32Array(size_t len, const int32_t *val); 108f0190bff38b6c29abbfc4a877442f71fc3d7dad8Marco Nelissen status_t writeByteArray(size_t len, const uint8_t *val); 109e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian 110e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian template<typename T> 111e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian status_t write(const Flattenable<T>& val); 112edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 1138683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian template<typename T> 1148683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian status_t write(const LightFlattenable<T>& val); 1158683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian 1168683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian 117a47f02afb1e1f2c4abd9379c13903a5dde89d354Mathias Agopian // Place a native_handle into the parcel (the native_handle's file- 118a47f02afb1e1f2c4abd9379c13903a5dde89d354Mathias Agopian // descriptors are dup'ed, so it is safe to delete the native_handle 119a47f02afb1e1f2c4abd9379c13903a5dde89d354Mathias Agopian // when this function returns). 120a47f02afb1e1f2c4abd9379c13903a5dde89d354Mathias Agopian // Doesn't take ownership of the native_handle. 121a47f02afb1e1f2c4abd9379c13903a5dde89d354Mathias Agopian status_t writeNativeHandle(const native_handle* handle); 122edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 123edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // Place a file descriptor into the parcel. The given fd must remain 124edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // valid for the lifetime of the parcel. 12593ff1f985e233fe04412a65041e977c9f0c21f5bJeff Brown // The Parcel does not take ownership of the given fd unless you ask it to. 12693ff1f985e233fe04412a65041e977c9f0c21f5bJeff Brown status_t writeFileDescriptor(int fd, bool takeOwnership = false); 127edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 128edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // Place a file descriptor into the parcel. A dup of the fd is made, which 129edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // will be closed once the parcel is destroyed. 130edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeDupFileDescriptor(int fd); 1315707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown 132cbe36fe1ec21e22e6649d47144c91260ba51d753Mike Lockwood // Writes a raw fd and optional comm channel fd to the parcel as a ParcelFileDescriptor. 133cbe36fe1ec21e22e6649d47144c91260ba51d753Mike Lockwood // A dup's of the fds are made, which will be closed once the parcel is destroyed. 134cbe36fe1ec21e22e6649d47144c91260ba51d753Mike Lockwood // Null values are passed as -1. 135cbe36fe1ec21e22e6649d47144c91260ba51d753Mike Lockwood status_t writeParcelFileDescriptor(int fd, int commChannel = -1); 136cbe36fe1ec21e22e6649d47144c91260ba51d753Mike Lockwood 1375707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown // Writes a blob to the parcel. 1385707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown // If the blob is small, then it is stored in-place, otherwise it is 1395707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown // transferred by way of an anonymous shared memory region. 1405707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown // The caller should call release() on the blob after writing its contents. 1415707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown status_t writeBlob(size_t len, WritableBlob* outBlob); 1425707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown 143edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeObject(const flat_binder_object& val, bool nullMetaData); 144edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 145837a0d0fb2c3fba8082d47d04cb6120af1eb9a54Brad Fitzpatrick // Like Parcel.java's writeNoException(). Just writes a zero int32. 146837a0d0fb2c3fba8082d47d04cb6120af1eb9a54Brad Fitzpatrick // Currently the native implementation doesn't do any of the StrictMode 147837a0d0fb2c3fba8082d47d04cb6120af1eb9a54Brad Fitzpatrick // stack gathering and serialization that the Java implementation does. 148837a0d0fb2c3fba8082d47d04cb6120af1eb9a54Brad Fitzpatrick status_t writeNoException(); 149837a0d0fb2c3fba8082d47d04cb6120af1eb9a54Brad Fitzpatrick 150edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void remove(size_t start, size_t amt); 151edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 152edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t read(void* outData, size_t len) const; 153edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const void* readInplace(size_t len) const; 154edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project int32_t readInt32() const; 155edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t readInt32(int32_t *pArg) const; 15641a0f2f86c0ca7d2fef50aef6215987f445a7231Dan Stoza uint32_t readUint32() const; 15741a0f2f86c0ca7d2fef50aef6215987f445a7231Dan Stoza status_t readUint32(uint32_t *pArg) const; 158edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project int64_t readInt64() const; 159edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t readInt64(int64_t *pArg) const; 160edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project float readFloat() const; 161edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t readFloat(float *pArg) const; 162edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project double readDouble() const; 163edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t readDouble(double *pArg) const; 16484a6d041e2c69d4d0b69269a0b59e725c9f119a3Andreas Huber intptr_t readIntPtr() const; 16584a6d041e2c69d4d0b69269a0b59e725c9f119a3Andreas Huber status_t readIntPtr(intptr_t *pArg) const; 166edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 167edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const char* readCString() const; 168edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project String8 readString8() const; 169edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project String16 readString16() const; 170edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const char16_t* readString16Inplace(size_t* outLen) const; 171edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project sp<IBinder> readStrongBinder() const; 172edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project wp<IBinder> readWeakBinder() const; 173e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian 174e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian template<typename T> 175e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian status_t read(Flattenable<T>& val) const; 176837a0d0fb2c3fba8082d47d04cb6120af1eb9a54Brad Fitzpatrick 1778683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian template<typename T> 1788683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian status_t read(LightFlattenable<T>& val) const; 1798683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian 180837a0d0fb2c3fba8082d47d04cb6120af1eb9a54Brad Fitzpatrick // Like Parcel.java's readExceptionCode(). Reads the first int32 181837a0d0fb2c3fba8082d47d04cb6120af1eb9a54Brad Fitzpatrick // off of a Parcel's header, returning 0 or the negative error 182837a0d0fb2c3fba8082d47d04cb6120af1eb9a54Brad Fitzpatrick // code on exceptions, but also deals with skipping over rich 183837a0d0fb2c3fba8082d47d04cb6120af1eb9a54Brad Fitzpatrick // response headers. Callers should use this to read & parse the 184837a0d0fb2c3fba8082d47d04cb6120af1eb9a54Brad Fitzpatrick // response headers rather than doing it by hand. 185837a0d0fb2c3fba8082d47d04cb6120af1eb9a54Brad Fitzpatrick int32_t readExceptionCode() const; 186837a0d0fb2c3fba8082d47d04cb6120af1eb9a54Brad Fitzpatrick 187a47f02afb1e1f2c4abd9379c13903a5dde89d354Mathias Agopian // Retrieve native_handle from the parcel. This returns a copy of the 188a47f02afb1e1f2c4abd9379c13903a5dde89d354Mathias Agopian // parcel's native_handle (the caller takes ownership). The caller 189a47f02afb1e1f2c4abd9379c13903a5dde89d354Mathias Agopian // must free the native_handle with native_handle_close() and 190a47f02afb1e1f2c4abd9379c13903a5dde89d354Mathias Agopian // native_handle_delete(). 191a47f02afb1e1f2c4abd9379c13903a5dde89d354Mathias Agopian native_handle* readNativeHandle() const; 192edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 193edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 194edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // Retrieve a file descriptor from the parcel. This returns the raw fd 195edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // in the parcel, which you do not own -- use dup() to get your own copy. 196edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project int readFileDescriptor() const; 1975707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown 198cbe36fe1ec21e22e6649d47144c91260ba51d753Mike Lockwood // Reads a ParcelFileDescriptor from the parcel. Returns the raw fd as 199cbe36fe1ec21e22e6649d47144c91260ba51d753Mike Lockwood // the result, and the optional comm channel fd in outCommChannel. 200cbe36fe1ec21e22e6649d47144c91260ba51d753Mike Lockwood // Null values are returned as -1. 201cbe36fe1ec21e22e6649d47144c91260ba51d753Mike Lockwood int readParcelFileDescriptor(int& outCommChannel) const; 202cbe36fe1ec21e22e6649d47144c91260ba51d753Mike Lockwood 2035707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown // Reads a blob from the parcel. 2045707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown // The caller should call release() on the blob after reading its contents. 2055707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown status_t readBlob(size_t len, ReadableBlob* outBlob) const; 2065707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown 207edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const flat_binder_object* readObject(bool nullMetaData) const; 208edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 209edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // Explicitly close all file descriptors in the parcel. 210edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void closeFileDescriptors(); 211edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 21284e625ac1e01f5a9c3ed16664da6498212ed662bArve Hjønnevågprivate: 213edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project typedef void (*release_func)(Parcel* parcel, 214edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const uint8_t* data, size_t dataSize, 21584e625ac1e01f5a9c3ed16664da6498212ed662bArve Hjønnevåg const binder_size_t* objects, size_t objectsSize, 216edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void* cookie); 217edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 21884e625ac1e01f5a9c3ed16664da6498212ed662bArve Hjønnevåg uintptr_t ipcData() const; 219edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project size_t ipcDataSize() const; 22084e625ac1e01f5a9c3ed16664da6498212ed662bArve Hjønnevåg uintptr_t ipcObjects() const; 221edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project size_t ipcObjectsCount() const; 222edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void ipcSetDataReference(const uint8_t* data, size_t dataSize, 22384e625ac1e01f5a9c3ed16664da6498212ed662bArve Hjønnevåg const binder_size_t* objects, size_t objectsCount, 224edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project release_func relFunc, void* relCookie); 225edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 22684e625ac1e01f5a9c3ed16664da6498212ed662bArve Hjønnevågpublic: 227edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void print(TextOutput& to, uint32_t flags = 0) const; 2285707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown 229edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectprivate: 230edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project Parcel(const Parcel& o); 231edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project Parcel& operator=(const Parcel& o); 232edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 233edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t finishWrite(size_t len); 234edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void releaseObjects(); 235edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void acquireObjects(); 236edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t growData(size_t len); 237edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t restartWrite(size_t desired); 238edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t continueWrite(size_t desired); 239f683e0163a84d93448b9388126902242367cd961Serban Constantinescu status_t writePointer(uintptr_t val); 240f683e0163a84d93448b9388126902242367cd961Serban Constantinescu status_t readPointer(uintptr_t *pArg) const; 241f683e0163a84d93448b9388126902242367cd961Serban Constantinescu uintptr_t readPointer() const; 242edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void freeDataNoInit(); 243edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void initState(); 244edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void scanForFds() const; 245edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 24684a6d041e2c69d4d0b69269a0b59e725c9f119a3Andreas Huber template<class T> 24784a6d041e2c69d4d0b69269a0b59e725c9f119a3Andreas Huber status_t readAligned(T *pArg) const; 24884a6d041e2c69d4d0b69269a0b59e725c9f119a3Andreas Huber 24984a6d041e2c69d4d0b69269a0b59e725c9f119a3Andreas Huber template<class T> T readAligned() const; 25084a6d041e2c69d4d0b69269a0b59e725c9f119a3Andreas Huber 25184a6d041e2c69d4d0b69269a0b59e725c9f119a3Andreas Huber template<class T> 25284a6d041e2c69d4d0b69269a0b59e725c9f119a3Andreas Huber status_t writeAligned(T val); 25384a6d041e2c69d4d0b69269a0b59e725c9f119a3Andreas Huber 254edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t mError; 255edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project uint8_t* mData; 256edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project size_t mDataSize; 257edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project size_t mDataCapacity; 258edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project mutable size_t mDataPos; 25984e625ac1e01f5a9c3ed16664da6498212ed662bArve Hjønnevåg binder_size_t* mObjects; 260edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project size_t mObjectsSize; 261edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project size_t mObjectsCapacity; 262edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project mutable size_t mNextObjectHint; 263edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 264edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project mutable bool mFdsKnown; 265edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project mutable bool mHasFds; 2668938ed2c8e906fc332301b64787728d4d34da571Dianne Hackborn bool mAllowFds; 267edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 268edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project release_func mOwner; 269edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void* mOwnerCookie; 2705707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown 2715707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown class Blob { 2725707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown public: 2735707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown Blob(); 2745707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown ~Blob(); 2755707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown 2765707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown void release(); 2775707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown inline size_t size() const { return mSize; } 2785707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown 2795707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown protected: 2805707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown void init(bool mapped, void* data, size_t size); 2815707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown void clear(); 2825707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown 2835707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown bool mMapped; 2845707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown void* mData; 2855707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown size_t mSize; 2865707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown }; 2875707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown 288e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian class FlattenableHelperInterface { 289e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian protected: 290e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian ~FlattenableHelperInterface() { } 291e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian public: 292e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian virtual size_t getFlattenedSize() const = 0; 293e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian virtual size_t getFdCount() const = 0; 294e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian virtual status_t flatten(void* buffer, size_t size, int* fds, size_t count) const = 0; 295e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian virtual status_t unflatten(void const* buffer, size_t size, int const* fds, size_t count) = 0; 296e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian }; 297e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian 298e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian template<typename T> 299e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian class FlattenableHelper : public FlattenableHelperInterface { 300e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian friend class Parcel; 301e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian const Flattenable<T>& val; 302e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian explicit FlattenableHelper(const Flattenable<T>& val) : val(val) { } 303e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian 304e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian public: 305e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian virtual size_t getFlattenedSize() const { 306e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian return val.getFlattenedSize(); 307e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian } 308e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian virtual size_t getFdCount() const { 309e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian return val.getFdCount(); 310e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian } 311e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian virtual status_t flatten(void* buffer, size_t size, int* fds, size_t count) const { 312e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian return val.flatten(buffer, size, fds, count); 313e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian } 314e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian virtual status_t unflatten(void const* buffer, size_t size, int const* fds, size_t count) { 315e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian return const_cast<Flattenable<T>&>(val).unflatten(buffer, size, fds, count); 316e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian } 317e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian }; 318e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian status_t write(const FlattenableHelperInterface& val); 319e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian status_t read(FlattenableHelperInterface& val) const; 320e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian 3215707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brownpublic: 3225707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown class ReadableBlob : public Blob { 3235707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown friend class Parcel; 3245707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown public: 3255707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown inline const void* data() const { return mData; } 3265707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown }; 3275707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown 3285707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown class WritableBlob : public Blob { 3295707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown friend class Parcel; 3305707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown public: 3315707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown inline void* data() { return mData; } 3325707dbf15d0b44c88fbaa6dd271097f2d42932e0Jeff Brown }; 333edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project}; 334edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 335edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project// --------------------------------------------------------------------------- 336edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 3378683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopiantemplate<typename T> 338e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopianstatus_t Parcel::write(const Flattenable<T>& val) { 339e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian const FlattenableHelper<T> helper(val); 340e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian return write(helper); 341e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian} 342e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian 343e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopiantemplate<typename T> 3448683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopianstatus_t Parcel::write(const LightFlattenable<T>& val) { 345e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian size_t size(val.getFlattenedSize()); 3468683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian if (!val.isFixedSize()) { 3478683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian status_t err = writeInt32(size); 3488683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian if (err != NO_ERROR) { 3498683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian return err; 3508683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian } 3518683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian } 3522098517e3e12a401005d7a7510d6c4943707b98dMathias Agopian if (size) { 3532098517e3e12a401005d7a7510d6c4943707b98dMathias Agopian void* buffer = writeInplace(size); 354e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian if (buffer == NULL) 355e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian return NO_MEMORY; 356e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian return val.flatten(buffer, size); 3572098517e3e12a401005d7a7510d6c4943707b98dMathias Agopian } 3582098517e3e12a401005d7a7510d6c4943707b98dMathias Agopian return NO_ERROR; 3598683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian} 3608683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian 3618683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopiantemplate<typename T> 362e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopianstatus_t Parcel::read(Flattenable<T>& val) const { 363e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian FlattenableHelper<T> helper(val); 364e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian return read(helper); 365e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian} 366e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian 367e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopiantemplate<typename T> 3688683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopianstatus_t Parcel::read(LightFlattenable<T>& val) const { 3698683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian size_t size; 3708683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian if (val.isFixedSize()) { 371e142428a9c8b9d2380032cd4d7b55ee440fe8770Mathias Agopian size = val.getFlattenedSize(); 3728683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian } else { 3738683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian int32_t s; 3748683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian status_t err = readInt32(&s); 3758683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian if (err != NO_ERROR) { 3768683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian return err; 3778683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian } 3788683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian size = s; 3798683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian } 3802098517e3e12a401005d7a7510d6c4943707b98dMathias Agopian if (size) { 3812098517e3e12a401005d7a7510d6c4943707b98dMathias Agopian void const* buffer = readInplace(size); 3822098517e3e12a401005d7a7510d6c4943707b98dMathias Agopian return buffer == NULL ? NO_MEMORY : 3832098517e3e12a401005d7a7510d6c4943707b98dMathias Agopian val.unflatten(buffer, size); 3842098517e3e12a401005d7a7510d6c4943707b98dMathias Agopian } 3852098517e3e12a401005d7a7510d6c4943707b98dMathias Agopian return NO_ERROR; 3868683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian} 3878683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian 3888683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian// --------------------------------------------------------------------------- 3898683fca395d01734ec7946e9f0595ec5d7b754c6Mathias Agopian 390edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectinline TextOutput& operator<<(TextOutput& to, const Parcel& parcel) 391edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project{ 392edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project parcel.print(to); 393edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project return to; 394edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project} 395edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 396edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project// --------------------------------------------------------------------------- 397edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 398edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project// Generic acquire and release of objects. 399edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectvoid acquire_object(const sp<ProcessState>& proc, 400edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const flat_binder_object& obj, const void* who); 401edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectvoid release_object(const sp<ProcessState>& proc, 402edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const flat_binder_object& obj, const void* who); 403edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 404edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectvoid flatten_binder(const sp<ProcessState>& proc, 405edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const sp<IBinder>& binder, flat_binder_object* out); 406edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectvoid flatten_binder(const sp<ProcessState>& proc, 407edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const wp<IBinder>& binder, flat_binder_object* out); 408edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectstatus_t unflatten_binder(const sp<ProcessState>& proc, 409edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const flat_binder_object& flat, sp<IBinder>* out); 410edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectstatus_t unflatten_binder(const sp<ProcessState>& proc, 411edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const flat_binder_object& flat, wp<IBinder>* out); 412edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 413edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project}; // namespace android 414edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 415edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project// --------------------------------------------------------------------------- 416edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 417edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#endif // ANDROID_PARCEL_H 418