annotate lib/sleep.c @ 12326:25e64e77bb53

sleep: work around cygwin bug On cygwin 1.5.x, sleep amounts larger than 49.7 days (2**32 milliseconds) failed instantly, but with a garbage return value from uninitialized memory. * lib/sleep.c (rpl_sleep): Work around the bug. * m4/sleep.m4 (gl_FUNC_SLEEP): Detect the bug. (gl_PREREQ_SLEEP): Delete unused macro. * modules/sleep (Depends-on): Add verify. * m4/unistd_h.m4 (gl_UNISTD_H_DEFAULTS): Add default. * modules/unistd (Makefile.am): Substitute witness. * lib/unistd.in.h (sleep): Update prototype. * doc/posix-functions/sleep.texi (sleep): Document the bug. * tests/test-sleep.c (main) [HAVE_DECL_ALARM]: Test it. * modules/sleep-tests (Depends-on): Check for alarm. Signed-off-by: Eric Blake <ebb9@byu.net>
author Eric Blake <ebb9@byu.net>
date Wed, 18 Nov 2009 20:07:44 -0700 (2009-11-19)
parents bbbbbf4cd1c5
children c2cbabec01dd
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8786
b7c6961fb530 New module 'sleep'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
1 /* Pausing execution of the current thread.
12326
25e64e77bb53 sleep: work around cygwin bug
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
2 Copyright (C) 2007, 2009 Free Software Foundation, Inc.
8786
b7c6961fb530 New module 'sleep'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
3 Written by Bruno Haible <bruno@clisp.org>, 2007.
b7c6961fb530 New module 'sleep'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
4
9309
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 8786
diff changeset
5 This program is free software: you can redistribute it and/or modify
8786
b7c6961fb530 New module 'sleep'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
6 it under the terms of the GNU General Public License as published by
9309
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 8786
diff changeset
7 the Free Software Foundation; either version 3 of the License, or
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 8786
diff changeset
8 (at your option) any later version.
8786
b7c6961fb530 New module 'sleep'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
9
b7c6961fb530 New module 'sleep'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
10 This program is distributed in the hope that it will be useful,
b7c6961fb530 New module 'sleep'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
b7c6961fb530 New module 'sleep'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
b7c6961fb530 New module 'sleep'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
13 GNU General Public License for more details.
b7c6961fb530 New module 'sleep'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
14
b7c6961fb530 New module 'sleep'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
15 You should have received a copy of the GNU General Public License
9309
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 8786
diff changeset
16 along with this program. If not, see <http://www.gnu.org/licenses/>. */
8786
b7c6961fb530 New module 'sleep'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
17
b7c6961fb530 New module 'sleep'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
18 #include <config.h>
b7c6961fb530 New module 'sleep'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
19
b7c6961fb530 New module 'sleep'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
20 /* Specification. */
b7c6961fb530 New module 'sleep'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
21 #include <unistd.h>
b7c6961fb530 New module 'sleep'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
22
12326
25e64e77bb53 sleep: work around cygwin bug
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
23 #include <limits.h>
25e64e77bb53 sleep: work around cygwin bug
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
24
25e64e77bb53 sleep: work around cygwin bug
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
25 #include "verify.h"
25e64e77bb53 sleep: work around cygwin bug
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
26
8786
b7c6961fb530 New module 'sleep'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
27 #if (defined _WIN32 || defined __WIN32__) && ! defined __CYGWIN__
b7c6961fb530 New module 'sleep'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
28
b7c6961fb530 New module 'sleep'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
29 # define WIN32_LEAN_AND_MEAN /* avoid including junk */
b7c6961fb530 New module 'sleep'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
30 # include <windows.h>
b7c6961fb530 New module 'sleep'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
31
b7c6961fb530 New module 'sleep'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
32 unsigned int
b7c6961fb530 New module 'sleep'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
33 sleep (unsigned int seconds)
b7c6961fb530 New module 'sleep'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
34 {
b7c6961fb530 New module 'sleep'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
35 unsigned int remaining;
b7c6961fb530 New module 'sleep'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
36
b7c6961fb530 New module 'sleep'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
37 /* Sleep for 1 second many times, because
b7c6961fb530 New module 'sleep'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
38 1. Sleep is not interruptiple by Ctrl-C,
b7c6961fb530 New module 'sleep'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
39 2. we want to avoid arithmetic overflow while multiplying with 1000. */
b7c6961fb530 New module 'sleep'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
40 for (remaining = seconds; remaining > 0; remaining--)
b7c6961fb530 New module 'sleep'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
41 Sleep (1000);
b7c6961fb530 New module 'sleep'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
42
b7c6961fb530 New module 'sleep'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
43 return remaining;
b7c6961fb530 New module 'sleep'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
44 }
b7c6961fb530 New module 'sleep'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
45
12326
25e64e77bb53 sleep: work around cygwin bug
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
46 #elif HAVE_SLEEP
25e64e77bb53 sleep: work around cygwin bug
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
47
25e64e77bb53 sleep: work around cygwin bug
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
48 # undef sleep
25e64e77bb53 sleep: work around cygwin bug
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
49
25e64e77bb53 sleep: work around cygwin bug
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
50 /* Guarantee unlimited sleep and a reasonable return value. Cygwin
25e64e77bb53 sleep: work around cygwin bug
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
51 1.5.x rejects attempts to sleep more than 49.7 days (2**32
25e64e77bb53 sleep: work around cygwin bug
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
52 milliseconds), but uses uninitialized memory which results in a
25e64e77bb53 sleep: work around cygwin bug
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
53 garbage answer. */
25e64e77bb53 sleep: work around cygwin bug
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
54 unsigned int
25e64e77bb53 sleep: work around cygwin bug
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
55 rpl_sleep (unsigned int seconds)
25e64e77bb53 sleep: work around cygwin bug
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
56 {
25e64e77bb53 sleep: work around cygwin bug
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
57 /* This requires int larger than 16 bits. */
25e64e77bb53 sleep: work around cygwin bug
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
58 verify (UINT_MAX / 49 / 24 / 60 / 60);
25e64e77bb53 sleep: work around cygwin bug
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
59 const unsigned int limit = 49 * 24 * 60 * 60;
25e64e77bb53 sleep: work around cygwin bug
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
60 while (limit < seconds)
25e64e77bb53 sleep: work around cygwin bug
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
61 {
25e64e77bb53 sleep: work around cygwin bug
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
62 unsigned int result;
25e64e77bb53 sleep: work around cygwin bug
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
63 seconds -= limit;
25e64e77bb53 sleep: work around cygwin bug
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
64 result = sleep (limit);
25e64e77bb53 sleep: work around cygwin bug
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
65 if (result)
25e64e77bb53 sleep: work around cygwin bug
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
66 return seconds + result;
25e64e77bb53 sleep: work around cygwin bug
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
67 }
25e64e77bb53 sleep: work around cygwin bug
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
68 return sleep (seconds);
25e64e77bb53 sleep: work around cygwin bug
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
69 }
25e64e77bb53 sleep: work around cygwin bug
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
70
25e64e77bb53 sleep: work around cygwin bug
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
71 #else /* !HAVE_SLEEP */
8786
b7c6961fb530 New module 'sleep'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
72
b7c6961fb530 New module 'sleep'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
73 #error "Please port gnulib sleep.c to your platform, possibly using usleep() or select(), then report this to bug-gnulib."
b7c6961fb530 New module 'sleep'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
74
b7c6961fb530 New module 'sleep'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
75 #endif