Move test for other writing threads *before* allocating a sequence number.
[free-sw/xcb/libxcb] / src / xcb_out.c
1 /* Copyright (C) 2001-2004 Bart Massey and Jamey Sharp.
2  *
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:
9  * 
10  * The above copyright notice and this permission notice shall be included in
11  * all copies or substantial portions of the Software.
12  * 
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.
19  * 
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.
24  */
25
26 /* Stuff that sends stuff to the server. */
27
28 #include <assert.h>
29 #include <stdlib.h>
30 #include <unistd.h>
31 #include <string.h>
32 #include <errno.h>
33
34 #ifndef __GNUC__
35 # if HAVE_ALLOCA_H
36 #  include <alloca.h>
37 # else
38 #  ifdef _AIX
39  #pragma alloca
40 #  endif
41 # endif
42 #endif
43
44 #include "xcb.h"
45 #include "xcbext.h"
46 #include "xcbint.h"
47 #include "extensions/bigreq.h"
48
49 static int force_sequence_wrap(XCBConnection *c)
50 {
51     int ret = 1;
52     if((c->out.request - c->in.request_read) > 65530)
53     {
54         pthread_mutex_unlock(&c->iolock);
55         ret = XCBSync(c, 0);
56         pthread_mutex_lock(&c->iolock);
57     }
58     return ret;
59 }
60
61 /* Public interface */
62
63 CARD32 XCBGetMaximumRequestLength(XCBConnection *c)
64 {
65     pthread_mutex_lock(&c->out.reqlenlock);
66     if(!c->out.maximum_request_length)
67     {
68         const XCBQueryExtensionRep *ext;
69         c->out.maximum_request_length = c->setup->maximum_request_length;
70         ext = XCBGetExtensionData(c, &XCBBigRequestsId);
71         if(ext && ext->present)
72         {
73             XCBBigRequestsEnableRep *r = XCBBigRequestsEnableReply(c, XCBBigRequestsEnable(c), 0);
74             c->out.maximum_request_length = r->maximum_request_length;
75             free(r);
76         }
77     }
78     pthread_mutex_unlock(&c->out.reqlenlock);
79     return c->out.maximum_request_length;
80 }
81
82 int XCBSendRequest(XCBConnection *c, unsigned int *request, int flags, struct iovec *vector, const XCBProtocolRequest *req)
83 {
84     static const char pad[3];
85     int ret;
86     int i;
87     struct iovec *padded;
88     int padlen = 0;
89     CARD16 shortlen = 0;
90     CARD32 longlen = 0;
91     enum workarounds workaround = WORKAROUND_NONE;
92
93     assert(c != 0);
94     assert(request != 0);
95     assert(vector != 0);
96     assert(req->count > 0);
97
98     /* set the major opcode, and the minor opcode for extensions */
99     if(req->ext)
100     {
101         const XCBQueryExtensionRep *extension = XCBGetExtensionData(c, req->ext);
102         /* TODO: better error handling here, please! */
103         assert(extension && extension->present);
104         ((CARD8 *) vector[0].iov_base)[0] = extension->major_opcode;
105         ((CARD8 *) vector[0].iov_base)[1] = req->opcode;
106
107         /* do we need to work around the X server bug described in glx.xml? */
108         if(!req->isvoid && strcmp(req->ext->name, "GLX") &&
109                 ((req->opcode == 17 && ((CARD32 *) vector[0].iov_base)[0] == 0x10004) ||
110                  req->opcode == 21))
111             workaround = WORKAROUND_GLX_GET_FB_CONFIGS_BUG;
112     }
113     else
114         ((CARD8 *) vector[0].iov_base)[0] = req->opcode;
115
116     /* put together the length field, possibly using BIGREQUESTS */
117     for(i = 0; i < req->count; ++i)
118         longlen += (vector[i].iov_len + 3) >> 2;
119
120     if(longlen <= c->setup->maximum_request_length)
121     {
122         /* we don't need BIGREQUESTS. */
123         shortlen = longlen;
124         longlen = 0;
125     }
126     else if(longlen > XCBGetMaximumRequestLength(c))
127         return 0; /* server can't take this; maybe need BIGREQUESTS? */
128
129     padded =
130 #ifdef HAVE_ALLOCA
131         alloca
132 #else
133         malloc
134 #endif
135         ((req->count * 2 + 3) * sizeof(struct iovec));
136     /* set the length field. */
137     ((CARD16 *) vector[0].iov_base)[1] = shortlen;
138     if(!shortlen)
139     {
140         padded[0].iov_base = vector[0].iov_base;
141         padded[0].iov_len = sizeof(CARD32);
142         vector[0].iov_base = ((char *) vector[0].iov_base) + sizeof(CARD32);
143         vector[0].iov_len -= sizeof(CARD32);
144         ++longlen;
145         padded[1].iov_base = &longlen;
146         padded[1].iov_len = sizeof(CARD32);
147         padlen = 2;
148     }
149
150     for(i = 0; i < req->count; ++i)
151     {
152         if(!vector[i].iov_len)
153             continue;
154         padded[padlen].iov_base = vector[i].iov_base;
155         padded[padlen++].iov_len = vector[i].iov_len;
156         if(!XCB_PAD(vector[i].iov_len))
157             continue;
158         padded[padlen].iov_base = (caddr_t) pad;
159         padded[padlen++].iov_len = XCB_PAD(vector[i].iov_len);
160     }
161
162     /* get a sequence number and arrange for delivery. */
163     pthread_mutex_lock(&c->iolock);
164     if(req->isvoid && !force_sequence_wrap(c))
165     {
166         pthread_mutex_unlock(&c->iolock);
167 #ifndef HAVE_ALLOCA
168         free(padded);
169 #endif
170         return -1;
171     }
172
173     /* wait for other writing threads to get out of my way. */
174     while(c->out.writing)
175         pthread_cond_wait(&c->out.cond, &c->iolock);
176
177     *request = ++c->out.request;
178
179     _xcb_in_expect_reply(c, *request, workaround, flags);
180
181     ret = _xcb_out_write_block(c, padded, padlen);
182     pthread_mutex_unlock(&c->iolock);
183 #ifndef HAVE_ALLOCA
184     free(padded);
185 #endif
186
187     return ret;
188 }
189
190 int XCBFlush(XCBConnection *c)
191 {
192     int ret;
193     pthread_mutex_lock(&c->iolock);
194     ret = _xcb_out_flush(c);
195     pthread_mutex_unlock(&c->iolock);
196     return ret;
197 }
198
199 /* Private interface */
200
201 int _xcb_out_init(_xcb_out *out)
202 {
203     if(pthread_cond_init(&out->cond, 0))
204         return 0;
205     out->writing = 0;
206
207     out->queue_len = 0;
208     out->vec = 0;
209     out->vec_len = 0;
210
211     out->request = 0;
212     out->request_written = 0;
213
214     if(pthread_mutex_init(&out->reqlenlock, 0))
215         return 0;
216     out->maximum_request_length = 0;
217
218     return 1;
219 }
220
221 void _xcb_out_destroy(_xcb_out *out)
222 {
223     pthread_cond_destroy(&out->cond);
224     pthread_mutex_destroy(&out->reqlenlock);
225 }
226
227 /* precondition: there must be something for us to write. */
228 int _xcb_out_write(XCBConnection *c)
229 {
230     int n;
231     assert(!c->out.queue_len);
232     n = writev(c->fd, c->out.vec, c->out.vec_len);
233     if(n < 0 && errno == EAGAIN)
234         return 1;
235     if(n <= 0)
236         return 0;
237
238     for(; c->out.vec_len; --c->out.vec_len, ++c->out.vec)
239     {
240         int cur = c->out.vec->iov_len;
241         if(cur > n)
242             cur = n;
243         c->out.vec->iov_len -= cur;
244         c->out.vec->iov_base = (char *) c->out.vec->iov_base + cur;
245         n -= cur;
246         if(c->out.vec->iov_len)
247             break;
248     }
249     if(!c->out.vec_len)
250         c->out.vec = 0;
251     assert(n == 0);
252     return 1;
253 }
254
255 int _xcb_out_write_block(XCBConnection *c, struct iovec *vector, size_t count)
256 {
257     assert(!c->out.vec && !c->out.vec_len);
258     while(count && c->out.queue_len + vector[0].iov_len < sizeof(c->out.queue))
259     {
260         memcpy(c->out.queue + c->out.queue_len, vector[0].iov_base, vector[0].iov_len);
261         c->out.queue_len += vector[0].iov_len;
262         ++vector, --count;
263     }
264     if(!count)
265         return 1;
266
267     memmove(vector + 1, vector, count++ * sizeof(struct iovec));
268     vector[0].iov_base = c->out.queue;
269     vector[0].iov_len = c->out.queue_len;
270     c->out.queue_len = 0;
271
272     c->out.vec_len = count;
273     c->out.vec = vector;
274     return _xcb_out_flush(c);
275 }
276
277 int _xcb_out_flush(XCBConnection *c)
278 {
279     int ret = 1;
280     struct iovec vec;
281     if(c->out.queue_len)
282     {
283         assert(!c->out.vec && !c->out.vec_len);
284         vec.iov_base = c->out.queue;
285         vec.iov_len = c->out.queue_len;
286         c->out.vec = &vec;
287         c->out.vec_len = 1;
288         c->out.queue_len = 0;
289     }
290     while(ret && c->out.vec_len)
291         ret = _xcb_conn_wait(c, /*should_write*/ 1, &c->out.cond);
292     c->out.request_written = c->out.request;
293     pthread_cond_broadcast(&c->out.cond);
294     return ret;
295 }