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 sends stuff to the server. */
42 static inline void send_request(xcb_connection_t *c, int isvoid, enum workarounds workaround, int flags, struct iovec *vector, int count)
49 c->in.request_expected = c->out.request;
50 if(workaround != WORKAROUND_NONE || flags != 0)
51 _xcb_in_expect_reply(c, c->out.request, workaround, flags);
53 while(count && c->out.queue_len + vector[0].iov_len <= sizeof(c->out.queue))
55 memcpy(c->out.queue + c->out.queue_len, vector[0].iov_base, vector[0].iov_len);
56 c->out.queue_len += vector[0].iov_len;
57 vector[0].iov_base = (char *) vector[0].iov_base + vector[0].iov_len;
58 vector[0].iov_len = 0;
65 vector[0].iov_base = c->out.queue;
66 vector[0].iov_len = c->out.queue_len;
68 _xcb_out_send(c, vector, count);
71 static void send_sync(xcb_connection_t *c)
80 } sync_req = { { /* GetInputFocus */ 43, 0, 1 } };
81 struct iovec vector[2];
82 vector[1].iov_base = (char *) &sync_req;
83 vector[1].iov_len = sizeof(sync_req);
84 send_request(c, 0, WORKAROUND_NONE, XCB_REQUEST_DISCARD_REPLY, vector + 1, 1);
87 static void get_socket_back(xcb_connection_t *c)
89 while (c->out.return_socket) {
90 /* we are about to release the lock,
91 so make a copy of the current status */
92 xcb_return_socket_func_t return_socket = c->out.return_socket;
93 void *socket_closure = c->out.socket_closure;
94 int socket_seq = c->out.socket_seq;
96 pthread_mutex_unlock(&c->iolock);
97 return_socket(socket_closure);
98 pthread_mutex_lock(&c->iolock);
100 /* make sure nobody else has acquired the socket */
101 if (socket_seq == c->out.socket_seq) {
102 c->out.return_socket = 0;
103 c->out.socket_closure = 0;
104 _xcb_in_replies_done(c);
109 /* Public interface */
111 void xcb_prefetch_maximum_request_length(xcb_connection_t *c)
115 pthread_mutex_lock(&c->out.reqlenlock);
116 if(c->out.maximum_request_length_tag == LAZY_NONE)
118 const xcb_query_extension_reply_t *ext;
119 ext = xcb_get_extension_data(c, &xcb_big_requests_id);
120 if(ext && ext->present)
122 c->out.maximum_request_length_tag = LAZY_COOKIE;
123 c->out.maximum_request_length.cookie = xcb_big_requests_enable(c);
127 c->out.maximum_request_length_tag = LAZY_FORCED;
128 c->out.maximum_request_length.value = c->setup->maximum_request_length;
131 pthread_mutex_unlock(&c->out.reqlenlock);
134 uint32_t xcb_get_maximum_request_length(xcb_connection_t *c)
138 xcb_prefetch_maximum_request_length(c);
139 pthread_mutex_lock(&c->out.reqlenlock);
140 if(c->out.maximum_request_length_tag == LAZY_COOKIE)
142 xcb_big_requests_enable_reply_t *r = xcb_big_requests_enable_reply(c, c->out.maximum_request_length.cookie, 0);
143 c->out.maximum_request_length_tag = LAZY_FORCED;
146 c->out.maximum_request_length.value = r->maximum_request_length;
150 c->out.maximum_request_length.value = c->setup->maximum_request_length;
152 pthread_mutex_unlock(&c->out.reqlenlock);
153 return c->out.maximum_request_length.value;
156 unsigned int xcb_send_request(xcb_connection_t *c, int flags, struct iovec *vector, const xcb_protocol_request_t *req)
160 int veclen = req->count;
161 enum workarounds workaround = WORKAROUND_NONE;
168 assert(req->count > 0);
170 if(!(flags & XCB_REQUEST_RAW))
172 static const char pad[3];
174 uint16_t shortlen = 0;
176 assert(vector[0].iov_len >= 4);
177 /* set the major opcode, and the minor opcode for extensions */
180 const xcb_query_extension_reply_t *extension = xcb_get_extension_data(c, req->ext);
181 if(!(extension && extension->present))
183 _xcb_conn_shutdown(c, XCB_CONN_CLOSED_EXT_NOTSUPPORTED);
186 ((uint8_t *) vector[0].iov_base)[0] = extension->major_opcode;
187 ((uint8_t *) vector[0].iov_base)[1] = req->opcode;
190 ((uint8_t *) vector[0].iov_base)[0] = req->opcode;
192 /* put together the length field, possibly using BIGREQUESTS */
193 for(i = 0; i < req->count; ++i)
195 longlen += vector[i].iov_len;
196 if(!vector[i].iov_base)
198 vector[i].iov_base = (char *) pad;
199 assert(vector[i].iov_len <= sizeof(pad));
202 assert((longlen & 3) == 0);
205 if(longlen <= c->setup->maximum_request_length)
207 /* we don't need BIGREQUESTS. */
211 else if(longlen > xcb_get_maximum_request_length(c))
213 _xcb_conn_shutdown(c, XCB_CONN_CLOSED_REQ_LEN_EXCEED);
214 return 0; /* server can't take this; maybe need BIGREQUESTS? */
217 /* set the length field. */
218 ((uint16_t *) vector[0].iov_base)[1] = shortlen;
221 prefix[0] = ((uint32_t *) vector[0].iov_base)[0];
222 prefix[1] = ++longlen;
223 vector[0].iov_base = (uint32_t *) vector[0].iov_base + 1;
224 vector[0].iov_len -= sizeof(uint32_t);
226 vector[0].iov_base = prefix;
227 vector[0].iov_len = sizeof(prefix);
230 flags &= ~XCB_REQUEST_RAW;
232 /* do we need to work around the X server bug described in glx.xml? */
233 /* XXX: GetFBConfigs won't use BIG-REQUESTS in any sane
234 * configuration, but that should be handled here anyway. */
235 if(req->ext && !req->isvoid && !strcmp(req->ext->name, "GLX") &&
236 ((req->opcode == 17 && ((uint32_t *) vector[0].iov_base)[1] == 0x10004) ||
238 workaround = WORKAROUND_GLX_GET_FB_CONFIGS_BUG;
240 /* get a sequence number and arrange for delivery. */
241 pthread_mutex_lock(&c->iolock);
242 /* wait for other writing threads to get out of my way. */
243 while(c->out.writing)
244 pthread_cond_wait(&c->out.cond, &c->iolock);
247 /* send GetInputFocus (sync_req) when 64k-2 requests have been sent without
249 if(req->isvoid && c->out.request == c->in.request_expected + (1 << 16) - 2)
251 /* Also send sync_req (could use NoOp) at 32-bit wrap to avoid having
252 * applications see sequence 0 as that is used to indicate
253 * an error in sending the request */
254 if((unsigned int) (c->out.request + 1) == 0)
257 /* The above send_sync calls could drop the I/O lock, but this
258 * thread will still exclude any other thread that tries to write,
259 * so the sequence number postconditions still hold. */
260 send_request(c, req->isvoid, workaround, flags, vector, veclen);
261 request = c->has_error ? 0 : c->out.request;
262 pthread_mutex_unlock(&c->iolock);
267 xcb_send_fd(xcb_connection_t *c, int fd)
272 pthread_mutex_lock(&c->iolock);
273 while (c->out.out_fd.nfd == XCB_MAX_PASS_FD) {
274 _xcb_out_flush_to(c, c->out.request);
279 c->out.out_fd.fd[c->out.out_fd.nfd++] = fd;
280 pthread_mutex_unlock(&c->iolock);
284 int xcb_take_socket(xcb_connection_t *c, void (*return_socket)(void *closure), void *closure, int flags, uint64_t *sent)
289 pthread_mutex_lock(&c->iolock);
292 /* _xcb_out_flush may drop the iolock allowing other threads to
293 * write requests, so keep flushing until we're done
296 ret = _xcb_out_flush_to(c, c->out.request);
297 while (ret && c->out.request != c->out.request_written);
300 c->out.return_socket = return_socket;
301 c->out.socket_closure = closure;
304 _xcb_in_expect_reply(c, c->out.request, WORKAROUND_EXTERNAL_SOCKET_OWNER, flags);
305 assert(c->out.request == c->out.request_written);
306 *sent = c->out.request;
308 pthread_mutex_unlock(&c->iolock);
312 int xcb_writev(xcb_connection_t *c, struct iovec *vector, int count, uint64_t requests)
317 pthread_mutex_lock(&c->iolock);
318 c->out.request += requests;
319 ret = _xcb_out_send(c, vector, count);
320 pthread_mutex_unlock(&c->iolock);
324 int xcb_flush(xcb_connection_t *c)
329 pthread_mutex_lock(&c->iolock);
330 ret = _xcb_out_flush_to(c, c->out.request);
331 pthread_mutex_unlock(&c->iolock);
335 /* Private interface */
337 int _xcb_out_init(_xcb_out *out)
339 out->return_socket = 0;
340 out->socket_closure = 0;
343 if(pthread_cond_init(&out->cond, 0))
350 out->request_written = 0;
352 if(pthread_mutex_init(&out->reqlenlock, 0))
354 out->maximum_request_length_tag = LAZY_NONE;
359 void _xcb_out_destroy(_xcb_out *out)
361 pthread_cond_destroy(&out->cond);
362 pthread_mutex_destroy(&out->reqlenlock);
365 int _xcb_out_send(xcb_connection_t *c, struct iovec *vector, int count)
369 ret = _xcb_conn_wait(c, &c->out.cond, &vector, &count);
370 c->out.request_written = c->out.request;
371 pthread_cond_broadcast(&c->out.cond);
372 _xcb_in_wake_up_next_reader(c);
376 void _xcb_out_send_sync(xcb_connection_t *c)
378 /* wait for other writing threads to get out of my way. */
379 while(c->out.writing)
380 pthread_cond_wait(&c->out.cond, &c->iolock);
385 int _xcb_out_flush_to(xcb_connection_t *c, uint64_t request)
387 assert(XCB_SEQUENCE_COMPARE(request, <=, c->out.request));
388 if(XCB_SEQUENCE_COMPARE(c->out.request_written, >=, request))
393 vec.iov_base = c->out.queue;
394 vec.iov_len = c->out.queue_len;
395 c->out.queue_len = 0;
396 return _xcb_out_send(c, &vec, 1);
398 while(c->out.writing)
399 pthread_cond_wait(&c->out.cond, &c->iolock);
400 assert(XCB_SEQUENCE_COMPARE(c->out.request_written, >=, request));