time.c 12.6 KB
Newer Older
Alexandre Julliard's avatar
Alexandre Julliard committed
1 2
/* -*- tab-width: 8; c-basic-offset: 4 -*- */

Alexandre Julliard's avatar
Alexandre Julliard committed
3
/*
Andreas Mohr's avatar
Andreas Mohr committed
4
 * MMSYSTEM time functions
Alexandre Julliard's avatar
Alexandre Julliard committed
5 6
 *
 * Copyright 1993 Martin Ayotte
7 8 9 10 11 12 13 14 15 16 17 18 19
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
20
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
Alexandre Julliard's avatar
Alexandre Julliard committed
21 22
 */

23 24 25
#include "config.h"
#include "wine/port.h"

26
#include <stdarg.h>
27
#include <errno.h>
Alexandre Julliard's avatar
Alexandre Julliard committed
28
#include <time.h>
29 30 31 32 33 34
#ifdef HAVE_SYS_TIME_H
# include <sys/time.h>
#endif
#ifdef HAVE_UNISTD_H
# include <unistd.h>
#endif
35 36 37 38 39 40
#ifdef HAVE_POLL_H
#include <poll.h>
#endif
#ifdef HAVE_SYS_POLL_H
#include <sys/poll.h>
#endif
41

42
#include "windef.h"
43
#include "winbase.h"
44
#include "mmsystem.h"
45

46
#include "winemm.h"
47

48
#include "wine/list.h"
49
#include "wine/debug.h"
Alexandre Julliard's avatar
Alexandre Julliard committed
50

51
WINE_DEFAULT_DEBUG_CHANNEL(mmtime);
52

53
typedef struct tagWINE_TIMERENTRY {
54
    struct list                 entry;
55 56 57
    UINT                        wDelay;
    UINT                        wResol;
    LPTIMECALLBACK              lpFunc; /* can be lots of things */
58
    DWORD_PTR                   dwUser;
59 60 61 62 63
    UINT16                      wFlags;
    UINT16                      wTimerID;
    DWORD                       dwTriggerTime;
} WINE_TIMERENTRY, *LPWINE_TIMERENTRY;

64
static struct list timer_list = LIST_INIT(timer_list);
65

66 67 68 69 70 71 72 73 74
static CRITICAL_SECTION TIME_cbcrst;
static CRITICAL_SECTION_DEBUG critsect_debug =
{
    0, 0, &TIME_cbcrst,
    { &critsect_debug.ProcessLocksList, &critsect_debug.ProcessLocksList },
      0, 0, { (DWORD_PTR)(__FILE__ ": TIME_cbcrst") }
};
static CRITICAL_SECTION TIME_cbcrst = { &critsect_debug, -1, 0, 0, 0, 0 };

75
static    HANDLE                TIME_hMMTimer;
76
static    BOOL                  TIME_TimeToDie = TRUE;
77
static    int                   TIME_fdWake[2] = { -1, -1 };
78

79 80 81 82 83 84 85 86 87 88 89
/* link timer at the appropriate spot in the list */
static inline void link_timer( WINE_TIMERENTRY *timer )
{
    WINE_TIMERENTRY *next;

    LIST_FOR_EACH_ENTRY( next, &timer_list, WINE_TIMERENTRY, entry )
        if ((int)(next->dwTriggerTime - timer->dwTriggerTime) >= 0) break;

    list_add_before( &next->entry, &timer->entry );
}

Alexandre Julliard's avatar
Alexandre Julliard committed
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
 * Some observations on the behavior of winmm on Windows.
 * First, the call to timeBeginPeriod(xx) can never be used
 * to raise the timer resolution, only lower it.
 *
 * Second, a brief survey of a variety of Win 2k and Win X
 * machines showed that a 'standard' (aka default) timer
 * resolution was 1 ms (Win9x is documented as being 1).  However, one 
 * machine had a standard timer resolution of 10 ms.
 *
 * Further, if we set our default resolution to 1,
 * the implementation of timeGetTime becomes GetTickCount(),
 * and we can optimize the code to reduce overhead.
 *
 * Additionally, a survey of Event behaviors shows that
 * if we request a Periodic event every 50 ms, then Windows
 * makes sure to trigger that event 20 times in the next
 * second.  If delays prevent that from happening on exact
 * schedule, Windows will trigger the events as close
 * to the original schedule as is possible, and will eventually
 * bring the event triggers back onto a schedule that is
 * consistent with what would have happened if there were
 * no delays.
 *
 *   Jeremy White, October 2004
