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 typedef struct {
  40     unsigned int request;
  41     enum workarounds workaround;
  42 } pending_reply;
  43
  44 typedef struct XCBReplyData {
  45     unsigned int request;
  46     void *data;
  47     XCBGenericError **error;
  48 } XCBReplyData;
  49
  50 static int match_request_error(const void *request, const void *data)
  51 {
  52     const XCBGenericError *e = data;
  53     return e->response_type == 0 && e->sequence == ((*(unsigned int *) request) & 0xffff);
  54 }
  55
  56 static int match_reply(const void *request, const void *data)
  57 {
  58     return ((XCBReplyData *) data)->request == *(unsigned int *) request;
  59 }
  60
  61 static void wake_up_next_reader(XCBConnection *c)
  62 {
  63     XCBReplyData *cur = _xcb_list_peek_head(c->in.readers);
  64     int pthreadret;
  65     if(cur)
  66         pthreadret = pthread_cond_signal(cur->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     unsigned char *buf;
  77
  78     /* Wait for there to be enough data for us to read a whole packet */
  79     if(c->in.queue_len < length)
  80         return 0;
  81
  82     /* Get the response type, length, and sequence number. */
  83     memcpy(&genrep, c->in.queue, sizeof(genrep));
  84
  85     /* Compute 32-bit sequence number of this packet. */
  86     if((genrep.response_type & 0x7f) != KeymapNotify)
  87     {
  88         int lastread = c->in.request_read;
  89         c->in.request_read = (lastread & 0xffff0000) | genrep.sequence;
  90         if(c->in.request_read != lastread && !_xcb_queue_is_empty(c->in.current_reply))
  91         {
  92             _xcb_map_put(c->in.replies, lastread, c->in.current_reply);
  93             c->in.current_reply = _xcb_queue_new();
  94         }
  95         if(c->in.request_read < lastread)
  96             c->in.request_read += 0x10000;
  97     }
  98
  99     /* For reply packets, check that the entire packet is available. */
 100     if(genrep.response_type == 1)
 101     {
 102         pending_reply *pend = _xcb_list_peek_head(c->in.pending_replies);
 103         if(pend && pend->request == c->in.request_read)
 104         {
 105             switch(pend->workaround)
 106             {
 107             case WORKAROUND_NONE:
 108                 break;
 109             case WORKAROUND_GLX_GET_FB_CONFIGS_BUG:
 110                 {
 111                     CARD32 *p = (CARD32 *) c->in.queue;
 112                     genrep.length = p[2] * p[3] * 2;
 113                 }
 114                 break;
 115             }
 116             free(_xcb_queue_dequeue(c->in.pending_replies));
 117         }
 118         length += genrep.length * 4;
 119     }
 120
 121     buf = malloc(length);
 122     if(!buf)
 123         return 0;
 124     if(_xcb_in_read_block(c, buf, length) <= 0)
 125     {
 126         free(buf);
 127         return 0;
 128     }
 129
 130     if(buf[0] == 1) /* response is a reply */
 131     {
 132         XCBReplyData *reader = _xcb_list_find(c->in.readers, match_reply, &c->in.request_read);
 133         _xcb_queue_enqueue(c->in.current_reply, buf);
 134         if(reader)
 135             pthread_cond_signal(reader->data);
 136         return 1;
 137     }
 138
 139     if(buf[0] == 0) /* response is an error */
 140     {
 141         XCBReplyData *reader = _xcb_list_find(c->in.readers, match_reply, &c->in.request_read);
 142         if(reader && reader->error)
 143         {
 144             *reader->error = (XCBGenericError *) buf;
 145             pthread_cond_signal(reader->data);
 146             return 1;
 147         }
 148     }
 149
 150     /* event, or error without a waiting reader */
 151     _xcb_queue_enqueue(c->in.events, buf);
 152     pthread_cond_signal(&c->in.event_cond);
 153     return 1; /* I have something for you... */
 154 }
 155
 156 /* Public interface */
 157
 158 void *XCBWaitForReply(XCBConnection *c, unsigned int request, XCBGenericError **e)
 159 {
 160     pthread_cond_t cond = PTHREAD_COND_INITIALIZER;
 161     XCBReplyData reader;
 162     void *ret = 0;
 163     if(e)
 164         *e = 0;
 165
 166     pthread_mutex_lock(&c->iolock);
 167
 168     /* If this request has not been written yet, write it. */
 169     if((signed int) (c->out.request_written - request) < 0)
 170         if(!_xcb_out_flush(c))
 171             goto done; /* error */
 172
 173     if(_xcb_list_find(c->in.readers, match_reply, &request))
 174         goto done; /* error */
 175
 176     if(e)
 177     {
 178         *e = _xcb_list_remove(c->in.events, match_request_error, &request);
 179         if(*e)
 180             goto done;
 181     }
 182
 183     reader.request = request;
 184     reader.data = &cond;
 185     reader.error = e;
 186     _xcb_list_append(c->in.readers, &reader);
 187
 188     /* If this request has not been read yet, wait for it. */
 189     while(!(e && *e) && ((signed int) (c->in.request_read - request) < 0 ||
 190             (c->in.request_read == request &&
 191              _xcb_queue_is_empty(c->in.current_reply))))
 192         if(!_xcb_conn_wait(c, /*should_write*/ 0, &cond))
 193             goto done;
 194
 195     if(c->in.request_read != request)
 196     {
 197         _xcb_queue *q = _xcb_map_get(c->in.replies, request);
 198         if(q)
 199         {
 200             ret = _xcb_queue_dequeue(q);
 201             if(_xcb_queue_is_empty(q))
 202                 _xcb_queue_delete(_xcb_map_remove(c->in.replies, request), free);
 203         }
 204     }
 205     else
 206         ret = _xcb_queue_dequeue(c->in.current_reply);
 207
 208 done:
 209     _xcb_list_remove(c->in.readers, match_reply, &request);
 210     pthread_cond_destroy(&cond);
 211
 212     wake_up_next_reader(c);
 213     pthread_mutex_unlock(&c->iolock);
 214     return ret;
 215 }
 216
 217 XCBGenericEvent *XCBWaitEvent(XCBConnection *c)
 218 {
 219     return XCBWaitForEvent(c);
 220 }
 221
 222 XCBGenericEvent *XCBWaitForEvent(XCBConnection *c)
 223 {
 224     XCBGenericEvent *ret;
 225
 226 #if XCBTRACEEVENT
 227     fprintf(stderr, "Entering XCBWaitEvent\n");
 228 #endif
 229
 230     pthread_mutex_lock(&c->iolock);
 231     /* _xcb_list_remove_head returns 0 on empty list. */
 232     while(!(ret = _xcb_queue_dequeue(c->in.events)))
 233         if(!_xcb_conn_wait(c, /*should_write*/ 0, &c->in.event_cond))
 234             break;
 235
 236     wake_up_next_reader(c);
 237     pthread_mutex_unlock(&c->iolock);
 238
 239 #if XCBTRACEEVENT
 240     fprintf(stderr, "Leaving XCBWaitEvent, event type %d\n", ret ? ret->response_type : -1);
 241 #endif
 242
 243     return ret;
 244 }
 245
 246 XCBGenericEvent *XCBPollForEvent(XCBConnection *c, int *error)
 247 {
 248     XCBGenericEvent *ret = 0;
 249     pthread_mutex_lock(&c->iolock);
 250     if(error)
 251         *error = 0;
 252     /* FIXME: follow X meets Z architecture changes. */
 253     if(_xcb_in_read(c))
 254         ret = _xcb_queue_dequeue(c->in.events);
 255     else if(error)
 256         *error = -1;
 257     else
 258     {
 259         fprintf(stderr, "XCBPollForEvent: I/O error occured, but no handler provided.\n");
 260         abort();
 261     }
 262     pthread_mutex_unlock(&c->iolock);
 263     return ret;
 264 }
 265
 266 unsigned int XCBGetRequestRead(XCBConnection *c)
 267 {
 268     unsigned int ret;
 269     pthread_mutex_lock(&c->iolock);
 270     /* FIXME: follow X meets Z architecture changes. */
 271     _xcb_in_read(c);
 272     ret = c->in.request_read;
 273     pthread_mutex_unlock(&c->iolock);
 274     return ret;
 275 }
 276
 277 /* Private interface */
 278
 279 int _xcb_in_init(_xcb_in *in)
 280 {
 281     if(pthread_cond_init(&in->event_cond, 0))
 282         return 0;
 283     in->reading = 0;
 284
 285     in->queue_len = 0;
 286
 287     in->request_read = 0;
 288     in->current_reply = _xcb_queue_new();
 289
 290     in->replies = _xcb_map_new();
 291     in->events = _xcb_queue_new();
 292     in->readers = _xcb_list_new();
 293
 294     in->pending_replies = _xcb_queue_new();
 295     if(!in->current_reply || !in->replies || !in->events || !in->readers || !in->pending_replies)
 296         return 0;
 297
 298     return 1;
 299 }
 300
 301 void _xcb_in_destroy(_xcb_in *in)
 302 {
 303     pthread_cond_destroy(&in->event_cond);
 304     _xcb_queue_delete(in->current_reply, free);
 305     _xcb_map_delete(in->replies, free);
 306     _xcb_queue_delete(in->events, free);
 307     _xcb_list_delete(in->readers, 0);
 308     _xcb_queue_delete(in->pending_replies, free);
 309 }
 310
 311 int _xcb_in_expect_reply(XCBConnection *c, unsigned int request, enum workarounds workaround)
 312 {
 313     if(workaround != WORKAROUND_NONE)
 314     {
 315         pending_reply *pend = malloc(sizeof(pending_reply));
 316         if(!pend)
 317             return 0;
 318         pend->request = request;
 319         pend->workaround = workaround;
 320         if(!_xcb_queue_enqueue(c->in.pending_replies, pend))
 321         {
 322             free(pend);
 323             return 0;
 324         }
 325     }
 326     return 1;
 327 }
 328
 329 int _xcb_in_read(XCBConnection *c)
 330 {
 331     int n = read(c->fd, c->in.queue + c->in.queue_len, sizeof(c->in.queue) - c->in.queue_len);
 332     if(n > 0)
 333         c->in.queue_len += n;
 334     while(read_packet(c))
 335         /* empty */;
 336     return (n > 0) || (n < 0 && errno == EAGAIN);
 337 }
 338
 339 int _xcb_in_read_block(XCBConnection *c, void *buf, int len)
 340 {
 341     int done = c->in.queue_len;
 342     if(len < done)
 343         done = len;
 344
 345     memcpy(buf, c->in.queue, done);
 346     c->in.queue_len -= done;
 347     memmove(c->in.queue, c->in.queue + done, c->in.queue_len);
 348
 349     if(len > done)
 350     {
 351         int ret = _xcb_read_block(c->fd, (char *) buf + done, len - done);
 352         if(ret <= 0)
 353             return ret;
 354     }
 355
 356     return len;
 357 }