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 <sys/select.h>
  34 #include <errno.h>
  35
  36 #include "xcb.h"
  37 #include "xcbext.h"
  38 #include "xcbint.h"
  39
  40 #define XCB_ERROR 0
  41 #define XCB_REPLY 1
  42 #define XCB_XGE_EVENT 35
  43
  44 struct event_list {
  45     xcb_generic_event_t *event;
  46     struct event_list *next;
  47 };
  48
  49 struct reply_list {
  50     void *reply;
  51     struct reply_list *next;
  52 };
  53
  54 typedef struct pending_reply {
  55     unsigned int request;
  56     enum workarounds workaround;
  57     int flags;
  58     struct pending_reply *next;
  59 } pending_reply;
  60
  61 typedef struct reader_list {
  62     unsigned int request;
  63     pthread_cond_t *data;
  64     struct reader_list *next;
  65 } reader_list;
  66
  67 static void wake_up_next_reader(xcb_connection_t *c)
  68 {
  69     int pthreadret;
  70     if(c->in.readers)
  71         pthreadret = pthread_cond_signal(c->in.readers->data);
  72     else
  73         pthreadret = pthread_cond_signal(&c->in.event_cond);
  74     assert(pthreadret == 0);
  75 }
  76
  77 static int read_packet(xcb_connection_t *c)
  78 {
  79     xcb_generic_reply_t genrep;
  80     int length = 32;
  81     int eventlength = 0; /* length after first 32 bytes for GenericEvents */
  82     void *buf;
  83     pending_reply *pend = 0;
  84     struct event_list *event;
  85
  86     /* Wait for there to be enough data for us to read a whole packet */
  87     if(c->in.queue_len < length)
  88         return 0;
  89
  90     /* Get the response type, length, and sequence number. */
  91     memcpy(&genrep, c->in.queue, sizeof(genrep));
  92
  93     /* Compute 32-bit sequence number of this packet. */
  94     if((genrep.response_type & 0x7f) != XCB_KEYMAP_NOTIFY)
  95     {
  96         unsigned int lastread = c->in.request_read;
  97         c->in.request_read = (lastread & 0xffff0000) | genrep.sequence;
  98         if(XCB_SEQUENCE_COMPARE(c->in.request_read, <, lastread))
  99             c->in.request_read += 0x10000;
 100         if(XCB_SEQUENCE_COMPARE(c->in.request_read, >, c->in.request_expected))
 101             c->in.request_expected = c->in.request_read;
 102
 103         if(c->in.request_read != lastread)
 104         {
 105             if(c->in.current_reply)
 106             {
 107                 _xcb_map_put(c->in.replies, lastread, c->in.current_reply);
 108                 c->in.current_reply = 0;
 109                 c->in.current_reply_tail = &c->in.current_reply;
 110             }
 111             c->in.request_completed = c->in.request_read - 1;
 112         }
 113
 114         while(c->in.pending_replies &&
 115               XCB_SEQUENCE_COMPARE (c->in.pending_replies->request, <=, c->in.request_completed))
 116         {
 117             pending_reply *oldpend = c->in.pending_replies;
 118             c->in.pending_replies = oldpend->next;
 119             if(!oldpend->next)
 120                 c->in.pending_replies_tail = &c->in.pending_replies;
 121             free(oldpend);
 122         }
 123
 124         if(genrep.response_type == XCB_ERROR)
 125             c->in.request_completed = c->in.request_read;
 126     }
 127
 128     if(genrep.response_type == XCB_ERROR || genrep.response_type == XCB_REPLY)
 129     {
 130         pend = c->in.pending_replies;
 131         if(pend && pend->request != c->in.request_read)
 132             pend = 0;
 133     }
 134
 135     /* For reply packets, check that the entire packet is available. */
 136     if(genrep.response_type == XCB_REPLY)
 137     {
 138         if(pend && pend->workaround == WORKAROUND_GLX_GET_FB_CONFIGS_BUG)
 139         {
 140             uint32_t *p = (uint32_t *) c->in.queue;
 141             genrep.length = p[2] * p[3] * 2;
 142         }
 143         length += genrep.length * 4;
 144     }
 145
 146     /* XGE events may have sizes > 32 */
 147     if (genrep.response_type == XCB_XGE_EVENT)
 148     {
 149         eventlength = ((xcb_ge_event_t*)&genrep)->length * 4;
 150     }
 151
 152     buf = malloc(length + eventlength +
 153             (genrep.response_type == XCB_REPLY ? 0 : sizeof(uint32_t)));
 154     if(!buf)
 155     {
 156         _xcb_conn_shutdown(c);
 157         return 0;
 158     }
 159
 160     if(_xcb_in_read_block(c, buf, length) <= 0)
 161     {
 162         free(buf);
 163         return 0;
 164     }
 165
 166     /* pull in XGE event data if available, append after event struct */
 167     if (eventlength)
 168     {
 169         if(_xcb_in_read_block(c, &((xcb_generic_event_t*)buf)[1], eventlength) <= 0)
 170         {
 171             free(buf);
 172             return 0;
 173         }
 174     }
 175
 176     if(pend && (pend->flags & XCB_REQUEST_DISCARD_REPLY))
 177     {
 178         free(buf);
 179         return 1;
 180     }
 181
 182     if(genrep.response_type != XCB_REPLY)
 183         ((xcb_generic_event_t *) buf)->full_sequence = c->in.request_read;
 184
 185     /* reply, or checked error */
 186     if( genrep.response_type == XCB_REPLY ||
 187        (genrep.response_type == XCB_ERROR && pend && (pend->flags & XCB_REQUEST_CHECKED)))
 188     {
 189         reader_list *reader;
 190         struct reply_list *cur = malloc(sizeof(struct reply_list));
 191         if(!cur)
 192         {
 193             _xcb_conn_shutdown(c);
 194             return 0;
 195         }
 196         cur->reply = buf;
 197         cur->next = 0;
 198         *c->in.current_reply_tail = cur;
 199         c->in.current_reply_tail = &cur->next;
 200         for(reader = c->in.readers;
 201             reader &&
 202             XCB_SEQUENCE_COMPARE(reader->request, <=, c->in.request_read);
 203             reader = reader->next)
 204         {
 205             if(reader->request == c->in.request_read)
 206             {
 207                 pthread_cond_signal(reader->data);
 208                 break;
 209             }
 210         }
 211         return 1;
 212     }
 213
 214     /* event, or unchecked error */
 215     event = malloc(sizeof(struct event_list));
 216     if(!event)
 217     {
 218         _xcb_conn_shutdown(c);
 219         free(buf);
 220         return 0;
 221     }
 222     event->event = buf;
 223     event->next = 0;
 224     *c->in.events_tail = event;
 225     c->in.events_tail = &event->next;
 226     pthread_cond_signal(&c->in.event_cond);
 227     return 1; /* I have something for you... */
 228 }
 229
 230 static xcb_generic_event_t *get_event(xcb_connection_t *c)
 231 {
 232     struct event_list *cur = c->in.events;
 233     xcb_generic_event_t *ret;
 234     if(!c->in.events)
 235         return 0;
 236     ret = cur->event;
 237     c->in.events = cur->next;
 238     if(!cur->next)
 239         c->in.events_tail = &c->in.events;
 240     free(cur);
 241     return ret;
 242 }
 243
 244 static void free_reply_list(struct reply_list *head)
 245 {
 246     while(head)
 247     {
 248         struct reply_list *cur = head;
 249         head = cur->next;
 250         free(cur->reply);
 251         free(cur);
 252     }
 253 }
 254
 255 static int read_block(const int fd, void *buf, const ssize_t len)
 256 {
 257     int done = 0;
 258     while(done < len)
 259     {
 260         int ret = read(fd, ((char *) buf) + done, len - done);
 261         if(ret > 0)
 262             done += ret;
 263         if(ret < 0 && errno == EAGAIN)
 264         {
 265             fd_set fds;
 266             FD_ZERO(&fds);
 267             FD_SET(fd, &fds);
 268             do {
 269                 ret = select(fd + 1, &fds, 0, 0, 0);
 270             } while (ret == -1 && errno == EINTR);
 271         }
 272         if(ret <= 0)
 273             return ret;
 274     }
 275     return len;
 276 }
 277
 278 static int poll_for_reply(xcb_connection_t *c, unsigned int request, void **reply, xcb_generic_error_t **error)
 279 {
 280     struct reply_list *head;
 281
 282     /* If an error occurred when issuing the request, fail immediately. */
 283     if(!request)
 284         head = 0;
 285     /* We've read requests past the one we want, so if it has replies we have
 286      * them all and they're in the replies map. */
 287     else if(XCB_SEQUENCE_COMPARE(request, <, c->in.request_read))
 288     {
 289         head = _xcb_map_remove(c->in.replies, request);
 290         if(head && head->next)
 291             _xcb_map_put(c->in.replies, request, head->next);
 292     }
 293     /* We're currently processing the responses to the request we want, and we
 294      * have a reply ready to return. So just return it without blocking. */
 295     else if(request == c->in.request_read && c->in.current_reply)
 296     {
 297         head = c->in.current_reply;
 298         c->in.current_reply = head->next;
 299         if(!head->next)
 300             c->in.current_reply_tail = &c->in.current_reply;
 301     }
 302     /* We know this request can't have any more replies, and we've already
 303      * established it doesn't have a reply now. Don't bother blocking. */
 304     else if(request == c->in.request_completed)
 305         head = 0;
 306     /* We may have more replies on the way for this request: block until we're
 307      * sure. */
 308     else
 309         return 0;
 310
 311     if(error)
 312         *error = 0;
 313     *reply = 0;
 314
 315     if(head)
 316     {
 317         if(((xcb_generic_reply_t *) head->reply)->response_type == XCB_ERROR)
 318         {
 319             if(error)
 320                 *error = head->reply;
 321             else
 322                 free(head->reply);
 323         }
 324         else
 325             *reply = head->reply;
 326
 327         free(head);
 328     }
 329
 330     return 1;
 331 }
 332
 333 /* Public interface */
 334
 335 void *xcb_wait_for_reply(xcb_connection_t *c, unsigned int request, xcb_generic_error_t **e)
 336 {
 337     void *ret = 0;
 338     if(e)
 339         *e = 0;
 340     if(c->has_error)
 341         return 0;
 342
 343     _xcb_lock_io(c);
 344
 345     /* If this request has not been written yet, write it. */
 346     if(_xcb_out_flush_to(c, request))
 347     {
 348         pthread_cond_t cond = PTHREAD_COND_INITIALIZER;
 349         reader_list reader;
 350         reader_list **prev_reader;
 351
 352         for(prev_reader = &c->in.readers;
 353             *prev_reader &&
 354             XCB_SEQUENCE_COMPARE ((*prev_reader)->request, <=, request);
 355             prev_reader = &(*prev_reader)->next)
 356         {
 357             /* empty */;
 358         }
 359         reader.request = request;
 360         reader.data = &cond;
 361         reader.next = *prev_reader;
 362         *prev_reader = &reader;
 363
 364         while(!poll_for_reply(c, request, &ret, e))
 365             if(!_xcb_conn_wait(c, &cond, 0, 0))
 366                 break;
 367
 368         for(prev_reader = &c->in.readers;
 369             *prev_reader &&
 370             XCB_SEQUENCE_COMPARE((*prev_reader)->request, <=, request);
 371             prev_reader = &(*prev_reader)->next)
 372         {
 373             if(*prev_reader == &reader)
 374             {
 375                 *prev_reader = (*prev_reader)->next;
 376                 break;
 377             }
 378         }
 379         pthread_cond_destroy(&cond);
 380     }
 381
 382     wake_up_next_reader(c);
 383     _xcb_unlock_io(c);
 384     return ret;
 385 }
 386
 387 int xcb_poll_for_reply(xcb_connection_t *c, unsigned int request, void **reply, xcb_generic_error_t **error)
 388 {
 389     int ret;
 390     if(c->has_error)
 391     {
 392         *reply = 0;
 393         if(error)
 394             *error = 0;
 395         return 1; /* would not block */
 396     }
 397     assert(reply != 0);
 398     _xcb_lock_io(c);
 399     ret = poll_for_reply(c, request, reply, error);
 400     _xcb_unlock_io(c);
 401     return ret;
 402 }
 403
 404 xcb_generic_event_t *xcb_wait_for_event(xcb_connection_t *c)
 405 {
 406     xcb_generic_event_t *ret;
 407     if(c->has_error)
 408         return 0;
 409     _xcb_lock_io(c);
 410     /* get_event returns 0 on empty list. */
 411     while(!(ret = get_event(c)))
 412         if(!_xcb_conn_wait(c, &c->in.event_cond, 0, 0))
 413             break;
 414
 415     wake_up_next_reader(c);
 416     _xcb_unlock_io(c);
 417     return ret;
 418 }
 419
 420 xcb_generic_event_t *xcb_poll_for_event(xcb_connection_t *c)
 421 {
 422     xcb_generic_event_t *ret = 0;
 423     if(!c->has_error)
 424     {
 425         _xcb_lock_io(c);
 426         /* FIXME: follow X meets Z architecture changes. */
 427         ret = get_event(c);
 428         if(!ret && _xcb_in_read(c)) /* _xcb_in_read shuts down the connection on error */
 429             ret = get_event(c);
 430         _xcb_unlock_io(c);
 431     }
 432     return ret;
 433 }
 434
 435 xcb_generic_error_t *xcb_request_check(xcb_connection_t *c, xcb_void_cookie_t cookie)
 436 {
 437     /* FIXME: this could hold the lock to avoid syncing unnecessarily, but
 438      * that would require factoring the locking out of xcb_get_input_focus,
 439      * xcb_get_input_focus_reply, and xcb_wait_for_reply. */
 440     xcb_generic_error_t *ret;
 441     void *reply;
 442     if(c->has_error)
 443         return 0;
 444     if(XCB_SEQUENCE_COMPARE(cookie.sequence,>,c->in.request_expected)
 445        && XCB_SEQUENCE_COMPARE(cookie.sequence,>,c->in.request_completed))
 446     {
 447         free(xcb_get_input_focus_reply(c, xcb_get_input_focus(c), &ret));
 448         assert(!ret);
 449     }
 450     reply = xcb_wait_for_reply(c, cookie.sequence, &ret);
 451     assert(!reply);
 452     return ret;
 453 }
 454
 455 /* Private interface */
 456
 457 int _xcb_in_init(_xcb_in *in)
 458 {
 459     if(pthread_cond_init(&in->event_cond, 0))
 460         return 0;
 461     in->reading = 0;
 462
 463     in->queue_len = 0;
 464
 465     in->request_read = 0;
 466     in->request_completed = 0;
 467
 468     in->replies = _xcb_map_new();
 469     if(!in->replies)
 470         return 0;
 471
 472     in->current_reply_tail = &in->current_reply;
 473     in->events_tail = &in->events;
 474     in->pending_replies_tail = &in->pending_replies;
 475
 476     return 1;
 477 }
 478
 479 void _xcb_in_destroy(_xcb_in *in)
 480 {
 481     pthread_cond_destroy(&in->event_cond);
 482     free_reply_list(in->current_reply);
 483     _xcb_map_delete(in->replies, (void (*)(void *)) free_reply_list);
 484     while(in->events)
 485     {
 486         struct event_list *e = in->events;
 487         in->events = e->next;
 488         free(e->event);
 489         free(e);
 490     }
 491     while(in->pending_replies)
 492     {
 493         pending_reply *pend = in->pending_replies;
 494         in->pending_replies = pend->next;
 495         free(pend);
 496     }
 497 }
 498
 499 int _xcb_in_expect_reply(xcb_connection_t *c, unsigned int request, enum workarounds workaround, int flags)
 500 {
 501     pending_reply *pend = malloc(sizeof(pending_reply));
 502     assert(workaround != WORKAROUND_NONE || flags != 0);
 503     if(!pend)
 504     {
 505         _xcb_conn_shutdown(c);
 506         return 0;
 507     }
 508     pend->request = request;
 509     pend->workaround = workaround;
 510     pend->flags = flags;
 511     pend->next = 0;
 512     *c->in.pending_replies_tail = pend;
 513     c->in.pending_replies_tail = &pend->next;
 514     return 1;
 515 }
 516
 517 int _xcb_in_read(xcb_connection_t *c)
 518 {
 519     int n = read(c->fd, c->in.queue + c->in.queue_len, sizeof(c->in.queue) - c->in.queue_len);
 520     if(n > 0)
 521         c->in.queue_len += n;
 522     while(read_packet(c))
 523         /* empty */;
 524     if((n > 0) || (n < 0 && errno == EAGAIN))
 525         return 1;
 526     _xcb_conn_shutdown(c);
 527     return 0;
 528 }
 529
 530 int _xcb_in_read_block(xcb_connection_t *c, void *buf, int len)
 531 {
 532     int done = c->in.queue_len;
 533     if(len < done)
 534         done = len;
 535
 536     memcpy(buf, c->in.queue, done);
 537     c->in.queue_len -= done;
 538     memmove(c->in.queue, c->in.queue + done, c->in.queue_len);
 539
 540     if(len > done)
 541     {
 542         int ret = read_block(c->fd, (char *) buf + done, len - done);
 543         if(ret <= 0)
 544         {
 545             _xcb_conn_shutdown(c);
 546             return ret;
 547         }
 548     }
 549
 550     return len;
 551 }