SurfaceFlinger.h revision 74c40c0a273dbfd7d10617c4cc1b0c066bfc812e
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 virtual status_t captureScreen(DisplayID dpy, 197 sp<IMemoryHeap>* heap, 198 uint32_t* width, 199 uint32_t* height, 200 PixelFormat* format, 201 uint32_t reqWidth, 202 uint32_t reqHeight); 203 204 void screenReleased(DisplayID dpy); 205 void screenAcquired(DisplayID dpy); 206 207 overlay_control_device_t* getOverlayEngine() const; 208 209 status_t removeLayer(const sp<LayerBase>& layer); 210 status_t addLayer(const sp<LayerBase>& layer); 211 status_t invalidateLayerVisibility(const sp<LayerBase>& layer); 212 213 sp<Layer> getLayer(const sp<ISurface>& sur) const; 214 215private: 216 friend class Client; 217 friend class LayerBase; 218 friend class LayerBuffer; 219 friend class LayerBaseClient; 220 friend class LayerBaseClient::Surface; 221 friend class Layer; 222 friend class LayerBlur; 223 friend class LayerDim; 224 225 sp<ISurface> createSurface(const sp<Client>& client, 226 int pid, const String8& name, 227 ISurfaceComposerClient::surface_data_t* params, 228 DisplayID display, uint32_t w, uint32_t h, PixelFormat format, 229 uint32_t flags); 230 231 sp<Layer> createNormalSurface( 232 const sp<Client>& client, DisplayID display, 233 uint32_t w, uint32_t h, uint32_t flags, 234 PixelFormat& format); 235 236 sp<LayerBlur> createBlurSurface( 237 const sp<Client>& client, DisplayID display, 238 uint32_t w, uint32_t h, uint32_t flags); 239 240 sp<LayerDim> createDimSurface( 241 const sp<Client>& client, DisplayID display, 242 uint32_t w, uint32_t h, uint32_t flags); 243 244 sp<LayerBuffer> createPushBuffersSurface( 245 const sp<Client>& client, DisplayID display, 246 uint32_t w, uint32_t h, uint32_t flags); 247 248 status_t removeSurface(const sp<Client>& client, SurfaceID sid); 249 status_t destroySurface(const sp<LayerBaseClient>& layer); 250 status_t setClientState(const sp<Client>& client, 251 int32_t count, const layer_state_t* states); 252 253 class LayerVector : public SortedVector< sp<LayerBase> > { 254 public: 255 LayerVector() { } 256 LayerVector(const LayerVector& rhs) : SortedVector< sp<LayerBase> >(rhs) { } 257 virtual int do_compare(const void* lhs, const void* rhs) const { 258 const sp<LayerBase>& l(*reinterpret_cast<const sp<LayerBase>*>(lhs)); 259 const sp<LayerBase>& r(*reinterpret_cast<const sp<LayerBase>*>(rhs)); 260 // sort layers by Z order 261 uint32_t lz = l->currentState().z; 262 uint32_t rz = r->currentState().z; 263 // then by sequence, so we get a stable ordering 264 return (lz != rz) ? (lz - rz) : (l->sequence - r->sequence); 265 } 266 }; 267 268 struct State { 269 State() { 270 orientation = ISurfaceComposer::eOrientationDefault; 271 freezeDisplay = 0; 272 } 273 LayerVector layersSortedByZ; 274 uint8_t orientation; 275 uint8_t orientationType; 276 uint8_t freezeDisplay; 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); 286private: 287 288 void waitForEvent(); 289public: // hack to work around gcc 4.0.3 bug 290 void signalEvent(); 291private: 292 void handleConsoleEvents(); 293 void handleTransaction(uint32_t transactionFlags); 294 void handleTransactionLocked( 295 uint32_t transactionFlags, 296 Vector< sp<LayerBase> >& ditchedLayers); 297 298 void computeVisibleRegions( 299 LayerVector& currentLayers, 300 Region& dirtyRegion, 301 Region& wormholeRegion); 302 303 void handlePageFlip(); 304 bool lockPageFlip(const LayerVector& currentLayers); 305 void unlockPageFlip(const LayerVector& currentLayers); 306 void handleWorkList(); 307 void handleRepaint(); 308 void postFramebuffer(); 309 void composeSurfaces(const Region& dirty); 310 void unlockClients(); 311 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 setTransactionFlags(uint32_t flags); 321 void commitTransaction(); 322 323 324 status_t captureScreenImplLocked(DisplayID dpy, 325 sp<IMemoryHeap>* heap, 326 uint32_t* width, uint32_t* height, PixelFormat* format, 327 uint32_t reqWidth = 0, uint32_t reqHeight = 0); 328 329 friend class FreezeLock; 330 sp<FreezeLock> getFreezeLock() const; 331 inline void incFreezeCount() { 332 if (mFreezeCount == 0) 333 mFreezeDisplayTime = 0; 334 mFreezeCount++; 335 } 336 inline void decFreezeCount() { if (mFreezeCount > 0) mFreezeCount--; } 337 inline bool hasFreezeRequest() const { return mFreezeDisplay; } 338 inline bool isFrozen() const { 339 return (mFreezeDisplay || mFreezeCount>0) && mBootFinished; 340 } 341 342 343 void debugFlashRegions(); 344 void debugShowFPS() const; 345 void drawWormhole() const; 346 347 348 mutable MessageQueue mEventQueue; 349 350 status_t postMessageAsync(const sp<MessageBase>& msg, 351 nsecs_t reltime=0, uint32_t flags = 0); 352 353 status_t postMessageSync(const sp<MessageBase>& msg, 354 nsecs_t reltime=0, uint32_t flags = 0); 355 356 // access must be protected by mStateLock 357 mutable Mutex mStateLock; 358 State mCurrentState; 359 State mDrawingState; 360 volatile int32_t mTransactionFlags; 361 volatile int32_t mTransactionCount; 362 Condition mTransactionCV; 363 bool mResizeTransationPending; 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 // constant members (no synchronization needed for access) 371 sp<IMemoryHeap> mServerHeap; 372 surface_flinger_cblk_t* mServerCblk; 373 GLuint mWormholeTexName; 374 nsecs_t mBootTime; 375 Permission mHardwareTest; 376 Permission mAccessSurfaceFlinger; 377 Permission mReadFramebuffer; 378 Permission mDump; 379 380 // Can only accessed from the main thread, these members 381 // don't need synchronization 382 Region mDirtyRegion; 383 Region mDirtyRegionRemovedLayer; 384 Region mInvalidRegion; 385 Region mWormholeRegion; 386 bool mVisibleRegionsDirty; 387 bool mHwWorkListDirty; 388 bool mDeferReleaseConsole; 389 bool mFreezeDisplay; 390 int32_t mFreezeCount; 391 nsecs_t mFreezeDisplayTime; 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 mDebugDisableHWC; 399 volatile nsecs_t mDebugInSwapBuffers; 400 nsecs_t mLastSwapBufferTime; 401 volatile nsecs_t mDebugInTransaction; 402 nsecs_t mLastTransactionTime; 403 bool mBootFinished; 404 405 // these are thread safe 406 mutable Barrier mReadyToRunBarrier; 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 421class FreezeLock : public LightRefBase<FreezeLock> { 422 SurfaceFlinger* mFlinger; 423public: 424 FreezeLock(SurfaceFlinger* flinger) 425 : mFlinger(flinger) { 426 mFlinger->incFreezeCount(); 427 } 428 ~FreezeLock() { 429 mFlinger->decFreezeCount(); 430 } 431}; 432 433// --------------------------------------------------------------------------- 434}; // namespace android 435 436#endif // ANDROID_SURFACE_FLINGER_H 437