SurfaceFlinger.h revision 10ca42cbdc75c6a36d0b72dadbe845d990e31e95 
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 SurfaceTextureLayer;
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        String8 displayName;
174        bool isSecure;
175    };
176
177    struct State {
178        LayerVector layersSortedByZ;
179        DefaultKeyedVector< wp<IBinder>, DisplayDeviceState> displays;
180    };
181
182    /* ------------------------------------------------------------------------
183     * IBinder interface
184     */
185    virtual status_t onTransact(uint32_t code, const Parcel& data,
186        Parcel* reply, uint32_t flags);
187    virtual status_t dump(int fd, const Vector<String16>& args);
188
189    /* ------------------------------------------------------------------------
190     * ISurfaceComposer interface
191     */
192    virtual sp<ISurfaceComposerClient> createConnection();
193    virtual sp<IGraphicBufferAlloc> createGraphicBufferAlloc();
194    virtual sp<IBinder> createDisplay(const String8& displayName, bool secure);
195    virtual void destroyDisplay(const sp<IBinder>& display);
196    virtual sp<IBinder> getBuiltInDisplay(int32_t id);
197    virtual void setTransactionState(const Vector<ComposerState>& state,
198            const Vector<DisplayState>& displays, uint32_t flags);
199    virtual void bootFinished();
200    virtual bool authenticateSurfaceTexture(
201        const sp<IGraphicBufferProducer>& bufferProducer) const;
202    virtual sp<IDisplayEventConnection> createDisplayEventConnection();
203    virtual status_t captureScreen(const sp<IBinder>& display,
204            const sp<IGraphicBufferProducer>& producer,
205            uint32_t reqWidth, uint32_t reqHeight,
206            uint32_t minLayerZ, uint32_t maxLayerZ);
207    // called when screen needs to turn off
208    virtual void blank(const sp<IBinder>& display);
209    // called when screen is turning back on
210    virtual void unblank(const sp<IBinder>& display);
211    virtual status_t getDisplayInfo(const sp<IBinder>& display, DisplayInfo* info);
212
213    /* ------------------------------------------------------------------------
214     * DeathRecipient interface
215     */
216    virtual void binderDied(const wp<IBinder>& who);
217
218    /* ------------------------------------------------------------------------
219     * RefBase interface
220     */
221    virtual void onFirstRef();
222
223    /* ------------------------------------------------------------------------
224     * HWComposer::EventHandler interface
225     */
226    virtual void onVSyncReceived(int type, nsecs_t timestamp);
227    virtual void onHotplugReceived(int disp, bool connected);
228
229    /* ------------------------------------------------------------------------
230     * Message handling
231     */
232    void waitForEvent();
233    void signalTransaction();
234    void signalLayerUpdate();
235    void signalRefresh();
236
237    // called on the main thread in response to initializeDisplays()
238    void onInitializeDisplays();
239    // called on the main thread in response to blank()
240    void onScreenReleased(const sp<const DisplayDevice>& hw);
241    // called on the main thread in response to unblank()
242    void onScreenAcquired(const sp<const DisplayDevice>& hw);
243
244    void handleMessageTransaction();
245    void handleMessageInvalidate();
246    void handleMessageRefresh();
247
248    void handleTransaction(uint32_t transactionFlags);
249    void handleTransactionLocked(uint32_t transactionFlags);
250
251    /* handlePageFilp: this is were we latch a new buffer
252     * if available and compute the dirty region.
253     */
254    void handlePageFlip();
255
256    /* ------------------------------------------------------------------------
257     * Transactions
258     */
259    uint32_t getTransactionFlags(uint32_t flags);
260    uint32_t peekTransactionFlags(uint32_t flags);
261    uint32_t setTransactionFlags(uint32_t flags);
262    void commitTransaction();
263    uint32_t setClientStateLocked(const sp<Client>& client, const layer_state_t& s);
264    uint32_t setDisplayStateLocked(const DisplayState& s);
265
266    /* ------------------------------------------------------------------------
267     * Layer management
268     */
269    status_t createLayer(const String8& name, const sp<Client>& client,
270            uint32_t w, uint32_t h, PixelFormat format, uint32_t flags,
271            sp<IBinder>* handle, sp<IGraphicBufferProducer>* gbp);
272
273    status_t createNormalLayer(const sp<Client>& client, const String8& name,
274            uint32_t w, uint32_t h, uint32_t flags, PixelFormat& format,
275            sp<IBinder>* outHandle, sp<IGraphicBufferProducer>* outGbp,
276            sp<Layer>* outLayer);
277
278    status_t createDimLayer(const sp<Client>& client, const String8& name,
279            uint32_t w, uint32_t h, uint32_t flags, sp<IBinder>* outHandle,
280            sp<IGraphicBufferProducer>* outGbp, sp<Layer>* outLayer);
281
282    // called in response to the window-manager calling
283    // ISurfaceComposerClient::destroySurface()
284    status_t onLayerRemoved(const sp<Client>& client, const sp<IBinder>& handle);
285
286    // called when all clients have released all their references to
287    // this layer meaning it is entirely safe to destroy all
288    // resources associated to this layer.
289    status_t onLayerDestroyed(const wp<Layer>& layer);
290
291    // remove a layer from SurfaceFlinger immediately
292    status_t removeLayer(const sp<Layer>& layer);
293
294    // add a layer to SurfaceFlinger
295    void addClientLayer(const sp<Client>& client,
296            const sp<IBinder>& handle,
297            const sp<IGraphicBufferProducer>& gbc,
298            const sp<Layer>& lbc);
299
300    /* ------------------------------------------------------------------------
301     * Boot animation, on/off animations and screen capture
302     */
303
304    void startBootAnim();
305
306    void renderScreenImplLocked(
307            const sp<const DisplayDevice>& hw,
308            uint32_t reqWidth, uint32_t reqHeight,
309            uint32_t minLayerZ, uint32_t maxLayerZ,
310            bool yswap);
311
312    status_t captureScreenImplLocked(
313            const sp<const DisplayDevice>& hw,
314            const sp<IGraphicBufferProducer>& producer,
315            uint32_t reqWidth, uint32_t reqHeight,
316            uint32_t minLayerZ, uint32_t maxLayerZ);
317
318    /* ------------------------------------------------------------------------
319     * EGL
320     */
321    size_t getMaxTextureSize() const;
322    size_t getMaxViewportDims() const;
323
324    /* ------------------------------------------------------------------------
325     * Display and layer stack management
326     */
327    // called when starting, or restarting after system_server death
328    void initializeDisplays();
329
330    // Create an IBinder for a builtin display and add it to current state
331    void createBuiltinDisplayLocked(DisplayDevice::DisplayType type);
332
333    // NOTE: can only be called from the main thread or with mStateLock held
334    sp<const DisplayDevice> getDisplayDevice(const wp<IBinder>& dpy) const {
335        return mDisplays.valueFor(dpy);
336    }
337
338    // NOTE: can only be called from the main thread or with mStateLock held
339    sp<DisplayDevice> getDisplayDevice(const wp<IBinder>& dpy) {
340        return mDisplays.valueFor(dpy);
341    }
342
343    // mark a region of a layer stack dirty. this updates the dirty
344    // region of all screens presenting this layer stack.
345    void invalidateLayerStack(uint32_t layerStack, const Region& dirty);
346
347    // allocate a h/w composer display id
348    int32_t allocateHwcDisplayId(DisplayDevice::DisplayType type);
349
350    /* ------------------------------------------------------------------------
351     * H/W composer
352     */
353
354    HWComposer& getHwComposer() const { return *mHwc; }
355
356    /* ------------------------------------------------------------------------
357     * Compositing
358     */
359    void invalidateHwcGeometry();
360    static void computeVisibleRegions(
361            const LayerVector& currentLayers, uint32_t layerStack,
362            Region& dirtyRegion, Region& opaqueRegion);
363
364    void preComposition();
365    void postComposition();
366    void rebuildLayerStacks();
367    void setUpHWComposer();
368    void doComposition();
369    void doDebugFlashRegions();
370    void doDisplayComposition(const sp<const DisplayDevice>& hw, const Region& dirtyRegion);
371    void doComposeSurfaces(const sp<const DisplayDevice>& hw, const Region& dirty);
372
373    void postFramebuffer();
374    void drawWormhole(const sp<const DisplayDevice>& hw, const Region& region) const;
375
376    /* ------------------------------------------------------------------------
377     * Display management
378     */
379
380    /* ------------------------------------------------------------------------
381     * VSync
382     */
383     void enableHardwareVsync();
384     void disableHardwareVsync(bool makeUnavailable);
385     void resyncToHardwareVsync(bool makeAvailable);
386
387    /* ------------------------------------------------------------------------
388     * Debugging & dumpsys
389     */
390    void listLayersLocked(const Vector<String16>& args, size_t& index, String8& result) const;
391    void dumpStatsLocked(const Vector<String16>& args, size_t& index, String8& result) const;
392    void clearStatsLocked(const Vector<String16>& args, size_t& index, String8& result);
393    void dumpAllLocked(const Vector<String16>& args, size_t& index, String8& result) const;
394    bool startDdmConnection();
395    static void appendSfConfigString(String8& result);
396    void checkScreenshot(size_t w, size_t s, size_t h, void const* vaddr,
397            const sp<const DisplayDevice>& hw,
398            uint32_t minLayerZ, uint32_t maxLayerZ);
399
400    void logFrameStats();
401
402    /* ------------------------------------------------------------------------
403     * Attributes
404     */
405
406    // access must be protected by mStateLock
407    mutable Mutex mStateLock;
408    State mCurrentState;
409    volatile int32_t mTransactionFlags;
410    Condition mTransactionCV;
411    bool mTransactionPending;
412    bool mAnimTransactionPending;
413    Vector< sp<Layer> > mLayersPendingRemoval;
414    SortedVector< wp<IBinder> > mGraphicBufferProducerList;
415
416    // protected by mStateLock (but we could use another lock)
417    bool mLayersRemoved;
418
419    // access must be protected by mInvalidateLock
420    volatile int32_t mRepaintEverything;
421
422    // constant members (no synchronization needed for access)
423    HWComposer* mHwc;
424    RenderEngine* mRenderEngine;
425    nsecs_t mBootTime;
426    bool mGpuToCpuSupported;
427    sp<EventThread> mEventThread;
428    sp<EventThread> mSFEventThread;
429    sp<EventControlThread> mEventControlThread;
430    EGLContext mEGLContext;
431    EGLDisplay mEGLDisplay;
432    sp<IBinder> mBuiltinDisplays[DisplayDevice::NUM_BUILTIN_DISPLAY_TYPES];
433
434    // Can only accessed from the main thread, these members
435    // don't need synchronization
436    State mDrawingState;
437    bool mVisibleRegionsDirty;
438    bool mHwWorkListDirty;
439    bool mAnimCompositionPending;
440
441    // this may only be written from the main thread with mStateLock held
442    // it may be read from other threads with mStateLock held
443    DefaultKeyedVector< wp<IBinder>, sp<DisplayDevice> > mDisplays;
444
445    // don't use a lock for these, we don't care
446    int mDebugRegion;
447    int mDebugDDMS;
448    int mDebugDisableHWC;
449    int mDebugDisableTransformHint;
450    volatile nsecs_t mDebugInSwapBuffers;
451    nsecs_t mLastSwapBufferTime;
452    volatile nsecs_t mDebugInTransaction;
453    nsecs_t mLastTransactionTime;
454    bool mBootFinished;
455
456    // these are thread safe
457    mutable MessageQueue mEventQueue;
458    FrameTracker mAnimFrameTracker;
459    DispSync mPrimaryDispSync;
460
461    // protected by mDestroyedLayerLock;
462    mutable Mutex mDestroyedLayerLock;
463    Vector<Layer const *> mDestroyedLayers;
464
465    // protected by mHWVsyncLock
466    Mutex mHWVsyncLock;
467    bool mPrimaryHWVsyncEnabled;
468    bool mHWVsyncAvailable;
469
470    /* ------------------------------------------------------------------------
471     * Feature prototyping
472     */
473
474    Daltonizer mDaltonizer;
475    bool mDaltonize;
476
477    mat4 mColorMatrix;
478    bool mHasColorMatrix;
479};
480
481}; // namespace android
482
483#endif // ANDROID_SURFACE_FLINGER_H
484