Alexandre Julliard's avatar
Alexandre Julliard committed
115
 */
116
#define MMSYSTIME_MININTERVAL (1)
Alexandre Julliard's avatar
Alexandre Julliard committed
117 118
#define MMSYSTIME_MAXINTERVAL (65535)

119
#ifdef HAVE_POLL
120

Alexandre Julliard's avatar
Alexandre Julliard committed
121
/**************************************************************************
Alexandre Julliard's avatar
Alexandre Julliard committed
122
 *           TIME_MMSysTimeCallback
Alexandre Julliard's avatar
Alexandre Julliard committed
123
 */
124
static int TIME_MMSysTimeCallback(void)
Alexandre Julliard's avatar
Alexandre Julliard committed
125
{
126 127
    WINE_TIMERENTRY *timer, *to_free;
    int delta_time;
128 129 130 131 132 133 134 135 136 137 138 139 140

    /* since timeSetEvent() and timeKillEvent() can be called
     * from 16 bit code, there are cases where win16 lock is
     * locked upon entering timeSetEvent(), and then the mm timer
     * critical section is locked. This function cannot call the
     * timer callback with the crit sect locked (because callback
     * may need to acquire Win16 lock, thus providing a deadlock
     * situation).
     * To cope with that, we just copy the WINE_TIMERENTRY struct
     * that need to trigger the callback, and call it without the
     * mm timer crit sect locked.
     */

141
    for (;;)
142
    {
143 144
        struct list *ptr = list_head( &timer_list );
        if (!ptr)
145
        {
146 147 148
            delta_time = -1;
            break;
        }
149

150 151 152
        timer = LIST_ENTRY( ptr, WINE_TIMERENTRY, entry );
        delta_time = timer->dwTriggerTime - GetTickCount();
        if (delta_time > 0) break;
153

154 155 156
        list_remove( &timer->entry );
        if (timer->wFlags & TIME_PERIODIC)
        {
157
            timer->dwTriggerTime += timer->wDelay;
158 159 160 161
            link_timer( timer );  /* restart it */
            to_free = NULL;
        }
        else to_free = timer;
162

163 164 165
        switch(timer->wFlags & (TIME_CALLBACK_EVENT_SET|TIME_CALLBACK_EVENT_PULSE))
        {
        case TIME_CALLBACK_EVENT_SET:
166
            SetEvent(timer->lpFunc);
167 168
            break;
        case TIME_CALLBACK_EVENT_PULSE:
169
            PulseEvent(timer->lpFunc);
170 171
            break;
        case TIME_CALLBACK_FUNCTION:
172
            {
173
                DWORD_PTR user = timer->dwUser;
174 175 176
                UINT16 id = timer->wTimerID;
                UINT16 flags = timer->wFlags;
                LPTIMECALLBACK func = timer->lpFunc;
177

178 179
                if (flags & TIME_KILL_SYNCHRONOUS) EnterCriticalSection(&TIME_cbcrst);
                LeaveCriticalSection(&WINMM_cs);
180

181
                func(id, 0, user, 0, 0);
182 183 184 185 186

                EnterCriticalSection(&WINMM_cs);
                if (flags & TIME_KILL_SYNCHRONOUS) LeaveCriticalSection(&TIME_cbcrst);
            }
            break;
187
        }
188
        HeapFree( GetProcessHeap(), 0, to_free );
189
    }
190
    return delta_time;
Alexandre Julliard's avatar
Alexandre Julliard committed
191 192
}

Eric Pouech's avatar
Eric Pouech committed
193
/**************************************************************************
194 195 196 197
 *           TIME_MMSysTimeThread
 */
