annotate lib/vsprintf.c @ 17255:d81be792518a

update from texinfo
author Karl Berry <karl@freefriends.org>
date Tue, 01 Jan 2013 15:51:49 -0800
parents e542fd46ad6f
children 344018b6e5d7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8371
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
1 /* Formatted output to strings.
17249
e542fd46ad6f maint: update all copyright year number ranges
Eric Blake <eblake@redhat.com>
parents: 16201
diff changeset
2 Copyright (C) 2004, 2006-2013 Free Software Foundation, Inc.
8371
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
3
9309
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 9029
diff changeset
4 This program is free software: you can redistribute it and/or modify
8371
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
5 it under the terms of the GNU General Public License as published by
9309
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 9029
diff changeset
6 the Free Software Foundation; either version 3 of the License, or
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 9029
diff changeset
7 (at your option) any later version.
8371
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
8
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
9 This program is distributed in the hope that it will be useful,
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
12 GNU General Public License for more details.
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
13
9309
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 9029
diff changeset
14 You should have received a copy of the GNU General Public License
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 9029
diff changeset
15 along with this program. If not, see <http://www.gnu.org/licenses/>. */
8371
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
16
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
17 #ifdef HAVE_CONFIG_H
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
18 # include <config.h>
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
19 #endif
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
20
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
21 /* Specification. */
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
22 #include <stdio.h>
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
23
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
24 #include <errno.h>
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
25 #include <limits.h>
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
26 #include <stdarg.h>
9029
3b5cd6b6e134 Avoid address wraparound inside system functions.
Bruno Haible <bruno@clisp.org>
parents: 8468
diff changeset
27 #include <stdint.h>
8371
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
28 #include <stdlib.h>
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
29
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
30 #include "vasnprintf.h"
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
31
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
32 #ifndef SIZE_MAX
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
33 # define SIZE_MAX ((size_t) -1)
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
34 #endif
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
35
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
36 /* Print formatted output to string STR.
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
37 Return string length of formatted string. On error, return a negative
8381
8c96722f8bd0 Whitespace change.
Bruno Haible <bruno@clisp.org>
parents: 8371
diff changeset
38 value. */
8371
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
39 int
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
40 vsprintf (char *str, const char *format, va_list args)
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
41 {
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
42 char *output;
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
43 size_t len;
9029
3b5cd6b6e134 Avoid address wraparound inside system functions.
Bruno Haible <bruno@clisp.org>
parents: 8468
diff changeset
44 size_t lenbuf;
3b5cd6b6e134 Avoid address wraparound inside system functions.
Bruno Haible <bruno@clisp.org>
parents: 8468
diff changeset
45
8468
336e69863755 Fix endless loop when the given allocated size was > INT_MAX.
Bruno Haible <bruno@clisp.org>
parents: 8381
diff changeset
46 /* vasnprintf fails with EOVERFLOW when the buffer size argument is larger
9029
3b5cd6b6e134 Avoid address wraparound inside system functions.
Bruno Haible <bruno@clisp.org>
parents: 8468
diff changeset
47 than INT_MAX (if that fits into a 'size_t' at all).
3b5cd6b6e134 Avoid address wraparound inside system functions.
Bruno Haible <bruno@clisp.org>
parents: 8468
diff changeset
48 Also note that glibc's iconv fails with E2BIG when we pass a length that
3b5cd6b6e134 Avoid address wraparound inside system functions.
Bruno Haible <bruno@clisp.org>
parents: 8468
diff changeset
49 is so large that str + lenbuf wraps around, i.e.
3b5cd6b6e134 Avoid address wraparound inside system functions.
Bruno Haible <bruno@clisp.org>
parents: 8468
diff changeset
50 (uintptr_t) (str + lenbuf) < (uintptr_t) str.
3b5cd6b6e134 Avoid address wraparound inside system functions.
Bruno Haible <bruno@clisp.org>
parents: 8468
diff changeset
51 Therefore set lenbuf = min (SIZE_MAX, INT_MAX, - (uintptr_t) str - 1). */
3b5cd6b6e134 Avoid address wraparound inside system functions.
Bruno Haible <bruno@clisp.org>
parents: 8468
diff changeset
52 lenbuf = (SIZE_MAX < INT_MAX ? SIZE_MAX : INT_MAX);
3b5cd6b6e134 Avoid address wraparound inside system functions.
Bruno Haible <bruno@clisp.org>
parents: 8468
diff changeset
53 if (lenbuf > ~ (uintptr_t) str)
3b5cd6b6e134 Avoid address wraparound inside system functions.
Bruno Haible <bruno@clisp.org>
parents: 8468
diff changeset
54 lenbuf = ~ (uintptr_t) str;
8371
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
55
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
56 output = vasnprintf (str, &lenbuf, format, args);
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
57 len = lenbuf;
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
58
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
59 if (!output)
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
60 return -1;
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
61
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
62 if (output != str)
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
63 {
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
64 /* len is near SIZE_MAX. */
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
65 free (output);
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
66 errno = EOVERFLOW;
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
67 return -1;
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
68 }
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
69
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
70 if (len > INT_MAX)
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
71 {
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
72 errno = EOVERFLOW;
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
73 return -1;
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
74 }
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
75
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
76 return len;
00b14bff072a New module 'vsprintf-posix'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
77 }