xcbint.h revision 1c7386f4 
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
41enum workarounds {
42    WORKAROUND_NONE,
43    WORKAROUND_GLX_GET_FB_CONFIGS_BUG,
44    WORKAROUND_EXTERNAL_SOCKET_OWNER
45};
46
47enum 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
70typedef void (*xcb_list_free_func_t)(void *);
71
72typedef struct _xcb_map _xcb_map;
73
74_xcb_map *_xcb_map_new(void);
75void _xcb_map_delete(_xcb_map *q, xcb_list_free_func_t do_free);
76int _xcb_map_put(_xcb_map *q, unsigned int key, void *data);
77void *_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
85typedef struct _xcb_fd {
86    int fd[XCB_MAX_PASS_FD];
87    int nfd;
88    int ifd;
89} _xcb_fd;
90#endif
91
92typedef 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
107    pthread_mutex_t reqlenlock;
108    enum lazy_reply_tag maximum_request_length_tag;
109    union {
110        xcb_big_requests_enable_cookie_t cookie;
111        uint32_t value;
112    } maximum_request_length;
113#if HAVE_SENDMSG
114    _xcb_fd out_fd;
115#endif
116} _xcb_out;
117
118int _xcb_out_init(_xcb_out *out);
119void _xcb_out_destroy(_xcb_out *out);
120
121int _xcb_out_send(xcb_connection_t *c, struct iovec *vector, int count);
122void _xcb_out_send_sync(xcb_connection_t *c);
123int _xcb_out_flush_to(xcb_connection_t *c, uint64_t request);
124
125
126/* xcb_in.c */
127
128typedef struct _xcb_in {
129    pthread_cond_t event_cond;
130    int reading;
131
132    char queue[4096];
133    int queue_len;
134
135    uint64_t request_expected;
136    uint64_t request_read;
137    uint64_t request_completed;
138    struct reply_list *current_reply;
139    struct reply_list **current_reply_tail;
140
141    _xcb_map *replies;
142    struct event_list *events;
143    struct event_list **events_tail;
144    struct reader_list *readers;
145
146    struct pending_reply *pending_replies;
147    struct pending_reply **pending_replies_tail;
148#if HAVE_SENDMSG
149    _xcb_fd in_fd;
150#endif
151    struct xcb_special_event *special_events;
152} _xcb_in;
153
154int _xcb_in_init(_xcb_in *in);
155void _xcb_in_destroy(_xcb_in *in);
156
157void _xcb_in_wake_up_next_reader(xcb_connection_t *c);
158
159int _xcb_in_expect_reply(xcb_connection_t *c, uint64_t request, enum workarounds workaround, int flags);
160void _xcb_in_replies_done(xcb_connection_t *c);
161
162int _xcb_in_read(xcb_connection_t *c);
163int _xcb_in_read_block(xcb_connection_t *c, void *buf, int nread);
164
165
166/* xcb_xid.c */
167
168typedef struct _xcb_xid {
169    pthread_mutex_t lock;
170    uint32_t last;
171    uint32_t base;
172    uint32_t max;
173    uint32_t inc;
174} _xcb_xid;
175
176int _xcb_xid_init(xcb_connection_t *c);
177void _xcb_xid_destroy(xcb_connection_t *c);
178
179
180/* xcb_ext.c */
181
182typedef struct _xcb_ext {
183    pthread_mutex_t lock;
184    struct lazyreply *extensions;
185    int extensions_size;
186} _xcb_ext;
187
188int _xcb_ext_init(xcb_connection_t *c);
189void _xcb_ext_destroy(xcb_connection_t *c);
190
191
192/* xcb_conn.c */
193
194struct xcb_connection_t {
195    /* This must be the first field; see _xcb_conn_ret_error(). */
196    int has_error;
197
198    /* constant data */
199    xcb_setup_t *setup;
200    int fd;
201
202    /* I/O data */
203    pthread_mutex_t iolock;
204    _xcb_in in;
205    _xcb_out out;
206
207    /* misc data */
208    _xcb_ext ext;
209    _xcb_xid xid;
210};
211
212void _xcb_conn_shutdown(xcb_connection_t *c, int err);
213
214xcb_connection_t *_xcb_conn_ret_error(int err);
215
216int _xcb_conn_wait(xcb_connection_t *c, pthread_cond_t *cond, struct iovec **vector, int *count);
217
218
219/* xcb_auth.c */
220
221int _xcb_get_auth_info(int fd, xcb_auth_info_t *info, int display);
222
223#ifdef GCC_HAS_VISIBILITY
224#pragma GCC visibility pop
225#endif
226
227#endif
228