1 /* Various utility functions.
2 Copyright (C) 2003 Free Software Foundation, Inc.
4 This file is part of GNU Wget.
6 GNU Wget is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 GNU Wget is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with Wget; if not, write to the Free Software
18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 In addition, as a special exception, the Free Software Foundation
21 gives permission to link the code of its release of Wget with the
22 OpenSSL project's "OpenSSL" library (or with modified versions of it
23 that use the same license as the "OpenSSL" library), and distribute
24 the linked executables. You must obey the GNU General Public License
25 in all respects for all of the code used other than "OpenSSL". If you
26 modify this file, you may extend this exception to your version of the
27 file, but you are not obligated to do so. If you do not wish to do
28 so, delete this exception statement from your version. */
36 #else /* not HAVE_STRING_H */
38 #endif /* not HAVE_STRING_H */
39 #include <sys/types.h>
44 # include <sys/mman.h>
55 #ifdef HAVE_SYS_UTIME_H
56 # include <sys/utime.h>
60 # include <libc.h> /* for access() */
64 #ifdef WGET_USE_STDARG
70 /* For TIOCGWINSZ and friends: */
71 #ifdef HAVE_SYS_IOCTL_H
72 # include <sys/ioctl.h>
78 /* Needed for run_with_timeout. */
79 #undef USE_SIGNAL_TIMEOUT
87 #ifndef HAVE_SIGSETJMP
88 /* If sigsetjmp is a macro, configure won't pick it up. */
90 # define HAVE_SIGSETJMP
95 # ifdef HAVE_SIGSETJMP
96 # define USE_SIGNAL_TIMEOUT
99 # define USE_SIGNAL_TIMEOUT
111 /* Utility function: like xstrdup(), but also lowercases S. */
114 xstrdup_lower (const char *s)
116 char *copy = xstrdup (s);
123 /* Return a count of how many times CHR occurs in STRING. */
126 count_char (const char *string, char chr)
130 for (p = string; *p; p++)
136 /* Copy the string formed by two pointers (one on the beginning, other
137 on the char after the last char) to a new, malloc-ed location.
140 strdupdelim (const char *beg, const char *end)
142 char *res = (char *)xmalloc (end - beg + 1);
143 memcpy (res, beg, end - beg);
144 res[end - beg] = '\0';
148 /* Parse a string containing comma-separated elements, and return a
149 vector of char pointers with the elements. Spaces following the
150 commas are ignored. */
152 sepstring (const char *s)
166 res = (char **)xrealloc (res, (i + 2) * sizeof (char *));
167 res[i] = strdupdelim (p, s);
170 /* Skip the blanks following the ','. */
178 res = (char **)xrealloc (res, (i + 2) * sizeof (char *));
179 res[i] = strdupdelim (p, s);
184 #ifdef WGET_USE_STDARG
185 # define VA_START(args, arg1) va_start (args, arg1)
187 # define VA_START(args, ignored) va_start (args)
190 /* Like sprintf, but allocates a string of sufficient size with malloc
191 and returns it. GNU libc has a similar function named asprintf,
192 which requires the pointer to the string to be passed. */
195 aprintf (const char *fmt, ...)
197 /* This function is implemented using vsnprintf, which we provide
198 for the systems that don't have it. Therefore, it should be 100%
202 char *str = xmalloc (size);
209 /* See log_vprintf_internal for explanation why it's OK to rely
210 on the return value of vsnprintf. */
212 VA_START (args, fmt);
213 n = vsnprintf (str, size, fmt, args);
216 /* If the printing worked, return the string. */
217 if (n > -1 && n < size)
220 /* Else try again with a larger buffer. */
221 if (n > -1) /* C99 */
222 size = n + 1; /* precisely what is needed */
224 size <<= 1; /* twice the old size */
225 str = xrealloc (str, size);
227 return NULL; /* unreached */
230 /* Return pointer to a static char[] buffer in which zero-terminated
231 string-representation of TM (in form hh:mm:ss) is printed.
233 If TM is NULL, the current time will be used. */
236 time_str (time_t *tm)
238 static char output[15];
240 time_t secs = tm ? *tm : time (NULL);
244 /* In case of error, return the empty string. Maybe we should
245 just abort if this happens? */
249 ptm = localtime (&secs);
250 sprintf (output, "%02d:%02d:%02d", ptm->tm_hour, ptm->tm_min, ptm->tm_sec);
254 /* Like the above, but include the date: YYYY-MM-DD hh:mm:ss. */
257 datetime_str (time_t *tm)
259 static char output[20]; /* "YYYY-MM-DD hh:mm:ss" + \0 */
261 time_t secs = tm ? *tm : time (NULL);
265 /* In case of error, return the empty string. Maybe we should
266 just abort if this happens? */
270 ptm = localtime (&secs);
271 sprintf (output, "%04d-%02d-%02d %02d:%02d:%02d",
272 ptm->tm_year + 1900, ptm->tm_mon + 1, ptm->tm_mday,
273 ptm->tm_hour, ptm->tm_min, ptm->tm_sec);
277 /* The Windows versions of the following two functions are defined in
282 fork_to_background (void)
285 /* Whether we arrange our own version of opt.lfilename here. */
290 opt.lfilename = unique_name (DEFAULT_LOGFILE, 0);
302 /* parent, no error */
303 printf (_("Continuing in background, pid %d.\n"), (int)pid);
305 printf (_("Output will be written to `%s'.\n"), opt.lfilename);
306 exit (0); /* #### should we use _exit()? */
309 /* child: give up the privileges and keep running. */
311 freopen ("/dev/null", "r", stdin);
312 freopen ("/dev/null", "w", stdout);
313 freopen ("/dev/null", "w", stderr);
315 #endif /* not WINDOWS */
317 /* "Touch" FILE, i.e. make its atime and mtime equal to the time
318 specified with TM. */
320 touch (const char *file, time_t tm)
322 #ifdef HAVE_STRUCT_UTIMBUF
323 struct utimbuf times;
324 times.actime = times.modtime = tm;
327 times[0] = times[1] = tm;
330 if (utime (file, ×) == -1)
331 logprintf (LOG_NOTQUIET, "utime(%s): %s\n", file, strerror (errno));
334 /* Checks if FILE is a symbolic link, and removes it if it is. Does
335 nothing under MS-Windows. */
337 remove_link (const char *file)
342 if (lstat (file, &st) == 0 && S_ISLNK (st.st_mode))
344 DEBUGP (("Unlinking %s (symlink).\n", file));
347 logprintf (LOG_VERBOSE, _("Failed to unlink symlink `%s': %s\n"),
348 file, strerror (errno));
353 /* Does FILENAME exist? This is quite a lousy implementation, since
354 it supplies no error codes -- only a yes-or-no answer. Thus it
355 will return that a file does not exist if, e.g., the directory is
356 unreadable. I don't mind it too much currently, though. The
357 proper way should, of course, be to have a third, error state,
358 other than true/false, but that would introduce uncalled-for
359 additional complexity to the callers. */
361 file_exists_p (const char *filename)
364 return access (filename, F_OK) >= 0;
367 return stat (filename, &buf) >= 0;
371 /* Returns 0 if PATH is a directory, 1 otherwise (any kind of file).
372 Returns 0 on error. */
374 file_non_directory_p (const char *path)
377 /* Use lstat() rather than stat() so that symbolic links pointing to
378 directories can be identified correctly. */
379 if (lstat (path, &buf) != 0)
381 return S_ISDIR (buf.st_mode) ? 0 : 1;
384 /* Return the size of file named by FILENAME, or -1 if it cannot be
385 opened or seeked into. */
387 file_size (const char *filename)
389 #if defined(HAVE_FSEEKO) && defined(HAVE_FTELLO)
391 /* We use fseek rather than stat to determine the file size because
392 that way we can also verify that the file is readable without
393 explicitly checking for permissions. Inspired by the POST patch
395 FILE *fp = fopen (filename, "rb");
398 fseeko (fp, 0, SEEK_END);
404 if (stat (filename, &st) < 0)
410 /* stat file names named PREFIX.1, PREFIX.2, etc., until one that
411 doesn't exist is found. Return a freshly allocated copy of the
415 unique_name_1 (const char *prefix)
418 int plen = strlen (prefix);
419 char *template = (char *)alloca (plen + 1 + 24);
420 char *template_tail = template + plen;
422 memcpy (template, prefix, plen);
423 *template_tail++ = '.';
426 number_to_string (template_tail, count++);
427 while (file_exists_p (template));
429 return xstrdup (template);
432 /* Return a unique file name, based on FILE.
434 More precisely, if FILE doesn't exist, it is returned unmodified.
435 If not, FILE.1 is tried, then FILE.2, etc. The first FILE.<number>
436 file name that doesn't exist is returned.
438 The resulting file is not created, only verified that it didn't
439 exist at the point in time when the function was called.
440 Therefore, where security matters, don't rely that the file created
441 by this function exists until you open it with O_EXCL or
444 If ALLOW_PASSTHROUGH is 0, it always returns a freshly allocated
445 string. Otherwise, it may return FILE if the file doesn't exist
446 (and therefore doesn't need changing). */
449 unique_name (const char *file, int allow_passthrough)
451 /* If the FILE itself doesn't exist, return it without
453 if (!file_exists_p (file))
454 return allow_passthrough ? (char *)file : xstrdup (file);
456 /* Otherwise, find a numeric suffix that results in unused file name
458 return unique_name_1 (file);
461 /* Create DIRECTORY. If some of the pathname components of DIRECTORY
462 are missing, create them first. In case any mkdir() call fails,
463 return its error status. Returns 0 on successful completion.
465 The behaviour of this function should be identical to the behaviour
466 of `mkdir -p' on systems where mkdir supports the `-p' option. */
468 make_directory (const char *directory)
475 /* Make a copy of dir, to be able to write to it. Otherwise, the
476 function is unsafe if called with a read-only char *argument. */
477 STRDUP_ALLOCA (dir, directory);
479 /* If the first character of dir is '/', skip it (and thus enable
480 creation of absolute-pathname directories. */
481 for (i = (*dir == '/'); 1; ++i)
483 for (; dir[i] && dir[i] != '/'; i++)
488 /* Check whether the directory already exists. Allow creation of
489 of intermediate directories to fail, as the initial path components
490 are not necessarily directories! */
491 if (!file_exists_p (dir))
492 ret = mkdir (dir, 0777);
503 /* Merge BASE with FILE. BASE can be a directory or a file name, FILE
504 should be a file name.
506 file_merge("/foo/bar", "baz") => "/foo/baz"
507 file_merge("/foo/bar/", "baz") => "/foo/bar/baz"
508 file_merge("foo", "bar") => "bar"
510 In other words, it's a simpler and gentler version of uri_merge_1. */
513 file_merge (const char *base, const char *file)
516 const char *cut = (const char *)strrchr (base, '/');
519 return xstrdup (file);
521 result = (char *)xmalloc (cut - base + 1 + strlen (file) + 1);
522 memcpy (result, base, cut - base);
523 result[cut - base] = '/';
524 strcpy (result + (cut - base) + 1, file);
529 static int in_acclist PARAMS ((const char *const *, const char *, int));
531 /* Determine whether a file is acceptable to be followed, according to
532 lists of patterns to accept/reject. */
534 acceptable (const char *s)
538 while (l && s[l] != '/')
545 return (in_acclist ((const char *const *)opt.accepts, s, 1)
546 && !in_acclist ((const char *const *)opt.rejects, s, 1));
548 return in_acclist ((const char *const *)opt.accepts, s, 1);
550 else if (opt.rejects)
551 return !in_acclist ((const char *const *)opt.rejects, s, 1);
555 /* Compare S1 and S2 frontally; S2 must begin with S1. E.g. if S1 is
556 `/something', frontcmp() will return 1 only if S2 begins with
557 `/something'. Otherwise, 0 is returned. */
559 frontcmp (const char *s1, const char *s2)
561 for (; *s1 && *s2 && (*s1 == *s2); ++s1, ++s2);
565 /* Iterate through STRLIST, and return the first element that matches
566 S, through wildcards or front comparison (as appropriate). */
568 proclist (char **strlist, const char *s, enum accd flags)
572 for (x = strlist; *x; x++)
573 if (has_wildcards_p (*x))
575 if (fnmatch (*x, s, FNM_PATHNAME) == 0)
580 char *p = *x + ((flags & ALLABS) && (**x == '/')); /* Remove '/' */
587 /* Returns whether DIRECTORY is acceptable for download, wrt the
588 include/exclude lists.
590 If FLAGS is ALLABS, the leading `/' is ignored in paths; relative
591 and absolute paths may be freely intermixed. */
593 accdir (const char *directory, enum accd flags)
595 /* Remove starting '/'. */
596 if (flags & ALLABS && *directory == '/')
600 if (!proclist (opt.includes, directory, flags))
605 if (proclist (opt.excludes, directory, flags))
611 /* Return non-zero if STRING ends with TAIL. For instance:
613 match_tail ("abc", "bc", 0) -> 1
614 match_tail ("abc", "ab", 0) -> 0
615 match_tail ("abc", "abc", 0) -> 1
617 If FOLD_CASE_P is non-zero, the comparison will be
621 match_tail (const char *string, const char *tail, int fold_case_p)
625 /* We want this to be fast, so we code two loops, one with
626 case-folding, one without. */
630 for (i = strlen (string), j = strlen (tail); i >= 0 && j >= 0; i--, j--)
631 if (string[i] != tail[j])
636 for (i = strlen (string), j = strlen (tail); i >= 0 && j >= 0; i--, j--)
637 if (TOLOWER (string[i]) != TOLOWER (tail[j]))
641 /* If the tail was exhausted, the match was succesful. */
648 /* Checks whether string S matches each element of ACCEPTS. A list
649 element are matched either with fnmatch() or match_tail(),
650 according to whether the element contains wildcards or not.
652 If the BACKWARD is 0, don't do backward comparison -- just compare
655 in_acclist (const char *const *accepts, const char *s, int backward)
657 for (; *accepts; accepts++)
659 if (has_wildcards_p (*accepts))
661 /* fnmatch returns 0 if the pattern *does* match the
663 if (fnmatch (*accepts, s, 0) == 0)
670 if (match_tail (s, *accepts, 0))
675 if (!strcmp (s, *accepts))
683 /* Return the location of STR's suffix (file extension). Examples:
684 suffix ("foo.bar") -> "bar"
685 suffix ("foo.bar.baz") -> "baz"
686 suffix ("/foo/bar") -> NULL
687 suffix ("/foo.bar/baz") -> NULL */
689 suffix (const char *str)
693 for (i = strlen (str); i && str[i] != '/' && str[i] != '.'; i--)
697 return (char *)str + i;
702 /* Return non-zero if S contains globbing wildcards (`*', `?', `[' or
706 has_wildcards_p (const char *s)
709 if (*s == '*' || *s == '?' || *s == '[' || *s == ']')
714 /* Return non-zero if FNAME ends with a typical HTML suffix. The
715 following (case-insensitive) suffixes are presumed to be HTML files:
719 ?html (`?' matches one character)
721 #### CAVEAT. This is not necessarily a good indication that FNAME
722 refers to a file that contains HTML! */
724 has_html_suffix_p (const char *fname)
728 if ((suf = suffix (fname)) == NULL)
730 if (!strcasecmp (suf, "html"))
732 if (!strcasecmp (suf, "htm"))
734 if (suf[0] && !strcasecmp (suf + 1, "html"))
739 /* Read a line from FP and return the pointer to freshly allocated
740 storage. The storage space is obtained through malloc() and should
741 be freed with free() when it is no longer needed.
743 The length of the line is not limited, except by available memory.
744 The newline character at the end of line is retained. The line is
745 terminated with a zero character.
747 After end-of-file is encountered without anything being read, NULL
748 is returned. NULL is also returned on error. To distinguish
749 between these two cases, use the stdio function ferror(). */
752 read_whole_line (FILE *fp)
756 char *line = (char *)xmalloc (bufsize);
758 while (fgets (line + length, bufsize - length, fp))
760 length += strlen (line + length);
762 /* Possible for example when reading from a binary file where
763 a line begins with \0. */
766 if (line[length - 1] == '\n')
769 /* fgets() guarantees to read the whole line, or to use up the
770 space we've given it. We can double the buffer
773 line = xrealloc (line, bufsize);
775 if (length == 0 || ferror (fp))
780 if (length + 1 < bufsize)
781 /* Relieve the memory from our exponential greediness. We say
782 `length + 1' because the terminating \0 is not included in
783 LENGTH. We don't need to zero-terminate the string ourselves,
784 though, because fgets() does that. */
785 line = xrealloc (line, length + 1);
789 /* Read FILE into memory. A pointer to `struct file_memory' are
790 returned; use struct element `content' to access file contents, and
791 the element `length' to know the file length. `content' is *not*
792 zero-terminated, and you should *not* read or write beyond the [0,
793 length) range of characters.
795 After you are done with the file contents, call read_file_free to
798 Depending on the operating system and the type of file that is
799 being read, read_file() either mmap's the file into memory, or
800 reads the file into the core using read().
802 If file is named "-", fileno(stdin) is used for reading instead.
803 If you want to read from a real file named "-", use "./-" instead. */
806 read_file (const char *file)
809 struct file_memory *fm;
811 int inhibit_close = 0;
813 /* Some magic in the finest tradition of Perl and its kin: if FILE
814 is "-", just use stdin. */
819 /* Note that we don't inhibit mmap() in this case. If stdin is
820 redirected from a regular file, mmap() will still work. */
823 fd = open (file, O_RDONLY);
826 fm = xnew (struct file_memory);
831 if (fstat (fd, &buf) < 0)
833 fm->length = buf.st_size;
834 /* NOTE: As far as I know, the callers of this function never
835 modify the file text. Relying on this would enable us to
836 specify PROT_READ and MAP_SHARED for a marginal gain in
837 efficiency, but at some cost to generality. */
838 fm->content = mmap (NULL, fm->length, PROT_READ | PROT_WRITE,
840 if (fm->content == (char *)MAP_FAILED)
850 /* The most common reason why mmap() fails is that FD does not point
851 to a plain file. However, it's also possible that mmap() doesn't
852 work for a particular type of file. Therefore, whenever mmap()
853 fails, we just fall back to the regular method. */
854 #endif /* HAVE_MMAP */
857 size = 512; /* number of bytes fm->contents can
858 hold at any given time. */
859 fm->content = xmalloc (size);
863 if (fm->length > size / 2)
865 /* #### I'm not sure whether the whole exponential-growth
866 thing makes sense with kernel read. On Linux at least,
867 read() refuses to read more than 4K from a file at a
868 single chunk anyway. But other Unixes might optimize it
869 better, and it doesn't *hurt* anything, so I'm leaving
872 /* Normally, we grow SIZE exponentially to make the number
873 of calls to read() and realloc() logarithmic in relation
874 to file size. However, read() can read an amount of data
875 smaller than requested, and it would be unreasonable to
876 double SIZE every time *something* was read. Therefore,
877 we double SIZE only when the length exceeds half of the
878 entire allocated size. */
880 fm->content = xrealloc (fm->content, size);
882 nread = read (fd, fm->content + fm->length, size - fm->length);
884 /* Successful read. */
895 if (size > fm->length && fm->length != 0)
896 /* Due to exponential growth of fm->content, the allocated region
897 might be much larger than what is actually needed. */
898 fm->content = xrealloc (fm->content, fm->length);
910 /* Release the resources held by FM. Specifically, this calls
911 munmap() or xfree() on fm->content, depending whether mmap or
912 malloc/read were used to read in the file. It also frees the
913 memory needed to hold the FM structure itself. */
916 read_file_free (struct file_memory *fm)
921 munmap (fm->content, fm->length);
931 /* Free the pointers in a NULL-terminated vector of pointers, then
932 free the pointer itself. */
934 free_vec (char **vec)
945 /* Append vector V2 to vector V1. The function frees V2 and
946 reallocates V1 (thus you may not use the contents of neither
947 pointer after the call). If V1 is NULL, V2 is returned. */
949 merge_vecs (char **v1, char **v2)
959 /* To avoid j == 0 */
964 for (i = 0; v1[i]; i++);
966 for (j = 0; v2[j]; j++);
968 v1 = (char **)xrealloc (v1, (i + j + 1) * sizeof (char **));
969 memcpy (v1 + i, v2, (j + 1) * sizeof (char *));
974 /* A set of simple-minded routines to store strings in a linked list.
975 This used to also be used for searching, but now we have hash
978 /* It's a shame that these simple things like linked lists and hash
979 tables (see hash.c) need to be implemented over and over again. It
980 would be nice to be able to use the routines from glib -- see
981 www.gtk.org for details. However, that would make Wget depend on
982 glib, and I want to avoid dependencies to external libraries for
983 reasons of convenience and portability (I suspect Wget is more
984 portable than anything ever written for Gnome). */
986 /* Append an element to the list. If the list has a huge number of
987 elements, this can get slow because it has to find the list's
988 ending. If you think you have to call slist_append in a loop,
989 think about calling slist_prepend() followed by slist_nreverse(). */
992 slist_append (slist *l, const char *s)
994 slist *newel = xnew (slist);
997 newel->string = xstrdup (s);
1002 /* Find the last element. */
1009 /* Prepend S to the list. Unlike slist_append(), this is O(1). */
1012 slist_prepend (slist *l, const char *s)
1014 slist *newel = xnew (slist);
1015 newel->string = xstrdup (s);
1020 /* Destructively reverse L. */
1023 slist_nreverse (slist *l)
1028 slist *next = l->next;
1036 /* Is there a specific entry in the list? */
1038 slist_contains (slist *l, const char *s)
1040 for (; l; l = l->next)
1041 if (!strcmp (l->string, s))
1046 /* Free the whole slist. */
1048 slist_free (slist *l)
1059 /* Sometimes it's useful to create "sets" of strings, i.e. special
1060 hash tables where you want to store strings as keys and merely
1061 query for their existence. Here is a set of utility routines that
1062 makes that transparent. */
1065 string_set_add (struct hash_table *ht, const char *s)
1067 /* First check whether the set element already exists. If it does,
1068 do nothing so that we don't have to free() the old element and
1069 then strdup() a new one. */
1070 if (hash_table_contains (ht, s))
1073 /* We use "1" as value. It provides us a useful and clear arbitrary
1074 value, and it consumes no memory -- the pointers to the same
1075 string "1" will be shared by all the key-value pairs in all `set'
1077 hash_table_put (ht, xstrdup (s), "1");
1080 /* Synonym for hash_table_contains... */
1083 string_set_contains (struct hash_table *ht, const char *s)
1085 return hash_table_contains (ht, s);
1089 string_set_free_mapper (void *key, void *value_ignored, void *arg_ignored)
1096 string_set_free (struct hash_table *ht)
1098 hash_table_map (ht, string_set_free_mapper, NULL);
1099 hash_table_destroy (ht);
1103 free_keys_and_values_mapper (void *key, void *value, void *arg_ignored)
1110 /* Another utility function: call free() on all keys and values of HT. */
1113 free_keys_and_values (struct hash_table *ht)
1115 hash_table_map (ht, free_keys_and_values_mapper, NULL);
1119 /* Engine for legible and legible_large_int; add thousand separators
1120 to numbers printed in strings. */
1123 legible_1 (const char *repr)
1125 static char outbuf[48];
1130 /* Reset the pointers. */
1134 /* Ignore the sign for the purpose of adding thousand
1141 /* How many digits before the first separator? */
1142 mod = strlen (inptr) % 3;
1144 for (i = 0; i < mod; i++)
1145 *outptr++ = inptr[i];
1146 /* Now insert the rest of them, putting separator before every
1148 for (i1 = i, i = 0; inptr[i1]; i++, i1++)
1150 if (i % 3 == 0 && i1 != 0)
1152 *outptr++ = inptr[i1];
1154 /* Zero-terminate the string. */
1159 /* Legible -- return a static pointer to the legibly printed wgint. */
1165 /* Print the number into the buffer. */
1166 number_to_string (inbuf, l);
1167 return legible_1 (inbuf);
1170 /* Write a string representation of LARGE_INT NUMBER into the provided
1171 buffer. The buffer should be able to accept 24 characters,
1172 including the terminating zero.
1174 It would be dangerous to use sprintf, because the code wouldn't
1175 work on a machine with gcc-provided long long support, but without
1176 libc support for "%lld". However, such platforms will typically
1177 not have snprintf and will use our version, which does support
1178 "%lld" where long longs are available. */
1181 large_int_to_string (char *buffer, LARGE_INT number)
1183 snprintf (buffer, 24, LARGE_INT_FMT, number);
1186 /* The same as legible(), but works on LARGE_INT. */
1189 legible_large_int (LARGE_INT l)
1192 large_int_to_string (inbuf, l);
1193 return legible_1 (inbuf);
1196 /* Count the digits in an integer number. */
1198 numdigit (wgint number)
1206 while ((number /= 10) > 0)
1211 #define ONE_DIGIT(figure) *p++ = n / (figure) + '0'
1212 #define ONE_DIGIT_ADVANCE(figure) (ONE_DIGIT (figure), n %= (figure))
1214 #define DIGITS_1(figure) ONE_DIGIT (figure)
1215 #define DIGITS_2(figure) ONE_DIGIT_ADVANCE (figure); DIGITS_1 ((figure) / 10)
1216 #define DIGITS_3(figure) ONE_DIGIT_ADVANCE (figure); DIGITS_2 ((figure) / 10)
1217 #define DIGITS_4(figure) ONE_DIGIT_ADVANCE (figure); DIGITS_3 ((figure) / 10)
1218 #define DIGITS_5(figure) ONE_DIGIT_ADVANCE (figure); DIGITS_4 ((figure) / 10)
1219 #define DIGITS_6(figure) ONE_DIGIT_ADVANCE (figure); DIGITS_5 ((figure) / 10)
1220 #define DIGITS_7(figure) ONE_DIGIT_ADVANCE (figure); DIGITS_6 ((figure) / 10)
1221 #define DIGITS_8(figure) ONE_DIGIT_ADVANCE (figure); DIGITS_7 ((figure) / 10)
1222 #define DIGITS_9(figure) ONE_DIGIT_ADVANCE (figure); DIGITS_8 ((figure) / 10)
1223 #define DIGITS_10(figure) ONE_DIGIT_ADVANCE (figure); DIGITS_9 ((figure) / 10)
1225 /* DIGITS_<11-20> are only used on machines with 64-bit numbers. */
1227 #define DIGITS_11(figure) ONE_DIGIT_ADVANCE (figure); DIGITS_10 ((figure) / 10)
1228 #define DIGITS_12(figure) ONE_DIGIT_ADVANCE (figure); DIGITS_11 ((figure) / 10)
1229 #define DIGITS_13(figure) ONE_DIGIT_ADVANCE (figure); DIGITS_12 ((figure) / 10)
1230 #define DIGITS_14(figure) ONE_DIGIT_ADVANCE (figure); DIGITS_13 ((figure) / 10)
1231 #define DIGITS_15(figure) ONE_DIGIT_ADVANCE (figure); DIGITS_14 ((figure) / 10)
1232 #define DIGITS_16(figure) ONE_DIGIT_ADVANCE (figure); DIGITS_15 ((figure) / 10)
1233 #define DIGITS_17(figure) ONE_DIGIT_ADVANCE (figure); DIGITS_16 ((figure) / 10)
1234 #define DIGITS_18(figure) ONE_DIGIT_ADVANCE (figure); DIGITS_17 ((figure) / 10)
1235 #define DIGITS_19(figure) ONE_DIGIT_ADVANCE (figure); DIGITS_18 ((figure) / 10)
1237 /* It is annoying that we have three different syntaxes for 64-bit constants:
1238 - nnnL for 64-bit systems, where they are of type long;
1239 - nnnLL for 32-bit systems that support long long;
1240 - nnnI64 for MS compiler on Windows, which doesn't support long long. */
1243 /* If long is large enough, use long constants. */
1244 # define C10000000000 10000000000L
1245 # define C100000000000 100000000000L
1246 # define C1000000000000 1000000000000L
1247 # define C10000000000000 10000000000000L
1248 # define C100000000000000 100000000000000L
1249 # define C1000000000000000 1000000000000000L
1250 # define C10000000000000000 10000000000000000L
1251 # define C100000000000000000 100000000000000000L
1252 # define C1000000000000000000 1000000000000000000L
1254 # if SIZEOF_LONG_LONG != 0
1255 /* Otherwise, if long long is available, use long long constants. */
1256 # define C10000000000 10000000000LL
1257 # define C100000000000 100000000000LL
1258 # define C1000000000000 1000000000000LL
1259 # define C10000000000000 10000000000000LL
1260 # define C100000000000000 100000000000000LL
1261 # define C1000000000000000 1000000000000000LL
1262 # define C10000000000000000 10000000000000000LL
1263 # define C100000000000000000 100000000000000000LL
1264 # define C1000000000000000000 1000000000000000000LL
1266 # if defined(_MSC_VER) || defined(__WATCOM__)
1267 /* Otherwise, if __int64 is available (under Windows), use __int64
1269 # define C10000000000 10000000000I64
1270 # define C100000000000 100000000000I64
1271 # define C1000000000000 1000000000000I64
1272 # define C10000000000000 10000000000000I64
1273 # define C100000000000000 100000000000000I64
1274 # define C1000000000000000 1000000000000000I64
1275 # define C10000000000000000 10000000000000000I64
1276 # define C100000000000000000 100000000000000000I64
1277 # define C1000000000000000000 1000000000000000000I64
1282 /* SPRINTF_WGINT is used by number_to_string to handle pathological
1283 cases and to portably support strange sizes of wgint. */
1284 #if SIZEOF_LONG >= SIZEOF_WGINT
1285 # define SPRINTF_WGINT(buf, n) sprintf(buf, "%ld", (long) (n))
1287 # if SIZEOF_LONG_LONG >= SIZEOF_WGINT
1288 # define SPRINTF_WGINT(buf, n) sprintf(buf, "%lld", (long long) (n))
1291 # define SPRINTF_WGINT(buf, n) sprintf(buf, "%I64", (__int64) (n))
1296 /* Print NUMBER to BUFFER in base 10. This is equivalent to
1297 `sprintf(buffer, "%lld", (long long) number)', only much faster and
1298 portable to machines without long long.
1300 The speedup may make a difference in programs that frequently
1301 convert numbers to strings. Some implementations of sprintf,
1302 particularly the one in GNU libc, have been known to be extremely
1303 slow when converting integers to strings.
1305 Return the pointer to the location where the terminating zero was
1306 printed. (Equivalent to calling buffer+strlen(buffer) after the
1309 BUFFER should be big enough to accept as many bytes as you expect
1310 the number to take up. On machines with 64-bit longs the maximum
1311 needed size is 24 bytes. That includes the digits needed for the
1312 largest 64-bit number, the `-' sign in case it's negative, and the
1313 terminating '\0'. */
1316 number_to_string (char *buffer, wgint number)
1321 #if (SIZEOF_WGINT != 4) && (SIZEOF_WGINT != 8)
1322 /* We are running in a strange or misconfigured environment. Let
1323 sprintf cope with it. */
1324 SPRINTF_WGINT (buffer, n);
1325 p += strlen (buffer);
1326 #else /* (SIZEOF_WGINT == 4) || (SIZEOF_WGINT == 8) */
1332 /* We cannot print a '-' and assign -n to n because -n would
1333 overflow. Let sprintf deal with this border case. */
1334 SPRINTF_WGINT (buffer, n);
1335 p += strlen (buffer);
1343 if (n < 10) { DIGITS_1 (1); }
1344 else if (n < 100) { DIGITS_2 (10); }
1345 else if (n < 1000) { DIGITS_3 (100); }
1346 else if (n < 10000) { DIGITS_4 (1000); }
1347 else if (n < 100000) { DIGITS_5 (10000); }
1348 else if (n < 1000000) { DIGITS_6 (100000); }
1349 else if (n < 10000000) { DIGITS_7 (1000000); }
1350 else if (n < 100000000) { DIGITS_8 (10000000); }
1351 else if (n < 1000000000) { DIGITS_9 (100000000); }
1352 #if SIZEOF_WGINT == 4
1353 /* wgint is four bytes long: we're done. */
1354 /* ``if (1)'' serves only to preserve editor indentation. */
1355 else if (1) { DIGITS_10 (1000000000); }
1357 /* wgint is 64 bits long -- make sure to process all the digits. */
1358 else if (n < C10000000000) { DIGITS_10 (1000000000); }
1359 else if (n < C100000000000) { DIGITS_11 (C10000000000); }
1360 else if (n < C1000000000000) { DIGITS_12 (C100000000000); }
1361 else if (n < C10000000000000) { DIGITS_13 (C1000000000000); }
1362 else if (n < C100000000000000) { DIGITS_14 (C10000000000000); }
1363 else if (n < C1000000000000000) { DIGITS_15 (C100000000000000); }
1364 else if (n < C10000000000000000) { DIGITS_16 (C1000000000000000); }
1365 else if (n < C100000000000000000) { DIGITS_17 (C10000000000000000); }
1366 else if (n < C1000000000000000000) { DIGITS_18 (C100000000000000000); }
1367 else { DIGITS_19 (C1000000000000000000); }
1371 #endif /* (SIZEOF_WGINT == 4) || (SIZEOF_WGINT == 8) */
1377 #undef ONE_DIGIT_ADVANCE
1401 /* Print NUMBER to a statically allocated string and return a pointer
1402 to the printed representation.
1404 This function is intended to be used in conjunction with printf.
1405 It is hard to portably print wgint values:
1406 a) you cannot use printf("%ld", number) because wgint can be long
1407 long on 32-bit machines with LFS.
1408 b) you cannot use printf("%lld", number) because NUMBER could be
1409 long on 32-bit machines without LFS, or on 64-bit machines,
1410 which do not require LFS. Also, Windows doesn't support %lld.
1411 c) you cannot use printf("%j", (int_max_t) number) because not all
1412 versions of printf support "%j", the most notable being the one
1414 d) you cannot #define WGINT_FMT to the appropriate format and use
1415 printf(WGINT_FMT, number) because that would break translations
1416 for user-visible messages, such as printf("Downloaded: %d
1419 What you should use instead is printf("%s", number_to_static_string
1422 CAVEAT: since the function returns pointers to static data, you
1423 must be careful to copy its result before calling it again.
1424 However, to make it more useful with printf, the function maintains
1425 an internal ring of static buffers to return. That way things like
1426 printf("%s %s", number_to_static_string (num1),
1427 number_to_static_string (num2)) work as expected. Three buffers
1428 are currently used, which means that "%s %s %s" will work, but "%s
1429 %s %s %s" won't. If you need to print more than three wgints,
1430 bump the RING_SIZE (or rethink your message.) */
1433 number_to_static_string (wgint number)
1435 static char ring[RING_SIZE][24];
1437 char *buf = ring[ringpos];
1438 number_to_string (buf, number);
1439 ringpos = (ringpos + 1) % RING_SIZE;
1443 /* Support for timers. */
1445 #undef TIMER_WINDOWS
1446 #undef TIMER_GETTIMEOFDAY
1449 /* Depending on the OS and availability of gettimeofday(), one and
1450 only one of the above constants will be defined. Virtually all
1451 modern Unix systems will define TIMER_GETTIMEOFDAY; Windows will
1452 use TIMER_WINDOWS. TIMER_TIME is a catch-all method for
1453 non-Windows systems without gettimeofday.
1455 #### Perhaps we should also support ftime(), which exists on old
1456 BSD 4.2-influenced systems? (It also existed under MS DOS Borland
1457 C, if memory serves me.) */
1460 # define TIMER_WINDOWS
1461 #else /* not WINDOWS */
1462 # ifdef HAVE_GETTIMEOFDAY
1463 # define TIMER_GETTIMEOFDAY
1467 #endif /* not WINDOWS */
1469 #ifdef TIMER_GETTIMEOFDAY
1470 typedef struct timeval wget_sys_time;
1474 typedef time_t wget_sys_time;
1477 #ifdef TIMER_WINDOWS
1478 typedef ULARGE_INTEGER wget_sys_time;
1482 /* Whether the start time has been initialized. */
1485 /* The starting point in time which, subtracted from the current
1486 time, yields elapsed time. */
1487 wget_sys_time start;
1489 /* The most recent elapsed time, calculated by wtimer_elapsed().
1490 Measured in milliseconds. */
1491 double elapsed_last;
1493 /* Approximately, the time elapsed between the true start of the
1494 measurement and the time represented by START. */
1495 double elapsed_pre_start;
1498 /* Allocate a timer. Calling wtimer_read on the timer will return
1499 zero. It is not legal to call wtimer_update with a freshly
1500 allocated timer -- use wtimer_reset first. */
1503 wtimer_allocate (void)
1505 struct wget_timer *wt = xnew (struct wget_timer);
1510 /* Allocate a new timer and reset it. Return the new timer. */
1515 struct wget_timer *wt = wtimer_allocate ();
1520 /* Free the resources associated with the timer. Its further use is
1524 wtimer_delete (struct wget_timer *wt)
1529 /* Store system time to WST. */
1532 wtimer_sys_set (wget_sys_time *wst)
1534 #ifdef TIMER_GETTIMEOFDAY
1535 gettimeofday (wst, NULL);
1542 #ifdef TIMER_WINDOWS
1543 /* We use GetSystemTime to get the elapsed time. MSDN warns that
1544 system clock adjustments can skew the output of GetSystemTime
1545 when used as a timer and gives preference to GetTickCount and
1546 high-resolution timers. But GetTickCount can overflow, and hires
1547 timers are typically used for profiling, not for regular time
1548 measurement. Since we handle clock skew anyway, we just use
1552 GetSystemTime (&st);
1554 /* As recommended by MSDN, we convert SYSTEMTIME to FILETIME, copy
1555 FILETIME to ULARGE_INTEGER, and use regular 64-bit integer
1556 arithmetic on that. */
1557 SystemTimeToFileTime (&st, &ft);
1558 wst->HighPart = ft.dwHighDateTime;
1559 wst->LowPart = ft.dwLowDateTime;
1563 /* Reset timer WT. This establishes the starting point from which
1564 wtimer_elapsed() will return the number of elapsed milliseconds.
1565 It is allowed to reset a previously used timer.
1567 If a non-zero value is used as START, the timer's values will be
1571 wtimer_reset (struct wget_timer *wt)
1573 /* Set the start time to the current time. */
1574 wtimer_sys_set (&wt->start);
1575 wt->elapsed_last = 0;
1576 wt->elapsed_pre_start = 0;
1577 wt->initialized = 1;
1581 wtimer_sys_diff (wget_sys_time *wst1, wget_sys_time *wst2)
1583 #ifdef TIMER_GETTIMEOFDAY
1584 return ((double)(wst1->tv_sec - wst2->tv_sec) * 1000
1585 + (double)(wst1->tv_usec - wst2->tv_usec) / 1000);
1589 return 1000 * (*wst1 - *wst2);
1593 /* VC++ 6 doesn't support direct cast of uint64 to double. To work
1594 around this, we subtract, then convert to signed, then finally to
1596 return (double)(signed __int64)(wst1->QuadPart - wst2->QuadPart) / 10000;
1600 /* Update the timer's elapsed interval. This function causes the
1601 timer to call gettimeofday (or time(), etc.) to update its idea of
1602 current time. To get the elapsed interval in milliseconds, use
1605 This function handles clock skew, i.e. time that moves backwards is
1609 wtimer_update (struct wget_timer *wt)
1614 assert (wt->initialized != 0);
1616 wtimer_sys_set (&now);
1617 elapsed = wt->elapsed_pre_start + wtimer_sys_diff (&now, &wt->start);
1619 /* Ideally we'd just return the difference between NOW and
1620 wt->start. However, the system timer can be set back, and we
1621 could return a value smaller than when we were last called, even
1622 a negative value. Both of these would confuse the callers, which
1623 expect us to return monotonically nondecreasing values.
1625 Therefore: if ELAPSED is smaller than its previous known value,
1626 we reset wt->start to the current time and effectively start
1627 measuring from this point. But since we don't want the elapsed
1628 value to start from zero, we set elapsed_pre_start to the last
1629 elapsed time and increment all future calculations by that
1632 if (elapsed < wt->elapsed_last)
1635 wt->elapsed_pre_start = wt->elapsed_last;
1636 elapsed = wt->elapsed_last;
1639 wt->elapsed_last = elapsed;
1642 /* Return the elapsed time in milliseconds between the last call to
1643 wtimer_reset and the last call to wtimer_update.
1645 A typical use of the timer interface would be:
1647 struct wtimer *timer = wtimer_new ();
1648 ... do something that takes a while ...
1650 double msecs = wtimer_read (); */
1653 wtimer_read (const struct wget_timer *wt)
1655 return wt->elapsed_last;
1658 /* Return the assessed granularity of the timer implementation, in
1659 milliseconds. This is used by code that tries to substitute a
1660 better value for timers that have returned zero. */
1663 wtimer_granularity (void)
1665 #ifdef TIMER_GETTIMEOFDAY
1666 /* Granularity of gettimeofday varies wildly between architectures.
1667 However, it appears that on modern machines it tends to be better
1668 than 1ms. Assume 100 usecs. (Perhaps the configure process
1669 could actually measure this?) */
1677 #ifdef TIMER_WINDOWS
1678 /* According to MSDN, GetSystemTime returns a broken-down time
1679 structure the smallest member of which are milliseconds. */
1684 /* This should probably be at a better place, but it doesn't really
1685 fit into html-parse.c. */
1687 /* The function returns the pointer to the malloc-ed quoted version of
1688 string s. It will recognize and quote numeric and special graphic
1689 entities, as per RFC1866:
1697 No other entities are recognized or replaced. */
1699 html_quote_string (const char *s)
1705 /* Pass through the string, and count the new size. */
1706 for (i = 0; *s; s++, i++)
1709 i += 4; /* `amp;' */
1710 else if (*s == '<' || *s == '>')
1711 i += 3; /* `lt;' and `gt;' */
1712 else if (*s == '\"')
1713 i += 5; /* `quot;' */
1717 res = (char *)xmalloc (i + 1);
1719 for (p = res; *s; s++)
1732 *p++ = (*s == '<' ? 'l' : 'g');
1759 /* Determine the width of the terminal we're running on. If that's
1760 not possible, return 0. */
1763 determine_screen_width (void)
1765 /* If there's a way to get the terminal size using POSIX
1766 tcgetattr(), somebody please tell me. */
1771 if (opt.lfilename != NULL)
1774 fd = fileno (stderr);
1775 if (ioctl (fd, TIOCGWINSZ, &wsz) < 0)
1776 return 0; /* most likely ENOTTY */
1779 #else /* not TIOCGWINSZ */
1781 CONSOLE_SCREEN_BUFFER_INFO csbi;
1782 if (!GetConsoleScreenBufferInfo (GetStdHandle (STD_ERROR_HANDLE), &csbi))
1784 return csbi.dwSize.X;
1785 # else /* neither WINDOWS nor TIOCGWINSZ */
1787 #endif /* neither WINDOWS nor TIOCGWINSZ */
1788 #endif /* not TIOCGWINSZ */
1791 /* Return a random number between 0 and MAX-1, inclusive.
1793 If MAX is greater than the value of RAND_MAX+1 on the system, the
1794 returned value will be in the range [0, RAND_MAX]. This may be
1795 fixed in a future release.
1797 The random number generator is seeded automatically the first time
1800 This uses rand() for portability. It has been suggested that
1801 random() offers better randomness, but this is not required for
1802 Wget, so I chose to go for simplicity and use rand
1805 DO NOT use this for cryptographic purposes. It is only meant to be
1806 used in situations where quality of the random numbers returned
1807 doesn't really matter. */
1810 random_number (int max)
1818 srand (time (NULL));
1823 /* On systems that don't define RAND_MAX, assume it to be 2**15 - 1,
1824 and enforce that assumption by masking other bits. */
1826 # define RAND_MAX 32767
1830 /* This is equivalent to rand() % max, but uses the high-order bits
1831 for better randomness on architecture where rand() is implemented
1832 using a simple congruential generator. */
1834 bounded = (double)max * rnd / (RAND_MAX + 1.0);
1835 return (int)bounded;
1838 /* Return a random uniformly distributed floating point number in the
1839 [0, 1) range. The precision of returned numbers is 9 digits.
1841 Modify this to use erand48() where available! */
1846 /* We can't rely on any specific value of RAND_MAX, but I'm pretty
1847 sure it's greater than 1000. */
1848 int rnd1 = random_number (1000);
1849 int rnd2 = random_number (1000);
1850 int rnd3 = random_number (1000);
1851 return rnd1 / 1000.0 + rnd2 / 1000000.0 + rnd3 / 1000000000.0;
1855 /* A debugging function for checking whether an MD5 library works. */
1857 #include "gen-md5.h"
1860 debug_test_md5 (char *buf)
1862 unsigned char raw[16];
1863 static char res[33];
1867 ALLOCA_MD5_CONTEXT (ctx);
1870 gen_md5_update ((unsigned char *)buf, strlen (buf), ctx);
1871 gen_md5_finish (ctx, raw);
1878 *p2++ = XNUM_TO_digit (*p1 >> 4);
1879 *p2++ = XNUM_TO_digit (*p1 & 0xf);
1888 /* Implementation of run_with_timeout, a generic timeout-forcing
1889 routine for systems with Unix-like signal handling. */
1891 #ifdef USE_SIGNAL_TIMEOUT
1892 # ifdef HAVE_SIGSETJMP
1893 # define SETJMP(env) sigsetjmp (env, 1)
1895 static sigjmp_buf run_with_timeout_env;
1898 abort_run_with_timeout (int sig)
1900 assert (sig == SIGALRM);
1901 siglongjmp (run_with_timeout_env, -1);
1903 # else /* not HAVE_SIGSETJMP */
1904 # define SETJMP(env) setjmp (env)
1906 static jmp_buf run_with_timeout_env;
1909 abort_run_with_timeout (int sig)
1911 assert (sig == SIGALRM);
1912 /* We don't have siglongjmp to preserve the set of blocked signals;
1913 if we longjumped out of the handler at this point, SIGALRM would
1914 remain blocked. We must unblock it manually. */
1915 int mask = siggetmask ();
1916 mask &= ~sigmask (SIGALRM);
1919 /* Now it's safe to longjump. */
1920 longjmp (run_with_timeout_env, -1);
1922 # endif /* not HAVE_SIGSETJMP */
1924 /* Arrange for SIGALRM to be delivered in TIMEOUT seconds. This uses
1925 setitimer where available, alarm otherwise.
1927 TIMEOUT should be non-zero. If the timeout value is so small that
1928 it would be rounded to zero, it is rounded to the least legal value
1929 instead (1us for setitimer, 1s for alarm). That ensures that
1930 SIGALRM will be delivered in all cases. */
1933 alarm_set (double timeout)
1936 /* Use the modern itimer interface. */
1937 struct itimerval itv;
1939 itv.it_value.tv_sec = (long) timeout;
1940 itv.it_value.tv_usec = 1000000L * (timeout - (long)timeout);
1941 if (itv.it_value.tv_sec == 0 && itv.it_value.tv_usec == 0)
1942 /* Ensure that we wait for at least the minimum interval.
1943 Specifying zero would mean "wait forever". */
1944 itv.it_value.tv_usec = 1;
1945 setitimer (ITIMER_REAL, &itv, NULL);
1946 #else /* not ITIMER_REAL */
1947 /* Use the old alarm() interface. */
1948 int secs = (int) timeout;
1950 /* Round TIMEOUTs smaller than 1 to 1, not to zero. This is
1951 because alarm(0) means "never deliver the alarm", i.e. "wait
1952 forever", which is not what someone who specifies a 0.5s
1953 timeout would expect. */
1956 #endif /* not ITIMER_REAL */
1959 /* Cancel the alarm set with alarm_set. */
1965 struct itimerval disable;
1967 setitimer (ITIMER_REAL, &disable, NULL);
1968 #else /* not ITIMER_REAL */
1970 #endif /* not ITIMER_REAL */
1973 /* Call FUN(ARG), but don't allow it to run for more than TIMEOUT
1974 seconds. Returns non-zero if the function was interrupted with a
1975 timeout, zero otherwise.
1977 This works by setting up SIGALRM to be delivered in TIMEOUT seconds
1978 using setitimer() or alarm(). The timeout is enforced by
1979 longjumping out of the SIGALRM handler. This has several
1980 advantages compared to the traditional approach of relying on
1981 signals causing system calls to exit with EINTR:
1983 * The callback function is *forcibly* interrupted after the
1984 timeout expires, (almost) regardless of what it was doing and
1985 whether it was in a syscall. For example, a calculation that
1986 takes a long time is interrupted as reliably as an IO
1989 * It works with both SYSV and BSD signals because it doesn't
1990 depend on the default setting of SA_RESTART.
1992 * It doesn't special handler setup beyond a simple call to
1993 signal(). (It does use sigsetjmp/siglongjmp, but they're
1996 The only downside is that, if FUN allocates internal resources that
1997 are normally freed prior to exit from the functions, they will be
1998 lost in case of timeout. */
2001 run_with_timeout (double timeout, void (*fun) (void *), void *arg)
2011 signal (SIGALRM, abort_run_with_timeout);
2012 if (SETJMP (run_with_timeout_env) != 0)
2014 /* Longjumped out of FUN with a timeout. */
2015 signal (SIGALRM, SIG_DFL);
2018 alarm_set (timeout);
2021 /* Preserve errno in case alarm() or signal() modifies it. */
2022 saved_errno = errno;
2024 signal (SIGALRM, SIG_DFL);
2025 errno = saved_errno;
2030 #else /* not USE_SIGNAL_TIMEOUT */
2033 /* A stub version of run_with_timeout that just calls FUN(ARG). Don't
2034 define it under Windows, because Windows has its own version of
2035 run_with_timeout that uses threads. */
2038 run_with_timeout (double timeout, void (*fun) (void *), void *arg)
2043 #endif /* not WINDOWS */
2044 #endif /* not USE_SIGNAL_TIMEOUT */
2048 /* Sleep the specified amount of seconds. On machines without
2049 nanosleep(), this may sleep shorter if interrupted by signals. */
2052 xsleep (double seconds)
2054 #ifdef HAVE_NANOSLEEP
2055 /* nanosleep is the preferred interface because it offers high
2056 accuracy and, more importantly, because it allows us to reliably
2057 restart after having been interrupted by a signal such as
2059 struct timespec sleep, remaining;
2060 sleep.tv_sec = (long) seconds;
2061 sleep.tv_nsec = 1000000000L * (seconds - (long) seconds);
2062 while (nanosleep (&sleep, &remaining) < 0 && errno == EINTR)
2063 /* If nanosleep has been interrupted by a signal, adjust the
2064 sleeping period and return to sleep. */
2066 #else /* not HAVE_NANOSLEEP */
2068 /* If usleep is available, use it in preference to select. */
2071 /* On some systems, usleep cannot handle values larger than
2072 1,000,000. If the period is larger than that, use sleep
2073 first, then add usleep for subsecond accuracy. */
2075 seconds -= (long) seconds;
2077 usleep (seconds * 1000000L);
2078 #else /* not HAVE_USLEEP */
2080 struct timeval sleep;
2081 sleep.tv_sec = (long) seconds;
2082 sleep.tv_usec = 1000000L * (seconds - (long) seconds);
2083 select (0, NULL, NULL, NULL, &sleep);
2084 /* If select returns -1 and errno is EINTR, it means we were
2085 interrupted by a signal. But without knowing how long we've
2086 actually slept, we can't return to sleep. Using gettimeofday to
2087 track sleeps is slow and unreliable due to clock skew. */
2088 #else /* not HAVE_SELECT */
2090 #endif /* not HAVE_SELECT */
2091 #endif /* not HAVE_USLEEP */
2092 #endif /* not HAVE_NANOSLEEP */
2095 #endif /* not WINDOWS */