Parcel.h revision edbf3b6af777b721cd2a1ef461947e51e88241e1
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> 25edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 26edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project// --------------------------------------------------------------------------- 27edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectnamespace android { 28edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 29edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectclass IBinder; 30edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectclass ProcessState; 31edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectclass String8; 32edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectclass TextOutput; 33edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 34edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectstruct flat_binder_object; // defined in support_p/binder_module.h 35edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 36edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectclass Parcel 37edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project{ 38edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectpublic: 39edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project Parcel(); 40edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project ~Parcel(); 41edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 42edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const uint8_t* data() const; 43edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project size_t dataSize() const; 44edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project size_t dataAvail() const; 45edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project size_t dataPosition() const; 46edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project size_t dataCapacity() const; 47edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 48edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t setDataSize(size_t size); 49edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void setDataPosition(size_t pos) const; 50edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t setDataCapacity(size_t size); 51edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 52edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t setData(const uint8_t* buffer, size_t len); 53edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 54edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t appendFrom(Parcel *parcel, size_t start, size_t len); 55edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 56edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project bool hasFileDescriptors() const; 57edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 58edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeInterfaceToken(const String16& interface); 59edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project bool enforceInterface(const String16& interface) const; 60edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 61edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void freeData(); 62edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 63edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const size_t* objects() const; 64edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project size_t objectsCount() const; 65edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 66edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t errorCheck() const; 67edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void setError(status_t err); 68edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 69edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t write(const void* data, size_t len); 70edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void* writeInplace(size_t len); 71edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeUnpadded(const void* data, size_t len); 72edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeInt32(int32_t val); 73edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeInt64(int64_t val); 74edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeFloat(float val); 75edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeDouble(double val); 76edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeCString(const char* str); 77edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeString8(const String8& str); 78edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeString16(const String16& str); 79edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeString16(const char16_t* str, size_t len); 80edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeStrongBinder(const sp<IBinder>& val); 81edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeWeakBinder(const wp<IBinder>& val); 82edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 83edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // doesn't take ownership of the native_handle 84edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeNativeHandle(const native_handle& handle); 85edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 86edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // Place a file descriptor into the parcel. The given fd must remain 87edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // valid for the lifetime of the parcel. 88edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeFileDescriptor(int fd); 89edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 90edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // Place a file descriptor into the parcel. A dup of the fd is made, which 91edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // will be closed once the parcel is destroyed. 92edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeDupFileDescriptor(int fd); 93edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 94edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t writeObject(const flat_binder_object& val, bool nullMetaData); 95edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 96edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void remove(size_t start, size_t amt); 97edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 98edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t read(void* outData, size_t len) const; 99edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const void* readInplace(size_t len) const; 100edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project int32_t readInt32() const; 101edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t readInt32(int32_t *pArg) const; 102edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project int64_t readInt64() const; 103edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t readInt64(int64_t *pArg) const; 104edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project float readFloat() const; 105edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t readFloat(float *pArg) const; 106edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project double readDouble() const; 107edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t readDouble(double *pArg) const; 108edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 109edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const char* readCString() const; 110edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project String8 readString8() const; 111edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project String16 readString16() const; 112edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const char16_t* readString16Inplace(size_t* outLen) const; 113edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project sp<IBinder> readStrongBinder() const; 114edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project wp<IBinder> readWeakBinder() const; 115edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 116edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 117edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // if alloc is NULL, native_handle is allocated with malloc(), otherwise 118edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // alloc is used. If the function fails, the effects of alloc() must be 119edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // reverted by the caller. 120edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project native_handle* readNativeHandle( 121edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project native_handle* (*alloc)(void* cookie, int numFds, int ints), 122edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void* cookie) const; 123edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 124edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 125edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // Retrieve a file descriptor from the parcel. This returns the raw fd 126edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // in the parcel, which you do not own -- use dup() to get your own copy. 127edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project int readFileDescriptor() const; 128edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 129edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const flat_binder_object* readObject(bool nullMetaData) const; 130edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 131edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // Explicitly close all file descriptors in the parcel. 132edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void closeFileDescriptors(); 133edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 134edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project typedef void (*release_func)(Parcel* parcel, 135edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const uint8_t* data, size_t dataSize, 136edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const size_t* objects, size_t objectsSize, 137edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void* cookie); 138edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 139edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const uint8_t* ipcData() const; 140edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project size_t ipcDataSize() const; 141edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const size_t* ipcObjects() const; 142edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project size_t ipcObjectsCount() const; 143edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void ipcSetDataReference(const uint8_t* data, size_t dataSize, 144edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const size_t* objects, size_t objectsCount, 145edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project release_func relFunc, void* relCookie); 146edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 147edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void print(TextOutput& to, uint32_t flags = 0) const; 148edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 149edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectprivate: 150edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project Parcel(const Parcel& o); 151edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project Parcel& operator=(const Parcel& o); 152edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 153edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t finishWrite(size_t len); 154edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void releaseObjects(); 155edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void acquireObjects(); 156edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t growData(size_t len); 157edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t restartWrite(size_t desired); 158edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t continueWrite(size_t desired); 159edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void freeDataNoInit(); 160edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void initState(); 161edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void scanForFds() const; 162edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 163edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project status_t mError; 164edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project uint8_t* mData; 165edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project size_t mDataSize; 166edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project size_t mDataCapacity; 167edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project mutable size_t mDataPos; 168edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project size_t* mObjects; 169edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project size_t mObjectsSize; 170edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project size_t mObjectsCapacity; 171edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project mutable size_t mNextObjectHint; 172edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 173edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project mutable bool mFdsKnown; 174edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project mutable bool mHasFds; 175edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 176edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project release_func mOwner; 177edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void* mOwnerCookie; 178edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project}; 179edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 180edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project// --------------------------------------------------------------------------- 181edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 182edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectinline TextOutput& operator<<(TextOutput& to, const Parcel& parcel) 183edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project{ 184edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project parcel.print(to); 185edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project return to; 186edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project} 187edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 188edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project// --------------------------------------------------------------------------- 189edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 190edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project// Generic acquire and release of objects. 191edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectvoid acquire_object(const sp<ProcessState>& proc, 192edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const flat_binder_object& obj, const void* who); 193edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectvoid release_object(const sp<ProcessState>& proc, 194edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const flat_binder_object& obj, const void* who); 195edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 196edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectvoid flatten_binder(const sp<ProcessState>& proc, 197edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const sp<IBinder>& binder, flat_binder_object* out); 198edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectvoid flatten_binder(const sp<ProcessState>& proc, 199edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const wp<IBinder>& binder, flat_binder_object* out); 200edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectstatus_t unflatten_binder(const sp<ProcessState>& proc, 201edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const flat_binder_object& flat, sp<IBinder>* out); 202edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectstatus_t unflatten_binder(const sp<ProcessState>& proc, 203edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const flat_binder_object& flat, wp<IBinder>* out); 204edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 205edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project}; // namespace android 206edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 207edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project// --------------------------------------------------------------------------- 208edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 209edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#endif // ANDROID_PARCEL_H 210