SurfaceFlinger.h revision ad8d13c8858b33e3efef42086875c0b0836d2296 
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 <cutils/compiler.h>
24
25#include <utils/Atomic.h>
26#include <utils/Errors.h>
27#include <utils/KeyedVector.h>
28#include <utils/RefBase.h>
29#include <utils/SortedVector.h>
30#include <utils/threads.h>
31
32#include <binder/BinderService.h>
33#include <binder/IMemory.h>
34
35#include <ui/PixelFormat.h>
36#include <surfaceflinger/IGraphicBufferAlloc.h>
37#include <surfaceflinger/ISurfaceComposer.h>
38#include <surfaceflinger/ISurfaceComposerClient.h>
39
40#include "Barrier.h"
41#include "Layer.h"
42
43#include "MessageQueue.h"
44
45namespace android {
46
47// ---------------------------------------------------------------------------
48
49class Client;
50class DisplayHardware;
51class DisplayEventConnection;
52class EventThread;
53class Layer;
54class LayerDim;
55class LayerScreenshot;
56struct surface_flinger_cblk_t;
57
58// ---------------------------------------------------------------------------
59
60class Client : public BnSurfaceComposerClient
61{
62public:
63        Client(const sp<SurfaceFlinger>& flinger);
64        ~Client();
65
66    status_t initCheck() const;
67
68    // protected by SurfaceFlinger::mStateLock
69    size_t attachLayer(const sp<LayerBaseClient>& layer);
70    void detachLayer(const LayerBaseClient* layer);
71    sp<LayerBaseClient> getLayerUser(int32_t i) const;
72
73private:
74    // ISurfaceComposerClient interface
75    virtual sp<ISurface> createSurface(
76            surface_data_t* params, const String8& name,
77            DisplayID display, uint32_t w, uint32_t h,PixelFormat format,
78            uint32_t flags);
79    virtual status_t destroySurface(SurfaceID surfaceId);
80    virtual status_t onTransact(
81        uint32_t code, const Parcel& data, Parcel* reply, uint32_t flags);
82
83    // constant
84    sp<SurfaceFlinger> mFlinger;
85
86    // protected by mLock
87    DefaultKeyedVector< size_t, wp<LayerBaseClient> > mLayers;
88    size_t mNameGenerator;
89
90    // thread-safe
91    mutable Mutex mLock;
92};
93
94class GraphicBufferAlloc : public BnGraphicBufferAlloc
95{
96public:
97    GraphicBufferAlloc();
98    virtual ~GraphicBufferAlloc();
99    virtual sp<GraphicBuffer> createGraphicBuffer(uint32_t w, uint32_t h,
100        PixelFormat format, uint32_t usage, status_t* error);
101};
102
103// ---------------------------------------------------------------------------
104
105class GraphicPlane
106{
107public:
108    static status_t orientationToTransfrom(int orientation, int w, int h,
109            Transform* tr);
110
111                                GraphicPlane();
112                                ~GraphicPlane();
113
114        bool                    initialized() const;
115
116        void                    setDisplayHardware(DisplayHardware *);
117        status_t                setOrientation(int orientation);
118        int                     getOrientation() const { return mOrientation; }
119        int                     getWidth() const;
120        int                     getHeight() const;
121
122        const DisplayHardware&  displayHardware() const;
123        DisplayHardware&        editDisplayHardware();
124        const Transform&        transform() const;
125        EGLDisplay              getEGLDisplay() const;
126
127private:
128                                GraphicPlane(const GraphicPlane&);
129        GraphicPlane            operator = (const GraphicPlane&);
130
131        DisplayHardware*        mHw;
132        Transform               mGlobalTransform;
133        Transform               mDisplayTransform;
134        int                     mOrientation;
135        float                   mDisplayWidth;
136        float                   mDisplayHeight;
137        int                     mWidth;
138        int                     mHeight;
139};
140
141// ---------------------------------------------------------------------------
142
143enum {
144    eTransactionNeeded      = 0x01,
145    eTraversalNeeded        = 0x02
146};
147
148class SurfaceFlinger :
149        public BinderService<SurfaceFlinger>,
150        public BnSurfaceComposer,
151        public IBinder::DeathRecipient,
152        protected Thread
153{
154public:
155    static char const* getServiceName() { return "SurfaceFlinger"; }
156
157                    SurfaceFlinger();
158    virtual         ~SurfaceFlinger();
159            void    init();
160
161    virtual status_t onTransact(
162        uint32_t code, const Parcel& data, Parcel* reply, uint32_t flags);
163
164    virtual status_t dump(int fd, const Vector<String16>& args);
165
166    // ISurfaceComposer interface
167    virtual sp<ISurfaceComposerClient>  createConnection();
168    virtual sp<IGraphicBufferAlloc>     createGraphicBufferAlloc();
169    virtual sp<IMemoryHeap>             getCblk() const;
170    virtual void                        bootFinished();
171    virtual void                        setTransactionState(const Vector<ComposerState>& state,
172                                                            int orientation, uint32_t flags);
173    virtual bool                        authenticateSurfaceTexture(const sp<ISurfaceTexture>& surface) const;
174    virtual sp<IDisplayEventConnection> createDisplayEventConnection();
175
176    virtual status_t captureScreen(DisplayID dpy,
177            sp<IMemoryHeap>* heap,
178            uint32_t* width, uint32_t* height,
179            PixelFormat* format, uint32_t reqWidth, uint32_t reqHeight,
180            uint32_t minLayerZ, uint32_t maxLayerZ);
181
182    virtual status_t                    turnElectronBeamOff(int32_t mode);
183    virtual status_t                    turnElectronBeamOn(int32_t mode);
184
185            void                        screenReleased(DisplayID dpy);
186            void                        screenAcquired(DisplayID dpy);
187
188            status_t renderScreenToTexture(DisplayID dpy,
189                    GLuint* textureName, GLfloat* uOut, GLfloat* vOut);
190            status_t renderScreenToTextureLocked(DisplayID dpy,
191                    GLuint* textureName, GLfloat* uOut, GLfloat* vOut);
192
193            status_t postMessageAsync(const sp<MessageBase>& msg,
194                    nsecs_t reltime=0, uint32_t flags = 0);
195
196            status_t postMessageSync(const sp<MessageBase>& msg,
197                    nsecs_t reltime=0, uint32_t flags = 0);
198
199    status_t removeLayer(const sp<LayerBase>& layer);
200    status_t addLayer(const sp<LayerBase>& layer);
201    status_t invalidateLayerVisibility(const sp<LayerBase>& layer);
202    void invalidateHwcGeometry();
203
204    sp<Layer> getLayer(const sp<ISurface>& sur) const;
205
206    GLuint getProtectedTexName() const { return mProtectedTexName; }
207
208
209    class MessageDestroyGLTexture : public MessageBase {
210        GLuint texture;
211    public:
212        MessageDestroyGLTexture(GLuint texture) : texture(texture) { }
213        virtual bool handler() {
214            glDeleteTextures(1, &texture);
215            return true;
216        }
217    };
218
219
220private:
221    // DeathRecipient interface
222    virtual void binderDied(const wp<IBinder>& who);
223
224private:
225    friend class Client;
226    friend class DisplayEventConnection;
227    friend class LayerBase;
228    friend class LayerBaseClient;
229    friend class Layer;
230
231    sp<ISurface> createSurface(
232            ISurfaceComposerClient::surface_data_t* params,
233            const String8& name,
234            const sp<Client>& client,
235            DisplayID display, uint32_t w, uint32_t h, PixelFormat format,
236            uint32_t flags);
237
238    sp<Layer> createNormalSurface(
239            const sp<Client>& client, DisplayID display,
240            uint32_t w, uint32_t h, uint32_t flags,
241            PixelFormat& format);
242
243    sp<LayerDim> createDimSurface(
244            const sp<Client>& client, DisplayID display,
245            uint32_t w, uint32_t h, uint32_t flags);
246
247    sp<LayerScreenshot> createScreenshotSurface(
248            const sp<Client>& client, DisplayID display,
249            uint32_t w, uint32_t h, uint32_t flags);
250
251    status_t removeSurface(const sp<Client>& client, SurfaceID sid);
252    status_t destroySurface(const wp<LayerBaseClient>& layer);
253    uint32_t setClientStateLocked(const sp<Client>& client, const layer_state_t& s);
254
255    class LayerVector : public SortedVector< sp<LayerBase> > {
256    public:
257        LayerVector() { }
258        LayerVector(const LayerVector& rhs) : SortedVector< sp<LayerBase> >(rhs) { }
259        virtual int do_compare(const void* lhs, const void* rhs) const {
260            const sp<LayerBase>& l(*reinterpret_cast<const sp<LayerBase>*>(lhs));
261            const sp<LayerBase>& r(*reinterpret_cast<const sp<LayerBase>*>(rhs));
262            // sort layers by Z order
263            uint32_t lz = l->currentState().z;
264            uint32_t rz = r->currentState().z;
265            // then by sequence, so we get a stable ordering
266            return (lz != rz) ? (lz - rz) : (l->sequence - r->sequence);
267        }
268    };
269
270    struct State {
271        State() {
272            orientation = ISurfaceComposer::eOrientationDefault;
273        }
274        LayerVector     layersSortedByZ;
275        uint8_t         orientation;
276        uint8_t         orientationFlags;
277    };
278
279    virtual bool        threadLoop();
280    virtual status_t    readyToRun();
281    virtual void        onFirstRef();
282
283public:     // hack to work around gcc 4.0.3 bug
284    const GraphicPlane&     graphicPlane(int dpy) const;
285          GraphicPlane&     graphicPlane(int dpy);
286          void              signalEvent();
287          void              repaintEverything();
288
289private:
290            void        waitForEvent();
291            void        handleConsoleEvents();
292            void        handleTransaction(uint32_t transactionFlags);
293            void        handleTransactionLocked(uint32_t transactionFlags);
294
295            void        computeVisibleRegions(
296                            const LayerVector& currentLayers,
297                            Region& dirtyRegion,
298                            Region& wormholeRegion);
299
300            void        handlePageFlip();
301            bool        lockPageFlip(const LayerVector& currentLayers);
302            void        unlockPageFlip(const LayerVector& currentLayers);
303            void        handleWorkList();
304            void        handleRepaint();
305            void        postFramebuffer();
306            void        setupHardwareComposer(Region& dirtyInOut);
307            void        composeSurfaces(const Region& dirty);
308
309
310            void        setInvalidateRegion(const Region& reg);
311            Region      getAndClearInvalidateRegion();
312
313            ssize_t     addClientLayer(const sp<Client>& client,
314                    const sp<LayerBaseClient>& lbc);
315            status_t    addLayer_l(const sp<LayerBase>& layer);
316            status_t    removeLayer_l(const sp<LayerBase>& layer);
317            status_t    purgatorizeLayer_l(const sp<LayerBase>& layer);
318
319            uint32_t    getTransactionFlags(uint32_t flags);
320            uint32_t    peekTransactionFlags(uint32_t flags);
321            uint32_t    setTransactionFlags(uint32_t flags);
322            void        commitTransaction();
323
324
325            status_t captureScreenImplLocked(DisplayID dpy,
326                    sp<IMemoryHeap>* heap,
327                    uint32_t* width, uint32_t* height, PixelFormat* format,
328                    uint32_t reqWidth, uint32_t reqHeight,
329                    uint32_t minLayerZ, uint32_t maxLayerZ);
330
331            status_t turnElectronBeamOffImplLocked(int32_t mode);
332            status_t turnElectronBeamOnImplLocked(int32_t mode);
333            status_t electronBeamOffAnimationImplLocked();
334            status_t electronBeamOnAnimationImplLocked();
335
336            void        debugFlashRegions();
337            void        drawWormhole() const;
338
339            void listLayersLocked(const Vector<String16>& args, size_t& index,
340                    String8& result, char* buffer, size_t SIZE) const;
341            void dumpStatsLocked(const Vector<String16>& args, size_t& index,
342                    String8& result, char* buffer, size_t SIZE) const;
343            void clearStatsLocked(const Vector<String16>& args, size_t& index,
344                    String8& result, char* buffer, size_t SIZE) const;
345            void dumpAllLocked(String8& result, char* buffer, size_t SIZE) const;
346
347    mutable     MessageQueue    mEventQueue;
348
349                // access must be protected by mStateLock
350    mutable     Mutex                   mStateLock;
351                State                   mCurrentState;
352    volatile    int32_t                 mTransactionFlags;
353                Condition               mTransactionCV;
354                SortedVector< sp<LayerBase> > mLayerPurgatory;
355                bool                    mTransationPending;
356                Vector< sp<LayerBase> > mLayersPendingRemoval;
357
358                // protected by mStateLock (but we could use another lock)
359                GraphicPlane                mGraphicPlanes[1];
360                bool                        mLayersRemoved;
361                DefaultKeyedVector< wp<IBinder>, wp<Layer> > mLayerMap;
362
363                // access must be protected by mInvalidateLock
364    mutable     Mutex                       mInvalidateLock;
365                Region                      mInvalidateRegion;
366
367                // constant members (no synchronization needed for access)
368                sp<IMemoryHeap>             mServerHeap;
369                surface_flinger_cblk_t*     mServerCblk;
370                GLuint                      mWormholeTexName;
371                GLuint                      mProtectedTexName;
372                nsecs_t                     mBootTime;
373                sp<EventThread>             mEventThread;
374
375                // Can only accessed from the main thread, these members
376                // don't need synchronization
377                State                       mDrawingState;
378                Region                      mDirtyRegion;
379                Region                      mDirtyRegionRemovedLayer;
380                Region                      mSwapRegion;
381                Region                      mWormholeRegion;
382                bool                        mVisibleRegionsDirty;
383                bool                        mHwWorkListDirty;
384                int32_t                     mElectronBeamAnimationMode;
385                Vector< sp<LayerBase> >     mVisibleLayersSortedByZ;
386
387
388                // don't use a lock for these, we don't care
389                int                         mDebugRegion;
390                int                         mDebugBackground;
391                int                         mDebugDDMS;
392                int                         mDebugDisableHWC;
393                int                         mDebugDisableTransformHint;
394                volatile nsecs_t            mDebugInSwapBuffers;
395                nsecs_t                     mLastSwapBufferTime;
396                volatile nsecs_t            mDebugInTransaction;
397                nsecs_t                     mLastTransactionTime;
398                bool                        mBootFinished;
399
400                // these are thread safe
401    mutable     Barrier                     mReadyToRunBarrier;
402
403
404                // protected by mDestroyedLayerLock;
405    mutable     Mutex                       mDestroyedLayerLock;
406                Vector<LayerBase const *>   mDestroyedLayers;
407
408                // atomic variables
409                enum {
410                    eConsoleReleased = 1,
411                    eConsoleAcquired = 2
412                };
413   volatile     int32_t                     mConsoleSignals;
414
415   // only written in the main thread, only read in other threads
416   volatile     int32_t                     mSecureFrameBuffer;
417};
418
419// ---------------------------------------------------------------------------
420}; // namespace android
421
422#endif // ANDROID_SURFACE_FLINGER_H
423