printf.c 9.87 KB
Newer Older
1 2 3 4 5 6
/*
 *	BIRD Library -- Formatted Output
 *
 *	(c) 1991, 1992 Lars Wirzenius & Linus Torvalds
 *
 *	Hacked up for BIRD by Martin Mares <mj@ucw.cz>
7
 *	Buffer size limitation implemented by Martin Mares.
8 9 10 11 12
 */

#include "nest/bird.h"
#include "string.h"

Martin Mareš's avatar
Martin Mareš committed
13 14
#include <errno.h>

15 16
#include "nest/iface.h"

17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
/* we use this so that we can do without the ctype library */
#define is_digit(c)	((c) >= '0' && (c) <= '9')

static int skip_atoi(const char **s)
{
	int i=0;

	while (is_digit(**s))
		i = i*10 + *((*s)++) - '0';
	return i;
}

#define ZEROPAD	1		/* pad with zero */
#define SIGN	2		/* unsigned/signed long */
#define PLUS	4		/* show plus */
#define SPACE	8		/* space if plus */
#define LEFT	16		/* left justified */
#define SPECIAL	32		/* 0x */
#define LARGE	64		/* use 'ABCDEF' instead of 'abcdef' */

#define do_div(n,base) ({ \
int __res; \
__res = ((unsigned long) n) % (unsigned) base; \
n = ((unsigned long) n) / (unsigned) base; \
__res; })

43 44
static char * number(char * str, long num, int base, int size, int precision,
	int type, int remains)
45 46 47 48 49
{
	char c,sign,tmp[66];
	const char *digits="0123456789abcdefghijklmnopqrstuvwxyz";
	int i;

50 51
	if (size >= 0 && (remains -= size) < 0)
		return NULL;
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86
	if (type & LARGE)
		digits = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ";
	if (type & LEFT)
		type &= ~ZEROPAD;
	if (base < 2 || base > 36)
		return 0;
	c = (type & ZEROPAD) ? '0' : ' ';
	sign = 0;
	if (type & SIGN) {
		if (num < 0) {
			sign = '-';
			num = -num;
			size--;
		} else if (type & PLUS) {
			sign = '+';
			size--;
		} else if (type & SPACE) {
			sign = ' ';
			size--;
		}
	}
	if (type & SPECIAL) {
		if (base == 16)
			size -= 2;
		else if (base == 8)
			size--;
	}
	i = 0;
	if (num == 0)
		tmp[i++]='0';
	else while (num != 0)
		tmp[i++] = digits[do_div(num,base)];
	if (i > precision)
		precision = i;
	size -= precision;
87 88
	if (size < 0 && -size > remains)
		return NULL;
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
	if (!(type&(ZEROPAD+LEFT)))
		while(size-->0)
			*str++ = ' ';
	if (sign)
		*str++ = sign;
	if (type & SPECIAL) {
		if (base==8)
			*str++ = '0';
		else if (base==16) {
			*str++ = '0';
			*str++ = digits[33];
		}
	}
	if (!(type & LEFT))
		while (size-- > 0)
			*str++ = c;
	while (i < precision--)
		*str++ = '0';
	while (i-- > 0)
		*str++ = tmp[i];
	while (size-- > 0)
		*str++ = ' ';
	return str;
}

Martin Mareš's avatar
Martin Mareš committed
114 115 116 117 118 119 120 121 122
/**
 * bvsnprintf - BIRD's vsnprintf()
 * @buf: destination buffer
 * @size: size of the buffer
 * @fmt: format string
 * @args: a list of arguments to be formatted
 *
 * This functions acts like ordinary sprintf() except that it checks
 * available space to avoid buffer overflows and it allows some more
123 124
 * format specifiers: |%I| for formatting of IP addresses (any non-zero
 * width is automatically replaced by standard IP address width which
125 126
 * depends on whether we use IPv4 or IPv6; |%#I| gives hexadecimal format),
 * |%R| for Router / Network ID (u32 value printed as IPv4 address)
127
 * |%lR| for 64bit Router / Network ID (u64 value printed as eight :-separated octets)
128
 * and |%m| resp. |%M| for error messages (uses strerror() to translate @errno code to
Martin Mareš's avatar
Martin Mareš committed
129 130 131 132 133 134
 * message text). On the other hand, it doesn't support floating
 * point numbers.
 *
 * Result: number of characters of the output string or -1 if
 * the buffer space was insufficient.
 */
