dixstruct.h revision 35c4bbdf 
1/***********************************************************
2Copyright 1987 by Digital Equipment Corporation, Maynard, Massachusetts.
3
4                        All Rights Reserved
5
6Permission to use, copy, modify, and distribute this software and its
7documentation for any purpose and without fee is hereby granted,
8provided that the above copyright notice appear in all copies and that
9both that copyright notice and this permission notice appear in
10supporting documentation, and that the name of Digital not be
11used in advertising or publicity pertaining to distribution of the
12software without specific, written prior permission.
13
14DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
15ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
16DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
17ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
18WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
19ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
20SOFTWARE.
21
22******************************************************************/
23
24#ifndef DIXSTRUCT_H
25#define DIXSTRUCT_H
26
27#include "client.h"
28#include "dix.h"
29#include "resource.h"
30#include "cursor.h"
31#include "gc.h"
32#include "pixmap.h"
33#include "privates.h"
34#include <X11/Xmd.h>
35
36/*
37 * 	direct-mapped hash table, used by resource manager to store
38 *      translation from client ids to server addresses.
39 */
40
41extern _X_EXPORT CallbackListPtr ClientStateCallback;
42
43typedef struct {
44    ClientPtr client;
45    xConnSetupPrefix *prefix;
46    xConnSetup *setup;
47} NewClientInfoRec;
48
49typedef void (*ReplySwapPtr) (ClientPtr /* pClient */ ,
50                              int /* size */ ,
51                              void * /* pbuf */ );
52
53extern _X_EXPORT void
54ReplyNotSwappd(ClientPtr /* pClient */ ,
55               int /* size */ ,
56               void * /* pbuf */ ) _X_NORETURN;
57
58typedef enum { ClientStateInitial,
59    ClientStateRunning,
60    ClientStateRetained,
61    ClientStateGone
62} ClientState;
63
64typedef struct _saveSet {
65    struct _Window *windowPtr;
66    Bool toRoot;
67    Bool map;
68} SaveSetElt;
69#define SaveSetWindow(ss)   ((ss).windowPtr)
70#define SaveSetToRoot(ss)   ((ss).toRoot)
71#define SaveSetShouldMap(ss)	    ((ss).map)
72#define SaveSetAssignWindow(ss,w)   ((ss).windowPtr = (w))
73#define SaveSetAssignToRoot(ss,tr)  ((ss).toRoot = (tr))
74#define SaveSetAssignMap(ss,m)      ((ss).map = (m))
75
76typedef struct _Client {
77    void *requestBuffer;
78    void *osPrivate;             /* for OS layer, including scheduler */
79    Mask clientAsMask;
80    short index;
81    unsigned char majorOp, minorOp;
82    unsigned int swapped:1;
83    unsigned int local:1;
84    unsigned int big_requests:1; /* supports large requests */
85    unsigned int clientGone:1;
86    unsigned int closeDownMode:2;
87    unsigned int clientState:2;
88    signed char smart_priority;
89    short noClientException;      /* this client died or needs to be killed */
90    int priority;
91    ReplySwapPtr pSwapReplyFunc;
92    XID errorValue;
93    int sequence;
94    int ignoreCount;            /* count for Attend/IgnoreClient */
95    int numSaved;
96    SaveSetElt *saveSet;
97    int (**requestVector) (ClientPtr /* pClient */ );
98    CARD32 req_len;             /* length of current request */
99    unsigned int replyBytesRemaining;
100    PrivateRec *devPrivates;
101    unsigned short xkbClientFlags;
102    unsigned short mapNotifyMask;
103    unsigned short newKeyboardNotifyMask;
104    unsigned short vMajor, vMinor;
105    KeyCode minKC, maxKC;
106
107    int smart_start_tick;
108    int smart_stop_tick;
109
110    DeviceIntPtr clientPtr;
111    ClientIdPtr clientIds;
112#if XTRANS_SEND_FDS
113    int req_fds;
114#endif
115} ClientRec;
116
117#if XTRANS_SEND_FDS
118static inline void
119SetReqFds(ClientPtr client, int req_fds) {
120    if (client->req_fds != 0 && req_fds != client->req_fds)
121        LogMessage(X_ERROR, "Mismatching number of request fds %d != %d\n", req_fds, client->req_fds);
122    client->req_fds = req_fds;
123}
124#endif
125
126/*
127 * Scheduling interface
128 */
129extern long SmartScheduleTime;
130extern long SmartScheduleInterval;
131extern long SmartScheduleSlice;
132extern long SmartScheduleMaxSlice;
133extern Bool SmartScheduleDisable;
134extern void SmartScheduleStartTimer(void);
135extern void SmartScheduleStopTimer(void);
136
137#define SMART_MAX_PRIORITY  (20)
138#define SMART_MIN_PRIORITY  (-20)
139
140extern void SmartScheduleInit(void);
141
142/* This prototype is used pervasively in Xext, dix */
143#define DISPATCH_PROC(func) int func(ClientPtr /* client */)
144
145typedef struct _WorkQueue {
146    struct _WorkQueue *next;
147    Bool (*function) (ClientPtr /* pClient */ ,
148                      void *    /* closure */
149        );
150    ClientPtr client;
151    void *closure;
152} WorkQueueRec;
153
154extern _X_EXPORT TimeStamp currentTime;
155
156extern _X_EXPORT int
157CompareTimeStamps(TimeStamp /*a */ ,
158                  TimeStamp /*b */ );
159
160extern _X_EXPORT TimeStamp
161ClientTimeToServerTime(CARD32 /*c */ );
162
163typedef struct _CallbackRec {
164    CallbackProcPtr proc;
165    void *data;
166    Bool deleted;
167    struct _CallbackRec *next;
168} CallbackRec, *CallbackPtr;
169
170typedef struct _CallbackList {
171    int inCallback;
172    Bool deleted;
173    int numDeleted;
174    CallbackPtr list;
175} CallbackListRec;
176
177/* proc vectors */
178
179extern int (*InitialVector[3]) (ClientPtr /*client */ );
180
181extern _X_EXPORT int (*ProcVector[256]) (ClientPtr /*client */ );
182
183extern _X_EXPORT int (*SwappedProcVector[256]) (ClientPtr /*client */ );
184
185extern ReplySwapPtr ReplySwapVector[256];
186
187extern _X_EXPORT int
188ProcBadRequest(ClientPtr /*client */ );
189
190#endif                          /* DIXSTRUCT_H */
191