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

Commit 298b08e5 authored by Dominik Laskowski's avatar Dominik Laskowski
Browse files

SF: Generalize thread safety guards 

Replace the guards with a uniform syntax that can be reused with
annotations other than mStateLock and SF_MAIN_THREAD.

Bug: 182939859
Test: Build
Change-Id: I03e6fe5d465111a5882d2fc1c09fe1dc9660aa07
parent bd006786

services/surfaceflinger/DisplayDevice.h

+11 −13
Original line number Original line Diff line number Diff line
@@ -21,6 +21,7 @@ 
#include <string>

#include <string>

#include <unordered_map>

#include <unordered_map>





#include <android-base/thread_annotations.h>

#include <android/native_window.h>

#include <android/native_window.h>

#include <binder/IBinder.h>

#include <binder/IBinder.h>

#include <gui/LayerState.h>

#include <gui/LayerState.h>
@@ -28,6 +29,7 @@ 
#include <renderengine/RenderEngine.h>

#include <renderengine/RenderEngine.h>

#include <system/window.h>

#include <system/window.h>

#include <ui/DisplayId.h>

#include <ui/DisplayId.h>

#include <ui/DisplayIdentification.h>

#include <ui/DisplayState.h>

#include <ui/DisplayState.h>

#include <ui/GraphicTypes.h>

#include <ui/GraphicTypes.h>

#include <ui/HdrCapabilities.h>

#include <ui/HdrCapabilities.h>
@@ -39,15 +41,11 @@ 
#include <utils/RefBase.h>

#include <utils/RefBase.h>

#include <utils/Timers.h>

#include <utils/Timers.h>





#include "MainThreadGuard.h"



#include <ui/DisplayIdentification.h>

#include "DisplayHardware/DisplayMode.h"

#include "DisplayHardware/DisplayMode.h"

#include "DisplayHardware/Hal.h"

#include "DisplayHardware/Hal.h"

#include "DisplayHardware/PowerAdvisor.h"

#include "DisplayHardware/PowerAdvisor.h"



#include "Scheduler/RefreshRateConfigs.h"

#include "Scheduler/RefreshRateConfigs.h"



#include "ThreadContext.h"

#include "TracedOrdinal.h"

#include "TracedOrdinal.h"





namespace android {

namespace android {
@@ -99,9 +97,9 @@ public: 
    void setLayerStack(ui::LayerStack);

    void setLayerStack(ui::LayerStack);

    void setDisplaySize(int width, int height);

    void setDisplaySize(int width, int height);

    void setProjection(ui::Rotation orientation, Rect viewport, Rect frame);

    void setProjection(ui::Rotation orientation, Rect viewport, Rect frame);

    void stageBrightness(float brightness) REQUIRES(SF_MAIN_THREAD);

    void stageBrightness(float brightness) REQUIRES(kMainThreadContext);

    void persistBrightness(bool needsComposite) REQUIRES(SF_MAIN_THREAD);

    void persistBrightness(bool needsComposite) REQUIRES(kMainThreadContext);

    bool isBrightnessStale() const REQUIRES(SF_MAIN_THREAD);

    bool isBrightnessStale() const REQUIRES(kMainThreadContext);

    void setFlags(uint32_t flags);

    void setFlags(uint32_t flags);





    ui::Rotation getPhysicalOrientation() const { return mPhysicalOrientation; }

    ui::Rotation getPhysicalOrientation() const { return mPhysicalOrientation; }
@@ -109,7 +107,7 @@ public: 




    static ui::Transform::RotationFlags getPrimaryDisplayRotationFlags();

    static ui::Transform::RotationFlags getPrimaryDisplayRotationFlags();





    std::optional<float> getStagedBrightness() const REQUIRES(SF_MAIN_THREAD);

    std::optional<float> getStagedBrightness() const REQUIRES(kMainThreadContext);

    ui::Transform::RotationFlags getTransformHint() const;

    ui::Transform::RotationFlags getTransformHint() const;

    const ui::Transform& getTransform() const;

    const ui::Transform& getTransform() const;

    const Rect& getLayerStackSpaceRect() const;

    const Rect& getLayerStackSpaceRect() const;
@@ -209,15 +207,15 @@ public: 
    bool setDesiredActiveMode(const ActiveModeInfo&) EXCLUDES(mActiveModeLock);

    bool setDesiredActiveMode(const ActiveModeInfo&) EXCLUDES(mActiveModeLock);

    std::optional<ActiveModeInfo> getDesiredActiveMode() const EXCLUDES(mActiveModeLock);

    std::optional<ActiveModeInfo> getDesiredActiveMode() const EXCLUDES(mActiveModeLock);

    void clearDesiredActiveModeState() EXCLUDES(mActiveModeLock);

    void clearDesiredActiveModeState() EXCLUDES(mActiveModeLock);

