1 const char miscutil_rcs[] = "$Id: miscutil.c,v 1.77 2012/07/23 12:41:59 fabiankeil Exp $";
2 /*********************************************************************
4 * File : $Source: /cvsroot/ijbswa/current/miscutil.c,v $
6 * Purpose : zalloc, hash_string, strcmpic, strncmpic, and
7 * MinGW32 strdup functions. These are each too small
8 * to deserve their own file but don't really fit in
11 * Copyright : Written by and Copyright (C) 2001-2012 the
12 * Privoxy team. http://www.privoxy.org/
14 * Based on the Internet Junkbuster originally written
15 * by and Copyright (C) 1997 Anonymous Coders and
16 * Junkbusters Corporation. http://www.junkbusters.com
18 * The timegm replacement function was taken from GnuPG,
19 * Copyright (C) 2004 Free Software Foundation, Inc.
21 * The snprintf replacement function is written by
22 * Mark Martinec who also holds the copyright. It can be
23 * used under the terms of the GPL or the terms of the
24 * "Frontier Artistic License".
26 * This program is free software; you can redistribute it
27 * and/or modify it under the terms of the GNU General
28 * Public License as published by the Free Software
29 * Foundation; either version 2 of the License, or (at
30 * your option) any later version.
32 * This program is distributed in the hope that it will
33 * be useful, but WITHOUT ANY WARRANTY; without even the
34 * implied warranty of MERCHANTABILITY or FITNESS FOR A
35 * PARTICULAR PURPOSE. See the GNU General Public
36 * License for more details.
38 * The GNU General Public License should be included with
39 * this file. If not, you can view it at
40 * http://www.gnu.org/copyleft/gpl.html
41 * or write to the Free Software Foundation, Inc., 59
42 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
44 *********************************************************************/
50 #include <sys/types.h>
52 #if !defined(_WIN32) && !defined(__OS2__)
54 #endif /* #if !defined(_WIN32) && !defined(__OS2__) */
59 #if !defined(HAVE_TIMEGM) && defined(HAVE_TZSET) && defined(HAVE_PUTENV)
61 #endif /* !defined(HAVE_TIMEGM) && defined(HAVE_TZSET) && defined(HAVE_PUTENV) */
68 const char miscutil_h_rcs[] = MISCUTIL_H_VERSION;
70 /*********************************************************************
74 * Description : Malloc some memory and set it to '\0'.
77 * 1 : size = Size of memory chunk to return.
79 * Returns : Pointer to newly malloc'd memory chunk.
81 *********************************************************************/
82 void *zalloc(size_t size)
86 if ((ret = (void *)malloc(size)) != NULL)
96 /*********************************************************************
98 * Function : strdup_or_die
100 * Description : strdup wrapper that either succeeds or causes
101 * program termination.
103 * Useful in situations were the string length is
104 * "small" and strdup() failures couldn't be handled
105 * better anyway. In case of debug builds, failures
106 * trigger an assert().
109 * 1 : str = String to duplicate
111 * Returns : Pointer to newly strdup'd copy of the string.
113 *********************************************************************/
114 char *strdup_or_die(const char *str)
118 new_str = strdup(str);
122 assert(new_str != NULL);
123 log_error(LOG_LEVEL_FATAL, "Out of memory in strdup_or_die().");
132 /*********************************************************************
134 * Function : malloc_or_die
136 * Description : malloc wrapper that either succeeds or causes
137 * program termination.
139 * Useful in situations were the buffer size is "small"
140 * and malloc() failures couldn't be handled better
141 * anyway. In case of debug builds, failures trigger
145 * 1 : buffer_size = Size of the space to allocate
147 * Returns : Pointer to newly malloc'd memory
149 *********************************************************************/
150 void *malloc_or_die(size_t buffer_size)
154 new_buf = malloc(buffer_size);
158 assert(new_buf != NULL);
159 log_error(LOG_LEVEL_FATAL, "Out of memory in malloc_or_die().");
169 /*********************************************************************
171 * Function : write_pid_file
173 * Description : Writes a pid file with the pid of the main process
179 *********************************************************************/
180 void write_pid_file(void)
185 * If no --pidfile option was given,
186 * we can live without one.
188 if (pidfile == NULL) return;
190 if ((fp = fopen(pidfile, "w")) == NULL)
192 log_error(LOG_LEVEL_INFO, "can't open pidfile '%s': %E", pidfile);
196 fprintf(fp, "%u\n", (unsigned int) getpid());
202 #endif /* def unix */
205 /*********************************************************************
207 * Function : hash_string
209 * Description : Take a string and compute a (hopefuly) unique numeric
210 * integer value. This is useful to "switch" a string.
213 * 1 : s : string to be hashed.
215 * Returns : The string's hash
217 *********************************************************************/
218 unsigned int hash_string(const char* s)
224 h = 5 * h + (unsigned int)*s;
232 /*********************************************************************
234 * Function : strcmpic
236 * Description : Case insensitive string comparison
239 * 1 : s1 = string 1 to compare
240 * 2 : s2 = string 2 to compare
242 * Returns : 0 if s1==s2, Negative if s1<s2, Positive if s1>s2
244 *********************************************************************/
245 int strcmpic(const char *s1, const char *s2)
252 if ((*s1 != *s2) && (privoxy_tolower(*s1) != privoxy_tolower(*s2)))
258 return(privoxy_tolower(*s1) - privoxy_tolower(*s2));
263 /*********************************************************************
265 * Function : strncmpic
267 * Description : Case insensitive string comparison (up to n characters)
270 * 1 : s1 = string 1 to compare
271 * 2 : s2 = string 2 to compare
272 * 3 : n = maximum characters to compare
274 * Returns : 0 if s1==s2, Negative if s1<s2, Positive if s1>s2
276 *********************************************************************/
277 int strncmpic(const char *s1, const char *s2, size_t n)
279 if (n <= (size_t)0) return(0);
285 if ((*s1 != *s2) && (privoxy_tolower(*s1) != privoxy_tolower(*s2)))
290 if (--n <= (size_t)0) break;
294 return(privoxy_tolower(*s1) - privoxy_tolower(*s2));
299 /*********************************************************************
303 * Description : In-situ-eliminate all leading and trailing whitespace
307 * 1 : s : string to be chomped.
309 * Returns : chomped string
311 *********************************************************************/
312 char *chomp(char *string)
317 * strip trailing whitespace
319 p = string + strlen(string);
320 while (p > string && privoxy_isspace(*(p-1)))
327 * find end of leading whitespace
330 while (*q && privoxy_isspace(*q))
336 * if there was any, move the rest forwards
351 /*********************************************************************
353 * Function : string_append
355 * Description : Reallocate target_string and append text to it.
356 * This makes it easier to append to malloc'd strings.
357 * This is similar to the (removed) strsav(), but
358 * running out of memory isn't catastrophic.
362 * The following style provides sufficient error
363 * checking for this routine, with minimal clutter
364 * in the source code. It is recommended if you
365 * have many calls to this function:
367 * char * s = strdup(...); // don't check for error
368 * string_append(&s, ...); // don't check for error
369 * string_append(&s, ...); // don't check for error
370 * string_append(&s, ...); // don't check for error
371 * if (NULL == s) { ... handle error ... }
375 * char * s = strdup(...); // don't check for error
376 * string_append(&s, ...); // don't check for error
377 * string_append(&s, ...); // don't check for error
378 * if (string_append(&s, ...)) {... handle error ...}
381 * 1 : target_string = Pointer to old text that is to be
382 * extended. *target_string will be free()d by this
383 * routine. target_string must be non-NULL.
384 * If *target_string is NULL, this routine will
385 * do nothing and return with an error - this allows
386 * you to make many calls to this routine and only
387 * check for errors after the last one.
388 * 2 : text_to_append = Text to be appended to old.
391 * Returns : JB_ERR_OK on success, and sets *target_string
392 * to newly malloc'ed appended string. Caller
393 * must free(*target_string).
394 * JB_ERR_MEMORY on out-of-memory. (And free()s
395 * *target_string and sets it to NULL).
396 * JB_ERR_MEMORY if *target_string is NULL.
398 *********************************************************************/
399 jb_err string_append(char **target_string, const char *text_to_append)
405 assert(target_string);
406 assert(text_to_append);
408 if (*target_string == NULL)
410 return JB_ERR_MEMORY;
413 if (*text_to_append == '\0')
418 old_len = strlen(*target_string);
420 new_size = strlen(text_to_append) + old_len + 1;
422 if (NULL == (new_string = realloc(*target_string, new_size)))
424 free(*target_string);
426 *target_string = NULL;
427 return JB_ERR_MEMORY;
430 strlcpy(new_string + old_len, text_to_append, new_size - old_len);
432 *target_string = new_string;
437 /*********************************************************************
439 * Function : string_join
441 * Description : Join two strings together. Frees BOTH the original
442 * strings. If either or both input strings are NULL,
443 * fails as if it had run out of memory.
445 * For comparison, string_append requires that the
446 * second string is non-NULL, and doesn't free it.
448 * Rationale: Too often, we want to do
449 * string_append(s, html_encode(s2)). That assert()s
450 * if s2 is NULL or if html_encode() runs out of memory.
451 * It also leaks memory. Proper checking is cumbersome.
452 * The solution: string_join(s, html_encode(s2)) is safe,
453 * and will free the memory allocated by html_encode().
456 * 1 : target_string = Pointer to old text that is to be
457 * extended. *target_string will be free()d by this
458 * routine. target_string must be non-NULL.
459 * 2 : text_to_append = Text to be appended to old.
461 * Returns : JB_ERR_OK on success, and sets *target_string
462 * to newly malloc'ed appended string. Caller
463 * must free(*target_string).
464 * JB_ERR_MEMORY on out-of-memory, or if
465 * *target_string or text_to_append is NULL. (In
466 * this case, frees *target_string and text_to_append,
467 * sets *target_string to NULL).
469 *********************************************************************/
470 jb_err string_join(char **target_string, char *text_to_append)
474 assert(target_string);
476 if (text_to_append == NULL)
478 freez(*target_string);
479 return JB_ERR_MEMORY;
482 err = string_append(target_string, text_to_append);
484 freez(text_to_append);
490 /*********************************************************************
492 * Function : string_toupper
494 * Description : Produce a copy of string with all convertible
495 * characters converted to uppercase.
498 * 1 : string = string to convert
500 * Returns : Uppercase copy of string if possible,
501 * NULL on out-of-memory or if string was NULL.
503 *********************************************************************/
504 char *string_toupper(const char *string)
509 if (!string || ((result = (char *) zalloc(strlen(string) + 1)) == NULL))
519 *p++ = (char)toupper((int) *q++);
527 /*********************************************************************
529 * Function : string_move
531 * Description : memmove wrapper to move the last part of a string
532 * towards the beginning, overwriting the part in
533 * the middle. strlcpy() can't be used here as the
537 * 1 : dst = Destination to overwrite
538 * 2 : src = Source to move.
542 *********************************************************************/
543 void string_move(char *dst, char *src)
547 /* +1 to copy the terminating nul as well. */
548 memmove(dst, src, strlen(src)+1);
552 /*********************************************************************
556 * Description : Duplicate the first n characters of a string that may
557 * contain '\0' characters.
560 * 1 : string = string to be duplicated
561 * 2 : len = number of bytes to duplicate
563 * Returns : pointer to copy, or NULL if failiure
565 *********************************************************************/
566 char *bindup(const char *string, size_t len)
570 duplicate = (char *)malloc(len);
571 if (NULL != duplicate)
573 memcpy(duplicate, string, len);
581 /*********************************************************************
583 * Function : make_path
585 * Description : Takes a directory name and a file name, returns
586 * the complete path. Handles windows/unix differences.
587 * If the file name is already an absolute path, or if
588 * the directory name is NULL or empty, it returns
592 * 1 : dir: Name of directory or NULL for none.
593 * 2 : file: Name of file. Should not be NULL or empty.
595 * Returns : "dir/file" (Or on windows, "dir\file").
596 * It allocates the string on the heap. Caller frees.
597 * Returns NULL in error (i.e. NULL file or out of
600 *********************************************************************/
601 char * make_path(const char * dir, const char * file)
612 strncpy(path,dir+2,512);
616 strncpy(path,dir+1,512);
621 strncpy(path,dir,512);
629 if (AddPart(path,file,512))
637 #else /* ndef AMIGA */
639 if ((file == NULL) || (*file == '\0'))
641 return NULL; /* Error */
644 if ((dir == NULL) || (*dir == '\0') /* No directory specified */
645 #if defined(_WIN32) || defined(__OS2__)
646 || (*file == '\\') || (file[1] == ':') /* Absolute path (DOS) */
647 #else /* ifndef _WIN32 || __OS2__ */
648 || (*file == '/') /* Absolute path (U*ix) */
649 #endif /* ifndef _WIN32 || __OS2__ */
657 size_t path_size = strlen(dir) + strlen(file) + 2; /* +2 for trailing (back)slash and \0 */
660 if (*dir != '/' && basedir && *basedir)
663 * Relative path, so start with the base directory.
665 path_size += strlen(basedir) + 1; /* +1 for the slash */
666 path = malloc(path_size);
667 if (!path) log_error(LOG_LEVEL_FATAL, "malloc failed!");
668 strlcpy(path, basedir, path_size);
669 strlcat(path, "/", path_size);
670 strlcat(path, dir, path_size);
673 #endif /* defined unix */
675 path = malloc(path_size);
676 if (!path) log_error(LOG_LEVEL_FATAL, "malloc failed!");
677 strlcpy(path, dir, path_size);
680 assert(NULL != path);
681 #if defined(_WIN32) || defined(__OS2__)
682 if (path[strlen(path)-1] != '\\')
684 strlcat(path, "\\", path_size);
686 #else /* ifndef _WIN32 || __OS2__ */
687 if (path[strlen(path)-1] != '/')
689 strlcat(path, "/", path_size);
691 #endif /* ifndef _WIN32 || __OS2__ */
692 strlcat(path, file, path_size);
696 #endif /* ndef AMIGA */
700 /*********************************************************************
702 * Function : pick_from_range
704 * Description : Pick a positive number out of a given range.
705 * Should only be used if randomness would be nice,
706 * but isn't really necessary.
709 * 1 : range: Highest possible number to pick.
711 * Returns : Picked number.
713 *********************************************************************/
714 long int pick_from_range(long int range)
718 static unsigned long seed = 0;
719 #endif /* def _WIN32 */
724 if (range <= 0) return 0;
727 number = random() % range + 1;
728 #elif defined(MUTEX_LOCKS_AVAILABLE)
729 privoxy_mutex_lock(&rand_mutex);
733 seed = (unsigned long)(GetCurrentThreadId()+GetTickCount());
736 seed = (unsigned long)((rand() << 16) + rand());
737 #endif /* def _WIN32 */
738 number = (unsigned long)((rand() << 16) + (rand())) % (unsigned long)(range + 1);
739 privoxy_mutex_unlock(&rand_mutex);
742 * XXX: Which platforms reach this and are there
743 * better options than just using rand() and hoping
746 log_error(LOG_LEVEL_INFO, "No thread-safe PRNG available? Header time randomization "
747 "might cause crashes, predictable results or even combine these fine options.");
748 number = rand() % (long int)(range + 1);
750 #endif /* (def HAVE_RANDOM) */
756 #ifdef USE_PRIVOXY_STRLCPY
757 /*********************************************************************
759 * Function : privoxy_strlcpy
761 * Description : strlcpy(3) look-alike for those without decent libc.
764 * 1 : destination: buffer to copy into.
765 * 2 : source: String to copy.
766 * 3 : size: Size of destination buffer.
768 * Returns : The length of the string that privoxy_strlcpy() tried to create.
770 *********************************************************************/
771 size_t privoxy_strlcpy(char *destination, const char *source, const size_t size)
775 snprintf(destination, size, "%s", source);
777 * Platforms that lack strlcpy() also tend to have
778 * a broken snprintf implementation that doesn't
779 * guarantee nul termination.
781 * XXX: the configure script should detect and reject those.
783 destination[size-1] = '\0';
785 return strlen(source);
787 #endif /* def USE_PRIVOXY_STRLCPY */
791 /*********************************************************************
793 * Function : privoxy_strlcat
795 * Description : strlcat(3) look-alike for those without decent libc.
798 * 1 : destination: C string.
799 * 2 : source: String to copy.
800 * 3 : size: Size of destination buffer.
802 * Returns : The length of the string that privoxy_strlcat() tried to create.
804 *********************************************************************/
805 size_t privoxy_strlcat(char *destination, const char *source, const size_t size)
807 const size_t old_length = strlen(destination);
808 return old_length + strlcpy(destination + old_length, source, size - old_length);
810 #endif /* ndef HAVE_STRLCAT */
813 #if !defined(HAVE_TIMEGM) && defined(HAVE_TZSET) && defined(HAVE_PUTENV)
814 /*********************************************************************
818 * Description : libc replacement function for the inverse of gmtime().
819 * Copyright (C) 2004 Free Software Foundation, Inc.
821 * Code originally copied from GnuPG, modifications done
822 * for Privoxy: style changed, #ifdefs for _WIN32 added
823 * to have it work on mingw32.
825 * XXX: It's very unlikely to happen, but if the malloc()
826 * call fails the time zone will be permanently set to UTC.
829 * 1 : tm: Broken-down time struct.
831 * Returns : tm converted into time_t seconds.
833 *********************************************************************/
834 time_t timegm(struct tm *tm)
847 old_zone = malloc(3 + strlen(zone) + 1);
850 strcpy(old_zone, "TZ=");
851 strcat(old_zone, zone);
855 #endif /* def _WIN32 */
862 #elif defined(_WIN32)
872 #endif /* !defined(HAVE_TIMEGM) && defined(HAVE_TZSET) && defined(HAVE_PUTENV) */
875 #ifndef HAVE_SNPRINTF
877 * What follows is a portable snprintf routine, written by Mark Martinec.
878 * See: http://www.ijs.si/software/snprintf/
881 - a portable implementation of snprintf,
882 including vsnprintf.c, asnprintf, vasnprintf, asprintf, vasprintf
884 snprintf is a routine to convert numeric and string arguments to
885 formatted strings. It is similar to sprintf(3) provided in a system's
886 C library, yet it requires an additional argument - the buffer size -
887 and it guarantees never to store anything beyond the given buffer,
888 regardless of the format or arguments to be formatted. Some newer
889 operating systems do provide snprintf in their C library, but many do
890 not or do provide an inadequate (slow or idiosyncratic) version, which
891 calls for a portable implementation of this routine.
895 Mark Martinec <mark.martinec@ijs.si>, April 1999, June 2000
896 Copyright © 1999, Mark Martinec
900 #define PORTABLE_SNPRINTF_VERSION_MAJOR 2
901 #define PORTABLE_SNPRINTF_VERSION_MINOR 2
903 #if defined(NEED_ASPRINTF) || defined(NEED_ASNPRINTF) || defined(NEED_VASPRINTF) || defined(NEED_VASNPRINTF)
904 # if defined(NEED_SNPRINTF_ONLY)
905 # undef NEED_SNPRINTF_ONLY
907 # if !defined(PREFER_PORTABLE_SNPRINTF)
908 # define PREFER_PORTABLE_SNPRINTF
912 #if defined(SOLARIS_BUG_COMPATIBLE) && !defined(SOLARIS_COMPATIBLE)
913 #define SOLARIS_COMPATIBLE
916 #if defined(HPUX_BUG_COMPATIBLE) && !defined(HPUX_COMPATIBLE)
917 #define HPUX_COMPATIBLE
920 #if defined(DIGITAL_UNIX_BUG_COMPATIBLE) && !defined(DIGITAL_UNIX_COMPATIBLE)
921 #define DIGITAL_UNIX_COMPATIBLE
924 #if defined(PERL_BUG_COMPATIBLE) && !defined(PERL_COMPATIBLE)
925 #define PERL_COMPATIBLE
928 #if defined(LINUX_BUG_COMPATIBLE) && !defined(LINUX_COMPATIBLE)
929 #define LINUX_COMPATIBLE
932 #include <sys/types.h>
943 #define isdigit(c) ((c) >= '0' && (c) <= '9')
945 /* For copying strings longer or equal to 'breakeven_point'
946 * it is more efficient to call memcpy() than to do it inline.
947 * The value depends mostly on the processor architecture,
948 * but also on the compiler and its optimization capabilities.
949 * The value is not critical, some small value greater than zero
950 * will be just fine if you don't care to squeeze every drop
951 * of performance out of the code.
953 * Small values favor memcpy, large values favor inline code.
955 #if defined(__alpha__) || defined(__alpha)
956 # define breakeven_point 2 /* AXP (DEC Alpha) - gcc or cc or egcs */
958 #if defined(__i386__) || defined(__i386)
959 # define breakeven_point 12 /* Intel Pentium/Linux - gcc 2.96 */
962 # define breakeven_point 10 /* HP-PA - gcc */
964 #if defined(__sparc__) || defined(__sparc)
965 # define breakeven_point 33 /* Sun Sparc 5 - gcc 2.8.1 */
968 /* some other values of possible interest: */
969 /* #define breakeven_point 8 */ /* VAX 4000 - vaxc */
970 /* #define breakeven_point 19 */ /* VAX 4000 - gcc 2.7.0 */
972 #ifndef breakeven_point
973 # define breakeven_point 6 /* some reasonable one-size-fits-all value */
976 #define fast_memcpy(d,s,n) \
977 { register size_t nn = (size_t)(n); \
978 if (nn >= breakeven_point) memcpy((d), (s), nn); \
979 else if (nn > 0) { /* proc call overhead is worth only for large strings*/\
980 register char *dd; register const char *ss; \
981 for (ss=(s), dd=(d); nn>0; nn--) *dd++ = *ss++; } }
983 #define fast_memset(d,c,n) \
984 { register size_t nn = (size_t)(n); \
985 if (nn >= breakeven_point) memset((d), (int)(c), nn); \
986 else if (nn > 0) { /* proc call overhead is worth only for large strings*/\
987 register char *dd; register const int cc=(int)(c); \
988 for (dd=(d); nn>0; nn--) *dd++ = cc; } }
992 #if defined(NEED_ASPRINTF)
993 int asprintf (char **ptr, const char *fmt, /*args*/ ...);
995 #if defined(NEED_VASPRINTF)
996 int vasprintf (char **ptr, const char *fmt, va_list ap);
998 #if defined(NEED_ASNPRINTF)
999 int asnprintf (char **ptr, size_t str_m, const char *fmt, /*args*/ ...);
1001 #if defined(NEED_VASNPRINTF)
1002 int vasnprintf (char **ptr, size_t str_m, const char *fmt, va_list ap);
1005 #if defined(HAVE_SNPRINTF)
1006 /* declare our portable snprintf routine under name portable_snprintf */
1007 /* declare our portable vsnprintf routine under name portable_vsnprintf */
1009 /* declare our portable routines under names snprintf and vsnprintf */
1010 #define portable_snprintf snprintf
1011 #if !defined(NEED_SNPRINTF_ONLY)
1012 #define portable_vsnprintf vsnprintf
1016 #if !defined(HAVE_SNPRINTF) || defined(PREFER_PORTABLE_SNPRINTF)
1017 int portable_snprintf(char *str, size_t str_m, const char *fmt, /*args*/ ...);
1018 #if !defined(NEED_SNPRINTF_ONLY)
1019 int portable_vsnprintf(char *str, size_t str_m, const char *fmt, va_list ap);
1025 static char credits[] = "\n\
1026 @(#)snprintf.c, v2.2: Mark Martinec, <mark.martinec@ijs.si>\n\
1027 @(#)snprintf.c, v2.2: Copyright 1999, Mark Martinec. Frontier Artistic License applies.\n\
1028 @(#)snprintf.c, v2.2: http://www.ijs.si/software/snprintf/\n";
1030 #if defined(NEED_ASPRINTF)
1031 int asprintf(char **ptr, const char *fmt, /*args*/ ...) {
1037 va_start(ap, fmt); /* measure the required size */
1038 str_l = portable_vsnprintf(NULL, (size_t)0, fmt, ap);
1040 assert(str_l >= 0); /* possible integer overflow if str_m > INT_MAX */
1041 *ptr = (char *) malloc(str_m = (size_t)str_l + 1);
1042 if (*ptr == NULL) { errno = ENOMEM; str_l = -1; }
1046 str_l2 = portable_vsnprintf(*ptr, str_m, fmt, ap);
1048 assert(str_l2 == str_l);
1054 #if defined(NEED_VASPRINTF)
1055 int vasprintf(char **ptr, const char *fmt, va_list ap) {
1061 va_copy(ap2, ap); /* don't consume the original ap, we'll need it again */
1062 str_l = portable_vsnprintf(NULL, (size_t)0, fmt, ap2);/*get required size*/
1065 assert(str_l >= 0); /* possible integer overflow if str_m > INT_MAX */
1066 *ptr = (char *) malloc(str_m = (size_t)str_l + 1);
1067 if (*ptr == NULL) { errno = ENOMEM; str_l = -1; }
1069 int str_l2 = portable_vsnprintf(*ptr, str_m, fmt, ap);
1070 assert(str_l2 == str_l);
1076 #if defined(NEED_ASNPRINTF)
1077 int asnprintf (char **ptr, size_t str_m, const char *fmt, /*args*/ ...) {
1082 va_start(ap, fmt); /* measure the required size */
1083 str_l = portable_vsnprintf(NULL, (size_t)0, fmt, ap);
1085 assert(str_l >= 0); /* possible integer overflow if str_m > INT_MAX */
1086 if ((size_t)str_l + 1 < str_m) str_m = (size_t)str_l + 1; /* truncate */
1087 /* if str_m is 0, no buffer is allocated, just set *ptr to NULL */
1088 if (str_m == 0) { /* not interested in resulting string, just return size */
1090 *ptr = (char *) malloc(str_m);
1091 if (*ptr == NULL) { errno = ENOMEM; str_l = -1; }
1095 str_l2 = portable_vsnprintf(*ptr, str_m, fmt, ap);
1097 assert(str_l2 == str_l);
1104 #if defined(NEED_VASNPRINTF)
1105 int vasnprintf (char **ptr, size_t str_m, const char *fmt, va_list ap) {
1110 va_copy(ap2, ap); /* don't consume the original ap, we'll need it again */
1111 str_l = portable_vsnprintf(NULL, (size_t)0, fmt, ap2);/*get required size*/
1114 assert(str_l >= 0); /* possible integer overflow if str_m > INT_MAX */
1115 if ((size_t)str_l + 1 < str_m) str_m = (size_t)str_l + 1; /* truncate */
1116 /* if str_m is 0, no buffer is allocated, just set *ptr to NULL */
1117 if (str_m == 0) { /* not interested in resulting string, just return size */
1119 *ptr = (char *) malloc(str_m);
1120 if (*ptr == NULL) { errno = ENOMEM; str_l = -1; }
1122 int str_l2 = portable_vsnprintf(*ptr, str_m, fmt, ap);
1123 assert(str_l2 == str_l);
1131 * If the system does have snprintf and the portable routine is not
1132 * specifically required, this module produces no code for snprintf/vsnprintf.
1134 #if !defined(HAVE_SNPRINTF) || defined(PREFER_PORTABLE_SNPRINTF)
1136 #if !defined(NEED_SNPRINTF_ONLY)
1137 int portable_snprintf(char *str, size_t str_m, const char *fmt, /*args*/ ...) {
1142 str_l = portable_vsnprintf(str, str_m, fmt, ap);
1148 #if defined(NEED_SNPRINTF_ONLY)
1149 int portable_snprintf(char *str, size_t str_m, const char *fmt, /*args*/ ...) {
1151 int portable_vsnprintf(char *str, size_t str_m, const char *fmt, va_list ap) {
1154 #if defined(NEED_SNPRINTF_ONLY)
1158 const char *p = fmt;
1160 /* In contrast with POSIX, the ISO C99 now says
1161 * that str can be NULL and str_m can be 0.
1162 * This is more useful than the old: if (str_m < 1) return -1; */
1164 #if defined(NEED_SNPRINTF_ONLY)
1170 /* if (str_l < str_m) str[str_l++] = *p++; -- this would be sufficient */
1171 /* but the following code achieves better performance for cases
1172 * where format string is long and contains few conversions */
1173 const char *q = strchr(p+1,'%');
1174 size_t n = !q ? strlen(p) : (q-p);
1175 if (str_l < str_m) {
1176 size_t avail = str_m-str_l;
1177 fast_memcpy(str+str_l, p, (n>avail?avail:n));
1181 const char *starting_p;
1182 size_t min_field_width = 0, precision = 0;
1183 int zero_padding = 0, precision_specified = 0, justify_left = 0;
1184 int alternate_form = 0, force_sign = 0;
1185 int space_for_positive = 1; /* If both the ' ' and '+' flags appear,
1186 the ' ' flag should be ignored. */
1187 char length_modifier = '\0'; /* allowed values: \0, h, l, L */
1188 char tmp[32];/* temporary buffer for simple numeric->string conversion */
1190 const char *str_arg; /* string address in case of string argument */
1191 size_t str_arg_l; /* natural field width of arg without padding
1193 unsigned char uchar_arg;
1194 /* unsigned char argument value - only defined for c conversion.
1195 N.B. standard explicitly states the char argument for
1196 the c conversion is unsigned */
1198 size_t number_of_zeros_to_pad = 0;
1199 /* number of zeros to be inserted for numeric conversions
1200 as required by the precision or minimal field width */
1202 size_t zero_padding_insertion_ind = 0;
1203 /* index into tmp where zero padding is to be inserted */
1205 char fmt_spec = '\0';
1206 /* current conversion specifier character */
1208 str_arg = credits;/* just to make compiler happy (defined but not used)*/
1210 starting_p = p; p++; /* skip '%' */
1212 while (*p == '0' || *p == '-' || *p == '+' ||
1213 *p == ' ' || *p == '#' || *p == '\'') {
1215 case '0': zero_padding = 1; break;
1216 case '-': justify_left = 1; break;
1217 case '+': force_sign = 1; space_for_positive = 0; break;
1218 case ' ': force_sign = 1;
1219 /* If both the ' ' and '+' flags appear, the ' ' flag should be ignored */
1220 #ifdef PERL_COMPATIBLE
1221 /* ... but in Perl the last of ' ' and '+' applies */
1222 space_for_positive = 1;
1225 case '#': alternate_form = 1; break;
1230 /* If the '0' and '-' flags both appear, the '0' flag should be ignored. */
1232 /* parse field width */
1235 p++; j = va_arg(ap, int);
1236 if (j >= 0) min_field_width = j;
1237 else { min_field_width = -j; justify_left = 1; }
1238 } else if (isdigit((int)(*p))) {
1239 /* size_t could be wider than unsigned int;
1240 make sure we treat argument like common implementations do */
1241 unsigned int uj = *p++ - '0';
1242 while (isdigit((int)(*p))) uj = 10*uj + (unsigned int)(*p++ - '0');
1243 min_field_width = uj;
1245 /* parse precision */
1247 p++; precision_specified = 1;
1249 int j = va_arg(ap, int);
1251 if (j >= 0) precision = j;
1253 precision_specified = 0; precision = 0;
1255 * Solaris 2.6 man page claims that in this case the precision
1256 * should be set to 0. Digital Unix 4.0, HPUX 10 and BSD man page
1257 * claim that this case should be treated as unspecified precision,
1258 * which is what we do here.
1261 } else if (isdigit((int)(*p))) {
1262 /* size_t could be wider than unsigned int;
1263 make sure we treat argument like common implementations do */
1264 unsigned int uj = *p++ - '0';
1265 while (isdigit((int)(*p))) uj = 10*uj + (unsigned int)(*p++ - '0');
1269 /* parse 'h', 'l' and 'll' length modifiers */
1270 if (*p == 'h' || *p == 'l') {
1271 length_modifier = *p; p++;
1272 if (length_modifier == 'l' && *p == 'l') { /* double l = long long */
1273 #ifdef SNPRINTF_LONGLONG_SUPPORT
1274 length_modifier = '2'; /* double l encoded as '2' */
1276 length_modifier = 'l'; /* treat it as a single 'l' */
1282 /* common synonyms: */
1284 case 'i': fmt_spec = 'd'; break;
1285 case 'D': fmt_spec = 'd'; length_modifier = 'l'; break;
1286 case 'U': fmt_spec = 'u'; length_modifier = 'l'; break;
1287 case 'O': fmt_spec = 'o'; length_modifier = 'l'; break;
1290 /* get parameter value, do initial processing */
1292 case '%': /* % behaves similar to 's' regarding flags and field widths */
1293 case 'c': /* c behaves similar to 's' regarding flags and field widths */
1295 length_modifier = '\0'; /* wint_t and wchar_t not supported */
1296 /* the result of zero padding flag with non-numeric conversion specifier*/
1297 /* is undefined. Solaris and HPUX 10 does zero padding in this case, */
1298 /* Digital Unix and Linux does not. */
1299 #if !defined(SOLARIS_COMPATIBLE) && !defined(HPUX_COMPATIBLE)
1300 zero_padding = 0; /* turn zero padding off for string conversions */
1307 int j = va_arg(ap, int);
1308 uchar_arg = (unsigned char) j; /* standard demands unsigned char */
1309 str_arg = (const char *) &uchar_arg;
1313 str_arg = va_arg(ap, const char *);
1314 if (!str_arg) str_arg_l = 0;
1315 /* make sure not to address string beyond the specified precision !!! */
1316 else if (!precision_specified) str_arg_l = strlen(str_arg);
1317 /* truncate string if necessary as requested by precision */
1318 else if (precision == 0) str_arg_l = 0;
1320 /* memchr on HP does not like n > 2^31 !!! */
1321 const char *q = memchr(str_arg, '\0',
1322 precision <= 0x7fffffff ? precision : 0x7fffffff);
1323 str_arg_l = !q ? precision : (q-str_arg);
1329 case 'd': case 'u': case 'o': case 'x': case 'X': case 'p': {
1330 /* NOTE: the u, o, x, X and p conversion specifiers imply
1331 the value is unsigned; d implies a signed value */
1334 /* 0 if numeric argument is zero (or if pointer is NULL for 'p'),
1335 +1 if greater than zero (or nonzero for unsigned arguments),
1336 -1 if negative (unsigned argument is never negative) */
1338 int int_arg = 0; unsigned int uint_arg = 0;
1339 /* only defined for length modifier h, or for no length modifiers */
1341 long int long_arg = 0; unsigned long int ulong_arg = 0;
1342 /* only defined for length modifier l */
1344 void *ptr_arg = NULL;
1345 /* pointer argument value -only defined for p conversion */
1347 #ifdef SNPRINTF_LONGLONG_SUPPORT
1348 long long int long_long_arg = 0;
1349 unsigned long long int ulong_long_arg = 0;
1350 /* only defined for length modifier ll */
1352 if (fmt_spec == 'p') {
1353 /* HPUX 10: An l, h, ll or L before any other conversion character
1354 * (other than d, i, u, o, x, or X) is ignored.
1356 * not specified, but seems to behave as HPUX does.
1357 * Solaris: If an h, l, or L appears before any other conversion
1358 * specifier (other than d, i, u, o, x, or X), the behavior
1359 * is undefined. (Actually %hp converts only 16-bits of address
1360 * and %llp treats address as 64-bit data which is incompatible
1361 * with (void *) argument on a 32-bit system).
1363 #ifdef SOLARIS_COMPATIBLE
1364 # ifdef SOLARIS_BUG_COMPATIBLE
1365 /* keep length modifiers even if it represents 'll' */
1367 if (length_modifier == '2') length_modifier = '\0';
1370 length_modifier = '\0';
1372 ptr_arg = va_arg(ap, void *);
1373 if (ptr_arg != NULL) arg_sign = 1;
1374 } else if (fmt_spec == 'd') { /* signed */
1375 switch (length_modifier) {
1378 /* It is non-portable to specify a second argument of char or short
1379 * to va_arg, because arguments seen by the called function
1380 * are not char or short. C converts char and short arguments
1381 * to int before passing them to a function.
1383 int_arg = va_arg(ap, int);
1384 if (int_arg > 0) arg_sign = 1;
1385 else if (int_arg < 0) arg_sign = -1;
1388 long_arg = va_arg(ap, long int);
1389 if (long_arg > 0) arg_sign = 1;
1390 else if (long_arg < 0) arg_sign = -1;
1392 #ifdef SNPRINTF_LONGLONG_SUPPORT
1394 long_long_arg = va_arg(ap, long long int);
1395 if (long_long_arg > 0) arg_sign = 1;
1396 else if (long_long_arg < 0) arg_sign = -1;
1400 } else { /* unsigned */
1401 switch (length_modifier) {
1404 uint_arg = va_arg(ap, unsigned int);
1405 if (uint_arg) arg_sign = 1;
1408 ulong_arg = va_arg(ap, unsigned long int);
1409 if (ulong_arg) arg_sign = 1;
1411 #ifdef SNPRINTF_LONGLONG_SUPPORT
1413 ulong_long_arg = va_arg(ap, unsigned long long int);
1414 if (ulong_long_arg) arg_sign = 1;
1419 str_arg = tmp; str_arg_l = 0;
1421 * For d, i, u, o, x, and X conversions, if precision is specified,
1422 * the '0' flag should be ignored. This is so with Solaris 2.6,
1423 * Digital UNIX 4.0, HPUX 10, Linux, FreeBSD, NetBSD; but not with Perl.
1425 #ifndef PERL_COMPATIBLE
1426 if (precision_specified) zero_padding = 0;
1428 if (fmt_spec == 'd') {
1429 if (force_sign && arg_sign >= 0)
1430 tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
1431 /* leave negative numbers for sprintf to handle,
1432 to avoid handling tricky cases like (short int)(-32768) */
1433 #ifdef LINUX_COMPATIBLE
1434 } else if (fmt_spec == 'p' && force_sign && arg_sign > 0) {
1435 tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
1437 } else if (alternate_form) {
1438 if (arg_sign != 0 && (fmt_spec == 'x' || fmt_spec == 'X') )
1439 { tmp[str_arg_l++] = '0'; tmp[str_arg_l++] = fmt_spec; }
1440 /* alternate form should have no effect for p conversion, but ... */
1441 #ifdef HPUX_COMPATIBLE
1442 else if (fmt_spec == 'p'
1443 /* HPUX 10: for an alternate form of p conversion,
1444 * a nonzero result is prefixed by 0x. */
1445 #ifndef HPUX_BUG_COMPATIBLE
1446 /* Actually it uses 0x prefix even for a zero value. */
1449 ) { tmp[str_arg_l++] = '0'; tmp[str_arg_l++] = 'x'; }
1452 zero_padding_insertion_ind = str_arg_l;
1453 if (!precision_specified) precision = 1; /* default precision is 1 */
1454 if (precision == 0 && arg_sign == 0
1455 #if defined(HPUX_BUG_COMPATIBLE) || defined(LINUX_COMPATIBLE)
1457 /* HPUX 10 man page claims: With conversion character p the result of
1458 * converting a zero value with a precision of zero is a null string.
1459 * Actually HP returns all zeroes, and Linux returns "(nil)". */
1462 /* converted to null string */
1463 /* When zero value is formatted with an explicit precision 0,
1464 the resulting formatted string is empty (d, i, u, o, x, X, p). */
1466 char f[5]; int f_l = 0;
1467 f[f_l++] = '%'; /* construct a simple format string for sprintf */
1468 if (!length_modifier) { }
1469 else if (length_modifier=='2') { f[f_l++] = 'l'; f[f_l++] = 'l'; }
1470 else f[f_l++] = length_modifier;
1471 f[f_l++] = fmt_spec; f[f_l++] = '\0';
1472 if (fmt_spec == 'p') str_arg_l += sprintf(tmp+str_arg_l, f, ptr_arg);
1473 else if (fmt_spec == 'd') { /* signed */
1474 switch (length_modifier) {
1476 case 'h': str_arg_l+=sprintf(tmp+str_arg_l, f, int_arg); break;
1477 case 'l': str_arg_l+=sprintf(tmp+str_arg_l, f, long_arg); break;
1478 #ifdef SNPRINTF_LONGLONG_SUPPORT
1479 case '2': str_arg_l+=sprintf(tmp+str_arg_l,f,long_long_arg); break;
1482 } else { /* unsigned */
1483 switch (length_modifier) {
1485 case 'h': str_arg_l+=sprintf(tmp+str_arg_l, f, uint_arg); break;
1486 case 'l': str_arg_l+=sprintf(tmp+str_arg_l, f, ulong_arg); break;
1487 #ifdef SNPRINTF_LONGLONG_SUPPORT
1488 case '2': str_arg_l+=sprintf(tmp+str_arg_l,f,ulong_long_arg);break;
1492 /* include the optional minus sign and possible "0x"
1493 in the region before the zero padding insertion point */
1494 if (zero_padding_insertion_ind < str_arg_l &&
1495 tmp[zero_padding_insertion_ind] == '-') {
1496 zero_padding_insertion_ind++;
1498 if (zero_padding_insertion_ind+1 < str_arg_l &&
1499 tmp[zero_padding_insertion_ind] == '0' &&
1500 (tmp[zero_padding_insertion_ind+1] == 'x' ||
1501 tmp[zero_padding_insertion_ind+1] == 'X') ) {
1502 zero_padding_insertion_ind += 2;
1505 { size_t num_of_digits = str_arg_l - zero_padding_insertion_ind;
1506 if (alternate_form && fmt_spec == 'o'
1507 #ifdef HPUX_COMPATIBLE /* ("%#.o",0) -> "" */
1510 #ifdef DIGITAL_UNIX_BUG_COMPATIBLE /* ("%#o",0) -> "00" */
1512 /* unless zero is already the first character */
1513 && !(zero_padding_insertion_ind < str_arg_l
1514 && tmp[zero_padding_insertion_ind] == '0')
1516 ) { /* assure leading zero for alternate-form octal numbers */
1517 if (!precision_specified || precision < num_of_digits+1) {
1518 /* precision is increased to force the first character to be zero,
1519 except if a zero value is formatted with an explicit precision
1521 precision = num_of_digits+1; precision_specified = 1;
1524 /* zero padding to specified precision? */
1525 if (num_of_digits < precision)
1526 number_of_zeros_to_pad = precision - num_of_digits;
1528 /* zero padding to specified minimal field width? */
1529 if (!justify_left && zero_padding) {
1530 int n = min_field_width - (str_arg_l+number_of_zeros_to_pad);
1531 if (n > 0) number_of_zeros_to_pad += n;
1535 default: /* unrecognized conversion specifier, keep format string as-is*/
1536 zero_padding = 0; /* turn zero padding off for non-numeric convers. */
1537 #ifndef DIGITAL_UNIX_COMPATIBLE
1538 justify_left = 1; min_field_width = 0; /* reset flags */
1540 #if defined(PERL_COMPATIBLE) || defined(LINUX_COMPATIBLE)
1541 /* keep the entire format string unchanged */
1542 str_arg = starting_p; str_arg_l = p - starting_p;
1543 /* well, not exactly so for Linux, which does something between,
1544 * and I don't feel an urge to imitate it: "%+++++hy" -> "%+y" */
1546 /* discard the unrecognized conversion, just keep *
1547 * the unrecognized conversion character */
1548 str_arg = p; str_arg_l = 0;
1550 if (*p) str_arg_l++; /* include invalid conversion specifier unchanged
1551 if not at end-of-string */
1554 if (*p) p++; /* step over the just processed conversion specifier */
1555 /* insert padding to the left as requested by min_field_width;
1556 this does not include the zero padding in case of numerical conversions*/
1557 if (!justify_left) { /* left padding with blank or zero */
1558 int n = min_field_width - (str_arg_l+number_of_zeros_to_pad);
1560 if (str_l < str_m) {
1561 size_t avail = str_m-str_l;
1562 fast_memset(str+str_l, (zero_padding?'0':' '), (n>avail?avail:n));
1567 /* zero padding as requested by the precision or by the minimal field width
1568 * for numeric conversions required? */
1569 if (number_of_zeros_to_pad <= 0) {
1570 /* will not copy first part of numeric right now, *
1571 * force it to be copied later in its entirety */
1572 zero_padding_insertion_ind = 0;
1574 /* insert first part of numerics (sign or '0x') before zero padding */
1575 int n = zero_padding_insertion_ind;
1577 if (str_l < str_m) {
1578 size_t avail = str_m-str_l;
1579 fast_memcpy(str+str_l, str_arg, (n>avail?avail:n));
1583 /* insert zero padding as requested by the precision or min field width */
1584 n = number_of_zeros_to_pad;
1586 if (str_l < str_m) {
1587 size_t avail = str_m-str_l;
1588 fast_memset(str+str_l, '0', (n>avail?avail:n));
1593 /* insert formatted string
1594 * (or as-is conversion specifier for unknown conversions) */
1595 { int n = str_arg_l - zero_padding_insertion_ind;
1597 if (str_l < str_m) {
1598 size_t avail = str_m-str_l;
1599 fast_memcpy(str+str_l, str_arg+zero_padding_insertion_ind,
1605 /* insert right padding */
1606 if (justify_left) { /* right blank padding to the field width */
1607 int n = min_field_width - (str_arg_l+number_of_zeros_to_pad);
1609 if (str_l < str_m) {
1610 size_t avail = str_m-str_l;
1611 fast_memset(str+str_l, ' ', (n>avail?avail:n));
1618 #if defined(NEED_SNPRINTF_ONLY)
1621 if (str_m > 0) { /* make sure the string is null-terminated
1622 even at the expense of overwriting the last character
1623 (shouldn't happen, but just in case) */
1624 str[str_l <= str_m-1 ? str_l : str_m-1] = '\0';
1626 /* Return the number of characters formatted (excluding trailing null
1627 * character), that is, the number of characters that would have been
1628 * written to the buffer if it were large enough.
1630 * The value of str_l should be returned, but str_l is of unsigned type
1631 * size_t, and snprintf is int, possibly leading to an undetected
1632 * integer overflow, resulting in a negative return value, which is illegal.
1633 * Both XSH5 and ISO C99 (at least the draft) are silent on this issue.
1634 * Should errno be set to EOVERFLOW and EOF returned in this case???
1639 #endif /* ndef HAVE_SNPRINTF */