tests/lock.c

   1 /*
   2  * Copyright © 2007 Intel Corporation
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice (including the next
  12  * paragraph) shall be included in all copies or substantial portions of the
  13  * Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  21  * IN THE SOFTWARE.
  22  *
  23  * Authors:
  24  *    Eric Anholt <eric@anholt.net>
  25  *
  26  */
  27
  28 /** @file lock.c
  29  * Tests various potential failures of the DRM locking mechanisms
  30  */
  31
  32 #include <limits.h>
  33 #include "drmtest.h"
  34
  35 enum auth_event {
  36         SERVER_READY,
  37         CLIENT_MAGIC,
  38         SERVER_LOCKED,
  39         CLIENT_LOCKED,
  40 };
  41
  42 int commfd[2];
  43 unsigned int lock1 = 0x00001111;
  44 unsigned int lock2 = 0x00002222;
  45
  46 /* return time in milliseconds */
  47 static unsigned int
  48 get_millis()
  49 {
  50         struct timeval tv;
  51
  52         gettimeofday(&tv, NULL);
  53         return tv.tv_sec * 1000 + tv.tv_usec / 1000;
  54 }
  55
  56 static void
  57 wait_event(int pipe, enum auth_event expected_event)
  58 {
  59         int ret;
  60         enum auth_event event;
  61         unsigned char in;
  62
  63         ret = read(commfd[pipe], &in, 1);
  64         if (ret == -1)
  65                 err(1, "read error");
  66         event = in;
  67
  68         if (event != expected_event)
  69                 errx(1, "unexpected event: %d\n", event);
  70 }
  71
  72 static void
  73 send_event(int pipe, enum auth_event send_event)
  74 {
  75         int ret;
  76         unsigned char event;
  77
  78         event = send_event;
  79         ret = write(commfd[pipe], &event, 1);
  80         if (ret == -1)
  81                 err(1, "failed to send event %d", event);
  82 }
  83
  84 static void
  85 client_auth(int drmfd)
  86 {
  87         struct drm_auth auth;
  88         int ret;
  89
  90         wait_event(0, SERVER_READY);
  91
  92         /* Get a client magic number and pass it to the master for auth. */
  93         ret = ioctl(drmfd, DRM_IOCTL_GET_MAGIC, &auth);
  94         if (ret == -1)
  95                 err(1, "Couldn't get client magic");
  96         send_event(0, CLIENT_MAGIC);
  97         ret = write(commfd[0], &auth.magic, sizeof(auth.magic));
  98         if (ret == -1)
  99                 err(1, "Couldn't write auth data");
 100 }
 101
 102 static void
 103 server_auth(int drmfd)
 104 {
 105         struct drm_auth auth;
 106         int ret;
 107
 108         send_event(1, SERVER_READY);
 109         wait_event(1, CLIENT_MAGIC);
 110         ret = read(commfd[1], &auth.magic, sizeof(auth.magic));
 111         if (ret == -1)
 112                 err(1, "Failure to read client magic");
 113
 114         ret = ioctl(drmfd, DRM_IOCTL_AUTH_MAGIC, &auth);
 115         if (ret == -1)
 116                 err(1, "Failure to authenticate client magic\n");
 117 }
 118
 119 /** Tests that locking is successful in normal conditions */
 120 static void
 121 test_lock_unlock(int drmfd)
 122 {
 123         int ret;
 124
 125         ret = drmGetLock(drmfd, lock1, 0);
 126         if (ret != 0)
 127                 err(1, "Locking failed");
 128         ret = drmUnlock(drmfd, lock1);
 129         if (ret != 0)
 130                 err(1, "Unlocking failed");
 131 }
 132
 133 /** Tests that unlocking the lock while it's not held works correctly */
 134 static void
 135 test_unlock_unlocked(int drmfd)
 136 {
 137         int ret;
 138
 139         ret = drmUnlock(drmfd, lock1);
 140         if (ret == 0)
 141                 err(1, "Unlocking unlocked lock succeeded");
 142 }
 143
 144 /** Tests that unlocking a lock held by another context fails appropriately */
 145 static void
 146 test_unlock_unowned(int drmfd)
 147 {
 148         int ret;
 149
 150         ret = drmGetLock(drmfd, lock1, 0);
 151         assert(ret == 0);
 152         ret = drmUnlock(drmfd, lock2);
 153         if (ret == 0)
 154                 errx(1, "Unlocking other context's lock succeeded");
 155         ret = drmUnlock(drmfd, lock1);
 156         assert(ret == 0);
 157 }
 158
 159 /**
 160  * Tests that an open/close by the same process doesn't result in the lock
 161  * being dropped.
 162  */
 163 static void test_open_close_locked(drmfd)
 164 {
 165         int ret, tempfd;
 166
 167         ret = drmGetLock(drmfd, lock1, 0);
 168         assert(ret == 0);
 169         /* XXX: Need to make sure that this is the same device as drmfd */
 170         tempfd = drm_open_any();
 171         close(tempfd);
 172         ret = drmUnlock(drmfd, lock1);
 173         if (ret != 0)
 174                 errx(1, "lock lost during open/close by same pid");
 175
 176         close(drmfd);
 177 }
 178
 179 static void client()
 180 {
 181         int drmfd, ret;
 182         unsigned int time;
 183
 184         /* XXX: Should make sure we open the same DRM as the master */
 185         drmfd = drm_open_any();
 186
 187         client_auth(drmfd);
 188
 189         /* Wait for the server to grab the lock, then grab it ourselves (to
 190          * contest it).  Hopefully we hit it within the window of when the
 191          * server locks.
 192          */
 193         wait_event(0, SERVER_LOCKED);
 194         ret = drmGetLock(drmfd, lock2, 0);
 195         time = get_millis();
 196         if (ret != 0)
 197                 err(1, "Failed to get lock on client\n");
 198         drmUnlock(drmfd, lock2);
 199
 200         /* Tell the server that our locking completed, and when it did */
 201         send_event(0, CLIENT_LOCKED);
 202         ret = write(commfd[0], &time, sizeof(time));
 203
 204         exit(0);
 205 }
 206
 207 static void server()
 208 {
 209         int drmfd, tempfd, ret;
 210         unsigned int client_time, unlock_time;
 211
 212         drmfd = drm_open_any_master();
 213
 214         test_lock_unlock(drmfd);
 215         test_unlock_unlocked(drmfd);
 216         test_unlock_unowned(drmfd);
 217         test_open_close_locked(drmfd);
 218
 219         /* Perform the authentication sequence with the client. */
 220         server_auth(drmfd);
 221
 222         /* Now, test that the client attempting to lock while the server
 223          * holds the lock works correctly.
 224          */
 225         ret = drmGetLock(drmfd, lock1, 0);
 226         assert(ret == 0);
 227         send_event(1, SERVER_LOCKED);
 228         /* Wait a while for the client to do its thing */
 229         sleep(1);
 230         ret = drmUnlock(drmfd, lock1);
 231         assert(ret == 0);
 232         unlock_time = get_millis();
 233
 234         wait_event(1, CLIENT_LOCKED);
 235         ret = read(commfd[1], &client_time, sizeof(client_time));
 236         if (ret == -1)
 237                 err(1, "Failure to read client magic");
 238
 239         if (client_time < unlock_time)
 240                 errx(1, "Client took lock before server released it");
 241 }
 242
 243 int main(int argc, char **argv)
 244 {
 245         int ret;
 246
 247
 248         ret = pipe(commfd);
 249         if (ret == -1)
 250                 err(1, "Couldn't create pipe");
 251
 252         ret = fork();
 253         if (ret == -1)
 254                 err(1, "failure to fork client");
 255         if (ret == 0)
 256                 client();
 257         else
 258                 server();
 259
 260         return 0;
 261 }
 262