1 /*
2  * Copyright (C) 2001-2004 Bart Massey and Jamey Sharp.
3  * All Rights Reserved.
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a
6  * copy of this software and associated documentation files (the "Software"),
7  * to deal in the Software without restriction, including without limitation
8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9  * and/or sell copies of the Software, and to permit persons to whom the
10  * Software is furnished to do so, subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be included in
13  * all copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18  * AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
19  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21  *
22  * Except as contained in this notice, the names of the authors or their
23  * institutions shall not be used in advertising or otherwise to promote the
24  * sale, use or other dealings in this Software without prior written
25  * authorization from the authors.
26  */
27 
28 #ifndef __XCBINT_H
29 #define __XCBINT_H
30 
31 #include "bigreq.h"
32 
33 #ifdef HAVE_CONFIG_H
34 #include "config.h"
35 #endif
36 
37 #ifdef GCC_HAS_VISIBILITY
38 #pragma GCC visibility push(hidden)
39 #endif
40 
41 enum workarounds {
42     WORKAROUND_NONE,
43     WORKAROUND_GLX_GET_FB_CONFIGS_BUG,
44     WORKAROUND_EXTERNAL_SOCKET_OWNER
45 };
46 
47 enum lazy_reply_tag
48 {
49     LAZY_NONE = 0,
50     LAZY_COOKIE,
51     LAZY_FORCED
52 };
53 
54 #define XCB_PAD(i) (-(i) & 3)
55 
56 #define XCB_SEQUENCE_COMPARE(a,op,b)    ((int64_t) ((a) - (b)) op 0)
57 
58 #ifndef offsetof
59 #define offsetof(type,member) ((size_t) &((type *)0)->member)
60 #endif
61 
62 #ifndef MIN
63 #define MIN(x,y) ((x) < (y) ? (x) : (y))
64 #endif
65 
66 #define container_of(pointer,type,member) ((type *)(((char *)(pointer)) - offsetof(type, member)))
67 
68 /* xcb_list.c */
69 
70 typedef void (*xcb_list_free_func_t)(void *);
71 
72 typedef struct _xcb_map _xcb_map;
73 
74 _xcb_map *_xcb_map_new(void);
75 void _xcb_map_delete(_xcb_map *q, xcb_list_free_func_t do_free);
76 int _xcb_map_put(_xcb_map *q, unsigned int key, void *data);
77 void *_xcb_map_remove(_xcb_map *q, unsigned int key);
78 
79 
80 /* xcb_out.c */
81 
82 #if HAVE_SENDMSG
83 #define XCB_MAX_PASS_FD 16
84 
85 typedef struct _xcb_fd {
86     int fd[XCB_MAX_PASS_FD];
87     int nfd;
88     int ifd;
89 } _xcb_fd;
90 #endif
91 
92 typedef struct _xcb_out {
93     pthread_cond_t cond;
94     int writing;
95 
96     pthread_cond_t socket_cond;
97     void (*return_socket)(void *closure);
98     void *socket_closure;
99     int socket_moving;
100 
101     char queue[XCB_QUEUE_BUFFER_SIZE];
102     int queue_len;
103 
104     uint64_t request;
105     uint64_t request_written;
106     uint64_t total_written;
107 
108     pthread_mutex_t reqlenlock;
109     enum lazy_reply_tag maximum_request_length_tag;
110     union {
111         xcb_big_requests_enable_cookie_t cookie;
112         uint32_t value;
113     } maximum_request_length;
114 #if HAVE_SENDMSG
115     _xcb_fd out_fd;
116 #endif
117 } _xcb_out;
118 
119 int _xcb_out_init(_xcb_out *out);
120 void _xcb_out_destroy(_xcb_out *out);
121 
122 int _xcb_out_send(xcb_connection_t *c, struct iovec *vector, int count);
123 void _xcb_out_send_sync(xcb_connection_t *c);
124 int _xcb_out_flush_to(xcb_connection_t *c, uint64_t request);
125 
126 
127 /* xcb_in.c */
128 
129 typedef struct _xcb_in {
130     pthread_cond_t event_cond;
131     int reading;
132 
133     char queue[4096];
134     int queue_len;
135 
136     uint64_t request_expected;
137     uint64_t request_read;
138     uint64_t request_completed;
139     uint64_t total_read;
140     struct reply_list *current_reply;
141     struct reply_list **current_reply_tail;
142 
143     _xcb_map *replies;
144     struct event_list *events;
145     struct event_list **events_tail;
146     struct reader_list *readers;
147     struct special_list *special_waiters;
148 
149     struct pending_reply *pending_replies;
150     struct pending_reply **pending_replies_tail;
151 #if HAVE_SENDMSG
152     _xcb_fd in_fd;
153 #endif
154     struct xcb_special_event *special_events;
155 } _xcb_in;
156 
157 int _xcb_in_init(_xcb_in *in);
158 void _xcb_in_destroy(_xcb_in *in);
159 
160 void _xcb_in_wake_up_next_reader(xcb_connection_t *c);
161 
162 int _xcb_in_expect_reply(xcb_connection_t *c, uint64_t request, enum workarounds workaround, int flags);
163 void _xcb_in_replies_done(xcb_connection_t *c);
164 
165 int _xcb_in_read(xcb_connection_t *c);
166 int _xcb_in_read_block(xcb_connection_t *c, void *buf, int nread);
167 
168 
169 /* xcb_xid.c */
170 
171 typedef struct _xcb_xid {
172     pthread_mutex_t lock;
173     uint32_t last;
174     uint32_t base;
175     uint32_t max;
176     uint32_t inc;
177 } _xcb_xid;
178 
179 int _xcb_xid_init(xcb_connection_t *c);
180 void _xcb_xid_destroy(xcb_connection_t *c);
181 
182 
183 /* xcb_ext.c */
184 
185 typedef struct _xcb_ext {
186     pthread_mutex_t lock;
187     struct lazyreply *extensions;
188     int extensions_size;
189 } _xcb_ext;
190 
191 int _xcb_ext_init(xcb_connection_t *c);
192 void _xcb_ext_destroy(xcb_connection_t *c);
193 
194 
195 /* xcb_conn.c */
196 
197 struct xcb_connection_t {
198     /* This must be the first field; see _xcb_conn_ret_error(). */
199     int has_error;
200 
201     /* constant data */
202     xcb_setup_t *setup;
203     int fd;
204 
205     /* I/O data */
206     pthread_mutex_t iolock;
207     _xcb_in in;
208     _xcb_out out;
209 
210     /* misc data */
211     _xcb_ext ext;
212     _xcb_xid xid;
213 };
214 
215 void _xcb_conn_shutdown(xcb_connection_t *c, int err);
216 
217 xcb_connection_t *_xcb_conn_ret_error(int err);
218 
219 int _xcb_conn_wait(xcb_connection_t *c, pthread_cond_t *cond, struct iovec **vector, int *count);
220 
221 
222 /* xcb_auth.c */
223 
224 int _xcb_get_auth_info(int fd, xcb_auth_info_t *info, int display);
225 
226 #ifdef GCC_HAS_VISIBILITY
227 #pragma GCC visibility pop
228 #endif
229 
230 #endif
231