blob: 03bc545fd0c90671ec53e6a10b980e8d072d465f [file] [log] [blame]
/*
* Copyright 2019 Google Inc.
*
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
#include "include/core/SkAlphaType.h"
#include "include/core/SkCanvas.h"
#include "include/core/SkColor.h"
#include "include/core/SkColorSpace.h"
#include "include/core/SkColorType.h"
#include "include/core/SkImage.h"
#include "include/core/SkImageInfo.h"
#include "include/core/SkRect.h"
#include "include/core/SkRefCnt.h"
#include "include/core/SkSurface.h"
#include "include/core/SkTypes.h"
#include "include/gpu/GpuTypes.h"
#include "include/gpu/GrDirectContext.h"
#include "include/gpu/GrTypes.h"
#include "src/gpu/ganesh/GrCaps.h"
#include "src/gpu/ganesh/GrDirectContextPriv.h"
#include "tests/CtsEnforcement.h"
#include "tests/Test.h"
#include "tools/gpu/FenceSync.h"
#include "tools/gpu/ManagedBackendTexture.h"
#include <chrono>
#include <memory>
struct GrContextOptions;
using namespace sk_gpu_test;
static void testing_finished_proc(void* ctx) {
int* count = (int*)ctx;
*count += 1;
}
static void busy_wait_for_callback(int* count, int expectedValue, GrDirectContext* dContext,
skiatest::Reporter* reporter) {
// Busy waiting should detect that the work is done.
auto begin = std::chrono::steady_clock::now();
auto end = begin;
do {
dContext->checkAsyncWorkCompletion();
end = std::chrono::steady_clock::now();
} while (*count != expectedValue && (end - begin) < std::chrono::seconds(1));
if (*count != expectedValue) {
ERRORF(reporter, "Expected count failed to reach %d within 1 second of busy waiting.",
expectedValue);
}
}
DEF_GANESH_TEST_FOR_RENDERING_CONTEXTS(FlushFinishedProcTest,
reporter,
ctxInfo,
CtsEnforcement::kApiLevel_T) {
auto dContext = ctxInfo.directContext();
SkImageInfo info =
SkImageInfo::Make(8, 8, kRGBA_8888_SkColorType, kPremul_SkAlphaType);
sk_sp<SkSurface> surface = SkSurface::MakeRenderTarget(dContext, skgpu::Budgeted::kNo, info);
SkCanvas* canvas = surface->getCanvas();
canvas->clear(SK_ColorGREEN);
auto image = surface->makeImageSnapshot();
dContext->flush();
dContext->submit(true);
int count = 0;
GrFlushInfo flushInfoFinishedProc;
flushInfoFinishedProc.fFinishedProc = testing_finished_proc;
flushInfoFinishedProc.fFinishedContext = (void*)&count;
// There is no work on the surface so flushing may immediately call the finished proc.
surface->flush(flushInfoFinishedProc);
dContext->submit();
REPORTER_ASSERT(reporter, count == 0 || count == 1);
// Busy waiting should detect that the work is done.
busy_wait_for_callback(&count, 1, dContext, reporter);
canvas->clear(SK_ColorRED);
surface->flush(flushInfoFinishedProc);
dContext->submit();
bool fenceSupport = dContext->priv().caps()->fenceSyncSupport();
bool expectAsyncCallback =
dContext->backend() == GrBackendApi::kVulkan ||
((dContext->backend() == GrBackendApi::kOpenGL) && fenceSupport) ||
((dContext->backend() == GrBackendApi::kMetal) && fenceSupport) ||
dContext->backend() == GrBackendApi::kDawn ||
dContext->backend() == GrBackendApi::kDirect3D;
if (expectAsyncCallback) {
// On Vulkan the command buffer we just submitted may or may not have finished immediately
// so the finish proc may not have been called.
REPORTER_ASSERT(reporter, count == 1 || count == 2);
} else {
REPORTER_ASSERT(reporter, count == 2);
}
dContext->flush();
dContext->submit(true);
REPORTER_ASSERT(reporter, count == 2);
// Test flushing via the SkImage
canvas->drawImage(image, 0, 0);
image->flush(dContext, flushInfoFinishedProc);
dContext->submit();
if (expectAsyncCallback) {
// On Vulkan the command buffer we just submitted may or may not have finished immediately
// so the finish proc may not have been called.
REPORTER_ASSERT(reporter, count == 2 || count == 3);
} else {
REPORTER_ASSERT(reporter, count == 3);
}
dContext->flush();
dContext->submit(true);
REPORTER_ASSERT(reporter, count == 3);
// Test flushing via the GrDirectContext
canvas->clear(SK_ColorBLUE);
dContext->flush(flushInfoFinishedProc);
dContext->submit();
if (expectAsyncCallback) {
// On Vulkan the command buffer we just submitted may or may not have finished immediately
// so the finish proc may not have been called.
REPORTER_ASSERT(reporter, count == 3 || count == 4);
} else {
REPORTER_ASSERT(reporter, count == 4);
}
dContext->flush();
dContext->submit(true);
REPORTER_ASSERT(reporter, count == 4);
// There is no work on the surface so flushing may immediately call the finished proc.
dContext->flush(flushInfoFinishedProc);
dContext->submit();
REPORTER_ASSERT(reporter, count == 4 || count == 5);
busy_wait_for_callback(&count, 5, dContext, reporter);
count = 0;
int count2 = 0;
canvas->clear(SK_ColorGREEN);
surface->flush(flushInfoFinishedProc);
dContext->submit();
// There is no work to be flushed here so this will return immediately, but make sure the
// finished call from this proc isn't called till the previous surface flush also is finished.
flushInfoFinishedProc.fFinishedContext = (void*)&count2;
dContext->flush(flushInfoFinishedProc);
dContext->submit();
REPORTER_ASSERT(reporter, count <= 1 && count2 <= count);
dContext->flush();
dContext->submit(true);
REPORTER_ASSERT(reporter, count == 1);
REPORTER_ASSERT(reporter, count == count2);
}
static void abandon_context(void* context) {
((GrDirectContext*)context)->abandonContext();
}
static void async_callback(void* c, std::unique_ptr<const SkImage::AsyncReadResult> result) {
// We don't actually care about the results so just drop them without doing anything.
}
// This test checks that calls to the async read pixels callback can safely be made even if the
// context has been abandoned previously. Specifically there was a bug where the client buffer
// manager stored on the GrDirectContext was accessed in the async callback after it was deleted.
// This bug is detected on ASAN bots running non GL backends (GL isn't affected purely based on
// how we call finish callbacks during abandon).
DEF_GANESH_TEST_FOR_RENDERING_CONTEXTS(FinishedAsyncProcWhenAbandonedTest,
reporter,
ctxInfo,
CtsEnforcement::kApiLevel_T) {
auto dContext = ctxInfo.directContext();
SkImageInfo info =
SkImageInfo::Make(8, 8, kRGBA_8888_SkColorType, kPremul_SkAlphaType);
auto mbet = sk_gpu_test::ManagedBackendTexture::MakeFromInfo(dContext,
info,
GrMipmapped::kNo,
GrRenderable::kYes);
if (!mbet) {
return;
}
auto surface = SkSurface::MakeFromBackendTexture(
dContext,
mbet->texture(),
kTopLeft_GrSurfaceOrigin,
/*sample count*/ 1,
kRGBA_8888_SkColorType,
/*color space*/ nullptr,
/*surface props*/ nullptr,
sk_gpu_test::ManagedBackendTexture::ReleaseProc,
mbet->releaseContext(nullptr, nullptr));
if (!surface) {
return;
}
SkCanvas* canvas = surface->getCanvas();
canvas->clear(SK_ColorGREEN);
// To trigger bug we must have a finish callback that abanonds the context before an asyc
// read callbck on the same command buffer. So we add the abandon callback first and flush
// then add the asyc to enforce this order.
GrFlushInfo flushInfo;
flushInfo.fFinishedProc = abandon_context;
flushInfo.fFinishedContext = dContext;
dContext->flush(flushInfo);
surface->asyncRescaleAndReadPixels(info,
SkIRect::MakeWH(8, 8),
SkImage::RescaleGamma::kSrc,
SkImage::RescaleMode::kNearest,
async_callback,
nullptr);
surface.reset();
dContext->flushAndSubmit(/*syncCpu=*/true);
}