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