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 use_flags)
 198 {
 199         struct combination *curr, *best;
 200
 201         if (format == DRM_FORMAT_NONE || use_flags == 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) && use_flags == (curr->use_flags & use_flags))
 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 use_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->use_flags = use_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 use_flags)
 243 {
 244         int ret;
 245         size_t plane;
 246         struct bo *bo;
 247
 248         bo = drv_bo_new(drv, width, height, format, use_flags);
 249
 250         if (!bo)
 251                 return NULL;
 252
 253         ret = drv->backend->bo_create(bo, width, height, format, use_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                 if (plane > 0)
 264                         assert(bo->offsets[plane] >= bo->offsets[plane - 1]);
 265
 266                 drv_increment_reference_count(drv, bo, plane);
 267         }
 268
 269         pthread_mutex_unlock(&drv->driver_lock);
 270
 271         return bo;
 272 }
 273
 274 struct bo *drv_bo_create_with_modifiers(struct driver *drv, uint32_t width, uint32_t height,
 275                                         uint32_t format, const uint64_t *modifiers, uint32_t count)
 276 {
 277         int ret;
 278         size_t plane;
 279         struct bo *bo;
 280
 281         if (!drv->backend->bo_create_with_modifiers) {
 282                 errno = ENOENT;
 283                 return NULL;
 284         }
 285
 286         bo = drv_bo_new(drv, width, height, format, BO_USE_NONE);
 287
 288         if (!bo)
 289                 return NULL;
 290
 291         ret = drv->backend->bo_create_with_modifiers(bo, width, height, format, modifiers, count);
 292
 293         if (ret) {
 294                 free(bo);
 295                 return NULL;
 296         }
 297
 298         pthread_mutex_lock(&drv->driver_lock);
 299
 300         for (plane = 0; plane < bo->num_planes; plane++) {
 301                 if (plane > 0)
 302                         assert(bo->offsets[plane] >= bo->offsets[plane - 1]);
 303
 304                 drv_increment_reference_count(drv, bo, plane);
 305         }
 306
 307         pthread_mutex_unlock(&drv->driver_lock);
 308
 309         return bo;
 310 }
 311
 312 void drv_bo_destroy(struct bo *bo)
 313 {
 314         size_t plane;
 315         uintptr_t total = 0;
 316         struct driver *drv = bo->drv;
 317
 318         pthread_mutex_lock(&drv->driver_lock);
 319
 320         for (plane = 0; plane < bo->num_planes; plane++)
 321                 drv_decrement_reference_count(drv, bo, plane);
 322
 323         for (plane = 0; plane < bo->num_planes; plane++)
 324                 total += drv_get_reference_count(drv, bo, plane);
 325
 326         pthread_mutex_unlock(&drv->driver_lock);
 327
 328         if (total == 0) {
 329                 assert(drv_map_info_destroy(bo) == 0);
 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         off_t seek_end;
 342
 343         bo = drv_bo_new(drv, data->width, data->height, data->format, data->use_flags);
 344
 345         if (!bo)
 346                 return NULL;
 347
 348         ret = drv->backend->bo_import(bo, data);
 349         if (ret) {
 350                 free(bo);
 351                 return NULL;
 352         }
 353
 354         for (plane = 0; plane < bo->num_planes; plane++) {
 355                 bo->strides[plane] = data->strides[plane];
 356                 bo->offsets[plane] = data->offsets[plane];
 357                 bo->format_modifiers[plane] = data->format_modifiers[plane];
 358
 359                 seek_end = lseek(data->fds[plane], 0, SEEK_END);
 360                 if (seek_end == (off_t)(-1)) {
 361                         fprintf(stderr, "drv: lseek() failed with %s\n", strerror(errno));
 362                         goto destroy_bo;
 363                 }
 364
 365                 lseek(data->fds[plane], 0, SEEK_SET);
 366                 if (plane == bo->num_planes - 1 || data->offsets[plane + 1] == 0)
 367                         bo->sizes[plane] = seek_end - data->offsets[plane];
 368                 else
 369                         bo->sizes[plane] = data->offsets[plane + 1] - data->offsets[plane];
 370
 371                 if ((int64_t)bo->offsets[plane] + bo->sizes[plane] > seek_end) {
 372                         fprintf(stderr, "drv: buffer size is too large.\n");
 373                         goto destroy_bo;
 374                 }
 375
 376                 bo->total_size += bo->sizes[plane];
 377         }
 378
 379         return bo;
 380
 381 destroy_bo:
 382         drv_bo_destroy(bo);
 383         return NULL;
 384 }
 385
 386 void *drv_bo_map(struct bo *bo, uint32_t x, uint32_t y, uint32_t width, uint32_t height,
 387                  uint32_t map_flags, struct map_info **map_data, size_t plane)
 388 {
 389         void *ptr;
 390         uint8_t *addr;
 391         size_t offset;
 392         struct map_info *data;
 393
 394         assert(width > 0);
 395         assert(height > 0);
 396         assert(x + width <= drv_bo_get_width(bo));
 397         assert(y + height <= drv_bo_get_height(bo));
 398         assert(BO_MAP_READ_WRITE & map_flags);
 399         /* No CPU access for protected buffers. */
 400         assert(!(bo->use_flags & BO_USE_PROTECTED));
 401
 402         pthread_mutex_lock(&bo->drv->driver_lock);
 403
 404         if (!drmHashLookup(bo->drv->map_table, bo->handles[plane].u32, &ptr)) {
 405                 data = (struct map_info *)ptr;
 406                 /* TODO(gsingh): support mapping same buffer with different flags. */
 407                 assert(data->map_flags == map_flags);
 408                 data->refcount++;
 409                 goto success;
 410         }
 411
 412         data = calloc(1, sizeof(*data));
 413         addr = bo->drv->backend->bo_map(bo, data, plane, map_flags);
 414         if (addr == MAP_FAILED) {
 415                 *map_data = NULL;
 416                 free(data);
 417                 pthread_mutex_unlock(&bo->drv->driver_lock);
 418                 return MAP_FAILED;
 419         }
 420
 421         data->refcount = 1;
 422         data->addr = addr;
 423         data->handle = bo->handles[plane].u32;
 424         data->map_flags = map_flags;
 425         drmHashInsert(bo->drv->map_table, bo->handles[plane].u32, (void *)data);
 426
 427 success:
 428         drv_bo_invalidate(bo, data);
 429         *map_data = data;
 430         offset = drv_bo_get_plane_stride(bo, plane) * y;
 431         offset += drv_stride_from_format(bo->format, x, plane);
 432         addr = (uint8_t *)data->addr;
 433         addr += drv_bo_get_plane_offset(bo, plane) + offset;
 434         pthread_mutex_unlock(&bo->drv->driver_lock);
 435
 436         return (void *)addr;
 437 }
 438
 439 int drv_bo_unmap(struct bo *bo, struct map_info *data)
 440 {
 441         int ret = drv_bo_flush(bo, data);
 442         if (ret)
 443                 return ret;
 444
 445         pthread_mutex_lock(&bo->drv->driver_lock);
 446
 447         if (!--data->refcount) {
 448                 ret = bo->drv->backend->bo_unmap(bo, data);
 449                 drmHashDelete(bo->drv->map_table, data->handle);
 450                 free(data);
 451         }
 452
 453         pthread_mutex_unlock(&bo->drv->driver_lock);
 454
 455         return ret;
 456 }
 457
 458 int drv_bo_invalidate(struct bo *bo, struct map_info *data)
 459 {
 460         int ret = 0;
 461         assert(data);
 462         assert(data->refcount >= 0);
 463
 464         if (bo->drv->backend->bo_invalidate)
 465                 ret = bo->drv->backend->bo_invalidate(bo, data);
 466
 467         return ret;
 468 }
 469
 470 int drv_bo_flush(struct bo *bo, struct map_info *data)
 471 {
 472         int ret = 0;
 473         assert(data);
 474         assert(data->refcount >= 0);
 475         assert(!(bo->use_flags & BO_USE_PROTECTED));
 476
 477         if (bo->drv->backend->bo_flush)
 478                 ret = bo->drv->backend->bo_flush(bo, data);
 479
 480         return ret;
 481 }
 482
 483 uint32_t drv_bo_get_width(struct bo *bo)
 484 {
 485         return bo->width;
 486 }
 487
 488 uint32_t drv_bo_get_height(struct bo *bo)
 489 {
 490         return bo->height;
 491 }
 492
 493 uint32_t drv_bo_get_stride_or_tiling(struct bo *bo)
 494 {
 495         return bo->tiling ? bo->tiling : drv_bo_get_plane_stride(bo, 0);
 496 }
 497
 498 size_t drv_bo_get_num_planes(struct bo *bo)
 499 {
 500         return bo->num_planes;
 501 }
 502
 503 union bo_handle drv_bo_get_plane_handle(struct bo *bo, size_t plane)
 504 {
 505         return bo->handles[plane];
 506 }
 507
 508 #ifndef DRM_RDWR
 509 #define DRM_RDWR O_RDWR
 510 #endif
 511
 512 int drv_bo_get_plane_fd(struct bo *bo, size_t plane)
 513 {
 514
 515         int ret, fd;
 516         assert(plane < bo->num_planes);
 517
 518         ret = drmPrimeHandleToFD(bo->drv->fd, bo->handles[plane].u32, DRM_CLOEXEC | DRM_RDWR, &fd);
 519
 520         return (ret) ? ret : fd;
 521 }
 522
 523 uint32_t drv_bo_get_plane_offset(struct bo *bo, size_t plane)
 524 {
 525         assert(plane < bo->num_planes);
 526         return bo->offsets[plane];
 527 }
 528
 529 uint32_t drv_bo_get_plane_size(struct bo *bo, size_t plane)
 530 {
 531         assert(plane < bo->num_planes);
 532         return bo->sizes[plane];
 533 }
 534
 535 uint32_t drv_bo_get_plane_stride(struct bo *bo, size_t plane)
 536 {
 537         assert(plane < bo->num_planes);
 538         return bo->strides[plane];
 539 }
 540
 541 uint64_t drv_bo_get_plane_format_modifier(struct bo *bo, size_t plane)
 542 {
 543         assert(plane < bo->num_planes);
 544         return bo->format_modifiers[plane];
 545 }
 546
 547 uint32_t drv_bo_get_format(struct bo *bo)
 548 {
 549         return bo->format;
 550 }
 551
 552 uint32_t drv_resolve_format(struct driver *drv, uint32_t format, uint64_t use_flags)
 553 {
 554         if (drv->backend->resolve_format)
 555                 return drv->backend->resolve_format(format, use_flags);
 556
 557         return format;
 558 }
 559
 560 size_t drv_num_planes_from_format(uint32_t format)
 561 {
 562         switch (format) {
 563         case DRM_FORMAT_ABGR1555:
 564         case DRM_FORMAT_ABGR2101010:
 565         case DRM_FORMAT_ABGR4444:
 566         case DRM_FORMAT_ABGR8888:
 567         case DRM_FORMAT_ARGB1555:
 568         case DRM_FORMAT_ARGB2101010:
 569         case DRM_FORMAT_ARGB4444:
 570         case DRM_FORMAT_ARGB8888:
 571         case DRM_FORMAT_AYUV:
 572         case DRM_FORMAT_BGR233:
 573         case DRM_FORMAT_BGR565:
 574         case DRM_FORMAT_BGR888:
 575         case DRM_FORMAT_BGRA1010102:
 576         case DRM_FORMAT_BGRA4444:
 577         case DRM_FORMAT_BGRA5551:
 578         case DRM_FORMAT_BGRA8888:
 579         case DRM_FORMAT_BGRX1010102:
 580         case DRM_FORMAT_BGRX4444:
 581         case DRM_FORMAT_BGRX5551:
 582         case DRM_FORMAT_BGRX8888:
 583         case DRM_FORMAT_C8:
 584         case DRM_FORMAT_GR88:
 585         case DRM_FORMAT_R8:
 586         case DRM_FORMAT_RG88:
 587         case DRM_FORMAT_RGB332:
 588         case DRM_FORMAT_RGB565:
 589         case DRM_FORMAT_RGB888:
 590         case DRM_FORMAT_RGBA1010102:
 591         case DRM_FORMAT_RGBA4444:
 592         case DRM_FORMAT_RGBA5551:
 593         case DRM_FORMAT_RGBA8888:
 594         case DRM_FORMAT_RGBX1010102:
 595         case DRM_FORMAT_RGBX4444:
 596         case DRM_FORMAT_RGBX5551:
 597         case DRM_FORMAT_RGBX8888:
 598         case DRM_FORMAT_UYVY:
 599         case DRM_FORMAT_VYUY:
 600         case DRM_FORMAT_XBGR1555:
 601         case DRM_FORMAT_XBGR2101010:
 602         case DRM_FORMAT_XBGR4444:
 603         case DRM_FORMAT_XBGR8888:
 604         case DRM_FORMAT_XRGB1555:
 605         case DRM_FORMAT_XRGB2101010:
 606         case DRM_FORMAT_XRGB4444:
 607         case DRM_FORMAT_XRGB8888:
 608         case DRM_FORMAT_YUYV:
 609         case DRM_FORMAT_YVYU:
 610                 return 1;
 611         case DRM_FORMAT_NV12:
 612         case DRM_FORMAT_NV21:
 613                 return 2;
 614         case DRM_FORMAT_YVU420:
 615         case DRM_FORMAT_YVU420_ANDROID:
 616                 return 3;
 617         }
 618
 619         fprintf(stderr, "drv: UNKNOWN FORMAT %d\n", format);
 620         return 0;
 621 }
 622
 623 uint32_t drv_num_buffers_per_bo(struct bo *bo)
 624 {
 625         uint32_t count = 0;
 626         size_t plane, p;
 627
 628         for (plane = 0; plane < bo->num_planes; plane++) {
 629                 for (p = 0; p < plane; p++)
 630                         if (bo->handles[p].u32 == bo->handles[plane].u32)
 631                                 break;
 632                 if (p == plane)
 633                         count++;
 634         }
 635
 636         return count;
 637 }