xcb_io.c revision 2d67cb4f
11ab64890Smrg/* Copyright (C) 2003-2006 Jamey Sharp, Josh Triplett 21ab64890Smrg * This file is licensed under the MIT license. See the file COPYING. */ 31ab64890Smrg 4b4ee4795Smrg#ifdef HAVE_CONFIG_H 5b4ee4795Smrg#include <config.h> 6b4ee4795Smrg#endif 7b4ee4795Smrg 81ab64890Smrg#include "Xlibint.h" 91ab64890Smrg#include "locking.h" 1061b2299dSmrg#include "Xprivate.h" 111ab64890Smrg#include "Xxcbint.h" 121ab64890Smrg#include <xcb/xcbext.h> 131ab64890Smrg 141ab64890Smrg#include <assert.h> 1588de56ccSmrg#ifdef HAVE_INTTYPES_H 1661b2299dSmrg#include <inttypes.h> 1788de56ccSmrg#endif 186cc2b21fSmrg#include <stdio.h> 1961b2299dSmrg#include <stdint.h> 201ab64890Smrg#include <stdlib.h> 211ab64890Smrg#include <string.h> 22eb411b4bSmrg#include <limits.h> 23b4ee4795Smrg#ifdef HAVE_SYS_SELECT_H 24b4ee4795Smrg#include <sys/select.h> 25b4ee4795Smrg#endif 261ab64890Smrg 276cc2b21fSmrg#define xcb_fail_assert(_message, _var) { \ 286cc2b21fSmrg unsigned int _var = 1; \ 296cc2b21fSmrg fprintf(stderr, "[xcb] Aborting, sorry about that.\n"); \ 306cc2b21fSmrg assert(!_var); \ 316cc2b21fSmrg} 326cc2b21fSmrg 336cc2b21fSmrg#define throw_thread_fail_assert(_message, _var) { \ 346cc2b21fSmrg fprintf(stderr, "[xcb] " _message "\n"); \ 356cc2b21fSmrg fprintf(stderr, "[xcb] Most likely this is a multi-threaded client " \ 366cc2b21fSmrg "and XInitThreads has not been called\n"); \ 376cc2b21fSmrg xcb_fail_assert(_message, _var); \ 386cc2b21fSmrg} 396cc2b21fSmrg 406cc2b21fSmrg/* XXX: It would probably be most useful if we stored the last-processed 416cc2b21fSmrg * request, so we could find the offender from the message. */ 426cc2b21fSmrg#define throw_extlib_fail_assert(_message, _var) { \ 436cc2b21fSmrg fprintf(stderr, "[xcb] " _message "\n"); \ 446cc2b21fSmrg fprintf(stderr, "[xcb] This is most likely caused by a broken X " \ 456cc2b21fSmrg "extension library\n"); \ 466cc2b21fSmrg xcb_fail_assert(_message, _var); \ 476cc2b21fSmrg} 486cc2b21fSmrg 4961b2299dSmrgstatic void return_socket(void *closure) 5061b2299dSmrg{ 5161b2299dSmrg Display *dpy = closure; 5288de56ccSmrg InternalLockDisplay(dpy, /* don't skip user locks */ 0); 5361b2299dSmrg _XSend(dpy, NULL, 0); 5461b2299dSmrg dpy->bufmax = dpy->buffer; 5561b2299dSmrg UnlockDisplay(dpy); 5661b2299dSmrg} 5761b2299dSmrg 5861b2299dSmrgstatic void require_socket(Display *dpy) 5961b2299dSmrg{ 6061b2299dSmrg if(dpy->bufmax == dpy->buffer) 6161b2299dSmrg { 6261b2299dSmrg uint64_t sent; 6361b2299dSmrg int flags = 0; 6461b2299dSmrg /* if we don't own the event queue, we have to ask XCB 6561b2299dSmrg * to set our errors aside for us. */ 6661b2299dSmrg if(dpy->xcb->event_owner != XlibOwnsEventQueue) 6761b2299dSmrg flags = XCB_REQUEST_CHECKED; 6861b2299dSmrg if(!xcb_take_socket(dpy->xcb->connection, return_socket, dpy, 6961b2299dSmrg flags, &sent)) 7061b2299dSmrg _XIOError(dpy); 712d67cb4fSmrg dpy->xcb->last_flushed = sent; 722d67cb4fSmrg X_DPY_SET_REQUEST(dpy, sent); 7361b2299dSmrg dpy->bufmax = dpy->xcb->real_bufmax; 7461b2299dSmrg } 7561b2299dSmrg} 7661b2299dSmrg 771ab64890Smrg/* Call internal connection callbacks for any fds that are currently 781ab64890Smrg * ready to read. This function will not block unless one of the 791ab64890Smrg * callbacks blocks. 801ab64890Smrg * 811ab64890Smrg * This code borrowed from _XWaitForReadable. Inverse call tree: 821ab64890Smrg * _XRead 831ab64890Smrg * _XWaitForWritable 841ab64890Smrg * _XFlush 851ab64890Smrg * _XSend 861ab64890Smrg * _XEventsQueued 871ab64890Smrg * _XReadEvents 881ab64890Smrg * _XRead[0-9]+ 891ab64890Smrg * _XAllocIDs 901ab64890Smrg * _XReply 911ab64890Smrg * _XEatData 921ab64890Smrg * _XReadPad 931ab64890Smrg */ 941ab64890Smrgstatic void check_internal_connections(Display *dpy) 951ab64890Smrg{ 9661b2299dSmrg struct _XConnectionInfo *ilist; 971ab64890Smrg fd_set r_mask; 981ab64890Smrg struct timeval tv; 991ab64890Smrg int result; 1001ab64890Smrg int highest_fd = -1; 1011ab64890Smrg 1021ab64890Smrg if(dpy->flags & XlibDisplayProcConni || !dpy->im_fd_info) 1031ab64890Smrg return; 1041ab64890Smrg 1051ab64890Smrg FD_ZERO(&r_mask); 1061ab64890Smrg for(ilist = dpy->im_fd_info; ilist; ilist = ilist->next) 1071ab64890Smrg { 1081ab64890Smrg assert(ilist->fd >= 0); 1091ab64890Smrg FD_SET(ilist->fd, &r_mask); 1101ab64890Smrg if(ilist->fd > highest_fd) 1111ab64890Smrg highest_fd = ilist->fd; 1121ab64890Smrg } 1131ab64890Smrg assert(highest_fd >= 0); 1141ab64890Smrg 1151ab64890Smrg tv.tv_sec = 0; 1161ab64890Smrg tv.tv_usec = 0; 1171ab64890Smrg result = select(highest_fd + 1, &r_mask, NULL, NULL, &tv); 1181ab64890Smrg 1191ab64890Smrg if(result == -1) 1201ab64890Smrg { 1211ab64890Smrg if(errno == EINTR) 1221ab64890Smrg return; 1231ab64890Smrg _XIOError(dpy); 1241ab64890Smrg } 1251ab64890Smrg 1261ab64890Smrg for(ilist = dpy->im_fd_info; result && ilist; ilist = ilist->next) 1271ab64890Smrg if(FD_ISSET(ilist->fd, &r_mask)) 1281ab64890Smrg { 1291ab64890Smrg _XProcessInternalConnection(dpy, ilist); 1301ab64890Smrg --result; 1311ab64890Smrg } 1321ab64890Smrg} 1331ab64890Smrg 1342d67cb4fSmrgstatic PendingRequest *append_pending_request(Display *dpy, uint64_t sequence) 1351ab64890Smrg{ 13688de56ccSmrg PendingRequest *node = malloc(sizeof(PendingRequest)); 13788de56ccSmrg assert(node); 13888de56ccSmrg node->next = NULL; 13988de56ccSmrg node->sequence = sequence; 14088de56ccSmrg node->reply_waiter = 0; 14188de56ccSmrg if(dpy->xcb->pending_requests_tail) 1421ab64890Smrg { 1436cc2b21fSmrg if (XLIB_SEQUENCE_COMPARE(dpy->xcb->pending_requests_tail->sequence, 1446cc2b21fSmrg >=, node->sequence)) 1456cc2b21fSmrg throw_thread_fail_assert("Unknown sequence number " 1466cc2b21fSmrg "while appending request", 1476cc2b21fSmrg xcb_xlib_unknown_seq_number); 1486cc2b21fSmrg if (dpy->xcb->pending_requests_tail->next != NULL) 1496cc2b21fSmrg throw_thread_fail_assert("Unknown request in queue " 1506cc2b21fSmrg "while appending request", 1516cc2b21fSmrg xcb_xlib_unknown_req_pending); 15288de56ccSmrg dpy->xcb->pending_requests_tail->next = node; 1531ab64890Smrg } 15488de56ccSmrg else 15588de56ccSmrg dpy->xcb->pending_requests = node; 15688de56ccSmrg dpy->xcb->pending_requests_tail = node; 15788de56ccSmrg return node; 1581ab64890Smrg} 1591ab64890Smrg 16088de56ccSmrgstatic void dequeue_pending_request(Display *dpy, PendingRequest *req) 1611ab64890Smrg{ 1626cc2b21fSmrg if (req != dpy->xcb->pending_requests) 1636cc2b21fSmrg throw_thread_fail_assert("Unknown request in queue while " 1646cc2b21fSmrg "dequeuing", 1656cc2b21fSmrg xcb_xlib_unknown_req_in_deq); 1666cc2b21fSmrg 16788de56ccSmrg dpy->xcb->pending_requests = req->next; 16888de56ccSmrg if(!dpy->xcb->pending_requests) 1691ab64890Smrg { 1706cc2b21fSmrg if (req != dpy->xcb->pending_requests_tail) 1716cc2b21fSmrg throw_thread_fail_assert("Unknown request in queue " 1726cc2b21fSmrg "while dequeuing", 1736cc2b21fSmrg xcb_xlib_unknown_req_in_deq); 17488de56ccSmrg dpy->xcb->pending_requests_tail = NULL; 1751ab64890Smrg } 1766cc2b21fSmrg else if (XLIB_SEQUENCE_COMPARE(req->sequence, >=, 1776cc2b21fSmrg dpy->xcb->pending_requests->sequence)) 1786cc2b21fSmrg throw_thread_fail_assert("Unknown sequence number while " 1796cc2b21fSmrg "dequeuing request", 1806cc2b21fSmrg xcb_xlib_threads_sequence_lost); 1816cc2b21fSmrg 18288de56ccSmrg free(req); 18388de56ccSmrg} 18488de56ccSmrg 18588de56ccSmrgstatic int handle_error(Display *dpy, xError *err, Bool in_XReply) 18688de56ccSmrg{ 18788de56ccSmrg _XExtension *ext; 18888de56ccSmrg int ret_code; 18988de56ccSmrg /* Oddly, Xlib only allows extensions to suppress errors when 19088de56ccSmrg * those errors were seen by _XReply. */ 19188de56ccSmrg if(in_XReply) 19288de56ccSmrg /* 19388de56ccSmrg * we better see if there is an extension who may 19488de56ccSmrg * want to suppress the error. 19588de56ccSmrg */ 19688de56ccSmrg for(ext = dpy->ext_procs; ext; ext = ext->next) 19788de56ccSmrg if(ext->error && (*ext->error)(dpy, err, &ext->codes, &ret_code)) 19888de56ccSmrg return ret_code; 19988de56ccSmrg _XError(dpy, err); 20088de56ccSmrg return 0; 2011ab64890Smrg} 2021ab64890Smrg 2032d67cb4fSmrg/* Widen a 32-bit sequence number into a 64bit (uint64_t) sequence number. 2042d67cb4fSmrg * Treating the comparison as a 1 and shifting it avoids a conditional branch. 2052d67cb4fSmrg */ 2062d67cb4fSmrgstatic void widen(uint64_t *wide, unsigned int narrow) 20761b2299dSmrg{ 2082d67cb4fSmrg uint64_t new = (*wide & ~((uint64_t)0xFFFFFFFFUL)) | narrow; 2092d67cb4fSmrg *wide = new + (((uint64_t)(new < *wide)) << 32); 21061b2299dSmrg} 21161b2299dSmrg 21288de56ccSmrg/* Thread-safety rules: 21388de56ccSmrg * 21488de56ccSmrg * At most one thread can be reading from XCB's event queue at a time. 21588de56ccSmrg * If you are not the current event-reading thread and you need to find 21688de56ccSmrg * out if an event is available, you must wait. 21788de56ccSmrg * 21888de56ccSmrg * The same rule applies for reading replies. 21988de56ccSmrg * 22088de56ccSmrg * A single thread cannot be both the the event-reading and the 22188de56ccSmrg * reply-reading thread at the same time. 22288de56ccSmrg * 22388de56ccSmrg * We always look at both the current event and the first pending reply 22488de56ccSmrg * to decide which to process next. 22588de56ccSmrg * 22688de56ccSmrg * We always process all responses in sequence-number order, which may 22788de56ccSmrg * mean waiting for another thread (either the event_waiter or the 22888de56ccSmrg * reply_waiter) to handle an earlier response before we can process or 22988de56ccSmrg * return a later one. If so, we wait on the corresponding condition 23088de56ccSmrg * variable for that thread to process the response and wake us up. 23188de56ccSmrg */ 2321ab64890Smrg 23388de56ccSmrgstatic xcb_generic_reply_t *poll_for_event(Display *dpy) 23488de56ccSmrg{ 23588de56ccSmrg /* Make sure the Display's sequence numbers are valid */ 23661b2299dSmrg require_socket(dpy); 23761b2299dSmrg 23888de56ccSmrg /* Precondition: This thread can safely get events from XCB. */ 23988de56ccSmrg assert(dpy->xcb->event_owner == XlibOwnsEventQueue && !dpy->xcb->event_waiter); 24088de56ccSmrg 24188de56ccSmrg if(!dpy->xcb->next_event) 24288de56ccSmrg dpy->xcb->next_event = xcb_poll_for_event(dpy->xcb->connection); 24388de56ccSmrg 24488de56ccSmrg if(dpy->xcb->next_event) 2451ab64890Smrg { 2461ab64890Smrg PendingRequest *req = dpy->xcb->pending_requests; 24788de56ccSmrg xcb_generic_event_t *event = dpy->xcb->next_event; 2482d67cb4fSmrg uint64_t event_sequence = X_DPY_GET_LAST_REQUEST_READ(dpy); 24988de56ccSmrg widen(&event_sequence, event->full_sequence); 25088de56ccSmrg if(!req || XLIB_SEQUENCE_COMPARE(event_sequence, <, req->sequence) 25188de56ccSmrg || (event->response_type != X_Error && event_sequence == req->sequence)) 2521ab64890Smrg { 2532d67cb4fSmrg uint64_t request = X_DPY_GET_REQUEST(dpy); 2542d67cb4fSmrg if (XLIB_SEQUENCE_COMPARE(event_sequence, >, request)) 2556cc2b21fSmrg { 2566cc2b21fSmrg throw_thread_fail_assert("Unknown sequence " 2576cc2b21fSmrg "number while " 2586cc2b21fSmrg "processing queue", 2596cc2b21fSmrg xcb_xlib_threads_sequence_lost); 2606cc2b21fSmrg } 2612d67cb4fSmrg X_DPY_SET_LAST_REQUEST_READ(dpy, event_sequence); 26288de56ccSmrg dpy->xcb->next_event = NULL; 26388de56ccSmrg return (xcb_generic_reply_t *) event; 2641ab64890Smrg } 26588de56ccSmrg } 26688de56ccSmrg return NULL; 26788de56ccSmrg} 26888de56ccSmrg 26988de56ccSmrgstatic xcb_generic_reply_t *poll_for_response(Display *dpy) 27088de56ccSmrg{ 27188de56ccSmrg void *response; 27288de56ccSmrg xcb_generic_error_t *error; 27388de56ccSmrg PendingRequest *req; 27488de56ccSmrg while(!(response = poll_for_event(dpy)) && 27588de56ccSmrg (req = dpy->xcb->pending_requests) && 27688de56ccSmrg !req->reply_waiter && 2772d67cb4fSmrg xcb_poll_for_reply64(dpy->xcb->connection, req->sequence, &response, &error)) 27888de56ccSmrg { 2792d67cb4fSmrg uint64_t request = X_DPY_GET_REQUEST(dpy); 2802d67cb4fSmrg if(XLIB_SEQUENCE_COMPARE(req->sequence, >, request)) 2816cc2b21fSmrg { 2826cc2b21fSmrg throw_thread_fail_assert("Unknown sequence number " 2836cc2b21fSmrg "while awaiting reply", 2846cc2b21fSmrg xcb_xlib_threads_sequence_lost); 2856cc2b21fSmrg } 2862d67cb4fSmrg X_DPY_SET_LAST_REQUEST_READ(dpy, req->sequence); 287e9fcaa8aSmrg if(response) 288e9fcaa8aSmrg break; 289e9fcaa8aSmrg dequeue_pending_request(dpy, req); 29088de56ccSmrg if(error) 29188de56ccSmrg return (xcb_generic_reply_t *) error; 29288de56ccSmrg } 29388de56ccSmrg return response; 29488de56ccSmrg} 29588de56ccSmrg 29688de56ccSmrgstatic void handle_response(Display *dpy, xcb_generic_reply_t *response, Bool in_XReply) 29788de56ccSmrg{ 29888de56ccSmrg _XAsyncHandler *async, *next; 29988de56ccSmrg switch(response->response_type) 30088de56ccSmrg { 30188de56ccSmrg case X_Reply: 30288de56ccSmrg for(async = dpy->async_handlers; async; async = next) 3031ab64890Smrg { 30488de56ccSmrg next = async->next; 30588de56ccSmrg if(async->handler(dpy, (xReply *) response, (char *) response, sizeof(xReply) + (response->length << 2), async->data)) 30688de56ccSmrg break; 3071ab64890Smrg } 30888de56ccSmrg break; 30988de56ccSmrg 31088de56ccSmrg case X_Error: 31188de56ccSmrg handle_error(dpy, (xError *) response, in_XReply); 31288de56ccSmrg break; 31388de56ccSmrg 31488de56ccSmrg default: /* event */ 31588de56ccSmrg /* GenericEvents may be > 32 bytes. In this case, the 31688de56ccSmrg * event struct is trailed by the additional bytes. the 31788de56ccSmrg * xcb_generic_event_t struct uses 4 bytes for internal 31888de56ccSmrg * numbering, so we need to shift the trailing data to 31988de56ccSmrg * be after the first 32 bytes. */ 32088de56ccSmrg if(response->response_type == GenericEvent && ((xcb_ge_event_t *) response)->length) 3211ab64890Smrg { 32288de56ccSmrg xcb_ge_event_t *event = (xcb_ge_event_t *) response; 32388de56ccSmrg memmove(&event->full_sequence, &event[1], event->length * 4); 3241ab64890Smrg } 32588de56ccSmrg _XEnq(dpy, (xEvent *) response); 32688de56ccSmrg break; 3271ab64890Smrg } 32888de56ccSmrg free(response); 3291ab64890Smrg} 3301ab64890Smrg 3311ab64890Smrgint _XEventsQueued(Display *dpy, int mode) 3321ab64890Smrg{ 33388de56ccSmrg xcb_generic_reply_t *response; 3341ab64890Smrg if(dpy->flags & XlibDisplayIOError) 3351ab64890Smrg return 0; 3361ab64890Smrg if(dpy->xcb->event_owner != XlibOwnsEventQueue) 3371ab64890Smrg return 0; 3381ab64890Smrg 3391ab64890Smrg if(mode == QueuedAfterFlush) 34061b2299dSmrg _XSend(dpy, NULL, 0); 3411ab64890Smrg else 3421ab64890Smrg check_internal_connections(dpy); 34388de56ccSmrg 34488de56ccSmrg /* If another thread is blocked waiting for events, then we must 34588de56ccSmrg * let that thread pick up the next event. Since it blocked, we 34688de56ccSmrg * can reasonably claim there are no new events right now. */ 34788de56ccSmrg if(!dpy->xcb->event_waiter) 34888de56ccSmrg { 34988de56ccSmrg while((response = poll_for_response(dpy))) 35088de56ccSmrg handle_response(dpy, response, False); 35188de56ccSmrg if(xcb_connection_has_error(dpy->xcb->connection)) 35288de56ccSmrg _XIOError(dpy); 35388de56ccSmrg } 3541ab64890Smrg return dpy->qlen; 3551ab64890Smrg} 3561ab64890Smrg 3571ab64890Smrg/* _XReadEvents - Flush the output queue, 3581ab64890Smrg * then read as many events as possible (but at least 1) and enqueue them 3591ab64890Smrg */ 3601ab64890Smrgvoid _XReadEvents(Display *dpy) 3611ab64890Smrg{ 36288de56ccSmrg xcb_generic_reply_t *response; 36388de56ccSmrg unsigned long serial; 36488de56ccSmrg 3651ab64890Smrg if(dpy->flags & XlibDisplayIOError) 3661ab64890Smrg return; 36761b2299dSmrg _XSend(dpy, NULL, 0); 3681ab64890Smrg if(dpy->xcb->event_owner != XlibOwnsEventQueue) 3691ab64890Smrg return; 3701ab64890Smrg check_internal_connections(dpy); 37188de56ccSmrg 37288de56ccSmrg serial = dpy->next_event_serial_num; 37388de56ccSmrg while(serial == dpy->next_event_serial_num || dpy->qlen == 0) 37488de56ccSmrg { 37588de56ccSmrg if(dpy->xcb->event_waiter) 37688de56ccSmrg { 37788de56ccSmrg ConditionWait(dpy, dpy->xcb->event_notify); 37888de56ccSmrg /* Maybe the other thread got us an event. */ 37988de56ccSmrg continue; 38088de56ccSmrg } 38188de56ccSmrg 38288de56ccSmrg if(!dpy->xcb->next_event) 38388de56ccSmrg { 38488de56ccSmrg xcb_generic_event_t *event; 38588de56ccSmrg dpy->xcb->event_waiter = 1; 38688de56ccSmrg UnlockDisplay(dpy); 38788de56ccSmrg event = xcb_wait_for_event(dpy->xcb->connection); 38857f47464Smrg /* It appears that classic Xlib respected user 38957f47464Smrg * locks when waking up after waiting for 39057f47464Smrg * events. However, if this thread did not have 39157f47464Smrg * any user locks, and another thread takes a 39257f47464Smrg * user lock and tries to read events, then we'd 39357f47464Smrg * deadlock. So we'll choose to let the thread 39457f47464Smrg * that got in first consume events, despite the 39557f47464Smrg * later thread's user locks. */ 39657f47464Smrg InternalLockDisplay(dpy, /* ignore user locks */ 1); 39788de56ccSmrg dpy->xcb->event_waiter = 0; 39888de56ccSmrg ConditionBroadcast(dpy, dpy->xcb->event_notify); 39988de56ccSmrg if(!event) 40088de56ccSmrg _XIOError(dpy); 40188de56ccSmrg dpy->xcb->next_event = event; 40288de56ccSmrg } 40388de56ccSmrg 40488de56ccSmrg /* We've established most of the conditions for 40588de56ccSmrg * poll_for_response to return non-NULL. The exceptions 40688de56ccSmrg * are connection shutdown, and finding that another 40788de56ccSmrg * thread is waiting for the next reply we'd like to 40888de56ccSmrg * process. */ 40988de56ccSmrg 41088de56ccSmrg response = poll_for_response(dpy); 41188de56ccSmrg if(response) 41288de56ccSmrg handle_response(dpy, response, False); 41388de56ccSmrg else if(dpy->xcb->pending_requests->reply_waiter) 41488de56ccSmrg { /* need braces around ConditionWait */ 41588de56ccSmrg ConditionWait(dpy, dpy->xcb->reply_notify); 41688de56ccSmrg } 41788de56ccSmrg else 41888de56ccSmrg _XIOError(dpy); 41988de56ccSmrg } 42088de56ccSmrg 42188de56ccSmrg /* The preceding loop established that there is no 42288de56ccSmrg * event_waiter--unless we just called ConditionWait because of 42388de56ccSmrg * a reply_waiter, in which case another thread may have become 42488de56ccSmrg * the event_waiter while we slept unlocked. */ 42588de56ccSmrg if(!dpy->xcb->event_waiter) 42688de56ccSmrg while((response = poll_for_response(dpy))) 42788de56ccSmrg handle_response(dpy, response, False); 42888de56ccSmrg if(xcb_connection_has_error(dpy->xcb->connection)) 42988de56ccSmrg _XIOError(dpy); 4301ab64890Smrg} 4311ab64890Smrg 4321ab64890Smrg/* 4331ab64890Smrg * _XSend - Flush the buffer and send the client data. 32 bit word aligned 4341ab64890Smrg * transmission is used, if size is not 0 mod 4, extra bytes are transmitted. 4351ab64890Smrg * 4361ab64890Smrg * Note that the connection must not be read from once the data currently 4371ab64890Smrg * in the buffer has been written. 4381ab64890Smrg */ 4391ab64890Smrgvoid _XSend(Display *dpy, const char *data, long size) 4401ab64890Smrg{ 44161b2299dSmrg static const xReq dummy_request; 44261b2299dSmrg static char const pad[3]; 44361b2299dSmrg struct iovec vec[3]; 44461b2299dSmrg uint64_t requests; 4452d67cb4fSmrg uint64_t dpy_request; 44661b2299dSmrg _XExtension *ext; 4471ab64890Smrg xcb_connection_t *c = dpy->xcb->connection; 4481ab64890Smrg if(dpy->flags & XlibDisplayIOError) 4491ab64890Smrg return; 4501ab64890Smrg 45161b2299dSmrg if(dpy->bufptr == dpy->buffer && !size) 45261b2299dSmrg return; 4531ab64890Smrg 4542d67cb4fSmrg /* append_pending_request does not alter the dpy request number 4552d67cb4fSmrg * therefore we can get it outside of the loop and the if 4562d67cb4fSmrg */ 4572d67cb4fSmrg dpy_request = X_DPY_GET_REQUEST(dpy); 45861b2299dSmrg /* iff we asked XCB to set aside errors, we must pick those up 45961b2299dSmrg * eventually. iff there are async handlers, we may have just 46061b2299dSmrg * issued requests that will generate replies. in either case, 46161b2299dSmrg * we need to remember to check later. */ 46261b2299dSmrg if(dpy->xcb->event_owner != XlibOwnsEventQueue || dpy->async_handlers) 46361b2299dSmrg { 4642e9c7c8cSmrg uint64_t sequence; 4652d67cb4fSmrg for(sequence = dpy->xcb->last_flushed + 1; sequence <= dpy_request; ++sequence) 46688de56ccSmrg append_pending_request(dpy, sequence); 46761b2299dSmrg } 4682d67cb4fSmrg requests = dpy_request - dpy->xcb->last_flushed; 4692d67cb4fSmrg dpy->xcb->last_flushed = dpy_request; 4701ab64890Smrg 47161b2299dSmrg vec[0].iov_base = dpy->buffer; 47261b2299dSmrg vec[0].iov_len = dpy->bufptr - dpy->buffer; 473eb411b4bSmrg vec[1].iov_base = (char *)data; 47461b2299dSmrg vec[1].iov_len = size; 475eb411b4bSmrg vec[2].iov_base = (char *)pad; 47661b2299dSmrg vec[2].iov_len = -size & 3; 47761b2299dSmrg 47861b2299dSmrg for(ext = dpy->flushes; ext; ext = ext->next_flush) 47961b2299dSmrg { 48061b2299dSmrg int i; 48161b2299dSmrg for(i = 0; i < 3; ++i) 48261b2299dSmrg if(vec[i].iov_len) 48361b2299dSmrg ext->before_flush(dpy, &ext->codes, vec[i].iov_base, vec[i].iov_len); 48461b2299dSmrg } 4851ab64890Smrg 48661b2299dSmrg if(xcb_writev(c, vec, 3, requests) < 0) 48761b2299dSmrg _XIOError(dpy); 48861b2299dSmrg dpy->bufptr = dpy->buffer; 48961b2299dSmrg dpy->last_req = (char *) &dummy_request; 4901ab64890Smrg 4911ab64890Smrg check_internal_connections(dpy); 4921ab64890Smrg 49361b2299dSmrg _XSetSeqSyncFunction(dpy); 4941ab64890Smrg} 4951ab64890Smrg 4961ab64890Smrg/* 4971ab64890Smrg * _XFlush - Flush the X request buffer. If the buffer is empty, no 4981ab64890Smrg * action is taken. 4991ab64890Smrg */ 5001ab64890Smrgvoid _XFlush(Display *dpy) 5011ab64890Smrg{ 50261b2299dSmrg require_socket(dpy); 50361b2299dSmrg _XSend(dpy, NULL, 0); 5041ab64890Smrg 5051ab64890Smrg _XEventsQueued(dpy, QueuedAfterReading); 5061ab64890Smrg} 5071ab64890Smrg 50861b2299dSmrgstatic const XID inval_id = ~0UL; 50961b2299dSmrg 51088de56ccSmrgvoid _XIDHandler(Display *dpy) 5111ab64890Smrg{ 51288de56ccSmrg if (dpy->xcb->next_xid == inval_id) 51388de56ccSmrg _XAllocIDs(dpy, &dpy->xcb->next_xid, 1); 5141ab64890Smrg} 5151ab64890Smrg 5161ab64890Smrg/* _XAllocID - resource ID allocation routine. */ 5171ab64890SmrgXID _XAllocID(Display *dpy) 5181ab64890Smrg{ 5191ab64890Smrg XID ret = dpy->xcb->next_xid; 52061b2299dSmrg assert (ret != inval_id); 52161b2299dSmrg dpy->xcb->next_xid = inval_id; 52261b2299dSmrg _XSetPrivSyncFunction(dpy); 5231ab64890Smrg return ret; 5241ab64890Smrg} 5251ab64890Smrg 5261ab64890Smrg/* _XAllocIDs - multiple resource ID allocation routine. */ 5271ab64890Smrgvoid _XAllocIDs(Display *dpy, XID *ids, int count) 5281ab64890Smrg{ 5291ab64890Smrg int i; 53061b2299dSmrg#ifdef XTHREADS 53161b2299dSmrg if (dpy->lock) 53261b2299dSmrg (*dpy->lock->user_lock_display)(dpy); 53361b2299dSmrg UnlockDisplay(dpy); 53461b2299dSmrg#endif 5351ab64890Smrg for (i = 0; i < count; i++) 5361ab64890Smrg ids[i] = xcb_generate_id(dpy->xcb->connection); 53761b2299dSmrg#ifdef XTHREADS 53888de56ccSmrg InternalLockDisplay(dpy, /* don't skip user locks */ 0); 53961b2299dSmrg if (dpy->lock) 54061b2299dSmrg (*dpy->lock->user_unlock_display)(dpy); 54161b2299dSmrg#endif 5421ab64890Smrg} 5431ab64890Smrg 5441ab64890Smrgstatic void _XFreeReplyData(Display *dpy, Bool force) 5451ab64890Smrg{ 5461ab64890Smrg if(!force && dpy->xcb->reply_consumed < dpy->xcb->reply_length) 5471ab64890Smrg return; 5481ab64890Smrg free(dpy->xcb->reply_data); 54961b2299dSmrg dpy->xcb->reply_data = NULL; 5501ab64890Smrg} 5511ab64890Smrg 5521ab64890Smrg/* 5531ab64890Smrg * _XReply - Wait for a reply packet and copy its contents into the 5541ab64890Smrg * specified rep. 5551ab64890Smrg * extra: number of 32-bit words expected after the reply 5561ab64890Smrg * discard: should I discard data following "extra" words? 5571ab64890Smrg */ 5581ab64890SmrgStatus _XReply(Display *dpy, xReply *rep, int extra, Bool discard) 5591ab64890Smrg{ 5601ab64890Smrg xcb_generic_error_t *error; 5611ab64890Smrg xcb_connection_t *c = dpy->xcb->connection; 5621ab64890Smrg char *reply; 5631ab64890Smrg PendingRequest *current; 5642d67cb4fSmrg uint64_t dpy_request; 5651ab64890Smrg 5666cc2b21fSmrg if (dpy->xcb->reply_data) 5676cc2b21fSmrg throw_extlib_fail_assert("Extra reply data still left in queue", 5686cc2b21fSmrg xcb_xlib_extra_reply_data_left); 5691ab64890Smrg 5701ab64890Smrg if(dpy->flags & XlibDisplayIOError) 5711ab64890Smrg return 0; 5721ab64890Smrg 57361b2299dSmrg _XSend(dpy, NULL, 0); 5742d67cb4fSmrg dpy_request = X_DPY_GET_REQUEST(dpy); 5752d67cb4fSmrg if(dpy->xcb->pending_requests_tail 5762d67cb4fSmrg && dpy->xcb->pending_requests_tail->sequence == dpy_request) 57788de56ccSmrg current = dpy->xcb->pending_requests_tail; 57888de56ccSmrg else 5792d67cb4fSmrg current = append_pending_request(dpy, dpy_request); 58088de56ccSmrg /* Don't let any other thread get this reply. */ 58188de56ccSmrg current->reply_waiter = 1; 58288de56ccSmrg 58388de56ccSmrg while(1) 58488de56ccSmrg { 58588de56ccSmrg PendingRequest *req = dpy->xcb->pending_requests; 58688de56ccSmrg xcb_generic_reply_t *response; 5871ab64890Smrg 58888de56ccSmrg if(req != current && req->reply_waiter) 58988de56ccSmrg { 59088de56ccSmrg ConditionWait(dpy, dpy->xcb->reply_notify); 59188de56ccSmrg /* Another thread got this reply. */ 59288de56ccSmrg continue; 59388de56ccSmrg } 59488de56ccSmrg req->reply_waiter = 1; 59588de56ccSmrg UnlockDisplay(dpy); 5962d67cb4fSmrg response = xcb_wait_for_reply64(c, req->sequence, &error); 59757f47464Smrg /* Any user locks on another thread must have been taken 5982d67cb4fSmrg * while we slept in xcb_wait_for_reply64. Classic Xlib 59957f47464Smrg * ignored those user locks in this case, so we do too. */ 60057f47464Smrg InternalLockDisplay(dpy, /* ignore user locks */ 1); 60188de56ccSmrg 60288de56ccSmrg /* We have the response we're looking for. Now, before 60388de56ccSmrg * letting anyone else process this sequence number, we 60488de56ccSmrg * need to process any events that should have come 60588de56ccSmrg * earlier. */ 60688de56ccSmrg 60788de56ccSmrg if(dpy->xcb->event_owner == XlibOwnsEventQueue) 60888de56ccSmrg { 60988de56ccSmrg xcb_generic_reply_t *event; 61088de56ccSmrg /* If some thread is already waiting for events, 61188de56ccSmrg * it will get the first one. That thread must 61288de56ccSmrg * process that event before we can continue. */ 61388de56ccSmrg /* FIXME: That event might be after this reply, 61488de56ccSmrg * and might never even come--or there might be 61588de56ccSmrg * multiple threads trying to get events. */ 61688de56ccSmrg while(dpy->xcb->event_waiter) 61788de56ccSmrg { /* need braces around ConditionWait */ 61888de56ccSmrg ConditionWait(dpy, dpy->xcb->event_notify); 61988de56ccSmrg } 62088de56ccSmrg while((event = poll_for_event(dpy))) 62188de56ccSmrg handle_response(dpy, event, True); 62288de56ccSmrg } 62388de56ccSmrg 62488de56ccSmrg req->reply_waiter = 0; 62588de56ccSmrg ConditionBroadcast(dpy, dpy->xcb->reply_notify); 6262d67cb4fSmrg dpy_request = X_DPY_GET_REQUEST(dpy); 6272d67cb4fSmrg if(XLIB_SEQUENCE_COMPARE(req->sequence, >, dpy_request)) { 6286cc2b21fSmrg throw_thread_fail_assert("Unknown sequence number " 6296cc2b21fSmrg "while processing reply", 6306cc2b21fSmrg xcb_xlib_threads_sequence_lost); 6316cc2b21fSmrg } 6322d67cb4fSmrg X_DPY_SET_LAST_REQUEST_READ(dpy, req->sequence); 63388de56ccSmrg if(!response) 63488de56ccSmrg dequeue_pending_request(dpy, req); 63588de56ccSmrg 63688de56ccSmrg if(req == current) 63788de56ccSmrg { 63888de56ccSmrg reply = (char *) response; 63988de56ccSmrg break; 64088de56ccSmrg } 64188de56ccSmrg 64288de56ccSmrg if(error) 64388de56ccSmrg handle_response(dpy, (xcb_generic_reply_t *) error, True); 64488de56ccSmrg else if(response) 64588de56ccSmrg handle_response(dpy, response, True); 64688de56ccSmrg } 6471ab64890Smrg check_internal_connections(dpy); 64888de56ccSmrg 64988de56ccSmrg if(dpy->xcb->next_event && dpy->xcb->next_event->response_type == X_Error) 65088de56ccSmrg { 65188de56ccSmrg xcb_generic_event_t *event = dpy->xcb->next_event; 6522d67cb4fSmrg uint64_t last_request_read = X_DPY_GET_LAST_REQUEST_READ(dpy); 6532d67cb4fSmrg uint64_t event_sequence = last_request_read; 65488de56ccSmrg widen(&event_sequence, event->full_sequence); 6552d67cb4fSmrg if(event_sequence == last_request_read) 65688de56ccSmrg { 65788de56ccSmrg error = (xcb_generic_error_t *) event; 65888de56ccSmrg dpy->xcb->next_event = NULL; 65988de56ccSmrg } 66088de56ccSmrg } 6611ab64890Smrg 6621ab64890Smrg if(error) 6631ab64890Smrg { 6641ab64890Smrg int ret_code; 6651ab64890Smrg 6661ab64890Smrg /* Xlib is evil and assumes that even errors will be 6671ab64890Smrg * copied into rep. */ 6681ab64890Smrg memcpy(rep, error, 32); 6691ab64890Smrg 6701ab64890Smrg /* do not die on "no such font", "can't allocate", 6711ab64890Smrg "can't grab" failures */ 67288de56ccSmrg switch(error->error_code) 6731ab64890Smrg { 6741ab64890Smrg case BadName: 67588de56ccSmrg switch(error->major_code) 6761ab64890Smrg { 6771ab64890Smrg case X_LookupColor: 6781ab64890Smrg case X_AllocNamedColor: 67961b2299dSmrg free(error); 6801ab64890Smrg return 0; 6811ab64890Smrg } 6821ab64890Smrg break; 6831ab64890Smrg case BadFont: 68488de56ccSmrg if(error->major_code == X_QueryFont) { 68561b2299dSmrg free(error); 6861ab64890Smrg return 0; 68761b2299dSmrg } 6881ab64890Smrg break; 6891ab64890Smrg case BadAlloc: 6901ab64890Smrg case BadAccess: 69161b2299dSmrg free(error); 6921ab64890Smrg return 0; 6931ab64890Smrg } 6941ab64890Smrg 69588de56ccSmrg ret_code = handle_error(dpy, (xError *) error, True); 69661b2299dSmrg free(error); 69788de56ccSmrg return ret_code; 6981ab64890Smrg } 6991ab64890Smrg 7001ab64890Smrg /* it's not an error, but we don't have a reply, so it's an I/O 7011ab64890Smrg * error. */ 7021ab64890Smrg if(!reply) 7031ab64890Smrg { 7041ab64890Smrg _XIOError(dpy); 7051ab64890Smrg return 0; 7061ab64890Smrg } 7071ab64890Smrg 7081ab64890Smrg /* there's no error and we have a reply. */ 7091ab64890Smrg dpy->xcb->reply_data = reply; 7101ab64890Smrg dpy->xcb->reply_consumed = sizeof(xReply) + (extra * 4); 7111ab64890Smrg dpy->xcb->reply_length = sizeof(xReply); 7121ab64890Smrg if(dpy->xcb->reply_data[0] == 1) 7131ab64890Smrg dpy->xcb->reply_length += (((xcb_generic_reply_t *) dpy->xcb->reply_data)->length * 4); 7141ab64890Smrg 7151ab64890Smrg /* error: Xlib asks too much. give them what we can anyway. */ 7161ab64890Smrg if(dpy->xcb->reply_length < dpy->xcb->reply_consumed) 7171ab64890Smrg dpy->xcb->reply_consumed = dpy->xcb->reply_length; 7181ab64890Smrg 7191ab64890Smrg memcpy(rep, dpy->xcb->reply_data, dpy->xcb->reply_consumed); 7201ab64890Smrg _XFreeReplyData(dpy, discard); 7211ab64890Smrg return 1; 7221ab64890Smrg} 7231ab64890Smrg 7241ab64890Smrgint _XRead(Display *dpy, char *data, long size) 7251ab64890Smrg{ 7261ab64890Smrg assert(size >= 0); 7271ab64890Smrg if(size == 0) 7281ab64890Smrg return 0; 7296cc2b21fSmrg if(dpy->xcb->reply_data == NULL || 7306cc2b21fSmrg dpy->xcb->reply_consumed + size > dpy->xcb->reply_length) 7316cc2b21fSmrg throw_extlib_fail_assert("Too much data requested from _XRead", 7326cc2b21fSmrg xcb_xlib_too_much_data_requested); 7331ab64890Smrg memcpy(data, dpy->xcb->reply_data + dpy->xcb->reply_consumed, size); 7341ab64890Smrg dpy->xcb->reply_consumed += size; 7351ab64890Smrg _XFreeReplyData(dpy, False); 7361ab64890Smrg return 0; 7371ab64890Smrg} 7381ab64890Smrg 7391ab64890Smrg/* 7401ab64890Smrg * _XReadPad - Read bytes from the socket taking into account incomplete 7411ab64890Smrg * reads. If the number of bytes is not 0 mod 4, read additional pad 7421ab64890Smrg * bytes. 7431ab64890Smrg */ 7441ab64890Smrgvoid _XReadPad(Display *dpy, char *data, long size) 7451ab64890Smrg{ 7461ab64890Smrg _XRead(dpy, data, size); 7471ab64890Smrg dpy->xcb->reply_consumed += -size & 3; 7481ab64890Smrg _XFreeReplyData(dpy, False); 7491ab64890Smrg} 7501ab64890Smrg 7511ab64890Smrg/* Read and discard "n" 8-bit bytes of data */ 7521ab64890Smrgvoid _XEatData(Display *dpy, unsigned long n) 7531ab64890Smrg{ 7541ab64890Smrg dpy->xcb->reply_consumed += n; 7551ab64890Smrg _XFreeReplyData(dpy, False); 7561ab64890Smrg} 757eb411b4bSmrg 758eb411b4bSmrg/* 759eb411b4bSmrg * Read and discard "n" 32-bit words of data 760eb411b4bSmrg * Matches the units of the length field in X protocol replies, and provides 761eb411b4bSmrg * a single implementation of overflow checking to avoid having to replicate 762eb411b4bSmrg * those checks in every caller. 763eb411b4bSmrg */ 764eb411b4bSmrgvoid _XEatDataWords(Display *dpy, unsigned long n) 765eb411b4bSmrg{ 766eb411b4bSmrg if (n < ((INT_MAX - dpy->xcb->reply_consumed) >> 2)) 767eb411b4bSmrg dpy->xcb->reply_consumed += (n << 2); 768eb411b4bSmrg else 769eb411b4bSmrg /* Overflow would happen, so just eat the rest of the reply */ 770eb411b4bSmrg dpy->xcb->reply_consumed = dpy->xcb->reply_length; 771eb411b4bSmrg _XFreeReplyData(dpy, False); 772eb411b4bSmrg} 7730f8248bfSmrg 7740f8248bfSmrgunsigned long 7750f8248bfSmrg_XNextRequest(Display *dpy) 7760f8248bfSmrg{ 7770f8248bfSmrg /* This will update dpy->request. The assumption is that the next thing 7780f8248bfSmrg * that the application will do is make a request so there's little 7790f8248bfSmrg * overhead. 7800f8248bfSmrg */ 7810f8248bfSmrg require_socket(dpy); 7820f8248bfSmrg return NextRequest(dpy); 7830f8248bfSmrg} 784