SurfaceFlinger.h revision 1b0b30d04304392748a8a4ab5a69e52a19f51b3a
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 202 void screenReleased(DisplayID dpy); 203 void screenAcquired(DisplayID dpy); 204 205 overlay_control_device_t* getOverlayEngine() const; 206 207 status_t removeLayer(const sp<LayerBase>& layer); 208 status_t addLayer(const sp<LayerBase>& layer); 209 status_t invalidateLayerVisibility(const sp<LayerBase>& layer); 210 211 sp<Layer> getLayer(const sp<ISurface>& sur) const; 212 213private: 214 friend class Client; 215 friend class LayerBase; 216 friend class LayerBuffer; 217 friend class LayerBaseClient; 218 friend class LayerBaseClient::Surface; 219 friend class Layer; 220 friend class LayerBlur; 221 friend class LayerDim; 222 223 sp<ISurface> createSurface(const sp<Client>& client, 224 int pid, const String8& name, 225 ISurfaceComposerClient::surface_data_t* params, 226 DisplayID display, uint32_t w, uint32_t h, PixelFormat format, 227 uint32_t flags); 228 229 sp<Layer> createNormalSurface( 230 const sp<Client>& client, DisplayID display, 231 uint32_t w, uint32_t h, uint32_t flags, 232 PixelFormat& format); 233 234 sp<LayerBlur> createBlurSurface( 235 const sp<Client>& client, DisplayID display, 236 uint32_t w, uint32_t h, uint32_t flags); 237 238 sp<LayerDim> createDimSurface( 239 const sp<Client>& client, DisplayID display, 240 uint32_t w, uint32_t h, uint32_t flags); 241 242 sp<LayerBuffer> createPushBuffersSurface( 243 const sp<Client>& client, DisplayID display, 244 uint32_t w, uint32_t h, uint32_t flags); 245 246 status_t removeSurface(const sp<Client>& client, SurfaceID sid); 247 status_t destroySurface(const sp<LayerBaseClient>& layer); 248 status_t setClientState(const sp<Client>& client, 249 int32_t count, const layer_state_t* states); 250 251 class LayerVector : public SortedVector< sp<LayerBase> > { 252 public: 253 LayerVector() { } 254 LayerVector(const LayerVector& rhs) : SortedVector< sp<LayerBase> >(rhs) { } 255 virtual int do_compare(const void* lhs, const void* rhs) const { 256 const sp<LayerBase>& l(*reinterpret_cast<const sp<LayerBase>*>(lhs)); 257 const sp<LayerBase>& r(*reinterpret_cast<const sp<LayerBase>*>(rhs)); 258 // sort layers by Z order 259 uint32_t lz = l->currentState().z; 260 uint32_t rz = r->currentState().z; 261 // then by sequence, so we get a stable ordering 262 return (lz != rz) ? (lz - rz) : (l->sequence - r->sequence); 263 } 264 }; 265 266 struct State { 267 State() { 268 orientation = ISurfaceComposer::eOrientationDefault; 269 freezeDisplay = 0; 270 } 271 LayerVector layersSortedByZ; 272 uint8_t orientation; 273 uint8_t orientationType; 274 uint8_t freezeDisplay; 275 }; 276 277 virtual bool threadLoop(); 278 virtual status_t readyToRun(); 279 virtual void onFirstRef(); 280 281public: // hack to work around gcc 4.0.3 bug 282 const GraphicPlane& graphicPlane(int dpy) const; 283 GraphicPlane& graphicPlane(int dpy); 284private: 285 286 void waitForEvent(); 287public: // hack to work around gcc 4.0.3 bug 288 void signalEvent(); 289private: 290 void handleConsoleEvents(); 291 void handleTransaction(uint32_t transactionFlags); 292 void handleTransactionLocked( 293 uint32_t transactionFlags, 294 Vector< sp<LayerBase> >& ditchedLayers); 295 296 void computeVisibleRegions( 297 LayerVector& currentLayers, 298 Region& dirtyRegion, 299 Region& wormholeRegion); 300 301 void handlePageFlip(); 302 bool lockPageFlip(const LayerVector& currentLayers); 303 void unlockPageFlip(const LayerVector& currentLayers); 304 void handleRepaint(); 305 void postFramebuffer(); 306 void composeSurfaces(const Region& dirty); 307 void unlockClients(); 308 309 310 ssize_t addClientLayer(const sp<Client>& client, 311 const sp<LayerBaseClient>& lbc); 312 status_t addLayer_l(const sp<LayerBase>& layer); 313 status_t removeLayer_l(const sp<LayerBase>& layer); 314 status_t purgatorizeLayer_l(const sp<LayerBase>& layer); 315 316 uint32_t getTransactionFlags(uint32_t flags); 317 uint32_t setTransactionFlags(uint32_t flags); 318 void commitTransaction(); 319 320 321 friend class FreezeLock; 322 sp<FreezeLock> getFreezeLock() const; 323 inline void incFreezeCount() { 324 if (mFreezeCount == 0) 325 mFreezeDisplayTime = 0; 326 mFreezeCount++; 327 } 328 inline void decFreezeCount() { if (mFreezeCount > 0) mFreezeCount--; } 329 inline bool hasFreezeRequest() const { return mFreezeDisplay; } 330 inline bool isFrozen() const { 331 return (mFreezeDisplay || mFreezeCount>0) && mBootFinished; 332 } 333 334 335 void debugFlashRegions(); 336 void debugShowFPS() const; 337 void drawWormhole() const; 338 339 340 mutable MessageQueue mEventQueue; 341 342 status_t postMessageAsync(const sp<MessageBase>& msg, 343 nsecs_t reltime=0, uint32_t flags = 0); 344 345 status_t postMessageSync(const sp<MessageBase>& msg, 346 nsecs_t reltime=0, uint32_t flags = 0); 347 348 // access must be protected by mStateLock 349 mutable Mutex mStateLock; 350 State mCurrentState; 351 State mDrawingState; 352 volatile int32_t mTransactionFlags; 353 volatile int32_t mTransactionCount; 354 Condition mTransactionCV; 355 bool mResizeTransationPending; 356 357 // protected by mStateLock (but we could use another lock) 358 GraphicPlane mGraphicPlanes[1]; 359 bool mLayersRemoved; 360 DefaultKeyedVector< wp<IBinder>, wp<Layer> > mLayerMap; 361 362 // constant members (no synchronization needed for access) 363 sp<IMemoryHeap> mServerHeap; 364 surface_flinger_cblk_t* mServerCblk; 365 GLuint mWormholeTexName; 366 nsecs_t mBootTime; 367 Permission mHardwareTest; 368 Permission mAccessSurfaceFlinger; 369 Permission mReadFramebuffer; 370 Permission mDump; 371 372 // Can only accessed from the main thread, these members 373 // don't need synchronization 374 Region mDirtyRegion; 375 Region mDirtyRegionRemovedLayer; 376 Region mInvalidRegion; 377 Region mWormholeRegion; 378 bool mVisibleRegionsDirty; 379 bool mDeferReleaseConsole; 380 bool mFreezeDisplay; 381 int32_t mFreezeCount; 382 nsecs_t mFreezeDisplayTime; 383 Vector< sp<LayerBase> > mVisibleLayersSortedByZ; 384 385 386 // don't use a lock for these, we don't care 387 int mDebugRegion; 388 int mDebugBackground; 389 volatile nsecs_t mDebugInSwapBuffers; 390 nsecs_t mLastSwapBufferTime; 391 volatile nsecs_t mDebugInTransaction; 392 nsecs_t mLastTransactionTime; 393 bool mBootFinished; 394 395 // these are thread safe 396 mutable Barrier mReadyToRunBarrier; 397 398 // atomic variables 399 enum { 400 eConsoleReleased = 1, 401 eConsoleAcquired = 2 402 }; 403 volatile int32_t mConsoleSignals; 404 405 // only written in the main thread, only read in other threads 406 volatile int32_t mSecureFrameBuffer; 407}; 408 409// --------------------------------------------------------------------------- 410 411class FreezeLock : public LightRefBase<FreezeLock> { 412 SurfaceFlinger* mFlinger; 413public: 414 FreezeLock(SurfaceFlinger* flinger) 415 : mFlinger(flinger) { 416 mFlinger->incFreezeCount(); 417 } 418 ~FreezeLock() { 419 mFlinger->decFreezeCount(); 420 } 421}; 422 423// --------------------------------------------------------------------------- 424}; // namespace android 425 426#endif // ANDROID_SURFACE_FLINGER_H 427