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