Track 64-bit sequence numbers internally.
[free-sw/xcb/libxcb] / src / xcbint.h
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 };
45
46 enum lazy_reply_tag
47 {
48     LAZY_NONE = 0,
49     LAZY_COOKIE,
50     LAZY_FORCED
51 };
52
53 #define XCB_PAD(i) (-(i) & 3)
54
55 #define XCB_SEQUENCE_COMPARE(a,op,b)    ((int64_t) ((a) - (b)) op 0)
56 #define XCB_SEQUENCE_COMPARE_32(a,op,b) (((int) (a) - (int) (b)) op 0)
57
58 /* xcb_list.c */
59
60 typedef void (*xcb_list_free_func_t)(void *);
61
62 typedef struct _xcb_map _xcb_map;
63
64 _xcb_map *_xcb_map_new(void);
65 void _xcb_map_delete(_xcb_map *q, xcb_list_free_func_t do_free);
66 int _xcb_map_put(_xcb_map *q, unsigned int key, void *data);
67 void *_xcb_map_remove(_xcb_map *q, unsigned int key);
68
69
70 /* xcb_out.c */
71
72 typedef struct _xcb_out {
73     pthread_cond_t cond;
74     int writing;
75
76     char queue[XCB_QUEUE_BUFFER_SIZE];
77     int queue_len;
78
79     uint64_t request;
80     uint64_t request_written;
81
82     pthread_mutex_t reqlenlock;
83     enum lazy_reply_tag maximum_request_length_tag;
84     union {
85         xcb_big_requests_enable_cookie_t cookie;
86         uint32_t value;
87     } maximum_request_length;
88 } _xcb_out;
89
90 int _xcb_out_init(_xcb_out *out);
91 void _xcb_out_destroy(_xcb_out *out);
92
93 int _xcb_out_send(xcb_connection_t *c, struct iovec **vector, int *count);
94 int _xcb_out_flush_to(xcb_connection_t *c, uint64_t request);
95
96
97 /* xcb_in.c */
98
99 typedef struct _xcb_in {
100     pthread_cond_t event_cond;
101     int reading;
102
103     char queue[4096];
104     int queue_len;
105
106     uint64_t request_expected;
107     uint64_t request_read;
108     uint64_t request_completed;
109     struct reply_list *current_reply;
110     struct reply_list **current_reply_tail;
111
112     _xcb_map *replies;
113     struct event_list *events;
114     struct event_list **events_tail;
115     struct reader_list *readers;
116
117     struct pending_reply *pending_replies;
118     struct pending_reply **pending_replies_tail;
119 } _xcb_in;
120
121 int _xcb_in_init(_xcb_in *in);
122 void _xcb_in_destroy(_xcb_in *in);
123
124 int _xcb_in_expect_reply(xcb_connection_t *c, uint64_t request, enum workarounds workaround, int flags);
125
126 int _xcb_in_read(xcb_connection_t *c);
127 int _xcb_in_read_block(xcb_connection_t *c, void *buf, int nread);
128
129
130 /* xcb_xid.c */
131
132 typedef struct _xcb_xid {
133     pthread_mutex_t lock;
134     uint32_t last;
135     uint32_t base;
136     uint32_t max;
137     uint32_t inc;
138 } _xcb_xid;
139
140 int _xcb_xid_init(xcb_connection_t *c);
141 void _xcb_xid_destroy(xcb_connection_t *c);
142
143
144 /* xcb_ext.c */
145
146 typedef struct _xcb_ext {
147     pthread_mutex_t lock;
148     struct lazyreply *extensions;
149     int extensions_size;
150 } _xcb_ext;
151
152 int _xcb_ext_init(xcb_connection_t *c);
153 void _xcb_ext_destroy(xcb_connection_t *c);
154
155
156 /* xcb_conn.c */
157
158 struct xcb_connection_t {
159     int has_error;
160
161     /* constant data */
162     xcb_setup_t *setup;
163     int fd;
164
165     /* I/O data */
166     pthread_mutex_t iolock;
167     _xcb_in in;
168     _xcb_out out;
169
170     /* misc data */
171     _xcb_ext ext;
172     _xcb_xid xid;
173 };
174
175 void _xcb_conn_shutdown(xcb_connection_t *c);
176 int _xcb_conn_wait(xcb_connection_t *c, pthread_cond_t *cond, struct iovec **vector, int *count);
177
178
179 /* xcb_auth.c */
180
181 int _xcb_get_auth_info(int fd, xcb_auth_info_t *info, int display);
182
183 #ifdef GCC_HAS_VISIBILITY
184 #pragma GCC visibility pop
185 #endif
186
187 #endif