2 * Copyright Patrick Powell 1995
4 * This code is based on code written by Patrick Powell
5 * (papowell@astart.com) It may be used for any purpose as long
6 * as this notice remains intact on all source code distributions.
8 * Adapted for Bacula -- note there were lots of bugs in
9 * the original code: %lld and %s were seriously broken, and
10 * with FP turned off %f seg faults.
11 * Kern Sibbald, November MMV
18 #define FP_OUTPUT 1 /* Bacula uses floating point */
21 Temp only for me -- NOT YET READY FOR USE -- seems to work fine
22 on Linux, but doesn't build correctly on Win32
26 #ifdef HAVE_LONG_DOUBLE
27 #define LDOUBLE long double
29 #define LDOUBLE double
32 int bvsnprintf(char *buffer, int32_t maxlen, const char *format, va_list args);
33 static int32_t fmtstr(char *buffer, int32_t currlen, int32_t maxlen,
34 char *value, int flags, int min, int max);
35 static int32_t fmtint(char *buffer, int32_t currlen, int32_t maxlen,
36 int64_t value, int base, int min, int max, int flags);
42 static int32_t fmtfp(char *buffer, int32_t currlen, int32_t maxlen,
43 LDOUBLE fvalue, int min, int max, int flags);
45 #define fmtfp(b, c, m, f, min, max, fl) currlen
48 #define outch(c) {int len=currlen; if (currlen++ < maxlen) { buffer[len] = (c);}}
51 /* format read states */
52 #define DP_S_DEFAULT 0
61 /* format flags - Bits */
62 #define DP_F_MINUS (1 << 0)
63 #define DP_F_PLUS (1 << 1)
64 #define DP_F_SPACE (1 << 2)
65 #define DP_F_NUM (1 << 3)
66 #define DP_F_ZERO (1 << 4)
67 #define DP_F_UP (1 << 5)
68 #define DP_F_UNSIGNED (1 << 6)
69 #define DP_F_DOT (1 << 7)
71 /* Conversion Flags */
74 #define DP_C_LDOUBLE 3
77 #define char_to_int(p) ((p)- '0')
79 #define MAX(p,q) (((p) >= (q)) ? (p) : (q))
82 You might ask why does Bacula have it's own printf routine? Well,
83 There are two reasons: 1. Here (as opposed to library routines), we
84 define %d and %ld to be 32 bit; %lld and %q to be 64 bit. 2. We
85 disable %n for security reasons.
88 int bsnprintf(char *str, int32_t size, const char *fmt, ...)
93 va_start(arg_ptr, fmt);
94 len = bvsnprintf(str, size, fmt, arg_ptr);
100 int bvsnprintf(char *buffer, int32_t maxlen, const char *format, va_list args)
117 state = DP_S_DEFAULT;
118 currlen = flags = cflags = min = 0;
123 while (state != DP_S_DONE) {
124 if ((ch == '\0') || (currlen >= maxlen))
164 if (isdigit((unsigned char)ch)) {
165 min = 10 * min + char_to_int(ch);
167 } else if (ch == '*') {
168 #ifdef SECURITY_PROBLEM
169 min = va_arg(args, int);
171 junk = va_arg(args, int);
187 if (isdigit((unsigned char)ch)) {
190 max = 10 * max + char_to_int(ch);
192 } else if (ch == '*') {
193 #ifdef SECURITY_PROBLEM
194 max = va_arg(args, int);
196 junk = va_arg(args, int);
212 if (ch == 'l') { /* It's a long long */
218 cflags = DP_C_LDOUBLE;
230 if (cflags == DP_C_INT16) {
231 value = va_arg(args, int32_t);
232 } else if (cflags == DP_C_INT32) {
233 value = va_arg(args, int32_t);
234 } else if (cflags == DP_C_INT64) {
235 value = va_arg(args, int64_t);
237 value = va_arg(args, int);
239 currlen = fmtint(buffer, currlen, maxlen, value, 10, min, max, flags);
247 } else if (ch == 'x') {
249 } else if (ch == 'X') {
255 flags |= DP_F_UNSIGNED;
256 if (cflags == DP_C_INT16) {
257 value = va_arg(args, uint32_t);
258 } else if (cflags == DP_C_INT32) {
259 value = (long)va_arg(args, uint32_t);
260 } else if (cflags == DP_C_INT64) {
261 value = (int64_t) va_arg(args, uint64_t);
263 value = (long)va_arg(args, unsigned int);
265 currlen = fmtint(buffer, currlen, maxlen, value, base, min, max, flags);
268 if (cflags == DP_C_LDOUBLE) {
269 fvalue = va_arg(args, LDOUBLE);
271 fvalue = va_arg(args, double);
273 currlen = fmtfp(buffer, currlen, maxlen, fvalue, min, max, flags);
278 if (cflags == DP_C_LDOUBLE) {
279 fvalue = va_arg(args, LDOUBLE);
281 fvalue = va_arg(args, double);
283 currlen = fmtfp(buffer, currlen, maxlen, fvalue, min, max, flags);
288 if (cflags == DP_C_LDOUBLE) {
289 fvalue = va_arg(args, LDOUBLE);
291 fvalue = va_arg(args, double);
293 currlen = fmtfp(buffer, currlen, maxlen, fvalue, min, max, flags);
296 outch(va_arg(args, int));
299 strvalue = va_arg(args, char *);
300 currlen = fmtstr(buffer, currlen, maxlen, strvalue, flags, min, max);
303 strvalue = va_arg(args, char *);
304 currlen = fmtint(buffer, currlen, maxlen, (long)strvalue, 16, min, max, flags);
307 if (cflags == DP_C_INT16) {
309 num = va_arg(args, int16_t *);
310 #ifdef SECURITY_PROBLEM
313 } else if (cflags == DP_C_INT32) {
315 num = va_arg(args, int32_t *);
316 #ifdef SECURITY_PROBLEM
317 *num = (int32_t)currlen;
319 } else if (cflags == DP_C_INT64) {
321 num = va_arg(args, int64_t *);
322 #ifdef SECURITY_PROBLEM
323 *num = (int64_t)currlen;
327 num = va_arg(args, int32_t *);
328 #ifdef SECURITY_PROBLEM
329 *num = (int32_t)currlen;
337 /* not supported yet, treat as next char */
345 state = DP_S_DEFAULT;
346 flags = cflags = min = 0;
353 break; /* some picky compilers need this */
356 if (currlen < maxlen - 1) {
357 buffer[currlen] = '\0';
359 buffer[maxlen - 1] = '\0';
364 static int32_t fmtstr(char *buffer, int32_t currlen, int32_t maxlen,
365 char *value, int flags, int min, int max)
367 int padlen, strln; /* amount to pad */
374 if (flags & DP_F_DOT && max < 0) { /* Max not specified */
376 } else if (max < 0) {
379 strln = strlen(value);
381 strln = max; /* truncate to max */
383 padlen = min - strln;
387 if (flags & DP_F_MINUS) {
388 padlen = -padlen; /* Left Justify */
395 while (*value && (cnt < max)) {
406 /* Have to handle DP_F_NUM (ie 0x and 0 alternates) */
408 static int32_t fmtint(char *buffer, int32_t currlen, int32_t maxlen,
409 int64_t value, int base, int min, int max, int flags)
415 int spadlen = 0; /* amount to space pad */
416 int zpadlen = 0; /* amount to zero pad */
425 if (!(flags & DP_F_UNSIGNED)) {
429 } else if (flags & DP_F_PLUS) { /* Do a sign (+/i) */
431 } else if (flags & DP_F_SPACE) {
436 if (flags & DP_F_UP) {
437 caps = 1; /* Should characters be upper case? */
441 convert[place++] = (caps ? "0123456789ABCDEF" : "0123456789abcdef")
442 [uvalue % (unsigned)base];
443 uvalue = (uvalue / (unsigned)base);
444 } while (uvalue && (place < 20));
450 zpadlen = max - place;
451 spadlen = min - MAX(max, place) - (signvalue ? 1 : 0);
456 if (flags & DP_F_ZERO) {
457 zpadlen = MAX(zpadlen, spadlen);
460 if (flags & DP_F_MINUS)
461 spadlen = -spadlen; /* Left Justifty */
463 #ifdef DEBUG_SNPRINTF
464 printf("zpad: %d, spad: %d, min: %d, max: %d, place: %d\n",
465 zpadlen, spadlen, min, max, place);
469 while (spadlen > 0) {
481 while (zpadlen > 0) {
489 outch(convert[--place]);
492 /* Left Justified spaces */
493 while (spadlen < 0) {
502 static LDOUBLE abs_val(LDOUBLE value)
504 LDOUBLE result = value;
512 static LDOUBLE pow10(int exp)
524 static long round(LDOUBLE value)
528 intpart = (long)value;
529 value = value - intpart;
536 static int32_t fmtfp(char *buffer, int32_t currlen, int32_t maxlen,
537 LDOUBLE fvalue, int min, int max, int flags)
550 extern char *fcvt(double value, int ndigit, int *decpt, int *sign);
554 int padlen = 0; /* amount to pad */
561 * AIX manpage says the default is 0, but Solaris says the default
562 * is 6, and sprintf on AIX defaults to 6
567 ufvalue = abs_val(fvalue);
571 else if (flags & DP_F_PLUS) /* Do a sign (+/i) */
573 else if (flags & DP_F_SPACE)
578 caps = 1; /* Should characters be upper case? */
582 intpart = (long)ufvalue;
585 * Sorry, we only support 9 digits past the decimal because of our
591 /* We "cheat" by converting the fractional part to integer by
592 * multiplying by a factor of 10
594 fracpart = round((pow10(max)) * (ufvalue - intpart));
596 if (fracpart >= pow10(max)) {
598 fracpart -= (int64_t)pow10(max);
600 #ifdef DEBUG_SNPRINTF
601 printf("fmtfp: %g %d.%d min=%d max=%d\n",
602 (double)fvalue, intpart, fracpart, min, max);
605 /* Convert integer part */
608 (caps ? "0123456789ABCDEF" : "0123456789abcdef")[intpart % 10];
609 intpart = (intpart / 10);
610 } while (intpart && (iplace < 20));
613 iconvert[iplace] = 0;
615 /* Convert fractional part */
618 (caps ? "0123456789ABCDEF" : "0123456789abcdef")[fracpart % 10];
619 fracpart = (fracpart / 10);
620 } while (fracpart && (fplace < 20));
623 fconvert[fplace] = 0;
624 #else /* use fcvt() */
628 result = fcvtl(ufvalue, max, &dec_pt, &sig);
630 result = fcvt(ufvalue, max, &dec_pt, &sig);
633 r_length = strlen(result);
636 * Fix broken fcvt implementation returns..
645 if (r_length < dec_pt)
656 fconvert[fplace++] = result[--r_length];
658 while ((dec_pt < 0) && (fplace < max)) {
659 fconvert[fplace++] = '0';
666 for (c = dec_pt; c; iconvert[iplace++] = result[--c]);
667 iconvert[iplace] = '\0';
672 for (c = (r_length - dec_pt); c; fconvert[fplace++] = result[--c]);
674 #endif /* HAVE_FCVT */
676 /* -1 for decimal point, another -1 if we are printing a sign */
677 padlen = min - iplace - max - 1 - ((signvalue) ? 1 : 0);
678 zpadlen = max - fplace;
685 if (flags & DP_F_MINUS) {
686 padlen = -padlen; /* Left Justifty */
689 if ((flags & DP_F_ZERO) && (padlen > 0)) {
709 outch(iconvert[--iplace]);
713 #ifdef DEBUG_SNPRINTF
714 printf("fmtfp: fplace=%d zpadlen=%d\n", fplace, zpadlen);
718 * Decimal point. This should probably use locale to find the correct
724 outch(fconvert[--fplace]);
728 while (zpadlen > 0) {
739 #endif /* FP_OUTPUT */
745 #define LONG_STRING 1024
749 char buf1[LONG_STRING];
750 char buf2[LONG_STRING];
769 double fp_nums[] = { -1.5, 134.21, 91340.2, 341.1234, 0203.9, 0.96, 0.996,
770 0.9996, 1.996, 4.136, 6442452944.1234, 0
794 long int_nums[] = { -1, 134, 91340, 341, 0203, 0 };
808 int64_t ll_nums[] = { -1976, 789134567890LL, 91340, 34123, 0203, 0 };
826 char *s_nums[] = { "abc", "def", "ghi", "123", "4567", "a", "bb", "ccccccc", NULL};
833 printf("Testing snprintf format codes against system sprintf...\n");
836 for (x = 0; fp_fmt[x] != NULL; x++)
837 for (y = 0; fp_nums[y] != 0; y++) {
838 bsnprintf(buf1, sizeof(buf1), fp_fmt[x], fp_nums[y]);
839 sprintf(buf2, fp_fmt[x], fp_nums[y]);
840 if (strcmp(buf1, buf2)) {
842 ("snprintf doesn't match Format: %s\n\tsnprintf = %s\n\tsprintf = %s\n",
843 fp_fmt[x], buf1, buf2);
850 for (x = 0; int_fmt[x] != NULL; x++)
851 for (y = 0; int_nums[y] != 0; y++) {
853 bcount = bsnprintf(buf1, sizeof(buf1), int_fmt[x], int_nums[y]);
854 printf("%s\n", buf1);
855 pcount = sprintf(buf2, int_fmt[x], int_nums[y]);
856 if (bcount != pcount) {
857 printf("bsnprintf count %d doesn't match sprintf count %d\n",
860 if (strcmp(buf1, buf2)) {
862 ("bsnprintf doesn't match Format: %s\n\tsnprintf = %s\n\tsprintf = %s\n",
863 int_fmt[x], buf1, buf2);
869 for (x = 0; ll_fmt[x] != NULL; x++) {
870 for (y = 0; ll_nums[y] != 0; y++) {
872 bcount = bsnprintf(buf1, sizeof(buf1), ll_fmt[x], ll_nums[y]);
873 printf("%s\n", buf1);
874 pcount = sprintf(buf2, ll_fmt[x], ll_nums[y]);
875 if (bcount != pcount) {
876 printf("bsnprintf count %d doesn't match sprintf count %d\n",
879 if (strcmp(buf1, buf2)) {
881 ("bsnprintf doesn't match Format: %s\n\tsnprintf = %s\n\tsprintf = %s\n",
882 ll_fmt[x], buf1, buf2);
889 for (x = 0; s_fmt[x] != NULL; x++) {
890 for (y = 0; s_nums[y] != 0; y++) {
892 bcount = bsnprintf(buf1, sizeof(buf1), s_fmt[x], s_nums[y]);
893 printf("%s\n", buf1);
894 pcount = sprintf(buf2, s_fmt[x], s_nums[y]);
895 if (bcount != pcount) {
896 printf("bsnprintf count %d doesn't match sprintf count %d\n",
899 if (strcmp(buf1, buf2)) {
901 ("bsnprintf doesn't match Format: %s\n\tsnprintf = %s\n\tsprintf = %s\n",
902 s_fmt[x], buf1, buf2);
910 printf("%d tests failed out of %d.\n", fail, num);
912 #endif /* TEST_PROGRAM */
914 #endif /* USE_BSNPRINTF */