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 /* Connection management: the core of XCB. */
46 #include <sys/select.h>
50 #include "xcb_windefs.h"
52 #include <sys/socket.h>
53 #include <netinet/in.h>
56 /* SHUT_RDWR is fairly recent and is not available on all platforms */
57 #if !defined(SHUT_RDWR)
65 } xcb_setup_generic_t;
67 static const int xcb_con_error = XCB_CONN_ERROR;
68 static const int xcb_con_closed_mem_er = XCB_CONN_CLOSED_MEM_INSUFFICIENT;
69 static const int xcb_con_closed_parse_er = XCB_CONN_CLOSED_PARSE_ERR;
70 static const int xcb_con_closed_screen_er = XCB_CONN_CLOSED_INVALID_SCREEN;
72 static int set_fd_flags(const int fd)
74 /* Win32 doesn't have file descriptors and the fcntl function. This block sets the socket in non-blocking mode */
77 u_long iMode = 1; /* non-zero puts it in non-blocking mode, 0 in blocking mode */
80 ret = ioctlsocket(fd, FIONBIO, &iMode);
85 int flags = fcntl(fd, F_GETFL, 0);
89 if(fcntl(fd, F_SETFL, flags) == -1)
91 if(fcntl(fd, F_SETFD, FD_CLOEXEC) == -1)
97 static int write_setup(xcb_connection_t *c, xcb_auth_info_t *auth_info)
99 static const char pad[3];
100 xcb_setup_request_t out;
101 struct iovec parts[6];
103 static const uint32_t endian = 0x01020304;
106 memset(&out, 0, sizeof(out));
108 /* B = 0x42 = MSB first, l = 0x6c = LSB first */
109 if(htonl(endian) == endian)
110 out.byte_order = 0x42;
112 out.byte_order = 0x6c;
113 out.protocol_major_version = X_PROTOCOL;
114 out.protocol_minor_version = X_PROTOCOL_REVISION;
115 out.authorization_protocol_name_len = 0;
116 out.authorization_protocol_data_len = 0;
117 parts[count].iov_len = sizeof(xcb_setup_request_t);
118 parts[count++].iov_base = &out;
119 parts[count].iov_len = XCB_PAD(sizeof(xcb_setup_request_t));
120 parts[count++].iov_base = (char *) pad;
124 parts[count].iov_len = out.authorization_protocol_name_len = auth_info->namelen;
125 parts[count++].iov_base = auth_info->name;
126 parts[count].iov_len = XCB_PAD(out.authorization_protocol_name_len);
127 parts[count++].iov_base = (char *) pad;
128 parts[count].iov_len = out.authorization_protocol_data_len = auth_info->datalen;
129 parts[count++].iov_base = auth_info->data;
130 parts[count].iov_len = XCB_PAD(out.authorization_protocol_data_len);
131 parts[count++].iov_base = (char *) pad;
133 assert(count <= (int) (sizeof(parts) / sizeof(*parts)));
135 pthread_mutex_lock(&c->iolock);
136 ret = _xcb_out_send(c, parts, count);
137 pthread_mutex_unlock(&c->iolock);
141 static int read_setup(xcb_connection_t *c)
143 /* Read the server response */
144 c->setup = malloc(sizeof(xcb_setup_generic_t));
148 if(_xcb_in_read_block(c, c->setup, sizeof(xcb_setup_generic_t)) != sizeof(xcb_setup_generic_t))
152 void *tmp = realloc(c->setup, c->setup->length * 4 + sizeof(xcb_setup_generic_t));
158 if(_xcb_in_read_block(c, (char *) c->setup + sizeof(xcb_setup_generic_t), c->setup->length * 4) <= 0)
161 /* 0 = failed, 2 = authenticate, 1 = success */
162 switch(c->setup->status)
166 xcb_setup_failed_t *setup = (xcb_setup_failed_t *) c->setup;
167 write(STDERR_FILENO, xcb_setup_failed_reason(setup), xcb_setup_failed_reason_length(setup));
171 case 2: /* authenticate */
173 xcb_setup_authenticate_t *setup = (xcb_setup_authenticate_t *) c->setup;
174 write(STDERR_FILENO, xcb_setup_authenticate_reason(setup), xcb_setup_authenticate_reason_length(setup));
182 /* precondition: there must be something for us to write. */
183 static int write_vec(xcb_connection_t *c, struct iovec **vector, int *count)
186 assert(!c->out.queue_len);
194 /* Could use the WSASend win32 function for scatter/gather i/o but setting up the WSABUF struct from
195 an iovec would require more work and I'm not sure of the benefit....works for now */
199 ret = send(c->fd,vec->iov_base,vec->iov_len,0);
200 if(ret == SOCKET_ERROR)
202 err = WSAGetLastError();
203 if(err == WSAEWOULDBLOCK)
218 if (c->out.out_fd.nfd) {
220 struct cmsghdr cmsghdr;
221 char buf[CMSG_SPACE(XCB_MAX_PASS_FD * sizeof(int))];
223 struct msghdr msg = {
228 .msg_control = cmsgbuf.buf,
229 .msg_controllen = CMSG_LEN(c->out.out_fd.nfd * sizeof (int)),
232 struct cmsghdr *hdr = CMSG_FIRSTHDR(&msg);
234 hdr->cmsg_len = msg.msg_controllen;
235 hdr->cmsg_level = SOL_SOCKET;
236 hdr->cmsg_type = SCM_RIGHTS;
237 memcpy(CMSG_DATA(hdr), c->out.out_fd.fd, c->out.out_fd.nfd * sizeof (int));
239 n = sendmsg(c->fd, &msg, 0);
240 if(n < 0 && errno == EAGAIN)
242 for (i = 0; i < c->out.out_fd.nfd; i++)
243 close(c->out.out_fd.fd[i]);
244 c->out.out_fd.nfd = 0;
248 n = writev(c->fd, *vector, n);
249 if(n < 0 && errno == EAGAIN)
257 _xcb_conn_shutdown(c, XCB_CONN_ERROR);
261 for(; *count; --*count, ++*vector)
263 int cur = (*vector)->iov_len;
266 (*vector)->iov_len -= cur;
267 (*vector)->iov_base = (char *) (*vector)->iov_base + cur;
269 if((*vector)->iov_len)
278 /* Public interface */
280 const xcb_setup_t *xcb_get_setup(xcb_connection_t *c)
284 /* doesn't need locking because it's never written to. */
288 int xcb_get_file_descriptor(xcb_connection_t *c)
292 /* doesn't need locking because it's never written to. */
296 int xcb_connection_has_error(xcb_connection_t *c)
298 /* doesn't need locking because it's read and written atomically. */
302 xcb_connection_t *xcb_connect_to_fd(int fd, xcb_auth_info_t *auth_info)
308 if(fd >= FD_SETSIZE) /* would overflow in FD_SET */
311 return _xcb_conn_ret_error(XCB_CONN_ERROR);
316 c = calloc(1, sizeof(xcb_connection_t));
319 return _xcb_conn_ret_error(XCB_CONN_CLOSED_MEM_INSUFFICIENT) ;
326 pthread_mutex_init(&c->iolock, 0) == 0 &&
327 _xcb_in_init(&c->in) &&
328 _xcb_out_init(&c->out) &&
329 write_setup(c, auth_info) &&
336 return _xcb_conn_ret_error(XCB_CONN_ERROR);
342 void xcb_disconnect(xcb_connection_t *c)
349 /* disallow further sends and receives */
350 shutdown(c->fd, SHUT_RDWR);
353 pthread_mutex_destroy(&c->iolock);
354 _xcb_in_destroy(&c->in);
355 _xcb_out_destroy(&c->out);
367 /* Private interface */
369 void _xcb_conn_shutdown(xcb_connection_t *c, int err)
374 /* Return connection error state.
375 * To make thread-safe, I need a seperate static
376 * variable for every possible error.
378 xcb_connection_t *_xcb_conn_ret_error(int err)
383 case XCB_CONN_CLOSED_MEM_INSUFFICIENT:
385 return (xcb_connection_t *) &xcb_con_closed_mem_er;
387 case XCB_CONN_CLOSED_PARSE_ERR:
389 return (xcb_connection_t *) &xcb_con_closed_parse_er;
391 case XCB_CONN_CLOSED_INVALID_SCREEN:
393 return (xcb_connection_t *) &xcb_con_closed_screen_er;
398 return (xcb_connection_t *) &xcb_con_error;
403 int _xcb_conn_wait(xcb_connection_t *c, pthread_cond_t *cond, struct iovec **vector, int *count)
412 /* If the thing I should be doing is already being done, wait for it. */
413 if(count ? c->out.writing : c->in.reading)
415 pthread_cond_wait(cond, &c->iolock);
420 memset(&fd, 0, sizeof(fd));
425 FD_SET(c->fd, &rfds);
432 fd.events |= POLLOUT;
439 FD_SET(c->fd, &wfds);
444 pthread_mutex_unlock(&c->iolock);
447 ret = poll(&fd, 1, -1);
448 /* If poll() returns an event we didn't expect, such as POLLNVAL, treat
449 * it as if it failed. */
450 if(ret >= 0 && (fd.revents & ~fd.events))
456 ret = select(c->fd + 1, &rfds, &wfds, 0, 0);
458 } while (ret == -1 && errno == EINTR);
461 _xcb_conn_shutdown(c, XCB_CONN_ERROR);
464 pthread_mutex_lock(&c->iolock);
468 /* The code allows two threads to call select()/poll() at the same time.
469 * First thread just wants to read, a second thread wants to write, too.
470 * We have to make sure that we don't steal the reading thread's reply
471 * and let it get stuck in select()/poll().
472 * So a thread may read if either:
473 * - There is no other thread that wants to read (the above situation
475 * - It is the reading thread (above situation occurred).
477 int may_read = c->in.reading == 1 || !count;
479 if(may_read && (fd.revents & POLLIN) != 0)
481 if(may_read && FD_ISSET(c->fd, &rfds))
483 ret = ret && _xcb_in_read(c);
486 if((fd.revents & POLLOUT) != 0)
488 if(FD_ISSET(c->fd, &wfds))
490 ret = ret && write_vec(c, vector, count);