fix tiny memory leak in read_packet (leak only happens when malloc returns NULL so...
[free-sw/xcb/libxcb] / src / xcb_in.c
index 1f6dcbe..f613772 100644 (file)
 #include <stdlib.h>
 #include <unistd.h>
 #include <stdio.h>
+#include <sys/select.h>
 #include <errno.h>
 
 #include "xcb.h"
 #include "xcbext.h"
 #include "xcbint.h"
 
+#define XCB_ERROR 0
+#define XCB_REPLY 1
+#define XCB_XGE_EVENT 35
+
+struct event_list {
+    xcb_generic_event_t *event;
+    struct event_list *next;
+};
+
+struct reply_list {
+    void *reply;
+    struct reply_list *next;
+};
+
 typedef struct pending_reply {
     unsigned int request;
     enum workarounds workaround;
@@ -43,33 +58,30 @@ typedef struct pending_reply {
     struct pending_reply *next;
 } pending_reply;
 
-typedef struct XCBReplyData {
+typedef struct reader_list {
     unsigned int request;
-    void *data;
-} XCBReplyData;
+    pthread_cond_t *data;
+    struct reader_list *next;
+} reader_list;
 
-static int match_reply(const void *request, const void *data)
+static void wake_up_next_reader(xcb_connection_t *c)
 {
-    return ((XCBReplyData *) data)->request == *(unsigned int *) request;
-}
-
-static void wake_up_next_reader(XCBConnection *c)
-{
-    XCBReplyData *cur = _xcb_list_peek_head(c->in.readers);
     int pthreadret;
-    if(cur)
-        pthreadret = pthread_cond_signal(cur->data);
+    if(c->in.readers)
+        pthreadret = pthread_cond_signal(c->in.readers->data);
     else
         pthreadret = pthread_cond_signal(&c->in.event_cond);
     assert(pthreadret == 0);
 }
 
-static int read_packet(XCBConnection *c)
+static int read_packet(xcb_connection_t *c)
 {
-    XCBGenericRep genrep;
+    xcb_generic_reply_t genrep;
     int length = 32;
-    unsigned char *buf;
+    int eventlength = 0; /* length after first 32 bytes for GenericEvents */
+    void *buf;
     pending_reply *pend = 0;
+    struct event_list *event;
 
     /* Wait for there to be enough data for us to read a whole packet */
     if(c->in.queue_len < length)
@@ -79,31 +91,41 @@ static int read_packet(XCBConnection *c)
     memcpy(&genrep, c->in.queue, sizeof(genrep));
 
     /* Compute 32-bit sequence number of this packet. */
-    if((genrep.response_type & 0x7f) != KeymapNotify)
+    if((genrep.response_type & 0x7f) != XCB_KEYMAP_NOTIFY)
     {
-        int lastread = c->in.request_read;
+        unsigned int lastread = c->in.request_read;
         c->in.request_read = (lastread & 0xffff0000) | genrep.sequence;
+        if(XCB_SEQUENCE_COMPARE(c->in.request_read, <, lastread))
+            c->in.request_read += 0x10000;
+        if(XCB_SEQUENCE_COMPARE(c->in.request_read, >, c->in.request_expected))
+            c->in.request_expected = c->in.request_read;
+
         if(c->in.request_read != lastread)
         {
-            pending_reply *oldpend = c->in.pending_replies;
-            if(oldpend && oldpend->request == lastread)
-            {
-                c->in.pending_replies = oldpend->next;
-                if(!oldpend->next)
-                    c->in.pending_replies_tail = &c->in.pending_replies;
-                free(oldpend);
-            }
-            if(!_xcb_queue_is_empty(c->in.current_reply))
+            if(c->in.current_reply)
             {
                 _xcb_map_put(c->in.replies, lastread, c->in.current_reply);
-                c->in.current_reply = _xcb_queue_new();
+                c->in.current_reply = 0;
+                c->in.current_reply_tail = &c->in.current_reply;
             }
+            c->in.request_completed = c->in.request_read - 1;
         }
-        if(c->in.request_read < lastread)
-            c->in.request_read += 0x10000;
+
+        while(c->in.pending_replies && 
+             XCB_SEQUENCE_COMPARE (c->in.pending_replies->request, <=, c->in.request_completed))
+        {
+            pending_reply *oldpend = c->in.pending_replies;
+            c->in.pending_replies = oldpend->next;
+            if(!oldpend->next)
+                c->in.pending_replies_tail = &c->in.pending_replies;
+            free(oldpend);
+        }
+
+        if(genrep.response_type == XCB_ERROR)
+            c->in.request_completed = c->in.request_read;
     }
 
-    if(genrep.response_type == 0 || genrep.response_type == 1)
+    if(genrep.response_type == XCB_ERROR || genrep.response_type == XCB_REPLY)
     {
         pend = c->in.pending_replies;
         if(pend && pend->request != c->in.request_read)
@@ -111,42 +133,127 @@ static int read_packet(XCBConnection *c)
     }
 
     /* For reply packets, check that the entire packet is available. */
-    if(genrep.response_type == 1)
+    if(genrep.response_type == XCB_REPLY)
     {
         if(pend && pend->workaround == WORKAROUND_GLX_GET_FB_CONFIGS_BUG)
         {
-            CARD32 *p = (CARD32 *) c->in.queue;
+            uint32_t *p = (uint32_t *) c->in.queue;
             genrep.length = p[2] * p[3] * 2;
         }
         length += genrep.length * 4;
     }
 
-    buf = malloc(length);
+    /* XGE events may have sizes > 32 */
+    if (genrep.response_type == XCB_XGE_EVENT)
+    {
+        eventlength = ((xcb_ge_event_t*)&genrep)->length * 4;
+    }
+
+    buf = malloc(length + eventlength +
+            (genrep.response_type == XCB_REPLY ? 0 : sizeof(uint32_t)));
     if(!buf)
+    {
+        _xcb_conn_shutdown(c);
         return 0;
+    }
+
     if(_xcb_in_read_block(c, buf, length) <= 0)
     {
         free(buf);
         return 0;
     }
 
+    /* pull in XGE event data if available, append after event struct */
+    if (eventlength)
+    {
+        if(_xcb_in_read_block(c, &((xcb_generic_event_t*)buf)[1], eventlength) <= 0)
+        {
+            free(buf);
+            return 0;
+        }
+    }
+
+    if(pend && (pend->flags & XCB_REQUEST_DISCARD_REPLY))
+    {
+        free(buf);
+        return 1;
+    }
+
+    if(genrep.response_type != XCB_REPLY)
+        ((xcb_generic_event_t *) buf)->full_sequence = c->in.request_read;
+
     /* reply, or checked error */
-    if(genrep.response_type == 1 || (genrep.response_type == 0 && pend && (pend->flags & XCB_REQUEST_CHECKED)))
+    if( genrep.response_type == XCB_REPLY ||
+       (genrep.response_type == XCB_ERROR && pend && (pend->flags & XCB_REQUEST_CHECKED)))
     {
-        XCBReplyData *reader = _xcb_list_find(c->in.readers, match_reply, &c->in.request_read);
-        _xcb_queue_enqueue(c->in.current_reply, buf);
-        if(reader)
-            pthread_cond_signal(reader->data);
+        reader_list *reader;
+        struct reply_list *cur = malloc(sizeof(struct reply_list));
+        if(!cur)
+        {
+            _xcb_conn_shutdown(c);
+            free(buf);
+            return 0;
+        }
+        cur->reply = buf;
+        cur->next = 0;
+        *c->in.current_reply_tail = cur;
+        c->in.current_reply_tail = &cur->next;
+        for(reader = c->in.readers; 
+           reader && 
+           XCB_SEQUENCE_COMPARE(reader->request, <=, c->in.request_read);
+           reader = reader->next)
+       {
+            if(reader->request == c->in.request_read)
+            {
+                pthread_cond_signal(reader->data);
+                break;
+            }
+       }
         return 1;
     }
 
     /* event, or unchecked error */
-    _xcb_queue_enqueue(c->in.events, buf);
+    event = malloc(sizeof(struct event_list));
+    if(!event)
+    {
+        _xcb_conn_shutdown(c);
+        free(buf);
+        return 0;
+    }
+    event->event = buf;
+    event->next = 0;
+    *c->in.events_tail = event;
+    c->in.events_tail = &event->next;
     pthread_cond_signal(&c->in.event_cond);
     return 1; /* I have something for you... */
 }
 
-static int read_block(const int fd, void *buf, const size_t len)
+static xcb_generic_event_t *get_event(xcb_connection_t *c)
+{
+    struct event_list *cur = c->in.events;
+    xcb_generic_event_t *ret;
+    if(!c->in.events)
+        return 0;
+    ret = cur->event;
+    c->in.events = cur->next;
+    if(!cur->next)
+        c->in.events_tail = &c->in.events;
+    free(cur);
+    return ret;
+}
+
+static void free_reply_list(struct reply_list *head)
+{
+    while(head)
+    {
+        struct reply_list *cur = head;
+        head = cur->next;
+        free(cur->reply);
+        free(cur);
+    }
+}
+
+static int read_block(const int fd, void *buf, const ssize_t len)
 {
     int done = 0;
     while(done < len)
@@ -159,7 +266,9 @@ static int read_block(const int fd, void *buf, const size_t len)
             fd_set fds;
             FD_ZERO(&fds);
             FD_SET(fd, &fds);
-            ret = select(fd + 1, &fds, 0, 0, 0);
+           do {
+               ret = select(fd + 1, &fds, 0, 0, 0);
+           } while (ret == -1 && errno == EINTR);
         }
         if(ret <= 0)
             return ret;
@@ -167,115 +276,180 @@ static int read_block(const int fd, void *buf, const size_t len)
     return len;
 }
 
+static int poll_for_reply(xcb_connection_t *c, unsigned int request, void **reply, xcb_generic_error_t **error)
+{
+    struct reply_list *head;
+
+    /* If an error occurred when issuing the request, fail immediately. */
+    if(!request)
+        head = 0;
+    /* We've read requests past the one we want, so if it has replies we have
+     * them all and they're in the replies map. */
+    else if(XCB_SEQUENCE_COMPARE(request, <, c->in.request_read))
+    {
+        head = _xcb_map_remove(c->in.replies, request);
+        if(head && head->next)
+            _xcb_map_put(c->in.replies, request, head->next);
+    }
+    /* We're currently processing the responses to the request we want, and we
+     * have a reply ready to return. So just return it without blocking. */
+    else if(request == c->in.request_read && c->in.current_reply)
+    {
+        head = c->in.current_reply;
+        c->in.current_reply = head->next;
+        if(!head->next)
+            c->in.current_reply_tail = &c->in.current_reply;
+    }
+    /* We know this request can't have any more replies, and we've already
+     * established it doesn't have a reply now. Don't bother blocking. */
+    else if(request == c->in.request_completed)
+        head = 0;
+    /* We may have more replies on the way for this request: block until we're
+     * sure. */
+    else
+        return 0;
+
+    if(error)
+        *error = 0;
+    *reply = 0;
+
+    if(head)
+    {
+        if(((xcb_generic_reply_t *) head->reply)->response_type == XCB_ERROR)
+        {
+            if(error)
+                *error = head->reply;
+            else
+                free(head->reply);
+        }
+        else
+            *reply = head->reply;
+
+        free(head);
+    }
+
+    return 1;
+}
+
 /* Public interface */
 
-void *XCBWaitForReply(XCBConnection *c, unsigned int request, XCBGenericError **e)
+void *xcb_wait_for_reply(xcb_connection_t *c, unsigned int request, xcb_generic_error_t **e)
 {
-    pthread_cond_t cond = PTHREAD_COND_INITIALIZER;
-    XCBReplyData reader;
     void *ret = 0;
     if(e)
         *e = 0;
+    if(c->has_error)
+        return 0;
 
-    pthread_mutex_lock(&c->iolock);
+    _xcb_lock_io(c);
 
     /* If this request has not been written yet, write it. */
-    if((signed int) (c->out.request_written - request) < 0)
-        if(!_xcb_out_flush(c))
-            goto done; /* error */
-
-    if(_xcb_list_find(c->in.readers, match_reply, &request))
-        goto done; /* error */
-
-    reader.request = request;
-    reader.data = &cond;
-    _xcb_list_append(c->in.readers, &reader);
-
-    /* If this request has not been read yet, wait for it. */
-    while(((signed int) (c->in.request_read - request) < 0 ||
-            (c->in.request_read == request &&
-            _xcb_queue_is_empty(c->in.current_reply))))
-        if(!_xcb_conn_wait(c, /*should_write*/ 0, &cond))
-            goto done;
-
-    if(c->in.request_read != request)
+    if(_xcb_out_flush_to(c, request))
     {
-        _xcb_queue *q = _xcb_map_get(c->in.replies, request);
-        if(q)
-        {
-            ret = _xcb_queue_dequeue(q);
-            if(_xcb_queue_is_empty(q))
-                _xcb_queue_delete(_xcb_map_remove(c->in.replies, request), free);
-        }
-    }
-    else
-        ret = _xcb_queue_dequeue(c->in.current_reply);
-
-    if(ret && ((XCBGenericRep *) ret)->response_type == 0) /* X error */
-    {
-        if(e)
-            *e = ret;
-        else
-            free(ret);
-        ret = 0;
+        pthread_cond_t cond = PTHREAD_COND_INITIALIZER;
+        reader_list reader;
+        reader_list **prev_reader;
+
+        for(prev_reader = &c->in.readers; 
+           *prev_reader && 
+           XCB_SEQUENCE_COMPARE ((*prev_reader)->request, <=, request);
+           prev_reader = &(*prev_reader)->next)
+       {
+            /* empty */;
+       }
+        reader.request = request;
+        reader.data = &cond;
+        reader.next = *prev_reader;
+        *prev_reader = &reader;
+
+        while(!poll_for_reply(c, request, &ret, e))
+            if(!_xcb_conn_wait(c, &cond, 0, 0))
+                break;
+
+        for(prev_reader = &c->in.readers;
+           *prev_reader && 
+           XCB_SEQUENCE_COMPARE((*prev_reader)->request, <=, request);
+           prev_reader = &(*prev_reader)->next)
+       {
+            if(*prev_reader == &reader)
+            {
+                *prev_reader = (*prev_reader)->next;
+                break;
+            }
+       }
+        pthread_cond_destroy(&cond);
     }
 
-done:
-    _xcb_list_remove(c->in.readers, match_reply, &request);
-    pthread_cond_destroy(&cond);
-
     wake_up_next_reader(c);
-    pthread_mutex_unlock(&c->iolock);
+    _xcb_unlock_io(c);
     return ret;
 }
 
-XCBGenericEvent *XCBWaitEvent(XCBConnection *c)
+int xcb_poll_for_reply(xcb_connection_t *c, unsigned int request, void **reply, xcb_generic_error_t **error)
 {
-    return XCBWaitForEvent(c);
+    int ret;
+    if(c->has_error)
+    {
+        *reply = 0;
+        if(error)
+            *error = 0;
+        return 1; /* would not block */
+    }
+    assert(reply != 0);
+    _xcb_lock_io(c);
+    ret = poll_for_reply(c, request, reply, error);
+    _xcb_unlock_io(c);
+    return ret;
 }
 
-XCBGenericEvent *XCBWaitForEvent(XCBConnection *c)
+xcb_generic_event_t *xcb_wait_for_event(xcb_connection_t *c)
 {
-    XCBGenericEvent *ret;
-    pthread_mutex_lock(&c->iolock);
-    /* _xcb_list_remove_head returns 0 on empty list. */
-    while(!(ret = _xcb_queue_dequeue(c->in.events)))
-        if(!_xcb_conn_wait(c, /*should_write*/ 0, &c->in.event_cond))
+    xcb_generic_event_t *ret;
+    if(c->has_error)
+        return 0;
+    _xcb_lock_io(c);
+    /* get_event returns 0 on empty list. */
+    while(!(ret = get_event(c)))
+        if(!_xcb_conn_wait(c, &c->in.event_cond, 0, 0))
             break;
 
     wake_up_next_reader(c);
-    pthread_mutex_unlock(&c->iolock);
+    _xcb_unlock_io(c);
     return ret;
 }
 
-XCBGenericEvent *XCBPollForEvent(XCBConnection *c, int *error)
+xcb_generic_event_t *xcb_poll_for_event(xcb_connection_t *c)
 {
-    XCBGenericEvent *ret = 0;
-    pthread_mutex_lock(&c->iolock);
-    if(error)
-        *error = 0;
-    /* FIXME: follow X meets Z architecture changes. */
-    if(_xcb_in_read(c))
-        ret = _xcb_queue_dequeue(c->in.events);
-    else if(error)
-        *error = -1;
-    else
+    xcb_generic_event_t *ret = 0;
+    if(!c->has_error)
     {
-        fprintf(stderr, "XCBPollForEvent: I/O error occured, but no handler provided.\n");
-        abort();
+        _xcb_lock_io(c);
+        /* FIXME: follow X meets Z architecture changes. */
+        ret = get_event(c);
+        if(!ret && _xcb_in_read(c)) /* _xcb_in_read shuts down the connection on error */
+            ret = get_event(c);
+        _xcb_unlock_io(c);
     }
-    pthread_mutex_unlock(&c->iolock);
     return ret;
 }
 
-unsigned int XCBGetRequestRead(XCBConnection *c)
+xcb_generic_error_t *xcb_request_check(xcb_connection_t *c, xcb_void_cookie_t cookie)
 {
-    unsigned int ret;
-    pthread_mutex_lock(&c->iolock);
-    /* FIXME: follow X meets Z architecture changes. */
-    _xcb_in_read(c);
-    ret = c->in.request_read;
-    pthread_mutex_unlock(&c->iolock);
+    /* FIXME: this could hold the lock to avoid syncing unnecessarily, but
+     * that would require factoring the locking out of xcb_get_input_focus,
+     * xcb_get_input_focus_reply, and xcb_wait_for_reply. */
+    xcb_generic_error_t *ret;
+    void *reply;
+    if(c->has_error)
+        return 0;
+    if(XCB_SEQUENCE_COMPARE(cookie.sequence,>,c->in.request_expected)
+       && XCB_SEQUENCE_COMPARE(cookie.sequence,>,c->in.request_completed))
+    {
+        free(xcb_get_input_focus_reply(c, xcb_get_input_focus(c), &ret));
+        assert(!ret);
+    }
+    reply = xcb_wait_for_reply(c, cookie.sequence, &ret);
+    assert(!reply);
     return ret;
 }
 
@@ -290,14 +464,14 @@ int _xcb_in_init(_xcb_in *in)
     in->queue_len = 0;
 
     in->request_read = 0;
-    in->current_reply = _xcb_queue_new();
+    in->request_completed = 0;
 
     in->replies = _xcb_map_new();
-    in->events = _xcb_queue_new();
-    in->readers = _xcb_list_new();
-    if(!in->current_reply || !in->replies || !in->events || !in->readers)
+    if(!in->replies)
         return 0;
 
+    in->current_reply_tail = &in->current_reply;
+    in->events_tail = &in->events;
     in->pending_replies_tail = &in->pending_replies;
 
     return 1;
@@ -306,10 +480,15 @@ int _xcb_in_init(_xcb_in *in)
 void _xcb_in_destroy(_xcb_in *in)
 {
     pthread_cond_destroy(&in->event_cond);
-    _xcb_queue_delete(in->current_reply, free);
-    _xcb_map_delete(in->replies, free);
-    _xcb_queue_delete(in->events, free);
-    _xcb_list_delete(in->readers, 0);
+    free_reply_list(in->current_reply);
+    _xcb_map_delete(in->replies, (void (*)(void *)) free_reply_list);
+    while(in->events)
+    {
+        struct event_list *e = in->events;
+        in->events = e->next;
+        free(e->event);
+        free(e);
+    }
     while(in->pending_replies)
     {
         pending_reply *pend = in->pending_replies;
@@ -318,34 +497,38 @@ void _xcb_in_destroy(_xcb_in *in)
     }
 }
 
-int _xcb_in_expect_reply(XCBConnection *c, unsigned int request, enum workarounds workaround, int flags)
+int _xcb_in_expect_reply(xcb_connection_t *c, unsigned int request, enum workarounds workaround, int flags)
 {
-    if(workaround != WORKAROUND_NONE || flags != 0)
+    pending_reply *pend = malloc(sizeof(pending_reply));
+    assert(workaround != WORKAROUND_NONE || flags != 0);
+    if(!pend)
     {
-        pending_reply *pend = malloc(sizeof(pending_reply));
-        if(!pend)
-            return 0;
-        pend->request = request;
-        pend->workaround = workaround;
-        pend->flags = flags;
-        pend->next = 0;
-        *c->in.pending_replies_tail = pend;
-        c->in.pending_replies_tail = &pend->next;
+        _xcb_conn_shutdown(c);
+        return 0;
     }
+    pend->request = request;
+    pend->workaround = workaround;
+    pend->flags = flags;
+    pend->next = 0;
+    *c->in.pending_replies_tail = pend;
+    c->in.pending_replies_tail = &pend->next;
     return 1;
 }
 
-int _xcb_in_read(XCBConnection *c)
+int _xcb_in_read(xcb_connection_t *c)
 {
     int n = read(c->fd, c->in.queue + c->in.queue_len, sizeof(c->in.queue) - c->in.queue_len);
     if(n > 0)
         c->in.queue_len += n;
     while(read_packet(c))
         /* empty */;
-    return (n > 0) || (n < 0 && errno == EAGAIN);
+    if((n > 0) || (n < 0 && errno == EAGAIN))
+        return 1;
+    _xcb_conn_shutdown(c);
+    return 0;
 }
 
-int _xcb_in_read_block(XCBConnection *c, void *buf, int len)
+int _xcb_in_read_block(xcb_connection_t *c, void *buf, int len)
 {
     int done = c->in.queue_len;
     if(len < done)
@@ -359,7 +542,10 @@ int _xcb_in_read_block(XCBConnection *c, void *buf, int len)
     {
         int ret = read_block(c->fd, (char *) buf + done, len - done);
         if(ret <= 0)
+        {
+            _xcb_conn_shutdown(c);
             return ret;
+        }
     }
 
     return len;