135
int bvsnprintf(char *buf, int size, const char *fmt, va_list args)
136 137 138 139
{
	int len;
	unsigned long num;
	int i, base;
140
	u32 x;
141
	u64 X;
142
	char *str, *start;
143
	const char *s;
144
	char ipbuf[MAX(STD_ADDRESS_P_LENGTH,ROUTER_ID_64_LENGTH)+1];
145
	struct iface *iface;
146 147 148 149 150 151 152 153

	int flags;		/* flags to number() */

	int field_width;	/* width of output field */
	int precision;		/* min. # of digits for integers; max
				   number of chars for from string */
	int qualifier;		/* 'h', 'l', or 'L' for integer fields */

154
	for (start=str=buf ; *fmt ; ++fmt, size-=(str-start), start=str) {
155
		if (*fmt != '%') {
156 157
			if (!size)
				return -1;
158 159 160 161 162 163 164 165 166 167 168 169 170 171
			*str++ = *fmt;
			continue;
		}
			
		/* process flags */
		flags = 0;
		repeat:
			++fmt;		/* this also skips first '%' */
			switch (*fmt) {
				case '-': flags |= LEFT; goto repeat;
				case '+': flags |= PLUS; goto repeat;
				case ' ': flags |= SPACE; goto repeat;
				case '#': flags |= SPECIAL; goto repeat;
				case '0': flags |= ZEROPAD; goto repeat;
Pavel Tvrdik's avatar
Pavel Tvrdik committed
172
			}
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
		
		/* get field width */
		field_width = -1;
		if (is_digit(*fmt))
			field_width = skip_atoi(&fmt);
		else if (*fmt == '*') {
			++fmt;
			/* it's the next argument */
			field_width = va_arg(args, int);
			if (field_width < 0) {
				field_width = -field_width;
				flags |= LEFT;
			}
		}

		/* get the precision */
		precision = -1;
		if (*fmt == '.') {
			++fmt;	
			if (is_digit(*fmt))
				precision = skip_atoi(&fmt);
			else if (*fmt == '*') {
				++fmt;
				/* it's the next argument */
				precision = va_arg(args, int);
			}
			if (precision < 0)
				precision = 0;
		}

		/* get the conversion qualifier */
		qualifier = -1;
		if (*fmt == 'h' || *fmt == 'l' || *fmt == 'L') {
			qualifier = *fmt;
			++fmt;
		}

		/* default base */
		base = 10;

213 214
		if (field_width > size)
			return -1;
215 216 217 218 219
		switch (*fmt) {
		case 'c':
			if (!(flags & LEFT))
				while (--field_width > 0)
					*str++ = ' ';
Pavel Tvrdík's avatar
Pavel Tvrdík committed
220
			*str++ = (byte) va_arg(args, int);
221 222 223 224
			while (--field_width > 0)
				*str++ = ' ';
			continue;

Martin Mareš's avatar
Martin Mareš committed
225
		case 'm':
226 227 228 229 230 231 232 233 234 235
			if (flags & SPECIAL) {
				if (!errno)
					continue;
				if (size < 2)
					return -1;
				*str++ = ':';
				*str++ = ' ';
				start += 2;
				size -= 2;
			}
Martin Mareš's avatar
Martin Mareš committed
236 237
			s = strerror(errno);
			goto str;
238 239 240
		case 'M':
			s = strerror(va_arg(args, int));
			goto str;
241 242 243 244 245
		case 's':
			s = va_arg(args, char *);
			if (!s)
				s = "<NULL>";

Martin Mareš's avatar
Martin Mareš committed
246
		str:
247 248 249
			len = strlen(s);
			if (precision >= 0 && len > precision)
				len = precision;
250 251
			if (len > size)
				return -1;
252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268

			if (!(flags & LEFT))
				while (len < field_width--)
					*str++ = ' ';
			for (i = 0; i < len; ++i)
				*str++ = *s++;
			while (len < field_width--)
				*str++ = ' ';
			continue;

		case 'p':
			if (field_width == -1) {
				field_width = 2*sizeof(void *);
				flags |= ZEROPAD;
			}
			str = number(str,
				(unsigned long) va_arg(args, void *), 16,
269 270 271
				field_width, precision, flags, size);
			if (!str)
				return -1;
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
			continue;


		case 'n':
			if (qualifier == 'l') {
				long * ip = va_arg(args, long *);
				*ip = (str - buf);
			} else {
				int * ip = va_arg(args, int *);
				*ip = (str - buf);
			}
			continue;

		/* IP address */
		case 'I':
			if (flags & SPECIAL)
288
				ipa_ntox(va_arg(args, ip_addr), ipbuf);
289
			else {
290
				ipa_ntop(va_arg(args, ip_addr), ipbuf);
291
				if (field_width == 1)
292
					field_width = STD_ADDRESS_P_LENGTH;
293
			}
294 295
			s = ipbuf;
			goto str;
296

297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
		/* Interface scope after link-local IP address */
		case 'J':
			iface = va_arg(args, struct iface *);
			if (!iface)
				continue;
			if (!size)
				return -1;

			*str++ = '%';
			start++;
			size--;

			s = iface->name;
			goto str;

312 313
		/* Router/Network ID - essentially IPv4 address in u32 value */
		case 'R':
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
			if(qualifier == 'l') {
				X = va_arg(args, u64);
				bsprintf(ipbuf, "%02x:%02x:%02x:%02x:%02x:%02x:%02x:%02x",
					((X >> 56) & 0xff),
					((X >> 48) & 0xff),
					((X >> 40) & 0xff),
					((X >> 32) & 0xff),
					((X >> 24) & 0xff),
					((X >> 16) & 0xff),
					((X >> 8) & 0xff),
					(X & 0xff));
			}
			else
			{
				x = va_arg(args, u32);
				bsprintf(ipbuf, "%d.%d.%d.%d",
					((x >> 24) & 0xff),
					((x >> 16) & 0xff),
					((x >> 8) & 0xff),
					(x & 0xff));
			}
335 336 337
			s = ipbuf;
			goto str;

338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
		/* integer number formats - set up the flags and "break" */
		case 'o':
			base = 8;
			break;

		case 'X':
			flags |= LARGE;
		case 'x':
			base = 16;
			break;

		case 'd':
		case 'i':
			flags |= SIGN;
		case 'u':
			break;

		default:
356 357
			if (size < 2)
				return -1;
358 359 360 361 362 363 364 365 366 367 368
			if (*fmt != '%')
				*str++ = '%';
			if (*fmt)
				*str++ = *fmt;
			else
				--fmt;
			continue;
		}
		if (qualifier == 'l')
			num = va_arg(args, unsigned long);
		else if (qualifier == 'h') {
369
			num = (unsigned short) va_arg(args, int);
370
			if (flags & SIGN)
371
				num = (short) num;
372 373 374
		} else if (flags & SIGN)
			num = va_arg(args, int);
		else
Pavel Tvrdík's avatar
Pavel Tvrdík committed
375
			num = va_arg(args, uint);
376 377 378
		str = number(str, num, base, field_width, precision, flags, size);
		if (!str)
			return -1;
379
	}
380 381
	if (!size)
		return -1;
382 383 384 385
	*str = '\0';
	return str-buf;
}