static DWORD CALLBACK TIME_MMSysTimeThread(LPVOID arg)
{
198 199 200 201 202 203
    int sleep_time, ret;
    char readme[16];
    struct pollfd pfd;

    pfd.fd = TIME_fdWake[0];
    pfd.events = POLLIN;
204 205 206

    TRACE("Starting main winmm thread\n");

207
    EnterCriticalSection(&WINMM_cs);
208 209
    while (! TIME_TimeToDie) 
    {
210
        sleep_time = TIME_MMSysTimeCallback();
211

212 213
        if (sleep_time < 0)
            break;
214 215 216
        if (sleep_time == 0)
            continue;

217 218 219 220 221
        LeaveCriticalSection(&WINMM_cs);
        ret = poll(&pfd, 1, sleep_time);
        EnterCriticalSection(&WINMM_cs);

        if (ret < 0)
222 223 224 225 226 227 228 229 230
        {
            if (errno != EINTR && errno != EAGAIN)
            {
                ERR("Unexpected error in poll: %s(%d)\n", strerror(errno), errno);
                break;
            }
         }

        while (ret > 0) ret = read(TIME_fdWake[0], readme, sizeof(readme));
231
    }
232 233 234
    CloseHandle(TIME_hMMTimer);
    TIME_hMMTimer = NULL;
    LeaveCriticalSection(&WINMM_cs);
235
    TRACE("Exiting main winmm thread\n");
236
    FreeLibraryAndExitThread(arg, 0);
237 238 239 240 241
    return 0;
}

/**************************************************************************
 * 				TIME_MMTimeStart
Eric Pouech's avatar
Eric Pouech committed
242
 */
243
static void TIME_MMTimeStart(void)
Eric Pouech's avatar
Eric Pouech committed
244
{
245
    TIME_TimeToDie = 0;
246 247 248

    if (TIME_fdWake[0] < 0) {
        if (pipe(TIME_fdWake) < 0) {
249 250 251 252 253 254
            TIME_fdWake[0] = TIME_fdWake[1] = -1;
            ERR("Cannot create pipe: %s\n", strerror(errno));
        } else {
            fcntl(TIME_fdWake[0], F_SETFL, O_NONBLOCK);
            fcntl(TIME_fdWake[1], F_SETFL, O_NONBLOCK);
        }
255 256 257 258
    }

    if (!TIME_hMMTimer) {
        HMODULE mod;
259 260
        GetModuleHandleExW(GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS, (LPCWSTR)TIME_MMSysTimeThread, &mod);
        TIME_hMMTimer = CreateThread(NULL, 0, TIME_MMSysTimeThread, mod, 0, NULL);
261
        SetThreadPriority(TIME_hMMTimer, THREAD_PRIORITY_TIME_CRITICAL);
Eric Pouech's avatar
Eric Pouech committed
262 263 264
    }
}

265 266 267 268 269 270 271 272 273
#else  /* HAVE_POLL */

static void TIME_MMTimeStart(void)
{
    FIXME( "not starting system thread\n" );
}

#endif  /* HAVE_POLL */

274 275 276 277 278
/**************************************************************************
 * 				TIME_MMTimeStop
 */
void	TIME_MMTimeStop(void)
{
279
    if (TIME_hMMTimer) {
280 281 282 283 284
        EnterCriticalSection(&WINMM_cs);
        if (TIME_hMMTimer) {
            ERR("Timer still active?!\n");
            CloseHandle(TIME_hMMTimer);
        }
285 286
        close(TIME_fdWake[0]);
        close(TIME_fdWake[1]);
287
        DeleteCriticalSection(&TIME_cbcrst);
288 289 290
    }
}

Alexandre Julliard's avatar
Alexandre Julliard committed
291
/**************************************************************************
292
 * 				timeGetSystemTime	[WINMM.@]
Alexandre Julliard's avatar
Alexandre Julliard committed
293
 */
294
MMRESULT WINAPI timeGetSystemTime(LPMMTIME lpTime, UINT wSize)
Alexandre Julliard's avatar
Alexandre Julliard committed
295
{
296

Eric Pouech's avatar
Eric Pouech committed
297 298
    if (wSize >= sizeof(*lpTime)) {
	lpTime->wType = TIME_MS;
299
	lpTime->u.ms = GetTickCount();
300

Eric Pouech's avatar
Eric Pouech committed
301
    }
302

Alexandre Julliard's avatar
Alexandre Julliard committed
303 304 305
    return 0;
}

