auth: use snprintf() return value
[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     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 #define XCB_SEQUENCE_COMPARE_32(a,op,b) (((int) (a) - (int) (b)) op 0)
58
59 #ifndef offsetof
60 #define offsetof(type,member) ((size_t) &((type *)0)->member)
61 #endif
62
63 #ifndef MIN
64 #define MIN(x,y) ((x) < (y) ? (x) : (y))
65 #endif
66
67 #define container_of(pointer,type,member) ((type *)(((char *)(pointer)) - offsetof(type, member)))
68
69 /* xcb_list.c */
70
71 typedef void (*xcb_list_free_func_t)(void *);
72
73 typedef struct _xcb_map _xcb_map;
74
75 _xcb_map *_xcb_map_new(void);
76 void _xcb_map_delete(_xcb_map *q, xcb_list_free_func_t do_free);
77 int _xcb_map_put(_xcb_map *q, unsigned int key, void *data);
78 void *_xcb_map_remove(_xcb_map *q, unsigned int key);
79
80
81 /* xcb_out.c */
82
83 typedef struct _xcb_out {
84     pthread_cond_t cond;
85     int writing;
86
87     pthread_cond_t socket_cond;
88     void (*return_socket)(void *closure);
89     void *socket_closure;
90     int socket_moving;
91
92     char queue[XCB_QUEUE_BUFFER_SIZE];
93     int queue_len;
94
95     uint64_t request;
96     uint64_t request_written;
97
98     pthread_mutex_t reqlenlock;
99     enum lazy_reply_tag maximum_request_length_tag;
100     union {
101         xcb_big_requests_enable_cookie_t cookie;
102         uint32_t value;
103     } maximum_request_length;
104 } _xcb_out;
105
106 int _xcb_out_init(_xcb_out *out);
107 void _xcb_out_destroy(_xcb_out *out);
108
109 int _xcb_out_send(xcb_connection_t *c, struct iovec **vector, int *count);
110 int _xcb_out_flush_to(xcb_connection_t *c, uint64_t request);
111
112
113 /* xcb_in.c */
114
115 typedef struct _xcb_in {
116     pthread_cond_t event_cond;
117     int reading;
118
119     char queue[4096];
120     int queue_len;
121
122     uint64_t request_expected;
123     uint64_t request_read;
124     uint64_t request_completed;
125     struct reply_list *current_reply;
126     struct reply_list **current_reply_tail;
127
128     _xcb_map *replies;
129     struct event_list *events;
130     struct event_list **events_tail;
131     struct reader_list *readers;
132
133     struct pending_reply *pending_replies;
134     struct pending_reply **pending_replies_tail;
135 } _xcb_in;
136
137 int _xcb_in_init(_xcb_in *in);
138 void _xcb_in_destroy(_xcb_in *in);
139
140 int _xcb_in_expect_reply(xcb_connection_t *c, uint64_t request, enum workarounds workaround, int flags);
141 void _xcb_in_replies_done(xcb_connection_t *c);
142
143 int _xcb_in_read(xcb_connection_t *c);
144 int _xcb_in_read_block(xcb_connection_t *c, void *buf, int nread);
145
146
147 /* xcb_xid.c */
148
149 typedef struct _xcb_xid {
150     pthread_mutex_t lock;
151     uint32_t last;
152     uint32_t base;
153     uint32_t max;
154     uint32_t inc;
155 } _xcb_xid;
156
157 int _xcb_xid_init(xcb_connection_t *c);
158 void _xcb_xid_destroy(xcb_connection_t *c);
159
160
161 /* xcb_ext.c */
162
163 typedef struct _xcb_ext {
164     pthread_mutex_t lock;
165     struct lazyreply *extensions;
166     int extensions_size;
167 } _xcb_ext;
168
169 int _xcb_ext_init(xcb_connection_t *c);
170 void _xcb_ext_destroy(xcb_connection_t *c);
171
172
173 /* xcb_conn.c */
174
175 struct xcb_connection_t {
176     int has_error;
177
178     /* constant data */
179     xcb_setup_t *setup;
180     int fd;
181
182     /* I/O data */
183     pthread_mutex_t iolock;
184     _xcb_in in;
185     _xcb_out out;
186
187     /* misc data */
188     _xcb_ext ext;
189     _xcb_xid xid;
190 };
191
192 void _xcb_conn_shutdown(xcb_connection_t *c);
193 int _xcb_conn_wait(xcb_connection_t *c, pthread_cond_t *cond, struct iovec **vector, int *count);
194
195
196 /* xcb_auth.c */
197
198 int _xcb_get_auth_info(int fd, xcb_auth_info_t *info, int display);
199
200 #ifdef GCC_HAS_VISIBILITY
201 #pragma GCC visibility pop
202 #endif
203
204 #endif