RenderProxy.cpp revision ba6adf66d3c44c0aa2fd8a224862ff1901d64300 
1/*
2 * Copyright (C) 2013 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 "RenderProxy.h"
18
19#include "DeferredLayerUpdater.h"
20#include "DisplayList.h"
21#include "LayerRenderer.h"
22#include "Rect.h"
23#include "renderthread/CanvasContext.h"
24#include "renderthread/RenderTask.h"
25#include "renderthread/RenderThread.h"
26#include "utils/Macros.h"
27
28namespace android {
29namespace uirenderer {
30namespace renderthread {
31
32#define ARGS(method) method ## Args
33
34#define CREATE_BRIDGE0(name) CREATE_BRIDGE(name,,,,,,,,)
35#define CREATE_BRIDGE1(name, a1) CREATE_BRIDGE(name, a1,,,,,,,)
36#define CREATE_BRIDGE2(name, a1, a2) CREATE_BRIDGE(name, a1,a2,,,,,,)
37#define CREATE_BRIDGE3(name, a1, a2, a3) CREATE_BRIDGE(name, a1,a2,a3,,,,,)
38#define CREATE_BRIDGE4(name, a1, a2, a3, a4) CREATE_BRIDGE(name, a1,a2,a3,a4,,,,)
39#define CREATE_BRIDGE5(name, a1, a2, a3, a4, a5) CREATE_BRIDGE(name, a1,a2,a3,a4,a5,,,)
40#define CREATE_BRIDGE6(name, a1, a2, a3, a4, a5, a6) CREATE_BRIDGE(name, a1,a2,a3,a4,a5,a6,,)
41#define CREATE_BRIDGE7(name, a1, a2, a3, a4, a5, a6, a7) CREATE_BRIDGE(name, a1,a2,a3,a4,a5,a6,a7,)
42#define CREATE_BRIDGE(name, a1, a2, a3, a4, a5, a6, a7, a8) \
43    typedef struct { \
44        a1; a2; a3; a4; a5; a6; a7; a8; \
45    } ARGS(name); \
46    static void* Bridge_ ## name(ARGS(name)* args)
47
48#define SETUP_TASK(method) \
49    LOG_ALWAYS_FATAL_IF( METHOD_INVOKE_PAYLOAD_SIZE < sizeof(ARGS(method)), \
50        "METHOD_INVOKE_PAYLOAD_SIZE %zu is smaller than sizeof(" #method "Args) %zu", \
51                METHOD_INVOKE_PAYLOAD_SIZE, sizeof(ARGS(method))); \
52    MethodInvokeRenderTask* task = new MethodInvokeRenderTask((RunnableMethod) Bridge_ ## method); \
53    ARGS(method) *args = (ARGS(method) *) task->payload()
54
55HWUI_ENUM(DumpFlags,
56        kFrameStats = 1 << 0,
57        kReset      = 1 << 1,
58);
59
60CREATE_BRIDGE4(createContext, RenderThread* thread, bool translucent,
61        RenderNode* rootRenderNode, IContextFactory* contextFactory) {
62    return new CanvasContext(*args->thread, args->translucent,
63            args->rootRenderNode, args->contextFactory);
64}
65
66RenderProxy::RenderProxy(bool translucent, RenderNode* rootRenderNode, IContextFactory* contextFactory)
67        : mRenderThread(RenderThread::getInstance())
68        , mContext(nullptr) {
69    SETUP_TASK(createContext);
70    args->translucent = translucent;
71    args->rootRenderNode = rootRenderNode;
72    args->thread = &mRenderThread;
73    args->contextFactory = contextFactory;
74    mContext = (CanvasContext*) postAndWait(task);
75    mDrawFrameTask.setContext(&mRenderThread, mContext);
76}
77
78RenderProxy::~RenderProxy() {
79    destroyContext();
80}
81
82CREATE_BRIDGE1(destroyContext, CanvasContext* context) {
83    delete args->context;
84    return nullptr;
85}
86
87void RenderProxy::destroyContext() {
88    if (mContext) {
89        SETUP_TASK(destroyContext);
90        args->context = mContext;
91        mContext = nullptr;
92        mDrawFrameTask.setContext(nullptr, nullptr);
93        // This is also a fence as we need to be certain that there are no
94        // outstanding mDrawFrame tasks posted before it is destroyed
95        postAndWait(task);
96    }
97}
98
99CREATE_BRIDGE2(setFrameInterval, RenderThread* thread, nsecs_t frameIntervalNanos) {
100    args->thread->setFrameInterval(args->frameIntervalNanos);
101    return nullptr;
102}
103
104void RenderProxy::setFrameInterval(nsecs_t frameIntervalNanos) {
105    SETUP_TASK(setFrameInterval);
106    args->thread = &mRenderThread;
107    args->frameIntervalNanos = frameIntervalNanos;
108    post(task);
109}
110
111CREATE_BRIDGE2(setSwapBehavior, CanvasContext* context, SwapBehavior swapBehavior) {
112    args->context->setSwapBehavior(args->swapBehavior);
113    return nullptr;
114}
115
116void RenderProxy::setSwapBehavior(SwapBehavior swapBehavior) {
117    SETUP_TASK(setSwapBehavior);
118    args->context = mContext;
119    args->swapBehavior = swapBehavior;
120    post(task);
121}
122
123CREATE_BRIDGE1(loadSystemProperties, CanvasContext* context) {
124    bool needsRedraw = false;
125    if (Caches::hasInstance()) {
126        needsRedraw = Caches::getInstance().initProperties();
127    }
128    if (args->context->profiler().loadSystemProperties()) {
129        needsRedraw = true;
130    }
131    return (void*) needsRedraw;
132}
133
134bool RenderProxy::loadSystemProperties() {
135    SETUP_TASK(loadSystemProperties);
136    args->context = mContext;
137    return (bool) postAndWait(task);
138}
139
140CREATE_BRIDGE2(initialize, CanvasContext* context, ANativeWindow* window) {
141    return (void*) args->context->initialize(args->window);
142}
143
144bool RenderProxy::initialize(const sp<ANativeWindow>& window) {
145    SETUP_TASK(initialize);
146    args->context = mContext;
147    args->window = window.get();
148    return (bool) postAndWait(task);
149}
150
151CREATE_BRIDGE2(updateSurface, CanvasContext* context, ANativeWindow* window) {
152    args->context->updateSurface(args->window);
153    return nullptr;
154}
155
156void RenderProxy::updateSurface(const sp<ANativeWindow>& window) {
157    SETUP_TASK(updateSurface);
158    args->context = mContext;
159    args->window = window.get();
160    postAndWait(task);
161}
162
163CREATE_BRIDGE2(pauseSurface, CanvasContext* context, ANativeWindow* window) {
164    return (void*) args->context->pauseSurface(args->window);
165}
166
167bool RenderProxy::pauseSurface(const sp<ANativeWindow>& window) {
168    SETUP_TASK(pauseSurface);
169    args->context = mContext;
170    args->window = window.get();
171    return (bool) postAndWait(task);
172}
173
174CREATE_BRIDGE7(setup, CanvasContext* context, int width, int height,
175        Vector3 lightCenter, float lightRadius,
176        uint8_t ambientShadowAlpha, uint8_t spotShadowAlpha) {
177    args->context->setup(args->width, args->height, args->lightCenter, args->lightRadius,
178            args->ambientShadowAlpha, args->spotShadowAlpha);
179    return nullptr;
180}
181
182void RenderProxy::setup(int width, int height, const Vector3& lightCenter, float lightRadius,
183        uint8_t ambientShadowAlpha, uint8_t spotShadowAlpha, float density) {
184    mDrawFrameTask.setDensity(density);
185    SETUP_TASK(setup);
186    args->context = mContext;
187    args->width = width;
188    args->height = height;
189    args->lightCenter = lightCenter;
190    args->lightRadius = lightRadius;
191    args->ambientShadowAlpha = ambientShadowAlpha;
192    args->spotShadowAlpha = spotShadowAlpha;
193    post(task);
194}
195
196CREATE_BRIDGE2(setOpaque, CanvasContext* context, bool opaque) {
197    args->context->setOpaque(args->opaque);
198    return nullptr;
199}
200
201void RenderProxy::setOpaque(bool opaque) {
202    SETUP_TASK(setOpaque);
203    args->context = mContext;
204    args->opaque = opaque;
205    post(task);
206}
207
208int64_t* RenderProxy::frameInfo() {
209    return mDrawFrameTask.frameInfo();
210}
211
212int RenderProxy::syncAndDrawFrame() {
213    return mDrawFrameTask.drawFrame();
214}
215
216CREATE_BRIDGE1(destroy, CanvasContext* context) {
217    args->context->destroy();
218    return nullptr;
219}
220
221void RenderProxy::destroy() {
222    SETUP_TASK(destroy);
223    args->context = mContext;
224    // destroyCanvasAndSurface() needs a fence as when it returns the
225    // underlying BufferQueue is going to be released from under
226    // the render thread.
227    postAndWait(task);
228}
229
230CREATE_BRIDGE2(invokeFunctor, RenderThread* thread, Functor* functor) {
231    CanvasContext::invokeFunctor(*args->thread, args->functor);
232    return nullptr;
233}
234
235void RenderProxy::invokeFunctor(Functor* functor, bool waitForCompletion) {
236    ATRACE_CALL();
237    RenderThread& thread = RenderThread::getInstance();
238    SETUP_TASK(invokeFunctor);
239    args->thread = &thread;
240    args->functor = functor;
241    if (waitForCompletion) {
242        // waitForCompletion = true is expected to be fairly rare and only
243        // happen in destruction. Thus it should be fine to temporarily
244        // create a Mutex
245        staticPostAndWait(task);
246    } else {
247        thread.queue(task);
248    }
249}
250
251CREATE_BRIDGE2(runWithGlContext, CanvasContext* context, RenderTask* task) {
252    args->context->runWithGlContext(args->task);
253    return nullptr;
254}
255
256void RenderProxy::runWithGlContext(RenderTask* gltask) {
257    SETUP_TASK(runWithGlContext);
258    args->context = mContext;
259    args->task = gltask;
260    postAndWait(task);
261}
262
263CREATE_BRIDGE2(createTextureLayer, RenderThread* thread, CanvasContext* context) {
264    Layer* layer = args->context->createTextureLayer();
265    if (!layer) return nullptr;
266    return new DeferredLayerUpdater(*args->thread, layer);
267}
268
269DeferredLayerUpdater* RenderProxy::createTextureLayer() {
270    SETUP_TASK(createTextureLayer);
271    args->context = mContext;
272    args->thread = &mRenderThread;
273    void* retval = postAndWait(task);
274    DeferredLayerUpdater* layer = reinterpret_cast<DeferredLayerUpdater*>(retval);
275    return layer;
276}
277
278CREATE_BRIDGE2(buildLayer, CanvasContext* context, RenderNode* node) {
279    args->context->buildLayer(args->node);
280    return nullptr;
281}
282
283void RenderProxy::buildLayer(RenderNode* node) {
284    SETUP_TASK(buildLayer);
285    args->context = mContext;
286    args->node = node;
287    postAndWait(task);
288}
289
290CREATE_BRIDGE3(copyLayerInto, CanvasContext* context, DeferredLayerUpdater* layer,
291        SkBitmap* bitmap) {
292    bool success = args->context->copyLayerInto(args->layer, args->bitmap);
293    return (void*) success;
294}
295
296bool RenderProxy::copyLayerInto(DeferredLayerUpdater* layer, SkBitmap* bitmap) {
297    SETUP_TASK(copyLayerInto);
298    args->context = mContext;
299    args->layer = layer;
300    args->bitmap = bitmap;
301    return (bool) postAndWait(task);
302}
303
304void RenderProxy::pushLayerUpdate(DeferredLayerUpdater* layer) {
305    mDrawFrameTask.pushLayerUpdate(layer);
306}
307
308void RenderProxy::cancelLayerUpdate(DeferredLayerUpdater* layer) {
309    mDrawFrameTask.removeLayerUpdate(layer);
310}
311
312CREATE_BRIDGE1(detachSurfaceTexture, DeferredLayerUpdater* layer) {
313    args->layer->detachSurfaceTexture();
314    return nullptr;
315}
316
317void RenderProxy::detachSurfaceTexture(DeferredLayerUpdater* layer) {
318    SETUP_TASK(detachSurfaceTexture);
319    args->layer = layer;
320    postAndWait(task);
321}
322
323CREATE_BRIDGE1(destroyHardwareResources, CanvasContext* context) {
324    args->context->destroyHardwareResources();
325    return nullptr;
326}
327
328void RenderProxy::destroyHardwareResources() {
329    SETUP_TASK(destroyHardwareResources);
330    args->context = mContext;
331    post(task);
332}
333
334CREATE_BRIDGE2(timMemory, RenderThread* thread, int level) {
335    CanvasContext::trimMemory(*args->thread, args->level);
336    return nullptr;
337}
338
339void RenderProxy::trimMemory(int level) {
340    // Avoid creating a RenderThread to do a trimMemory.
341    if (RenderThread::hasInstance()) {
342        RenderThread& thread = RenderThread::getInstance();
343        SETUP_TASK(timMemory);
344        args->thread = &thread;
345        args->level = level;
346        thread.queue(task);
347    }
348}
349
350CREATE_BRIDGE0(fence) {
351    // Intentionally empty
352    return nullptr;
353}
354
355template <typename T>
356void UNUSED(T t) {}
357
358void RenderProxy::fence() {
359    SETUP_TASK(fence);
360    UNUSED(args);
361    postAndWait(task);
362}
363
364CREATE_BRIDGE1(stopDrawing, CanvasContext* context) {
365    args->context->stopDrawing();
366    return nullptr;
367}
368
369void RenderProxy::stopDrawing() {
370    SETUP_TASK(stopDrawing);
371    args->context = mContext;
372    postAndWait(task);
373}
374
375CREATE_BRIDGE1(notifyFramePending, CanvasContext* context) {
376    args->context->notifyFramePending();
377    return nullptr;
378}
379
380void RenderProxy::notifyFramePending() {
381    SETUP_TASK(notifyFramePending);
382    args->context = mContext;
383    mRenderThread.queueAtFront(task);
384}
385
386CREATE_BRIDGE3(dumpProfileInfo, CanvasContext* context, int fd, int dumpFlags) {
387    args->context->profiler().dumpData(args->fd);
388    if (args->dumpFlags & DumpFlags::kFrameStats) {
389        args->context->dumpFrames(args->fd);
390    }
391    if (args->dumpFlags & DumpFlags::kReset) {
392        args->context->resetFrameStats();
393    }
394    return nullptr;
395}
396
397void RenderProxy::dumpProfileInfo(int fd, int dumpFlags) {
398    SETUP_TASK(dumpProfileInfo);
399    args->context = mContext;
400    args->fd = fd;
401    args->dumpFlags = dumpFlags;
402    postAndWait(task);
403}
404
405CREATE_BRIDGE2(dumpGraphicsMemory, int fd, RenderThread* thread) {
406    args->thread->jankTracker().dump(args->fd);
407
408    FILE *file = fdopen(args->fd, "a");
409    if (Caches::hasInstance()) {
410        String8 cachesLog;
411        Caches::getInstance().dumpMemoryUsage(cachesLog);
412        fprintf(file, "\nCaches:\n%s\n", cachesLog.string());
413    } else {
414        fprintf(file, "\nNo caches instance.\n");
415    }
416    fflush(file);
417    return nullptr;
418}
419
420void RenderProxy::dumpGraphicsMemory(int fd) {
421    SETUP_TASK(dumpGraphicsMemory);
422    args->fd = fd;
423    args->thread = &RenderThread::getInstance();
424    staticPostAndWait(task);
425}
426
427CREATE_BRIDGE4(setTextureAtlas, RenderThread* thread, GraphicBuffer* buffer, int64_t* map, size_t size) {
428    CanvasContext::setTextureAtlas(*args->thread, args->buffer, args->map, args->size);
429    args->buffer->decStrong(nullptr);
430    return nullptr;
431}
432
433void RenderProxy::setTextureAtlas(const sp<GraphicBuffer>& buffer, int64_t* map, size_t size) {
434    SETUP_TASK(setTextureAtlas);
435    args->thread = &mRenderThread;
436    args->buffer = buffer.get();
437    args->buffer->incStrong(nullptr);
438    args->map = map;
439    args->size = size;
440    post(task);
441}
442
443void RenderProxy::post(RenderTask* task) {
444    mRenderThread.queue(task);
445}
446
447void* RenderProxy::postAndWait(MethodInvokeRenderTask* task) {
448    void* retval;
449    task->setReturnPtr(&retval);
450    SignalingRenderTask syncTask(task, &mSyncMutex, &mSyncCondition);
451    AutoMutex _lock(mSyncMutex);
452    mRenderThread.queue(&syncTask);
453    mSyncCondition.wait(mSyncMutex);
454    return retval;
455}
456
457void* RenderProxy::staticPostAndWait(MethodInvokeRenderTask* task) {
458    RenderThread& thread = RenderThread::getInstance();
459    void* retval;
460    task->setReturnPtr(&retval);
461    Mutex mutex;
462    Condition condition;
463    SignalingRenderTask syncTask(task, &mutex, &condition);
464    AutoMutex _lock(mutex);
465    thread.queue(&syncTask);
466    condition.wait(mutex);
467    return retval;
468}
469
470} /* namespace renderthread */
471} /* namespace uirenderer */
472} /* namespace android */
473