SurfaceFlinger.h revision b90cf07f8b3a8fe76e40b997924c2509d04575f4 
1/*
2 * Copyright (C) 2007 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef ANDROID_SURFACE_FLINGER_H
18#define ANDROID_SURFACE_FLINGER_H
19
20#include <stdint.h>
21#include <sys/types.h>
22
23#include <EGL/egl.h>
24
25/*
26 * NOTE: Make sure this file doesn't include  anything from <gl/ > or <gl2/ >
27 */
28
29#include <cutils/compiler.h>
30
31#include <utils/Atomic.h>
32#include <utils/Errors.h>
33#include <utils/KeyedVector.h>
34#include <utils/RefBase.h>
35#include <utils/SortedVector.h>
36#include <utils/threads.h>
37
38#include <binder/IMemory.h>
39
40#include <ui/PixelFormat.h>
41#include <ui/mat4.h>
42
43#include <gui/ISurfaceComposer.h>
44#include <gui/ISurfaceComposerClient.h>
45
46#include <hardware/hwcomposer_defs.h>
47
48#include <private/gui/LayerState.h>
49
50#include "Barrier.h"
51#include "DisplayDevice.h"
52#include "DispSync.h"
53#include "FrameTracker.h"
54#include "MessageQueue.h"
55
56#include "DisplayHardware/HWComposer.h"
57#include "Effects/Daltonizer.h"
58
59namespace android {
60
61// ---------------------------------------------------------------------------
62
63class Client;
64class DisplayEventConnection;
65class EventThread;
66class IGraphicBufferAlloc;
67class Layer;
68class LayerDim;
69class Surface;
70class RenderEngine;
71class EventControlThread;
72
73// ---------------------------------------------------------------------------
74
75enum {
76    eTransactionNeeded        = 0x01,
77    eTraversalNeeded          = 0x02,
78    eDisplayTransactionNeeded = 0x04,
79    eTransactionMask          = 0x07
80};
81
82class SurfaceFlinger : public BnSurfaceComposer,
83                       private IBinder::DeathRecipient,
84                       private HWComposer::EventHandler
85{
86public:
87    static char const* getServiceName() ANDROID_API {
88        return "SurfaceFlinger";
89    }
90
91    SurfaceFlinger() ANDROID_API;
92
93    // must be called before clients can connect
94    void init() ANDROID_API;
95
96    // starts SurfaceFlinger main loop in the current thread
97    void run() ANDROID_API;
98
99    enum {
100        EVENT_VSYNC = HWC_EVENT_VSYNC
101    };
102
103    // post an asynchronous message to the main thread
104    status_t postMessageAsync(const sp<MessageBase>& msg, nsecs_t reltime = 0, uint32_t flags = 0);
105
106    // post a synchronous message to the main thread
107    status_t postMessageSync(const sp<MessageBase>& msg, nsecs_t reltime = 0, uint32_t flags = 0);
108
109    // force full composition on all displays
110    void repaintEverything();
111
112    // returns the default Display
113    sp<const DisplayDevice> getDefaultDisplayDevice() const {
114        return getDisplayDevice(mBuiltinDisplays[DisplayDevice::DISPLAY_PRIMARY]);
115    }
116
117    // utility function to delete a texture on the main thread
118    void deleteTextureAsync(uint32_t texture);
119
120    // enable/disable h/w composer event
121    // TODO: this should be made accessible only to EventThread
122    void eventControl(int disp, int event, int enabled);
123
124    // called on the main thread by MessageQueue when an internal message
125    // is received
126    // TODO: this should be made accessible only to MessageQueue
127    void onMessageReceived(int32_t what);
128
129    // for debugging only
130    // TODO: this should be made accessible only to HWComposer
131    const Vector< sp<Layer> >& getLayerSortedByZForHwcDisplay(int id);
132
133    RenderEngine& getRenderEngine() const {
134        return *mRenderEngine;
135    }
136
137private:
138    friend class Client;
139    friend class DisplayEventConnection;
140    friend class Layer;
141    friend class MonitoredProducer;
142
143    // This value is specified in number of frames.  Log frame stats at most
144    // every half hour.
145    enum { LOG_FRAME_STATS_PERIOD =  30*60*60 };
146
147    // We're reference counted, never destroy SurfaceFlinger directly
148    virtual ~SurfaceFlinger();
149
150    /* ------------------------------------------------------------------------
151     * Internal data structures
152     */
153
154    class LayerVector : public SortedVector< sp<Layer> > {
155    public:
156        LayerVector();
157        LayerVector(const LayerVector& rhs);
158        virtual int do_compare(const void* lhs, const void* rhs) const;
159    };
160
161    struct DisplayDeviceState {
162        DisplayDeviceState();
163        DisplayDeviceState(DisplayDevice::DisplayType type);
164        bool isValid() const { return type >= 0; }
165        bool isMainDisplay() const { return type == DisplayDevice::DISPLAY_PRIMARY; }
166        bool isVirtualDisplay() const { return type >= DisplayDevice::DISPLAY_VIRTUAL; }
167        DisplayDevice::DisplayType type;
168        sp<IGraphicBufferProducer> surface;
169        uint32_t layerStack;
170        Rect viewport;
171        Rect frame;
172        uint8_t orientation;
173        uint32_t width, height;
174        String8 displayName;
175        bool isSecure;
176    };
177
178    struct State {
179        LayerVector layersSortedByZ;
180        DefaultKeyedVector< wp<IBinder>, DisplayDeviceState> displays;
181    };
182
183    /* ------------------------------------------------------------------------
184     * IBinder interface
185     */
186    virtual status_t onTransact(uint32_t code, const Parcel& data,
187        Parcel* reply, uint32_t flags);
188    virtual status_t dump(int fd, const Vector<String16>& args);
189
190    /* ------------------------------------------------------------------------
191     * ISurfaceComposer interface
192     */
193    virtual sp<ISurfaceComposerClient> createConnection();
194    virtual sp<IGraphicBufferAlloc> createGraphicBufferAlloc();
195    virtual sp<IBinder> createDisplay(const String8& displayName, bool secure);
196    virtual void destroyDisplay(const sp<IBinder>& display);
197    virtual sp<IBinder> getBuiltInDisplay(int32_t id);
198    virtual void setTransactionState(const Vector<ComposerState>& state,
199            const Vector<DisplayState>& displays, uint32_t flags);
200    virtual void bootFinished();
201    virtual bool authenticateSurfaceTexture(
202        const sp<IGraphicBufferProducer>& bufferProducer) const;
203    virtual sp<IDisplayEventConnection> createDisplayEventConnection();
204    virtual status_t captureScreen(const sp<IBinder>& display,
205            const sp<IGraphicBufferProducer>& producer,
206            Rect sourceCrop, uint32_t reqWidth, uint32_t reqHeight,
207            uint32_t minLayerZ, uint32_t maxLayerZ,
208            bool useIdentityTransform, ISurfaceComposer::Rotation rotation);
209    virtual status_t getDisplayStats(const sp<IBinder>& display,
210            DisplayStatInfo* stats);
211    virtual status_t getDisplayConfigs(const sp<IBinder>& display,
212            Vector<DisplayInfo>* configs);
213    virtual int getActiveConfig(const sp<IBinder>& display);
214    virtual void setPowerMode(const sp<IBinder>& display, int mode);
215    virtual status_t setActiveConfig(const sp<IBinder>& display, int id);
216    virtual status_t clearAnimationFrameStats();
217    virtual status_t getAnimationFrameStats(FrameStats* outStats) const;
218
219    /* ------------------------------------------------------------------------
220     * DeathRecipient interface
221     */
222    virtual void binderDied(const wp<IBinder>& who);
223
224    /* ------------------------------------------------------------------------
225     * RefBase interface
226     */
227    virtual void onFirstRef();
228
229    /* ------------------------------------------------------------------------
230     * HWComposer::EventHandler interface
231     */
232    virtual void onVSyncReceived(int type, nsecs_t timestamp);
233    virtual void onHotplugReceived(int disp, bool connected);
234
235    /* ------------------------------------------------------------------------
236     * Message handling
237     */
238    void waitForEvent();
239    void signalTransaction();
240    void signalLayerUpdate();
241    void signalRefresh();
242
243    // called on the main thread in response to initializeDisplays()
244    void onInitializeDisplays();
245    // called on the main thread in response to setActiveConfig()
246    void setActiveConfigInternal(const sp<DisplayDevice>& hw, int mode);
247    // called on the main thread in response to setPowerMode()
248    void setPowerModeInternal(const sp<DisplayDevice>& hw, int mode);
249
250    // Returns whether the transaction actually modified any state
251    bool handleMessageTransaction();
252
253    // Returns whether a new buffer has been latched (see handlePageFlip())
254    bool handleMessageInvalidate();
255
256    void handleMessageRefresh();
257
258    void handleTransaction(uint32_t transactionFlags);
259    void handleTransactionLocked(uint32_t transactionFlags);
260
261    void updateCursorAsync();
262
263    /* handlePageFlip - latch a new buffer if available and compute the dirty
264     * region. Returns whether a new buffer has been latched, i.e., whether it
265     * is necessary to perform a refresh during this vsync.
266     */
267    bool handlePageFlip();
268
269    /* ------------------------------------------------------------------------
270     * Transactions
271     */
272    uint32_t getTransactionFlags(uint32_t flags);
273    uint32_t peekTransactionFlags(uint32_t flags);
274    uint32_t setTransactionFlags(uint32_t flags);
275    void commitTransaction();
276    uint32_t setClientStateLocked(const sp<Client>& client, const layer_state_t& s);
277    uint32_t setDisplayStateLocked(const DisplayState& s);
278
279    /* ------------------------------------------------------------------------
280     * Layer management
281     */
282    status_t createLayer(const String8& name, const sp<Client>& client,
283            uint32_t w, uint32_t h, PixelFormat format, uint32_t flags,
284            sp<IBinder>* handle, sp<IGraphicBufferProducer>* gbp);
285
286    status_t createNormalLayer(const sp<Client>& client, const String8& name,
287            uint32_t w, uint32_t h, uint32_t flags, PixelFormat& format,
288            sp<IBinder>* outHandle, sp<IGraphicBufferProducer>* outGbp,
289            sp<Layer>* outLayer);
290
291    status_t createDimLayer(const sp<Client>& client, const String8& name,
292            uint32_t w, uint32_t h, uint32_t flags, sp<IBinder>* outHandle,
293            sp<IGraphicBufferProducer>* outGbp, sp<Layer>* outLayer);
294
295    // called in response to the window-manager calling
296    // ISurfaceComposerClient::destroySurface()
297    status_t onLayerRemoved(const sp<Client>& client, const sp<IBinder>& handle);
298
299    // called when all clients have released all their references to
300    // this layer meaning it is entirely safe to destroy all
301    // resources associated to this layer.
302    status_t onLayerDestroyed(const wp<Layer>& layer);
303
304    // remove a layer from SurfaceFlinger immediately
305    status_t removeLayer(const sp<Layer>& layer);
306
307    // add a layer to SurfaceFlinger
308    void addClientLayer(const sp<Client>& client,
309            const sp<IBinder>& handle,
310            const sp<IGraphicBufferProducer>& gbc,
311            const sp<Layer>& lbc);
312
313    /* ------------------------------------------------------------------------
314     * Boot animation, on/off animations and screen capture
315     */
316
317    void startBootAnim();
318
319    void renderScreenImplLocked(
320            const sp<const DisplayDevice>& hw,
321            Rect sourceCrop, uint32_t reqWidth, uint32_t reqHeight,
322            uint32_t minLayerZ, uint32_t maxLayerZ,
323            bool yswap, bool useIdentityTransform, Transform::orientation_flags rotation);
324
325    status_t captureScreenImplLocked(
326            const sp<const DisplayDevice>& hw,
327            const sp<IGraphicBufferProducer>& producer,
328            Rect sourceCrop, uint32_t reqWidth, uint32_t reqHeight,
329            uint32_t minLayerZ, uint32_t maxLayerZ,
330            bool useIdentityTransform, Transform::orientation_flags rotation);
331
332    /* ------------------------------------------------------------------------
333     * EGL
334     */
335    size_t getMaxTextureSize() const;
336    size_t getMaxViewportDims() const;
337
338    /* ------------------------------------------------------------------------
339     * Display and layer stack management
340     */
341    // called when starting, or restarting after system_server death
342    void initializeDisplays();
343
344    // Create an IBinder for a builtin display and add it to current state
345    void createBuiltinDisplayLocked(DisplayDevice::DisplayType type);
346
347    // NOTE: can only be called from the main thread or with mStateLock held
348    sp<const DisplayDevice> getDisplayDevice(const wp<IBinder>& dpy) const {
349        return mDisplays.valueFor(dpy);
350    }
351
352    // NOTE: can only be called from the main thread or with mStateLock held
353    sp<DisplayDevice> getDisplayDevice(const wp<IBinder>& dpy) {
354        return mDisplays.valueFor(dpy);
355    }
356
357    // mark a region of a layer stack dirty. this updates the dirty
358    // region of all screens presenting this layer stack.
359    void invalidateLayerStack(uint32_t layerStack, const Region& dirty);
360
361    // allocate a h/w composer display id
362    int32_t allocateHwcDisplayId(DisplayDevice::DisplayType type);
363
364    /* ------------------------------------------------------------------------
365     * H/W composer
366     */
367
368    HWComposer& getHwComposer() const { return *mHwc; }
369
370    /* ------------------------------------------------------------------------
371     * Compositing
372     */
373    void invalidateHwcGeometry();
374    static void computeVisibleRegions(
375            const LayerVector& currentLayers, uint32_t layerStack,
376            Region& dirtyRegion, Region& opaqueRegion);
377
378    void preComposition();
379    void postComposition();
380    void rebuildLayerStacks();
381    void setUpHWComposer();
382    void doComposition();
383    void doDebugFlashRegions();
384    void doDisplayComposition(const sp<const DisplayDevice>& hw, const Region& dirtyRegion);
385
386    // compose surfaces for display hw. this fails if using GL and the surface
387    // has been destroyed and is no longer valid.
388    bool doComposeSurfaces(const sp<const DisplayDevice>& hw, const Region& dirty);
389
390    void postFramebuffer();
391    void drawWormhole(const sp<const DisplayDevice>& hw, const Region& region) const;
392
393    /* ------------------------------------------------------------------------
394     * Display management
395     */
396
397    /* ------------------------------------------------------------------------
398     * VSync
399     */
400     void enableHardwareVsync();
401     void disableHardwareVsync(bool makeUnavailable);
402     void resyncToHardwareVsync(bool makeAvailable);
403
404    /* ------------------------------------------------------------------------
405     * Debugging & dumpsys
406     */
407    void listLayersLocked(const Vector<String16>& args, size_t& index, String8& result) const;
408    void dumpStatsLocked(const Vector<String16>& args, size_t& index, String8& result) const;
409    void clearStatsLocked(const Vector<String16>& args, size_t& index, String8& result);
410    void dumpAllLocked(const Vector<String16>& args, size_t& index, String8& result) const;
411    bool startDdmConnection();
412    static void appendSfConfigString(String8& result);
413    void checkScreenshot(size_t w, size_t s, size_t h, void const* vaddr,
414            const sp<const DisplayDevice>& hw,
415            uint32_t minLayerZ, uint32_t maxLayerZ);
416
417    void logFrameStats();
418
419    void dumpStaticScreenStats(String8& result) const;
420
421    /* ------------------------------------------------------------------------
422     * Attributes
423     */
424
425    // access must be protected by mStateLock
426    mutable Mutex mStateLock;
427    State mCurrentState;
428    volatile int32_t mTransactionFlags;
429    Condition mTransactionCV;
430    bool mTransactionPending;
431    bool mAnimTransactionPending;
432    Vector< sp<Layer> > mLayersPendingRemoval;
433    SortedVector< wp<IBinder> > mGraphicBufferProducerList;
434
435    // protected by mStateLock (but we could use another lock)
436    bool mLayersRemoved;
437
438    // access must be protected by mInvalidateLock
439    volatile int32_t mRepaintEverything;
440
441    // constant members (no synchronization needed for access)
442    HWComposer* mHwc;
443    RenderEngine* mRenderEngine;
444    nsecs_t mBootTime;
445    bool mGpuToCpuSupported;
446    sp<EventThread> mEventThread;
447    sp<EventThread> mSFEventThread;
448    sp<EventControlThread> mEventControlThread;
449    EGLContext mEGLContext;
450    EGLDisplay mEGLDisplay;
451    sp<IBinder> mBuiltinDisplays[DisplayDevice::NUM_BUILTIN_DISPLAY_TYPES];
452
453    // Can only accessed from the main thread, these members
454    // don't need synchronization
455    State mDrawingState;
456    bool mVisibleRegionsDirty;
457    bool mHwWorkListDirty;
458    bool mAnimCompositionPending;
459
460    // this may only be written from the main thread with mStateLock held
461    // it may be read from other threads with mStateLock held
462    DefaultKeyedVector< wp<IBinder>, sp<DisplayDevice> > mDisplays;
463
464    // don't use a lock for these, we don't care
465    int mDebugRegion;
466    int mDebugDDMS;
467    int mDebugDisableHWC;
468    int mDebugDisableTransformHint;
469    volatile nsecs_t mDebugInSwapBuffers;
470    nsecs_t mLastSwapBufferTime;
471    volatile nsecs_t mDebugInTransaction;
472    nsecs_t mLastTransactionTime;
473    bool mBootFinished;
474
475    // these are thread safe
476    mutable MessageQueue mEventQueue;
477    FrameTracker mAnimFrameTracker;
478    DispSync mPrimaryDispSync;
479
480    // protected by mDestroyedLayerLock;
481    mutable Mutex mDestroyedLayerLock;
482    Vector<Layer const *> mDestroyedLayers;
483
484    // protected by mHWVsyncLock
485    Mutex mHWVsyncLock;
486    bool mPrimaryHWVsyncEnabled;
487    bool mHWVsyncAvailable;
488
489    /* ------------------------------------------------------------------------
490     * Feature prototyping
491     */
492
493    Daltonizer mDaltonizer;
494    bool mDaltonize;
495
496    mat4 mColorMatrix;
497    bool mHasColorMatrix;
498
499    // Static screen stats
500    bool mHasPoweredOff;
501    static const size_t NUM_BUCKETS = 8; // < 1-7, 7+
502    nsecs_t mFrameBuckets[NUM_BUCKETS];
503    nsecs_t mTotalTime;
504    nsecs_t mLastSwapTime;
505};
506
507}; // namespace android
508
509#endif // ANDROID_SURFACE_FLINGER_H
510