lib/libstand/printf.c

   1 /*-
   2  * Copyright (c) 1986, 1988, 1991, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  * (c) UNIX System Laboratories, Inc.
   5  * All or some portions of this file are derived from material licensed
   6  * to the University of California by American Telephone and Telegraph
   7  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
   8  * the permission of UNIX System Laboratories, Inc.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 3. Neither the name of the University nor the names of its contributors
  19  *    may be used to endorse or promote products derived from this software
  20  *    without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  *      @(#)subr_prf.c  8.3 (Berkeley) 1/21/94
  35  * $FreeBSD: src/lib/libstand/printf.c,v 1.14 2010/07/12 15:32:45 jkim Exp $
  36  */
  37
  38 /*
  39  * Standaloneified version of the FreeBSD kernel printf family.
  40  */
  41
  42 #include <sys/types.h>
  43 #include <sys/stdint.h>
  44 #include <limits.h>
  45 #include <string.h>
  46 #include "stand.h"
  47
  48 /*
  49  * Note that stdarg.h and the ANSI style va_start macro is used for both
  50  * ANSI and traditional C compilers.
  51  */
  52 #include <stdarg.h>
  53
  54 struct snprintf_arg {
  55         char    *buf;
  56         size_t  remain;
  57 };
  58
  59 #define MAXNBUF (sizeof(intmax_t) * CHAR_BIT + 1)
  60
  61 static char     *ksprintn (char *buf, uintmax_t num, int base, int *len, int upper);
  62 static int      kvprintf(const char *, void (*)(int, void *), void *, int,
  63                          va_list);
  64 static void     putchar_wrapper(int, void *);
  65 static void     snprintf_func(int, void *);
  66
  67 static void
  68 putchar_wrapper(int ch, void *arg __unused)
  69 {
  70         putchar(ch);
  71 }
  72
  73 int
  74 printf(const char *fmt, ...)
  75 {
  76         va_list ap;
  77         int retval;
  78
  79         va_start(ap, fmt);
  80         retval = kvprintf(fmt, putchar_wrapper, NULL, 10, ap);
  81         va_end(ap);
  82         return retval;
  83 }
  84
  85 void
  86 vprintf(const char *fmt, va_list ap)
  87 {
  88
  89         kvprintf(fmt, putchar_wrapper, NULL, 10, ap);
  90 }
  91
  92 int
  93 sprintf(char *buf, const char *cfmt, ...)
  94 {
  95         int retval;
  96         va_list ap;
  97
  98         va_start(ap, cfmt);
  99         retval = kvprintf(cfmt, NULL, buf, 10, ap);
 100         buf[retval] = '\0';
 101         va_end(ap);
 102         return retval;
 103 }
 104
 105 void
 106 vsprintf(char *buf, const char *cfmt, va_list ap)
 107 {
 108         int     retval;
 109
 110         retval = kvprintf(cfmt, NULL, buf, 10, ap);
 111         buf[retval] = '\0';
 112 }
 113
 114 int
 115 snprintf(char *buf, size_t size, const char *cfmt, ...)
 116 {
 117         int retval;
 118         va_list ap;
 119
 120         va_start(ap, cfmt);
 121         retval = vsnprintf(buf, size, cfmt, ap);
 122         __va_end(ap);
 123         return(retval);
 124 }
 125
 126 int
 127 vsnprintf(char *buf, size_t size, const char *cfmt, va_list ap)
 128 {
 129         struct snprintf_arg info;
 130         int retval;
 131
 132         info.buf = buf;
 133         info.remain = size;
 134         retval = kvprintf(cfmt, snprintf_func, &info, 10, ap);
 135         if (info.remain >= 1)
 136                 *info.buf++ = '\0';
 137         return(retval);
 138 }
 139
 140 static void
 141 snprintf_func(int ch, void *arg)
 142 {
 143         struct snprintf_arg * const info = arg;
 144
 145         if (info->remain >= 2) {
 146                 *info->buf++ = ch;
 147                 info->remain--;
 148         }
 149 }
 150
 151 /*
 152  * Put a NUL-terminated ASCII number (base <= 36) in a buffer in reverse
 153  * order; return an optional length and a pointer to the last character
 154  * written in the buffer (i.e., the first character of the string).
 155  * The buffer pointed to by `nbuf' must have length >= MAXNBUF.
 156  */
 157 static char *
 158 ksprintn(char *nbuf, uintmax_t num, int base, int *lenp, int upper)
 159 {
 160         char *p, c;
 161
 162         p = nbuf;
 163         *p = '\0';
 164         do {
 165                 c = hex2ascii(num % base);
 166                 *++p = upper ? toupper(c) : c;
 167         } while (num /= base);
 168         if (lenp)
 169                 *lenp = p - nbuf;
 170         return (p);
 171 }
 172
 173 /*
 174  * Scaled down version of printf(3).
 175  *
 176  * Two additional formats:
 177  *
 178  * The format %b is supported to decode error registers.
 179  * Its usage is:
 180  *
 181  *      printf("reg=%b\n", regval, "<base><arg>*");
 182  *
 183  * where <base> is the output base expressed as a control character, e.g.
 184  * \10 gives octal; \20 gives hex.  Each arg is a sequence of characters,
 185  * the first of which gives the bit number to be inspected (origin 1), and
 186  * the next characters (up to a control character, i.e. a character <= 32),
 187  * give the name of the register.  Thus:
 188  *
 189  *      kvprintf("reg=%b\n", 3, "\10\2BITTWO\1BITONE\n");
 190  *
 191  * would produce output:
 192  *
 193  *      reg=3<BITTWO,BITONE>
 194  *
 195  */
 196 static int
 197 kvprintf(char const *fmt, void (*func)(int, void *), void *arg, int radix,
 198          va_list ap)
 199 {
 200 #define PCHAR(c) {int cc=(c); if (func) (*func)(cc, arg); else *d++ = cc; retval++; }
 201         char nbuf[MAXNBUF];
 202         char *d;
 203         const char *p, *percent, *q;
 204         int ch, n;
 205         uintmax_t num;
 206         int base, lflag, qflag, tmp, width, ladjust, sharpflag, neg, sign, dot;
 207         int cflag, hflag, jflag, tflag, zflag;
 208         int dwidth, upper;
 209         char padc;
 210         int stop = 0, retval = 0;
 211
 212         num = 0;
 213         if (!func)
 214                 d = (char *) arg;
 215         else
 216                 d = NULL;
 217
 218         if (fmt == NULL)
 219                 fmt = "(fmt null)\n";
 220
 221         if (radix < 2 || radix > 36)
 222                 radix = 10;
 223
 224         for (;;) {
 225                 padc = ' ';
 226                 width = 0;
 227                 while ((ch = (u_char)*fmt++) != '%' || stop) {
 228                         if (ch == '\0')
 229                                 return (retval);
 230                         PCHAR(ch);
 231                 }
 232                 percent = fmt - 1;
 233                 qflag = 0; lflag = 0; ladjust = 0; sharpflag = 0; neg = 0;
 234                 sign = 0; dot = 0; dwidth = 0; upper = 0;
 235                 cflag = 0; hflag = 0; jflag = 0; tflag = 0; zflag = 0;
 236
 237 reswitch:       switch (ch = (u_char)*fmt++) {
 238                 case '.':
 239                         dot = 1;
 240                         goto reswitch;
 241                 case '#':
 242                         sharpflag = 1;
 243                         goto reswitch;
 244                 case '+':
 245                         sign = 1;
 246                         goto reswitch;
 247                 case '-':
 248                         ladjust = 1;
 249                         goto reswitch;
 250                 case '%':
 251                         PCHAR(ch);
 252                         break;
 253                 case '*':
 254                         if (!dot) {
 255                                 width = va_arg(ap, int);
 256                                 if (width < 0) {
 257                                         ladjust = !ladjust;
 258                                         width = -width;
 259                                 }
 260                         } else {
 261                                 dwidth = va_arg(ap, int);
 262                         }
 263                         goto reswitch;
 264                 case '0':
 265                         if (!dot) {
 266                                 padc = '0';
 267                                 goto reswitch;
 268                         }
 269                 case '1': case '2': case '3': case '4':
 270                 case '5': case '6': case '7': case '8': case '9':
 271                                 for (n = 0;; ++fmt) {
 272                                         n = n * 10 + ch - '0';
 273                                         ch = *fmt;
 274                                         if (ch < '0' || ch > '9')
 275                                                 break;
 276                                 }
 277                         if (dot)
 278                                 dwidth = n;
 279                         else
 280                                 width = n;
 281                         goto reswitch;
 282                 case 'b':
 283                         num = (u_int)va_arg(ap, int);
 284                         p = va_arg(ap, char *);
 285                         for (q = ksprintn(nbuf, num, *p++, NULL, 0); *q;)
 286                                 PCHAR(*q--);
 287
 288                         if (num == 0)
 289                                 break;
 290
 291                         for (tmp = 0; *p;) {
 292                                 n = *p++;
 293                                 if (num & (1 << (n - 1))) {
 294                                         PCHAR(tmp ? ',' : '<');
 295                                         for (; (n = *p) > ' '; ++p)
 296                                                 PCHAR(n);
 297                                         tmp = 1;
 298                                 } else
 299                                         for (; *p > ' '; ++p)
 300                                                 continue;
 301                         }
 302                         if (tmp)
 303                                 PCHAR('>');
 304                         break;
 305                 case 'c':
 306                         PCHAR(va_arg(ap, int));
 307                         break;
 308                 case 'd':
 309                 case 'i':
 310                         base = 10;
 311                         sign = 1;
 312                         goto handle_sign;
 313                 case 'h':
 314                         if (hflag) {
 315                                 hflag = 0;
 316                                 cflag = 1;
 317                         } else
 318                                 hflag = 1;
 319                         goto reswitch;
 320                 case 'j':
 321                         jflag = 1;
 322                         goto reswitch;
 323                 case 'l':
 324                         if (lflag) {
 325                                 lflag = 0;
 326                                 qflag = 1;
 327                         } else
 328                                 lflag = 1;
 329                         goto reswitch;
 330                 case 'n':
 331                         if (jflag)
 332                                 *(va_arg(ap, intmax_t *)) = retval;
 333                         else if (qflag)
 334                                 *(va_arg(ap, quad_t *)) = retval;
 335                         else if (lflag)
 336                                 *(va_arg(ap, long *)) = retval;
 337                         else if (zflag)
 338                                 *(va_arg(ap, size_t *)) = retval;
 339                         else if (hflag)
 340                                 *(va_arg(ap, short *)) = retval;
 341                         else if (cflag)
 342                                 *(va_arg(ap, char *)) = retval;
 343                         else
 344                                 *(va_arg(ap, int *)) = retval;
 345                         break;
 346                 case 'o':
 347                         base = 8;
 348                         goto handle_nosign;
 349                 case 'p':
 350                         base = 16;
 351                         sharpflag = (width == 0);
 352                         sign = 0;
 353                         num = (uintptr_t)va_arg(ap, void *);
 354                         goto number;
 355                 case 'q':
 356                         qflag = 1;
 357                         goto reswitch;
 358                 case 'r':
 359                         base = radix;
 360                         if (sign)
 361                                 goto handle_sign;
 362                         goto handle_nosign;
 363                 case 's':
 364                         p = va_arg(ap, char *);
 365                         if (p == NULL)
 366                                 p = "(null)";
 367                         if (!dot)
 368                                 n = strlen (p);
 369                         else
 370                                 for (n = 0; n < dwidth && p[n]; n++)
 371                                         continue;
 372
 373                         width -= n;
 374
 375                         if (!ladjust && width > 0)
 376                                 while (width--)
 377                                         PCHAR(padc);
 378                         while (n--)
 379                                 PCHAR(*p++);
 380                         if (ladjust && width > 0)
 381                                 while (width--)
 382                                         PCHAR(padc);
 383                         break;
 384                 case 't':
 385                         tflag = 1;
 386                         goto reswitch;
 387                 case 'u':
 388                         base = 10;
 389                         goto handle_nosign;
 390                 case 'X':
 391                         upper = 1;
 392                 case 'x':
 393                         base = 16;
 394                         goto handle_nosign;
 395                 case 'y':
 396                         base = 16;
 397                         sign = 1;
 398                         goto handle_sign;
 399                 case 'z':
 400                         zflag = 1;
 401                         goto reswitch;
 402 handle_nosign:
 403                         sign = 0;
 404                         if (jflag)
 405                                 num = va_arg(ap, uintmax_t);
 406                         else if (qflag)
 407                                 num = va_arg(ap, u_quad_t);
 408                         else if (tflag)
 409                                 num = va_arg(ap, ptrdiff_t);
 410                         else if (lflag)
 411                                 num = va_arg(ap, u_long);
 412                         else if (zflag)
 413                                 num = va_arg(ap, size_t);
 414                         else if (hflag)
 415                                 num = (u_short)va_arg(ap, int);
 416                         else if (cflag)
 417                                 num = (u_char)va_arg(ap, int);
 418                         else
 419                                 num = va_arg(ap, u_int);
 420                         goto number;
 421 handle_sign:
 422                         if (jflag)
 423                                 num = va_arg(ap, intmax_t);
 424                         else if (qflag)
 425                                 num = va_arg(ap, quad_t);
 426                         else if (tflag)
 427                                 num = va_arg(ap, ptrdiff_t);
 428                         else if (lflag)
 429                                 num = va_arg(ap, long);
 430                         else if (zflag)
 431                                 num = va_arg(ap, ssize_t);
 432                         else if (hflag)
 433                                 num = (short)va_arg(ap, int);
 434                         else if (cflag)
 435                                 num = (char)va_arg(ap, int);
 436                         else
 437                                 num = va_arg(ap, int);
 438 number:
 439                         if (sign && (intmax_t)num < 0) {
 440                                 neg = 1;
 441                                 num = -(intmax_t)num;
 442                         }
 443                         p = ksprintn(nbuf, num, base, &n, upper);
 444                         tmp = 0;
 445                         if (sharpflag && num != 0) {
 446                                 if (base == 8)
 447                                         tmp++;
 448                                 else if (base == 16)
 449                                         tmp += 2;
 450                         }
 451                         if (neg)
 452                                 tmp++;
 453
 454                         if (!ladjust && padc == '0')
 455                                 dwidth = width - tmp;
 456                         width -= tmp + imax(dwidth, n);
 457                         dwidth -= n;
 458                         if (!ladjust)
 459                                 while (width-- > 0)
 460                                         PCHAR(' ');
 461                         if (neg)
 462                                 PCHAR('-');
 463                         if (sharpflag && num != 0) {
 464                                 if (base == 8) {
 465                                         PCHAR('0');
 466                                 } else if (base == 16) {
 467                                         PCHAR('0');
 468                                         PCHAR('x');
 469                                 }
 470                         }
 471                         while (dwidth-- > 0)
 472                                 PCHAR('0');
 473
 474                         while (*p)
 475                                 PCHAR(*p--);
 476
 477                         if (ladjust)
 478                                 while (width-- > 0)
 479                                         PCHAR(' ');
 480
 481                         break;
 482                 default:
 483                         while (percent < fmt)
 484                                 PCHAR(*percent++);
 485                         /*
 486                          * Since we ignore an formatting argument it is no
 487                          * longer safe to obey the remaining formatting
 488                          * arguments as the arguments will no longer match
 489                          * the format specs.
 490                          */
 491                         stop = 1;
 492                         break;
 493                 }
 494         }
 495 #undef PCHAR
 496 }