drv.c

   1 /*
   2  * Copyright 2016 The Chromium OS Authors. All rights reserved.
   3  * Use of this source code is governed by a BSD-style license that can be
   4  * found in the LICENSE file.
   5  */
   6 #include <assert.h>
   7 #include <errno.h>
   8 #include <fcntl.h>
   9 #include <pthread.h>
  10 #include <stdint.h>
  11 #include <stdio.h>
  12 #include <stdlib.h>
  13 #include <string.h>
  14 #include <sys/mman.h>
  15 #include <xf86drm.h>
  16
  17 #include "drv_priv.h"
  18 #include "helpers.h"
  19 #include "util.h"
  20
  21 #ifdef DRV_AMDGPU
  22 extern struct backend backend_amdgpu;
  23 #endif
  24 extern struct backend backend_cirrus;
  25 extern struct backend backend_evdi;
  26 #ifdef DRV_EXYNOS
  27 extern struct backend backend_exynos;
  28 #endif
  29 extern struct backend backend_gma500;
  30 #ifdef DRV_I915
  31 extern struct backend backend_i915;
  32 #endif
  33 #ifdef DRV_MARVELL
  34 extern struct backend backend_marvell;
  35 #endif
  36 #ifdef DRV_MEDIATEK
  37 extern struct backend backend_mediatek;
  38 #endif
  39 extern struct backend backend_nouveau;
  40 #ifdef DRV_RADEON
  41 extern struct backend backend_radeon;
  42 #endif
  43 #ifdef DRV_ROCKCHIP
  44 extern struct backend backend_rockchip;
  45 #endif
  46 #ifdef DRV_TEGRA
  47 extern struct backend backend_tegra;
  48 #endif
  49 extern struct backend backend_udl;
  50 #ifdef DRV_VC4
  51 extern struct backend backend_vc4;
  52 #endif
  53 extern struct backend backend_vgem;
  54 extern struct backend backend_virtio_gpu;
  55
  56 static struct backend *drv_get_backend(int fd)
  57 {
  58         drmVersionPtr drm_version;
  59         unsigned int i;
  60
  61         drm_version = drmGetVersion(fd);
  62
  63         if (!drm_version)
  64                 return NULL;
  65
  66         struct backend *backend_list[] = {
  67 #ifdef DRV_AMDGPU
  68                 &backend_amdgpu,
  69 #endif
  70                 &backend_cirrus,   &backend_evdi,
  71 #ifdef DRV_EXYNOS
  72                 &backend_exynos,
  73 #endif
  74                 &backend_gma500,
  75 #ifdef DRV_I915
  76                 &backend_i915,
  77 #endif
  78 #ifdef DRV_MARVELL
  79                 &backend_marvell,
  80 #endif
  81 #ifdef DRV_MEDIATEK
  82                 &backend_mediatek,
  83 #endif
  84                 &backend_nouveau,
  85 #ifdef DRV_RADEON
  86                 &backend_radeon,
  87 #endif
  88 #ifdef DRV_ROCKCHIP
  89                 &backend_rockchip,
  90 #endif
  91 #ifdef DRV_TEGRA
  92                 &backend_tegra,
  93 #endif
  94                 &backend_udl,
  95 #ifdef DRV_VC4
  96                 &backend_vc4,
  97 #endif
  98                 &backend_vgem,     &backend_virtio_gpu,
  99         };
 100
 101         for (i = 0; i < ARRAY_SIZE(backend_list); i++)
 102                 if (!strcmp(drm_version->name, backend_list[i]->name)) {
 103                         drmFreeVersion(drm_version);
 104                         return backend_list[i];
 105                 }
 106
 107         drmFreeVersion(drm_version);
 108         return NULL;
 109 }
 110
 111 struct driver *drv_create(int fd)
 112 {
 113         struct driver *drv;
 114         int ret;
 115
 116         drv = (struct driver *)calloc(1, sizeof(*drv));
 117
 118         if (!drv)
 119                 return NULL;
 120
 121         drv->fd = fd;
 122         drv->backend = drv_get_backend(fd);
 123
 124         if (!drv->backend)
 125                 goto free_driver;
 126
 127         if (pthread_mutex_init(&drv->driver_lock, NULL))
 128                 goto free_driver;
 129
 130         drv->buffer_table = drmHashCreate();
 131         if (!drv->buffer_table)
 132                 goto free_lock;
 133
 134         drv->map_table = drmHashCreate();
 135         if (!drv->map_table)
 136                 goto free_buffer_table;
 137
 138         /* Start with a power of 2 number of allocations. */
 139         drv->backend->combos.allocations = 2;
 140         drv->backend->combos.size = 0;
 141         drv->backend->combos.data =
 142             calloc(drv->backend->combos.allocations, sizeof(struct combination));
 143         if (!drv->backend->combos.data)
 144                 goto free_map_table;
 145
 146         if (drv->backend->init) {
 147                 ret = drv->backend->init(drv);
 148                 if (ret) {
 149                         free(drv->backend->combos.data);
 150                         goto free_map_table;
 151                 }
 152         }
 153
 154         return drv;
 155
 156 free_map_table:
 157         drmHashDestroy(drv->map_table);
 158 free_buffer_table:
 159         drmHashDestroy(drv->buffer_table);
 160 free_lock:
 161         pthread_mutex_destroy(&drv->driver_lock);
 162 free_driver:
 163         free(drv);
 164         return NULL;
 165 }
 166
 167 void drv_destroy(struct driver *drv)
 168 {
 169         pthread_mutex_lock(&drv->driver_lock);
 170
 171         if (drv->backend->close)
 172                 drv->backend->close(drv);
 173
 174         drmHashDestroy(drv->buffer_table);
 175         drmHashDestroy(drv->map_table);
 176
 177         free(drv->backend->combos.data);
 178
 179         pthread_mutex_unlock(&drv->driver_lock);
 180         pthread_mutex_destroy(&drv->driver_lock);
 181
 182         free(drv);
 183 }
 184
 185 int drv_get_fd(struct driver *drv)
 186 {
 187         return drv->fd;
 188 }
 189
 190 const char *drv_get_name(struct driver *drv)
 191 {
 192         return drv->backend->name;
 193 }
 194
 195 struct combination *drv_get_combination(struct driver *drv, uint32_t format, uint64_t usage)
 196 {
 197         struct combination *curr, *best;
 198
 199         if (format == DRM_FORMAT_NONE || usage == BO_USE_NONE)
 200                 return 0;
 201
 202         best = NULL;
 203         uint32_t i;
 204         for (i = 0; i < drv->backend->combos.size; i++) {
 205                 curr = &drv->backend->combos.data[i];
 206                 if ((format == curr->format) && usage == (curr->usage & usage))
 207                         if (!best || best->metadata.priority < curr->metadata.priority)
 208                                 best = curr;
 209         }
 210
 211         return best;
 212 }
 213
 214 struct bo *drv_bo_new(struct driver *drv, uint32_t width, uint32_t height, uint32_t format,
 215                       uint64_t flags)
 216 {
 217
 218         struct bo *bo;
 219         bo = (struct bo *)calloc(1, sizeof(*bo));
 220
 221         if (!bo)
 222                 return NULL;
 223
 224         bo->drv = drv;
 225         bo->width = width;
 226         bo->height = height;
 227         bo->format = format;
 228         bo->flags = flags;
 229         bo->num_planes = drv_num_planes_from_format(format);
 230
 231         if (!bo->num_planes) {
 232                 free(bo);
 233                 return NULL;
 234         }
 235
 236         return bo;
 237 }
 238
 239 struct bo *drv_bo_create(struct driver *drv, uint32_t width, uint32_t height, uint32_t format,
 240                          uint64_t flags)
 241 {
 242         int ret;
 243         size_t plane;
 244         struct bo *bo;
 245
 246         bo = drv_bo_new(drv, width, height, format, flags);
 247
 248         if (!bo)
 249                 return NULL;
 250
 251         ret = drv->backend->bo_create(bo, width, height, format, flags);
 252
 253         if (ret) {
 254                 free(bo);
 255                 return NULL;
 256         }
 257
 258         pthread_mutex_lock(&drv->driver_lock);
 259
 260         for (plane = 0; plane < bo->num_planes; plane++)
 261                 drv_increment_reference_count(drv, bo, plane);
 262
 263         pthread_mutex_unlock(&drv->driver_lock);
 264
 265         return bo;
 266 }
 267
 268 struct bo *drv_bo_create_with_modifiers(struct driver *drv, uint32_t width, uint32_t height,
 269                                         uint32_t format, const uint64_t *modifiers, uint32_t count)
 270 {
 271         int ret;
 272         size_t plane;
 273         struct bo *bo;
 274
 275         if (!drv->backend->bo_create_with_modifiers) {
 276                 errno = ENOENT;
 277                 return NULL;
 278         }
 279
 280         bo = drv_bo_new(drv, width, height, format, BO_USE_NONE);
 281
 282         if (!bo)
 283                 return NULL;
 284
 285         ret = drv->backend->bo_create_with_modifiers(bo, width, height, format, modifiers, count);
 286
 287         if (ret) {
 288                 free(bo);
 289                 return NULL;
 290         }
 291
 292         pthread_mutex_lock(&drv->driver_lock);
 293
 294         for (plane = 0; plane < bo->num_planes; plane++)
 295                 drv_increment_reference_count(drv, bo, plane);
 296
 297         pthread_mutex_unlock(&drv->driver_lock);
 298
 299         return bo;
 300 }
 301
 302 void drv_bo_destroy(struct bo *bo)
 303 {
 304         size_t plane;
 305         uintptr_t total = 0;
 306         size_t map_count = 0;
 307         struct driver *drv = bo->drv;
 308
 309         pthread_mutex_lock(&drv->driver_lock);
 310
 311         for (plane = 0; plane < bo->num_planes; plane++)
 312                 drv_decrement_reference_count(drv, bo, plane);
 313
 314         for (plane = 0; plane < bo->num_planes; plane++) {
 315                 void *ptr;
 316
 317                 total += drv_get_reference_count(drv, bo, plane);
 318                 map_count += !drmHashLookup(bo->drv->map_table, bo->handles[plane].u32, &ptr);
 319         }
 320
 321         pthread_mutex_unlock(&drv->driver_lock);
 322
 323         if (total == 0) {
 324                 /*
 325                  * If we leak a reference to the GEM handle being freed here in the mapping table,
 326                  * we risk using the mapping table entry later for a completely different BO that
 327                  * gets the same handle. (See b/38250067.)
 328                  */
 329                 assert(!map_count);
 330                 bo->drv->backend->bo_destroy(bo);
 331         }
 332
 333         free(bo);
 334 }
 335
 336 struct bo *drv_bo_import(struct driver *drv, struct drv_import_fd_data *data)
 337 {
 338         int ret;
 339         size_t plane;
 340         struct bo *bo;
 341
 342         bo = drv_bo_new(drv, data->width, data->height, data->format, data->flags);
 343
 344         if (!bo)
 345                 return NULL;
 346
 347         ret = drv->backend->bo_import(bo, data);
 348         if (ret) {
 349                 free(bo);
 350                 return NULL;
 351         }
 352
 353         for (plane = 0; plane < bo->num_planes; plane++) {
 354                 bo->strides[plane] = data->strides[plane];
 355                 bo->offsets[plane] = data->offsets[plane];
 356                 bo->sizes[plane] = data->sizes[plane];
 357                 bo->format_modifiers[plane] = data->format_modifiers[plane];
 358                 bo->total_size += data->sizes[plane];
 359         }
 360
 361         return bo;
 362 }
 363
 364 void *drv_bo_map(struct bo *bo, uint32_t x, uint32_t y, uint32_t width, uint32_t height,
 365                  uint32_t flags, struct map_info **map_data, size_t plane)
 366 {
 367         void *ptr;
 368         uint8_t *addr;
 369         size_t offset;
 370         struct map_info *data;
 371         int prot;
 372
 373         assert(width > 0);
 374         assert(height > 0);
 375         assert(x + width <= drv_bo_get_width(bo));
 376         assert(y + height <= drv_bo_get_height(bo));
 377         assert(BO_TRANSFER_READ_WRITE & flags);
 378
 379         pthread_mutex_lock(&bo->drv->driver_lock);
 380
 381         if (!drmHashLookup(bo->drv->map_table, bo->handles[plane].u32, &ptr)) {
 382                 data = (struct map_info *)ptr;
 383                 data->refcount++;
 384                 goto success;
 385         }
 386
 387         data = calloc(1, sizeof(*data));
 388         prot = BO_TRANSFER_WRITE & flags ? PROT_WRITE | PROT_READ : PROT_READ;
 389         addr = bo->drv->backend->bo_map(bo, data, plane, prot);
 390         if (addr == MAP_FAILED) {
 391                 *map_data = NULL;
 392                 free(data);
 393                 pthread_mutex_unlock(&bo->drv->driver_lock);
 394                 return MAP_FAILED;
 395         }
 396
 397         data->refcount = 1;
 398         data->addr = addr;
 399         data->handle = bo->handles[plane].u32;
 400         drmHashInsert(bo->drv->map_table, bo->handles[plane].u32, (void *)data);
 401
 402 success:
 403         *map_data = data;
 404         offset = drv_bo_get_plane_stride(bo, plane) * y;
 405         offset += drv_stride_from_format(bo->format, x, plane);
 406         addr = (uint8_t *)data->addr;
 407         addr += drv_bo_get_plane_offset(bo, plane) + offset;
 408         pthread_mutex_unlock(&bo->drv->driver_lock);
 409
 410         return (void *)addr;
 411 }
 412
 413 int drv_bo_unmap(struct bo *bo, struct map_info *data)
 414 {
 415         int ret = 0;
 416
 417         assert(data);
 418         assert(data->refcount >= 0);
 419
 420         pthread_mutex_lock(&bo->drv->driver_lock);
 421
 422         if (!--data->refcount) {
 423                 if (bo->drv->backend->bo_unmap)
 424                         ret = bo->drv->backend->bo_unmap(bo, data);
 425                 else
 426                         ret = munmap(data->addr, data->length);
 427                 drmHashDelete(bo->drv->map_table, data->handle);
 428                 free(data);
 429         }
 430
 431         pthread_mutex_unlock(&bo->drv->driver_lock);
 432
 433         return ret;
 434 }
 435
 436 uint32_t drv_bo_get_width(struct bo *bo)
 437 {
 438         return bo->width;
 439 }
 440
 441 uint32_t drv_bo_get_height(struct bo *bo)
 442 {
 443         return bo->height;
 444 }
 445
 446 uint32_t drv_bo_get_stride_or_tiling(struct bo *bo)
 447 {
 448         return bo->tiling ? bo->tiling : drv_bo_get_plane_stride(bo, 0);
 449 }
 450
 451 size_t drv_bo_get_num_planes(struct bo *bo)
 452 {
 453         return bo->num_planes;
 454 }
 455
 456 union bo_handle drv_bo_get_plane_handle(struct bo *bo, size_t plane)
 457 {
 458         return bo->handles[plane];
 459 }
 460
 461 #ifndef DRM_RDWR
 462 #define DRM_RDWR O_RDWR
 463 #endif
 464
 465 int drv_bo_get_plane_fd(struct bo *bo, size_t plane)
 466 {
 467
 468         int ret, fd;
 469         assert(plane < bo->num_planes);
 470
 471         ret = drmPrimeHandleToFD(bo->drv->fd, bo->handles[plane].u32, DRM_CLOEXEC | DRM_RDWR, &fd);
 472
 473         return (ret) ? ret : fd;
 474 }
 475
 476 uint32_t drv_bo_get_plane_offset(struct bo *bo, size_t plane)
 477 {
 478         assert(plane < bo->num_planes);
 479         return bo->offsets[plane];
 480 }
 481
 482 uint32_t drv_bo_get_plane_size(struct bo *bo, size_t plane)
 483 {
 484         assert(plane < bo->num_planes);
 485         return bo->sizes[plane];
 486 }
 487
 488 uint32_t drv_bo_get_plane_stride(struct bo *bo, size_t plane)
 489 {
 490         assert(plane < bo->num_planes);
 491         return bo->strides[plane];
 492 }
 493
 494 uint64_t drv_bo_get_plane_format_modifier(struct bo *bo, size_t plane)
 495 {
 496         assert(plane < bo->num_planes);
 497         return bo->format_modifiers[plane];
 498 }
 499
 500 uint32_t drv_bo_get_format(struct bo *bo)
 501 {
 502         return bo->format;
 503 }
 504
 505 uint32_t drv_resolve_format(struct driver *drv, uint32_t format, uint64_t usage)
 506 {
 507         if (drv->backend->resolve_format)
 508                 return drv->backend->resolve_format(format, usage);
 509
 510         return format;
 511 }
 512
 513 size_t drv_num_planes_from_format(uint32_t format)
 514 {
 515         switch (format) {
 516         case DRM_FORMAT_ABGR1555:
 517         case DRM_FORMAT_ABGR2101010:
 518         case DRM_FORMAT_ABGR4444:
 519         case DRM_FORMAT_ABGR8888:
 520         case DRM_FORMAT_ARGB1555:
 521         case DRM_FORMAT_ARGB2101010:
 522         case DRM_FORMAT_ARGB4444:
 523         case DRM_FORMAT_ARGB8888:
 524         case DRM_FORMAT_AYUV:
 525         case DRM_FORMAT_BGR233:
 526         case DRM_FORMAT_BGR565:
 527         case DRM_FORMAT_BGR888:
 528         case DRM_FORMAT_BGRA1010102:
 529         case DRM_FORMAT_BGRA4444:
 530         case DRM_FORMAT_BGRA5551:
 531         case DRM_FORMAT_BGRA8888:
 532         case DRM_FORMAT_BGRX1010102:
 533         case DRM_FORMAT_BGRX4444:
 534         case DRM_FORMAT_BGRX5551:
 535         case DRM_FORMAT_BGRX8888:
 536         case DRM_FORMAT_C8:
 537         case DRM_FORMAT_GR88:
 538         case DRM_FORMAT_R8:
 539         case DRM_FORMAT_RG88:
 540         case DRM_FORMAT_RGB332:
 541         case DRM_FORMAT_RGB565:
 542         case DRM_FORMAT_RGB888:
 543         case DRM_FORMAT_RGBA1010102:
 544         case DRM_FORMAT_RGBA4444:
 545         case DRM_FORMAT_RGBA5551:
 546         case DRM_FORMAT_RGBA8888:
 547         case DRM_FORMAT_RGBX1010102:
 548         case DRM_FORMAT_RGBX4444:
 549         case DRM_FORMAT_RGBX5551:
 550         case DRM_FORMAT_RGBX8888:
 551         case DRM_FORMAT_UYVY:
 552         case DRM_FORMAT_VYUY:
 553         case DRM_FORMAT_XBGR1555:
 554         case DRM_FORMAT_XBGR2101010:
 555         case DRM_FORMAT_XBGR4444:
 556         case DRM_FORMAT_XBGR8888:
 557         case DRM_FORMAT_XRGB1555:
 558         case DRM_FORMAT_XRGB2101010:
 559         case DRM_FORMAT_XRGB4444:
 560         case DRM_FORMAT_XRGB8888:
 561         case DRM_FORMAT_YUYV:
 562         case DRM_FORMAT_YVYU:
 563                 return 1;
 564         case DRM_FORMAT_NV12:
 565         case DRM_FORMAT_NV21:
 566                 return 2;
 567         case DRM_FORMAT_YVU420:
 568         case DRM_FORMAT_YVU420_ANDROID:
 569                 return 3;
 570         }
 571
 572         fprintf(stderr, "drv: UNKNOWN FORMAT %d\n", format);
 573         return 0;
 574 }
 575
 576 uint32_t drv_size_from_format(uint32_t format, uint32_t stride, uint32_t height, size_t plane)
 577 {
 578         assert(plane < drv_num_planes_from_format(format));
 579         uint32_t vertical_subsampling;
 580
 581         switch (format) {
 582         case DRM_FORMAT_NV12:
 583         case DRM_FORMAT_YVU420:
 584         case DRM_FORMAT_YVU420_ANDROID:
 585                 vertical_subsampling = (plane == 0) ? 1 : 2;
 586                 break;
 587         default:
 588                 vertical_subsampling = 1;
 589         }
 590
 591         return stride * DIV_ROUND_UP(height, vertical_subsampling);
 592 }
 593
 594 uint32_t drv_num_buffers_per_bo(struct bo *bo)
 595 {
 596         uint32_t count = 0;
 597         size_t plane, p;
 598
 599         for (plane = 0; plane < bo->num_planes; plane++) {
 600                 for (p = 0; p < plane; p++)
 601                         if (bo->handles[p].u32 == bo->handles[plane].u32)
 602                                 break;
 603                 if (p == plane)
 604                         count++;
 605         }
 606
 607         return count;
 608 }