privates.h revision 03532efdc331b598d3dedc8cc7477641c3b0dd12
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/***********************************************************
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncAUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncAN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync******************************************************************/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/*****************************************************************
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * STUFF FOR PRIVATES
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *****************************************************************/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /* XSELinux uses the same private keys for numerous objects */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /* Otherwise, you get a private in just the requested structure
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /* These can have objects created before all of the keys are registered */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /* These cannot have any objects before all relevant keys are registered */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /* extension privates */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /* last private type */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _DevPrivateKeyRec {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _DevPrivateSetRec {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Let drivers know how to initialize private keys
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Register a new private index for the private type.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * This initializes the specified key and optionally requests pre-allocated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * private space for your driver/module. If you request no extra space, you
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * may set and get a single pointer value using this private key. Otherwise,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * you can get the address of the extra space and store whatever data you like
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * You may call dixRegisterPrivateKey more than once on the same key, but the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * size and type must match or the server will abort.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * dixRegisterPrivateKey returns FALSE if it fails to allocate memory
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * during its operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync dixRegisterPrivateKey(DevPrivateKey key, DevPrivateType type, unsigned size);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Check whether a private key has been registered
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncstatic inline Bool
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Get the address of the private storage.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * For keys with pre-defined storage, this gets the base of that storage
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Otherwise, it returns the place where the private pointer is stored.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncstatic inline void *
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncdixGetPrivateAddr(PrivatePtr *privates, const DevPrivateKey key)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Fetch a private pointer stored in the object
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Returns the pointer stored with dixSetPrivate.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * This must only be used with keys that have
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * no pre-defined storage
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncstatic inline void *
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncdixGetPrivate(PrivatePtr *privates, const DevPrivateKey key)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return *(void **) dixGetPrivateAddr(privates, key);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Associate 'val' with 'key' in 'privates' so that later calls to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * dixLookupPrivate(privates, key) will return 'val'.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncstatic inline void
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncdixSetPrivate(PrivatePtr *privates, const DevPrivateKey key, pointer val)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *(pointer *) dixGetPrivateAddr(privates, key) = val;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Lookup a pointer to the private record.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * For privates with defined storage, return the address of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * storage. For privates without defined storage, return the pointer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncstatic inline pointer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncdixLookupPrivate(PrivatePtr *privates, const DevPrivateKey key)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Look up the address of the pointer to the storage
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * This returns the place where the private pointer is stored,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * which is only valid for privates without predefined storage.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncstatic inline pointer *
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncdixLookupPrivateAddr(PrivatePtr *privates, const DevPrivateKey key)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return (pointer *) dixGetPrivateAddr(privates, key);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncdixRegisterScreenPrivateKey(DevScreenPrivateKey key, ScreenPtr pScreen,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync _dixGetScreenPrivateKey(const DevScreenPrivateKey key, ScreenPtr pScreen);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncstatic inline void *
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncdixGetScreenPrivateAddr(PrivatePtr *privates, const DevScreenPrivateKey key,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return dixGetPrivateAddr(privates, _dixGetScreenPrivateKey(key, pScreen));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncstatic inline void *
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncdixGetScreenPrivate(PrivatePtr *privates, const DevScreenPrivateKey key,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return dixGetPrivate(privates, _dixGetScreenPrivateKey(key, pScreen));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncstatic inline void
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncdixSetScreenPrivate(PrivatePtr *privates, const DevScreenPrivateKey key,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync dixSetPrivate(privates, _dixGetScreenPrivateKey(key, pScreen), val);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncstatic inline pointer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncdixLookupScreenPrivate(PrivatePtr *privates, const DevScreenPrivateKey key,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return dixLookupPrivate(privates, _dixGetScreenPrivateKey(key, pScreen));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncstatic inline pointer *
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncdixLookupScreenPrivateAddr(PrivatePtr *privates, const DevScreenPrivateKey key,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * These functions relate to allocations related to a specific screen;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * space will only be available for objects allocated for use on that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * screen. As such, only objects which are related directly to a specific
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * screen are candidates for allocation this way, this includes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * windows, pixmaps, gcs, pictures and colormaps. This key is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * used just like any other key using dixGetPrivate and friends.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * This is distinctly different from the ScreenPrivateKeys above which
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * allocate space in global objects like cursor bits for a specific
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * screen, allowing multiple screen-related chunks of storage in a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * single global object.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncdixRegisterScreenSpecificPrivateKey(ScreenPtr pScreen, DevPrivateKey key,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/* Clean up screen-specific privates before CloseScreen */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/* Initialize screen-specific privates in AddScreen */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync_dixAllocateScreenObjectWithPrivates(ScreenPtr pScreen,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define dixAllocateScreenObjectWithPrivates(s, t, type) _dixAllocateScreenObjectWithPrivates(s, sizeof(t), sizeof(t), offsetof(t, devPrivates), type)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncdixScreenSpecificPrivatesSize(ScreenPtr pScreen, DevPrivateType type);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync_dixInitScreenPrivates(ScreenPtr pScreen, PrivatePtr *privates, void *addr, DevPrivateType type);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define dixInitScreenPrivates(s, o, v, type) _dixInitScreenPrivates(s, &(o)->devPrivates, (v), type);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Allocates private data separately from main object.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * For objects created during server initialization, this allows those
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * privates to be re-allocated as new private keys are registered.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * This includes screens, the serverClient, default colormaps and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * extensions entries.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync dixAllocatePrivates(PrivatePtr *privates, DevPrivateType type);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Frees separately allocated private data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync dixFreePrivates(PrivatePtr privates, DevPrivateType type);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Initialize privates by zeroing them
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync_dixInitPrivates(PrivatePtr *privates, void *addr, DevPrivateType type);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define dixInitPrivates(o, v, type) _dixInitPrivates(&(o)->devPrivates, (v), type);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Clean up privates
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync _dixFiniPrivates(PrivatePtr privates, DevPrivateType type);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define dixFiniPrivates(o,t) _dixFiniPrivates((o)->devPrivates,t)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Allocates private data at object creation time. Required
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * for almost all objects, except for the list described
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * above for dixAllocatePrivates.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncextern _X_EXPORT void *_dixAllocateObjectWithPrivates(unsigned size,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define dixAllocateObjectWithPrivates(t, type) (t *) _dixAllocateObjectWithPrivates(sizeof(t), sizeof(t), offsetof(t, devPrivates), type)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync_dixFreeObjectWithPrivates(void *object, PrivatePtr privates,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define dixFreeObjectWithPrivates(o,t) _dixFreeObjectWithPrivates(o, (o)->devPrivates, t)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Return size of privates for the specified type
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Dump out private stats to ErrorF
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Resets the privates subsystem. dixResetPrivates is called from the main loop
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * before each server generation. This function must only be called by main().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Looks up the offset where the devPrivates field is located.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Returns -1 if the specified resource has no dev privates.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * The position of the devPrivates field varies by structure
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * and calling code might only know the resource type, not the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * structure definition.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Convenience macro for adding an offset to an object pointer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * when making a call to one of the devPrivates functions
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define DEVPRIV_AT(ptr, offset) ((PrivatePtr *)((char *)(ptr) + offset))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#endif /* PRIVATES_H */