1 /* Various functions of utilitarian nature.
2 Copyright (C) 1995, 1996, 1997, 1998, 2000, 2001
3 Free Software Foundation, Inc.
5 This file is part of GNU Wget.
7 GNU Wget is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 GNU Wget is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with Wget; if not, write to the Free Software
19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 In addition, as a special exception, the Free Software Foundation
22 gives permission to link the code of its release of Wget with the
23 OpenSSL project's "OpenSSL" library (or with modified versions of it
24 that use the same license as the "OpenSSL" library), and distribute
25 the linked executables. You must obey the GNU General Public License
26 in all respects for all of the code used other than "OpenSSL". If you
27 modify this file, you may extend this exception to your version of the
28 file, but you are not obligated to do so. If you do not wish to do
29 so, delete this exception statement from your version. */
37 #else /* not HAVE_STRING_H */
39 #endif /* not HAVE_STRING_H */
40 #include <sys/types.h>
45 # include <sys/mman.h>
54 #ifdef HAVE_SYS_UTIME_H
55 # include <sys/utime.h>
59 # include <libc.h> /* for access() */
64 /* For TIOCGWINSZ and friends: */
65 #ifdef HAVE_SYS_IOCTL_H
66 # include <sys/ioctl.h>
72 /* Needed for run_with_timeout. */
73 #undef USE_SIGNAL_TIMEOUT
80 /* If sigsetjmp is a macro, configure won't pick it up. */
82 # define HAVE_SIGSETJMP
85 # ifdef HAVE_SIGSETJMP
86 # define USE_SIGNAL_TIMEOUT
89 # define USE_SIGNAL_TIMEOUT
101 /* This section implements several wrappers around the basic
102 allocation routines. This is done for two reasons: first, so that
103 the callers of these functions need not consistently check for
104 errors. If there is not enough virtual memory for running Wget,
105 something is seriously wrong, and Wget exits with an appropriate
108 The second reason why these are useful is that, if DEBUG_MALLOC is
109 defined, they also provide a handy (if crude) malloc debugging
110 interface that checks memory leaks. */
112 /* Croak the fatal memory error and bail out with non-zero exit
115 memfatal (const char *what)
117 /* Make sure we don't try to store part of the log line, and thus
119 log_set_save_context (0);
120 logprintf (LOG_ALWAYS, _("%s: %s: Not enough memory.\n"), exec_name, what);
124 /* These functions end with _real because they need to be
125 distinguished from the debugging functions, and from the macros.
128 If memory debugging is not turned on, wget.h defines these:
130 #define xmalloc xmalloc_real
131 #define xrealloc xrealloc_real
132 #define xstrdup xstrdup_real
135 In case of memory debugging, the definitions are a bit more
136 complex, because we want to provide more information, *and* we want
137 to call the debugging code. (The former is the reason why xmalloc
138 and friends need to be macros in the first place.) Then it looks
141 #define xmalloc(a) xmalloc_debug (a, __FILE__, __LINE__)
142 #define xfree(a) xfree_debug (a, __FILE__, __LINE__)
143 #define xrealloc(a, b) xrealloc_debug (a, b, __FILE__, __LINE__)
144 #define xstrdup(a) xstrdup_debug (a, __FILE__, __LINE__)
146 Each of the *_debug function does its magic and calls the real one. */
149 # define STATIC_IF_DEBUG static
151 # define STATIC_IF_DEBUG
154 STATIC_IF_DEBUG void *
155 xmalloc_real (size_t size)
157 void *ptr = malloc (size);
163 STATIC_IF_DEBUG void *
164 xrealloc_real (void *ptr, size_t newsize)
168 /* Not all Un*xes have the feature of realloc() that calling it with
169 a NULL-pointer is the same as malloc(), but it is easy to
172 newptr = realloc (ptr, newsize);
174 newptr = malloc (newsize);
176 memfatal ("realloc");
180 STATIC_IF_DEBUG char *
181 xstrdup_real (const char *s)
187 copy = malloc (l + 1);
190 memcpy (copy, s, l + 1);
191 #else /* HAVE_STRDUP */
195 #endif /* HAVE_STRDUP */
202 /* Crude home-grown routines for debugging some malloc-related
205 * Counting the number of malloc and free invocations, and reporting
206 the "balance", i.e. how many times more malloc was called than it
207 was the case with free.
209 * Making malloc store its entry into a simple array and free remove
210 stuff from that array. At the end, print the pointers which have
211 not been freed, along with the source file and the line number.
212 This also has the side-effect of detecting freeing memory that
215 Note that this kind of memory leak checking strongly depends on
216 every malloc() being followed by a free(), even if the program is
217 about to finish. Wget is careful to free the data structure it
218 allocated in init.c. */
220 static int malloc_count, free_count;
226 } malloc_debug[100000];
228 /* Both register_ptr and unregister_ptr take O(n) operations to run,
229 which can be a real problem. It would be nice to use a hash table
230 for malloc_debug, but the functions in hash.c are not suitable
231 because they can call malloc() themselves. Maybe it would work if
232 the hash table were preallocated to a huge size, and if we set the
233 rehash threshold to 1.0. */
235 /* Register PTR in malloc_debug. Abort if this is not possible
236 (presumably due to the number of current allocations exceeding the
237 size of malloc_debug.) */
240 register_ptr (void *ptr, const char *file, int line)
243 for (i = 0; i < countof (malloc_debug); i++)
244 if (malloc_debug[i].ptr == NULL)
246 malloc_debug[i].ptr = ptr;
247 malloc_debug[i].file = file;
248 malloc_debug[i].line = line;
254 /* Unregister PTR from malloc_debug. Abort if PTR is not present in
255 malloc_debug. (This catches calling free() with a bogus pointer.) */
258 unregister_ptr (void *ptr)
261 for (i = 0; i < countof (malloc_debug); i++)
262 if (malloc_debug[i].ptr == ptr)
264 malloc_debug[i].ptr = NULL;
270 /* Print the malloc debug stats that can be gathered from the above
271 information. Currently this is the count of mallocs, frees, the
272 difference between the two, and the dump of the contents of
273 malloc_debug. The last part are the memory leaks. */
276 print_malloc_debug_stats (void)
279 printf ("\nMalloc: %d\nFree: %d\nBalance: %d\n\n",
280 malloc_count, free_count, malloc_count - free_count);
281 for (i = 0; i < countof (malloc_debug); i++)
282 if (malloc_debug[i].ptr != NULL)
283 printf ("0x%08ld: %s:%d\n", (long)malloc_debug[i].ptr,
284 malloc_debug[i].file, malloc_debug[i].line);
288 xmalloc_debug (size_t size, const char *source_file, int source_line)
290 void *ptr = xmalloc_real (size);
292 register_ptr (ptr, source_file, source_line);
297 xfree_debug (void *ptr, const char *source_file, int source_line)
299 assert (ptr != NULL);
301 unregister_ptr (ptr);
306 xrealloc_debug (void *ptr, size_t newsize, const char *source_file, int source_line)
308 void *newptr = xrealloc_real (ptr, newsize);
312 register_ptr (newptr, source_file, source_line);
314 else if (newptr != ptr)
316 unregister_ptr (ptr);
317 register_ptr (newptr, source_file, source_line);
323 xstrdup_debug (const char *s, const char *source_file, int source_line)
325 char *copy = xstrdup_real (s);
327 register_ptr (copy, source_file, source_line);
331 #endif /* DEBUG_MALLOC */
333 /* Utility function: like xstrdup(), but also lowercases S. */
336 xstrdup_lower (const char *s)
338 char *copy = xstrdup (s);
345 /* Return a count of how many times CHR occurs in STRING. */
348 count_char (const char *string, char chr)
352 for (p = string; *p; p++)
358 /* Copy the string formed by two pointers (one on the beginning, other
359 on the char after the last char) to a new, malloc-ed location.
362 strdupdelim (const char *beg, const char *end)
364 char *res = (char *)xmalloc (end - beg + 1);
365 memcpy (res, beg, end - beg);
366 res[end - beg] = '\0';
370 /* Parse a string containing comma-separated elements, and return a
371 vector of char pointers with the elements. Spaces following the
372 commas are ignored. */
374 sepstring (const char *s)
388 res = (char **)xrealloc (res, (i + 2) * sizeof (char *));
389 res[i] = strdupdelim (p, s);
392 /* Skip the blanks following the ','. */
400 res = (char **)xrealloc (res, (i + 2) * sizeof (char *));
401 res[i] = strdupdelim (p, s);
406 /* Return pointer to a static char[] buffer in which zero-terminated
407 string-representation of TM (in form hh:mm:ss) is printed.
409 If TM is non-NULL, the current time-in-seconds will be stored
412 (#### This is misleading: one would expect TM would be used instead
413 of the current time in that case. This design was probably
414 influenced by the design time(2), and should be changed at some
415 points. No callers use non-NULL TM anyway.) */
418 time_str (time_t *tm)
420 static char output[15];
422 time_t secs = time (tm);
426 /* In case of error, return the empty string. Maybe we should
427 just abort if this happens? */
431 ptm = localtime (&secs);
432 sprintf (output, "%02d:%02d:%02d", ptm->tm_hour, ptm->tm_min, ptm->tm_sec);
436 /* Like the above, but include the date: YYYY-MM-DD hh:mm:ss. */
439 datetime_str (time_t *tm)
441 static char output[20]; /* "YYYY-MM-DD hh:mm:ss" + \0 */
443 time_t secs = time (tm);
447 /* In case of error, return the empty string. Maybe we should
448 just abort if this happens? */
452 ptm = localtime (&secs);
453 sprintf (output, "%04d-%02d-%02d %02d:%02d:%02d",
454 ptm->tm_year + 1900, ptm->tm_mon + 1, ptm->tm_mday,
455 ptm->tm_hour, ptm->tm_min, ptm->tm_sec);
459 /* The Windows versions of the following two functions are defined in
464 fork_to_background (void)
467 /* Whether we arrange our own version of opt.lfilename here. */
472 opt.lfilename = unique_name (DEFAULT_LOGFILE, 0);
484 /* parent, no error */
485 printf (_("Continuing in background, pid %d.\n"), (int)pid);
487 printf (_("Output will be written to `%s'.\n"), opt.lfilename);
488 exit (0); /* #### should we use _exit()? */
491 /* child: give up the privileges and keep running. */
493 freopen ("/dev/null", "r", stdin);
494 freopen ("/dev/null", "w", stdout);
495 freopen ("/dev/null", "w", stderr);
497 #endif /* not WINDOWS */
499 /* "Touch" FILE, i.e. make its atime and mtime equal to the time
500 specified with TM. */
502 touch (const char *file, time_t tm)
504 #ifdef HAVE_STRUCT_UTIMBUF
505 struct utimbuf times;
506 times.actime = times.modtime = tm;
509 times[0] = times[1] = tm;
512 if (utime (file, ×) == -1)
513 logprintf (LOG_NOTQUIET, "utime(%s): %s\n", file, strerror (errno));
516 /* Checks if FILE is a symbolic link, and removes it if it is. Does
517 nothing under MS-Windows. */
519 remove_link (const char *file)
524 if (lstat (file, &st) == 0 && S_ISLNK (st.st_mode))
526 DEBUGP (("Unlinking %s (symlink).\n", file));
529 logprintf (LOG_VERBOSE, _("Failed to unlink symlink `%s': %s\n"),
530 file, strerror (errno));
535 /* Does FILENAME exist? This is quite a lousy implementation, since
536 it supplies no error codes -- only a yes-or-no answer. Thus it
537 will return that a file does not exist if, e.g., the directory is
538 unreadable. I don't mind it too much currently, though. The
539 proper way should, of course, be to have a third, error state,
540 other than true/false, but that would introduce uncalled-for
541 additional complexity to the callers. */
543 file_exists_p (const char *filename)
546 return access (filename, F_OK) >= 0;
549 return stat (filename, &buf) >= 0;
553 /* Returns 0 if PATH is a directory, 1 otherwise (any kind of file).
554 Returns 0 on error. */
556 file_non_directory_p (const char *path)
559 /* Use lstat() rather than stat() so that symbolic links pointing to
560 directories can be identified correctly. */
561 if (lstat (path, &buf) != 0)
563 return S_ISDIR (buf.st_mode) ? 0 : 1;
566 /* Return the size of file named by FILENAME, or -1 if it cannot be
567 opened or seeked into. */
569 file_size (const char *filename)
572 /* We use fseek rather than stat to determine the file size because
573 that way we can also verify whether the file is readable.
574 Inspired by the POST patch by Arnaud Wylie. */
575 FILE *fp = fopen (filename, "rb");
578 fseek (fp, 0, SEEK_END);
584 /* stat file names named PREFIX.1, PREFIX.2, etc., until one that
585 doesn't exist is found. Return a freshly allocated copy of the
589 unique_name_1 (const char *prefix)
592 int plen = strlen (prefix);
593 char *template = (char *)alloca (plen + 1 + 24);
594 char *template_tail = template + plen;
596 memcpy (template, prefix, plen);
597 *template_tail++ = '.';
600 number_to_string (template_tail, count++);
601 while (file_exists_p (template));
603 return xstrdup (template);
606 /* Return a unique file name, based on FILE.
608 More precisely, if FILE doesn't exist, it is returned unmodified.
609 If not, FILE.1 is tried, then FILE.2, etc. The first FILE.<number>
610 file name that doesn't exist is returned.
612 The resulting file is not created, only verified that it didn't
613 exist at the point in time when the function was called.
614 Therefore, where security matters, don't rely that the file created
615 by this function exists until you open it with O_EXCL or
618 If ALLOW_PASSTHROUGH is 0, it always returns a freshly allocated
619 string. Otherwise, it may return FILE if the file doesn't exist
620 (and therefore doesn't need changing). */
623 unique_name (const char *file, int allow_passthrough)
625 /* If the FILE itself doesn't exist, return it without
627 if (!file_exists_p (file))
628 return allow_passthrough ? (char *)file : xstrdup (file);
630 /* Otherwise, find a numeric suffix that results in unused file name
632 return unique_name_1 (file);
635 /* Create DIRECTORY. If some of the pathname components of DIRECTORY
636 are missing, create them first. In case any mkdir() call fails,
637 return its error status. Returns 0 on successful completion.
639 The behaviour of this function should be identical to the behaviour
640 of `mkdir -p' on systems where mkdir supports the `-p' option. */
642 make_directory (const char *directory)
649 /* Make a copy of dir, to be able to write to it. Otherwise, the
650 function is unsafe if called with a read-only char *argument. */
651 STRDUP_ALLOCA (dir, directory);
653 /* If the first character of dir is '/', skip it (and thus enable
654 creation of absolute-pathname directories. */
655 for (i = (*dir == '/'); 1; ++i)
657 for (; dir[i] && dir[i] != '/'; i++)
662 /* Check whether the directory already exists. Allow creation of
663 of intermediate directories to fail, as the initial path components
664 are not necessarily directories! */
665 if (!file_exists_p (dir))
666 ret = mkdir (dir, 0777);
677 /* Merge BASE with FILE. BASE can be a directory or a file name, FILE
678 should be a file name.
680 file_merge("/foo/bar", "baz") => "/foo/baz"
681 file_merge("/foo/bar/", "baz") => "/foo/bar/baz"
682 file_merge("foo", "bar") => "bar"
684 In other words, it's a simpler and gentler version of uri_merge_1. */
687 file_merge (const char *base, const char *file)
690 const char *cut = (const char *)strrchr (base, '/');
693 return xstrdup (file);
695 result = (char *)xmalloc (cut - base + 1 + strlen (file) + 1);
696 memcpy (result, base, cut - base);
697 result[cut - base] = '/';
698 strcpy (result + (cut - base) + 1, file);
703 static int in_acclist PARAMS ((const char *const *, const char *, int));
705 /* Determine whether a file is acceptable to be followed, according to
706 lists of patterns to accept/reject. */
708 acceptable (const char *s)
712 while (l && s[l] != '/')
719 return (in_acclist ((const char *const *)opt.accepts, s, 1)
720 && !in_acclist ((const char *const *)opt.rejects, s, 1));
722 return in_acclist ((const char *const *)opt.accepts, s, 1);
724 else if (opt.rejects)
725 return !in_acclist ((const char *const *)opt.rejects, s, 1);
729 /* Compare S1 and S2 frontally; S2 must begin with S1. E.g. if S1 is
730 `/something', frontcmp() will return 1 only if S2 begins with
731 `/something'. Otherwise, 0 is returned. */
733 frontcmp (const char *s1, const char *s2)
735 for (; *s1 && *s2 && (*s1 == *s2); ++s1, ++s2);
739 /* Iterate through STRLIST, and return the first element that matches
740 S, through wildcards or front comparison (as appropriate). */
742 proclist (char **strlist, const char *s, enum accd flags)
746 for (x = strlist; *x; x++)
747 if (has_wildcards_p (*x))
749 if (fnmatch (*x, s, FNM_PATHNAME) == 0)
754 char *p = *x + ((flags & ALLABS) && (**x == '/')); /* Remove '/' */
761 /* Returns whether DIRECTORY is acceptable for download, wrt the
762 include/exclude lists.
764 If FLAGS is ALLABS, the leading `/' is ignored in paths; relative
765 and absolute paths may be freely intermixed. */
767 accdir (const char *directory, enum accd flags)
769 /* Remove starting '/'. */
770 if (flags & ALLABS && *directory == '/')
774 if (!proclist (opt.includes, directory, flags))
779 if (proclist (opt.excludes, directory, flags))
785 /* Return non-zero if STRING ends with TAIL. For instance:
787 match_tail ("abc", "bc", 0) -> 1
788 match_tail ("abc", "ab", 0) -> 0
789 match_tail ("abc", "abc", 0) -> 1
791 If FOLD_CASE_P is non-zero, the comparison will be
795 match_tail (const char *string, const char *tail, int fold_case_p)
799 /* We want this to be fast, so we code two loops, one with
800 case-folding, one without. */
804 for (i = strlen (string), j = strlen (tail); i >= 0 && j >= 0; i--, j--)
805 if (string[i] != tail[j])
810 for (i = strlen (string), j = strlen (tail); i >= 0 && j >= 0; i--, j--)
811 if (TOLOWER (string[i]) != TOLOWER (tail[j]))
815 /* If the tail was exhausted, the match was succesful. */
822 /* Checks whether string S matches each element of ACCEPTS. A list
823 element are matched either with fnmatch() or match_tail(),
824 according to whether the element contains wildcards or not.
826 If the BACKWARD is 0, don't do backward comparison -- just compare
829 in_acclist (const char *const *accepts, const char *s, int backward)
831 for (; *accepts; accepts++)
833 if (has_wildcards_p (*accepts))
835 /* fnmatch returns 0 if the pattern *does* match the
837 if (fnmatch (*accepts, s, 0) == 0)
844 if (match_tail (s, *accepts, 0))
849 if (!strcmp (s, *accepts))
857 /* Return the location of STR's suffix (file extension). Examples:
858 suffix ("foo.bar") -> "bar"
859 suffix ("foo.bar.baz") -> "baz"
860 suffix ("/foo/bar") -> NULL
861 suffix ("/foo.bar/baz") -> NULL */
863 suffix (const char *str)
867 for (i = strlen (str); i && str[i] != '/' && str[i] != '.'; i--)
871 return (char *)str + i;
876 /* Return non-zero if S contains globbing wildcards (`*', `?', `[' or
880 has_wildcards_p (const char *s)
883 if (*s == '*' || *s == '?' || *s == '[' || *s == ']')
888 /* Return non-zero if FNAME ends with a typical HTML suffix. The
889 following (case-insensitive) suffixes are presumed to be HTML files:
893 ?html (`?' matches one character)
895 #### CAVEAT. This is not necessarily a good indication that FNAME
896 refers to a file that contains HTML! */
898 has_html_suffix_p (const char *fname)
902 if ((suf = suffix (fname)) == NULL)
904 if (!strcasecmp (suf, "html"))
906 if (!strcasecmp (suf, "htm"))
908 if (suf[0] && !strcasecmp (suf + 1, "html"))
913 /* Read a line from FP and return the pointer to freshly allocated
914 storage. The storage space is obtained through malloc() and should
915 be freed with free() when it is no longer needed.
917 The length of the line is not limited, except by available memory.
918 The newline character at the end of line is retained. The line is
919 terminated with a zero character.
921 After end-of-file is encountered without anything being read, NULL
922 is returned. NULL is also returned on error. To distinguish
923 between these two cases, use the stdio function ferror(). */
926 read_whole_line (FILE *fp)
930 char *line = (char *)xmalloc (bufsize);
932 while (fgets (line + length, bufsize - length, fp))
934 length += strlen (line + length);
936 /* Possible for example when reading from a binary file where
937 a line begins with \0. */
940 if (line[length - 1] == '\n')
943 /* fgets() guarantees to read the whole line, or to use up the
944 space we've given it. We can double the buffer
947 line = xrealloc (line, bufsize);
949 if (length == 0 || ferror (fp))
954 if (length + 1 < bufsize)
955 /* Relieve the memory from our exponential greediness. We say
956 `length + 1' because the terminating \0 is not included in
957 LENGTH. We don't need to zero-terminate the string ourselves,
958 though, because fgets() does that. */
959 line = xrealloc (line, length + 1);
963 /* Read FILE into memory. A pointer to `struct file_memory' are
964 returned; use struct element `content' to access file contents, and
965 the element `length' to know the file length. `content' is *not*
966 zero-terminated, and you should *not* read or write beyond the [0,
967 length) range of characters.
969 After you are done with the file contents, call read_file_free to
972 Depending on the operating system and the type of file that is
973 being read, read_file() either mmap's the file into memory, or
974 reads the file into the core using read().
976 If file is named "-", fileno(stdin) is used for reading instead.
977 If you want to read from a real file named "-", use "./-" instead. */
980 read_file (const char *file)
983 struct file_memory *fm;
985 int inhibit_close = 0;
987 /* Some magic in the finest tradition of Perl and its kin: if FILE
988 is "-", just use stdin. */
993 /* Note that we don't inhibit mmap() in this case. If stdin is
994 redirected from a regular file, mmap() will still work. */
997 fd = open (file, O_RDONLY);
1000 fm = xmalloc (sizeof (struct file_memory));
1005 if (fstat (fd, &buf) < 0)
1007 fm->length = buf.st_size;
1008 /* NOTE: As far as I know, the callers of this function never
1009 modify the file text. Relying on this would enable us to
1010 specify PROT_READ and MAP_SHARED for a marginal gain in
1011 efficiency, but at some cost to generality. */
1012 fm->content = mmap (NULL, fm->length, PROT_READ | PROT_WRITE,
1013 MAP_PRIVATE, fd, 0);
1014 if (fm->content == (char *)MAP_FAILED)
1024 /* The most common reason why mmap() fails is that FD does not point
1025 to a plain file. However, it's also possible that mmap() doesn't
1026 work for a particular type of file. Therefore, whenever mmap()
1027 fails, we just fall back to the regular method. */
1028 #endif /* HAVE_MMAP */
1031 size = 512; /* number of bytes fm->contents can
1032 hold at any given time. */
1033 fm->content = xmalloc (size);
1037 if (fm->length > size / 2)
1039 /* #### I'm not sure whether the whole exponential-growth
1040 thing makes sense with kernel read. On Linux at least,
1041 read() refuses to read more than 4K from a file at a
1042 single chunk anyway. But other Unixes might optimize it
1043 better, and it doesn't *hurt* anything, so I'm leaving
1046 /* Normally, we grow SIZE exponentially to make the number
1047 of calls to read() and realloc() logarithmic in relation
1048 to file size. However, read() can read an amount of data
1049 smaller than requested, and it would be unreasonable to
1050 double SIZE every time *something* was read. Therefore,
1051 we double SIZE only when the length exceeds half of the
1052 entire allocated size. */
1054 fm->content = xrealloc (fm->content, size);
1056 nread = read (fd, fm->content + fm->length, size - fm->length);
1058 /* Successful read. */
1059 fm->length += nread;
1069 if (size > fm->length && fm->length != 0)
1070 /* Due to exponential growth of fm->content, the allocated region
1071 might be much larger than what is actually needed. */
1072 fm->content = xrealloc (fm->content, fm->length);
1079 xfree (fm->content);
1084 /* Release the resources held by FM. Specifically, this calls
1085 munmap() or xfree() on fm->content, depending whether mmap or
1086 malloc/read were used to read in the file. It also frees the
1087 memory needed to hold the FM structure itself. */
1090 read_file_free (struct file_memory *fm)
1095 munmap (fm->content, fm->length);
1100 xfree (fm->content);
1105 /* Free the pointers in a NULL-terminated vector of pointers, then
1106 free the pointer itself. */
1108 free_vec (char **vec)
1119 /* Append vector V2 to vector V1. The function frees V2 and
1120 reallocates V1 (thus you may not use the contents of neither
1121 pointer after the call). If V1 is NULL, V2 is returned. */
1123 merge_vecs (char **v1, char **v2)
1133 /* To avoid j == 0 */
1138 for (i = 0; v1[i]; i++);
1140 for (j = 0; v2[j]; j++);
1141 /* Reallocate v1. */
1142 v1 = (char **)xrealloc (v1, (i + j + 1) * sizeof (char **));
1143 memcpy (v1 + i, v2, (j + 1) * sizeof (char *));
1148 /* A set of simple-minded routines to store strings in a linked list.
1149 This used to also be used for searching, but now we have hash
1152 /* It's a shame that these simple things like linked lists and hash
1153 tables (see hash.c) need to be implemented over and over again. It
1154 would be nice to be able to use the routines from glib -- see
1155 www.gtk.org for details. However, that would make Wget depend on
1156 glib, and I want to avoid dependencies to external libraries for
1157 reasons of convenience and portability (I suspect Wget is more
1158 portable than anything ever written for Gnome). */
1160 /* Append an element to the list. If the list has a huge number of
1161 elements, this can get slow because it has to find the list's
1162 ending. If you think you have to call slist_append in a loop,
1163 think about calling slist_prepend() followed by slist_nreverse(). */
1166 slist_append (slist *l, const char *s)
1168 slist *newel = (slist *)xmalloc (sizeof (slist));
1171 newel->string = xstrdup (s);
1176 /* Find the last element. */
1183 /* Prepend S to the list. Unlike slist_append(), this is O(1). */
1186 slist_prepend (slist *l, const char *s)
1188 slist *newel = (slist *)xmalloc (sizeof (slist));
1189 newel->string = xstrdup (s);
1194 /* Destructively reverse L. */
1197 slist_nreverse (slist *l)
1202 slist *next = l->next;
1210 /* Is there a specific entry in the list? */
1212 slist_contains (slist *l, const char *s)
1214 for (; l; l = l->next)
1215 if (!strcmp (l->string, s))
1220 /* Free the whole slist. */
1222 slist_free (slist *l)
1233 /* Sometimes it's useful to create "sets" of strings, i.e. special
1234 hash tables where you want to store strings as keys and merely
1235 query for their existence. Here is a set of utility routines that
1236 makes that transparent. */
1239 string_set_add (struct hash_table *ht, const char *s)
1241 /* First check whether the set element already exists. If it does,
1242 do nothing so that we don't have to free() the old element and
1243 then strdup() a new one. */
1244 if (hash_table_contains (ht, s))
1247 /* We use "1" as value. It provides us a useful and clear arbitrary
1248 value, and it consumes no memory -- the pointers to the same
1249 string "1" will be shared by all the key-value pairs in all `set'
1251 hash_table_put (ht, xstrdup (s), "1");
1254 /* Synonym for hash_table_contains... */
1257 string_set_contains (struct hash_table *ht, const char *s)
1259 return hash_table_contains (ht, s);
1263 string_set_free_mapper (void *key, void *value_ignored, void *arg_ignored)
1270 string_set_free (struct hash_table *ht)
1272 hash_table_map (ht, string_set_free_mapper, NULL);
1273 hash_table_destroy (ht);
1277 free_keys_and_values_mapper (void *key, void *value, void *arg_ignored)
1284 /* Another utility function: call free() on all keys and values of HT. */
1287 free_keys_and_values (struct hash_table *ht)
1289 hash_table_map (ht, free_keys_and_values_mapper, NULL);
1293 /* Engine for legible and legible_very_long; this function works on
1297 legible_1 (const char *repr)
1299 static char outbuf[128];
1304 /* Reset the pointers. */
1307 /* If the number is negative, shift the pointers. */
1313 /* How many digits before the first separator? */
1314 mod = strlen (inptr) % 3;
1316 for (i = 0; i < mod; i++)
1317 *outptr++ = inptr[i];
1318 /* Now insert the rest of them, putting separator before every
1320 for (i1 = i, i = 0; inptr[i1]; i++, i1++)
1322 if (i % 3 == 0 && i1 != 0)
1324 *outptr++ = inptr[i1];
1326 /* Zero-terminate the string. */
1331 /* Legible -- return a static pointer to the legibly printed long. */
1336 /* Print the number into the buffer. */
1337 number_to_string (inbuf, l);
1338 return legible_1 (inbuf);
1341 /* Write a string representation of NUMBER into the provided buffer.
1342 We cannot use sprintf() because we cannot be sure whether the
1343 platform supports printing of what we chose for VERY_LONG_TYPE.
1345 Example: Gcc supports `long long' under many platforms, but on many
1346 of those the native libc knows nothing of it and therefore cannot
1349 How long BUFFER needs to be depends on the platform and the content
1350 of NUMBER. For 64-bit VERY_LONG_TYPE (the most common case), 24
1351 bytes are sufficient. Using more might be a good idea.
1353 This function does not go through the hoops that long_to_string
1354 goes to because it doesn't aspire to be fast. (It's called perhaps
1355 once in a Wget run.) */
1358 very_long_to_string (char *buffer, VERY_LONG_TYPE number)
1363 /* Print the number backwards... */
1366 buffer[i++] = '0' + number % 10;
1371 /* ...and reverse the order of the digits. */
1372 for (j = 0; j < i / 2; j++)
1375 buffer[j] = buffer[i - 1 - j];
1376 buffer[i - 1 - j] = c;
1381 /* The same as legible(), but works on VERY_LONG_TYPE. See sysdep.h. */
1383 legible_very_long (VERY_LONG_TYPE l)
1386 /* Print the number into the buffer. */
1387 very_long_to_string (inbuf, l);
1388 return legible_1 (inbuf);
1391 /* Count the digits in a (long) integer. */
1393 numdigit (long number)
1401 while ((number /= 10) > 0)
1406 /* A half-assed implementation of INT_MAX on machines that don't
1407 bother to define one. */
1409 # define INT_MAX ((int) ~((unsigned)1 << 8 * sizeof (int) - 1))
1412 #define ONE_DIGIT(figure) *p++ = n / (figure) + '0'
1413 #define ONE_DIGIT_ADVANCE(figure) (ONE_DIGIT (figure), n %= (figure))
1415 #define DIGITS_1(figure) ONE_DIGIT (figure)
1416 #define DIGITS_2(figure) ONE_DIGIT_ADVANCE (figure); DIGITS_1 ((figure) / 10)
1417 #define DIGITS_3(figure) ONE_DIGIT_ADVANCE (figure); DIGITS_2 ((figure) / 10)
1418 #define DIGITS_4(figure) ONE_DIGIT_ADVANCE (figure); DIGITS_3 ((figure) / 10)
1419 #define DIGITS_5(figure) ONE_DIGIT_ADVANCE (figure); DIGITS_4 ((figure) / 10)
1420 #define DIGITS_6(figure) ONE_DIGIT_ADVANCE (figure); DIGITS_5 ((figure) / 10)
1421 #define DIGITS_7(figure) ONE_DIGIT_ADVANCE (figure); DIGITS_6 ((figure) / 10)
1422 #define DIGITS_8(figure) ONE_DIGIT_ADVANCE (figure); DIGITS_7 ((figure) / 10)
1423 #define DIGITS_9(figure) ONE_DIGIT_ADVANCE (figure); DIGITS_8 ((figure) / 10)
1424 #define DIGITS_10(figure) ONE_DIGIT_ADVANCE (figure); DIGITS_9 ((figure) / 10)
1426 /* DIGITS_<11-20> are only used on machines with 64-bit longs. */
1428 #define DIGITS_11(figure) ONE_DIGIT_ADVANCE (figure); DIGITS_10 ((figure) / 10)
1429 #define DIGITS_12(figure) ONE_DIGIT_ADVANCE (figure); DIGITS_11 ((figure) / 10)
1430 #define DIGITS_13(figure) ONE_DIGIT_ADVANCE (figure); DIGITS_12 ((figure) / 10)
1431 #define DIGITS_14(figure) ONE_DIGIT_ADVANCE (figure); DIGITS_13 ((figure) / 10)
1432 #define DIGITS_15(figure) ONE_DIGIT_ADVANCE (figure); DIGITS_14 ((figure) / 10)
1433 #define DIGITS_16(figure) ONE_DIGIT_ADVANCE (figure); DIGITS_15 ((figure) / 10)
1434 #define DIGITS_17(figure) ONE_DIGIT_ADVANCE (figure); DIGITS_16 ((figure) / 10)
1435 #define DIGITS_18(figure) ONE_DIGIT_ADVANCE (figure); DIGITS_17 ((figure) / 10)
1436 #define DIGITS_19(figure) ONE_DIGIT_ADVANCE (figure); DIGITS_18 ((figure) / 10)
1438 /* Print NUMBER to BUFFER in base 10. This should be completely
1439 equivalent to `sprintf(buffer, "%ld", number)', only much faster.
1441 The speedup may make a difference in programs that frequently
1442 convert numbers to strings. Some implementations of sprintf,
1443 particularly the one in GNU libc, have been known to be extremely
1444 slow compared to this function.
1446 Return the pointer to the location where the terminating zero was
1447 printed. (Equivalent to calling buffer+strlen(buffer) after the
1450 BUFFER should be big enough to accept as many bytes as you expect
1451 the number to take up. On machines with 64-bit longs the maximum
1452 needed size is 24 bytes. That includes the digits needed for the
1453 largest 64-bit number, the `-' sign in case it's negative, and the
1454 terminating '\0'. */
1457 number_to_string (char *buffer, long number)
1462 #if (SIZEOF_LONG != 4) && (SIZEOF_LONG != 8)
1463 /* We are running in a strange or misconfigured environment. Let
1464 sprintf cope with it. */
1465 sprintf (buffer, "%ld", n);
1466 p += strlen (buffer);
1467 #else /* (SIZEOF_LONG == 4) || (SIZEOF_LONG == 8) */
1473 /* We cannot print a '-' and assign -n to n because -n would
1474 overflow. Let sprintf deal with this border case. */
1475 sprintf (buffer, "%ld", n);
1476 p += strlen (buffer);
1484 if (n < 10) { DIGITS_1 (1); }
1485 else if (n < 100) { DIGITS_2 (10); }
1486 else if (n < 1000) { DIGITS_3 (100); }
1487 else if (n < 10000) { DIGITS_4 (1000); }
1488 else if (n < 100000) { DIGITS_5 (10000); }
1489 else if (n < 1000000) { DIGITS_6 (100000); }
1490 else if (n < 10000000) { DIGITS_7 (1000000); }
1491 else if (n < 100000000) { DIGITS_8 (10000000); }
1492 else if (n < 1000000000) { DIGITS_9 (100000000); }
1493 #if SIZEOF_LONG == 4
1494 /* ``if (1)'' serves only to preserve editor indentation. */
1495 else if (1) { DIGITS_10 (1000000000); }
1496 #else /* SIZEOF_LONG != 4 */
1497 else if (n < 10000000000L) { DIGITS_10 (1000000000L); }
1498 else if (n < 100000000000L) { DIGITS_11 (10000000000L); }
1499 else if (n < 1000000000000L) { DIGITS_12 (100000000000L); }
1500 else if (n < 10000000000000L) { DIGITS_13 (1000000000000L); }
1501 else if (n < 100000000000000L) { DIGITS_14 (10000000000000L); }
1502 else if (n < 1000000000000000L) { DIGITS_15 (100000000000000L); }
1503 else if (n < 10000000000000000L) { DIGITS_16 (1000000000000000L); }
1504 else if (n < 100000000000000000L) { DIGITS_17 (10000000000000000L); }
1505 else if (n < 1000000000000000000L) { DIGITS_18 (100000000000000000L); }
1506 else { DIGITS_19 (1000000000000000000L); }
1507 #endif /* SIZEOF_LONG != 4 */
1510 #endif /* (SIZEOF_LONG == 4) || (SIZEOF_LONG == 8) */
1516 #undef ONE_DIGIT_ADVANCE
1538 /* Support for timers. */
1540 #undef TIMER_WINDOWS
1541 #undef TIMER_GETTIMEOFDAY
1544 /* Depending on the OS and availability of gettimeofday(), one and
1545 only one of the above constants will be defined. Virtually all
1546 modern Unix systems will define TIMER_GETTIMEOFDAY; Windows will
1547 use TIMER_WINDOWS. TIMER_TIME is a catch-all method for
1548 non-Windows systems without gettimeofday.
1550 #### Perhaps we should also support ftime(), which exists on old
1551 BSD 4.2-influenced systems? (It also existed under MS DOS Borland
1552 C, if memory serves me.) */
1555 # define TIMER_WINDOWS
1556 #else /* not WINDOWS */
1557 # ifdef HAVE_GETTIMEOFDAY
1558 # define TIMER_GETTIMEOFDAY
1562 #endif /* not WINDOWS */
1564 #ifdef TIMER_GETTIMEOFDAY
1565 typedef struct timeval wget_sys_time;
1569 typedef time_t wget_sys_time;
1572 #ifdef TIMER_WINDOWS
1573 typedef ULARGE_INTEGER wget_sys_time;
1577 /* The starting point in time which, subtracted from the current
1578 time, yields elapsed time. */
1579 wget_sys_time start;
1581 /* The most recent elapsed time, calculated by wtimer_elapsed().
1582 Measured in milliseconds. */
1583 double elapsed_last;
1585 /* Approximately, the time elapsed between the true start of the
1586 measurement and the time represented by START. */
1587 double elapsed_pre_start;
1590 /* Allocate a timer. It is not legal to do anything with a freshly
1591 allocated timer, except call wtimer_reset() or wtimer_delete(). */
1594 wtimer_allocate (void)
1596 struct wget_timer *wt =
1597 (struct wget_timer *)xmalloc (sizeof (struct wget_timer));
1601 /* Allocate a new timer and reset it. Return the new timer. */
1606 struct wget_timer *wt = wtimer_allocate ();
1611 /* Free the resources associated with the timer. Its further use is
1615 wtimer_delete (struct wget_timer *wt)
1620 /* Store system time to WST. */
1623 wtimer_sys_set (wget_sys_time *wst)
1625 #ifdef TIMER_GETTIMEOFDAY
1626 gettimeofday (wst, NULL);
1633 #ifdef TIMER_WINDOWS
1634 /* We use GetSystemTime to get the elapsed time. MSDN warns that
1635 system clock adjustments can skew the output of GetSystemTime
1636 when used as a timer and gives preference to GetTickCount and
1637 high-resolution timers. But GetTickCount can overflow, and hires
1638 timers are typically used for profiling, not for regular time
1639 measurement. Since we handle clock skew anyway, we just use
1643 GetSystemTime (&st);
1645 /* As recommended by MSDN, we convert SYSTEMTIME to FILETIME, copy
1646 FILETIME to ULARGE_INTEGER, and use regular 64-bit integer
1647 arithmetic on that. */
1648 SystemTimeToFileTime (&st, &ft);
1649 wst->HighPart = ft.dwHighDateTime;
1650 wst->LowPart = ft.dwLowDateTime;
1654 /* Reset timer WT. This establishes the starting point from which
1655 wtimer_elapsed() will return the number of elapsed
1656 milliseconds. It is allowed to reset a previously used timer. */
1659 wtimer_reset (struct wget_timer *wt)
1661 /* Set the start time to the current time. */
1662 wtimer_sys_set (&wt->start);
1663 wt->elapsed_last = 0;
1664 wt->elapsed_pre_start = 0;
1668 wtimer_sys_diff (wget_sys_time *wst1, wget_sys_time *wst2)
1670 #ifdef TIMER_GETTIMEOFDAY
1671 return ((double)(wst1->tv_sec - wst2->tv_sec) * 1000
1672 + (double)(wst1->tv_usec - wst2->tv_usec) / 1000);
1676 return 1000 * (*wst1 - *wst2);
1680 /* VC++ 6 doesn't support direct cast of uint64 to double. To work
1681 around this, we subtract, then convert to signed, then finally to
1683 return (double)(signed __int64)(wst1->QuadPart - wst2->QuadPart) / 10000;
1687 /* Return the number of milliseconds elapsed since the timer was last
1688 reset. It is allowed to call this function more than once to get
1689 increasingly higher elapsed values. These timers handle clock
1693 wtimer_elapsed (struct wget_timer *wt)
1698 wtimer_sys_set (&now);
1699 elapsed = wt->elapsed_pre_start + wtimer_sys_diff (&now, &wt->start);
1701 /* Ideally we'd just return the difference between NOW and
1702 wt->start. However, the system timer can be set back, and we
1703 could return a value smaller than when we were last called, even
1704 a negative value. Both of these would confuse the callers, which
1705 expect us to return monotonically nondecreasing values.
1707 Therefore: if ELAPSED is smaller than its previous known value,
1708 we reset wt->start to the current time and effectively start
1709 measuring from this point. But since we don't want the elapsed
1710 value to start from zero, we set elapsed_pre_start to the last
1711 elapsed time and increment all future calculations by that
1714 if (elapsed < wt->elapsed_last)
1717 wt->elapsed_pre_start = wt->elapsed_last;
1718 elapsed = wt->elapsed_last;
1721 wt->elapsed_last = elapsed;
1725 /* Return the assessed granularity of the timer implementation, in
1726 milliseconds. This is used by code that tries to substitute a
1727 better value for timers that have returned zero. */
1730 wtimer_granularity (void)
1732 #ifdef TIMER_GETTIMEOFDAY
1733 /* Granularity of gettimeofday varies wildly between architectures.
1734 However, it appears that on modern machines it tends to be better
1735 than 1ms. Assume 100 usecs. (Perhaps the configure process
1736 could actually measure this?) */
1744 #ifdef TIMER_WINDOWS
1745 /* According to MSDN, GetSystemTime returns a broken-down time
1746 structure the smallest member of which are milliseconds. */
1751 /* This should probably be at a better place, but it doesn't really
1752 fit into html-parse.c. */
1754 /* The function returns the pointer to the malloc-ed quoted version of
1755 string s. It will recognize and quote numeric and special graphic
1756 entities, as per RFC1866:
1764 No other entities are recognized or replaced. */
1766 html_quote_string (const char *s)
1772 /* Pass through the string, and count the new size. */
1773 for (i = 0; *s; s++, i++)
1776 i += 4; /* `amp;' */
1777 else if (*s == '<' || *s == '>')
1778 i += 3; /* `lt;' and `gt;' */
1779 else if (*s == '\"')
1780 i += 5; /* `quot;' */
1784 res = (char *)xmalloc (i + 1);
1786 for (p = res; *s; s++)
1799 *p++ = (*s == '<' ? 'l' : 'g');
1826 /* Determine the width of the terminal we're running on. If that's
1827 not possible, return 0. */
1830 determine_screen_width (void)
1832 /* If there's a way to get the terminal size using POSIX
1833 tcgetattr(), somebody please tell me. */
1836 #else /* TIOCGWINSZ */
1840 if (opt.lfilename != NULL)
1843 fd = fileno (stderr);
1844 if (ioctl (fd, TIOCGWINSZ, &wsz) < 0)
1845 return 0; /* most likely ENOTTY */
1848 #endif /* TIOCGWINSZ */
1851 /* Return a random number between 0 and MAX-1, inclusive.
1853 If MAX is greater than the value of RAND_MAX+1 on the system, the
1854 returned value will be in the range [0, RAND_MAX]. This may be
1855 fixed in a future release.
1857 The random number generator is seeded automatically the first time
1860 This uses rand() for portability. It has been suggested that
1861 random() offers better randomness, but this is not required for
1862 Wget, so I chose to go for simplicity and use rand
1865 DO NOT use this for cryptographic purposes. It is only meant to be
1866 used in situations where quality of the random numbers returned
1867 doesn't really matter. */
1870 random_number (int max)
1878 srand (time (NULL));
1883 /* On systems that don't define RAND_MAX, assume it to be 2**15 - 1,
1884 and enforce that assumption by masking other bits. */
1886 # define RAND_MAX 32767
1890 /* This is equivalent to rand() % max, but uses the high-order bits
1891 for better randomness on architecture where rand() is implemented
1892 using a simple congruential generator. */
1894 bounded = (double)max * rnd / (RAND_MAX + 1.0);
1895 return (int)bounded;
1898 /* Return a random uniformly distributed floating point number in the
1899 [0, 1) range. The precision of returned numbers is 9 digits.
1901 Modify this to use erand48() where available! */
1906 /* We can't rely on any specific value of RAND_MAX, but I'm pretty
1907 sure it's greater than 1000. */
1908 int rnd1 = random_number (1000);
1909 int rnd2 = random_number (1000);
1910 int rnd3 = random_number (1000);
1911 return rnd1 / 1000.0 + rnd2 / 1000000.0 + rnd3 / 1000000000.0;
1915 /* A debugging function for checking whether an MD5 library works. */
1917 #include "gen-md5.h"
1920 debug_test_md5 (char *buf)
1922 unsigned char raw[16];
1923 static char res[33];
1927 ALLOCA_MD5_CONTEXT (ctx);
1930 gen_md5_update ((unsigned char *)buf, strlen (buf), ctx);
1931 gen_md5_finish (ctx, raw);
1938 *p2++ = XNUM_TO_digit (*p1 >> 4);
1939 *p2++ = XNUM_TO_digit (*p1 & 0xf);
1948 /* Implementation of run_with_timeout, a generic timeout-forcing
1949 routine for systems with Unix-like signal handling. */
1951 #ifdef USE_SIGNAL_TIMEOUT
1952 # ifdef HAVE_SIGSETJMP
1953 # define SETJMP(env) sigsetjmp (env, 1)
1955 static sigjmp_buf run_with_timeout_env;
1958 abort_run_with_timeout (int sig)
1960 assert (sig == SIGALRM);
1961 siglongjmp (run_with_timeout_env, -1);
1963 # else /* not HAVE_SIGSETJMP */
1964 # define SETJMP(env) setjmp (env)
1966 static jmp_buf run_with_timeout_env;
1969 abort_run_with_timeout (int sig)
1971 assert (sig == SIGALRM);
1972 /* We don't have siglongjmp to preserve the set of blocked signals;
1973 if we longjumped out of the handler at this point, SIGALRM would
1974 remain blocked. We must unblock it manually. */
1975 int mask = siggetmask ();
1976 mask &= ~sigmask (SIGALRM);
1979 /* Now it's safe to longjump. */
1980 longjmp (run_with_timeout_env, -1);
1982 # endif /* not HAVE_SIGSETJMP */
1984 /* Arrange for SIGALRM to be delivered in TIMEOUT seconds. This uses
1985 setitimer where available, alarm otherwise.
1987 TIMEOUT should be non-zero. If the timeout value is so small that
1988 it would be rounded to zero, it is rounded to the least legal value
1989 instead (1us for setitimer, 1s for alarm). That ensures that
1990 SIGALRM will be delivered in all cases. */
1993 alarm_set (double timeout)
1996 /* Use the modern itimer interface. */
1997 struct itimerval itv;
1998 memset (&itv, 0, sizeof (itv));
1999 itv.it_value.tv_sec = (long) timeout;
2000 itv.it_value.tv_usec = 1000000L * (timeout - (long)timeout);
2001 if (itv.it_value.tv_sec == 0 && itv.it_value.tv_usec == 0)
2002 /* Ensure that we wait for at least the minimum interval.
2003 Specifying zero would mean "wait forever". */
2004 itv.it_value.tv_usec = 1;
2005 setitimer (ITIMER_REAL, &itv, NULL);
2006 #else /* not ITIMER_REAL */
2007 /* Use the old alarm() interface. */
2008 int secs = (int) timeout;
2010 /* Round TIMEOUTs smaller than 1 to 1, not to zero. This is
2011 because alarm(0) means "never deliver the alarm", i.e. "wait
2012 forever", which is not what someone who specifies a 0.5s
2013 timeout would expect. */
2016 #endif /* not ITIMER_REAL */
2019 /* Cancel the alarm set with alarm_set. */
2025 struct itimerval disable;
2026 memset (&disable, 0, sizeof (disable));
2027 setitimer (ITIMER_REAL, &disable, NULL);
2028 #else /* not ITIMER_REAL */
2030 #endif /* not ITIMER_REAL */
2033 /* Call FUN(ARG), but don't allow it to run for more than TIMEOUT
2034 seconds. Returns non-zero if the function was interrupted with a
2035 timeout, zero otherwise.
2037 This works by setting up SIGALRM to be delivered in TIMEOUT seconds
2038 using setitimer() or alarm(). The timeout is enforced by
2039 longjumping out of the SIGALRM handler. This has several
2040 advantages compared to the traditional approach of relying on
2041 signals causing system calls to exit with EINTR:
2043 * The callback function is *forcibly* interrupted after the
2044 timeout expires, (almost) regardless of what it was doing and
2045 whether it was in a syscall. For example, a calculation that
2046 takes a long time is interrupted as reliably as an IO
2049 * It works with both SYSV and BSD signals because it doesn't
2050 depend on the default setting of SA_RESTART.
2052 * It doesn't special handler setup beyond a simple call to
2053 signal(). (It does use sigsetjmp/siglongjmp, but they're
2056 The only downside is that, if FUN allocates internal resources that
2057 are normally freed prior to exit from the functions, they will be
2058 lost in case of timeout. */
2061 run_with_timeout (double timeout, void (*fun) (void *), void *arg)
2071 signal (SIGALRM, abort_run_with_timeout);
2072 if (SETJMP (run_with_timeout_env) != 0)
2074 /* Longjumped out of FUN with a timeout. */
2075 signal (SIGALRM, SIG_DFL);
2078 alarm_set (timeout);
2081 /* Preserve errno in case alarm() or signal() modifies it. */
2082 saved_errno = errno;
2084 signal (SIGALRM, SIG_DFL);
2085 errno = saved_errno;
2090 #else /* not USE_SIGNAL_TIMEOUT */
2093 /* A stub version of run_with_timeout that just calls FUN(ARG). Don't
2094 define it under Windows, because Windows has its own version of
2095 run_with_timeout that uses threads. */
2098 run_with_timeout (double timeout, void (*fun) (void *), void *arg)
2103 #endif /* not WINDOWS */
2104 #endif /* not USE_SIGNAL_TIMEOUT */