SurfaceFlinger.h revision cb9732a951d20cacb7ebe2dab132b5738226b1b6 
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 <gui/IGraphicBufferAlloc.h>
37#include <gui/ISurfaceComposer.h>
38#include <gui/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            void onMessageReceived(int32_t what);
194
195            status_t postMessageAsync(const sp<MessageBase>& msg,
196                    nsecs_t reltime=0, uint32_t flags = 0);
197
198            status_t postMessageSync(const sp<MessageBase>& msg,
199                    nsecs_t reltime=0, uint32_t flags = 0);
200
201    status_t removeLayer(const sp<LayerBase>& layer);
202    status_t addLayer(const sp<LayerBase>& layer);
203    status_t invalidateLayerVisibility(const sp<LayerBase>& layer);
204    void invalidateHwcGeometry();
205
206    sp<Layer> getLayer(const sp<ISurface>& sur) const;
207
208    GLuint getProtectedTexName() const { return mProtectedTexName; }
209
210
211    class MessageDestroyGLTexture : public MessageBase {
212        GLuint texture;
213    public:
214        MessageDestroyGLTexture(GLuint texture) : texture(texture) { }
215        virtual bool handler() {
216            glDeleteTextures(1, &texture);
217            return true;
218        }
219    };
220
221
222private:
223    // DeathRecipient interface
224    virtual void binderDied(const wp<IBinder>& who);
225
226private:
227    friend class Client;
228    friend class DisplayEventConnection;
229    friend class LayerBase;
230    friend class LayerBaseClient;
231    friend class Layer;
232
233    sp<ISurface> createSurface(
234            ISurfaceComposerClient::surface_data_t* params,
235            const String8& name,
236            const sp<Client>& client,
237            DisplayID display, uint32_t w, uint32_t h, PixelFormat format,
238            uint32_t flags);
239
240    sp<Layer> createNormalSurface(
241            const sp<Client>& client, DisplayID display,
242            uint32_t w, uint32_t h, uint32_t flags,
243            PixelFormat& format);
244
245    sp<LayerDim> createDimSurface(
246            const sp<Client>& client, DisplayID display,
247            uint32_t w, uint32_t h, uint32_t flags);
248
249    sp<LayerScreenshot> createScreenshotSurface(
250            const sp<Client>& client, DisplayID display,
251            uint32_t w, uint32_t h, uint32_t flags);
252
253    status_t removeSurface(const sp<Client>& client, SurfaceID sid);
254    status_t destroySurface(const wp<LayerBaseClient>& layer);
255    uint32_t setClientStateLocked(const sp<Client>& client, const layer_state_t& s);
256
257    class LayerVector : public SortedVector< sp<LayerBase> > {
258    public:
259        LayerVector() { }
260        LayerVector(const LayerVector& rhs) : SortedVector< sp<LayerBase> >(rhs) { }
261        virtual int do_compare(const void* lhs, const void* rhs) const {
262            const sp<LayerBase>& l(*reinterpret_cast<const sp<LayerBase>*>(lhs));
263            const sp<LayerBase>& r(*reinterpret_cast<const sp<LayerBase>*>(rhs));
264            // sort layers by Z order
265            uint32_t lz = l->currentState().z;
266            uint32_t rz = r->currentState().z;
267            // then by sequence, so we get a stable ordering
268            return (lz != rz) ? (lz - rz) : (l->sequence - r->sequence);
269        }
270    };
271
272    struct State {
273        State()
274            : orientation(ISurfaceComposer::eOrientationDefault),
275              orientationFlags(0) {
276        }
277        LayerVector     layersSortedByZ;
278        uint8_t         orientation;
279        uint8_t         orientationFlags;
280    };
281
282    virtual bool        threadLoop();
283    virtual status_t    readyToRun();
284    virtual void        onFirstRef();
285
286public:     // hack to work around gcc 4.0.3 bug
287    const GraphicPlane&     graphicPlane(int dpy) const;
288          GraphicPlane&     graphicPlane(int dpy);
289
290          void              signalTransaction();
291          void              signalLayerUpdate();
292          void              signalRefresh();
293          void              repaintEverything();
294
295private:
296            void        waitForEvent();
297            void        handleConsoleEvents();
298            void        handleTransaction(uint32_t transactionFlags);
299            void        handleTransactionLocked(uint32_t transactionFlags);
300
301            void        computeVisibleRegions(
302                            const LayerVector& currentLayers,
303                            Region& dirtyRegion,
304                            Region& wormholeRegion);
305
306            void        handlePageFlip();
307            bool        lockPageFlip(const LayerVector& currentLayers);
308            void        unlockPageFlip(const LayerVector& currentLayers);
309            void        handleRefresh();
310            void        handleWorkList();
311            void        handleRepaint();
312            void        postFramebuffer();
313            void        setupHardwareComposer(Region& dirtyInOut);
314            void        composeSurfaces(const Region& dirty);
315
316
317            void        setInvalidateRegion(const Region& reg);
318            Region      getAndClearInvalidateRegion();
319
320            ssize_t     addClientLayer(const sp<Client>& client,
321                    const sp<LayerBaseClient>& lbc);
322            status_t    addLayer_l(const sp<LayerBase>& layer);
323            status_t    removeLayer_l(const sp<LayerBase>& layer);
324            status_t    purgatorizeLayer_l(const sp<LayerBase>& layer);
325
326            uint32_t    getTransactionFlags(uint32_t flags);
327            uint32_t    peekTransactionFlags(uint32_t flags);
328            uint32_t    setTransactionFlags(uint32_t flags);
329            void        commitTransaction();
330
331
332            status_t captureScreenImplLocked(DisplayID dpy,
333                    sp<IMemoryHeap>* heap,
334                    uint32_t* width, uint32_t* height, PixelFormat* format,
335                    uint32_t reqWidth, uint32_t reqHeight,
336                    uint32_t minLayerZ, uint32_t maxLayerZ);
337
338            status_t turnElectronBeamOffImplLocked(int32_t mode);
339            status_t turnElectronBeamOnImplLocked(int32_t mode);
340            status_t electronBeamOffAnimationImplLocked();
341            status_t electronBeamOnAnimationImplLocked();
342
343            void        debugFlashRegions();
344            void        drawWormhole() const;
345
346            void listLayersLocked(const Vector<String16>& args, size_t& index,
347                    String8& result, char* buffer, size_t SIZE) const;
348            void dumpStatsLocked(const Vector<String16>& args, size_t& index,
349                    String8& result, char* buffer, size_t SIZE) const;
350            void clearStatsLocked(const Vector<String16>& args, size_t& index,
351                    String8& result, char* buffer, size_t SIZE) const;
352            void dumpAllLocked(String8& result, char* buffer, size_t SIZE) const;
353
354    mutable     MessageQueue    mEventQueue;
355
356                // access must be protected by mStateLock
357    mutable     Mutex                   mStateLock;
358                State                   mCurrentState;
359    volatile    int32_t                 mTransactionFlags;
360                Condition               mTransactionCV;
361                SortedVector< sp<LayerBase> > mLayerPurgatory;
362                bool                    mTransationPending;
363                Vector< sp<LayerBase> > mLayersPendingRemoval;
364
365                // protected by mStateLock (but we could use another lock)
366                GraphicPlane                mGraphicPlanes[1];
367                bool                        mLayersRemoved;
368                DefaultKeyedVector< wp<IBinder>, wp<Layer> > mLayerMap;
369
370                // access must be protected by mInvalidateLock
371    mutable     Mutex                       mInvalidateLock;
372                Region                      mInvalidateRegion;
373
374                // constant members (no synchronization needed for access)
375                sp<IMemoryHeap>             mServerHeap;
376                surface_flinger_cblk_t*     mServerCblk;
377                GLuint                      mWormholeTexName;
378                GLuint                      mProtectedTexName;
379                nsecs_t                     mBootTime;
380                sp<EventThread>             mEventThread;
381
382                // Can only accessed from the main thread, these members
383                // don't need synchronization
384                State                       mDrawingState;
385                Region                      mDirtyRegion;
386                Region                      mDirtyRegionRemovedLayer;
387                Region                      mSwapRegion;
388                Region                      mWormholeRegion;
389                bool                        mVisibleRegionsDirty;
390                bool                        mHwWorkListDirty;
391                int32_t                     mElectronBeamAnimationMode;
392                Vector< sp<LayerBase> >     mVisibleLayersSortedByZ;
393
394
395                // don't use a lock for these, we don't care
396                int                         mDebugRegion;
397                int                         mDebugBackground;
398                int                         mDebugDDMS;
399                int                         mDebugDisableHWC;
400                int                         mDebugDisableTransformHint;
401                volatile nsecs_t            mDebugInSwapBuffers;
402                nsecs_t                     mLastSwapBufferTime;
403                volatile nsecs_t            mDebugInTransaction;
404                nsecs_t                     mLastTransactionTime;
405                bool                        mBootFinished;
406
407                // these are thread safe
408    mutable     Barrier                     mReadyToRunBarrier;
409
410
411                // protected by mDestroyedLayerLock;
412    mutable     Mutex                       mDestroyedLayerLock;
413                Vector<LayerBase const *>   mDestroyedLayers;
414
415                // atomic variables
416                enum {
417                    eConsoleReleased = 1,
418                    eConsoleAcquired = 2
419                };
420   volatile     int32_t                     mConsoleSignals;
421
422   // only written in the main thread, only read in other threads
423   volatile     int32_t                     mSecureFrameBuffer;
424};
425
426// ---------------------------------------------------------------------------
427}; // namespace android
428
429#endif // ANDROID_SURFACE_FLINGER_H
430