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 <errno.h>
  30 #include <fcntl.h>
  31 #include <sys/stat.h>
  32 #include <stdarg.h>
  33 #include <stdio.h>
  34 #include <stdbool.h>
  35 #include <string.h>
  36 #include <unistd.h>
  37 #include <stdlib.h>
  38 #ifdef MAJOR_IN_MKDEV
  39 #include <sys/mkdev.h>
  40 #endif
  41 #ifdef MAJOR_IN_SYSMACROS
  42 #include <sys/sysmacros.h>
  43 #endif
  44 #include "loader.h"
  45
  46 #ifdef HAVE_LIBDRM
  47 #include <xf86drm.h>
  48 #ifdef USE_DRICONF
  49 #include "util/xmlconfig.h"
  50 #include "util/xmlpool.h"
  51 #endif
  52 #endif
  53
  54 #define __IS_LOADER
  55 #include "pci_id_driver_map.h"
  56
  57 static void default_logger(int level, const char *fmt, ...)
  58 {
  59    if (level <= _LOADER_WARNING) {
  60       va_list args;
  61       va_start(args, fmt);
  62       vfprintf(stderr, fmt, args);
  63       va_end(args);
  64    }
  65 }
  66
  67 static void (*log_)(int level, const char *fmt, ...) = default_logger;
  68
  69 int
  70 loader_open_device(const char *device_name)
  71 {
  72    int fd;
  73 #ifdef O_CLOEXEC
  74    fd = open(device_name, O_RDWR | O_CLOEXEC);
  75    if (fd == -1 && errno == EINVAL)
  76 #endif
  77    {
  78       fd = open(device_name, O_RDWR);
  79       if (fd != -1)
  80          fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
  81    }
  82    return fd;
  83 }
  84
  85 #if defined(HAVE_LIBDRM)
  86 #ifdef USE_DRICONF
  87 static const char __driConfigOptionsLoader[] =
  88 DRI_CONF_BEGIN
  89     DRI_CONF_SECTION_INITIALIZATION
  90         DRI_CONF_DEVICE_ID_PATH_TAG()
  91     DRI_CONF_SECTION_END
  92 DRI_CONF_END;
  93
  94 static char *loader_get_dri_config_device_id(void)
  95 {
  96    driOptionCache defaultInitOptions;
  97    driOptionCache userInitOptions;
  98    char *prime = NULL;
  99
 100    driParseOptionInfo(&defaultInitOptions, __driConfigOptionsLoader);
 101    driParseConfigFiles(&userInitOptions, &defaultInitOptions, 0, "loader");
 102    if (driCheckOption(&userInitOptions, "device_id", DRI_STRING))
 103       prime = strdup(driQueryOptionstr(&userInitOptions, "device_id"));
 104    driDestroyOptionCache(&userInitOptions);
 105    driDestroyOptionInfo(&defaultInitOptions);
 106
 107    return prime;
 108 }
 109 #endif
 110
 111 static char *drm_construct_id_path_tag(drmDevicePtr device)
 112 {
 113 /* Length of "pci-xxxx_xx_xx_x\0" */
 114 #define PCI_ID_PATH_TAG_LENGTH 17
 115    char *tag = NULL;
 116
 117    if (device->bustype == DRM_BUS_PCI) {
 118         tag = calloc(PCI_ID_PATH_TAG_LENGTH, sizeof(char));
 119         if (tag == NULL)
 120             return NULL;
 121
 122         snprintf(tag, PCI_ID_PATH_TAG_LENGTH, "pci-%04x_%02x_%02x_%1u",
 123                  device->businfo.pci->domain, device->businfo.pci->bus,
 124                  device->businfo.pci->dev, device->businfo.pci->func);
 125    }
 126    return tag;
 127 }
 128
 129 static bool drm_device_matches_tag(drmDevicePtr device, const char *prime_tag)
 130 {
 131    char *tag = drm_construct_id_path_tag(device);
 132    int ret;
 133
 134    if (tag == NULL)
 135       return false;
 136
 137    ret = strcmp(tag, prime_tag);
 138
 139    free(tag);
 140    return ret == 0;
 141 }
 142
 143 static char *drm_get_id_path_tag_for_fd(int fd)
 144 {
 145    drmDevicePtr device;
 146    char *tag;
 147
 148    if (drmGetDevice2(fd, 0, &device) != 0)
 149        return NULL;
 150
 151    tag = drm_construct_id_path_tag(device);
 152    drmFreeDevice(&device);
 153    return tag;
 154 }
 155
 156 int loader_get_user_preferred_fd(int default_fd, bool *different_device)
 157 {
 158 /* Arbitrary "maximum" value of drm devices. */
 159 #define MAX_DRM_DEVICES 32
 160    const char *dri_prime = getenv("DRI_PRIME");
 161    char *default_tag, *prime = NULL;
 162    drmDevicePtr devices[MAX_DRM_DEVICES];
 163    int i, num_devices, fd;
 164    bool found = false;
 165
 166    if (dri_prime)
 167       prime = strdup(dri_prime);
 168 #ifdef USE_DRICONF
 169    else
 170       prime = loader_get_dri_config_device_id();
 171 #endif
 172
 173    if (prime == NULL) {
 174       *different_device = false;
 175       return default_fd;
 176    }
 177
 178    default_tag = drm_get_id_path_tag_for_fd(default_fd);
 179    if (default_tag == NULL)
 180       goto err;
 181
 182    num_devices = drmGetDevices2(0, devices, MAX_DRM_DEVICES);
 183    if (num_devices < 0)
 184       goto err;
 185
 186    /* two format are supported:
 187     * "1": choose any other card than the card used by default.
 188     * id_path_tag: (for example "pci-0000_02_00_0") choose the card
 189     * with this id_path_tag.
 190     */
 191    if (!strcmp(prime,"1")) {
 192       /* Hmm... detection for 2-7 seems to be broken. Oh well ...
 193        * Pick the first render device that is not our own.
 194        */
 195       for (i = 0; i < num_devices; i++) {
 196          if (devices[i]->available_nodes & 1 << DRM_NODE_RENDER &&
 197              !drm_device_matches_tag(devices[i], default_tag)) {
 198
 199             found = true;
 200             break;
 201          }
 202       }
 203    } else {
 204       for (i = 0; i < num_devices; i++) {
 205          if (devices[i]->available_nodes & 1 << DRM_NODE_RENDER &&
 206             drm_device_matches_tag(devices[i], prime)) {
 207
 208             found = true;
 209             break;
 210          }
 211       }
 212    }
 213
 214    if (!found) {
 215       drmFreeDevices(devices, num_devices);
 216       goto err;
 217    }
 218
 219    fd = loader_open_device(devices[i]->nodes[DRM_NODE_RENDER]);
 220    drmFreeDevices(devices, num_devices);
 221    if (fd < 0)
 222       goto err;
 223
 224    close(default_fd);
 225
 226    *different_device = !!strcmp(default_tag, prime);
 227
 228    free(default_tag);
 229    free(prime);
 230    return fd;
 231
 232  err:
 233    *different_device = false;
 234
 235    free(default_tag);
 236    free(prime);
 237    return default_fd;
 238 }
 239 #else
 240 int loader_get_user_preferred_fd(int default_fd, bool *different_device)
 241 {
 242    *different_device = false;
 243    return default_fd;
 244 }
 245 #endif
 246
 247 #if defined(HAVE_LIBDRM)
 248
 249 static int
 250 drm_get_pci_id_for_fd(int fd, int *vendor_id, int *chip_id)
 251 {
 252    drmDevicePtr device;
 253    int ret;
 254
 255    if (drmGetDevice2(fd, 0, &device) == 0) {
 256       if (device->bustype == DRM_BUS_PCI) {
 257          *vendor_id = device->deviceinfo.pci->vendor_id;
 258          *chip_id = device->deviceinfo.pci->device_id;
 259          ret = 1;
 260       }
 261       else {
 262          log_(_LOADER_DEBUG, "MESA-LOADER: device is not located on the PCI bus\n");
 263          ret = 0;
 264       }
 265       drmFreeDevice(&device);
 266    }
 267    else {
 268       log_(_LOADER_WARNING, "MESA-LOADER: failed to retrieve device information\n");
 269       ret = 0;
 270    }
 271
 272    return ret;
 273 }
 274 #endif
 275
 276
 277 int
 278 loader_get_pci_id_for_fd(int fd, int *vendor_id, int *chip_id)
 279 {
 280 #if HAVE_LIBDRM
 281    if (drm_get_pci_id_for_fd(fd, vendor_id, chip_id))
 282       return 1;
 283 #endif
 284    return 0;
 285 }
 286
 287 char *
 288 loader_get_device_name_for_fd(int fd)
 289 {
 290    char *result = NULL;
 291
 292 #if HAVE_LIBDRM
 293    result = drmGetDeviceNameFromFd2(fd);
 294 #endif
 295
 296    return result;
 297 }
 298
 299 char *
 300 loader_get_driver_for_fd(int fd)
 301 {
 302    int vendor_id, chip_id, i, j;
 303    char *driver = NULL;
 304
 305    /* Allow an environment variable to force choosing a different driver
 306     * binary.  If that driver binary can't survive on this FD, that's the
 307     * user's problem, but this allows vc4 simulator to run on an i965 host,
 308     * and may be useful for some touch testing of i915 on an i965 host.
 309     */
 310    if (geteuid() == getuid()) {
 311       driver = getenv("MESA_LOADER_DRIVER_OVERRIDE");
 312       if (driver)
 313          return strdup(driver);
 314    }
 315
 316    if (!loader_get_pci_id_for_fd(fd, &vendor_id, &chip_id)) {
 317
 318 #if HAVE_LIBDRM
 319       /* fallback to drmGetVersion(): */
 320       drmVersionPtr version = drmGetVersion(fd);
 321
 322       if (!version) {
 323          log_(_LOADER_WARNING, "failed to get driver name for fd %d\n", fd);
 324          return NULL;
 325       }
 326
 327       driver = strndup(version->name, version->name_len);
 328       log_(_LOADER_INFO, "using driver %s for %d\n", driver, fd);
 329
 330       drmFreeVersion(version);
 331 #endif
 332
 333       return driver;
 334    }
 335
 336    for (i = 0; driver_map[i].driver; i++) {
 337       if (vendor_id != driver_map[i].vendor_id)
 338          continue;
 339
 340       if (driver_map[i].predicate && !driver_map[i].predicate(fd))
 341          continue;
 342
 343       if (driver_map[i].num_chips_ids == -1) {
 344          driver = strdup(driver_map[i].driver);
 345          goto out;
 346       }
 347
 348       for (j = 0; j < driver_map[i].num_chips_ids; j++)
 349          if (driver_map[i].chip_ids[j] == chip_id) {
 350             driver = strdup(driver_map[i].driver);
 351             goto out;
 352          }
 353    }
 354
 355 out:
 356    log_(driver ? _LOADER_DEBUG : _LOADER_WARNING,
 357          "pci id for fd %d: %04x:%04x, driver %s\n",
 358          fd, vendor_id, chip_id, driver);
 359    return driver;
 360 }
 361
 362 void
 363 loader_set_logger(void (*logger)(int level, const char *fmt, ...))
 364 {
 365    log_ = logger;
 366 }
 367
 368 /* XXX: Local definition to avoid pulling the heavyweight GL/gl.h and
 369  * GL/internal/dri_interface.h
 370  */
 371
 372 #ifndef __DRI_DRIVER_GET_EXTENSIONS
 373 #define __DRI_DRIVER_GET_EXTENSIONS "__driDriverGetExtensions"
 374 #endif
 375
 376 char *
 377 loader_get_extensions_name(const char *driver_name)
 378 {
 379    char *name = NULL;
 380
 381    if (asprintf(&name, "%s_%s", __DRI_DRIVER_GET_EXTENSIONS, driver_name) < 0)
 382       return NULL;
 383
 384    const size_t len = strlen(name);
 385    for (size_t i = 0; i < len; i++) {
 386            if (name[i] == '-')
 387                    name[i] = '_';
 388    }
 389
 390    return name;
 391 }