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