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. */
42 #include <sys/select.h>
43 #include <sys/socket.h>
47 #include "xcb_windefs.h"
52 #define XCB_XGE_EVENT 35
54 /* required for compiling for Win32 using MinGW */
61 xcb_generic_event_t *event;
62 struct event_list *next;
67 struct reply_list *next;
70 typedef struct pending_reply {
71 uint64_t first_request;
72 uint64_t last_request;
73 enum workarounds workaround;
75 struct pending_reply *next;
78 typedef struct reader_list {
81 struct reader_list *next;
84 static void remove_finished_readers(reader_list **prev_reader, uint64_t completed)
86 while(*prev_reader && XCB_SEQUENCE_COMPARE((*prev_reader)->request, <=, completed))
88 /* If you don't have what you're looking for now, you never
89 * will. Wake up and leave me alone. */
90 pthread_cond_signal((*prev_reader)->data);
91 *prev_reader = (*prev_reader)->next;
95 static int read_packet(xcb_connection_t *c)
97 xcb_generic_reply_t genrep;
99 int eventlength = 0; /* length after first 32 bytes for GenericEvents */
101 pending_reply *pend = 0;
102 struct event_list *event;
104 /* Wait for there to be enough data for us to read a whole packet */
105 if(c->in.queue_len < length)
108 /* Get the response type, length, and sequence number. */
109 memcpy(&genrep, c->in.queue, sizeof(genrep));
111 /* Compute 32-bit sequence number of this packet. */
112 if((genrep.response_type & 0x7f) != XCB_KEYMAP_NOTIFY)
114 uint64_t lastread = c->in.request_read;
115 c->in.request_read = (lastread & UINT64_C(0xffffffffffff0000)) | genrep.sequence;
116 if(XCB_SEQUENCE_COMPARE(c->in.request_read, <, lastread))
117 c->in.request_read += 0x10000;
118 if(XCB_SEQUENCE_COMPARE(c->in.request_read, >, c->in.request_expected))
119 c->in.request_expected = c->in.request_read;
121 if(c->in.request_read != lastread)
123 if(c->in.current_reply)
125 _xcb_map_put(c->in.replies, lastread, c->in.current_reply);
126 c->in.current_reply = 0;
127 c->in.current_reply_tail = &c->in.current_reply;
129 c->in.request_completed = c->in.event_responses_completed = c->in.request_read - 1;
132 while(c->in.pending_replies &&
133 c->in.pending_replies->workaround != WORKAROUND_EXTERNAL_SOCKET_OWNER &&
134 XCB_SEQUENCE_COMPARE (c->in.pending_replies->last_request, <=, c->in.request_completed))
136 pending_reply *oldpend = c->in.pending_replies;
137 c->in.pending_replies = oldpend->next;
139 c->in.pending_replies_tail = &c->in.pending_replies;
143 if(genrep.response_type == XCB_ERROR)
144 c->in.request_completed = c->in.event_responses_completed = c->in.request_read;
145 else if(genrep.response_type == XCB_REPLY)
146 c->in.event_responses_completed = c->in.request_read;
148 remove_finished_readers(&c->in.readers, c->in.request_completed);
149 remove_finished_readers(&c->in.event_readers, c->in.event_responses_completed);
152 if(genrep.response_type == XCB_ERROR || genrep.response_type == XCB_REPLY)
154 pend = c->in.pending_replies;
156 !(XCB_SEQUENCE_COMPARE(pend->first_request, <=, c->in.request_read) &&
157 (pend->workaround == WORKAROUND_EXTERNAL_SOCKET_OWNER ||
158 XCB_SEQUENCE_COMPARE(c->in.request_read, <=, pend->last_request))))
162 /* For reply packets, check that the entire packet is available. */
163 if(genrep.response_type == XCB_REPLY)
165 if(pend && pend->workaround == WORKAROUND_GLX_GET_FB_CONFIGS_BUG)
167 uint32_t *p = (uint32_t *) c->in.queue;
168 genrep.length = p[2] * p[3] * 2;
170 length += genrep.length * 4;
173 /* XGE events may have sizes > 32 */
174 if (genrep.response_type == XCB_XGE_EVENT)
175 eventlength = genrep.length * 4;
177 buf = malloc(length + eventlength +
178 (genrep.response_type == XCB_REPLY ? 0 : sizeof(uint32_t)));
181 _xcb_conn_shutdown(c);
185 if(_xcb_in_read_block(c, buf, length) <= 0)
191 /* pull in XGE event data if available, append after event struct */
194 if(_xcb_in_read_block(c, &((xcb_generic_event_t*)buf)[1], eventlength) <= 0)
201 if(pend && (pend->flags & XCB_REQUEST_DISCARD_REPLY))
207 if(genrep.response_type != XCB_REPLY)
208 ((xcb_generic_event_t *) buf)->full_sequence = c->in.request_read;
210 /* reply, or checked error */
211 if( genrep.response_type == XCB_REPLY ||
212 (genrep.response_type == XCB_ERROR && pend && (pend->flags & XCB_REQUEST_CHECKED)))
214 struct reply_list *cur = malloc(sizeof(struct reply_list));
217 _xcb_conn_shutdown(c);
223 *c->in.current_reply_tail = cur;
224 c->in.current_reply_tail = &cur->next;
225 if(c->in.readers && c->in.readers->request == c->in.request_read)
226 pthread_cond_signal(c->in.readers->data);
230 /* event, or unchecked error */
231 event = malloc(sizeof(struct event_list));
234 _xcb_conn_shutdown(c);
238 event->sequence = c->in.request_read;
241 *c->in.events_tail = event;
242 c->in.events_tail = &event->next;
243 if(c->in.event_readers)
244 pthread_cond_signal(c->in.event_readers->data);
246 pthread_cond_signal(&c->in.event_cond);
247 return 1; /* I have something for you... */
250 static xcb_generic_event_t *get_event(xcb_connection_t *c)
252 struct event_list *cur = c->in.events;
253 xcb_generic_event_t *ret;
257 c->in.events = cur->next;
259 c->in.events_tail = &c->in.events;
264 static void free_reply_list(struct reply_list *head)
268 struct reply_list *cur = head;
275 static int read_block(const int fd, void *buf, const ssize_t len)
280 int ret = recv(fd, ((char *) buf) + done, len - done,MSG_WAITALL);
284 if(ret < 0 && errno == EAGAIN)
286 if(ret == SOCKET_ERROR && WSAGetLastError() == WSAEWOULDBLOCK)
295 ret = poll(&pfd, 1, -1);
296 } while (ret == -1 && errno == EINTR);
302 /* Initializing errno here makes sure that for Win32 this loop will execute only once */
305 ret = select(fd + 1, &fds, 0, 0, 0);
306 } while (ret == -1 && errno == EINTR);
307 #endif /* USE_POLL */
315 static int poll_for_reply(xcb_connection_t *c, uint64_t request, void **reply, xcb_generic_error_t **error)
317 struct reply_list *head;
319 /* If an error occurred when issuing the request, fail immediately. */
322 /* We've read requests past the one we want, so if it has replies we have
323 * them all and they're in the replies map. */
324 else if(XCB_SEQUENCE_COMPARE(request, <, c->in.request_read))
326 head = _xcb_map_remove(c->in.replies, request);
327 if(head && head->next)
328 _xcb_map_put(c->in.replies, request, head->next);
330 /* We're currently processing the responses to the request we want, and we
331 * have a reply ready to return. So just return it without blocking. */
332 else if(request == c->in.request_read && c->in.current_reply)
334 head = c->in.current_reply;
335 c->in.current_reply = head->next;
337 c->in.current_reply_tail = &c->in.current_reply;
339 /* We know this request can't have any more replies, and we've already
340 * established it doesn't have a reply now. Don't bother blocking. */
341 else if(request == c->in.request_completed)
343 /* We may have more replies on the way for this request: block until we're
354 if(((xcb_generic_reply_t *) head->reply)->response_type == XCB_ERROR)
357 *error = head->reply;
362 *reply = head->reply;
370 static void insert_reader(reader_list **prev_reader, reader_list *reader, uint64_t request, pthread_cond_t *cond)
372 while(*prev_reader && XCB_SEQUENCE_COMPARE((*prev_reader)->request, <=, request))
373 prev_reader = &(*prev_reader)->next;
374 reader->request = request;
376 reader->next = *prev_reader;
377 *prev_reader = reader;
380 static void remove_reader(reader_list **prev_reader, reader_list *reader)
382 while(*prev_reader && XCB_SEQUENCE_COMPARE((*prev_reader)->request, <=, reader->request))
383 if(*prev_reader == reader)
385 *prev_reader = (*prev_reader)->next;
390 static void *wait_for_reply(xcb_connection_t *c, uint64_t request, xcb_generic_error_t **e)
394 /* If this request has not been written yet, write it. */
395 if(c->out.return_socket || _xcb_out_flush_to(c, request))
397 pthread_cond_t cond = PTHREAD_COND_INITIALIZER;
400 insert_reader(&c->in.readers, &reader, request, &cond);
402 while(!poll_for_reply(c, request, &ret, e))
403 if(!_xcb_conn_wait(c, &cond, 0, 0))
406 remove_reader(&c->in.readers, &reader);
407 pthread_cond_destroy(&cond);
410 _xcb_in_wake_up_next_reader(c);
414 static uint64_t widen(xcb_connection_t *c, unsigned int request)
416 uint64_t widened_request = (c->out.request & UINT64_C(0xffffffff00000000)) | request;
417 if(widened_request > c->out.request)
418 widened_request -= UINT64_C(1) << 32;
419 return widened_request;
422 /* Public interface */
424 void *xcb_wait_for_reply(xcb_connection_t *c, unsigned int request, xcb_generic_error_t **e)
432 pthread_mutex_lock(&c->iolock);
433 ret = wait_for_reply(c, widen(c, request), e);
434 pthread_mutex_unlock(&c->iolock);
438 static void insert_pending_discard(xcb_connection_t *c, pending_reply **prev_next, uint64_t seq)
441 pend = malloc(sizeof(*pend));
444 _xcb_conn_shutdown(c);
448 pend->first_request = seq;
449 pend->last_request = seq;
450 pend->workaround = 0;
451 pend->flags = XCB_REQUEST_DISCARD_REPLY;
452 pend->next = *prev_next;
456 c->in.pending_replies_tail = &pend->next;
459 static void discard_reply(xcb_connection_t *c, uint64_t request)
462 pending_reply **prev_pend;
464 /* Free any replies or errors that we've already read. Stop if
465 * xcb_wait_for_reply would block or we've run out of replies. */
466 while(poll_for_reply(c, request, &reply, 0) && reply)
469 /* If we've proven there are no more responses coming, we're done. */
470 if(XCB_SEQUENCE_COMPARE(request, <=, c->in.request_completed))
473 /* Walk the list of pending requests. Mark the first match for deletion. */
474 for(prev_pend = &c->in.pending_replies; *prev_pend; prev_pend = &(*prev_pend)->next)
476 if(XCB_SEQUENCE_COMPARE((*prev_pend)->first_request, >, request))
479 if((*prev_pend)->first_request == request)
481 /* Pending reply found. Mark for discard: */
482 (*prev_pend)->flags |= XCB_REQUEST_DISCARD_REPLY;
487 /* Pending reply not found (likely due to _unchecked request). Create one: */
488 insert_pending_discard(c, prev_pend, request);
491 void xcb_discard_reply(xcb_connection_t *c, unsigned int sequence)
496 /* If an error occurred when issuing the request, fail immediately. */
500 pthread_mutex_lock(&c->iolock);
501 discard_reply(c, widen(c, sequence));
502 pthread_mutex_unlock(&c->iolock);
505 int xcb_poll_for_reply(xcb_connection_t *c, unsigned int request, void **reply, xcb_generic_error_t **error)
513 return 1; /* would not block */
516 pthread_mutex_lock(&c->iolock);
517 ret = poll_for_reply(c, widen(c, request), reply, error);
518 pthread_mutex_unlock(&c->iolock);
522 xcb_generic_event_t *xcb_wait_for_event(xcb_connection_t *c)
524 xcb_generic_event_t *ret;
527 pthread_mutex_lock(&c->iolock);
528 /* get_event returns 0 on empty list. */
529 while(!(ret = get_event(c)))
530 if(!_xcb_conn_wait(c, &c->in.event_cond, 0, 0))
533 _xcb_in_wake_up_next_reader(c);
534 pthread_mutex_unlock(&c->iolock);
538 xcb_generic_event_t *xcb_poll_for_event(xcb_connection_t *c)
540 xcb_generic_event_t *ret = 0;
543 pthread_mutex_lock(&c->iolock);
544 /* FIXME: follow X meets Z architecture changes. */
546 if(!ret && _xcb_in_read(c)) /* _xcb_in_read shuts down the connection on error */
548 pthread_mutex_unlock(&c->iolock);
553 static xcb_generic_event_t *get_event_until(xcb_connection_t *c, uint64_t request)
555 if(c->in.events && XCB_SEQUENCE_COMPARE(c->in.events->sequence, <=, request))
560 xcb_generic_event_t *xcb_wait_for_event_until(xcb_connection_t *c, unsigned int request)
562 pthread_cond_t cond = PTHREAD_COND_INITIALIZER;
564 xcb_generic_event_t *ret;
567 pthread_mutex_lock(&c->iolock);
569 insert_reader(&c->in.event_readers, &reader, widen(c, request), &cond);
571 while(!(ret = get_event_until(c, reader.request)) && XCB_SEQUENCE_COMPARE(c->in.event_responses_completed, <, reader.request))
572 if(!_xcb_conn_wait(c, &cond, 0, 0))
575 remove_reader(&c->in.event_readers, &reader);
576 pthread_cond_destroy(&cond);
577 _xcb_in_wake_up_next_reader(c);
578 pthread_mutex_unlock(&c->iolock);
582 xcb_generic_error_t *xcb_request_check(xcb_connection_t *c, xcb_void_cookie_t cookie)
585 xcb_generic_error_t *ret = 0;
589 pthread_mutex_lock(&c->iolock);
590 request = widen(c, cookie.sequence);
591 if(XCB_SEQUENCE_COMPARE(request, >=, c->in.request_expected)
592 && XCB_SEQUENCE_COMPARE(request, >, c->in.request_completed))
594 _xcb_out_send_sync(c);
595 _xcb_out_flush_to(c, c->out.request);
597 reply = wait_for_reply(c, request, &ret);
599 pthread_mutex_unlock(&c->iolock);
603 /* Private interface */
605 int _xcb_in_init(_xcb_in *in)
607 if(pthread_cond_init(&in->event_cond, 0))
613 in->request_read = 0;
614 in->request_completed = 0;
616 in->replies = _xcb_map_new();
620 in->current_reply_tail = &in->current_reply;
621 in->events_tail = &in->events;
622 in->pending_replies_tail = &in->pending_replies;
627 void _xcb_in_destroy(_xcb_in *in)
629 pthread_cond_destroy(&in->event_cond);
630 free_reply_list(in->current_reply);
631 _xcb_map_delete(in->replies, (void (*)(void *)) free_reply_list);
634 struct event_list *e = in->events;
635 in->events = e->next;
639 while(in->pending_replies)
641 pending_reply *pend = in->pending_replies;
642 in->pending_replies = pend->next;
647 void _xcb_in_wake_up_next_reader(xcb_connection_t *c)
651 pthreadret = pthread_cond_signal(c->in.readers->data);
652 else if(c->in.event_readers)
653 pthreadret = pthread_cond_signal(c->in.event_readers->data);
655 pthreadret = pthread_cond_signal(&c->in.event_cond);
656 assert(pthreadret == 0);
659 int _xcb_in_expect_reply(xcb_connection_t *c, uint64_t request, enum workarounds workaround, int flags)
661 pending_reply *pend = malloc(sizeof(pending_reply));
662 assert(workaround != WORKAROUND_NONE || flags != 0);
665 _xcb_conn_shutdown(c);
668 pend->first_request = pend->last_request = request;
669 pend->workaround = workaround;
672 *c->in.pending_replies_tail = pend;
673 c->in.pending_replies_tail = &pend->next;
677 void _xcb_in_replies_done(xcb_connection_t *c)
679 struct pending_reply *pend;
680 if (c->in.pending_replies_tail != &c->in.pending_replies)
682 pend = container_of(c->in.pending_replies_tail, struct pending_reply, next);
683 if(pend->workaround == WORKAROUND_EXTERNAL_SOCKET_OWNER)
685 pend->last_request = c->out.request;
686 pend->workaround = WORKAROUND_NONE;
691 int _xcb_in_read(xcb_connection_t *c)
693 int n = recv(c->fd, c->in.queue + c->in.queue_len, sizeof(c->in.queue) - c->in.queue_len,MSG_WAITALL);
695 c->in.queue_len += n;
696 while(read_packet(c))
699 if((n > 0) || (n < 0 && errno == EAGAIN))
701 if((n > 0) || (n < 0 && WSAGetLastError() == WSAEWOULDBLOCK))
704 _xcb_conn_shutdown(c);
708 int _xcb_in_read_block(xcb_connection_t *c, void *buf, int len)
710 int done = c->in.queue_len;
714 memcpy(buf, c->in.queue, done);
715 c->in.queue_len -= done;
716 memmove(c->in.queue, c->in.queue + done, c->in.queue_len);
720 int ret = read_block(c->fd, (char *) buf + done, len - done);
723 _xcb_conn_shutdown(c);