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')
78 #define MAX(p,q) (((p) >= (q)) ? (p) : (q))
81 You might ask why does Bacula have it's own printf routine? Well,
82 There are two reasons: 1. Here (as opposed to library routines), we
83 define %d and %ld to be 32 bit; %lld and %q to be 64 bit. 2. We
84 disable %n for security reasons.
87 int bsnprintf(char *str, int32_t size, const char *fmt, ...)
92 va_start(arg_ptr, fmt);
93 len = bvsnprintf(str, size, fmt, arg_ptr);
99 int bvsnprintf(char *buffer, int32_t maxlen, const char *format, va_list args)
116 state = DP_S_DEFAULT;
117 currlen = flags = cflags = min = 0;
122 while (state != DP_S_DONE) {
123 if ((ch == '\0') || (currlen >= maxlen))
163 if (isdigit((unsigned char)ch)) {
164 min = 10 * min + char_to_int(ch);
166 } else if (ch == '*') {
167 #ifdef SECURITY_PROBLEM
168 min = va_arg(args, int);
170 junk = va_arg(args, int);
186 if (isdigit((unsigned char)ch)) {
189 max = 10 * max + char_to_int(ch);
191 } else if (ch == '*') {
192 #ifdef SECURITY_PROBLEM
193 max = va_arg(args, int);
195 junk = va_arg(args, int);
211 if (ch == 'l') { /* It's a long long */
217 cflags = DP_C_LDOUBLE;
229 if (cflags == DP_C_INT16) {
230 value = va_arg(args, int32_t);
231 } else if (cflags == DP_C_INT32) {
232 value = va_arg(args, int32_t);
233 } else if (cflags == DP_C_INT64) {
234 value = va_arg(args, int64_t);
236 value = va_arg(args, int);
238 currlen = fmtint(buffer, currlen, maxlen, value, 10, min, max, flags);
246 } else if (ch == 'x') {
248 } else if (ch == 'X') {
254 flags |= DP_F_UNSIGNED;
255 if (cflags == DP_C_INT16) {
256 value = va_arg(args, uint32_t);
257 } else if (cflags == DP_C_INT32) {
258 value = (long)va_arg(args, uint32_t);
259 } else if (cflags == DP_C_INT64) {
260 value = (int64_t) va_arg(args, uint64_t);
262 value = (long)va_arg(args, unsigned int);
264 currlen = fmtint(buffer, currlen, maxlen, value, base, min, max, flags);
267 if (cflags == DP_C_LDOUBLE) {
268 fvalue = va_arg(args, LDOUBLE);
270 fvalue = va_arg(args, double);
272 currlen = fmtfp(buffer, currlen, maxlen, fvalue, min, max, flags);
277 if (cflags == DP_C_LDOUBLE) {
278 fvalue = va_arg(args, LDOUBLE);
280 fvalue = va_arg(args, double);
282 currlen = fmtfp(buffer, currlen, maxlen, fvalue, min, max, flags);
287 if (cflags == DP_C_LDOUBLE) {
288 fvalue = va_arg(args, LDOUBLE);
290 fvalue = va_arg(args, double);
292 currlen = fmtfp(buffer, currlen, maxlen, fvalue, min, max, flags);
295 outch(va_arg(args, int));
298 strvalue = va_arg(args, char *);
299 currlen = fmtstr(buffer, currlen, maxlen, strvalue, flags, min, max);
302 strvalue = va_arg(args, char *);
303 currlen = fmtint(buffer, currlen, maxlen, (long)strvalue, 16, min, max, flags);
306 if (cflags == DP_C_INT16) {
308 num = va_arg(args, int16_t *);
309 #ifdef SECURITY_PROBLEM
312 } else if (cflags == DP_C_INT32) {
314 num = va_arg(args, int32_t *);
315 #ifdef SECURITY_PROBLEM
316 *num = (int32_t)currlen;
318 } else if (cflags == DP_C_INT64) {
320 num = va_arg(args, int64_t *);
321 #ifdef SECURITY_PROBLEM
322 *num = (int64_t)currlen;
326 num = va_arg(args, int32_t *);
327 #ifdef SECURITY_PROBLEM
328 *num = (int32_t)currlen;
336 /* not supported yet, treat as next char */
344 state = DP_S_DEFAULT;
345 flags = cflags = min = 0;
352 break; /* some picky compilers need this */
355 if (currlen < maxlen - 1) {
356 buffer[currlen] = '\0';
358 buffer[maxlen - 1] = '\0';
363 static int32_t fmtstr(char *buffer, int32_t currlen, int32_t maxlen,
364 char *value, int flags, int min, int max)
366 int padlen, strln; /* amount to pad */
373 if (flags & DP_F_DOT && max < 0) { /* Max not specified */
375 } else if (max < 0) {
378 strln = strlen(value);
380 strln = max; /* truncate to max */
382 padlen = min - strln;
386 if (flags & DP_F_MINUS) {
387 padlen = -padlen; /* Left Justify */
394 while (*value && (cnt < max)) {
405 /* Have to handle DP_F_NUM (ie 0x and 0 alternates) */
407 static int32_t fmtint(char *buffer, int32_t currlen, int32_t maxlen,
408 int64_t value, int base, int min, int max, int flags)
414 int spadlen = 0; /* amount to space pad */
415 int zpadlen = 0; /* amount to zero pad */
424 if (!(flags & DP_F_UNSIGNED)) {
428 } else if (flags & DP_F_PLUS) { /* Do a sign (+/i) */
430 } else if (flags & DP_F_SPACE) {
435 if (flags & DP_F_UP) {
436 caps = 1; /* Should characters be upper case? */
440 convert[place++] = (caps ? "0123456789ABCDEF" : "0123456789abcdef")
441 [uvalue % (unsigned)base];
442 uvalue = (uvalue / (unsigned)base);
443 } while (uvalue && (place < 20));
449 zpadlen = max - place;
450 spadlen = min - MAX(max, place) - (signvalue ? 1 : 0);
455 if (flags & DP_F_ZERO) {
456 zpadlen = MAX(zpadlen, spadlen);
459 if (flags & DP_F_MINUS)
460 spadlen = -spadlen; /* Left Justifty */
462 #ifdef DEBUG_SNPRINTF
463 printf("zpad: %d, spad: %d, min: %d, max: %d, place: %d\n",
464 zpadlen, spadlen, min, max, place);
468 while (spadlen > 0) {
480 while (zpadlen > 0) {
488 outch(convert[--place]);
491 /* Left Justified spaces */
492 while (spadlen < 0) {
501 static LDOUBLE abs_val(LDOUBLE value)
503 LDOUBLE result = value;
511 static LDOUBLE pow10(int exp)
523 static long round(LDOUBLE value)
527 intpart = (long)value;
528 value = value - intpart;
535 static int32_t fmtfp(char *buffer, int32_t currlen, int32_t maxlen,
536 LDOUBLE fvalue, int min, int max, int flags)
549 extern char *fcvt(double value, int ndigit, int *decpt, int *sign);
553 int padlen = 0; /* amount to pad */
560 * AIX manpage says the default is 0, but Solaris says the default
561 * is 6, and sprintf on AIX defaults to 6
566 ufvalue = abs_val(fvalue);
570 else if (flags & DP_F_PLUS) /* Do a sign (+/i) */
572 else if (flags & DP_F_SPACE)
577 caps = 1; /* Should characters be upper case? */
581 intpart = (long)ufvalue;
584 * Sorry, we only support 9 digits past the decimal because of our
590 /* We "cheat" by converting the fractional part to integer by
591 * multiplying by a factor of 10
593 fracpart = round((pow10(max)) * (ufvalue - intpart));
595 if (fracpart >= pow10(max)) {
597 fracpart -= (int64_t)pow10(max);
599 #ifdef DEBUG_SNPRINTF
600 printf("fmtfp: %g %d.%d min=%d max=%d\n",
601 (double)fvalue, intpart, fracpart, min, max);
604 /* Convert integer part */
607 (caps ? "0123456789ABCDEF" : "0123456789abcdef")[intpart % 10];
608 intpart = (intpart / 10);
609 } while (intpart && (iplace < 20));
612 iconvert[iplace] = 0;
614 /* Convert fractional part */
617 (caps ? "0123456789ABCDEF" : "0123456789abcdef")[fracpart % 10];
618 fracpart = (fracpart / 10);
619 } while (fracpart && (fplace < 20));
622 fconvert[fplace] = 0;
623 #else /* use fcvt() */
627 result = fcvtl(ufvalue, max, &dec_pt, &sig);
629 result = fcvt(ufvalue, max, &dec_pt, &sig);
632 r_length = strlen(result);
635 * Fix broken fcvt implementation returns..
644 if (r_length < dec_pt)
655 fconvert[fplace++] = result[--r_length];
657 while ((dec_pt < 0) && (fplace < max)) {
658 fconvert[fplace++] = '0';
665 for (c = dec_pt; c; iconvert[iplace++] = result[--c]);
666 iconvert[iplace] = '\0';
671 for (c = (r_length - dec_pt); c; fconvert[fplace++] = result[--c]);
673 #endif /* HAVE_FCVT */
675 /* -1 for decimal point, another -1 if we are printing a sign */
676 padlen = min - iplace - max - 1 - ((signvalue) ? 1 : 0);
677 zpadlen = max - fplace;
684 if (flags & DP_F_MINUS) {
685 padlen = -padlen; /* Left Justifty */
688 if ((flags & DP_F_ZERO) && (padlen > 0)) {
708 outch(iconvert[--iplace]);
712 #ifdef DEBUG_SNPRINTF
713 printf("fmtfp: fplace=%d zpadlen=%d\n", fplace, zpadlen);
717 * Decimal point. This should probably use locale to find the correct
723 outch(fconvert[--fplace]);
727 while (zpadlen > 0) {
738 #endif /* FP_OUTPUT */
744 #define LONG_STRING 1024
748 char buf1[LONG_STRING];
749 char buf2[LONG_STRING];
768 double fp_nums[] = { -1.5, 134.21, 91340.2, 341.1234, 0203.9, 0.96, 0.996,
769 0.9996, 1.996, 4.136, 6442452944.1234, 0
793 long int_nums[] = { -1, 134, 91340, 341, 0203, 0 };
807 int64_t ll_nums[] = { -1976, 789134567890LL, 91340, 34123, 0203, 0 };
825 char *s_nums[] = { "abc", "def", "ghi", "123", "4567", "a", "bb", "ccccccc", NULL};
832 printf("Testing snprintf format codes against system sprintf...\n");
835 for (x = 0; fp_fmt[x] != NULL; x++)
836 for (y = 0; fp_nums[y] != 0; y++) {
837 bsnprintf(buf1, sizeof(buf1), fp_fmt[x], fp_nums[y]);
838 sprintf(buf2, fp_fmt[x], fp_nums[y]);
839 if (strcmp(buf1, buf2)) {
841 ("snprintf doesn't match Format: %s\n\tsnprintf = %s\n\tsprintf = %s\n",
842 fp_fmt[x], buf1, buf2);
849 for (x = 0; int_fmt[x] != NULL; x++)
850 for (y = 0; int_nums[y] != 0; y++) {
852 bcount = bsnprintf(buf1, sizeof(buf1), int_fmt[x], int_nums[y]);
853 printf("%s\n", buf1);
854 pcount = sprintf(buf2, int_fmt[x], int_nums[y]);
855 if (bcount != pcount) {
856 printf("bsnprintf count %d doesn't match sprintf count %d\n",
859 if (strcmp(buf1, buf2)) {
861 ("bsnprintf doesn't match Format: %s\n\tsnprintf = %s\n\tsprintf = %s\n",
862 int_fmt[x], buf1, buf2);
868 for (x = 0; ll_fmt[x] != NULL; x++) {
869 for (y = 0; ll_nums[y] != 0; y++) {
871 bcount = bsnprintf(buf1, sizeof(buf1), ll_fmt[x], ll_nums[y]);
872 printf("%s\n", buf1);
873 pcount = sprintf(buf2, ll_fmt[x], ll_nums[y]);
874 if (bcount != pcount) {
875 printf("bsnprintf count %d doesn't match sprintf count %d\n",
878 if (strcmp(buf1, buf2)) {
880 ("bsnprintf doesn't match Format: %s\n\tsnprintf = %s\n\tsprintf = %s\n",
881 ll_fmt[x], buf1, buf2);
888 for (x = 0; s_fmt[x] != NULL; x++) {
889 for (y = 0; s_nums[y] != 0; y++) {
891 bcount = bsnprintf(buf1, sizeof(buf1), s_fmt[x], s_nums[y]);
892 printf("%s\n", buf1);
893 pcount = sprintf(buf2, s_fmt[x], s_nums[y]);
894 if (bcount != pcount) {
895 printf("bsnprintf count %d doesn't match sprintf count %d\n",
898 if (strcmp(buf1, buf2)) {
900 ("bsnprintf doesn't match Format: %s\n\tsnprintf = %s\n\tsprintf = %s\n",
901 s_fmt[x], buf1, buf2);
909 printf("%d tests failed out of %d.\n", fail, num);
911 #endif /* TEST_PROGRAM */
913 #endif /* USE_BSNPRINTF */