os.h revision 65b04b38 
1/***********************************************************
2
3Copyright 1987, 1998  The Open Group
4
5Permission to use, copy, modify, distribute, and sell this software and its
6documentation for any purpose is hereby granted without fee, provided that
7the above copyright notice appear in all copies and that both that
8copyright notice and this permission notice appear in supporting
9documentation.
10
11The above copyright notice and this permission notice shall be included in
12all copies or substantial portions of the Software.
13
14THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
17OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
18AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
19CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
20
21Except as contained in this notice, the name of The Open Group shall not be
22used in advertising or otherwise to promote the sale, use or other dealings
23in this Software without prior written authorization from The Open Group.
24
25
26Copyright 1987 by Digital Equipment Corporation, Maynard, Massachusetts.
27
28                        All Rights Reserved
29
30Permission to use, copy, modify, and distribute this software and its
31documentation for any purpose and without fee is hereby granted,
32provided that the above copyright notice appear in all copies and that
33both that copyright notice and this permission notice appear in
34supporting documentation, and that the name of Digital not be
35used in advertising or publicity pertaining to distribution of the
36software without specific, written prior permission.
37
38DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
39ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
40DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
41ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
42WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
43ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
44SOFTWARE.
45
46******************************************************************/
47
48
49#ifndef OS_H
50#define OS_H
51
52#include "misc.h"
53#include <stdarg.h>
54#include <string.h>
55
56#define SCREEN_SAVER_ON   0
57#define SCREEN_SAVER_OFF  1
58#define SCREEN_SAVER_FORCER 2
59#define SCREEN_SAVER_CYCLE  3
60
61#ifndef MAX_REQUEST_SIZE
62#define MAX_REQUEST_SIZE 65535
63#endif
64#ifndef MAX_BIG_REQUEST_SIZE
65#define MAX_BIG_REQUEST_SIZE 4194303
66#endif
67
68typedef struct _FontPathRec *FontPathPtr;
69typedef struct _NewClientRec *NewClientPtr;
70
71#ifndef xalloc
72#define xnfalloc(size) XNFalloc((unsigned long)(size))
73#define xnfcalloc(_num, _size) XNFcalloc((unsigned long)(_num)*(unsigned long)(_size))
74#define xnfrealloc(ptr, size) XNFrealloc((pointer)(ptr), (unsigned long)(size))
75
76#define xalloc(size) Xalloc((unsigned long)(size))
77#define xcalloc(_num, _size) Xcalloc((unsigned long)(_num)*(unsigned long)(_size))
78#define xrealloc(ptr, size) Xrealloc((pointer)(ptr), (unsigned long)(size))
79#define xfree(ptr) Xfree((pointer)(ptr))
80#define xstrdup(s) Xstrdup(s)
81#define xnfstrdup(s) XNFstrdup(s)
82#endif
83
84#include <stdio.h>
85#include <stdarg.h>
86#include <string.h>
87#include <strings.h>
88
89
90#ifdef DDXBEFORERESET
91extern void ddxBeforeReset (void);
92#endif
93
94#ifdef DDXOSVERRORF
95extern _X_EXPORT void (*OsVendorVErrorFProc)(const char *, va_list args);
96#endif
97
98extern _X_EXPORT int WaitForSomething(
99    int* /*pClientsReady*/
100);
101
102extern _X_EXPORT int ReadRequestFromClient(ClientPtr /*client*/);
103
104extern _X_EXPORT Bool InsertFakeRequest(
105    ClientPtr /*client*/,
106    char* /*data*/,
107    int /*count*/);
108
109extern _X_EXPORT void ResetCurrentRequest(ClientPtr /*client*/);
110
111extern _X_EXPORT void FlushAllOutput(void);
112
113extern _X_EXPORT void FlushIfCriticalOutputPending(void);
114
115extern _X_EXPORT void SetCriticalOutputPending(void);
116
117extern _X_EXPORT int WriteToClient(ClientPtr /*who*/, int /*count*/, const void* /*buf*/);
118
119extern _X_EXPORT void ResetOsBuffers(void);
120
121extern _X_EXPORT void InitConnectionLimits(void);
122
123extern _X_EXPORT void NotifyParentProcess(void);
124
125extern _X_EXPORT void CreateWellKnownSockets(void);
126
127extern _X_EXPORT void ResetWellKnownSockets(void);
128
129extern _X_EXPORT void CloseWellKnownConnections(void);
130
131extern _X_EXPORT XID AuthorizationIDOfClient(ClientPtr /*client*/);
132
133extern _X_EXPORT char *ClientAuthorized(
134    ClientPtr /*client*/,
135    unsigned int /*proto_n*/,
136    char* /*auth_proto*/,
137    unsigned int /*string_n*/,
138    char* /*auth_string*/);
139
140extern _X_EXPORT Bool EstablishNewConnections(
141    ClientPtr /*clientUnused*/,
142    pointer /*closure*/);
143
144extern _X_EXPORT void CheckConnections(void);
145
146extern _X_EXPORT void CloseDownConnection(ClientPtr /*client*/);
147
148extern _X_EXPORT void AddGeneralSocket(int /*fd*/);
149
150extern _X_EXPORT void RemoveGeneralSocket(int /*fd*/);
151
152extern _X_EXPORT void AddEnabledDevice(int /*fd*/);
153
154extern _X_EXPORT void RemoveEnabledDevice(int /*fd*/);
155
156extern _X_EXPORT int OnlyListenToOneClient(ClientPtr /*client*/);
157
158extern _X_EXPORT void ListenToAllClients(void);
159
160extern _X_EXPORT void IgnoreClient(ClientPtr /*client*/);
161
162extern _X_EXPORT void AttendClient(ClientPtr /*client*/);
163
164extern _X_EXPORT void MakeClientGrabImpervious(ClientPtr /*client*/);
165
166extern _X_EXPORT void MakeClientGrabPervious(ClientPtr /*client*/);
167
168#ifdef XQUARTZ
169extern void ListenOnOpenFD(int /* fd */, int /* noxauth */);
170#endif
171
172extern _X_EXPORT CARD32 GetTimeInMillis(void);
173
174extern _X_EXPORT void AdjustWaitForDelay(
175    pointer /*waitTime*/,
176    unsigned long /*newdelay*/);
177
178typedef	struct _OsTimerRec *OsTimerPtr;
179
180typedef CARD32 (*OsTimerCallback)(
181    OsTimerPtr /* timer */,
182    CARD32 /* time */,
183    pointer /* arg */);
184
185extern _X_EXPORT void TimerInit(void);
186
187extern _X_EXPORT Bool TimerForce(OsTimerPtr /* timer */);
188
189#define TimerAbsolute (1<<0)
190#define TimerForceOld (1<<1)
191
192extern _X_EXPORT OsTimerPtr TimerSet(
193    OsTimerPtr /* timer */,
194    int /* flags */,
195    CARD32 /* millis */,
196    OsTimerCallback /* func */,
197    pointer /* arg */);
198
199extern _X_EXPORT void TimerCheck(void);
200extern _X_EXPORT void TimerCancel(OsTimerPtr /* pTimer */);
201extern _X_EXPORT void TimerFree(OsTimerPtr /* pTimer */);
202
203extern _X_EXPORT void SetScreenSaverTimer(void);
204extern _X_EXPORT void FreeScreenSaverTimer(void);
205
206extern _X_EXPORT void AutoResetServer(int /*sig*/);
207
208extern _X_EXPORT void GiveUp(int /*sig*/);
209
210extern _X_EXPORT void UseMsg(void);
211
212extern _X_EXPORT void ProcessCommandLine(int /*argc*/, char* /*argv*/[]);
213
214extern _X_EXPORT int set_font_authorizations(
215    char ** /* authorizations */,
216    int * /*authlen */,
217    pointer /* client */);
218
219#ifndef _HAVE_XALLOC_DECLS
220#define _HAVE_XALLOC_DECLS
221
222/*
223 * These causes all sorts of warnings->errors in the xsrc build.
224 */
225#ifdef __NetBSD__
226#undef _X_DEPRECATED
227#define _X_DEPRECATED
228#endif
229
230/*
231 * Use malloc(3) instead.
232 */
233extern _X_EXPORT void *Xalloc(unsigned long /*amount*/) _X_DEPRECATED;
234/*
235 * Use calloc(3) instead
236 */
237extern _X_EXPORT void *Xcalloc(unsigned long /*amount*/) _X_DEPRECATED;
238/*
239 * Use realloc(3) instead
240 */
241extern _X_EXPORT void *Xrealloc(void * /*ptr*/, unsigned long /*amount*/)
242    _X_DEPRECATED;
243/*
244 * Use free(3) instead
245 */
246extern _X_EXPORT void Xfree(void * /*ptr*/) _X_DEPRECATED;
247
248#endif
249
250/*
251 * This function malloc(3)s buffer, terminating the server if there is not
252 * enough memory.
253 */
254extern _X_EXPORT void *XNFalloc(unsigned long /*amount*/);
255/*
256 * This function calloc(3)s buffer, terminating the server if there is not
257 * enough memory.
258 */
259extern _X_EXPORT void *XNFcalloc(unsigned long /*amount*/);
260/*
261 * This function realloc(3)s passed buffer, terminating the server if there is
262 * not enough memory.
263 */
264extern _X_EXPORT void *XNFrealloc(void * /*ptr*/, unsigned long /*amount*/);
265
266/*
267 * This function strdup(3)s passed string. The only difference from the library
268 * function that it is safe to pass NULL, as NULL will be returned.
269 */
270extern _X_EXPORT char *Xstrdup(const char *s);
271
272/*
273 * This function strdup(3)s passed string, terminating the server if there is
274 * not enough memory. If NULL is passed to this function, NULL is returned.
275 */
276extern _X_EXPORT char *XNFstrdup(const char *s);
277
278/* Include new X*asprintf API */
279#include "Xprintf.h"
280
281/* Older api deprecated in favor of the asprintf versions */
282extern _X_EXPORT char *Xprintf(const char *fmt, ...) _X_ATTRIBUTE_PRINTF(1,2) _X_DEPRECATED;
283extern _X_EXPORT char *Xvprintf(const char *fmt, va_list va)_X_ATTRIBUTE_PRINTF(1,0) _X_DEPRECATED;
284extern _X_EXPORT char *XNFprintf(const char *fmt, ...) _X_ATTRIBUTE_PRINTF(1,2) _X_DEPRECATED;
285extern _X_EXPORT char *XNFvprintf(const char *fmt, va_list va)_X_ATTRIBUTE_PRINTF(1,0) _X_DEPRECATED;
286
287typedef void (*OsSigHandlerPtr)(int /* sig */);
288typedef int (*OsSigWrapperPtr)(int /* sig */);
289
290extern _X_EXPORT OsSigHandlerPtr OsSignal(int /* sig */, OsSigHandlerPtr /* handler */);
291extern _X_EXPORT OsSigWrapperPtr OsRegisterSigWrapper(OsSigWrapperPtr newWrap);
292
293extern _X_EXPORT int auditTrailLevel;
294
295extern _X_EXPORT void LockServer(void);
296extern _X_EXPORT void UnlockServer(void);
297
298extern _X_EXPORT int OsLookupColor(
299    int	/*screen*/,
300    char * /*name*/,
301    unsigned /*len*/,
302    unsigned short * /*pred*/,
303    unsigned short * /*pgreen*/,
304    unsigned short * /*pblue*/);
305
306extern _X_EXPORT void OsInit(void);
307
308extern _X_EXPORT void OsCleanup(Bool);
309
310extern _X_EXPORT void OsVendorFatalError(void);
311
312extern _X_EXPORT void OsVendorInit(void);
313
314extern _X_EXPORT void OsBlockSignals (void);
315
316extern _X_EXPORT void OsReleaseSignals (void);
317
318extern _X_EXPORT void OsAbort (void) _X_NORETURN;
319
320#if !defined(WIN32)
321extern _X_EXPORT int System(char *);
322extern _X_EXPORT pointer Popen(char *, char *);
323extern _X_EXPORT int Pclose(pointer);
324extern _X_EXPORT pointer Fopen(char *, char *);
325extern _X_EXPORT int Fclose(pointer);
326#else
327#define System(a) system(a)
328#define Popen(a,b) popen(a,b)
329#define Pclose(a) pclose(a)
330#define Fopen(a,b) fopen(a,b)
331#define Fclose(a) fclose(a)
332#endif
333
334extern _X_EXPORT void CheckUserParameters(int argc, char **argv, char **envp);
335extern _X_EXPORT void CheckUserAuthorization(void);
336
337extern _X_EXPORT int AddHost(
338    ClientPtr	/*client*/,
339    int         /*family*/,
340    unsigned    /*length*/,
341    const void */*pAddr*/);
342
343extern _X_EXPORT Bool ForEachHostInFamily (
344    int	    /*family*/,
345    Bool    (* /*func*/ )(
346            unsigned char * /* addr */,
347            short           /* len */,
348            pointer         /* closure */),
349    pointer /*closure*/);
350
351extern _X_EXPORT int RemoveHost(
352    ClientPtr	/*client*/,
353    int         /*family*/,
354    unsigned    /*length*/,
355    pointer     /*pAddr*/);
356
357extern _X_EXPORT int GetHosts(
358    pointer * /*data*/,
359    int	    * /*pnHosts*/,
360    int	    * /*pLen*/,
361    BOOL    * /*pEnabled*/);
362
363typedef struct sockaddr * sockaddrPtr;
364
365extern _X_EXPORT int InvalidHost(sockaddrPtr /*saddr*/, int /*len*/, ClientPtr client);
366
367extern _X_EXPORT int LocalClient(ClientPtr /* client */);
368
369extern _X_EXPORT int LocalClientCred(ClientPtr, int *, int *);
370
371#define LCC_UID_SET	(1 << 0)
372#define LCC_GID_SET	(1 << 1)
373#define LCC_PID_SET	(1 << 2)
374#define LCC_ZID_SET	(1 << 3)
375
376typedef struct {
377    int fieldsSet;	/* Bit mask of fields set */
378    int	euid;		/* Effective uid */
379    int egid;		/* Primary effective group id */
380    int nSuppGids;	/* Number of supplementary group ids */
381    int *pSuppGids;	/* Array of supplementary group ids */
382    int pid;		/* Process id */
383    int zoneid;		/* Only set on Solaris 10 & later */
384} LocalClientCredRec;
385
386extern _X_EXPORT int GetLocalClientCreds(ClientPtr, LocalClientCredRec **);
387extern _X_EXPORT void FreeLocalClientCreds(LocalClientCredRec *);
388
389extern _X_EXPORT int ChangeAccessControl(ClientPtr /*client*/, int /*fEnabled*/);
390
391extern _X_EXPORT int GetAccessControl(void);
392
393
394extern _X_EXPORT void AddLocalHosts(void);
395
396extern _X_EXPORT void ResetHosts(char *display);
397
398extern _X_EXPORT void EnableLocalHost(void);
399
400extern _X_EXPORT void DisableLocalHost(void);
401
402extern _X_EXPORT void AccessUsingXdmcp(void);
403
404extern _X_EXPORT void DefineSelf(int /*fd*/);
405
406#if XDMCP
407extern _X_EXPORT void AugmentSelf(pointer /*from*/, int /*len*/);
408
409extern _X_EXPORT void RegisterAuthorizations(void);
410#endif
411
412extern _X_EXPORT void InitAuthorization(char * /*filename*/);
413
414/* extern int LoadAuthorization(void); */
415
416extern _X_EXPORT int AuthorizationFromID (
417	XID 		id,
418	unsigned short	*name_lenp,
419	char		**namep,
420	unsigned short	*data_lenp,
421	char		**datap);
422
423extern _X_EXPORT XID CheckAuthorization(
424    unsigned int /*namelength*/,
425    const char * /*name*/,
426    unsigned int /*datalength*/,
427    const char * /*data*/,
428    ClientPtr /*client*/,
429    char ** /*reason*/
430);
431
432extern _X_EXPORT void ResetAuthorization(void);
433
434extern _X_EXPORT int RemoveAuthorization (
435    unsigned short	name_length,
436    const char		*name,
437    unsigned short	data_length,
438    const char		*data);
439
440extern _X_EXPORT int AddAuthorization(
441    unsigned int	/*name_length*/,
442    const char *	/*name*/,
443    unsigned int	/*data_length*/,
444    char *		/*data*/);
445
446#ifdef XCSECURITY
447extern _X_EXPORT XID GenerateAuthorization(
448    unsigned int   /* name_length */,
449    const char	*  /* name */,
450    unsigned int   /* data_length */,
451    const char	*  /* data */,
452    unsigned int * /* data_length_return */,
453    char	** /* data_return */);
454#endif
455
456extern _X_EXPORT int ddxProcessArgument(int /*argc*/, char * /*argv*/ [], int /*i*/);
457
458extern _X_EXPORT void ddxUseMsg(void);
459
460/* stuff for ReplyCallback */
461extern _X_EXPORT CallbackListPtr ReplyCallback;
462typedef struct {
463    ClientPtr client;
464    const void *replyData;
465    unsigned long dataLenBytes;
466    unsigned long bytesRemaining;
467    Bool startOfReply;
468} ReplyInfoRec;
469
470/* stuff for FlushCallback */
471extern _X_EXPORT CallbackListPtr FlushCallback;
472
473extern _X_EXPORT void AbortDDX(void);
474extern _X_EXPORT void ddxGiveUp(void);
475extern _X_EXPORT int TimeSinceLastInputEvent(void);
476
477/* strcasecmp.c */
478#if NEED_STRCASECMP
479#define strcasecmp xstrcasecmp
480extern _X_EXPORT int xstrcasecmp(const char *s1, const char *s2);
481#endif
482
483#if NEED_STRNCASECMP
484#define strncasecmp xstrncasecmp
485extern _X_EXPORT int xstrncasecmp(const char *s1, const char *s2, size_t n);
486#endif
487
488#if NEED_STRCASESTR
489#define strcasestr xstrcasestr
490extern _X_EXPORT char *xstrcasestr(const char *s, const char *find);
491#endif
492
493#ifndef HAS_STRLCPY
494extern _X_EXPORT size_t strlcpy(char *dst, const char *src, size_t siz);
495extern _X_EXPORT size_t strlcat(char *dst, const char *src, size_t siz);
496#endif
497
498/* Logging. */
499typedef enum _LogParameter {
500    XLOG_FLUSH,
501    XLOG_SYNC,
502    XLOG_VERBOSITY,
503    XLOG_FILE_VERBOSITY
504} LogParameter;
505
506/* Flags for log messages. */
507typedef enum {
508    X_PROBED,			/* Value was probed */
509    X_CONFIG,			/* Value was given in the config file */
510    X_DEFAULT,			/* Value is a default */
511    X_CMDLINE,			/* Value was given on the command line */
512    X_NOTICE,			/* Notice */
513    X_ERROR,			/* Error message */
514    X_WARNING,			/* Warning message */
515    X_INFO,			/* Informational message */
516    X_NONE,			/* No prefix */
517    X_NOT_IMPLEMENTED,		/* Not implemented */
518    X_UNKNOWN = -1		/* unknown -- this must always be last */
519} MessageType;
520
521extern _X_EXPORT const char *LogInit(const char *fname, const char *backup);
522extern _X_EXPORT void LogClose(void);
523extern _X_EXPORT Bool LogSetParameter(LogParameter param, int value);
524extern _X_EXPORT void LogVWrite(int verb, const char *f, va_list args);
525extern _X_EXPORT void LogWrite(int verb, const char *f, ...) _X_ATTRIBUTE_PRINTF(2,3);
526extern _X_EXPORT void LogVMessageVerb(MessageType type, int verb, const char *format,
527			    va_list args);
528extern _X_EXPORT void LogMessageVerb(MessageType type, int verb, const char *format,
529			   ...) _X_ATTRIBUTE_PRINTF(3,4);
530extern _X_EXPORT void LogMessage(MessageType type, const char *format, ...)
531			_X_ATTRIBUTE_PRINTF(2,3);
532extern _X_EXPORT void FreeAuditTimer(void);
533extern _X_EXPORT void AuditF(const char *f, ...) _X_ATTRIBUTE_PRINTF(1,2);
534extern _X_EXPORT void VAuditF(const char *f, va_list args);
535extern _X_EXPORT void FatalError(const char *f, ...) _X_ATTRIBUTE_PRINTF(1,2) _X_NORETURN;
536
537#ifdef DEBUG
538#define DebugF ErrorF
539#else
540#define DebugF(...) /* */
541#endif
542
543extern _X_EXPORT void VErrorF(const char *f, va_list args);
544extern _X_EXPORT void ErrorF(const char *f, ...) _X_ATTRIBUTE_PRINTF(1,2);
545extern _X_EXPORT void Error(const char *str);
546extern _X_EXPORT void LogPrintMarkers(void);
547
548extern _X_EXPORT void xorg_backtrace(void);
549
550#endif /* OS_H */
551