1 /* Copyright (C) 2001-2004 Bart Massey and Jamey Sharp.
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:
10 * The above copyright notice and this permission notice shall be included in
11 * all copies or substantial portions of the Software.
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.
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.
26 /* Stuff that reads stuff from the server. */
46 #include <sys/select.h>
47 #include <sys/socket.h>
51 #include "xcb_windefs.h"
56 #define XCB_XGE_EVENT 35
59 xcb_generic_event_t *event;
60 struct event_list *next;
65 struct reply_list *next;
68 typedef struct pending_reply {
69 uint64_t first_request;
70 uint64_t last_request;
71 enum workarounds workaround;
73 struct pending_reply *next;
76 typedef struct reader_list {
79 struct reader_list *next;
82 static void remove_finished_readers(reader_list **prev_reader, uint64_t completed)
84 while(*prev_reader && XCB_SEQUENCE_COMPARE((*prev_reader)->request, <=, completed))
86 /* If you don't have what you're looking for now, you never
87 * will. Wake up and leave me alone. */
88 pthread_cond_signal((*prev_reader)->data);
89 *prev_reader = (*prev_reader)->next;
93 static int read_packet(xcb_connection_t *c)
95 xcb_generic_reply_t genrep;
97 int eventlength = 0; /* length after first 32 bytes for GenericEvents */
99 pending_reply *pend = 0;
100 struct event_list *event;
102 /* Wait for there to be enough data for us to read a whole packet */
103 if(c->in.queue_len < length)
106 /* Get the response type, length, and sequence number. */
107 memcpy(&genrep, c->in.queue, sizeof(genrep));
109 /* Compute 32-bit sequence number of this packet. */
110 if((genrep.response_type & 0x7f) != XCB_KEYMAP_NOTIFY)
112 uint64_t lastread = c->in.request_read;
113 c->in.request_read = (lastread & UINT64_C(0xffffffffffff0000)) | genrep.sequence;
114 if(XCB_SEQUENCE_COMPARE(c->in.request_read, <, lastread))
115 c->in.request_read += 0x10000;
116 if(XCB_SEQUENCE_COMPARE(c->in.request_read, >, c->in.request_expected))
117 c->in.request_expected = c->in.request_read;
119 if(c->in.request_read != lastread)
121 if(c->in.current_reply)
123 _xcb_map_put(c->in.replies, lastread, c->in.current_reply);
124 c->in.current_reply = 0;
125 c->in.current_reply_tail = &c->in.current_reply;
127 c->in.request_completed = c->in.request_read - 1;
130 while(c->in.pending_replies &&
131 c->in.pending_replies->workaround != WORKAROUND_EXTERNAL_SOCKET_OWNER &&
132 XCB_SEQUENCE_COMPARE (c->in.pending_replies->last_request, <=, c->in.request_completed))
134 pending_reply *oldpend = c->in.pending_replies;
135 c->in.pending_replies = oldpend->next;
137 c->in.pending_replies_tail = &c->in.pending_replies;
141 if(genrep.response_type == XCB_ERROR)
142 c->in.request_completed = c->in.request_read;
144 remove_finished_readers(&c->in.readers, c->in.request_completed);
147 if(genrep.response_type == XCB_ERROR || genrep.response_type == XCB_REPLY)
149 pend = c->in.pending_replies;
151 !(XCB_SEQUENCE_COMPARE(pend->first_request, <=, c->in.request_read) &&
152 (pend->workaround == WORKAROUND_EXTERNAL_SOCKET_OWNER ||
153 XCB_SEQUENCE_COMPARE(c->in.request_read, <=, pend->last_request))))
157 /* For reply packets, check that the entire packet is available. */
158 if(genrep.response_type == XCB_REPLY)
160 if(pend && pend->workaround == WORKAROUND_GLX_GET_FB_CONFIGS_BUG)
162 uint32_t *p = (uint32_t *) c->in.queue;
163 genrep.length = p[2] * p[3] * 2;
165 length += genrep.length * 4;
168 /* XGE events may have sizes > 32 */
169 if ((genrep.response_type & 0x7f) == XCB_XGE_EVENT)
170 eventlength = genrep.length * 4;
172 buf = malloc(length + eventlength +
173 (genrep.response_type == XCB_REPLY ? 0 : sizeof(uint32_t)));
176 _xcb_conn_shutdown(c, XCB_CONN_CLOSED_MEM_INSUFFICIENT);
180 if(_xcb_in_read_block(c, buf, length) <= 0)
186 /* pull in XGE event data if available, append after event struct */
189 if(_xcb_in_read_block(c, &((xcb_generic_event_t*)buf)[1], eventlength) <= 0)
196 if(pend && (pend->flags & XCB_REQUEST_DISCARD_REPLY))
202 if(genrep.response_type != XCB_REPLY)
203 ((xcb_generic_event_t *) buf)->full_sequence = c->in.request_read;
205 /* reply, or checked error */
206 if( genrep.response_type == XCB_REPLY ||
207 (genrep.response_type == XCB_ERROR && pend && (pend->flags & XCB_REQUEST_CHECKED)))
209 struct reply_list *cur = malloc(sizeof(struct reply_list));
212 _xcb_conn_shutdown(c, XCB_CONN_CLOSED_MEM_INSUFFICIENT);
218 *c->in.current_reply_tail = cur;
219 c->in.current_reply_tail = &cur->next;
220 if(c->in.readers && c->in.readers->request == c->in.request_read)
221 pthread_cond_signal(c->in.readers->data);
225 /* event, or unchecked error */
226 event = malloc(sizeof(struct event_list));
229 _xcb_conn_shutdown(c, XCB_CONN_CLOSED_MEM_INSUFFICIENT);
235 *c->in.events_tail = event;
236 c->in.events_tail = &event->next;
237 pthread_cond_signal(&c->in.event_cond);
238 return 1; /* I have something for you... */
241 static xcb_generic_event_t *get_event(xcb_connection_t *c)
243 struct event_list *cur = c->in.events;
244 xcb_generic_event_t *ret;
248 c->in.events = cur->next;
250 c->in.events_tail = &c->in.events;
255 static void free_reply_list(struct reply_list *head)
259 struct reply_list *cur = head;
266 static int read_block(const int fd, void *buf, const ssize_t len)
271 int ret = recv(fd, ((char *) buf) + done, len - done, 0);
275 if(ret < 0 && errno == EAGAIN)
277 if(ret == SOCKET_ERROR && WSAGetLastError() == WSAEWOULDBLOCK)
286 ret = poll(&pfd, 1, -1);
287 } while (ret == -1 && errno == EINTR);
293 /* Initializing errno here makes sure that for Win32 this loop will execute only once */
296 ret = select(fd + 1, &fds, 0, 0, 0);
297 } while (ret == -1 && errno == EINTR);
298 #endif /* USE_POLL */
306 static int poll_for_reply(xcb_connection_t *c, uint64_t request, void **reply, xcb_generic_error_t **error)
308 struct reply_list *head;
310 /* If an error occurred when issuing the request, fail immediately. */
313 /* We've read requests past the one we want, so if it has replies we have
314 * them all and they're in the replies map. */
315 else if(XCB_SEQUENCE_COMPARE(request, <, c->in.request_read))
317 head = _xcb_map_remove(c->in.replies, request);
318 if(head && head->next)
319 _xcb_map_put(c->in.replies, request, head->next);
321 /* We're currently processing the responses to the request we want, and we
322 * have a reply ready to return. So just return it without blocking. */
323 else if(request == c->in.request_read && c->in.current_reply)
325 head = c->in.current_reply;
326 c->in.current_reply = head->next;
328 c->in.current_reply_tail = &c->in.current_reply;
330 /* We know this request can't have any more replies, and we've already
331 * established it doesn't have a reply now. Don't bother blocking. */
332 else if(request == c->in.request_completed)
334 /* We may have more replies on the way for this request: block until we're
345 if(((xcb_generic_reply_t *) head->reply)->response_type == XCB_ERROR)
348 *error = head->reply;
353 *reply = head->reply;
361 static void insert_reader(reader_list **prev_reader, reader_list *reader, uint64_t request, pthread_cond_t *cond)
363 while(*prev_reader && XCB_SEQUENCE_COMPARE((*prev_reader)->request, <=, request))
364 prev_reader = &(*prev_reader)->next;
365 reader->request = request;
367 reader->next = *prev_reader;
368 *prev_reader = reader;
371 static void remove_reader(reader_list **prev_reader, reader_list *reader)
373 while(*prev_reader && XCB_SEQUENCE_COMPARE((*prev_reader)->request, <=, reader->request))
374 if(*prev_reader == reader)
376 *prev_reader = (*prev_reader)->next;
381 static void *wait_for_reply(xcb_connection_t *c, uint64_t request, xcb_generic_error_t **e)
385 /* If this request has not been written yet, write it. */
386 if(c->out.return_socket || _xcb_out_flush_to(c, request))
388 pthread_cond_t cond = PTHREAD_COND_INITIALIZER;
391 insert_reader(&c->in.readers, &reader, request, &cond);
393 while(!poll_for_reply(c, request, &ret, e))
394 if(!_xcb_conn_wait(c, &cond, 0, 0))
397 remove_reader(&c->in.readers, &reader);
398 pthread_cond_destroy(&cond);
401 _xcb_in_wake_up_next_reader(c);
405 static uint64_t widen(xcb_connection_t *c, unsigned int request)
407 uint64_t widened_request = (c->out.request & UINT64_C(0xffffffff00000000)) | request;
408 if(widened_request > c->out.request)
409 widened_request -= UINT64_C(1) << 32;
410 return widened_request;
413 /* Public interface */
415 void *xcb_wait_for_reply(xcb_connection_t *c, unsigned int request, xcb_generic_error_t **e)
423 pthread_mutex_lock(&c->iolock);
424 ret = wait_for_reply(c, widen(c, request), e);
425 pthread_mutex_unlock(&c->iolock);
429 static void insert_pending_discard(xcb_connection_t *c, pending_reply **prev_next, uint64_t seq)
432 pend = malloc(sizeof(*pend));
435 _xcb_conn_shutdown(c, XCB_CONN_CLOSED_MEM_INSUFFICIENT);
439 pend->first_request = seq;
440 pend->last_request = seq;
441 pend->workaround = 0;
442 pend->flags = XCB_REQUEST_DISCARD_REPLY;
443 pend->next = *prev_next;
447 c->in.pending_replies_tail = &pend->next;
450 static void discard_reply(xcb_connection_t *c, uint64_t request)
453 pending_reply **prev_pend;
455 /* Free any replies or errors that we've already read. Stop if
456 * xcb_wait_for_reply would block or we've run out of replies. */
457 while(poll_for_reply(c, request, &reply, 0) && reply)
460 /* If we've proven there are no more responses coming, we're done. */
461 if(XCB_SEQUENCE_COMPARE(request, <=, c->in.request_completed))
464 /* Walk the list of pending requests. Mark the first match for deletion. */
465 for(prev_pend = &c->in.pending_replies; *prev_pend; prev_pend = &(*prev_pend)->next)
467 if(XCB_SEQUENCE_COMPARE((*prev_pend)->first_request, >, request))
470 if((*prev_pend)->first_request == request)
472 /* Pending reply found. Mark for discard: */
473 (*prev_pend)->flags |= XCB_REQUEST_DISCARD_REPLY;
478 /* Pending reply not found (likely due to _unchecked request). Create one: */
479 insert_pending_discard(c, prev_pend, request);
482 void xcb_discard_reply(xcb_connection_t *c, unsigned int sequence)
487 /* If an error occurred when issuing the request, fail immediately. */
491 pthread_mutex_lock(&c->iolock);
492 discard_reply(c, widen(c, sequence));
493 pthread_mutex_unlock(&c->iolock);
496 int xcb_poll_for_reply(xcb_connection_t *c, unsigned int request, void **reply, xcb_generic_error_t **error)
504 return 1; /* would not block */
507 pthread_mutex_lock(&c->iolock);
508 ret = poll_for_reply(c, widen(c, request), reply, error);
509 pthread_mutex_unlock(&c->iolock);
513 xcb_generic_event_t *xcb_wait_for_event(xcb_connection_t *c)
515 xcb_generic_event_t *ret;
518 pthread_mutex_lock(&c->iolock);
519 /* get_event returns 0 on empty list. */
520 while(!(ret = get_event(c)))
521 if(!_xcb_conn_wait(c, &c->in.event_cond, 0, 0))
524 _xcb_in_wake_up_next_reader(c);
525 pthread_mutex_unlock(&c->iolock);
529 static xcb_generic_event_t *poll_for_next_event(xcb_connection_t *c, int queued)
531 xcb_generic_event_t *ret = 0;
534 pthread_mutex_lock(&c->iolock);
535 /* FIXME: follow X meets Z architecture changes. */
537 if(!ret && !queued && c->in.reading == 0 && _xcb_in_read(c)) /* _xcb_in_read shuts down the connection on error */
539 pthread_mutex_unlock(&c->iolock);
544 xcb_generic_event_t *xcb_poll_for_event(xcb_connection_t *c)
546 return poll_for_next_event(c, 0);
549 xcb_generic_event_t *xcb_poll_for_queued_event(xcb_connection_t *c)
551 return poll_for_next_event(c, 1);
554 xcb_generic_error_t *xcb_request_check(xcb_connection_t *c, xcb_void_cookie_t cookie)
557 xcb_generic_error_t *ret = 0;
561 pthread_mutex_lock(&c->iolock);
562 request = widen(c, cookie.sequence);
563 if(XCB_SEQUENCE_COMPARE(request, >=, c->in.request_expected)
564 && XCB_SEQUENCE_COMPARE(request, >, c->in.request_completed))
566 _xcb_out_send_sync(c);
567 _xcb_out_flush_to(c, c->out.request);
569 reply = wait_for_reply(c, request, &ret);
571 pthread_mutex_unlock(&c->iolock);
575 /* Private interface */
577 int _xcb_in_init(_xcb_in *in)
579 if(pthread_cond_init(&in->event_cond, 0))
585 in->request_read = 0;
586 in->request_completed = 0;
588 in->replies = _xcb_map_new();
592 in->current_reply_tail = &in->current_reply;
593 in->events_tail = &in->events;
594 in->pending_replies_tail = &in->pending_replies;
599 void _xcb_in_destroy(_xcb_in *in)
601 pthread_cond_destroy(&in->event_cond);
602 free_reply_list(in->current_reply);
603 _xcb_map_delete(in->replies, (void (*)(void *)) free_reply_list);
606 struct event_list *e = in->events;
607 in->events = e->next;
611 while(in->pending_replies)
613 pending_reply *pend = in->pending_replies;
614 in->pending_replies = pend->next;
619 void _xcb_in_wake_up_next_reader(xcb_connection_t *c)
623 pthreadret = pthread_cond_signal(c->in.readers->data);
625 pthreadret = pthread_cond_signal(&c->in.event_cond);
626 assert(pthreadret == 0);
629 int _xcb_in_expect_reply(xcb_connection_t *c, uint64_t request, enum workarounds workaround, int flags)
631 pending_reply *pend = malloc(sizeof(pending_reply));
632 assert(workaround != WORKAROUND_NONE || flags != 0);
635 _xcb_conn_shutdown(c, XCB_CONN_CLOSED_MEM_INSUFFICIENT);
638 pend->first_request = pend->last_request = request;
639 pend->workaround = workaround;
642 *c->in.pending_replies_tail = pend;
643 c->in.pending_replies_tail = &pend->next;
647 void _xcb_in_replies_done(xcb_connection_t *c)
649 struct pending_reply *pend;
650 if (c->in.pending_replies_tail != &c->in.pending_replies)
652 pend = container_of(c->in.pending_replies_tail, struct pending_reply, next);
653 if(pend->workaround == WORKAROUND_EXTERNAL_SOCKET_OWNER)
655 pend->last_request = c->out.request;
656 pend->workaround = WORKAROUND_NONE;
661 int _xcb_in_read(xcb_connection_t *c)
663 int n = recv(c->fd, c->in.queue + c->in.queue_len, sizeof(c->in.queue) - c->in.queue_len, 0);
665 c->in.queue_len += n;
666 while(read_packet(c))
669 if((n > 0) || (n < 0 && errno == EAGAIN))
671 if((n > 0) || (n < 0 && WSAGetLastError() == WSAEWOULDBLOCK))
674 _xcb_conn_shutdown(c, XCB_CONN_ERROR);
678 int _xcb_in_read_block(xcb_connection_t *c, void *buf, int len)
680 int done = c->in.queue_len;
684 memcpy(buf, c->in.queue, done);
685 c->in.queue_len -= done;
686 memmove(c->in.queue, c->in.queue + done, c->in.queue_len);
690 int ret = read_block(c->fd, (char *) buf + done, len - done);
693 _xcb_conn_shutdown(c, XCB_CONN_ERROR);