CanvasContext.cpp revision f2dcc2aecb94e726096256c47b913ed0a57ae7e2 
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    EGLint error = 0;
149    mHaveNewSurface |= mEglManager.makeCurrent(mEglSurface, &error);
150    if (error) {
151        setSurface(nullptr);
152    }
153}
154
155void CanvasContext::processLayerUpdate(DeferredLayerUpdater* layerUpdater) {
156    bool success = layerUpdater->apply();
157    LOG_ALWAYS_FATAL_IF(!success, "Failed to update layer!");
158    if (layerUpdater->backingLayer()->deferredUpdateScheduled) {
159        mCanvas->pushLayerUpdate(layerUpdater->backingLayer());
160    }
161}
162
163static bool wasSkipped(FrameInfo* info) {
164    return info && ((*info)[FrameInfoIndex::Flags] & FrameInfoFlags::SkippedFrame);
165}
166
167void CanvasContext::prepareTree(TreeInfo& info, int64_t* uiFrameInfo, int64_t syncQueued) {
168    mRenderThread.removeFrameCallback(this);
169
170    // If the previous frame was dropped we don't need to hold onto it, so
171    // just keep using the previous frame's structure instead
172    if (!wasSkipped(mCurrentFrameInfo)) {
173        mCurrentFrameInfo = &mFrames.next();
174    }
175    mCurrentFrameInfo->importUiThreadInfo(uiFrameInfo);
176    mCurrentFrameInfo->set(FrameInfoIndex::SyncQueued) = syncQueued;
177    mCurrentFrameInfo->markSyncStart();
178
179    info.damageAccumulator = &mDamageAccumulator;
180    info.renderer = mCanvas;
181    if (mPrefetechedLayers.size() && info.mode == TreeInfo::MODE_FULL) {
182        info.canvasContext = this;
183    }
184    mAnimationContext->startFrame(info.mode);
185    mRootRenderNode->prepareTree(info);
186    mAnimationContext->runRemainingAnimations(info);
187
188    if (info.canvasContext) {
189        freePrefetechedLayers();
190    }
191
192    if (CC_UNLIKELY(!mNativeWindow.get())) {
193        mCurrentFrameInfo->addFlag(FrameInfoFlags::SkippedFrame);
194        info.out.canDrawThisFrame = false;
195        return;
196    }
197
198    int runningBehind = 0;
199    // TODO: This query is moderately expensive, investigate adding some sort
200    // of fast-path based off when we last called eglSwapBuffers() as well as
201    // last vsync time. Or something.
202    mNativeWindow->query(mNativeWindow.get(),
203            NATIVE_WINDOW_CONSUMER_RUNNING_BEHIND, &runningBehind);
204    info.out.canDrawThisFrame = !runningBehind;
205
206    if (!info.out.canDrawThisFrame) {
207        mCurrentFrameInfo->addFlag(FrameInfoFlags::SkippedFrame);
208    }
209
210    if (info.out.hasAnimations || !info.out.canDrawThisFrame) {
211        if (!info.out.requiresUiRedraw) {
212            // If animationsNeedsRedraw is set don't bother posting for an RT anim
213            // as we will just end up fighting the UI thread.
214            mRenderThread.postFrameCallback(this);
215        }
216    }
217}
218
219void CanvasContext::stopDrawing() {
220    mRenderThread.removeFrameCallback(this);
221}
222
223void CanvasContext::notifyFramePending() {
224    ATRACE_CALL();
225    mRenderThread.pushBackFrameCallback(this);
226}
227
228void CanvasContext::draw() {
229    LOG_ALWAYS_FATAL_IF(!mCanvas || mEglSurface == EGL_NO_SURFACE,
230            "drawRenderNode called on a context with no canvas or surface!");
231
232    SkRect dirty;
233    mDamageAccumulator.finish(&dirty);
234
235    if (dirty.isEmpty() && Properties::skipEmptyFrames) {
236        mCurrentFrameInfo->addFlag(FrameInfoFlags::SkippedFrame);
237        return;
238    }
239
240    mCurrentFrameInfo->markIssueDrawCommandsStart();
241
242    EGLint width, height;
243    mEglManager.beginFrame(mEglSurface, &width, &height);
244    if (width != mCanvas->getViewportWidth() || height != mCanvas->getViewportHeight()) {
245        mCanvas->setViewport(width, height);
246        dirty.setEmpty();
247    } else if (!mBufferPreserved || mHaveNewSurface) {
248        dirty.setEmpty();
249    } else {
250        if (!dirty.isEmpty() && !dirty.intersect(0, 0, width, height)) {
251            ALOGW("Dirty " RECT_STRING " doesn't intersect with 0 0 %d %d ?",
252                    SK_RECT_ARGS(dirty), width, height);
253            dirty.setEmpty();
254        }
255        profiler().unionDirty(&dirty);
256    }
257
258    if (!dirty.isEmpty()) {
259        mCanvas->prepareDirty(dirty.fLeft, dirty.fTop,
260                dirty.fRight, dirty.fBottom, mOpaque);
261    } else {
262        mCanvas->prepare(mOpaque);
263    }
264
265    Rect outBounds;
266    mCanvas->drawRenderNode(mRootRenderNode.get(), outBounds);
267
268    profiler().draw(mCanvas);
269
270    bool drew = mCanvas->finish();
271
272    // Even if we decided to cancel the frame, from the perspective of jank
273    // metrics the frame was swapped at this point
274    mCurrentFrameInfo->markSwapBuffers();
275
276    if (drew) {
277        swapBuffers(dirty, width, height);
278    }
279
280    // TODO: Use a fence for real completion?
281    mCurrentFrameInfo->markFrameCompleted();
282    mJankTracker.addFrame(*mCurrentFrameInfo);
283    mRenderThread.jankTracker().addFrame(*mCurrentFrameInfo);
284}
285
286// Called by choreographer to do an RT-driven animation
287void CanvasContext::doFrame() {
288    if (CC_UNLIKELY(!mCanvas || mEglSurface == EGL_NO_SURFACE)) {
289        return;
290    }
291
292    ATRACE_CALL();
293
294    int64_t frameInfo[UI_THREAD_FRAME_INFO_SIZE];
295    UiFrameInfoBuilder(frameInfo)
296        .addFlag(FrameInfoFlags::RTAnimation)
297        .setVsync(mRenderThread.timeLord().computeFrameTimeNanos(),
298                mRenderThread.timeLord().latestVsync());
299
300    TreeInfo info(TreeInfo::MODE_RT_ONLY, mRenderThread.renderState());
301    prepareTree(info, frameInfo, systemTime(CLOCK_MONOTONIC));
302    if (info.out.canDrawThisFrame) {
303        draw();
304    }
305}
306
307void CanvasContext::invokeFunctor(RenderThread& thread, Functor* functor) {
308    ATRACE_CALL();
309    DrawGlInfo::Mode mode = DrawGlInfo::kModeProcessNoContext;
310    if (thread.eglManager().hasEglContext()) {
311        mode = DrawGlInfo::kModeProcess;
312    }
313
314    thread.renderState().invokeFunctor(functor, mode, nullptr);
315}
316
317void CanvasContext::markLayerInUse(RenderNode* node) {
318    if (mPrefetechedLayers.erase(node)) {
319        node->decStrong(nullptr);
320    }
321}
322
323static void destroyPrefetechedNode(RenderNode* node) {
324    ALOGW("Incorrectly called buildLayer on View: %s, destroying layer...", node->getName());
325    node->destroyHardwareResources();
326    node->decStrong(nullptr);
327}
328
329void CanvasContext::freePrefetechedLayers() {
330    if (mPrefetechedLayers.size()) {
331        std::for_each(mPrefetechedLayers.begin(), mPrefetechedLayers.end(), destroyPrefetechedNode);
332        mPrefetechedLayers.clear();
333    }
334}
335
336void CanvasContext::buildLayer(RenderNode* node) {
337    ATRACE_CALL();
338    if (!mEglManager.hasEglContext() || !mCanvas) {
339        return;
340    }
341    // buildLayer() will leave the tree in an unknown state, so we must stop drawing
342    stopDrawing();
343
344    TreeInfo info(TreeInfo::MODE_FULL, mRenderThread.renderState());
345    info.damageAccumulator = &mDamageAccumulator;
346    info.renderer = mCanvas;
347    info.runAnimations = false;
348    node->prepareTree(info);
349    SkRect ignore;
350    mDamageAccumulator.finish(&ignore);
351    // Tickle the GENERIC property on node to mark it as dirty for damaging
352    // purposes when the frame is actually drawn
353    node->setPropertyFieldsDirty(RenderNode::GENERIC);
354
355    mCanvas->markLayersAsBuildLayers();
356    mCanvas->flushLayerUpdates();
357
358    node->incStrong(nullptr);
359    mPrefetechedLayers.insert(node);
360}
361
362bool CanvasContext::copyLayerInto(DeferredLayerUpdater* layer, SkBitmap* bitmap) {
363    layer->apply();
364    return LayerRenderer::copyLayer(mRenderThread.renderState(), layer->backingLayer(), bitmap);
365}
366
367void CanvasContext::destroyHardwareResources() {
368    stopDrawing();
369    if (mEglManager.hasEglContext()) {
370        freePrefetechedLayers();
371        mRootRenderNode->destroyHardwareResources();
372        Caches::getInstance().flush(Caches::kFlushMode_Layers);
373    }
374}
375
376void CanvasContext::trimMemory(RenderThread& thread, int level) {
377    // No context means nothing to free
378    if (!thread.eglManager().hasEglContext()) return;
379
380    ATRACE_CALL();
381    if (level >= TRIM_MEMORY_COMPLETE) {
382        Caches::getInstance().flush(Caches::kFlushMode_Full);
383        thread.eglManager().destroy();
384    } else if (level >= TRIM_MEMORY_UI_HIDDEN) {
385        Caches::getInstance().flush(Caches::kFlushMode_Moderate);
386    }
387}
388
389void CanvasContext::runWithGlContext(RenderTask* task) {
390    LOG_ALWAYS_FATAL_IF(!mEglManager.hasEglContext(),
391            "GL context not initialized!");
392    task->run();
393}
394
395Layer* CanvasContext::createTextureLayer() {
396    requireSurface();
397    return LayerRenderer::createTextureLayer(mRenderThread.renderState());
398}
399
400void CanvasContext::setTextureAtlas(RenderThread& thread,
401        const sp<GraphicBuffer>& buffer, int64_t* map, size_t mapSize) {
402    thread.eglManager().setTextureAtlas(buffer, map, mapSize);
403}
404
405void CanvasContext::dumpFrames(int fd) {
406    FILE* file = fdopen(fd, "a");
407    fprintf(file, "\n\n---PROFILEDATA---\n");
408    for (size_t i = 0; i < static_cast<size_t>(FrameInfoIndex::NumIndexes); i++) {
409        fprintf(file, "%s", FrameInfoNames[i].c_str());
410        fprintf(file, ",");
411    }
412    for (size_t i = 0; i < mFrames.size(); i++) {
413        FrameInfo& frame = mFrames[i];
414        if (frame[FrameInfoIndex::SyncStart] == 0) {
415            continue;
416        }
417        fprintf(file, "\n");
418        for (int i = 0; i < static_cast<int>(FrameInfoIndex::NumIndexes); i++) {
419            fprintf(file, "%" PRId64 ",", frame[i]);
420        }
421    }
422    fprintf(file, "\n---PROFILEDATA---\n\n");
423    fflush(file);
424}
425
426void CanvasContext::resetFrameStats() {
427    mFrames.clear();
428    mRenderThread.jankTracker().reset();
429}
430
431} /* namespace renderthread */
432} /* namespace uirenderer */
433} /* namespace android */
434