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