CanvasContext.cpp revision 6058251939e417ed764d76fbde77eefc964d0ee6 
1/*
2 * Copyright (C) 2014 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#include "CanvasContext.h"
18
19#include "AnimationContext.h"
20#include "Caches.h"
21#include "DeferredLayerUpdater.h"
22#include "EglManager.h"
23#include "LayerRenderer.h"
24#include "OpenGLRenderer.h"
25#include "Properties.h"
26#include "RenderThread.h"
27#include "renderstate/RenderState.h"
28#include "renderstate/Stencil.h"
29
30#include <algorithm>
31#include <strings.h>
32#include <cutils/properties.h>
33#include <private/hwui/DrawGlInfo.h>
34
35#define TRIM_MEMORY_COMPLETE 80
36#define TRIM_MEMORY_UI_HIDDEN 20
37
38namespace android {
39namespace uirenderer {
40namespace renderthread {
41
42CanvasContext::CanvasContext(RenderThread& thread, bool translucent,
43        RenderNode* rootRenderNode, IContextFactory* contextFactory)
44        : mRenderThread(thread)
45        , mEglManager(thread.eglManager())
46        , mOpaque(!translucent)
47        , mAnimationContext(contextFactory->createAnimationContext(mRenderThread.timeLord()))
48        , mRootRenderNode(rootRenderNode)
49        , mJankTracker(thread.timeLord().frameIntervalNanos())
50        , mProfiler(mFrames) {
51    mRenderThread.renderState().registerCanvasContext(this);
52    mProfiler.setDensity(mRenderThread.mainDisplayInfo().density);
53}
54
55CanvasContext::~CanvasContext() {
56    destroy();
57    mRenderThread.renderState().unregisterCanvasContext(this);
58}
59
60void CanvasContext::destroy() {
61    stopDrawing();
62    setSurface(nullptr);
63    freePrefetechedLayers();
64    destroyHardwareResources();
65    mAnimationContext->destroy();
66    if (mCanvas) {
67        delete mCanvas;
68        mCanvas = nullptr;
69    }
70}
71
72void CanvasContext::setSurface(ANativeWindow* window) {
73    ATRACE_CALL();
74
75    mNativeWindow = window;
76
77    if (mEglSurface != EGL_NO_SURFACE) {
78        mEglManager.destroySurface(mEglSurface);
79        mEglSurface = EGL_NO_SURFACE;
80    }
81
82    if (window) {
83        mEglSurface = mEglManager.createSurface(window);
84    }
85
86    if (mEglSurface != EGL_NO_SURFACE) {
87        const bool preserveBuffer = (mSwapBehavior != kSwap_discardBuffer);
88        mBufferPreserved = mEglManager.setPreserveBuffer(mEglSurface, preserveBuffer);
89        mHaveNewSurface = true;
90        makeCurrent();
91    } else {
92        mRenderThread.removeFrameCallback(this);
93    }
94}
95
96void CanvasContext::swapBuffers(const SkRect& dirty, EGLint width, EGLint height) {
97    if (CC_UNLIKELY(!mEglManager.swapBuffers(mEglSurface, dirty, width, height))) {
98        setSurface(nullptr);
99    }
100    mHaveNewSurface = false;
101}
102
103void CanvasContext::requireSurface() {
104    LOG_ALWAYS_FATAL_IF(mEglSurface == EGL_NO_SURFACE,
105            "requireSurface() called but no surface set!");
106    makeCurrent();
107}
108
109void CanvasContext::setSwapBehavior(SwapBehavior swapBehavior) {
110    mSwapBehavior = swapBehavior;
111}
112
113bool CanvasContext::initialize(ANativeWindow* window) {
114    setSurface(window);
115    if (mCanvas) return false;
116    mCanvas = new OpenGLRenderer(mRenderThread.renderState());
117    mCanvas->initProperties();
118    return true;
119}
120
121void CanvasContext::updateSurface(ANativeWindow* window) {
122    setSurface(window);
123}
124
125bool CanvasContext::pauseSurface(ANativeWindow* window) {
126    return mRenderThread.removeFrameCallback(this);
127}
128
129// TODO: don't pass viewport size, it's automatic via EGL
130void CanvasContext::setup(int width, int height, float lightRadius,
131        uint8_t ambientShadowAlpha, uint8_t spotShadowAlpha) {
132    if (!mCanvas) return;
133    mCanvas->initLight(lightRadius, ambientShadowAlpha, spotShadowAlpha);
134}
135
136void CanvasContext::setLightCenter(const Vector3& lightCenter) {
137    if (!mCanvas) return;
138    mCanvas->setLightCenter(lightCenter);
139}
140
141void CanvasContext::setOpaque(bool opaque) {
142    mOpaque = opaque;
143}
144
145void CanvasContext::makeCurrent() {
146    // TODO: Figure out why this workaround is needed, see b/13913604
147    // In the meantime this matches the behavior of GLRenderer, so it is not a regression
148    mHaveNewSurface |= mEglManager.makeCurrent(mEglSurface);
149}
150
151void CanvasContext::processLayerUpdate(DeferredLayerUpdater* layerUpdater) {
152    bool success = layerUpdater->apply();
153    LOG_ALWAYS_FATAL_IF(!success, "Failed to update layer!");
154    if (layerUpdater->backingLayer()->deferredUpdateScheduled) {
155        mCanvas->pushLayerUpdate(layerUpdater->backingLayer());
156    }
157}
158
159static bool wasSkipped(FrameInfo* info) {
160    return info && ((*info)[FrameInfoIndex::kFlags] & FrameInfoFlags::kSkippedFrame);
161}
162
163void CanvasContext::prepareTree(TreeInfo& info, int64_t* uiFrameInfo) {
164    mRenderThread.removeFrameCallback(this);
165
166    // If the previous frame was dropped we don't need to hold onto it, so
167    // just keep using the previous frame's structure instead
168    if (!wasSkipped(mCurrentFrameInfo)) {
169        mCurrentFrameInfo = &mFrames.next();
170    }
171    mCurrentFrameInfo->importUiThreadInfo(uiFrameInfo);
172    mCurrentFrameInfo->markSyncStart();
173
174    info.damageAccumulator = &mDamageAccumulator;
175    info.renderer = mCanvas;
176    if (mPrefetechedLayers.size() && info.mode == TreeInfo::MODE_FULL) {
177        info.canvasContext = this;
178    }
179    mAnimationContext->startFrame(info.mode);
180    mRootRenderNode->prepareTree(info);
181    mAnimationContext->runRemainingAnimations(info);
182
183    if (info.canvasContext) {
184        freePrefetechedLayers();
185    }
186
187    if (CC_UNLIKELY(!mNativeWindow.get())) {
188        mCurrentFrameInfo->addFlag(FrameInfoFlags::kSkippedFrame);
189        info.out.canDrawThisFrame = false;
190        return;
191    }
192
193    int runningBehind = 0;
194    // TODO: This query is moderately expensive, investigate adding some sort
195    // of fast-path based off when we last called eglSwapBuffers() as well as
196    // last vsync time. Or something.
197    mNativeWindow->query(mNativeWindow.get(),
198            NATIVE_WINDOW_CONSUMER_RUNNING_BEHIND, &runningBehind);
199    info.out.canDrawThisFrame = !runningBehind;
200
201    if (!info.out.canDrawThisFrame) {
202        mCurrentFrameInfo->addFlag(FrameInfoFlags::kSkippedFrame);
203    }
204
205    if (info.out.hasAnimations || !info.out.canDrawThisFrame) {
206        if (!info.out.requiresUiRedraw) {
207            // If animationsNeedsRedraw is set don't bother posting for an RT anim
208            // as we will just end up fighting the UI thread.
209            mRenderThread.postFrameCallback(this);
210        }
211    }
212}
213
214void CanvasContext::stopDrawing() {
215    mRenderThread.removeFrameCallback(this);
216}
217
218void CanvasContext::notifyFramePending() {
219    ATRACE_CALL();
220    mRenderThread.pushBackFrameCallback(this);
221}
222
223void CanvasContext::draw() {
224    LOG_ALWAYS_FATAL_IF(!mCanvas || mEglSurface == EGL_NO_SURFACE,
225            "drawRenderNode called on a context with no canvas or surface!");
226
227    SkRect dirty;
228    mDamageAccumulator.finish(&dirty);
229
230    if (dirty.isEmpty() && Properties::skipEmptyFrames) {
231        mCurrentFrameInfo->addFlag(FrameInfoFlags::kSkippedFrame);
232        return;
233    }
234
235    mCurrentFrameInfo->markIssueDrawCommandsStart();
236
237    EGLint width, height;
238    mEglManager.beginFrame(mEglSurface, &width, &height);
239    if (width != mCanvas->getViewportWidth() || height != mCanvas->getViewportHeight()) {
240        mCanvas->setViewport(width, height);
241        dirty.setEmpty();
242    } else if (!mBufferPreserved || mHaveNewSurface) {
243        dirty.setEmpty();
244    } else {
245        if (!dirty.isEmpty() && !dirty.intersect(0, 0, width, height)) {
246            ALOGW("Dirty " RECT_STRING " doesn't intersect with 0 0 %d %d ?",
247                    SK_RECT_ARGS(dirty), width, height);
248            dirty.setEmpty();
249        }
250        profiler().unionDirty(&dirty);
251    }
252
253    if (!dirty.isEmpty()) {
254        mCanvas->prepareDirty(dirty.fLeft, dirty.fTop,
255                dirty.fRight, dirty.fBottom, mOpaque);
256    } else {
257        mCanvas->prepare(mOpaque);
258    }
259
260    Rect outBounds;
261    mCanvas->drawRenderNode(mRootRenderNode.get(), outBounds);
262
263    profiler().draw(mCanvas);
264
265    bool drew = mCanvas->finish();
266
267    // Even if we decided to cancel the frame, from the perspective of jank
268    // metrics the frame was swapped at this point
269    mCurrentFrameInfo->markSwapBuffers();
270
271    if (drew) {
272        swapBuffers(dirty, width, height);
273    }
274
275    // TODO: Use a fence for real completion?
276    mCurrentFrameInfo->markFrameCompleted();
277    mJankTracker.addFrame(*mCurrentFrameInfo);
278    mRenderThread.jankTracker().addFrame(*mCurrentFrameInfo);
279}
280
281// Called by choreographer to do an RT-driven animation
282void CanvasContext::doFrame() {
283    if (CC_UNLIKELY(!mCanvas || mEglSurface == EGL_NO_SURFACE)) {
284        return;
285    }
286
287    ATRACE_CALL();
288
289    int64_t frameInfo[UI_THREAD_FRAME_INFO_SIZE];
290    UiFrameInfoBuilder(frameInfo)
291        .addFlag(FrameInfoFlags::kRTAnimation)
292        .setVsync(mRenderThread.timeLord().computeFrameTimeNanos(),
293                mRenderThread.timeLord().latestVsync());
294
295    TreeInfo info(TreeInfo::MODE_RT_ONLY, mRenderThread.renderState());
296    prepareTree(info, frameInfo);
297    if (info.out.canDrawThisFrame) {
298        draw();
299    }
300}
301
302void CanvasContext::invokeFunctor(RenderThread& thread, Functor* functor) {
303    ATRACE_CALL();
304    DrawGlInfo::Mode mode = DrawGlInfo::kModeProcessNoContext;
305    if (thread.eglManager().hasEglContext()) {
306        mode = DrawGlInfo::kModeProcess;
307    }
308
309    thread.renderState().invokeFunctor(functor, mode, nullptr);
310}
311
312void CanvasContext::markLayerInUse(RenderNode* node) {
313    if (mPrefetechedLayers.erase(node)) {
314        node->decStrong(nullptr);
315    }
316}
317
318static void destroyPrefetechedNode(RenderNode* node) {
319    ALOGW("Incorrectly called buildLayer on View: %s, destroying layer...", node->getName());
320    node->destroyHardwareResources();
321    node->decStrong(nullptr);
322}
323
324void CanvasContext::freePrefetechedLayers() {
325    if (mPrefetechedLayers.size()) {
326        std::for_each(mPrefetechedLayers.begin(), mPrefetechedLayers.end(), destroyPrefetechedNode);
327        mPrefetechedLayers.clear();
328    }
329}
330
331void CanvasContext::buildLayer(RenderNode* node) {
332    ATRACE_CALL();
333    if (!mEglManager.hasEglContext() || !mCanvas) {
334        return;
335    }
336    // buildLayer() will leave the tree in an unknown state, so we must stop drawing
337    stopDrawing();
338
339    TreeInfo info(TreeInfo::MODE_FULL, mRenderThread.renderState());
340    info.damageAccumulator = &mDamageAccumulator;
341    info.renderer = mCanvas;
342    info.runAnimations = false;
343    node->prepareTree(info);
344    SkRect ignore;
345    mDamageAccumulator.finish(&ignore);
346    // Tickle the GENERIC property on node to mark it as dirty for damaging
347    // purposes when the frame is actually drawn
348    node->setPropertyFieldsDirty(RenderNode::GENERIC);
349
350    mCanvas->markLayersAsBuildLayers();
351    mCanvas->flushLayerUpdates();
352
353    node->incStrong(nullptr);
354    mPrefetechedLayers.insert(node);
355}
356
357bool CanvasContext::copyLayerInto(DeferredLayerUpdater* layer, SkBitmap* bitmap) {
358    layer->apply();
359    return LayerRenderer::copyLayer(mRenderThread.renderState(), layer->backingLayer(), bitmap);
360}
361
362void CanvasContext::destroyHardwareResources() {
363    stopDrawing();
364    if (mEglManager.hasEglContext()) {
365        freePrefetechedLayers();
366        mRootRenderNode->destroyHardwareResources();
367        Caches::getInstance().flush(Caches::kFlushMode_Layers);
368    }
369}
370
371void CanvasContext::trimMemory(RenderThread& thread, int level) {
372    // No context means nothing to free
373    if (!thread.eglManager().hasEglContext()) return;
374
375    ATRACE_CALL();
376    if (level >= TRIM_MEMORY_COMPLETE) {
377        Caches::getInstance().flush(Caches::kFlushMode_Full);
378        thread.eglManager().destroy();
379    } else if (level >= TRIM_MEMORY_UI_HIDDEN) {
380        Caches::getInstance().flush(Caches::kFlushMode_Moderate);
381    }
382}
383
384void CanvasContext::runWithGlContext(RenderTask* task) {
385    LOG_ALWAYS_FATAL_IF(!mEglManager.hasEglContext(),
386            "GL context not initialized!");
387    task->run();
388}
389
390Layer* CanvasContext::createTextureLayer() {
391    requireSurface();
392    return LayerRenderer::createTextureLayer(mRenderThread.renderState());
393}
394
395void CanvasContext::setTextureAtlas(RenderThread& thread,
396        const sp<GraphicBuffer>& buffer, int64_t* map, size_t mapSize) {
397    thread.eglManager().setTextureAtlas(buffer, map, mapSize);
398}
399
400void CanvasContext::dumpFrames(int fd) {
401    FILE* file = fdopen(fd, "a");
402    fprintf(file, "\n\n---PROFILEDATA---\n");
403    for (size_t i = 0; i < static_cast<size_t>(FrameInfoIndex::kNumIndexes); i++) {
404        fprintf(file, FrameInfoNames[i].c_str());
405        fprintf(file, ",");
406    }
407    for (size_t i = 0; i < mFrames.size(); i++) {
408        FrameInfo& frame = mFrames[i];
409        if (frame[FrameInfoIndex::kSyncStart] == 0) {
410            continue;
411        }
412        fprintf(file, "\n");
413        for (int i = 0; i < static_cast<int>(FrameInfoIndex::kNumIndexes); i++) {
414            fprintf(file, "%" PRId64 ",", frame[i]);
415        }
416    }
417    fprintf(file, "\n---PROFILEDATA---\n\n");
418    fflush(file);
419}
420
421void CanvasContext::resetFrameStats() {
422    mFrames.clear();
423    mRenderThread.jankTracker().reset();
424}
425
426} /* namespace renderthread */
427} /* namespace uirenderer */
428} /* namespace android */
429