    ActiveModeInfo getUpcomingActiveMode() const REQUIRES(SF_MAIN_THREAD) {

    ActiveModeInfo getUpcomingActiveMode() const REQUIRES(kMainThreadContext) {

        return mUpcomingActiveMode;

        return mUpcomingActiveMode;

    }

    }





    void setActiveMode(DisplayModeId) REQUIRES(SF_MAIN_THREAD);

    void setActiveMode(DisplayModeId) REQUIRES(kMainThreadContext);

    status_t initiateModeChange(const ActiveModeInfo&,

    status_t initiateModeChange(const ActiveModeInfo&,

                                const hal::VsyncPeriodChangeConstraints& constraints,

                                const hal::VsyncPeriodChangeConstraints& constraints,

                                hal::VsyncPeriodChangeTimeline* outTimeline)

                                hal::VsyncPeriodChangeTimeline* outTimeline)

            REQUIRES(SF_MAIN_THREAD);

            REQUIRES(kMainThreadContext);





    // Return the immutable list of supported display modes. The HWC may report different modes

    // Return the immutable list of supported display modes. The HWC may report different modes

    // after a hotplug reconnect event, in which case the DisplayDevice object will be recreated.

    // after a hotplug reconnect event, in which case the DisplayDevice object will be recreated.
@@ -304,7 +302,7 @@ private: 
    ActiveModeInfo mDesiredActiveMode GUARDED_BY(mActiveModeLock);

    ActiveModeInfo mDesiredActiveMode GUARDED_BY(mActiveModeLock);

    TracedOrdinal<bool> mDesiredActiveModeChanged

    TracedOrdinal<bool> mDesiredActiveModeChanged

            GUARDED_BY(mActiveModeLock) = {"DesiredActiveModeChanged", false};

            GUARDED_BY(mActiveModeLock) = {"DesiredActiveModeChanged", false};

    ActiveModeInfo mUpcomingActiveMode GUARDED_BY(SF_MAIN_THREAD);

    ActiveModeInfo mUpcomingActiveMode GUARDED_BY(kMainThreadContext);

};

};





