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. */
33 #include <sys/select.h>
44 XCBGenericEvent *event;
45 struct event_list *next;
50 struct reply_list *next;
53 typedef struct pending_reply {
55 enum workarounds workaround;
57 struct pending_reply *next;
60 typedef struct reader_list {
63 struct reader_list *next;
66 static void wake_up_next_reader(XCBConnection *c)
70 pthreadret = pthread_cond_signal(c->in.readers->data);
72 pthreadret = pthread_cond_signal(&c->in.event_cond);
73 assert(pthreadret == 0);
76 static int read_packet(XCBConnection *c)
81 pending_reply *pend = 0;
82 struct event_list *event;
84 /* Wait for there to be enough data for us to read a whole packet */
85 if(c->in.queue_len < length)
88 /* Get the response type, length, and sequence number. */
89 memcpy(&genrep, c->in.queue, sizeof(genrep));
91 /* Compute 32-bit sequence number of this packet. */
92 if((genrep.response_type & 0x7f) != XCBKeymapNotify)
94 unsigned int lastread = c->in.request_read;
95 c->in.request_read = (lastread & 0xffff0000) | genrep.sequence;
96 if(XCB_SEQUENCE_COMPARE(c->in.request_read, <, lastread))
97 c->in.request_read += 0x10000;
98 if(XCB_SEQUENCE_COMPARE(c->in.request_read, >, c->in.request_expected))
99 c->in.request_expected = c->in.request_read;
101 if(c->in.request_read != lastread)
103 if(c->in.current_reply)
105 _xcb_map_put(c->in.replies, lastread, c->in.current_reply);
106 c->in.current_reply = 0;
107 c->in.current_reply_tail = &c->in.current_reply;
109 c->in.request_completed = c->in.request_read - 1;
111 if(genrep.response_type == XCBError)
112 c->in.request_completed = c->in.request_read;
114 while(c->in.pending_replies &&
115 XCB_SEQUENCE_COMPARE (c->in.pending_replies->request, <=, c->in.request_completed))
117 pending_reply *oldpend = c->in.pending_replies;
118 c->in.pending_replies = oldpend->next;
120 c->in.pending_replies_tail = &c->in.pending_replies;
125 if(genrep.response_type == XCBError || genrep.response_type == XCBReply)
127 pend = c->in.pending_replies;
128 if(pend && pend->request != c->in.request_read)
132 /* For reply packets, check that the entire packet is available. */
133 if(genrep.response_type == XCBReply)
135 if(pend && pend->workaround == WORKAROUND_GLX_GET_FB_CONFIGS_BUG)
137 CARD32 *p = (CARD32 *) c->in.queue;
138 genrep.length = p[2] * p[3] * 2;
140 length += genrep.length * 4;
143 buf = malloc(length + (genrep.response_type == XCBReply ? 0 : sizeof(CARD32)));
146 if(_xcb_in_read_block(c, buf, length) <= 0)
151 if(pend && (pend->flags & XCB_REQUEST_DISCARD_REPLY))
157 if(genrep.response_type != XCBReply)
158 ((XCBGenericEvent *) buf)->full_sequence = c->in.request_read;
160 /* reply, or checked error */
161 if( genrep.response_type == XCBReply ||
162 (genrep.response_type == XCBError && pend && (pend->flags & XCB_REQUEST_CHECKED)))
165 struct reply_list *cur = malloc(sizeof(struct reply_list));
170 *c->in.current_reply_tail = cur;
171 c->in.current_reply_tail = &cur->next;
172 for(reader = c->in.readers;
174 XCB_SEQUENCE_COMPARE(reader->request, <=, c->in.request_read);
175 reader = reader->next)
177 if(reader->request == c->in.request_read)
179 pthread_cond_signal(reader->data);
186 /* event, or unchecked error */
187 event = malloc(sizeof(struct event_list));
195 *c->in.events_tail = event;
196 c->in.events_tail = &event->next;
197 pthread_cond_signal(&c->in.event_cond);
198 return 1; /* I have something for you... */
201 static XCBGenericEvent *get_event(XCBConnection *c)
203 struct event_list *cur = c->in.events;
204 XCBGenericEvent *ret;
208 c->in.events = cur->next;
210 c->in.events_tail = &c->in.events;
215 static void free_reply_list(struct reply_list *head)
219 struct reply_list *cur = head;
226 static int read_block(const int fd, void *buf, const size_t len)
231 int ret = read(fd, ((char *) buf) + done, len - done);
234 if(ret < 0 && errno == EAGAIN)
240 ret = select(fd + 1, &fds, 0, 0, 0);
241 } while (ret == -1 && errno == EINTR);
249 static int poll_for_reply(XCBConnection *c, unsigned int request, void **reply, XCBGenericError **error)
251 struct reply_list *head;
253 /* If an error occurred when issuing the request, fail immediately. */
256 /* We've read requests past the one we want, so if it has replies we have
257 * them all and they're in the replies map. */
258 else if(XCB_SEQUENCE_COMPARE(request, <, c->in.request_read))
260 head = _xcb_map_remove(c->in.replies, request);
261 if(head && head->next)
262 _xcb_map_put(c->in.replies, request, head->next);
264 /* We're currently processing the responses to the request we want, and we
265 * have a reply ready to return. So just return it without blocking. */
266 else if(request == c->in.request_read && c->in.current_reply)
268 head = c->in.current_reply;
269 c->in.current_reply = head->next;
271 c->in.current_reply_tail = &c->in.current_reply;
273 /* We know this request can't have any more replies, and we've already
274 * established it doesn't have a reply now. Don't bother blocking. */
275 else if(request == c->in.request_completed)
277 /* We may have more replies on the way for this request: block until we're
288 if(((XCBGenericRep *) head->reply)->response_type == XCBError)
291 *error = head->reply;
296 *reply = head->reply;
304 /* Public interface */
306 void *XCBWaitForReply(XCBConnection *c, unsigned int request, XCBGenericError **e)
312 pthread_mutex_lock(&c->iolock);
314 /* If this request has not been written yet, write it. */
315 if(_xcb_out_flush_to(c, request))
317 pthread_cond_t cond = PTHREAD_COND_INITIALIZER;
319 reader_list **prev_reader;
321 for(prev_reader = &c->in.readers;
323 XCB_SEQUENCE_COMPARE ((*prev_reader)->request, <=, request);
324 prev_reader = &(*prev_reader)->next)
328 reader.request = request;
330 reader.next = *prev_reader;
331 *prev_reader = &reader;
333 while(!poll_for_reply(c, request, &ret, e))
334 if(!_xcb_conn_wait(c, &cond, 0, 0))
337 for(prev_reader = &c->in.readers;
339 XCB_SEQUENCE_COMPARE((*prev_reader)->request, <=, request);
340 prev_reader = &(*prev_reader)->next)
342 if(*prev_reader == &reader)
344 *prev_reader = (*prev_reader)->next;
348 pthread_cond_destroy(&cond);
351 wake_up_next_reader(c);
352 pthread_mutex_unlock(&c->iolock);
356 int XCBPollForReply(XCBConnection *c, unsigned int request, void **reply, XCBGenericError **error)
360 pthread_mutex_lock(&c->iolock);
361 ret = poll_for_reply(c, request, reply, error);
362 pthread_mutex_unlock(&c->iolock);
366 XCBGenericEvent *XCBWaitForEvent(XCBConnection *c)
368 XCBGenericEvent *ret;
369 pthread_mutex_lock(&c->iolock);
370 /* get_event returns 0 on empty list. */
371 while(!(ret = get_event(c)))
372 if(!_xcb_conn_wait(c, &c->in.event_cond, 0, 0))
375 wake_up_next_reader(c);
376 pthread_mutex_unlock(&c->iolock);
380 XCBGenericEvent *XCBPollForEvent(XCBConnection *c, int *error)
382 XCBGenericEvent *ret = 0;
384 pthread_mutex_lock(&c->iolock);
385 /* FIXME: follow X meets Z architecture changes. */
386 success = _xcb_in_read(c);
389 pthread_mutex_unlock(&c->iolock);
400 fprintf(stderr, "XCBPollForEvent: I/O error occured, but no handler provided.\n");
406 XCBGenericError *XCBRequestCheck(XCBConnection *c, XCBVoidCookie cookie)
408 /* FIXME: this could hold the lock to avoid syncing unnecessarily, but
409 * that would require factoring the locking out of XCBGetInputFocus,
410 * XCBGetInputFocusReply, and XCBWaitForReply. */
411 XCBGenericError *ret;
413 if(XCB_SEQUENCE_COMPARE(cookie.sequence,>,c->in.request_expected)
414 && XCB_SEQUENCE_COMPARE(cookie.sequence,>,c->in.request_completed))
416 free(XCBGetInputFocusReply(c, XCBGetInputFocus(c), &ret));
419 reply = XCBWaitForReply(c, cookie.sequence, &ret);
424 /* Private interface */
426 int _xcb_in_init(_xcb_in *in)
428 if(pthread_cond_init(&in->event_cond, 0))
434 in->request_read = 0;
435 in->request_completed = 0;
437 in->replies = _xcb_map_new();
441 in->current_reply_tail = &in->current_reply;
442 in->events_tail = &in->events;
443 in->pending_replies_tail = &in->pending_replies;
448 void _xcb_in_destroy(_xcb_in *in)
450 pthread_cond_destroy(&in->event_cond);
451 free_reply_list(in->current_reply);
452 _xcb_map_delete(in->replies, (void (*)(void *)) free_reply_list);
455 struct event_list *e = in->events;
456 in->events = e->next;
460 while(in->pending_replies)
462 pending_reply *pend = in->pending_replies;
463 in->pending_replies = pend->next;
468 int _xcb_in_expect_reply(XCBConnection *c, unsigned int request, enum workarounds workaround, int flags)
470 pending_reply *pend = malloc(sizeof(pending_reply));
471 assert(workaround != WORKAROUND_NONE || flags != 0);
474 pend->request = request;
475 pend->workaround = workaround;
478 *c->in.pending_replies_tail = pend;
479 c->in.pending_replies_tail = &pend->next;
483 int _xcb_in_read(XCBConnection *c)
485 int n = read(c->fd, c->in.queue + c->in.queue_len, sizeof(c->in.queue) - c->in.queue_len);
487 c->in.queue_len += n;
488 while(read_packet(c))
490 return (n > 0) || (n < 0 && errno == EAGAIN);
493 int _xcb_in_read_block(XCBConnection *c, void *buf, int len)
495 int done = c->in.queue_len;
499 memcpy(buf, c->in.queue, done);
500 c->in.queue_len -= done;
501 memmove(c->in.queue, c->in.queue + done, c->in.queue_len);
505 int ret = read_block(c->fd, (char *) buf + done, len - done);