Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 90e1415f authored by Treehugger Robot's avatar Treehugger Robot Committed by Gerrit Code Review
Browse files

Merge changes I695af339,I4d141774 into main 

* changes:
  libaudiohal@aidl: Align ownership of patches with the framework
  libaudiohal@aidl: Enforce thread safety for DeviceHalAidl
parents 20d97e07 78f7f9a5

media/libaudiohal/impl/Android.bp

+1 −0
Original line number Diff line number Diff line
@@ -319,6 +319,7 @@ filegroup { 
        "ConversionHelperAidl.cpp",

        "DeviceHalAidl.cpp",

        "DevicesFactoryHalAidl.cpp",

        "Hal2AidlMapper.cpp",

        "StreamHalAidl.cpp",

    ],

}

media/libaudiohal/impl/Cleanups.h

0 → 100644
+107 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2023 The Android Open Source Project

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */



#pragma once



#include <forward_list>

#include <mutex>

#include <utility>



namespace android {



// This class implements the "monitor" idiom for providing locked access to a class instance.

// This is how it is intended to be used. Let's assume there is a "Main" class which owns

// an instance of a "Resource" class, which is protected by a mutex. We add an instance of

// "LockedAccessor<Resource>" as a member of "Main":

//

// class Resource;

//

// class Main {

//     Main() : mAccessor(mResource, mLock) {}

//   private:

//     std::mutex mLock;

//     Resource mResource GUARDED_BY(mLock);  // owns the resource

//     LockedAccessor<Resource> mAccessor;

// };

//

// The accessor is initialized in the constructor when no locking is needed. The accessor

// defers locking until the resource is accessed.

//

// Although "mAccessor" can be used by the methods of "Main" for scoped access to the resource,

// its main role is for granting access to the resource to other classes. This is achieved by

// making a copy of "mAccessor" and giving it away to another class. This obviously does not

// transfer ownership of the resource. The intent is to allow another class to use the resource

// with proper locking in a "lazy" fashion:

//

// class Another {

//   public:

//     Another(const LockedAccessor<Resource>& accessor) : mAccessor(accessor) {}

//     void doItLater() {  // Use explicit 'lock' / 'unlock'

//         auto resource = mAccessor.lock();

//         resource.use();

//         mAccessor.unlock();

//     }

//     void doItLaterScoped() {  // Rely on the scoped accessor do perform unlocking.

//         LockedAccessor<Resource> scopedAccessor(mAccessor);

//         auto resource = scopedAccessor.lock();

//         resource.use();

//     }

//   private:

//     LockedAccessor<Resource> mAccessor;

// };

//

template<class C>

class LockedAccessor {

  public:

    LockedAccessor(C& instance, std::mutex& mutex)

            : mInstance(instance), mMutex(mutex), mLock(mMutex, std::defer_lock) {}

    LockedAccessor(const LockedAccessor& other)

            : mInstance(other.mInstance), mMutex(other.mMutex), mLock(mMutex, std::defer_lock) {}

    ~LockedAccessor() { if (mLock.owns_lock()) mLock.unlock(); }

    C& lock() { mLock.lock(); return mInstance; }

    void unlock() { mLock.unlock(); }

  private:

    C& mInstance;

    std::mutex& mMutex;

    std::unique_lock<std::mutex> mLock;

};



// This class implements scoped cleanups. A "cleanup" is a call to a method of class "C" which

// takes an integer parameter. Cleanups are executed in the reverse order to how they were added.

// For executing cleanups, the instance of "C" is retrieved via the provided "LockedAccessor".

template<class C>

class Cleanups {

  public:

    typedef void (C::*Cleaner)(int32_t);  // A member function of "C" performing a cleanup action.

    explicit Cleanups(const LockedAccessor<C>& accessor) : mAccessor(accessor) {}

    ~Cleanups() {

        if (!mCleanups.empty()) {

            C& c = mAccessor.lock();

            for (auto& cleanup : mCleanups) (c.*cleanup.first)(cleanup.second);

            mAccessor.unlock();

        }

    }

    void add(Cleaner cleaner, int32_t id) {

        mCleanups.emplace_front(cleaner, id);

    }

    void disarmAll() { mCleanups.clear(); }

  private:

    using Cleanup = std::pair<Cleaner, int32_t>;

    LockedAccessor<C> mAccessor;

    std::forward_list<Cleanup> mCleanups;

};



}  // namespace android

media/libaudiohal/impl/DeviceHalAidl.cpp

+186 −987

File changed.

Preview size limit exceeded, changes collapsed.

