aboutsummaryrefslogtreecommitdiff
path: root/xorg-server/os/WaitFor.c
blob: 95e64ba454fa45ae4931fd8902890a64d4423f5b (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
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
/***********************************************************

Copyright 1987, 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 1987 by Digital Equipment Corporation, Maynard, Massachusetts.

                        All Rights Reserved

Permission to use, copy, modify, and distribute this software and its 
documentation for any purpose and without fee is hereby granted, 
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 Digital not be
used in advertising or publicity pertaining to distribution of the
software without specific, written prior permission.  

DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
DIGITAL 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.

******************************************************************/

/*****************************************************************
 * OS Dependent input routines:
 *
 *  WaitForSomething
 *  TimerForce, TimerSet, TimerCheck, TimerFree
 *
 *****************************************************************/

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

#ifdef WIN32
#include <X11/Xwinsock.h>
#endif
#include <X11/Xos.h>            /* for strings, fcntl, time */
#include <errno.h>
#include <stdio.h>
#include <X11/X.h>
#include "misc.h"

#include "osdep.h"
#include <X11/Xpoll.h>
#include "dixstruct.h"
#include "opaque.h"
#ifdef DPMSExtension
#include "dpmsproc.h"
#endif

#ifdef WIN32
/* Error codes from windows sockets differ from fileio error codes  */
#undef EINTR
#define EINTR WSAEINTR
#undef EINVAL
#define EINVAL WSAEINVAL
#undef EBADF
#define EBADF WSAENOTSOCK
/* Windows select does not set errno. Use GetErrno as wrapper for 
   WSAGetLastError */
#define GetErrno WSAGetLastError
#else
/* This is just a fallback to errno to hide the differences between unix and
   Windows in the code */
#define GetErrno() errno
#endif

/* like ffs, but uses fd_mask instead of int as argument, so it works
   when fd_mask is longer than an int, such as common 64-bit platforms */
/* modifications by raphael */
int
mffs(fd_mask mask)
{
    int i;

    if (!mask)
        return 0;
    i = 1;
    while (!(mask & 1)) {
        i++;
        mask >>= 1;
    }
    return i;
}

#ifdef DPMSExtension
#include <X11/extensions/dpmsconst.h>
#endif

struct _OsTimerRec {
    OsTimerPtr next;
    CARD32 expires;
    CARD32 delta;
    OsTimerCallback callback;
    pointer arg;
};

static void DoTimer(OsTimerPtr timer, CARD32 now, OsTimerPtr *prev);
static void CheckAllTimers(void);
static OsTimerPtr timers = NULL;

/*****************
 * WaitForSomething:
 *     Make the server suspend until there is
 *	1. data from clients or
 *	2. input events available or
 *	3. ddx notices something of interest (graphics
 *	   queue ready, etc.) or
 *	4. clients that have buffered replies/events are ready
 *
 *     If the time between INPUT events is
 *     greater than ScreenSaverTime, the display is turned off (or
 *     saved, depending on the hardware).  So, WaitForSomething()
 *     has to handle this also (that's why the select() has a timeout.
 *     For more info on ClientsWithInput, see ReadRequestFromClient().
 *     pClientsReady is an array to store ready client->index values into.
 *****************/

int
WaitForSomething(int *pClientsReady)
{
    int i;
    struct timeval waittime, *wt;
    INT32 timeout = 0;
    fd_set clientsReadable;
    fd_set clientsWritable;
    int curclient;
    int selecterr;
    static int nready;
    fd_set devicesReadable;
    CARD32 now = 0;
    Bool someReady = FALSE;

    FD_ZERO(&clientsReadable);

    if (nready)
        SmartScheduleStopTimer();
    nready = 0;

    /* We need a while loop here to handle 
       crashed connections and the screen saver timeout */
    while (1) {
        /* deal with any blocked jobs */
        if (workQueue)
            ProcessWorkQueue();
        if (XFD_ANYSET(&ClientsWithInput)) {
            if (!SmartScheduleDisable) {
                someReady = TRUE;
                waittime.tv_sec = 0;
                waittime.tv_usec = 0;
                wt = &waittime;
            }
            else {
                XFD_COPYSET(&ClientsWithInput, &clientsReadable);
                break;
            }
        }
        if (someReady) {
            XFD_COPYSET(&AllSockets, &LastSelectMask);
            XFD_UNSET(&LastSelectMask, &ClientsWithInput);
        }
        else {
            wt = NULL;
            if (timers) {
                now = GetTimeInMillis();
                timeout = timers->expires - now;
                if (timeout > 0 && timeout > timers->delta + 250) {
                    /* time has rewound.  reset the timers. */
                    CheckAllTimers();
                }

                if (timers) {
                    timeout = timers->expires - now;
                    if (timeout < 0)
                        timeout = 0;
                    waittime.tv_sec = timeout / MILLI_PER_SECOND;
                    waittime.tv_usec = (timeout % MILLI_PER_SECOND) *
                        (1000000 / MILLI_PER_SECOND);
                    wt = &waittime;
                }
            }
            XFD_COPYSET(&AllSockets, &LastSelectMask);
        }

        BlockHandler((pointer) &wt, (pointer) &LastSelectMask);
        if (NewOutputPending)
            FlushAllOutput();
        /* keep this check close to select() call to minimize race */
        if (dispatchException)
            i = -1;
        else if (AnyClientsWriteBlocked) {
            XFD_COPYSET(&ClientsWriteBlocked, &clientsWritable);
            i = Select(MaxClients, &LastSelectMask, &clientsWritable, NULL, wt);
        }
        else {
            i = Select(MaxClients, &LastSelectMask, NULL, NULL, wt);
        }
        selecterr = GetErrno();
        WakeupHandler(i, (pointer) &LastSelectMask);
        if (i <= 0) {           /* An error or timeout occurred */
            if (dispatchException)
                return 0;
            if (i < 0) {
                if (selecterr == EBADF) {       /* Some client disconnected */
                    CheckConnections();
                    if (!XFD_ANYSET(&AllClients))
                        return 0;
                }
                else if (selecterr == EINVAL) {
                    FatalError("WaitForSomething(): select: %s\n",
                               strerror(selecterr));
                }
                else if (selecterr != EINTR && selecterr != EAGAIN) {
                    ErrorF("WaitForSomething(): select: %s\n",
                           strerror(selecterr));
                }
            }
            else if (someReady) {
                /*
                 * If no-one else is home, bail quickly
                 */
                XFD_COPYSET(&ClientsWithInput, &LastSelectMask);
                XFD_COPYSET(&ClientsWithInput, &clientsReadable);
                break;
            }
            if (*checkForInput[0] != *checkForInput[1])
                return 0;

            if (timers) {
                int expired = 0;

                now = GetTimeInMillis();
                if ((int) (timers->expires - now) <= 0)
                    expired = 1;

                while (timers && (int) (timers->expires - now) <= 0)
                    DoTimer(timers, now, &timers);

                if (expired)
                    return 0;
            }
        }
        else {
            fd_set tmp_set;

            if (*checkForInput[0] == *checkForInput[1]) {
                if (timers) {
                    int expired = 0;

                    now = GetTimeInMillis();
                    if ((int) (timers->expires - now) <= 0)
                        expired = 1;

                    while (timers && (int) (timers->expires - now) <= 0)
                        DoTimer(timers, now, &timers);

                    if (expired)
                        return 0;
                }
            }
            if (someReady)
                XFD_ORSET(&LastSelectMask, &ClientsWithInput, &LastSelectMask);
            if (AnyClientsWriteBlocked && XFD_ANYSET(&clientsWritable)) {
                NewOutputPending = TRUE;
                XFD_ORSET(&OutputPending, &clientsWritable, &OutputPending);
                XFD_UNSET(&ClientsWriteBlocked, &clientsWritable);
                if (!XFD_ANYSET(&ClientsWriteBlocked))
                    AnyClientsWriteBlocked = FALSE;
            }

            XFD_ANDSET(&devicesReadable, &LastSelectMask, &EnabledDevices);
            XFD_ANDSET(&clientsReadable, &LastSelectMask, &AllClients);
            XFD_ANDSET(&tmp_set, &LastSelectMask, &WellKnownConnections);
            if (XFD_ANYSET(&tmp_set))
                QueueWorkProc(EstablishNewConnections, NULL,
                              (pointer) &LastSelectMask);

            if (XFD_ANYSET(&devicesReadable) || XFD_ANYSET(&clientsReadable))
                break;
            /* check here for DDXes that queue events during Block/Wakeup */
            if (*checkForInput[0] != *checkForInput[1])
                return 0;
        }
    }

    nready = 0;
    if (XFD_ANYSET(&clientsReadable)) {
#ifndef WIN32
        for (i = 0; i < howmany(XFD_SETSIZE, NFDBITS); i++) {
            int highest_priority = 0;

            while (clientsReadable.fds_bits[i]) {
                int client_priority, client_index;

                curclient = mffs(clientsReadable.fds_bits[i]) - 1;
                client_index =  /* raphael: modified */
                    ConnectionTranslation[curclient +
                                          (i * (sizeof(fd_mask) * 8))];
#else
        int highest_priority = 0;
        fd_set savedClientsReadable;

        XFD_COPYSET(&clientsReadable, &savedClientsReadable);
        for (i = 0; i < XFD_SETCOUNT(&savedClientsReadable); i++) {
            int client_priority, client_index;

            curclient = XFD_FD(&savedClientsReadable, i);
            client_index = GetConnectionTranslation(curclient);
#endif
            /*  We implement "strict" priorities.
             *  Only the highest priority client is returned to
             *  dix.  If multiple clients at the same priority are
             *  ready, they are all returned.  This means that an
             *  aggressive client could take over the server.
             *  This was not considered a big problem because
             *  aggressive clients can hose the server in so many 
             *  other ways :)
             */
            client_priority = clients[client_index]->priority;
            if (nready == 0 || client_priority > highest_priority) {
                /*  Either we found the first client, or we found
                 *  a client whose priority is greater than all others
                 *  that have been found so far.  Either way, we want 
                 *  to initialize the list of clients to contain just
                 *  this client.
                 */
                pClientsReady[0] = client_index;
                highest_priority = client_priority;
                nready = 1;
            }
            /*  the following if makes sure that multiple same-priority 
             *  clients get batched together
             */
            else if (client_priority == highest_priority) {
                pClientsReady[nready++] = client_index;
            }
#ifndef WIN32
            clientsReadable.fds_bits[i] &= ~(((fd_mask) 1L) << curclient);
        }
#else
            FD_CLR(curclient, &clientsReadable);
#endif
        }
    }

    if (nready)
        SmartScheduleStartTimer();

    return nready;
}

/* If time has rewound, re-run every affected timer.
 * Timers might drop out of the list, so we have to restart every time. */
static void
CheckAllTimers(void)
{
    OsTimerPtr timer;
    CARD32 now;

 start:
    now = GetTimeInMillis();

    for (timer = timers; timer; timer = timer->next) {
        if (timer->expires - now > timer->delta + 250) {
            TimerForce(timer);
            goto start;
        }
    }
}

static void
DoTimer(OsTimerPtr timer, CARD32 now, OsTimerPtr *prev)
{
    CARD32 newTime;

    *prev = timer->next;
    timer->next = NULL;
    newTime = (*timer->callback) (timer, now, timer->arg);
    if (newTime)
        TimerSet(timer, 0, newTime, timer->callback, timer->arg);
}

OsTimerPtr
TimerSet(OsTimerPtr timer, int flags, CARD32 millis,
         OsTimerCallback func, pointer arg)
{
    register OsTimerPtr *prev;
    CARD32 now = GetTimeInMillis();

    if (!timer) {
        timer = malloc(sizeof(struct _OsTimerRec));
        if (!timer)
            return NULL;
    }
    else {
        for (prev = &timers; *prev; prev = &(*prev)->next) {
            if (*prev == timer) {
                *prev = timer->next;
                if (flags & TimerForceOld)
                    (void) (*timer->callback) (timer, now, timer->arg);
                break;
            }
        }
    }
    if (!millis)
        return timer;
    if (flags & TimerAbsolute) {
        timer->delta = millis - now;
    }
    else {
        timer->delta = millis;
        millis += now;
    }
    timer->expires = millis;
    timer->callback = func;
    timer->arg = arg;
    if ((int) (millis - now) <= 0) {
        timer->next = NULL;
        millis = (*timer->callback) (timer, now, timer->arg);
        if (!millis)
            return timer;
    }
    for (prev = &timers;
         *prev && (int) ((*prev)->expires - millis) <= 0;
         prev = &(*prev)->next);
    timer->next = *prev;
    *prev = timer;
    return timer;
}

Bool
TimerForce(OsTimerPtr timer)
{
    OsTimerPtr *prev;

    for (prev = &timers; *prev; prev = &(*prev)->next) {
        if (*prev == timer) {
            DoTimer(timer, GetTimeInMillis(), prev);
            return TRUE;
        }
    }
    return FALSE;
}

void
TimerCancel(OsTimerPtr timer)
{
    OsTimerPtr *prev;

    if (!timer)
        return;
    for (prev = &timers; *prev; prev = &(*prev)->next) {
        if (*prev == timer) {
            *prev = timer->next;
            break;
        }
    }
}

void
TimerFree(OsTimerPtr timer)
{
    if (!timer)
        return;
    TimerCancel(timer);
    free(timer);
}

void
TimerCheck(void)
{
    CARD32 now = GetTimeInMillis();

    while (timers && (int) (timers->expires - now) <= 0)
        DoTimer(timers, now, &timers);
}

void
TimerInit(void)
{
    OsTimerPtr timer;

    while ((timer = timers)) {
        timers = timer->next;
        free(timer);
    }
}

#ifdef DPMSExtension

#define DPMS_CHECK_MODE(mode,time)\
    if (time > 0 && DPMSPowerLevel < mode && timeout >= time)\
	DPMSSet(serverClient, mode);

#define DPMS_CHECK_TIMEOUT(time)\
    if (time > 0 && (time - timeout) > 0)\
	return time - timeout;

static CARD32
NextDPMSTimeout(INT32 timeout)
{
    /*
     * Return the amount of time remaining until we should set
     * the next power level. Fallthroughs are intentional.
     */
    switch (DPMSPowerLevel) {
    case DPMSModeOn:
        DPMS_CHECK_TIMEOUT(DPMSStandbyTime)

    case DPMSModeStandby:
        DPMS_CHECK_TIMEOUT(DPMSSuspendTime)

    case DPMSModeSuspend:
        DPMS_CHECK_TIMEOUT(DPMSOffTime)

    default:                   /* DPMSModeOff */
        return 0;
    }
}
#endif                          /* DPMSExtension */

static CARD32
ScreenSaverTimeoutExpire(OsTimerPtr timer, CARD32 now, pointer arg)
{
    INT32 timeout = now - lastDeviceEventTime[XIAllDevices].milliseconds;
    CARD32 nextTimeout = 0;

#ifdef DPMSExtension
    /*
     * Check each mode lowest to highest, since a lower mode can
     * have the same timeout as a higher one.
     */
    if (DPMSEnabled) {
        DPMS_CHECK_MODE(DPMSModeOff, DPMSOffTime)
            DPMS_CHECK_MODE(DPMSModeSuspend, DPMSSuspendTime)
            DPMS_CHECK_MODE(DPMSModeStandby, DPMSStandbyTime)

            nextTimeout = NextDPMSTimeout(timeout);
    }

    /*
     * Only do the screensaver checks if we're not in a DPMS
     * power saving mode
     */
    if (DPMSPowerLevel != DPMSModeOn)
        return nextTimeout;
#endif                          /* DPMSExtension */

    if (!ScreenSaverTime)
        return nextTimeout;

    if (timeout < ScreenSaverTime) {
        return nextTimeout > 0 ?
            min(ScreenSaverTime - timeout, nextTimeout) :
            ScreenSaverTime - timeout;
    }

    ResetOsBuffers();           /* not ideal, but better than nothing */
    dixSaveScreens(serverClient, SCREEN_SAVER_ON, ScreenSaverActive);

    if (ScreenSaverInterval > 0) {
        nextTimeout = nextTimeout > 0 ?
            min(ScreenSaverInterval, nextTimeout) : ScreenSaverInterval;
    }

    return nextTimeout;
}

static OsTimerPtr ScreenSaverTimer = NULL;

void
FreeScreenSaverTimer(void)
{
    if (ScreenSaverTimer) {
        TimerFree(ScreenSaverTimer);
        ScreenSaverTimer = NULL;
    }
}

void
SetScreenSaverTimer(void)
{
    CARD32 timeout = 0;

#ifdef DPMSExtension
    if (DPMSEnabled) {
        /*
         * A higher DPMS level has a timeout that's either less
         * than or equal to that of a lower DPMS level.
         */
        if (DPMSStandbyTime > 0)
            timeout = DPMSStandbyTime;

        else if (DPMSSuspendTime > 0)
            timeout = DPMSSuspendTime;

        else if (DPMSOffTime > 0)
            timeout = DPMSOffTime;
    }
#endif

    if (ScreenSaverTime > 0) {
        timeout = timeout > 0 ? min(ScreenSaverTime, timeout) : ScreenSaverTime;
    }

#ifdef SCREENSAVER
    if (timeout && !screenSaverSuspended) {
#else
    if (timeout) {
#endif
        ScreenSaverTimer = TimerSet(ScreenSaverTimer, 0, timeout,
                                    ScreenSaverTimeoutExpire, NULL);
    }
    else if (ScreenSaverTimer) {
        FreeScreenSaverTimer();
    }
}