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 xcb_setup_t xcb_error_setup = {
68 0, /* status: failed (but we wouldn't have a xcb_setup_t in this case) */
70 0, 0, /* protocol version, should be 11.0, but isn't */
71 0, /* length, invalid value */
72 0, /* release_number */
73 0, 0, /* resource_id_{base,mask} */
74 0, /* motion_buffer_size */
76 0, /* maximum_request_length */
78 0, /* pixmap_formats_len */
79 0, /* image_byte_order */
80 0, /* bitmap_format_bit_order */
81 0, /* bitmap_format_scanline_unit */
82 0, /* bitmap_format_scanline_pad */
83 0, 0, /* {min,max}_keycode */
84 { 0, 0, 0, 0 } /* pad1 */
87 /* Keep this list in sync with is_static_error_conn()! */
88 static const int xcb_con_error = XCB_CONN_ERROR;
89 static const int xcb_con_closed_mem_er = XCB_CONN_CLOSED_MEM_INSUFFICIENT;
90 static const int xcb_con_closed_parse_er = XCB_CONN_CLOSED_PARSE_ERR;
91 static const int xcb_con_closed_screen_er = XCB_CONN_CLOSED_INVALID_SCREEN;
93 static int is_static_error_conn(xcb_connection_t *c)
95 return c == (xcb_connection_t *) &xcb_con_error ||
96 c == (xcb_connection_t *) &xcb_con_closed_mem_er ||
97 c == (xcb_connection_t *) &xcb_con_closed_parse_er ||
98 c == (xcb_connection_t *) &xcb_con_closed_screen_er;
101 static int set_fd_flags(const int fd)
103 /* Win32 doesn't have file descriptors and the fcntl function. This block sets the socket in non-blocking mode */
106 u_long iMode = 1; /* non-zero puts it in non-blocking mode, 0 in blocking mode */
109 ret = ioctlsocket(fd, FIONBIO, &iMode);
114 int flags = fcntl(fd, F_GETFL, 0);
118 if(fcntl(fd, F_SETFL, flags) == -1)
120 if(fcntl(fd, F_SETFD, FD_CLOEXEC) == -1)
126 static int write_setup(xcb_connection_t *c, xcb_auth_info_t *auth_info)
128 static const char pad[3];
129 xcb_setup_request_t out;
130 struct iovec parts[6];
132 static const uint32_t endian = 0x01020304;
135 memset(&out, 0, sizeof(out));
137 /* B = 0x42 = MSB first, l = 0x6c = LSB first */
138 if(htonl(endian) == endian)
139 out.byte_order = 0x42;
141 out.byte_order = 0x6c;
142 out.protocol_major_version = X_PROTOCOL;
143 out.protocol_minor_version = X_PROTOCOL_REVISION;
144 out.authorization_protocol_name_len = 0;
145 out.authorization_protocol_data_len = 0;
146 parts[count].iov_len = sizeof(xcb_setup_request_t);
147 parts[count++].iov_base = &out;
148 parts[count].iov_len = XCB_PAD(sizeof(xcb_setup_request_t));
149 parts[count++].iov_base = (char *) pad;
153 parts[count].iov_len = out.authorization_protocol_name_len = auth_info->namelen;
154 parts[count++].iov_base = auth_info->name;
155 parts[count].iov_len = XCB_PAD(out.authorization_protocol_name_len);
156 parts[count++].iov_base = (char *) pad;
157 parts[count].iov_len = out.authorization_protocol_data_len = auth_info->datalen;
158 parts[count++].iov_base = auth_info->data;
159 parts[count].iov_len = XCB_PAD(out.authorization_protocol_data_len);
160 parts[count++].iov_base = (char *) pad;
162 assert(count <= (int) (sizeof(parts) / sizeof(*parts)));
164 pthread_mutex_lock(&c->iolock);
165 ret = _xcb_out_send(c, parts, count);
166 pthread_mutex_unlock(&c->iolock);
170 static int read_setup(xcb_connection_t *c)
172 /* Read the server response */
173 c->setup = malloc(sizeof(xcb_setup_generic_t));
177 if(_xcb_in_read_block(c, c->setup, sizeof(xcb_setup_generic_t)) != sizeof(xcb_setup_generic_t))
181 void *tmp = realloc(c->setup, c->setup->length * 4 + sizeof(xcb_setup_generic_t));
187 if(_xcb_in_read_block(c, (char *) c->setup + sizeof(xcb_setup_generic_t), c->setup->length * 4) <= 0)
190 /* 0 = failed, 2 = authenticate, 1 = success */
191 switch(c->setup->status)
195 xcb_setup_failed_t *setup = (xcb_setup_failed_t *) c->setup;
196 write(STDERR_FILENO, xcb_setup_failed_reason(setup), xcb_setup_failed_reason_length(setup));
200 case 2: /* authenticate */
202 xcb_setup_authenticate_t *setup = (xcb_setup_authenticate_t *) c->setup;
203 write(STDERR_FILENO, xcb_setup_authenticate_reason(setup), xcb_setup_authenticate_reason_length(setup));
211 /* precondition: there must be something for us to write. */
212 static int write_vec(xcb_connection_t *c, struct iovec **vector, int *count)
215 assert(!c->out.queue_len);
223 /* Could use the WSASend win32 function for scatter/gather i/o but setting up the WSABUF struct from
224 an iovec would require more work and I'm not sure of the benefit....works for now */
228 ret = send(c->fd,vec->iov_base,vec->iov_len,0);
229 if(ret == SOCKET_ERROR)
231 err = WSAGetLastError();
232 if(err == WSAEWOULDBLOCK)
247 if (c->out.out_fd.nfd) {
249 struct cmsghdr cmsghdr;
250 char buf[CMSG_SPACE(XCB_MAX_PASS_FD * sizeof(int))];
252 struct msghdr msg = {
257 .msg_control = cmsgbuf.buf,
258 .msg_controllen = CMSG_LEN(c->out.out_fd.nfd * sizeof (int)),
261 struct cmsghdr *hdr = CMSG_FIRSTHDR(&msg);
263 hdr->cmsg_len = msg.msg_controllen;
264 hdr->cmsg_level = SOL_SOCKET;
265 hdr->cmsg_type = SCM_RIGHTS;
266 memcpy(CMSG_DATA(hdr), c->out.out_fd.fd, c->out.out_fd.nfd * sizeof (int));
268 n = sendmsg(c->fd, &msg, 0);
269 if(n < 0 && errno == EAGAIN)
271 for (i = 0; i < c->out.out_fd.nfd; i++)
272 close(c->out.out_fd.fd[i]);
273 c->out.out_fd.nfd = 0;
277 n = writev(c->fd, *vector, n);
278 if(n < 0 && errno == EAGAIN)
286 _xcb_conn_shutdown(c, XCB_CONN_ERROR);
290 for(; *count; --*count, ++*vector)
292 int cur = (*vector)->iov_len;
295 (*vector)->iov_len -= cur;
296 (*vector)->iov_base = (char *) (*vector)->iov_base + cur;
298 if((*vector)->iov_len)
307 /* Public interface */
309 const xcb_setup_t *xcb_get_setup(xcb_connection_t *c)
311 if(is_static_error_conn(c))
312 return &xcb_error_setup;
313 /* doesn't need locking because it's never written to. */
317 int xcb_get_file_descriptor(xcb_connection_t *c)
319 if(is_static_error_conn(c))
321 /* doesn't need locking because it's never written to. */
325 int xcb_connection_has_error(xcb_connection_t *c)
327 /* doesn't need locking because it's read and written atomically. */
331 xcb_connection_t *xcb_connect_to_fd(int fd, xcb_auth_info_t *auth_info)
337 if(fd >= FD_SETSIZE) /* would overflow in FD_SET */
340 return _xcb_conn_ret_error(XCB_CONN_ERROR);
345 c = calloc(1, sizeof(xcb_connection_t));
348 return _xcb_conn_ret_error(XCB_CONN_CLOSED_MEM_INSUFFICIENT) ;
355 pthread_mutex_init(&c->iolock, 0) == 0 &&
356 _xcb_in_init(&c->in) &&
357 _xcb_out_init(&c->out) &&
358 write_setup(c, auth_info) &&
365 return _xcb_conn_ret_error(XCB_CONN_ERROR);
371 void xcb_disconnect(xcb_connection_t *c)
373 if(c == NULL || is_static_error_conn(c))
378 /* disallow further sends and receives */
379 shutdown(c->fd, SHUT_RDWR);
382 pthread_mutex_destroy(&c->iolock);
383 _xcb_in_destroy(&c->in);
384 _xcb_out_destroy(&c->out);
396 /* Private interface */
398 void _xcb_conn_shutdown(xcb_connection_t *c, int err)
403 /* Return connection error state.
404 * To make thread-safe, I need a seperate static
405 * variable for every possible error.
406 * has_error is the first field in xcb_connection_t, so just
407 * return a casted int here; checking has_error (and only
408 * has_error) will be safe.
410 xcb_connection_t *_xcb_conn_ret_error(int err)
415 case XCB_CONN_CLOSED_MEM_INSUFFICIENT:
417 return (xcb_connection_t *) &xcb_con_closed_mem_er;
419 case XCB_CONN_CLOSED_PARSE_ERR:
421 return (xcb_connection_t *) &xcb_con_closed_parse_er;
423 case XCB_CONN_CLOSED_INVALID_SCREEN:
425 return (xcb_connection_t *) &xcb_con_closed_screen_er;
430 return (xcb_connection_t *) &xcb_con_error;
435 int _xcb_conn_wait(xcb_connection_t *c, pthread_cond_t *cond, struct iovec **vector, int *count)
444 /* If the thing I should be doing is already being done, wait for it. */
445 if(count ? c->out.writing : c->in.reading)
447 pthread_cond_wait(cond, &c->iolock);
452 memset(&fd, 0, sizeof(fd));
457 FD_SET(c->fd, &rfds);
464 fd.events |= POLLOUT;
471 FD_SET(c->fd, &wfds);
476 pthread_mutex_unlock(&c->iolock);
479 ret = poll(&fd, 1, -1);
480 /* If poll() returns an event we didn't expect, such as POLLNVAL, treat
481 * it as if it failed. */
482 if(ret >= 0 && (fd.revents & ~fd.events))
488 ret = select(c->fd + 1, &rfds, &wfds, 0, 0);
490 } while (ret == -1 && errno == EINTR);
493 _xcb_conn_shutdown(c, XCB_CONN_ERROR);
496 pthread_mutex_lock(&c->iolock);
500 /* The code allows two threads to call select()/poll() at the same time.
501 * First thread just wants to read, a second thread wants to write, too.
502 * We have to make sure that we don't steal the reading thread's reply
503 * and let it get stuck in select()/poll().
504 * So a thread may read if either:
505 * - There is no other thread that wants to read (the above situation
507 * - It is the reading thread (above situation occurred).
509 int may_read = c->in.reading == 1 || !count;
511 if(may_read && (fd.revents & POLLIN) != 0)
513 if(may_read && FD_ISSET(c->fd, &rfds))
515 ret = ret && _xcb_in_read(c);
518 if((fd.revents & POLLOUT) != 0)
520 if(FD_ISSET(c->fd, &wfds))
522 ret = ret && write_vec(c, vector, count);