struct DisplayDeviceState {

struct DisplayDeviceState {

services/surfaceflinger/Layer.cpp

+4 −3
Original line number Original line Diff line number Diff line
@@ -37,6 +37,7 @@ 
#include <cutils/native_handle.h>

#include <cutils/native_handle.h>

#include <cutils/properties.h>

#include <cutils/properties.h>

#include <ftl/enum.h>

#include <ftl/enum.h>

#include <ftl/fake_guard.h>

#include <gui/BufferItem.h>

#include <gui/BufferItem.h>

#include <gui/LayerDebugInfo.h>

#include <gui/LayerDebugInfo.h>

#include <gui/Surface.h>

#include <gui/Surface.h>
@@ -2045,10 +2046,10 @@ LayerProto* Layer::writeToProto(LayersProto& layersProto, uint32_t traceFlags) { 
    writeToProtoCommonState(layerProto, LayerVector::StateSet::Drawing, traceFlags);

    writeToProtoCommonState(layerProto, LayerVector::StateSet::Drawing, traceFlags);





    if (traceFlags & LayerTracing::TRACE_COMPOSITION) {

    if (traceFlags & LayerTracing::TRACE_COMPOSITION) {

        ftl::FakeGuard guard(mFlinger->mStateLock); // Called from the main thread.



        // Only populate for the primary display.

        // Only populate for the primary display.

        UnnecessaryLock assumeLocked(mFlinger->mStateLock); // called from the main thread.

        if (const auto display = mFlinger->getDefaultDisplayDeviceLocked()) {

        const auto display = mFlinger->getDefaultDisplayDeviceLocked();

        if (display) {

            const auto compositionType = getCompositionType(*display);

            const auto compositionType = getCompositionType(*display);

            layerProto->set_hwc_composition_type(static_cast<HwcCompositionType>(compositionType));

            layerProto->set_hwc_composition_type(static_cast<HwcCompositionType>(compositionType));

            LayerProtoHelper::writeToProto(getVisibleRegion(display.get()),

            LayerProtoHelper::writeToProto(getVisibleRegion(display.get()),

services/surfaceflinger/MutexUtils.h

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

 * Copyright 2022 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 <log/log.h>

#include <utils/Mutex.h>



namespace android {



struct SCOPED_CAPABILITY ConditionalLock {

    ConditionalLock(Mutex& mutex, bool lock) ACQUIRE(mutex) : mutex(mutex), lock(lock) {

        if (lock) mutex.lock();

    }



    ~ConditionalLock() RELEASE() {

        if (lock) mutex.unlock();

    }



    Mutex& mutex;

    const bool lock;

};



struct SCOPED_CAPABILITY TimedLock {

    TimedLock(Mutex& mutex, nsecs_t timeout, const char* whence) ACQUIRE(mutex)

          : mutex(mutex), status(mutex.timedLock(timeout)) {

        ALOGE_IF(!locked(), "%s timed out locking: %s (%d)", whence, strerror(-status), status);

    }



    ~TimedLock() RELEASE() {

        if (locked()) mutex.unlock();

    }



    bool locked() const { return status == NO_ERROR; }



    Mutex& mutex;

    const status_t status;

};



} // namespace android

services/surfaceflinger/SurfaceFlinger.cpp

+96 −141

File changed.

Preview size limit exceeded, changes collapsed.

services/surfaceflinger/SurfaceFlinger.h

+5 −9
Original line number Original line Diff line number Diff line
@@ -64,6 +64,7 @@ 
#include "Scheduler/Scheduler.h"

#include "Scheduler/Scheduler.h"

#include "Scheduler/VsyncModulator.h"

#include "Scheduler/VsyncModulator.h"

#include "SurfaceFlingerFactory.h"

#include "SurfaceFlingerFactory.h"

#include "ThreadContext.h"

#include "TracedOrdinal.h"

#include "TracedOrdinal.h"

#include "Tracing/LayerTracing.h"

#include "Tracing/LayerTracing.h"

#include "Tracing/TransactionTracing.h"

#include "Tracing/TransactionTracing.h"
@@ -183,11 +184,6 @@ struct SurfaceFlingerBE { 
    std::atomic<nsecs_t> mLastSwapTime = 0;

    std::atomic<nsecs_t> mLastSwapTime = 0;

};

};





struct SCOPED_CAPABILITY UnnecessaryLock {

    explicit UnnecessaryLock(Mutex& mutex) ACQUIRE(mutex) {}

    ~UnnecessaryLock() RELEASE() {}

};



class SurfaceFlinger : public BnSurfaceComposer,

class SurfaceFlinger : public BnSurfaceComposer,

                       public PriorityDumper,

                       public PriorityDumper,

                       private IBinder::DeathRecipient,

                       private IBinder::DeathRecipient,
@@ -740,7 +736,7 @@ private: 
    void updateLayerGeometry();

    void updateLayerGeometry();





    void updateInputFlinger();

    void updateInputFlinger();

    void persistDisplayBrightness(bool needsComposite) REQUIRES(SF_MAIN_THREAD);

    void persistDisplayBrightness(bool needsComposite) REQUIRES(kMainThreadContext);

    void buildWindowInfos(std::vector<gui::WindowInfo>& outWindowInfos,

    void buildWindowInfos(std::vector<gui::WindowInfo>& outWindowInfos,

                          std::vector<gui::DisplayInfo>& outDisplayInfos);

                          std::vector<gui::DisplayInfo>& outDisplayInfos);

    void commitInputWindowCommands() REQUIRES(mStateLock);

    void commitInputWindowCommands() REQUIRES(mStateLock);
@@ -973,7 +969,7 @@ private: 
    void setCompositorTimingSnapped(const DisplayStatInfo& stats,

    void setCompositorTimingSnapped(const DisplayStatInfo& stats,

                                    nsecs_t compositeToPresentLatency);

                                    nsecs_t compositeToPresentLatency);





    void postFrame();

    void postFrame() REQUIRES(kMainThreadContext);





    /*

    /*

     * Display management

     * Display management
@@ -1088,7 +1084,7 @@ private: 
    void clearStatsLocked(const DumpArgs& args, std::string& result);

    void clearStatsLocked(const DumpArgs& args, std::string& result);

    void dumpTimeStats(const DumpArgs& args, bool asProto, std::string& result) const;

    void dumpTimeStats(const DumpArgs& args, bool asProto, std::string& result) const;

    void dumpFrameTimeline(const DumpArgs& args, std::string& result) const;

    void dumpFrameTimeline(const DumpArgs& args, std::string& result) const;

    void logFrameStats();

    void logFrameStats() REQUIRES(kMainThreadContext);





    void dumpVSync(std::string& result) const REQUIRES(mStateLock);

    void dumpVSync(std::string& result) const REQUIRES(mStateLock);

    void dumpStaticScreenStats(std::string& result) const;

    void dumpStaticScreenStats(std::string& result) const;
@@ -1431,7 +1427,7 @@ private: 
        nsecs_t commitStart;

        nsecs_t commitStart;

        nsecs_t compositeStart;

        nsecs_t compositeStart;

        nsecs_t presentEnd;

        nsecs_t presentEnd;

    } mPowerHintSessionData GUARDED_BY(SF_MAIN_THREAD);

    } mPowerHintSessionData GUARDED_BY(kMainThreadContext);





    nsecs_t mAnimationTransactionTimeout = s2ns(5);

    nsecs_t mAnimationTransactionTimeout = s2ns(5);