xref: /aosp_15_r20/system/libfmq/include/fmq/AidlMQDescriptorShim.h (revision be431cd81a9a2349eaea34eb56fcf6d1608da596)
1*be431cd8SAndroid Build Coastguard Worker /*
2*be431cd8SAndroid Build Coastguard Worker  * Copyright (C) 2020 The Android Open Source Project
3*be431cd8SAndroid Build Coastguard Worker  *
4*be431cd8SAndroid Build Coastguard Worker  * Licensed under the Apache License, Version 2.0 (the "License");
5*be431cd8SAndroid Build Coastguard Worker  * you may not use this file except in compliance with the License.
6*be431cd8SAndroid Build Coastguard Worker  * You may obtain a copy of the License at
7*be431cd8SAndroid Build Coastguard Worker  *
8*be431cd8SAndroid Build Coastguard Worker  *      http://www.apache.org/licenses/LICENSE-2.0
9*be431cd8SAndroid Build Coastguard Worker  *
10*be431cd8SAndroid Build Coastguard Worker  * Unless required by applicable law or agreed to in writing, software
11*be431cd8SAndroid Build Coastguard Worker  * distributed under the License is distributed on an "AS IS" BASIS,
12*be431cd8SAndroid Build Coastguard Worker  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*be431cd8SAndroid Build Coastguard Worker  * See the License for the specific language governing permissions and
14*be431cd8SAndroid Build Coastguard Worker  * limitations under the License.
15*be431cd8SAndroid Build Coastguard Worker  */
16*be431cd8SAndroid Build Coastguard Worker #pragma once
17*be431cd8SAndroid Build Coastguard Worker #include <cutils/native_handle.h>
18*be431cd8SAndroid Build Coastguard Worker #include <limits>
19*be431cd8SAndroid Build Coastguard Worker #include <type_traits>
20*be431cd8SAndroid Build Coastguard Worker 
21*be431cd8SAndroid Build Coastguard Worker #include <aidl/android/hardware/common/fmq/MQDescriptor.h>
22*be431cd8SAndroid Build Coastguard Worker #include <fmq/MQDescriptorBase.h>
23*be431cd8SAndroid Build Coastguard Worker #include "AidlMQDescriptorShimBase.h"
24*be431cd8SAndroid Build Coastguard Worker 
25*be431cd8SAndroid Build Coastguard Worker namespace android {
26*be431cd8SAndroid Build Coastguard Worker namespace details {
27*be431cd8SAndroid Build Coastguard Worker using aidl::android::hardware::common::fmq::MQDescriptor;
28*be431cd8SAndroid Build Coastguard Worker using aidl::android::hardware::common::fmq::SynchronizedReadWrite;
29*be431cd8SAndroid Build Coastguard Worker using aidl::android::hardware::common::fmq::UnsynchronizedWrite;
30*be431cd8SAndroid Build Coastguard Worker using android::hardware::MQFlavor;
31*be431cd8SAndroid Build Coastguard Worker 
32*be431cd8SAndroid Build Coastguard Worker struct BackendTypesStore {
33*be431cd8SAndroid Build Coastguard Worker     template <typename T, typename flavor>
34*be431cd8SAndroid Build Coastguard Worker     using MQDescriptorType = aidl::android::hardware::common::fmq::MQDescriptor<T, flavor>;
35*be431cd8SAndroid Build Coastguard Worker     using SynchronizedReadWriteType = aidl::android::hardware::common::fmq::SynchronizedReadWrite;
36*be431cd8SAndroid Build Coastguard Worker     using UnsynchronizedWriteType = aidl::android::hardware::common::fmq::UnsynchronizedWrite;
37*be431cd8SAndroid Build Coastguard Worker };
38*be431cd8SAndroid Build Coastguard Worker 
39*be431cd8SAndroid Build Coastguard Worker template <typename T, MQFlavor flavor>
40*be431cd8SAndroid Build Coastguard Worker struct AidlMQDescriptorShim : public AidlMQDescriptorShimBase<T, flavor, BackendTypesStore> {
41*be431cd8SAndroid Build Coastguard Worker     // Takes ownership of handle
42*be431cd8SAndroid Build Coastguard Worker     AidlMQDescriptorShim(const std::vector<android::hardware::GrantorDescriptor>& grantors,
43*be431cd8SAndroid Build Coastguard Worker                          native_handle_t* nHandle, size_t size);
44*be431cd8SAndroid Build Coastguard Worker 
45*be431cd8SAndroid Build Coastguard Worker     // Takes ownership of handle
46*be431cd8SAndroid Build Coastguard Worker     AidlMQDescriptorShim(
47*be431cd8SAndroid Build Coastguard Worker             const MQDescriptor<
48*be431cd8SAndroid Build Coastguard Worker                     T, typename std::conditional<flavor == hardware::kSynchronizedReadWrite,
49*be431cd8SAndroid Build Coastguard Worker                                                  SynchronizedReadWrite, UnsynchronizedWrite>::type>&
50*be431cd8SAndroid Build Coastguard Worker                     desc);
51*be431cd8SAndroid Build Coastguard Worker 
52*be431cd8SAndroid Build Coastguard Worker     // Takes ownership of handle
53*be431cd8SAndroid Build Coastguard Worker     AidlMQDescriptorShim(size_t bufferSize, native_handle_t* nHandle, size_t messageSize,
54*be431cd8SAndroid Build Coastguard Worker                          bool configureEventFlag = false);
55*be431cd8SAndroid Build Coastguard Worker 
AidlMQDescriptorShimAidlMQDescriptorShim56*be431cd8SAndroid Build Coastguard Worker     explicit AidlMQDescriptorShim(const AidlMQDescriptorShim& other)
57*be431cd8SAndroid Build Coastguard Worker         : AidlMQDescriptorShim(0, nullptr, 0) {
58*be431cd8SAndroid Build Coastguard Worker         *this = other;
59*be431cd8SAndroid Build Coastguard Worker     }
60*be431cd8SAndroid Build Coastguard Worker };
61*be431cd8SAndroid Build Coastguard Worker 
62*be431cd8SAndroid Build Coastguard Worker template <typename T, MQFlavor flavor>
AidlMQDescriptorShim(const MQDescriptor<T,typename std::conditional<flavor==hardware::kSynchronizedReadWrite,SynchronizedReadWrite,UnsynchronizedWrite>::type> & desc)63*be431cd8SAndroid Build Coastguard Worker AidlMQDescriptorShim<T, flavor>::AidlMQDescriptorShim(
64*be431cd8SAndroid Build Coastguard Worker         const MQDescriptor<T, typename std::conditional<flavor == hardware::kSynchronizedReadWrite,
65*be431cd8SAndroid Build Coastguard Worker                                                         SynchronizedReadWrite,
66*be431cd8SAndroid Build Coastguard Worker                                                         UnsynchronizedWrite>::type>& desc)
67*be431cd8SAndroid Build Coastguard Worker     : AidlMQDescriptorShimBase<T, flavor, BackendTypesStore>(desc) {}
68*be431cd8SAndroid Build Coastguard Worker 
69*be431cd8SAndroid Build Coastguard Worker template <typename T, MQFlavor flavor>
AidlMQDescriptorShim(const std::vector<android::hardware::GrantorDescriptor> & grantors,native_handle_t * nhandle,size_t size)70*be431cd8SAndroid Build Coastguard Worker AidlMQDescriptorShim<T, flavor>::AidlMQDescriptorShim(
71*be431cd8SAndroid Build Coastguard Worker         const std::vector<android::hardware::GrantorDescriptor>& grantors, native_handle_t* nhandle,
72*be431cd8SAndroid Build Coastguard Worker         size_t size)
73*be431cd8SAndroid Build Coastguard Worker     : AidlMQDescriptorShimBase<T, flavor, BackendTypesStore>(grantors, nhandle, size) {}
74*be431cd8SAndroid Build Coastguard Worker 
75*be431cd8SAndroid Build Coastguard Worker template <typename T, MQFlavor flavor>
AidlMQDescriptorShim(size_t bufferSize,native_handle_t * nHandle,size_t messageSize,bool configureEventFlag)76*be431cd8SAndroid Build Coastguard Worker AidlMQDescriptorShim<T, flavor>::AidlMQDescriptorShim(size_t bufferSize, native_handle_t* nHandle,
77*be431cd8SAndroid Build Coastguard Worker                                                       size_t messageSize, bool configureEventFlag)
78*be431cd8SAndroid Build Coastguard Worker     : AidlMQDescriptorShimBase<T, flavor, BackendTypesStore>(bufferSize, nHandle, messageSize,
79*be431cd8SAndroid Build Coastguard Worker                                                              configureEventFlag) {}
80*be431cd8SAndroid Build Coastguard Worker }  // namespace details
81*be431cd8SAndroid Build Coastguard Worker }  // namespace android
82