/*
* Mesa 3-D graphics library
*
* Copyright (C) 2010-2011 Chia-I Wu <olvaffe@gmail.com>
* Copyright (C) 2010-2011 LunarG Inc.
*
* Based on platform_x11, which has
*
* Copyright © 2011 Intel Corporation
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*/
#include <cutils/properties.h>
#include <errno.h>
#include <dlfcn.h>
#include <fcntl.h>
#include <xf86drm.h>
#include <stdbool.h>
#include <sync/sync.h>
#include "loader.h"
#include "egl_dri2.h"
#include "egl_dri2_fallbacks.h"
#ifdef HAVE_DRM_GRALLOC
#include <gralloc_drm_handle.h>
#include "gralloc_drm.h"
#endif /* HAVE_DRM_GRALLOC */
#define ALIGN(val, align) (((val) + (align) - 1) & ~((align) - 1))
struct droid_yuv_format {
/* Lookup keys */
int native; /* HAL_PIXEL_FORMAT_ */
int is_ycrcb; /* 0 if chroma order is {Cb, Cr}, 1 if {Cr, Cb} */
int chroma_step; /* Distance in bytes between subsequent chroma pixels. */
/* Result */
int fourcc; /* __DRI_IMAGE_FOURCC_ */
};
/* The following table is used to look up a DRI image FourCC based
* on native format and information contained in android_ycbcr struct. */
static const struct droid_yuv_format droid_yuv_formats[] = {
/* Native format, YCrCb, Chroma step, DRI image FourCC */
{ HAL_PIXEL_FORMAT_YCbCr_420_888, 0, 2, __DRI_IMAGE_FOURCC_NV12 },
{ HAL_PIXEL_FORMAT_YCbCr_420_888, 0, 1, __DRI_IMAGE_FOURCC_YUV420 },
{ HAL_PIXEL_FORMAT_YCbCr_420_888, 1, 1, __DRI_IMAGE_FOURCC_YVU420 },
{ HAL_PIXEL_FORMAT_YV12, 1, 1, __DRI_IMAGE_FOURCC_YVU420 },
/* HACK: See droid_create_image_from_prime_fd() and
* https://issuetracker.google.com/32077885. */
{ HAL_PIXEL_FORMAT_IMPLEMENTATION_DEFINED, 0, 2, __DRI_IMAGE_FOURCC_NV12 },
{ HAL_PIXEL_FORMAT_IMPLEMENTATION_DEFINED, 0, 1, __DRI_IMAGE_FOURCC_YUV420 },
{ HAL_PIXEL_FORMAT_IMPLEMENTATION_DEFINED, 1, 1, __DRI_IMAGE_FOURCC_YVU420 },
};
static int
get_fourcc_yuv(int native, int is_ycrcb, int chroma_step)
{
for (int i = 0; i < ARRAY_SIZE(droid_yuv_formats); ++i)
if (droid_yuv_formats[i].native == native &&
droid_yuv_formats[i].is_ycrcb == is_ycrcb &&
droid_yuv_formats[i].chroma_step == chroma_step)
return droid_yuv_formats[i].fourcc;
return -1;
}
static bool
is_yuv(int native)
{
for (int i = 0; i < ARRAY_SIZE(droid_yuv_formats); ++i)
if (droid_yuv_formats[i].native == native)
return true;
return false;
}
static int
get_format_bpp(int native)
{
int bpp;
switch (native) {
case HAL_PIXEL_FORMAT_RGBA_8888:
case HAL_PIXEL_FORMAT_IMPLEMENTATION_DEFINED:
/*
* HACK: Hardcode this to RGBX_8888 as per cros_gralloc hack.
* TODO: Remove this once https://issuetracker.google.com/32077885 is fixed.
*/
case HAL_PIXEL_FORMAT_RGBX_8888:
case HAL_PIXEL_FORMAT_BGRA_8888:
bpp = 4;
break;
case HAL_PIXEL_FORMAT_RGB_565:
bpp = 2;
break;
default:
bpp = 0;
break;
}
return bpp;
}
/* createImageFromFds requires fourcc format */
static int get_fourcc(int native)
{
switch (native) {
case HAL_PIXEL_FORMAT_RGB_565: return __DRI_IMAGE_FOURCC_RGB565;
case HAL_PIXEL_FORMAT_BGRA_8888: return __DRI_IMAGE_FOURCC_ARGB8888;
case HAL_PIXEL_FORMAT_RGBA_8888: return __DRI_IMAGE_FOURCC_ABGR8888;
case HAL_PIXEL_FORMAT_IMPLEMENTATION_DEFINED:
/*
* HACK: Hardcode this to RGBX_8888 as per cros_gralloc hack.
* TODO: Remove this once https://issuetracker.google.com/32077885 is fixed.
*/
case HAL_PIXEL_FORMAT_RGBX_8888: return __DRI_IMAGE_FOURCC_XBGR8888;
default:
_eglLog(_EGL_WARNING, "unsupported native buffer format 0x%x", native);
}
return -1;
}
static int get_format(int format)
{
switch (format) {
case HAL_PIXEL_FORMAT_BGRA_8888: return __DRI_IMAGE_FORMAT_ARGB8888;
case HAL_PIXEL_FORMAT_RGB_565: return __DRI_IMAGE_FORMAT_RGB565;
case HAL_PIXEL_FORMAT_RGBA_8888: return __DRI_IMAGE_FORMAT_ABGR8888;
case HAL_PIXEL_FORMAT_IMPLEMENTATION_DEFINED:
/*
* HACK: Hardcode this to RGBX_8888 as per cros_gralloc hack.
* TODO: Revert this once https://issuetracker.google.com/32077885 is fixed.
*/
case HAL_PIXEL_FORMAT_RGBX_8888: return __DRI_IMAGE_FORMAT_XBGR8888;
default:
_eglLog(_EGL_WARNING, "unsupported native buffer format 0x%x", format);
}
return -1;
}
static int
get_native_buffer_fd(struct ANativeWindowBuffer *buf)
{
native_handle_t *handle = (native_handle_t *)buf->handle;
/*
* Various gralloc implementations exist, but the dma-buf fd tends
* to be first. Access it directly to avoid a dependency on specific
* gralloc versions.
*/
return (handle && handle->numFds) ? handle->data[0] : -1;
}
#ifdef HAVE_DRM_GRALLOC
static int
get_native_buffer_name(struct ANativeWindowBuffer *buf)
{
return gralloc_drm_get_gem_handle(buf->handle);
}
#endif /* HAVE_DRM_GRALLOC */
static EGLBoolean
droid_window_dequeue_buffer(struct dri2_egl_surface *dri2_surf)
{
int fence_fd;
if (dri2_surf->window->dequeueBuffer(dri2_surf->window, &dri2_surf->buffer,
&fence_fd))
return EGL_FALSE;
/* If access to the buffer is controlled by a sync fence, then block on the
* fence.
*
* It may be more performant to postpone blocking until there is an
* immediate need to write to the buffer. But doing so would require adding
* hooks to the DRI2 loader.
*
* From the ANativeWindow::dequeueBuffer documentation:
*
* The libsync fence file descriptor returned in the int pointed to by
* the fenceFd argument will refer to the fence that must signal
* before the dequeued buffer may be written to. A value of -1
* indicates that the caller may access the buffer immediately without
* waiting on a fence. If a valid file descriptor is returned (i.e.
* any value except -1) then the caller is responsible for closing the
* file descriptor.
*/
if (fence_fd >= 0) {
/* From the SYNC_IOC_WAIT documentation in <linux/sync.h>:
*
* Waits indefinitely if timeout < 0.
*/
int timeout = -1;
sync_wait(fence_fd, timeout);
close(fence_fd);
}
dri2_surf->buffer->common.incRef(&dri2_surf->buffer->common);
/* Record all the buffers created by ANativeWindow and update back buffer
* for updating buffer's age in swap_buffers.
*/
EGLBoolean updated = EGL_FALSE;
for (int i = 0; i < ARRAY_SIZE(dri2_surf->color_buffers); i++) {
if (!dri2_surf->color_buffers[i].buffer) {
dri2_surf->color_buffers[i].buffer = dri2_surf->buffer;
}
if (dri2_surf->color_buffers[i].buffer == dri2_surf->buffer) {
dri2_surf->back = &dri2_surf->color_buffers[i];
updated = EGL_TRUE;
break;
}
}
if (!updated) {
/* In case of all the buffers were recreated by ANativeWindow, reset
* the color_buffers
*/
for (int i = 0; i < ARRAY_SIZE(dri2_surf->color_buffers); i++) {
dri2_surf->color_buffers[i].buffer = NULL;
dri2_surf->color_buffers[i].age = 0;
}
dri2_surf->color_buffers[0].buffer = dri2_surf->buffer;
dri2_surf->back = &dri2_surf->color_buffers[0];
}
return EGL_TRUE;
}
static EGLBoolean
droid_window_enqueue_buffer(_EGLDisplay *disp, struct dri2_egl_surface *dri2_surf)
{
struct dri2_egl_display *dri2_dpy = dri2_egl_display(disp);
/* To avoid blocking other EGL calls, release the display mutex before
* we enter droid_window_enqueue_buffer() and re-acquire the mutex upon
* return.
*/
mtx_unlock(&disp->Mutex);
/* Queue the buffer with stored out fence fd. The ANativeWindow or buffer
* consumer may choose to wait for the fence to signal before accessing
* it. If fence fd value is -1, buffer can be accessed by consumer
* immediately. Consumer or application shouldn't rely on timestamp
* associated with fence if the fence fd is -1.
*
* Ownership of fd is transferred to consumer after queueBuffer and the
* consumer is responsible for closing it. Caller must not use the fd
* after passing it to queueBuffer.
*/
int fence_fd = dri2_surf->out_fence_fd;
dri2_surf->out_fence_fd = -1;
dri2_surf->window->queueBuffer(dri2_surf->window, dri2_surf->buffer,
fence_fd);
dri2_surf->buffer->common.decRef(&dri2_surf->buffer->common);
dri2_surf->buffer = NULL;
dri2_surf->back = NULL;
mtx_lock(&disp->Mutex);
if (dri2_surf->dri_image_back) {
dri2_dpy->image->destroyImage(dri2_surf->dri_image_back);
dri2_surf->dri_image_back = NULL;
}
return EGL_TRUE;
}
static void
droid_window_cancel_buffer(struct dri2_egl_surface *dri2_surf)
{
int ret;
int fence_fd = dri2_surf->out_fence_fd;
dri2_surf->out_fence_fd = -1;
ret = dri2_surf->window->cancelBuffer(dri2_surf->window,
dri2_surf->buffer, fence_fd);
if (ret < 0) {
_eglLog(_EGL_WARNING, "ANativeWindow::cancelBuffer failed");
dri2_surf->base.Lost = EGL_TRUE;
}
}
static _EGLSurface *
droid_create_surface(_EGLDriver *drv, _EGLDisplay *disp, EGLint type,
_EGLConfig *conf, void *native_window,
const EGLint *attrib_list)
{
__DRIcreateNewDrawableFunc createNewDrawable;
struct dri2_egl_display *dri2_dpy = dri2_egl_display(disp);
struct dri2_egl_config *dri2_conf = dri2_egl_config(conf);
struct dri2_egl_surface *dri2_surf;
struct ANativeWindow *window = native_window;
const __DRIconfig *config;
dri2_surf = calloc(1, sizeof *dri2_surf);
if (!dri2_surf) {
_eglError(EGL_BAD_ALLOC, "droid_create_surface");
return NULL;
}
if (!dri2_init_surface(&dri2_surf->base, disp, type, conf, attrib_list, true))
goto cleanup_surface;
if (type == EGL_WINDOW_BIT) {
int format;
if (window->common.magic != ANDROID_NATIVE_WINDOW_MAGIC) {
_eglError(EGL_BAD_NATIVE_WINDOW, "droid_create_surface");
goto cleanup_surface;
}
if (window->query(window, NATIVE_WINDOW_FORMAT, &format)) {
_eglError(EGL_BAD_NATIVE_WINDOW, "droid_create_surface");
goto cleanup_surface;
}
if (format != dri2_conf->base.NativeVisualID) {
_eglLog(_EGL_WARNING, "Native format mismatch: 0x%x != 0x%x",
format, dri2_conf->base.NativeVisualID);
}
window->query(window, NATIVE_WINDOW_WIDTH, &dri2_surf->base.Width);
window->query(window, NATIVE_WINDOW_HEIGHT, &dri2_surf->base.Height);
}
config = dri2_get_dri_config(dri2_conf, type,
dri2_surf->base.GLColorspace);
if (!config)
goto cleanup_surface;
if (dri2_dpy->image_driver)
createNewDrawable = dri2_dpy->image_driver->createNewDrawable;
else
createNewDrawable = dri2_dpy->dri2->createNewDrawable;
dri2_surf->dri_drawable = (*createNewDrawable)(dri2_dpy->dri_screen, config,
dri2_surf);
if (dri2_surf->dri_drawable == NULL) {
_eglError(EGL_BAD_ALLOC, "createNewDrawable");
goto cleanup_surface;
}
if (window) {
window->common.incRef(&window->common);
dri2_surf->window = window;
}
return &dri2_surf->base;
cleanup_surface:
free(dri2_surf);
return NULL;
}
static _EGLSurface *
droid_create_window_surface(_EGLDriver *drv, _EGLDisplay *disp,
_EGLConfig *conf, void *native_window,
const EGLint *attrib_list)
{
return droid_create_surface(drv, disp, EGL_WINDOW_BIT, conf,
native_window, attrib_list);
}
static _EGLSurface *
droid_create_pbuffer_surface(_EGLDriver *drv, _EGLDisplay *disp,
_EGLConfig *conf, const EGLint *attrib_list)
{
return droid_create_surface(drv, disp, EGL_PBUFFER_BIT, conf,
NULL, attrib_list);
}
static EGLBoolean
droid_destroy_surface(_EGLDriver *drv, _EGLDisplay *disp, _EGLSurface *surf)
{
struct dri2_egl_display *dri2_dpy = dri2_egl_display(disp);
struct dri2_egl_surface *dri2_surf = dri2_egl_surface(surf);
dri2_egl_surface_free_local_buffers(dri2_surf);
if (dri2_surf->base.Type == EGL_WINDOW_BIT) {
if (dri2_surf->buffer)
droid_window_cancel_buffer(dri2_surf);
dri2_surf->window->common.decRef(&dri2_surf->window->common);
}
if (dri2_surf->dri_image_back) {
_eglLog(_EGL_DEBUG, "%s : %d : destroy dri_image_back", __func__, __LINE__);
dri2_dpy->image->destroyImage(dri2_surf->dri_image_back);
dri2_surf->dri_image_back = NULL;
}
if (dri2_surf->dri_image_front) {
_eglLog(_EGL_DEBUG, "%s : %d : destroy dri_image_front", __func__, __LINE__);
dri2_dpy->image->destroyImage(dri2_surf->dri_image_front);
dri2_surf->dri_image_front = NULL;
}
dri2_dpy->core->destroyDrawable(dri2_surf->dri_drawable);
dri2_fini_surface(surf);
free(dri2_surf);
return EGL_TRUE;
}
static int
update_buffers(struct dri2_egl_surface *dri2_surf)
{
if (dri2_surf->base.Lost)
return -1;
if (dri2_surf->base.Type != EGL_WINDOW_BIT)
return 0;
/* try to dequeue the next back buffer */
if (!dri2_surf->buffer && !droid_window_dequeue_buffer(dri2_surf)) {
_eglLog(_EGL_WARNING, "Could not dequeue buffer from native window");
dri2_surf->base.Lost = EGL_TRUE;
return -1;
}
/* free outdated buffers and update the surface size */
if (dri2_surf->base.Width != dri2_surf->buffer->width ||
dri2_surf->base.Height != dri2_surf->buffer->height) {
dri2_egl_surface_free_local_buffers(dri2_surf);
dri2_surf->base.Width = dri2_surf->buffer->width;
dri2_surf->base.Height = dri2_surf->buffer->height;
}
return 0;
}
static int
get_front_bo(struct dri2_egl_surface *dri2_surf, unsigned int format)
{
struct dri2_egl_display *dri2_dpy =
dri2_egl_display(dri2_surf->base.Resource.Display);
if (dri2_surf->dri_image_front)
return 0;
if (dri2_surf->base.Type == EGL_WINDOW_BIT) {
/* According current EGL spec, front buffer rendering
* for window surface is not supported now.
* and mesa doesn't have the implementation of this case.
* Add warning message, but not treat it as error.
*/
_eglLog(_EGL_DEBUG, "DRI driver requested unsupported front buffer for window surface");
} else if (dri2_surf->base.Type == EGL_PBUFFER_BIT) {
dri2_surf->dri_image_front =
dri2_dpy->image->createImage(dri2_dpy->dri_screen,
dri2_surf->base.Width,
dri2_surf->base.Height,
format,
0,
dri2_surf);
if (!dri2_surf->dri_image_front) {
_eglLog(_EGL_WARNING, "dri2_image_front allocation failed");
return -1;
}
}
return 0;
}
static int
get_back_bo(struct dri2_egl_surface *dri2_surf)
{
struct dri2_egl_display *dri2_dpy =
dri2_egl_display(dri2_surf->base.Resource.Display);
int fourcc, pitch;
int offset = 0, fd;
if (dri2_surf->dri_image_back)
return 0;
if (dri2_surf->base.Type == EGL_WINDOW_BIT) {
if (!dri2_surf->buffer) {
_eglLog(_EGL_WARNING, "Could not get native buffer");
return -1;
}
fd = get_native_buffer_fd(dri2_surf->buffer);
if (fd < 0) {
_eglLog(_EGL_WARNING, "Could not get native buffer FD");
return -1;
}
fourcc = get_fourcc(dri2_surf->buffer->format);
pitch = dri2_surf->buffer->stride *
get_format_bpp(dri2_surf->buffer->format);
if (fourcc == -1 || pitch == 0) {
_eglLog(_EGL_WARNING, "Invalid buffer fourcc(%x) or pitch(%d)",
fourcc, pitch);
return -1;
}
dri2_surf->dri_image_back =
dri2_dpy->image->createImageFromFds(dri2_dpy->dri_screen,
dri2_surf->base.Width,
dri2_surf->base.Height,
fourcc,
&fd,
1,
&pitch,
&offset,
dri2_surf);
if (!dri2_surf->dri_image_back) {
_eglLog(_EGL_WARNING, "failed to create DRI image from FD");
return -1;
}
} else if (dri2_surf->base.Type == EGL_PBUFFER_BIT) {
/* The EGL 1.5 spec states that pbuffers are single-buffered. Specifically,
* the spec states that they have a back buffer but no front buffer, in
* contrast to pixmaps, which have a front buffer but no back buffer.
*
* Single-buffered surfaces with no front buffer confuse Mesa; so we deviate
* from the spec, following the precedent of Mesa's EGL X11 platform. The
* X11 platform correctly assigns pbuffers to single-buffered configs, but
* assigns the pbuffer a front buffer instead of a back buffer.
*
* Pbuffers in the X11 platform mostly work today, so let's just copy its
* behavior instead of trying to fix (and hence potentially breaking) the
* world.
*/
_eglLog(_EGL_DEBUG, "DRI driver requested unsupported back buffer for pbuffer surface");
}
return 0;
}
/* Some drivers will pass multiple bits in buffer_mask.
* For such case, will go through all the bits, and
* will not return error when unsupported buffer is requested, only
* return error when the allocation for supported buffer failed.
*/
static int
droid_image_get_buffers(__DRIdrawable *driDrawable,
unsigned int format,
uint32_t *stamp,
void *loaderPrivate,
uint32_t buffer_mask,
struct __DRIimageList *images)
{
struct dri2_egl_surface *dri2_surf = loaderPrivate;
images->image_mask = 0;
images->front = NULL;
images->back = NULL;
if (update_buffers(dri2_surf) < 0)
return 0;
if (buffer_mask & __DRI_IMAGE_BUFFER_FRONT) {
if (get_front_bo(dri2_surf, format) < 0)
return 0;
if (dri2_surf->dri_image_front) {
images->front = dri2_surf->dri_image_front;
images->image_mask |= __DRI_IMAGE_BUFFER_FRONT;
}
}
if (buffer_mask & __DRI_IMAGE_BUFFER_BACK) {
if (get_back_bo(dri2_surf) < 0)
return 0;
if (dri2_surf->dri_image_back) {
images->back = dri2_surf->dri_image_back;
images->image_mask |= __DRI_IMAGE_BUFFER_BACK;
}
}
return 1;
}
static EGLint
droid_query_buffer_age(_EGLDriver *drv,
_EGLDisplay *disp, _EGLSurface *surface)
{
struct dri2_egl_surface *dri2_surf = dri2_egl_surface(surface);
if (update_buffers(dri2_surf) < 0) {
_eglError(EGL_BAD_ALLOC, "droid_query_buffer_age");
return -1;
}
return dri2_surf->back ? dri2_surf->back->age : 0;
}
static EGLBoolean
droid_swap_buffers(_EGLDriver *drv, _EGLDisplay *disp, _EGLSurface *draw)
{
struct dri2_egl_display *dri2_dpy = dri2_egl_display(disp);
struct dri2_egl_surface *dri2_surf = dri2_egl_surface(draw);
if (dri2_surf->base.Type != EGL_WINDOW_BIT)
return EGL_TRUE;
for (int i = 0; i < ARRAY_SIZE(dri2_surf->color_buffers); i++) {
if (dri2_surf->color_buffers[i].age > 0)
dri2_surf->color_buffers[i].age++;
}
/* "XXX: we don't use get_back_bo() since it causes regressions in
* several dEQP tests.
*/
if (dri2_surf->back)
dri2_surf->back->age = 1;
dri2_flush_drawable_for_swapbuffers(disp, draw);
/* dri2_surf->buffer can be null even when no error has occured. For
* example, if the user has called no GL rendering commands since the
* previous eglSwapBuffers, then the driver may have not triggered
* a callback to ANativeWindow::dequeueBuffer, in which case
* dri2_surf->buffer remains null.
*/
if (dri2_surf->buffer)
droid_window_enqueue_buffer(disp, dri2_surf);
dri2_dpy->flush->invalidate(dri2_surf->dri_drawable);
return EGL_TRUE;
}
#if ANDROID_API_LEVEL >= 23
static EGLBoolean
droid_set_damage_region(_EGLDriver *drv,
_EGLDisplay *disp,
_EGLSurface *draw, const EGLint* rects, EGLint n_rects)
{
struct dri2_egl_display *dri2_dpy = dri2_egl_display(disp);
struct dri2_egl_surface *dri2_surf = dri2_egl_surface(draw);
android_native_rect_t* droid_rects = NULL;
int ret;
if (n_rects == 0)
return EGL_TRUE;
droid_rects = malloc(n_rects * sizeof(android_native_rect_t));
if (droid_rects == NULL)
return _eglError(EGL_BAD_ALLOC, "eglSetDamageRegionKHR");
for (EGLint num_drects = 0; num_drects < n_rects; num_drects++) {
EGLint i = num_drects * 4;
droid_rects[num_drects].left = rects[i];
droid_rects[num_drects].bottom = rects[i + 1];
droid_rects[num_drects].right = rects[i] + rects[i + 2];
droid_rects[num_drects].top = rects[i + 1] + rects[i + 3];
}
/*
* XXX/TODO: Need to check for other return values
*/
ret = native_window_set_surface_damage(dri2_surf->window, droid_rects, n_rects);
free(droid_rects);
return ret == 0 ? EGL_TRUE : EGL_FALSE;
}
#endif
static _EGLImage *
droid_create_image_from_prime_fd_yuv(_EGLDisplay *disp, _EGLContext *ctx,
struct ANativeWindowBuffer *buf, int fd)
{
struct dri2_egl_display *dri2_dpy = dri2_egl_display(disp);
struct android_ycbcr ycbcr;
size_t offsets[3];
size_t pitches[3];
int is_ycrcb;
int fourcc;
int ret;
if (!dri2_dpy->gralloc->lock_ycbcr) {
_eglLog(_EGL_WARNING, "Gralloc does not support lock_ycbcr");
return NULL;
}
memset(&ycbcr, 0, sizeof(ycbcr));
ret = dri2_dpy->gralloc->lock_ycbcr(dri2_dpy->gralloc, buf->handle,
0, 0, 0, 0, 0, &ycbcr);
if (ret) {
/* HACK: See droid_create_image_from_prime_fd() and
* https://issuetracker.google.com/32077885.*/
if (buf->format == HAL_PIXEL_FORMAT_IMPLEMENTATION_DEFINED)
return NULL;
_eglLog(_EGL_WARNING, "gralloc->lock_ycbcr failed: %d", ret);
return NULL;
}
dri2_dpy->gralloc->unlock(dri2_dpy->gralloc, buf->handle);
/* When lock_ycbcr's usage argument contains no SW_READ/WRITE flags
* it will return the .y/.cb/.cr pointers based on a NULL pointer,
* so they can be interpreted as offsets. */
offsets[0] = (size_t)ycbcr.y;
/* We assume here that all the planes are located in one DMA-buf. */
is_ycrcb = (size_t)ycbcr.cr < (size_t)ycbcr.cb;
if (is_ycrcb) {
offsets[1] = (size_t)ycbcr.cr;
offsets[2] = (size_t)ycbcr.cb;
} else {
offsets[1] = (size_t)ycbcr.cb;
offsets[2] = (size_t)ycbcr.cr;
}
/* .ystride is the line length (in bytes) of the Y plane,
* .cstride is the line length (in bytes) of any of the remaining
* Cb/Cr/CbCr planes, assumed to be the same for Cb and Cr for fully
* planar formats. */
pitches[0] = ycbcr.ystride;
pitches[1] = pitches[2] = ycbcr.cstride;
/* .chroma_step is the byte distance between the same chroma channel
* values of subsequent pixels, assumed to be the same for Cb and Cr. */
fourcc = get_fourcc_yuv(buf->format, is_ycrcb, ycbcr.chroma_step);
if (fourcc == -1) {
_eglLog(_EGL_WARNING, "unsupported YUV format, native = %x, is_ycrcb = %d, chroma_step = %d",
buf->format, is_ycrcb, ycbcr.chroma_step);
return NULL;
}
if (ycbcr.chroma_step == 2) {
/* Semi-planar Y + CbCr or Y + CrCb format. */
const EGLint attr_list_2plane[] = {
EGL_WIDTH, buf->width,
EGL_HEIGHT, buf->height,
EGL_LINUX_DRM_FOURCC_EXT, fourcc,
EGL_DMA_BUF_PLANE0_FD_EXT, fd,
EGL_DMA_BUF_PLANE0_PITCH_EXT, pitches[0],
EGL_DMA_BUF_PLANE0_OFFSET_EXT, offsets[0],
EGL_DMA_BUF_PLANE1_FD_EXT, fd,
EGL_DMA_BUF_PLANE1_PITCH_EXT, pitches[1],
EGL_DMA_BUF_PLANE1_OFFSET_EXT, offsets[1],
EGL_NONE, 0
};
return dri2_create_image_dma_buf(disp, ctx, NULL, attr_list_2plane);
} else {
/* Fully planar Y + Cb + Cr or Y + Cr + Cb format. */
const EGLint attr_list_3plane[] = {
EGL_WIDTH, buf->width,
EGL_HEIGHT, buf->height,
EGL_LINUX_DRM_FOURCC_EXT, fourcc,
EGL_DMA_BUF_PLANE0_FD_EXT, fd,
EGL_DMA_BUF_PLANE0_PITCH_EXT, pitches[0],
EGL_DMA_BUF_PLANE0_OFFSET_EXT, offsets[0],
EGL_DMA_BUF_PLANE1_FD_EXT, fd,
EGL_DMA_BUF_PLANE1_PITCH_EXT, pitches[1],
EGL_DMA_BUF_PLANE1_OFFSET_EXT, offsets[1],
EGL_DMA_BUF_PLANE2_FD_EXT, fd,
EGL_DMA_BUF_PLANE2_PITCH_EXT, pitches[2],
EGL_DMA_BUF_PLANE2_OFFSET_EXT, offsets[2],
EGL_NONE, 0
};
return dri2_create_image_dma_buf(disp, ctx, NULL, attr_list_3plane);
}
}
static _EGLImage *
droid_create_image_from_prime_fd(_EGLDisplay *disp, _EGLContext *ctx,
struct ANativeWindowBuffer *buf, int fd)
{
unsigned int pitch;
if (is_yuv(buf->format)) {
_EGLImage *image;
image = droid_create_image_from_prime_fd_yuv(disp, ctx, buf, fd);
/*
* HACK: https://issuetracker.google.com/32077885
* There is no API available to properly query the IMPLEMENTATION_DEFINED
* format. As a workaround we rely here on gralloc allocating either
* an arbitrary YCbCr 4:2:0 or RGBX_8888, with the latter being recognized
* by lock_ycbcr failing.
*/
if (image || buf->format != HAL_PIXEL_FORMAT_IMPLEMENTATION_DEFINED)
return image;
}
const int fourcc = get_fourcc(buf->format);
if (fourcc == -1) {
_eglError(EGL_BAD_PARAMETER, "eglCreateEGLImageKHR");
return NULL;
}
pitch = buf->stride * get_format_bpp(buf->format);
if (pitch == 0) {
_eglError(EGL_BAD_PARAMETER, "eglCreateEGLImageKHR");
return NULL;
}
const EGLint attr_list[] = {
EGL_WIDTH, buf->width,
EGL_HEIGHT, buf->height,
EGL_LINUX_DRM_FOURCC_EXT, fourcc,
EGL_DMA_BUF_PLANE0_FD_EXT, fd,
EGL_DMA_BUF_PLANE0_PITCH_EXT, pitch,
EGL_DMA_BUF_PLANE0_OFFSET_EXT, 0,
EGL_NONE, 0
};
return dri2_create_image_dma_buf(disp, ctx, NULL, attr_list);
}
#ifdef HAVE_DRM_GRALLOC
static _EGLImage *
droid_create_image_from_name(_EGLDisplay *disp, _EGLContext *ctx,
struct ANativeWindowBuffer *buf)
{
struct dri2_egl_display *dri2_dpy = dri2_egl_display(disp);
struct dri2_egl_image *dri2_img;
int name;
int format;
name = get_native_buffer_name(buf);
if (!name) {
_eglError(EGL_BAD_PARAMETER, "eglCreateEGLImageKHR");
return NULL;
}
format = get_format(buf->format);
if (format == -1)
return NULL;
dri2_img = calloc(1, sizeof(*dri2_img));
if (!dri2_img) {
_eglError(EGL_BAD_ALLOC, "droid_create_image_mesa_drm");
return NULL;
}
_eglInitImage(&dri2_img->base, disp);
dri2_img->dri_image =
dri2_dpy->image->createImageFromName(dri2_dpy->dri_screen,
buf->width,
buf->height,
format,
name,
buf->stride,
dri2_img);
if (!dri2_img->dri_image) {
free(dri2_img);
_eglError(EGL_BAD_ALLOC, "droid_create_image_mesa_drm");
return NULL;
}
return &dri2_img->base;
}
#endif /* HAVE_DRM_GRALLOC */
static EGLBoolean
droid_query_surface(_EGLDriver *drv, _EGLDisplay *dpy, _EGLSurface *surf,
EGLint attribute, EGLint *value)
{
struct dri2_egl_surface *dri2_surf = dri2_egl_surface(surf);
switch (attribute) {
case EGL_WIDTH:
if (dri2_surf->base.Type == EGL_WINDOW_BIT && dri2_surf->window) {
dri2_surf->window->query(dri2_surf->window,
NATIVE_WINDOW_DEFAULT_WIDTH, value);
return EGL_TRUE;
}
break;
case EGL_HEIGHT:
if (dri2_surf->base.Type == EGL_WINDOW_BIT && dri2_surf->window) {
dri2_surf->window->query(dri2_surf->window,
NATIVE_WINDOW_DEFAULT_HEIGHT, value);
return EGL_TRUE;
}
break;
default:
break;
}
return _eglQuerySurface(drv, dpy, surf, attribute, value);
}
static _EGLImage *
dri2_create_image_android_native_buffer(_EGLDisplay *disp,
_EGLContext *ctx,
struct ANativeWindowBuffer *buf)
{
int fd;
if (ctx != NULL) {
/* From the EGL_ANDROID_image_native_buffer spec:
*
* * If <target> is EGL_NATIVE_BUFFER_ANDROID and <ctx> is not
* EGL_NO_CONTEXT, the error EGL_BAD_CONTEXT is generated.
*/
_eglError(EGL_BAD_CONTEXT, "eglCreateEGLImageKHR: for "
"EGL_NATIVE_BUFFER_ANDROID, the context must be "
"EGL_NO_CONTEXT");
return NULL;
}
if (!buf || buf->common.magic != ANDROID_NATIVE_BUFFER_MAGIC ||
buf->common.version != sizeof(*buf)) {
_eglError(EGL_BAD_PARAMETER, "eglCreateEGLImageKHR");
return NULL;
}
fd = get_native_buffer_fd(buf);
if (fd >= 0)
return droid_create_image_from_prime_fd(disp, ctx, buf, fd);
#ifdef HAVE_DRM_GRALLOC
return droid_create_image_from_name(disp, ctx, buf);
#else
return NULL;
#endif
}
static _EGLImage *
droid_create_image_khr(_EGLDriver *drv, _EGLDisplay *disp,
_EGLContext *ctx, EGLenum target,
EGLClientBuffer buffer, const EGLint *attr_list)
{
switch (target) {
case EGL_NATIVE_BUFFER_ANDROID:
return dri2_create_image_android_native_buffer(disp, ctx,
(struct ANativeWindowBuffer *) buffer);
default:
return dri2_create_image_khr(drv, disp, ctx, target, buffer, attr_list);
}
}
static void
droid_flush_front_buffer(__DRIdrawable * driDrawable, void *loaderPrivate)
{
}
#ifdef HAVE_DRM_GRALLOC
static int
droid_get_buffers_parse_attachments(struct dri2_egl_surface *dri2_surf,
unsigned int *attachments, int count)
{
int num_buffers = 0;
/* fill dri2_surf->buffers */
for (int i = 0; i < count * 2; i += 2) {
__DRIbuffer *buf, *local;
assert(num_buffers < ARRAY_SIZE(dri2_surf->buffers));
buf = &dri2_surf->buffers[num_buffers];
switch (attachments[i]) {
case __DRI_BUFFER_BACK_LEFT:
if (dri2_surf->base.Type == EGL_WINDOW_BIT) {
buf->attachment = attachments[i];
buf->name = get_native_buffer_name(dri2_surf->buffer);
buf->cpp = get_format_bpp(dri2_surf->buffer->format);
buf->pitch = dri2_surf->buffer->stride * buf->cpp;
buf->flags = 0;
if (buf->name)
num_buffers++;
break;
}
/* fall through for pbuffers */
case __DRI_BUFFER_DEPTH:
case __DRI_BUFFER_STENCIL:
case __DRI_BUFFER_ACCUM:
case __DRI_BUFFER_DEPTH_STENCIL:
case __DRI_BUFFER_HIZ:
local = dri2_egl_surface_alloc_local_buffer(dri2_surf,
attachments[i], attachments[i + 1]);
if (local) {
*buf = *local;
num_buffers++;
}
break;
case __DRI_BUFFER_FRONT_LEFT:
case __DRI_BUFFER_FRONT_RIGHT:
case __DRI_BUFFER_FAKE_FRONT_LEFT:
case __DRI_BUFFER_FAKE_FRONT_RIGHT:
case __DRI_BUFFER_BACK_RIGHT:
default:
/* no front or right buffers */
break;
}
}
return num_buffers;
}
static __DRIbuffer *
droid_get_buffers_with_format(__DRIdrawable * driDrawable,
int *width, int *height,
unsigned int *attachments, int count,
int *out_count, void *loaderPrivate)
{
struct dri2_egl_surface *dri2_surf = loaderPrivate;
if (update_buffers(dri2_surf) < 0)
return NULL;
*out_count = droid_get_buffers_parse_attachments(dri2_surf, attachments, count);
if (width)
*width = dri2_surf->base.Width;
if (height)
*height = dri2_surf->base.Height;
return dri2_surf->buffers;
}
#endif /* HAVE_DRM_GRALLOC */
static unsigned
droid_get_capability(void *loaderPrivate, enum dri_loader_cap cap)
{
/* Note: loaderPrivate is _EGLDisplay* */
switch (cap) {
case DRI_LOADER_CAP_RGBA_ORDERING:
return 1;
default:
return 0;
}
}
static EGLBoolean
droid_add_configs_for_visuals(_EGLDriver *drv, _EGLDisplay *dpy)
{
struct dri2_egl_display *dri2_dpy = dri2_egl_display(dpy);
static const struct {
int format;
unsigned int rgba_masks[4];
} visuals[] = {
{ HAL_PIXEL_FORMAT_RGBA_8888, { 0x000000ff, 0x0000ff00, 0x00ff0000, 0xff000000 } },
{ HAL_PIXEL_FORMAT_RGBX_8888, { 0x000000ff, 0x0000ff00, 0x00ff0000, 0x00000000 } },
{ HAL_PIXEL_FORMAT_RGB_565, { 0x0000f800, 0x000007e0, 0x0000001f, 0x00000000 } },
{ HAL_PIXEL_FORMAT_BGRA_8888, { 0x00ff0000, 0x0000ff00, 0x000000ff, 0xff000000 } },
};
unsigned int format_count[ARRAY_SIZE(visuals)] = { 0 };
int config_count = 0;
/* The nesting of loops is significant here. Also significant is the order
* of the HAL pixel formats. Many Android apps (such as Google's official
* NDK GLES2 example app), and even portions the core framework code (such
* as SystemServiceManager in Nougat), incorrectly choose their EGLConfig.
* They neglect to match the EGLConfig's EGL_NATIVE_VISUAL_ID against the
* window's native format, and instead choose the first EGLConfig whose
* channel sizes match those of the native window format while ignoring the
* channel *ordering*.
*
* We can detect such buggy clients in logcat when they call
* eglCreateSurface, by detecting the mismatch between the EGLConfig's
* format and the window's format.
*
* As a workaround, we generate EGLConfigs such that all EGLConfigs for HAL
* pixel format i precede those for HAL pixel format i+1. In my
* (chadversary) testing on Android Nougat, this was good enough to pacify
* the buggy clients.
*/
for (int i = 0; i < ARRAY_SIZE(visuals); i++) {
for (int j = 0; dri2_dpy->driver_configs[j]; j++) {
const EGLint surface_type = EGL_WINDOW_BIT | EGL_PBUFFER_BIT;
const EGLint config_attrs[] = {
EGL_NATIVE_VISUAL_ID, visuals[i].format,
EGL_NATIVE_VISUAL_TYPE, visuals[i].format,
EGL_FRAMEBUFFER_TARGET_ANDROID, EGL_TRUE,
EGL_RECORDABLE_ANDROID, EGL_TRUE,
EGL_NONE
};
struct dri2_egl_config *dri2_conf =
dri2_add_config(dpy, dri2_dpy->driver_configs[j],
config_count + 1, surface_type, config_attrs,
visuals[i].rgba_masks);
if (dri2_conf) {
if (dri2_conf->base.ConfigID == config_count + 1)
config_count++;
format_count[i]++;
}
}
}
for (int i = 0; i < ARRAY_SIZE(format_count); i++) {
if (!format_count[i]) {
_eglLog(_EGL_DEBUG, "No DRI config supports native format 0x%x",
visuals[i].format);
}
}
return (config_count != 0);
}
static const struct dri2_egl_display_vtbl droid_display_vtbl = {
.authenticate = NULL,
.create_window_surface = droid_create_window_surface,
.create_pixmap_surface = dri2_fallback_create_pixmap_surface,
.create_pbuffer_surface = droid_create_pbuffer_surface,
.destroy_surface = droid_destroy_surface,
.create_image = droid_create_image_khr,
.swap_buffers = droid_swap_buffers,
.swap_buffers_with_damage = dri2_fallback_swap_buffers_with_damage, /* Android implements the function */
.swap_buffers_region = dri2_fallback_swap_buffers_region,
#if ANDROID_API_LEVEL >= 23
.set_damage_region = droid_set_damage_region,
#else
.set_damage_region = dri2_fallback_set_damage_region,
#endif
.post_sub_buffer = dri2_fallback_post_sub_buffer,
.copy_buffers = dri2_fallback_copy_buffers,
.query_buffer_age = droid_query_buffer_age,
.query_surface = droid_query_surface,
.create_wayland_buffer_from_image = dri2_fallback_create_wayland_buffer_from_image,
.get_sync_values = dri2_fallback_get_sync_values,
.get_dri_drawable = dri2_surface_get_dri_drawable,
};
#ifdef HAVE_DRM_GRALLOC
static const __DRIdri2LoaderExtension droid_dri2_loader_extension = {
.base = { __DRI_DRI2_LOADER, 4 },
.getBuffers = NULL,
.flushFrontBuffer = droid_flush_front_buffer,
.getBuffersWithFormat = droid_get_buffers_with_format,
.getCapability = droid_get_capability,
};
#endif /* HAVE_DRM_GRALLOC */
static const __DRIimageLoaderExtension droid_image_loader_extension = {
.base = { __DRI_IMAGE_LOADER, 2 },
.getBuffers = droid_image_get_buffers,
.flushFrontBuffer = droid_flush_front_buffer,
.getCapability = droid_get_capability,
};
#ifdef HAVE_DRM_GRALLOC
static const __DRIextension *droid_dri2_loader_extensions[] = {
&droid_dri2_loader_extension.base,
&image_lookup_extension.base,
&use_invalidate.base,
NULL,
};
#endif /* HAVE_DRM_GRALLOC */
static const __DRIextension *droid_image_loader_extensions[] = {
&droid_image_loader_extension.base,
&image_lookup_extension.base,
&use_invalidate.base,
NULL,
};
EGLBoolean
droid_load_driver(_EGLDisplay *disp)
{
struct dri2_egl_display *dri2_dpy = disp->DriverData;
const char *err;
dri2_dpy->driver_name = loader_get_driver_for_fd(dri2_dpy->fd);
if (dri2_dpy->driver_name == NULL) {
err = "DRI2: failed to get driver name";
goto error;
}
dri2_dpy->is_render_node = drmGetNodeTypeFromFd(dri2_dpy->fd) == DRM_NODE_RENDER;
if (!dri2_dpy->is_render_node) {
#ifdef HAVE_DRM_GRALLOC
dri2_dpy->loader_extensions = droid_dri2_loader_extensions;
if (!dri2_load_driver(disp)) {
err = "DRI2: failed to load driver";
goto error;
}
} else {
/* render nodes cannot use Gem names, and thus do not support
* the __DRI_DRI2_LOADER extension */
dri2_dpy->loader_extensions = droid_image_loader_extensions;
if (!dri2_load_driver_dri3(disp)) {
err = "DRI3: failed to load driver";
goto error;
}
#else
err = "DRI2: handle is not for a render node";
goto error;
}
dri2_dpy->loader_extensions = droid_image_loader_extensions;
if (!dri2_load_driver_dri3(disp)) {
err = "DRI3: failed to load driver";
goto error;
#endif
}
return EGL_TRUE;
error:
free(dri2_dpy->driver_name);
dri2_dpy->driver_name = NULL;
return _eglError(EGL_NOT_INITIALIZED, err);
}
static int
droid_probe_driver(int fd, void *data)
{
_EGLDisplay *disp = data;
struct dri2_egl_display *dri2_dpy = disp->DriverData;
dri2_dpy->fd = fd;
if (!droid_load_driver(disp))
return false;
/* Since this probe can succeed, but another filter may failed
this string needs to be deallocated either way.
Once an FD has been found, this string will be set a second time. */
free(dri2_dpy->driver_name);
dri2_dpy->driver_name = NULL;
return true;
}
static int
droid_open_device(_EGLDisplay *disp)
{
const int MAX_DRM_DEVICES = 32;
int prop_set, num_devices, ret;
int fd = -1, fallback_fd = -1;
char vendor_name[PROPERTY_VALUE_MAX];
property_get("drm.gpu.vendor_name", vendor_name, NULL);
drm_match_t filters[] = {
{DRM_MATCH_DRIVER_NAME, .str = vendor_name },
{DRM_MATCH_FUNCTION, .func = { .fp = droid_probe_driver,
.data = disp }},
};
const int nbr_filters = sizeof(filters)/sizeof(drm_match_t);
drmDevicePtr devices[MAX_DRM_DEVICES];
num_devices = drmGetDevices2(0, devices, MAX_DRM_DEVICES);
if (num_devices < 0) {
_eglLog(_EGL_WARNING, "Failed to find any DRM devices");
return -1;
}
for (int i = 0; i < num_devices; i++) {
char *dev_path = devices[i]->nodes[DRM_NODE_RENDER];
fd = loader_open_device(dev_path);
if (fd == -1) {
_eglLog(_EGL_WARNING, "%s() Failed to open DRM device %s",
__func__, dev_path);
continue;
}
if (drmHandleMatch(fd, filters, nbr_filters))
goto next;
break;
next:
if (fallback_fd == -1) {
fallback_fd = fd;
fd = -1;
} else {
close(fd);
fd = -1;
}
continue;
}
if (fallback_fd < 0 && fd < 0) {
_eglLog(_EGL_WARNING, "Failed to open any DRM device");
return -1;
}
if (fd < 0) {
_eglLog(_EGL_WARNING, "Failed to open desired DRM device, using fallback");
return fallback_fd;
}
close(fallback_fd);
return fd;
}
EGLBoolean
dri2_initialize_android(_EGLDriver *drv, _EGLDisplay *disp)
{
struct dri2_egl_display *dri2_dpy;
const char *err;
int ret;
/* Not supported yet */
if (disp->Options.ForceSoftware)
return EGL_FALSE;
loader_set_logger(_eglLog);
dri2_dpy = calloc(1, sizeof(*dri2_dpy));
if (!dri2_dpy)
return _eglError(EGL_BAD_ALLOC, "eglInitialize");
dri2_dpy->fd = -1;
ret = hw_get_module(GRALLOC_HARDWARE_MODULE_ID,
(const hw_module_t **)&dri2_dpy->gralloc);
if (ret) {
err = "DRI2: failed to get gralloc module";
goto cleanup;
}
disp->DriverData = (void *) dri2_dpy;
dri2_dpy->fd = droid_open_device(disp);
if (dri2_dpy->fd < 0) {
err = "DRI2: failed to open device";
goto cleanup;
}
if (!droid_load_driver(disp)) {
err = "DRI2: failed to load driver";
goto cleanup;
}
if (!dri2_create_screen(disp)) {
err = "DRI2: failed to create screen";
goto cleanup;
}
if (!dri2_setup_extensions(disp)) {
err = "DRI2: failed to setup extensions";
goto cleanup;
}
dri2_setup_screen(disp);
if (!droid_add_configs_for_visuals(drv, disp)) {
err = "DRI2: failed to add configs";
goto cleanup;
}
disp->Extensions.ANDROID_framebuffer_target = EGL_TRUE;
disp->Extensions.ANDROID_image_native_buffer = EGL_TRUE;
disp->Extensions.ANDROID_recordable = EGL_TRUE;
disp->Extensions.EXT_buffer_age = EGL_TRUE;
#if ANDROID_API_LEVEL >= 23
disp->Extensions.KHR_partial_update = EGL_TRUE;
#endif
disp->Extensions.KHR_image = EGL_TRUE;
/* Fill vtbl last to prevent accidentally calling virtual function during
* initialization.
*/
dri2_dpy->vtbl = &droid_display_vtbl;
return EGL_TRUE;
cleanup:
dri2_display_destroy(disp);
return _eglError(EGL_NOT_INITIALIZED, err);
}