git.demorecorder.com Git - free-sw/xcb/libxcb/blob - src/xcb_in.c

   1 /* Copyright (C) 2001-2004 Bart Massey and Jamey Sharp.
   2  *
   3  * Permission is hereby granted, free of charge, to any person obtaining a
   4  * copy of this software and associated documentation files (the "Software"),
   5  * to deal in the Software without restriction, including without limitation
   6  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   7  * and/or sell copies of the Software, and to permit persons to whom the
   8  * Software is furnished to do so, subject to the following conditions:
   9  *
  10  * The above copyright notice and this permission notice shall be included in
  11  * all copies or substantial portions of the Software.
  12  *
  13  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  14  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  15  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  16  * AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  17  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  18  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  19  *
  20  * Except as contained in this notice, the names of the authors or their
  21  * institutions shall not be used in advertising or otherwise to promote the
  22  * sale, use or other dealings in this Software without prior written
  23  * authorization from the authors.
  24  */
  25
  26 /* Stuff that reads stuff from the server. */
  27
  28 #include <assert.h>
  29 #include <string.h>
  30 #include <stdlib.h>
  31 #include <unistd.h>
  32 #include <stdio.h>
  33 #include <errno.h>
  34
  35 #include "xcb.h"
  36 #include "xcbext.h"
  37 #include "xcbint.h"
  38
  39 struct event_list {
  40     XCBGenericEvent *event;
  41     struct event_list *next;
  42 };
  43
  44 struct reply_list {
  45     void *reply;
  46     struct reply_list *next;
  47 };
  48
  49 typedef struct pending_reply {
  50     unsigned int request;
  51     enum workarounds workaround;
  52     int flags;
  53     struct pending_reply *next;
  54 } pending_reply;
  55
  56 typedef struct reader_list {
  57     unsigned int request;
  58     pthread_cond_t *data;
  59     struct reader_list *next;
  60 } reader_list;
  61
  62 static void wake_up_next_reader(XCBConnection *c)
  63 {
  64     int pthreadret;
  65     if(c->in.readers)
  66         pthreadret = pthread_cond_signal(c->in.readers->data);
  67     else
  68         pthreadret = pthread_cond_signal(&c->in.event_cond);
  69     assert(pthreadret == 0);
  70 }
  71
  72 static int read_packet(XCBConnection *c)
  73 {
  74     XCBGenericRep genrep;
  75     int length = 32;
  76     void *buf;
  77     pending_reply *pend = 0;
  78     struct event_list *event;
  79
  80     /* Wait for there to be enough data for us to read a whole packet */
  81     if(c->in.queue_len < length)
  82         return 0;
  83
  84     /* Get the response type, length, and sequence number. */
  85     memcpy(&genrep, c->in.queue, sizeof(genrep));
  86
  87     /* Compute 32-bit sequence number of this packet. */
  88     if((genrep.response_type & 0x7f) != KeymapNotify)
  89     {
  90         int lastread = c->in.request_read;
  91         c->in.request_read = (lastread & 0xffff0000) | genrep.sequence;
  92         if(c->in.request_read < lastread)
  93             c->in.request_read += 0x10000;
  94         if(c->in.request_read > c->in.request_expected)
  95             c->in.request_expected = c->in.request_read;
  96
  97         if(c->in.request_read != lastread)
  98         {
  99             if(c->in.current_reply)
 100             {
 101                 _xcb_map_put(c->in.replies, lastread, c->in.current_reply);
 102                 c->in.current_reply = 0;
 103                 c->in.current_reply_tail = &c->in.current_reply;
 104             }
 105             c->in.request_completed = c->in.request_read - 1;
 106         }
 107         if(genrep.response_type != 1) /* not reply: error or event */
 108             c->in.request_completed = c->in.request_read; /* XXX: does event/error imply no more replies? */
 109
 110         while(c->in.pending_replies && c->in.pending_replies->request <= c->in.request_completed)
 111         {
 112             pending_reply *oldpend = c->in.pending_replies;
 113             c->in.pending_replies = oldpend->next;
 114             if(!oldpend->next)
 115                 c->in.pending_replies_tail = &c->in.pending_replies;
 116             free(oldpend);
 117         }
 118     }
 119
 120     if(genrep.response_type == 0 || genrep.response_type == 1)
 121     {
 122         pend = c->in.pending_replies;
 123         if(pend && pend->request != c->in.request_read)
 124             pend = 0;
 125     }
 126
 127     /* For reply packets, check that the entire packet is available. */
 128     if(genrep.response_type == 1)
 129     {
 130         if(pend && pend->workaround == WORKAROUND_GLX_GET_FB_CONFIGS_BUG)
 131         {
 132             CARD32 *p = (CARD32 *) c->in.queue;
 133             genrep.length = p[2] * p[3] * 2;
 134         }
 135         length += genrep.length * 4;
 136     }
 137
 138     buf = malloc(length + (genrep.response_type == 1 ? 0 : sizeof(CARD32)));
 139     if(!buf)
 140         return 0;
 141     if(_xcb_in_read_block(c, buf, length) <= 0)
 142     {
 143         free(buf);
 144         return 0;
 145     }
 146     if(pend && (pend->flags & XCB_REQUEST_DISCARD_REPLY))
 147     {
 148         free(buf);
 149         return 1;
 150     }
 151
 152     if(genrep.response_type != 1)
 153         ((XCBGenericEvent *) buf)->full_sequence = c->in.request_read;
 154
 155     /* reply, or checked error */
 156     if(genrep.response_type == 1 || (genrep.response_type == 0 && pend && (pend->flags & XCB_REQUEST_CHECKED)))
 157     {
 158         reader_list *reader;
 159         struct reply_list *cur = malloc(sizeof(struct reply_list));
 160         if(!cur)
 161             return 0;
 162         cur->reply = buf;
 163         cur->next = 0;
 164         *c->in.current_reply_tail = cur;
 165         c->in.current_reply_tail = &cur->next;
 166         for(reader = c->in.readers; reader && reader->request <= c->in.request_read; reader = reader->next)
 167             if(reader->request == c->in.request_read)
 168             {
 169                 pthread_cond_signal(reader->data);
 170                 break;
 171             }
 172         return 1;
 173     }
 174
 175     /* event, or unchecked error */
 176     event = malloc(sizeof(struct event_list));
 177     if(!event)
 178     {
 179         free(buf);
 180         return 0;
 181     }
 182     event->event = buf;
 183     event->next = 0;
 184     *c->in.events_tail = event;
 185     c->in.events_tail = &event->next;
 186     pthread_cond_signal(&c->in.event_cond);
 187     return 1; /* I have something for you... */
 188 }
 189
 190 static XCBGenericEvent *get_event(XCBConnection *c)
 191 {
 192     struct event_list *cur = c->in.events;
 193     XCBGenericEvent *ret;
 194     if(!c->in.events)
 195         return 0;
 196     ret = cur->event;
 197     c->in.events = cur->next;
 198     if(!cur->next)
 199         c->in.events_tail = &c->in.events;
 200     free(cur);
 201     return ret;
 202 }
 203
 204 static void free_reply_list(struct reply_list *head)
 205 {
 206     while(head)
 207     {
 208         struct reply_list *cur = head;
 209         head = cur->next;
 210         free(cur->reply);
 211         free(cur);
 212     }
 213 }
 214
 215 static int read_block(const int fd, void *buf, const size_t len)
 216 {
 217     int done = 0;
 218     while(done < len)
 219     {
 220         int ret = read(fd, ((char *) buf) + done, len - done);
 221         if(ret > 0)
 222             done += ret;
 223         if(ret < 0 && errno == EAGAIN)
 224         {
 225             fd_set fds;
 226             FD_ZERO(&fds);
 227             FD_SET(fd, &fds);
 228             ret = select(fd + 1, &fds, 0, 0, 0);
 229         }
 230         if(ret <= 0)
 231             return ret;
 232     }
 233     return len;
 234 }
 235
 236 /* Public interface */
 237
 238 void *XCBWaitForReply(XCBConnection *c, unsigned int request, XCBGenericError **e)
 239 {
 240     pthread_cond_t cond = PTHREAD_COND_INITIALIZER;
 241     reader_list reader;
 242     reader_list **prev_reader;
 243     struct reply_list *head;
 244     void *ret = 0;
 245     if(e)
 246         *e = 0;
 247
 248     /* If an error occurred when issuing the request, fail immediately. */
 249     if(!request)
 250         return 0;
 251
 252     pthread_mutex_lock(&c->iolock);
 253
 254     /* If this request has not been written yet, write it. */
 255     if(!_xcb_out_flush_to(c, request))
 256         goto done; /* error */
 257
 258     for(prev_reader = &c->in.readers; *prev_reader && (*prev_reader)->request <= request; prev_reader = &(*prev_reader)->next)
 259         if((*prev_reader)->request == request)
 260             goto done; /* error */
 261
 262     reader.request = request;
 263     reader.data = &cond;
 264     reader.next = *prev_reader;
 265     *prev_reader = &reader;
 266
 267     /* If this request has not completed yet and has no reply waiting,
 268      * wait for one. */
 269     while(c->in.request_completed < request &&
 270             !(c->in.request_read == request && c->in.current_reply))
 271         if(!_xcb_conn_wait(c, &cond, 0, 0))
 272             goto done;
 273
 274     if(c->in.request_read != request)
 275     {
 276         head = _xcb_map_remove(c->in.replies, request);
 277         if(head && head->next)
 278             _xcb_map_put(c->in.replies, request, head->next);
 279     }
 280     else
 281     {
 282         head = c->in.current_reply;
 283         if(head)
 284         {
 285             c->in.current_reply = head->next;
 286             if(!head->next)
 287                 c->in.current_reply_tail = &c->in.current_reply;
 288         }
 289     }
 290
 291     if(head)
 292     {
 293         ret = head->reply;
 294         free(head);
 295
 296         if(((XCBGenericRep *) ret)->response_type == 0) /* X error */
 297         {
 298             if(e)
 299                 *e = ret;
 300             else
 301                 free(ret);
 302             ret = 0;
 303         }
 304     }
 305
 306 done:
 307     for(prev_reader = &c->in.readers; *prev_reader && (*prev_reader)->request <= request; prev_reader = &(*prev_reader)->next)
 308         if(*prev_reader == &reader)
 309         {
 310             *prev_reader = (*prev_reader)->next;
 311             break;
 312         }
 313     pthread_cond_destroy(&cond);
 314
 315     wake_up_next_reader(c);
 316     pthread_mutex_unlock(&c->iolock);
 317     return ret;
 318 }
 319
 320 XCBGenericEvent *XCBWaitEvent(XCBConnection *c)
 321 {
 322     return XCBWaitForEvent(c);
 323 }
 324
 325 XCBGenericEvent *XCBWaitForEvent(XCBConnection *c)
 326 {
 327     XCBGenericEvent *ret;
 328     pthread_mutex_lock(&c->iolock);
 329     /* get_event returns 0 on empty list. */
 330     while(!(ret = get_event(c)))
 331         if(!_xcb_conn_wait(c, &c->in.event_cond, 0, 0))
 332             break;
 333
 334     wake_up_next_reader(c);
 335     pthread_mutex_unlock(&c->iolock);
 336     return ret;
 337 }
 338
 339 XCBGenericEvent *XCBPollForEvent(XCBConnection *c, int *error)
 340 {
 341     XCBGenericEvent *ret = 0;
 342     pthread_mutex_lock(&c->iolock);
 343     if(error)
 344         *error = 0;
 345     /* FIXME: follow X meets Z architecture changes. */
 346     if(_xcb_in_read(c))
 347         ret = get_event(c);
 348     else if(error)
 349         *error = -1;
 350     else
 351     {
 352         fprintf(stderr, "XCBPollForEvent: I/O error occured, but no handler provided.\n");
 353         abort();
 354     }
 355     pthread_mutex_unlock(&c->iolock);
 356     return ret;
 357 }
 358
 359 unsigned int XCBGetRequestRead(XCBConnection *c)
 360 {
 361     unsigned int ret;
 362     pthread_mutex_lock(&c->iolock);
 363     /* FIXME: follow X meets Z architecture changes. */
 364     _xcb_in_read(c);
 365     ret = c->in.request_read;
 366     pthread_mutex_unlock(&c->iolock);
 367     return ret;
 368 }
 369
 370 /* Private interface */
 371
 372 int _xcb_in_init(_xcb_in *in)
 373 {
 374     if(pthread_cond_init(&in->event_cond, 0))
 375         return 0;
 376     in->reading = 0;
 377
 378     in->queue_len = 0;
 379
 380     in->request_read = 0;
 381     in->request_completed = 0;
 382
 383     in->replies = _xcb_map_new();
 384     if(!in->replies)
 385         return 0;
 386
 387     in->current_reply_tail = &in->current_reply;
 388     in->events_tail = &in->events;
 389     in->pending_replies_tail = &in->pending_replies;
 390
 391     return 1;
 392 }
 393
 394 void _xcb_in_destroy(_xcb_in *in)
 395 {
 396     pthread_cond_destroy(&in->event_cond);
 397     free_reply_list(in->current_reply);
 398     _xcb_map_delete(in->replies, (void (*)(void *)) free_reply_list);
 399     while(in->events)
 400     {
 401         struct event_list *e = in->events;
 402         in->events = e->next;
 403         free(e->event);
 404         free(e);
 405     }
 406     while(in->pending_replies)
 407     {
 408         pending_reply *pend = in->pending_replies;
 409         in->pending_replies = pend->next;
 410         free(pend);
 411     }
 412 }
 413
 414 int _xcb_in_expect_reply(XCBConnection *c, unsigned int request, enum workarounds workaround, int flags)
 415 {
 416     if(workaround != WORKAROUND_NONE || flags != 0)
 417     {
 418         pending_reply *pend = malloc(sizeof(pending_reply));
 419         if(!pend)
 420             return 0;
 421         pend->request = request;
 422         pend->workaround = workaround;
 423         pend->flags = flags;
 424         pend->next = 0;
 425         *c->in.pending_replies_tail = pend;
 426         c->in.pending_replies_tail = &pend->next;
 427     }
 428     return 1;
 429 }
 430
 431 int _xcb_in_read(XCBConnection *c)
 432 {
 433     int n = read(c->fd, c->in.queue + c->in.queue_len, sizeof(c->in.queue) - c->in.queue_len);
 434     if(n > 0)
 435         c->in.queue_len += n;
 436     while(read_packet(c))
 437         /* empty */;
 438     return (n > 0) || (n < 0 && errno == EAGAIN);
 439 }
 440
 441 int _xcb_in_read_block(XCBConnection *c, void *buf, int len)
 442 {
 443     int done = c->in.queue_len;
 444     if(len < done)
 445         done = len;
 446
 447     memcpy(buf, c->in.queue, done);
 448     c->in.queue_len -= done;
 449     memmove(c->in.queue, c->in.queue + done, c->in.queue_len);
 450
 451     if(len > done)
 452     {
 453         int ret = read_block(c->fd, (char *) buf + done, len - done);
 454         if(ret <= 0)
 455             return ret;
 456     }
 457
 458     return len;
 459 }