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