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