src/loader/loader.c

   1 /*
   2  * Copyright (C) 2013 Rob Clark <robclark@freedesktop.org>
   3  * Copyright (C) 2014-2016 Emil Velikov <emil.l.velikov@gmail.com>
   4  * Copyright (C) 2016 Intel Corporation
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the "Software"),
   8  * to deal in the Software without restriction, including without limitation
   9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  10  * and/or sell copies of the Software, and to permit persons to whom the
  11  * Software is furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice (including the next
  14  * paragraph) shall be included in all copies or substantial portions of the
  15  * Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  20  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23  * SOFTWARE.
  24  *
  25  * Authors:
  26  *    Rob Clark <robclark@freedesktop.org>
  27  */
  28
  29 #include <dlfcn.h>
  30 #include <errno.h>
  31 #include <fcntl.h>
  32 #include <sys/stat.h>
  33 #include <stdarg.h>
  34 #include <stdio.h>
  35 #include <stdbool.h>
  36 #include <string.h>
  37 #include <unistd.h>
  38 #include <stdlib.h>
  39 #include <limits.h>
  40 #include <sys/param.h>
  41 #ifdef MAJOR_IN_MKDEV
  42 #include <sys/mkdev.h>
  43 #endif
  44 #ifdef MAJOR_IN_SYSMACROS
  45 #include <sys/sysmacros.h>
  46 #endif
  47 #include <GL/gl.h>
  48 #include <GL/internal/dri_interface.h>
  49 #include "loader.h"
  50
  51 #ifdef HAVE_LIBDRM
  52 #include <xf86drm.h>
  53 #ifdef USE_DRICONF
  54 #include "util/xmlconfig.h"
  55 #include "util/xmlpool.h"
  56 #endif
  57 #endif
  58
  59 #define __IS_LOADER
  60 #include "pci_id_driver_map.h"
  61
  62 static void default_logger(int level, const char *fmt, ...)
  63 {
  64    if (level <= _LOADER_WARNING) {
  65       va_list args;
  66       va_start(args, fmt);
  67       vfprintf(stderr, fmt, args);
  68       va_end(args);
  69    }
  70 }
  71
  72 static loader_logger *log_ = default_logger;
  73
  74 int
  75 loader_open_device(const char *device_name)
  76 {
  77    int fd;
  78 #ifdef O_CLOEXEC
  79    fd = open(device_name, O_RDWR | O_CLOEXEC);
  80    if (fd == -1 && errno == EINVAL)
  81 #endif
  82    {
  83       fd = open(device_name, O_RDWR);
  84       if (fd != -1)
  85          fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
  86    }
  87    return fd;
  88 }
  89
  90 static char *loader_get_kernel_driver_name(int fd)
  91 {
  92 #if HAVE_LIBDRM
  93    char *driver;
  94    drmVersionPtr version = drmGetVersion(fd);
  95
  96    if (!version) {
  97       log_(_LOADER_WARNING, "failed to get driver name for fd %d\n", fd);
  98       return NULL;
  99    }
 100
 101    driver = strndup(version->name, version->name_len);
 102
 103    drmFreeVersion(version);
 104    return driver;
 105 #else
 106    return NULL;
 107 #endif
 108 }
 109
 110 #if defined(HAVE_LIBDRM)
 111 int
 112 loader_open_render_node(const char *name)
 113 {
 114    drmDevicePtr *devices, device;
 115    int err, render = -ENOENT, fd;
 116    unsigned int num, i;
 117
 118    err = drmGetDevices2(0, NULL, 0);
 119    if (err < 0)
 120       return err;
 121
 122    num = err;
 123
 124    devices = calloc(num, sizeof(*devices));
 125    if (!devices)
 126       return -ENOMEM;
 127
 128    err = drmGetDevices2(0, devices, num);
 129    if (err < 0) {
 130       render = err;
 131       goto free;
 132    }
 133
 134    for (i = 0; i < num; i++) {
 135       device = devices[i];
 136
 137       if ((device->available_nodes & (1 << DRM_NODE_RENDER)) &&
 138           (device->bustype == DRM_BUS_PLATFORM)) {
 139          drmVersionPtr version;
 140
 141          fd = loader_open_device(device->nodes[DRM_NODE_RENDER]);
 142          if (fd < 0)
 143             continue;
 144
 145          version = drmGetVersion(fd);
 146          if (!version) {
 147             close(fd);
 148             continue;
 149          }
 150
 151          if (strcmp(version->name, name) != 0) {
 152             drmFreeVersion(version);
 153             close(fd);
 154             continue;
 155          }
 156
 157          drmFreeVersion(version);
 158          render = fd;
 159          break;
 160       }
 161    }
 162
 163    drmFreeDevices(devices, num);
 164
 165 free:
 166    free(devices);
 167    return render;
 168 }
 169
 170 #ifdef USE_DRICONF
 171 static const char __driConfigOptionsLoader[] =
 172 DRI_CONF_BEGIN
 173     DRI_CONF_SECTION_INITIALIZATION
 174         DRI_CONF_DEVICE_ID_PATH_TAG()
 175         DRI_CONF_DRI_DRIVER()
 176     DRI_CONF_SECTION_END
 177 DRI_CONF_END;
 178
 179 static char *loader_get_dri_config_driver(int fd)
 180 {
 181    driOptionCache defaultInitOptions;
 182    driOptionCache userInitOptions;
 183    char *dri_driver = NULL;
 184    char *kernel_driver = loader_get_kernel_driver_name(fd);
 185
 186    driParseOptionInfo(&defaultInitOptions, __driConfigOptionsLoader);
 187    driParseConfigFiles(&userInitOptions, &defaultInitOptions, 0,
 188                        "loader", kernel_driver);
 189    if (driCheckOption(&userInitOptions, "dri_driver", DRI_STRING)) {
 190       char *opt = driQueryOptionstr(&userInitOptions, "dri_driver");
 191       /* not an empty string */
 192       if (*opt)
 193          dri_driver = strdup(opt);
 194    }
 195    driDestroyOptionCache(&userInitOptions);
 196    driDestroyOptionInfo(&defaultInitOptions);
 197
 198    free(kernel_driver);
 199    return dri_driver;
 200 }
 201
 202 static char *loader_get_dri_config_device_id(void)
 203 {
 204    driOptionCache defaultInitOptions;
 205    driOptionCache userInitOptions;
 206    char *prime = NULL;
 207
 208    driParseOptionInfo(&defaultInitOptions, __driConfigOptionsLoader);
 209    driParseConfigFiles(&userInitOptions, &defaultInitOptions, 0, "loader", NULL);
 210    if (driCheckOption(&userInitOptions, "device_id", DRI_STRING))
 211       prime = strdup(driQueryOptionstr(&userInitOptions, "device_id"));
 212    driDestroyOptionCache(&userInitOptions);
 213    driDestroyOptionInfo(&defaultInitOptions);
 214
 215    return prime;
 216 }
 217 #endif
 218
 219 static char *drm_construct_id_path_tag(drmDevicePtr device)
 220 {
 221    char *tag = NULL;
 222
 223    if (device->bustype == DRM_BUS_PCI) {
 224       if (asprintf(&tag, "pci-%04x_%02x_%02x_%1u",
 225                    device->businfo.pci->domain,
 226                    device->businfo.pci->bus,
 227                    device->businfo.pci->dev,
 228                    device->businfo.pci->func) < 0) {
 229          return NULL;
 230       }
 231    } else if (device->bustype == DRM_BUS_PLATFORM ||
 232               device->bustype == DRM_BUS_HOST1X) {
 233       char *fullname, *name, *address;
 234
 235       if (device->bustype == DRM_BUS_PLATFORM)
 236          fullname = device->businfo.platform->fullname;
 237       else
 238          fullname = device->businfo.host1x->fullname;
 239
 240       name = strrchr(fullname, '/');
 241       if (!name)
 242          name = strdup(fullname);
 243       else
 244          name = strdup(name + 1);
 245
 246       address = strchr(name, '@');
 247       if (address) {
 248          *address++ = '\0';
 249
 250          if (asprintf(&tag, "platform-%s_%s", address, name) < 0)
 251             tag = NULL;
 252       } else {
 253          if (asprintf(&tag, "platform-%s", name) < 0)
 254             tag = NULL;
 255       }
 256
 257       free(name);
 258    }
 259    return tag;
 260 }
 261
 262 static bool drm_device_matches_tag(drmDevicePtr device, const char *prime_tag)
 263 {
 264    char *tag = drm_construct_id_path_tag(device);
 265    int ret;
 266
 267    if (tag == NULL)
 268       return false;
 269
 270    ret = strcmp(tag, prime_tag);
 271
 272    free(tag);
 273    return ret == 0;
 274 }
 275
 276 static char *drm_get_id_path_tag_for_fd(int fd)
 277 {
 278    drmDevicePtr device;
 279    char *tag;
 280
 281    if (drmGetDevice2(fd, 0, &device) != 0)
 282        return NULL;
 283
 284    tag = drm_construct_id_path_tag(device);
 285    drmFreeDevice(&device);
 286    return tag;
 287 }
 288
 289 int loader_get_user_preferred_fd(int default_fd, bool *different_device)
 290 {
 291 /* Arbitrary "maximum" value of drm devices. */
 292 #define MAX_DRM_DEVICES 32
 293    const char *dri_prime = getenv("DRI_PRIME");
 294    char *default_tag, *prime = NULL;
 295    drmDevicePtr devices[MAX_DRM_DEVICES];
 296    int i, num_devices, fd;
 297    bool found = false;
 298
 299    if (dri_prime)
 300       prime = strdup(dri_prime);
 301 #ifdef USE_DRICONF
 302    else
 303       prime = loader_get_dri_config_device_id();
 304 #endif
 305
 306    if (prime == NULL) {
 307       *different_device = false;
 308       return default_fd;
 309    }
 310
 311    default_tag = drm_get_id_path_tag_for_fd(default_fd);
 312    if (default_tag == NULL)
 313       goto err;
 314
 315    num_devices = drmGetDevices2(0, devices, MAX_DRM_DEVICES);
 316    if (num_devices < 0)
 317       goto err;
 318
 319    /* two format are supported:
 320     * "1": choose any other card than the card used by default.
 321     * id_path_tag: (for example "pci-0000_02_00_0") choose the card
 322     * with this id_path_tag.
 323     */
 324    if (!strcmp(prime,"1")) {
 325       /* Hmm... detection for 2-7 seems to be broken. Oh well ...
 326        * Pick the first render device that is not our own.
 327        */
 328       for (i = 0; i < num_devices; i++) {
 329          if (devices[i]->available_nodes & 1 << DRM_NODE_RENDER &&
 330              !drm_device_matches_tag(devices[i], default_tag)) {
 331
 332             found = true;
 333             break;
 334          }
 335       }
 336    } else {
 337       for (i = 0; i < num_devices; i++) {
 338          if (devices[i]->available_nodes & 1 << DRM_NODE_RENDER &&
 339             drm_device_matches_tag(devices[i], prime)) {
 340
 341             found = true;
 342             break;
 343          }
 344       }
 345    }
 346
 347    if (!found) {
 348       drmFreeDevices(devices, num_devices);
 349       goto err;
 350    }
 351
 352    fd = loader_open_device(devices[i]->nodes[DRM_NODE_RENDER]);
 353    drmFreeDevices(devices, num_devices);
 354    if (fd < 0)
 355       goto err;
 356
 357    close(default_fd);
 358
 359    *different_device = !!strcmp(default_tag, prime);
 360
 361    free(default_tag);
 362    free(prime);
 363    return fd;
 364
 365  err:
 366    *different_device = false;
 367
 368    free(default_tag);
 369    free(prime);
 370    return default_fd;
 371 }
 372 #else
 373 int
 374 loader_open_render_node(const char *name)
 375 {
 376    return -1;
 377 }
 378
 379 int loader_get_user_preferred_fd(int default_fd, bool *different_device)
 380 {
 381    *different_device = false;
 382    return default_fd;
 383 }
 384 #endif
 385
 386 #if defined(HAVE_LIBDRM)
 387
 388 static int
 389 drm_get_pci_id_for_fd(int fd, int *vendor_id, int *chip_id)
 390 {
 391    drmDevicePtr device;
 392    int ret;
 393
 394    if (drmGetDevice2(fd, 0, &device) == 0) {
 395       if (device->bustype == DRM_BUS_PCI) {
 396          *vendor_id = device->deviceinfo.pci->vendor_id;
 397          *chip_id = device->deviceinfo.pci->device_id;
 398          ret = 1;
 399       }
 400       else {
 401          log_(_LOADER_DEBUG, "MESA-LOADER: device is not located on the PCI bus\n");
 402          ret = 0;
 403       }
 404       drmFreeDevice(&device);
 405    }
 406    else {
 407       log_(_LOADER_WARNING, "MESA-LOADER: failed to retrieve device information\n");
 408       ret = 0;
 409    }
 410
 411    return ret;
 412 }
 413 #endif
 414
 415
 416 int
 417 loader_get_pci_id_for_fd(int fd, int *vendor_id, int *chip_id)
 418 {
 419 #if HAVE_LIBDRM
 420    if (drm_get_pci_id_for_fd(fd, vendor_id, chip_id))
 421       return 1;
 422 #endif
 423    return 0;
 424 }
 425
 426 char *
 427 loader_get_device_name_for_fd(int fd)
 428 {
 429    char *result = NULL;
 430
 431 #if HAVE_LIBDRM
 432    result = drmGetDeviceNameFromFd2(fd);
 433 #endif
 434
 435    return result;
 436 }
 437
 438 char *
 439 loader_get_driver_for_fd(int fd)
 440 {
 441    int vendor_id, chip_id, i, j;
 442    char *driver = NULL;
 443
 444    /* Allow an environment variable to force choosing a different driver
 445     * binary.  If that driver binary can't survive on this FD, that's the
 446     * user's problem, but this allows vc4 simulator to run on an i965 host,
 447     * and may be useful for some touch testing of i915 on an i965 host.
 448     */
 449    if (geteuid() == getuid()) {
 450       driver = getenv("MESA_LOADER_DRIVER_OVERRIDE");
 451       if (driver)
 452          return strdup(driver);
 453    }
 454
 455 #if defined(HAVE_LIBDRM) && defined(USE_DRICONF)
 456    driver = loader_get_dri_config_driver(fd);
 457    if (driver)
 458       return driver;
 459 #endif
 460
 461    if (!loader_get_pci_id_for_fd(fd, &vendor_id, &chip_id)) {
 462       driver = loader_get_kernel_driver_name(fd);
 463       if (driver)
 464          log_(_LOADER_INFO, "using driver %s for %d\n", driver, fd);
 465       return driver;
 466    }
 467
 468    for (i = 0; driver_map[i].driver; i++) {
 469       if (vendor_id != driver_map[i].vendor_id)
 470          continue;
 471
 472       if (driver_map[i].predicate && !driver_map[i].predicate(fd))
 473          continue;
 474
 475       if (driver_map[i].num_chips_ids == -1) {
 476          driver = strdup(driver_map[i].driver);
 477          goto out;
 478       }
 479
 480       for (j = 0; j < driver_map[i].num_chips_ids; j++)
 481          if (driver_map[i].chip_ids[j] == chip_id) {
 482             driver = strdup(driver_map[i].driver);
 483             goto out;
 484          }
 485    }
 486
 487 out:
 488    log_(driver ? _LOADER_DEBUG : _LOADER_WARNING,
 489          "pci id for fd %d: %04x:%04x, driver %s\n",
 490          fd, vendor_id, chip_id, driver);
 491    return driver;
 492 }
 493
 494 void
 495 loader_set_logger(loader_logger *logger)
 496 {
 497    log_ = logger;
 498 }
 499
 500 char *
 501 loader_get_extensions_name(const char *driver_name)
 502 {
 503    char *name = NULL;
 504
 505    if (asprintf(&name, "%s_%s", __DRI_DRIVER_GET_EXTENSIONS, driver_name) < 0)
 506       return NULL;
 507
 508    const size_t len = strlen(name);
 509    for (size_t i = 0; i < len; i++) {
 510       if (name[i] == '-')
 511          name[i] = '_';
 512    }
 513
 514    return name;
 515 }
 516
 517 /**
 518  * Opens a DRI driver using its driver name, returning the __DRIextension
 519  * entrypoints.
 520  *
 521  * \param driverName - a name like "i965", "radeon", "nouveau", etc.
 522  * \param out_driver - Address where the dlopen() return value will be stored.
 523  * \param search_path_vars - NULL-terminated list of env vars that can be used
 524  * to override the DEFAULT_DRIVER_DIR search path.
 525  */
 526 const struct __DRIextensionRec **
 527 loader_open_driver(const char *driver_name,
 528                    void **out_driver_handle,
 529                    const char **search_path_vars)
 530 {
 531    char path[PATH_MAX], *search_paths, *next, *end;
 532    char *get_extensions_name;
 533    const struct __DRIextensionRec **extensions = NULL;
 534    const struct __DRIextensionRec **(*get_extensions)(void);
 535
 536    search_paths = NULL;
 537    if (geteuid() == getuid() && search_path_vars) {
 538       for (int i = 0; search_path_vars[i] != NULL; i++) {
 539          search_paths = getenv(search_path_vars[i]);
 540          if (search_paths)
 541             break;
 542       }
 543    }
 544    if (search_paths == NULL)
 545       search_paths = DEFAULT_DRIVER_DIR;
 546
 547    void *driver = NULL;
 548    end = search_paths + strlen(search_paths);
 549    for (char *p = search_paths; p < end; p = next + 1) {
 550       int len;
 551       next = strchr(p, ':');
 552       if (next == NULL)
 553          next = end;
 554
 555       len = next - p;
 556 #if USE_ELF_TLS
 557       snprintf(path, sizeof(path), "%.*s/tls/%s_dri.so", len, p, driver_name);
 558       driver = dlopen(path, RTLD_NOW | RTLD_GLOBAL);
 559 #endif
 560       if (driver == NULL) {
 561          snprintf(path, sizeof(path), "%.*s/%s_dri.so", len, p, driver_name);
 562          driver = dlopen(path, RTLD_NOW | RTLD_GLOBAL);
 563          if (driver == NULL)
 564             log_(_LOADER_DEBUG, "MESA-LOADER: failed to open %s: %s\n",
 565                  path, dlerror());
 566       }
 567       /* not need continue to loop all paths once the driver is found */
 568       if (driver != NULL)
 569          break;
 570    }
 571
 572    if (driver == NULL) {
 573       log_(_LOADER_WARNING, "MESA-LOADER: failed to open %s (search paths %s)\n",
 574            driver_name, search_paths);
 575       *out_driver_handle = NULL;
 576       return NULL;
 577    }
 578
 579    log_(_LOADER_DEBUG, "MESA-LOADER: dlopen(%s)\n", path);
 580
 581    get_extensions_name = loader_get_extensions_name(driver_name);
 582    if (get_extensions_name) {
 583       get_extensions = dlsym(driver, get_extensions_name);
 584       if (get_extensions) {
 585          extensions = get_extensions();
 586       } else {
 587          log_(_LOADER_DEBUG, "MESA-LOADER: driver does not expose %s(): %s\n",
 588               get_extensions_name, dlerror());
 589       }
 590       free(get_extensions_name);
 591    }
 592
 593    if (!extensions)
 594       extensions = dlsym(driver, __DRI_DRIVER_EXTENSIONS);
 595    if (extensions == NULL) {
 596       log_(_LOADER_WARNING,
 597            "MESA-LOADER: driver exports no extensions (%s)\n", dlerror());
 598       dlclose(driver);
 599    }
 600
 601    *out_driver_handle = driver;
 602    return extensions;
 603 }