Allow various kinds of MQDescriptor.
The various kinds of MQDescriptor will be recognized
by hidl-gen.
Bug: 31550963
Test: Built and run FMQ unit tests and benchmarks
Change-Id: I994c16e764e454d1d9390a68bb4aa2145a89fb43
diff --git a/include/hidl/MQDescriptor.h b/include/hidl/MQDescriptor.h
index c01a902..a3cfeb2 100644
--- a/include/hidl/MQDescriptor.h
+++ b/include/hidl/MQDescriptor.h
@@ -34,12 +34,22 @@
size_t extent;
};
+enum MQFlavor : uint32_t {
+ /*
+ * kSynchronizedReadWrite represents the wait-free synchronized flavor of the
+ * FMQ. It is intended to be have a single reader and single writer.
+ * Attempts to overflow/underflow returns a failure.
+ */
+ kSynchronizedReadWrite = 0x01
+};
+
+template <MQFlavor flavor>
struct MQDescriptor {
MQDescriptor(
const std::vector<GrantorDescriptor>& grantors,
- native_handle_t* nHandle, int32_t flags, size_t size);
+ native_handle_t* nHandle, size_t size);
- MQDescriptor(size_t bufferSize, native_handle_t* nHandle, int32_t flags,
+ MQDescriptor(size_t bufferSize, native_handle_t* nHandle,
size_t messageSize);
~MQDescriptor();
@@ -73,13 +83,174 @@
*/
static constexpr int32_t kMinGrantorCount = 3;
enum GrantorType : int { READPTRPOS = 0, WRITEPTRPOS, DATAPTRPOS };
-
private:
::android::hardware::hidl_vec<GrantorDescriptor> mGrantors;
::native_handle_t *mHandle;
uint32_t mQuantum;
uint32_t mFlags;
};
+
+/*
+ * MQDescriptorSync will describe the wait-free synchronized
+ * flavor of FMQ.
+ */
+using MQDescriptorSync = MQDescriptor<kSynchronizedReadWrite>;
+
+template<MQFlavor flavor>
+MQDescriptor<flavor>::MQDescriptor(
+ const std::vector<GrantorDescriptor>& grantors,
+ native_handle_t* nhandle,
+ size_t size)
+ : mHandle(nhandle),
+ mQuantum(size),
+ mFlags(flavor) {
+ mGrantors.resize(grantors.size());
+ for (size_t i = 0; i < grantors.size(); ++i) {
+ mGrantors[i] = grantors[i];
+ }
+}
+
+template<MQFlavor flavor>
+MQDescriptor<flavor>::MQDescriptor(size_t bufferSize, native_handle_t *nHandle,
+ size_t messageSize)
+ : mHandle(nHandle), mQuantum(messageSize), mFlags(flavor) {
+ mGrantors.resize(kMinGrantorCount);
+ /*
+ * Create a default grantor descriptor for read, write pointers and
+ * the data buffer. fdIndex parameter is set to 0 by default and
+ * the offset for each grantor is contiguous.
+ */
+ mGrantors[READPTRPOS] = {
+ 0 /* grantor flags */, 0 /* fdIndex */, 0 /* offset */,
+ sizeof(RingBufferPosition) /* extent */
+ };
+
+ mGrantors[WRITEPTRPOS] = {
+ 0 /* grantor flags */,
+ 0 /* fdIndex */,
+ sizeof(RingBufferPosition) /* offset */,
+ sizeof(RingBufferPosition) /* extent */
+ };
+ mGrantors[DATAPTRPOS] = {
+ 0 /* grantor flags */, 0 /* fdIndex */,
+ 2 * sizeof(RingBufferPosition) /* offset */, bufferSize /* extent */
+ };
+}
+
+template<MQFlavor flavor>
+MQDescriptor<flavor>::MQDescriptor(const MQDescriptor<flavor> &other)
+ : mGrantors(other.mGrantors),
+ mHandle(nullptr),
+ mQuantum(other.mQuantum),
+ mFlags(other.mFlags) {
+ if (other.mHandle != nullptr) {
+ mHandle = native_handle_create(
+ other.mHandle->numFds, other.mHandle->numInts);
+
+ for (int i = 0; i < other.mHandle->numFds; ++i) {
+ const_cast<native_handle_t *>(mHandle)->data[i] =
+ dup(other.mHandle->data[i]);
+ }
+
+ memcpy(&const_cast<native_handle_t *>(mHandle)->data[other.mHandle->numFds],
+ &other.mHandle->data[other.mHandle->numFds],
+ other.mHandle->numInts * sizeof(int));
+ }
+}
+
+template<MQFlavor flavor>
+MQDescriptor<flavor>::~MQDescriptor() {
+ if (mHandle != nullptr) {
+ native_handle_close(const_cast<native_handle_t *>(mHandle));
+ native_handle_delete(const_cast<native_handle_t *>(mHandle));
+ }
+}
+
+template<MQFlavor flavor>
+::android::status_t MQDescriptor<flavor>::readEmbeddedFromParcel(
+ const Parcel &parcel,
+ size_t parentHandle,
+ size_t parentOffset) {
+ ::android::status_t _hidl_err = ::android::OK;
+
+ size_t _hidl_grantors_child;
+
+ _hidl_err = const_cast<hidl_vec<GrantorDescriptor> *>(
+ &mGrantors)->readEmbeddedFromParcel(
+ parcel,
+ parentHandle,
+ parentOffset + offsetof(MQDescriptor, mGrantors),
+ &_hidl_grantors_child);
+
+ if (_hidl_err != ::android::OK) { return _hidl_err; }
+
+ const native_handle_t *_hidl_mq_handle_ptr = parcel.readEmbeddedNativeHandle(
+ parentHandle,
+ parentOffset + offsetof(MQDescriptor, mHandle));
+
+ if (_hidl_mq_handle_ptr == nullptr) {
+ _hidl_err = ::android::UNKNOWN_ERROR;
+ return _hidl_err;
+ }
+
+ return _hidl_err;
+}
+
+template<MQFlavor flavor>
+::android::status_t MQDescriptor<flavor>::writeEmbeddedToParcel(
+ Parcel *parcel,
+ size_t parentHandle,
+ size_t parentOffset) const {
+ ::android::status_t _hidl_err = ::android::OK;
+
+ size_t _hidl_grantors_child;
+
+ _hidl_err = mGrantors.writeEmbeddedToParcel(
+ parcel,
+ parentHandle,
+ parentOffset + offsetof(MQDescriptor, mGrantors),
+ &_hidl_grantors_child);
+
+ if (_hidl_err != ::android::OK) { return _hidl_err; }
+
+ _hidl_err = parcel->writeEmbeddedNativeHandle(
+ mHandle,
+ parentHandle,
+ parentOffset + offsetof(MQDescriptor, mHandle));
+
+ if (_hidl_err != ::android::OK) { return _hidl_err; }
+
+ return _hidl_err;
+}
+
+template<MQFlavor flavor>
+size_t MQDescriptor<flavor>::getSize() const {
+ return mGrantors[DATAPTRPOS].extent;
+}
+
+template<MQFlavor flavor>
+size_t MQDescriptor<flavor>::getQuantum() const { return mQuantum; }
+
+template<MQFlavor flavor>
+int32_t MQDescriptor<flavor>::getFlags() const { return mFlags; }
+
+template<MQFlavor flavor>
+std::vector<GrantorDescriptor> MQDescriptor<flavor>::getGrantors() const {
+ size_t grantor_count = mGrantors.size();
+ std::vector<GrantorDescriptor> grantors(grantor_count);
+ for (size_t i = 0; i < grantor_count; i++) {
+ grantors[i] = mGrantors[i];
+ }
+ return grantors;
+}
+
+template<MQFlavor flavor>
+const sp<NativeHandle> MQDescriptor<flavor>::getNativeHandle() const {
+ /*
+ * Create an sp<NativeHandle> from mHandle.
+ */
+ return NativeHandle::create(mHandle, false /* ownsHandle */);
+}
} // namespace hardware
} // namespace android