306
/**************************************************************************
307
 * 				timeSetEvent		[WINMM.@]
308
 */
309 310
MMRESULT WINAPI timeSetEvent(UINT wDelay, UINT wResol, LPTIMECALLBACK lpFunc,
                            DWORD_PTR dwUser, UINT wFlags)
Alexandre Julliard's avatar
Alexandre Julliard committed
311
{
Alexandre Julliard's avatar
Alexandre Julliard committed
312
    WORD 		wNewID = 0;
313 314
    LPWINE_TIMERENTRY	lpNewTimer;
    LPWINE_TIMERENTRY	lpTimer;
315
    const char c = 'c';
316

317
    TRACE("(%u, %u, %p, %08lX, %04X);\n", wDelay, wResol, lpFunc, dwUser, wFlags);
318

319
    if (wDelay < MMSYSTIME_MININTERVAL || wDelay > MMSYSTIME_MAXINTERVAL)
Alexandre Julliard's avatar
Alexandre Julliard committed
320
	return 0;
Eric Pouech's avatar
Eric Pouech committed
321

322 323
    lpNewTimer = HeapAlloc(GetProcessHeap(), 0, sizeof(WINE_TIMERENTRY));
    if (lpNewTimer == NULL)
324 325
	return 0;

Alexandre Julliard's avatar
Alexandre Julliard committed
326
    lpNewTimer->wDelay = wDelay;
327 328 329 330
    lpNewTimer->dwTriggerTime = GetTickCount() + wDelay;

    /* FIXME - wResol is not respected, although it is not clear
               that we could change our precision meaningfully  */
Alexandre Julliard's avatar
Alexandre Julliard committed
331
    lpNewTimer->wResol = wResol;
Alexandre Julliard's avatar
Alexandre Julliard committed
332
    lpNewTimer->lpFunc = lpFunc;
Alexandre Julliard's avatar
Alexandre Julliard committed
333 334
    lpNewTimer->dwUser = dwUser;
    lpNewTimer->wFlags = wFlags;
Eric Pouech's avatar
Eric Pouech committed
335

336
    EnterCriticalSection(&WINMM_cs);
Eric Pouech's avatar
Eric Pouech committed
337

338 339
    LIST_FOR_EACH_ENTRY( lpTimer, &timer_list, WINE_TIMERENTRY, entry )
        wNewID = max(wNewID, lpTimer->wTimerID);
340

341
    link_timer( lpNewTimer );
Eric Pouech's avatar
Eric Pouech committed
342 343
    lpNewTimer->wTimerID = wNewID + 1;

344 345
    TIME_MMTimeStart();

346
    LeaveCriticalSection(&WINMM_cs);
Eric Pouech's avatar
Eric Pouech committed
347

348
    /* Wake the service thread in case there is work to be done */
349
    write(TIME_fdWake[1], &c, sizeof(c));
350

351 352
    TRACE("=> %u\n", wNewID + 1);

Eric Pouech's avatar
Eric Pouech committed
353
    return wNewID + 1;
Alexandre Julliard's avatar
Alexandre Julliard committed
354 355
}

Alexandre Julliard's avatar
Alexandre Julliard committed
356
/**************************************************************************
357
 * 				timeKillEvent		[WINMM.@]
Alexandre Julliard's avatar
Alexandre Julliard committed
358
 */