Martin Mareš's avatar
Martin Mareš committed
386 387 388 389 390 391 392 393 394 395
/**
 * bvsprintf - BIRD's vsprintf()
 * @buf: buffer
 * @fmt: format string
 * @args: a list of arguments to be formatted
 *
 * This function is equivalent to bvsnprintf() with an infinite
 * buffer size. Please use carefully only when you are absolutely
 * sure the buffer won't overflow.
 */
396 397 398 399 400
int bvsprintf(char *buf, const char *fmt, va_list args)
{
  return bvsnprintf(buf, 1000000000, fmt, args);
}

Martin Mareš's avatar
Martin Mareš committed
401 402 403 404 405 406 407 408 409 410
/**
 * bsprintf - BIRD's sprintf()
 * @buf: buffer
 * @fmt: format string
 *
 * This function is equivalent to bvsnprintf() with an infinite
 * buffer size and variable arguments instead of a &va_list.
 * Please use carefully only when you are absolutely
 * sure the buffer won't overflow.
 */
411 412
int bsprintf(char * buf, const char *fmt, ...)
{
413 414
  va_list args;
  int i;
415

416 417 418 419 420 421
  va_start(args, fmt);
  i=bvsnprintf(buf, 1000000000, fmt, args);
  va_end(args);
  return i;
}

Martin Mareš's avatar
Martin Mareš committed
422 423 424 425 426 427 428 429
/**
 * bsnprintf - BIRD's snprintf()
 * @buf: buffer
 * @size: buffer size
 * @fmt: format string
 *
 * This function is equivalent to bsnprintf() with variable arguments instead of a &va_list.
 */
430 431 432 433 434 435 436 437 438
int bsnprintf(char * buf, int size, const char *fmt, ...)
{
  va_list args;
  int i;

  va_start(args, fmt);
  i=bvsnprintf(buf, size, fmt, args);
  va_end(args);
  return i;
439
}
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476

int
buffer_vprint(buffer *buf, const char *fmt, va_list args)
{
  int i = bvsnprintf((char *) buf->pos, buf->end - buf->pos, fmt, args);
  buf->pos = (i >= 0) ? (buf->pos + i) : buf->end;
  return i;
}

int
buffer_print(buffer *buf, const char *fmt, ...)
{
  va_list args;
  int i;

  va_start(args, fmt);
  i=bvsnprintf((char *) buf->pos, buf->end - buf->pos, fmt, args);
  va_end(args);

  buf->pos = (i >= 0) ? (buf->pos + i) : buf->end;
  return i;
}

void
buffer_puts(buffer *buf, const char *str)
{
  byte *bp = buf->pos;
  byte *be = buf->end;

  while (bp < be && *str)
    *bp++ = *str++;

  if (bp < be)
    *bp = 0;

  buf->pos = bp;
}