media/libaudiohal/impl/DeviceHalAidl.h

+11 −97
Original line number Diff line number Diff line
@@ -17,7 +17,9 @@ 
#pragma once



#include <map>

#include <set>

#include <memory>

#include <mutex>

#include <string>

#include <vector>



#include <aidl/android/media/audio/IHalAdapterVendorExtension.h>
@@ -26,9 +28,10 @@ 
#include <android-base/thread_annotations.h>

#include <media/audiohal/DeviceHalInterface.h>

#include <media/audiohal/EffectHalInterface.h>

#include <media/audiohal/StreamHalInterface.h>



#include "Cleanups.h"

#include "ConversionHelperAidl.h"

#include "Hal2AidlMapper.h"



namespace android {
@@ -194,19 +197,6 @@ class DeviceHalAidl : public DeviceHalInterface, public ConversionHelperAidl, 
        Status status = Status::UNKNOWN;

        MicrophoneInfoProvider::Info info;

    };

    // IDs of ports for connected external devices, and whether they are held by streams.

    using ConnectedPorts = std::map<int32_t /*port ID*/, bool>;

    using Patches = std::map<int32_t /*patch ID*/,

            ::aidl::android::hardware::audio::core::AudioPatch>;

    using PortConfigs = std::map<int32_t /*port config ID*/,

            ::aidl::android::media::audio::common::AudioPortConfig>;

    using Ports = std::map<int32_t /*port ID*/, ::aidl::android::media::audio::common::AudioPort>;

    using Routes = std::vector<::aidl::android::hardware::audio::core::AudioRoute>;

    // Answers the question "whether portID 'first' is reachable from portID 'second'?"

    // It's not a map because both portIDs are known. The matrix is symmetric.

    using RoutingMatrix = std::set<std::pair<int32_t, int32_t>>;

    using Streams = std::map<wp<StreamHalInterface>, int32_t /*patch ID*/>;

    class Cleanups;



    // Must not be constructed directly by clients.

    DeviceHalAidl(
@@ -216,14 +206,6 @@ class DeviceHalAidl : public DeviceHalInterface, public ConversionHelperAidl, 


    ~DeviceHalAidl() override = default;



    bool audioDeviceMatches(const ::aidl::android::media::audio::common::AudioDevice& device,

            const ::aidl::android::media::audio::common::AudioPort& p);

    bool audioDeviceMatches(const ::aidl::android::media::audio::common::AudioDevice& device,

            const ::aidl::android::media::audio::common::AudioPortConfig& p);

    status_t createOrUpdatePortConfig(

            const ::aidl::android::media::audio::common::AudioPortConfig& requestedPortConfig,

            PortConfigs::iterator* result, bool *created);

    void eraseConnectedPort(int32_t portId);

    status_t filterAndRetrieveBtA2dpParameters(AudioParameter &keys, AudioParameter *result);

    status_t filterAndUpdateBtA2dpParameters(AudioParameter &parameters);

    status_t filterAndUpdateBtHfpParameters(AudioParameter &parameters);
@@ -231,60 +213,6 @@ class DeviceHalAidl : public DeviceHalInterface, public ConversionHelperAidl, 
    status_t filterAndUpdateBtScoParameters(AudioParameter &parameters);

    status_t filterAndUpdateScreenParameters(AudioParameter &parameters);

    status_t filterAndUpdateTelephonyParameters(AudioParameter &parameters);

    status_t findOrCreatePatch(

        const std::set<int32_t>& sourcePortConfigIds,

        const std::set<int32_t>& sinkPortConfigIds,

        ::aidl::android::hardware::audio::core::AudioPatch* patch, bool* created);

    status_t findOrCreatePatch(

        const ::aidl::android::hardware::audio::core::AudioPatch& requestedPatch,

        ::aidl::android::hardware::audio::core::AudioPatch* patch, bool* created);

    status_t findOrCreatePortConfig(

            const ::aidl::android::media::audio::common::AudioDevice& device,

            const ::aidl::android::media::audio::common::AudioConfig* config,

            ::aidl::android::media::audio::common::AudioPortConfig* portConfig,

            bool* created);

    status_t findOrCreatePortConfig(

            const ::aidl::android::media::audio::common::AudioConfig& config,

            const std::optional<::aidl::android::media::audio::common::AudioIoFlags>& flags,

            int32_t ioHandle,

            ::aidl::android::media::audio::common::AudioSource aidlSource,

            const std::set<int32_t>& destinationPortIds,

            ::aidl::android::media::audio::common::AudioPortConfig* portConfig, bool* created);

    status_t findOrCreatePortConfig(

        const ::aidl::android::media::audio::common::AudioPortConfig& requestedPortConfig,

        const std::set<int32_t>& destinationPortIds,

        ::aidl::android::media::audio::common::AudioPortConfig* portConfig, bool* created);

    Patches::iterator findPatch(const std::set<int32_t>& sourcePortConfigIds,

            const std::set<int32_t>& sinkPortConfigIds);

    Ports::iterator findPort(const ::aidl::android::media::audio::common::AudioDevice& device);

    Ports::iterator findPort(

            const ::aidl::android::media::audio::common::AudioConfig& config,

            const ::aidl::android::media::audio::common::AudioIoFlags& flags,

            const std::set<int32_t>& destinationPortIds);

    PortConfigs::iterator findPortConfig(

            const ::aidl::android::media::audio::common::AudioDevice& device);

    PortConfigs::iterator findPortConfig(

            const std::optional<::aidl::android::media::audio::common::AudioConfig>& config,

            const std::optional<::aidl::android::media::audio::common::AudioIoFlags>& flags,

            int32_t ioHandle);

    bool isPortHeldByAStream(int32_t portId);

    status_t prepareToOpenStream(

        int32_t aidlHandle,

        const ::aidl::android::media::audio::common::AudioDevice& aidlDevice,

        const ::aidl::android::media::audio::common::AudioIoFlags& aidlFlags,

        ::aidl::android::media::audio::common::AudioSource aidlSource,

        struct audio_config* config,

        Cleanups* cleanups,

        ::aidl::android::media::audio::common::AudioConfig* aidlConfig,

        ::aidl::android::media::audio::common::AudioPortConfig* mixPortConfig,

        ::aidl::android::hardware::audio::core::AudioPatch* aidlPatch);

    void resetPatch(int32_t patchId);

    void resetPortConfig(int32_t portConfigId);

    void resetUnusedPatches();

    void resetUnusedPatchesAndPortConfigs();

    void resetUnusedPortConfigs();

    status_t updateRoutes();

    status_t getAudioPort(int32_t portId, ::aidl::android::media::audio::common::AudioPort* port);



    // CallbackBroker implementation

    void clearCallbacks(void* cookie) override;
@@ -311,28 +239,14 @@ class DeviceHalAidl : public DeviceHalInterface, public ConversionHelperAidl, 
    const std::shared_ptr<::aidl::android::hardware::audio::core::IBluetooth> mBluetooth;

    const std::shared_ptr<::aidl::android::hardware::audio::core::IBluetoothA2dp> mBluetoothA2dp;

    const std::shared_ptr<::aidl::android::hardware::audio::core::IBluetoothLe> mBluetoothLe;

    std::shared_ptr<::aidl::android::hardware::audio::core::sounddose::ISoundDose>

        mSoundDose = nullptr;

    Ports mPorts;

    // Remote submix "template" ports (no address specified, no profiles).

    // They are excluded from `mPorts` as their presence confuses the framework code.

    std::optional<::aidl::android::media::audio::common::AudioPort> mRemoteSubmixIn;

    std::optional<::aidl::android::media::audio::common::AudioPort> mRemoteSubmixOut;

    int32_t mDefaultInputPortId = -1;

    int32_t mDefaultOutputPortId = -1;

    PortConfigs mPortConfigs;

    std::set<int32_t> mInitialPortConfigIds;

    Patches mPatches;

    Routes mRoutes;

    RoutingMatrix mRoutingMatrix;

    Streams mStreams;

    Microphones mMicrophones;

    const std::shared_ptr<::aidl::android::hardware::audio::core::sounddose::ISoundDose> mSoundDose;



    std::mutex mLock;

    std::map<void*, Callbacks> mCallbacks GUARDED_BY(mLock);

    std::set<audio_port_handle_t> mDeviceDisconnectionNotified;

    ConnectedPorts mConnectedPorts;

    std::pair<int32_t, ::aidl::android::media::audio::common::AudioPort>

            mDisconnectedPortReplacement;

    std::set<audio_port_handle_t> mDeviceDisconnectionNotified GUARDED_BY(mLock);

    Hal2AidlMapper mMapper GUARDED_BY(mLock);

    LockedAccessor<Hal2AidlMapper> mMapperAccessor;

    Microphones mMicrophones GUARDED_BY(mLock);

};



} // namespace android

media/libaudiohal/impl/Hal2AidlMapper.cpp

0 → 100644
+927 −0

File added.

Preview size limit exceeded, changes collapsed.