359
MMRESULT WINAPI timeKillEvent(UINT wID)
Alexandre Julliard's avatar
Alexandre Julliard committed
360
{
361
    WINE_TIMERENTRY *lpSelf = NULL, *lpTimer;
362
    DWORD wFlags;
Eric Pouech's avatar
Eric Pouech committed
363

364
    TRACE("(%u)\n", wID);
365
    EnterCriticalSection(&WINMM_cs);
366
    /* remove WINE_TIMERENTRY from list */
367 368 369 370 371
    LIST_FOR_EACH_ENTRY( lpTimer, &timer_list, WINE_TIMERENTRY, entry )
    {
	if (wID == lpTimer->wTimerID) {
            lpSelf = lpTimer;
            list_remove( &lpTimer->entry );
Eric Pouech's avatar
Eric Pouech committed
372
	    break;
Alexandre Julliard's avatar
Alexandre Julliard committed
373 374
	}
    }
375 376
    if (list_empty(&timer_list)) {
        char c = 'q';
377
        TIME_TimeToDie = 1;
378 379
        write(TIME_fdWake[1], &c, sizeof(c));
    }
380
    LeaveCriticalSection(&WINMM_cs);
381

382 383 384 385
    if (!lpSelf)
    {
        WARN("wID=%u is not a valid timer ID\n", wID);
        return MMSYSERR_INVALPARAM;
386
    }
387 388
    wFlags = lpSelf->wFlags;
    if (wFlags & TIME_KILL_SYNCHRONOUS)
389
        EnterCriticalSection(&TIME_cbcrst);
390
    HeapFree(GetProcessHeap(), 0, lpSelf);
391
    if (wFlags & TIME_KILL_SYNCHRONOUS)
392
        LeaveCriticalSection(&TIME_cbcrst);
393
    return TIMERR_NOERROR;
Alexandre Julliard's avatar
Alexandre Julliard committed
394 395
}

Alexandre Julliard's avatar
Alexandre Julliard committed
396
/**************************************************************************
397
 * 				timeGetDevCaps		[WINMM.@]
Alexandre Julliard's avatar
Alexandre Julliard committed
398
 */
399
MMRESULT WINAPI timeGetDevCaps(LPTIMECAPS lpCaps, UINT wSize)
Alexandre Julliard's avatar
Alexandre Julliard committed
400
{
401
    TRACE("(%p, %u)\n", lpCaps, wSize);
402

403 404 405 406 407 408 409 410 411 412
    if (lpCaps == 0) {
        WARN("invalid lpCaps\n");
        return TIMERR_NOCANDO;
    }

    if (wSize < sizeof(TIMECAPS)) {
        WARN("invalid wSize\n");
        return TIMERR_NOCANDO;
    }

Alexandre Julliard's avatar
Alexandre Julliard committed
413 414
    lpCaps->wPeriodMin = MMSYSTIME_MININTERVAL;
    lpCaps->wPeriodMax = MMSYSTIME_MAXINTERVAL;
415
    return TIMERR_NOERROR;
Alexandre Julliard's avatar
Alexandre Julliard committed
416 417 418
}

/**************************************************************************
419
 * 				timeBeginPeriod		[WINMM.@]
Alexandre Julliard's avatar
Alexandre Julliard committed
420
 */
421
MMRESULT WINAPI timeBeginPeriod(UINT wPeriod)
Alexandre Julliard's avatar
Alexandre Julliard committed
422
{
423
    if (wPeriod < MMSYSTIME_MININTERVAL || wPeriod > MMSYSTIME_MAXINTERVAL)
Alexandre Julliard's avatar
Alexandre Julliard committed
424
	return TIMERR_NOCANDO;
425 426 427

    if (wPeriod > MMSYSTIME_MININTERVAL)
    {
Robert Reif's avatar
Robert Reif committed
428
        WARN("Stub; we set our timer resolution at minimum\n");
429 430
    }

Alexandre Julliard's avatar
Alexandre Julliard committed
431 432
    return 0;
}
Eric Pouech's avatar
Eric Pouech committed
433

Alexandre Julliard's avatar
Alexandre Julliard committed
434
/**************************************************************************
435
 * 				timeEndPeriod		[WINMM.@]
Alexandre Julliard's avatar
Alexandre Julliard committed
436
 */
437
MMRESULT WINAPI timeEndPeriod(UINT wPeriod)
Alexandre Julliard's avatar
Alexandre Julliard committed
438
{
439
    if (wPeriod < MMSYSTIME_MININTERVAL || wPeriod > MMSYSTIME_MAXINTERVAL)
Alexandre Julliard's avatar
Alexandre Julliard committed
440
	return TIMERR_NOCANDO;
441 442 443

    if (wPeriod > MMSYSTIME_MININTERVAL)
    {
Robert Reif's avatar
Robert Reif committed
444
        WARN("Stub; we set our timer resolution at minimum\n");
445
    }
Alexandre Julliard's avatar
Alexandre Julliard committed
446 447
    return 0;
}