aboutsummaryrefslogtreecommitdiff
path: root/xorg-server/dix/privates.c
blob: 6d76ccff2dc8c92c523f99263821198561a154ed (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
/*

Copyright 1993, 1998  The Open Group

Permission to use, copy, modify, distribute, and sell this software and its
documentation for any purpose is hereby granted without fee, provided that
the above copyright notice appear in all copies and that both that
copyright notice and this permission notice appear in supporting
documentation.

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Except as contained in this notice, the name of The Open Group shall
not be used in advertising or otherwise to promote the sale, use or
other dealings in this Software without prior written authorization
from The Open Group.

*/
/*
 * Copyright © 2010, Keith Packard
 * Copyright © 2010, Jamey Sharp
 *
 * Permission to use, copy, modify, distribute, and sell this software and its
 * documentation for any purpose is hereby granted without fee, provided that
 * the above copyright notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting documentation, and
 * that the name of the copyright holders not be used in advertising or
 * publicity pertaining to distribution of the software without specific,
 * written prior permission.  The copyright holders make no representations
 * about the suitability of this software for any purpose.  It is provided "as
 * is" without express or implied warranty.
 *
 * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
 * OF THIS SOFTWARE.
 */

#ifdef HAVE_DIX_CONFIG_H
#include <dix-config.h>
#endif

#include <stddef.h>
#include "windowstr.h"
#include "resource.h"
#include "privates.h"
#include "gcstruct.h"
#include "cursorstr.h"
#include "colormapst.h"
#include "inputstr.h"
#include "scrnintstr.h"
#include "extnsionst.h"

static struct {
    DevPrivateKey	key;
    unsigned		offset;
    int			created;
    int			allocated;
} keys[PRIVATE_LAST];

static const Bool xselinux_private[PRIVATE_LAST] = {
    [PRIVATE_CLIENT] = TRUE,
    [PRIVATE_WINDOW] = TRUE,
    [PRIVATE_PIXMAP] = TRUE,
    [PRIVATE_GC] = TRUE,
    [PRIVATE_CURSOR] = TRUE,
    [PRIVATE_COLORMAP] = TRUE,
    [PRIVATE_DEVICE] = TRUE,
    [PRIVATE_EXTENSION] = TRUE,
    [PRIVATE_SELECTION] = TRUE,
    [PRIVATE_PROPERTY] = TRUE,
    [PRIVATE_PICTURE] = TRUE,
    [PRIVATE_GLYPHSET] = TRUE,
};

typedef Bool (*FixupFunc)(PrivatePtr *privates, int offset, unsigned bytes);

static Bool
dixReallocPrivates(PrivatePtr *privates, int old_offset, unsigned bytes)
{
    void	*new_privates;

    new_privates = realloc(*privates, old_offset + bytes);
    if (!new_privates)
	return FALSE;
    memset((char *) new_privates + old_offset, '\0', bytes);
    *privates = new_privates;
    return TRUE;
}

static Bool
dixMovePrivates(PrivatePtr *privates, int new_offset, unsigned bytes)
{
    memmove((char *) *privates + bytes, *privates, new_offset - bytes);
    memset(*privates, '\0', bytes);
    return TRUE;
}

static Bool
fixupScreens(FixupFunc fixup, unsigned bytes)
{
    int s;
    for (s = 0; s < screenInfo.numScreens; s++)
	if (!fixup(&screenInfo.screens[s]->devPrivates, keys[PRIVATE_SCREEN].offset, bytes))
	    return FALSE;
    return TRUE;
}

static Bool
fixupServerClient(FixupFunc fixup, unsigned bytes)
{
    if (serverClient)
	return fixup(&serverClient->devPrivates, keys[PRIVATE_CLIENT].offset, bytes);
    return TRUE;
}

static Bool
fixupExtensions(FixupFunc fixup, unsigned bytes)
{
    unsigned char 	major;
    ExtensionEntry	*extension;
    for (major = EXTENSION_BASE; (extension = GetExtensionEntry(major)); major++)
	if (!fixup(&extension->devPrivates, keys[PRIVATE_EXTENSION].offset, bytes))
	    return FALSE;
    return TRUE;
}

static Bool
fixupDefaultColormaps(FixupFunc fixup, unsigned bytes)
{
    int s;
    for (s = 0; s < screenInfo.numScreens; s++) {
	ColormapPtr cmap;
	dixLookupResourceByType((pointer *) &cmap, screenInfo.screens[s]->defColormap,
	                        RT_COLORMAP, serverClient, DixCreateAccess);
	if (cmap && !fixup(&cmap->devPrivates, keys[PRIVATE_COLORMAP].offset, bytes))
	    return FALSE;
    }
    return TRUE;
}

static Bool (* const allocated_early[PRIVATE_LAST])(FixupFunc, unsigned) = {
    [PRIVATE_SCREEN] = fixupScreens,
    [PRIVATE_CLIENT] = fixupServerClient,
    [PRIVATE_EXTENSION] = fixupExtensions,
    [PRIVATE_COLORMAP] = fixupDefaultColormaps,
};

/*
 * Register a private key. This takes the type of object the key will
 * be used with, which may be PRIVATE_ALL indicating that this key
 * will be used with all of the private objects. If 'size' is
 * non-zero, then the specified amount of space will be allocated in
 * the private storage. Otherwise, space for a single pointer will
 * be allocated which can be set with dixSetPrivate
 */
Bool
dixRegisterPrivateKey(DevPrivateKey key, DevPrivateType type, unsigned size)
{
    DevPrivateType	t;
    int			offset;
    unsigned		bytes;

    if (key->initialized) {
	assert (size == key->size);
	return TRUE;
    }

    /* Compute required space */
    bytes = size;
    if (size == 0)
	bytes = sizeof (void *);

    /* align to void * size */
    bytes = (bytes + sizeof (void *) - 1) & ~(sizeof (void *) - 1);

    /* Update offsets for all affected keys */
    if (type == PRIVATE_XSELINUX) {
	DevPrivateKey	k;

	/* Resize if we can, or make sure nothing's allocated if we can't
	 */
	for (t = PRIVATE_XSELINUX; t < PRIVATE_LAST; t++)
	    if (xselinux_private[t]) {
		if (!allocated_early[t])
		    assert (!keys[t].created);
		else if (!allocated_early[t](dixReallocPrivates, bytes))
		    return FALSE;
	    }

	/* Move all existing keys up in the privates space to make
	 * room for this new global key
	 */
	for (t = PRIVATE_XSELINUX; t < PRIVATE_LAST; t++) {
	    if (xselinux_private[t]) {
		for (k = keys[t].key; k; k = k->next)
		    k->offset += bytes;
		keys[t].offset += bytes;
		if (allocated_early[t])
		    allocated_early[t](dixMovePrivates, bytes);
	    }
	}

	offset = 0;
    } else {
	/* Resize if we can, or make sure nothing's allocated if we can't */
	if (!allocated_early[type])
	    assert(!keys[type].created);
	else if (!allocated_early[type](dixReallocPrivates, bytes))
	    return FALSE;
	offset = keys[type].offset;
	keys[type].offset += bytes;
    }

    /* Setup this key */
    key->offset = offset;
    key->size = size;
    key->initialized = TRUE;
    key->type = type;
    key->allocated = FALSE;
    key->next = keys[type].key;
    keys[type].key = key;

    return TRUE;
}

/*
 * Allocate a new private key.
 *
 * This manages the storage of the key object itself, freeing it when the
 * privates system is restarted at server reset time. All other keys
 * are expected to be statically allocated as the privates must be
 * reset after all objects have been freed
 */
DevPrivateKey
dixCreatePrivateKey(DevPrivateType type, unsigned size)
{
    DevPrivateKey	key;

    key = calloc(sizeof (DevPrivateKeyRec), 1);
    if (!key)
	return NULL;
    if (!dixRegisterPrivateKey(key, type, size)) {
	free(key);
	return NULL;
    }
    key->allocated = TRUE;
    return key;
}

/*
 * Initialize privates by zeroing them
 */
void
_dixInitPrivates(PrivatePtr *privates, void *addr, DevPrivateType type)
{
    keys[type].created++;
    if (xselinux_private[type])
	keys[PRIVATE_XSELINUX].created++;
    if (keys[type].offset == 0)
	addr = 0;
    *privates = addr;
    memset(addr, '\0', keys[type].offset);
}

/*
 * Clean up privates
 */
void
_dixFiniPrivates(PrivatePtr privates, DevPrivateType type)
{
    keys[type].created--;
    if (xselinux_private[type])
	keys[PRIVATE_XSELINUX].created--;
}

/*
 * Allocate new object with privates.
 *
 * This is expected to be invoked from the
 * dixAllocateObjectWithPrivates macro
 */
void *
_dixAllocateObjectWithPrivates(unsigned baseSize, unsigned clear, unsigned offset, DevPrivateType type)
{
    unsigned		totalSize;
    void		*object;
    PrivatePtr		privates;
    PrivatePtr		*devPrivates;

    assert (type > PRIVATE_SCREEN && type < PRIVATE_LAST);

    /* round up so that void * is aligned */
    baseSize = (baseSize + sizeof (void *) - 1) & ~(sizeof (void *) - 1);
    totalSize = baseSize + keys[type].offset;
    object = malloc(totalSize);
    if (!object)
	return NULL;

    memset(object, '\0', clear);
    privates = (PrivatePtr) (((char *) object) + baseSize);
    devPrivates = (PrivatePtr *) ((char *) object + offset);

    _dixInitPrivates(devPrivates, privates, type);

    return object;
}

/*
 * Allocate privates separately from containing object.
 * Used for clients and screens.
 */
Bool
dixAllocatePrivates(PrivatePtr *privates, DevPrivateType type)
{
    unsigned 	size;
    PrivatePtr	p;

    assert (type > PRIVATE_XSELINUX && type < PRIVATE_LAST);

    size = keys[type].offset;
    if (!size) {
	p = NULL;
    } else {
	if (!(p = malloc(size)))
	    return FALSE;
    }

    _dixInitPrivates(privates, p, type);
    ++keys[type].allocated;

    return TRUE;
}

/*
 * Free an object that has privates
 *
 * This is expected to be invoked from the
 * dixFreeObjectWithPrivates macro
 */
void
_dixFreeObjectWithPrivates(void *object, PrivatePtr privates, DevPrivateType type)
{
    _dixFiniPrivates(privates, type);
    free(object);
}

/*
 * Called to free screen or client privates
 */
void
dixFreePrivates(PrivatePtr privates, DevPrivateType type)
{
    _dixFiniPrivates(privates, type);
    --keys[type].allocated;
    free(privates);
}

/*
 * Return size of privates for the specified type
 */
extern _X_EXPORT int
dixPrivatesSize(DevPrivateType type)
{
    assert (type >= PRIVATE_SCREEN && type < PRIVATE_LAST);

    return keys[type].offset;
}

/* Table of devPrivates offsets */
static const int offsets[] = {
    -1,					/* RT_NONE */
    offsetof(WindowRec, devPrivates),	/* RT_WINDOW */
    offsetof(PixmapRec, devPrivates),	/* RT_PIXMAP */
    offsetof(GC, devPrivates),		/* RT_GC */
    -1,		    			/* RT_FONT */
    offsetof(CursorRec, devPrivates),	/* RT_CURSOR */
    offsetof(ColormapRec, devPrivates),	/* RT_COLORMAP */
};

#define NUM_OFFSETS	(sizeof (offsets) / sizeof (offsets[0]))

int
dixLookupPrivateOffset(RESTYPE type)
{
    /*
     * Special kludge for DBE which registers a new resource type that
     * points at pixmaps (thanks, DBE)
     */
    if (type & RC_DRAWABLE) {
	if (type == RT_WINDOW)
	    return offsets[RT_WINDOW & TypeMask];
	else
	    return offsets[RT_PIXMAP & TypeMask];
    }
    type = type & TypeMask;
    if (type < NUM_OFFSETS)
	return offsets[type];
    return -1;
}

static const char *key_names[PRIVATE_LAST] = {
    /* XSELinux uses the same private keys for numerous objects */
    [PRIVATE_XSELINUX] = "XSELINUX",

    /* Otherwise, you get a private in just the requested structure
     */
    /* These can have objects created before all of the keys are registered */
    [PRIVATE_SCREEN] = "SCREEN",
    [PRIVATE_EXTENSION] = "EXTENSION",
    [PRIVATE_COLORMAP] = "COLORMAP",

    /* These cannot have any objects before all relevant keys are registered */
    [PRIVATE_DEVICE] = "DEVICE",
    [PRIVATE_CLIENT] = "CLIENT",
    [PRIVATE_PROPERTY] = "PROPERTY",
    [PRIVATE_SELECTION] = "SELECTION",
    [PRIVATE_WINDOW] = "WINDOW",
    [PRIVATE_PIXMAP] = "PIXMAP",
    [PRIVATE_GC] = "GC",
    [PRIVATE_CURSOR] = "CURSOR",
    [PRIVATE_CURSOR_BITS] = "CURSOR_BITS",

    /* extension privates */
    [PRIVATE_DBE_WINDOW] = "DBE_WINDOW",
    [PRIVATE_DAMAGE] = "DAMAGE",
    [PRIVATE_GLYPH] = "GLYPH",
    [PRIVATE_GLYPHSET] = "GLYPHSET",
    [PRIVATE_PICTURE] = "PICTURE",
};

void
dixPrivateUsage(void)
{
    int objects = 0;
    int	bytes = 0;
    int alloc = 0;
    DevPrivateType t;

    for (t = PRIVATE_XSELINUX + 1; t < PRIVATE_LAST; t++) {
	if (keys[t].offset) {
	    ErrorF("%s: %d objects of %d bytes = %d total bytes %d private allocs\n",
		   key_names[t], keys[t].created, keys[t].offset, keys[t].created * keys[t].offset,
		   keys[t].allocated);
	    bytes += keys[t].created * keys[t].offset;
	    objects += keys[t].created;
	    alloc += keys[t].allocated;
	}
    }
    ErrorF("TOTAL: %d objects, %d bytes, %d allocs\n",
	   objects, bytes, alloc);
}

void
dixResetPrivates(void)
{
    DevPrivateType	t;

    for (t = PRIVATE_XSELINUX; t < PRIVATE_LAST; t++) {
	DevPrivateKey	key, next;

	for (key = keys[t].key; key; key = next) {
	    next = key->next;
	    key->offset = 0;
	    key->initialized = FALSE;
	    key->size = 0;
	    key->type = 0;
	    if (key->allocated)
		free(key);
	}
	if (keys[t].created) {
	    ErrorF("%d %ss still allocated at reset\n",
		   keys[t].created, key_names[t]);
	    dixPrivateUsage();
	}
	keys[t].key = NULL;
	keys[t].offset = 0;
	keys[t].created = 0;
	keys[t].allocated = 0;
    }
}