1/* Checking macros for stdio functions.
2 Copyright (C) 2004-2023 Free Software Foundation, Inc.
3 This file is part of the GNU C Library.
4
5 The GNU C Library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Lesser General Public
7 License as published by the Free Software Foundation; either
8 version 2.1 of the License, or (at your option) any later version.
9
10 The GNU C Library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Lesser General Public License for more details.
14
15 You should have received a copy of the GNU Lesser General Public
16 License along with the GNU C Library; if not, see
17 <https://www.gnu.org/licenses/>. */
18
19#ifndef _BITS_STDIO2_H
20#define _BITS_STDIO2_H 1
21
22#ifndef _STDIO_H
23# error "Never include <bits/stdio2.h> directly; use <stdio.h> instead."
24#endif
25
26#ifdef __va_arg_pack
27__fortify_function int
28__NTH (sprintf (char *__restrict __s, const char *__restrict __fmt, ...))
29{
30 return __builtin___sprintf_chk (__s, __USE_FORTIFY_LEVEL - 1,
31 __glibc_objsize (__s), __fmt,
32 __va_arg_pack ());
33}
34#elif !defined __cplusplus
35# define sprintf(str, ...) \
36 __builtin___sprintf_chk (str, __USE_FORTIFY_LEVEL - 1, \
37 __glibc_objsize (str), __VA_ARGS__)
38#endif
39
40__fortify_function int
41__NTH (vsprintf (char *__restrict __s, const char *__restrict __fmt,
42 __gnuc_va_list __ap))
43{
44 return __builtin___vsprintf_chk (__s, __USE_FORTIFY_LEVEL - 1,
45 __glibc_objsize (__s), __fmt, __ap);
46}
47
48#if defined __USE_ISOC99 || defined __USE_UNIX98
49# ifdef __va_arg_pack
50__fortify_function int
51__NTH (snprintf (char *__restrict __s, size_t __n,
52 const char *__restrict __fmt, ...))
53{
54 return __builtin___snprintf_chk (__s, __n, __USE_FORTIFY_LEVEL - 1,
55 __glibc_objsize (__s), __fmt,
56 __va_arg_pack ());
57}
58# elif !defined __cplusplus
59# define snprintf(str, len, ...) \
60 __builtin___snprintf_chk (str, len, __USE_FORTIFY_LEVEL - 1, \
61 __glibc_objsize (str), __VA_ARGS__)
62# endif
63
64__fortify_function int
65__NTH (vsnprintf (char *__restrict __s, size_t __n,
66 const char *__restrict __fmt, __gnuc_va_list __ap))
67{
68 return __builtin___vsnprintf_chk (__s, __n, __USE_FORTIFY_LEVEL - 1,
69 __glibc_objsize (__s), __fmt, __ap);
70}
71
72#endif
73
74#if __USE_FORTIFY_LEVEL > 1
75# ifdef __va_arg_pack
76__fortify_function int
77fprintf (FILE *__restrict __stream, const char *__restrict __fmt, ...)
78{
79 return __fprintf_chk (__stream, __USE_FORTIFY_LEVEL - 1, __fmt,
80 __va_arg_pack ());
81}
82
83__fortify_function int
84printf (const char *__restrict __fmt, ...)
85{
86 return __printf_chk (__USE_FORTIFY_LEVEL - 1, __fmt, __va_arg_pack ());
87}
88# elif !defined __cplusplus
89# define printf(...) \
90 __printf_chk (__USE_FORTIFY_LEVEL - 1, __VA_ARGS__)
91# define fprintf(stream, ...) \
92 __fprintf_chk (stream, __USE_FORTIFY_LEVEL - 1, __VA_ARGS__)
93# endif
94
95__fortify_function int
96vprintf (const char *__restrict __fmt, __gnuc_va_list __ap)
97{
98#ifdef __USE_EXTERN_INLINES
99 return __vfprintf_chk (stdout, __USE_FORTIFY_LEVEL - 1, __fmt, __ap);
100#else
101 return __vprintf_chk (__USE_FORTIFY_LEVEL - 1, __fmt, __ap);
102#endif
103}
104
105__fortify_function int
106vfprintf (FILE *__restrict __stream,
107 const char *__restrict __fmt, __gnuc_va_list __ap)
108{
109 return __vfprintf_chk (__stream, __USE_FORTIFY_LEVEL - 1, __fmt, __ap);
110}
111
112# ifdef __USE_XOPEN2K8
113# ifdef __va_arg_pack
114__fortify_function int
115dprintf (int __fd, const char *__restrict __fmt, ...)
116{
117 return __dprintf_chk (__fd, __USE_FORTIFY_LEVEL - 1, __fmt,
118 __va_arg_pack ());
119}
120# elif !defined __cplusplus
121# define dprintf(fd, ...) \
122 __dprintf_chk (fd, __USE_FORTIFY_LEVEL - 1, __VA_ARGS__)
123# endif
124
125__fortify_function int
126vdprintf (int __fd, const char *__restrict __fmt, __gnuc_va_list __ap)
127{
128 return __vdprintf_chk (__fd, __USE_FORTIFY_LEVEL - 1, __fmt, __ap);
129}
130# endif
131
132# ifdef __USE_GNU
133# ifdef __va_arg_pack
134__fortify_function int
135__NTH (asprintf (char **__restrict __ptr, const char *__restrict __fmt, ...))
136{
137 return __asprintf_chk (__ptr, __USE_FORTIFY_LEVEL - 1, __fmt,
138 __va_arg_pack ());
139}
140
141__fortify_function int
142__NTH (__asprintf (char **__restrict __ptr, const char *__restrict __fmt,
143 ...))
144{
145 return __asprintf_chk (__ptr, __USE_FORTIFY_LEVEL - 1, __fmt,
146 __va_arg_pack ());
147}
148
149__fortify_function int
150__NTH (obstack_printf (struct obstack *__restrict __obstack,
151 const char *__restrict __fmt, ...))
152{
153 return __obstack_printf_chk (__obstack, __USE_FORTIFY_LEVEL - 1, __fmt,
154 __va_arg_pack ());
155}
156# elif !defined __cplusplus
157# define asprintf(ptr, ...) \
158 __asprintf_chk (ptr, __USE_FORTIFY_LEVEL - 1, __VA_ARGS__)
159# define __asprintf(ptr, ...) \
160 __asprintf_chk (ptr, __USE_FORTIFY_LEVEL - 1, __VA_ARGS__)
161# define obstack_printf(obstack, ...) \
162 __obstack_printf_chk (obstack, __USE_FORTIFY_LEVEL - 1, __VA_ARGS__)
163# endif
164
165__fortify_function int
166__NTH (vasprintf (char **__restrict __ptr, const char *__restrict __fmt,
167 __gnuc_va_list __ap))
168{
169 return __vasprintf_chk (__ptr, __USE_FORTIFY_LEVEL - 1, __fmt, __ap);
170}
171
172__fortify_function int
173__NTH (obstack_vprintf (struct obstack *__restrict __obstack,
174 const char *__restrict __fmt, __gnuc_va_list __ap))
175{
176 return __obstack_vprintf_chk (__obstack, __USE_FORTIFY_LEVEL - 1, __fmt,
177 __ap);
178}
179
180# endif
181
182#endif
183
184#if __GLIBC_USE (DEPRECATED_GETS)
185extern char *__REDIRECT (__gets_warn, (char *__str), gets)
186 __wur __warnattr ("please use fgets or getline instead, gets can't "
187 "specify buffer size");
188
189__fortify_function __wur char *
190gets (char *__str)
191{
192 if (__glibc_objsize (__str) != (size_t) -1)
193 return __gets_chk (__str, __glibc_objsize (__str));
194 return __gets_warn (__str);
195}
196#endif
197
198extern char *__REDIRECT (__fgets_alias,
199 (char *__restrict __s, int __n,
200 FILE *__restrict __stream), fgets)
201 __wur __attr_access ((__write_only__, 1, 2));
202extern char *__REDIRECT (__fgets_chk_warn,
203 (char *__restrict __s, size_t __size, int __n,
204 FILE *__restrict __stream), __fgets_chk)
205 __wur __warnattr ("fgets called with bigger size than length "
206 "of destination buffer");
207
208__fortify_function __wur __fortified_attr_access (__write_only__, 1, 2) char *
209fgets (char *__restrict __s, int __n, FILE *__restrict __stream)
210{
211 size_t sz = __glibc_objsize (__s);
212 if (__glibc_safe_or_unknown_len (__n, sizeof (char), sz))
213 return __fgets_alias (__s, __n, __stream);
214 if (__glibc_unsafe_len (__n, sizeof (char), sz))
215 return __fgets_chk_warn (__s, sz, __n, __stream);
216 return __fgets_chk (__s, sz, __n, __stream);
217}
218
219extern size_t __REDIRECT (__fread_alias,
220 (void *__restrict __ptr, size_t __size,
221 size_t __n, FILE *__restrict __stream),
222 fread) __wur;
223extern size_t __REDIRECT (__fread_chk_warn,
224 (void *__restrict __ptr, size_t __ptrlen,
225 size_t __size, size_t __n,
226 FILE *__restrict __stream),
227 __fread_chk)
228 __wur __warnattr ("fread called with bigger size * nmemb than length "
229 "of destination buffer");
230
231__fortify_function __wur size_t
232fread (void *__restrict __ptr, size_t __size, size_t __n,
233 FILE *__restrict __stream)
234{
235 size_t sz = __glibc_objsize0 (__ptr);
236 if (__glibc_safe_or_unknown_len (__n, __size, sz))
237 return __fread_alias (__ptr, __size, __n, __stream);
238 if (__glibc_unsafe_len (__n, __size, sz))
239 return __fread_chk_warn (__ptr, sz, __size, __n, __stream);
240 return __fread_chk (__ptr, sz, __size, __n, __stream);
241}
242
243#ifdef __USE_GNU
244extern char *__REDIRECT (__fgets_unlocked_alias,
245 (char *__restrict __s, int __n,
246 FILE *__restrict __stream), fgets_unlocked)
247 __wur __attr_access ((__write_only__, 1, 2));
248extern char *__REDIRECT (__fgets_unlocked_chk_warn,
249 (char *__restrict __s, size_t __size, int __n,
250 FILE *__restrict __stream), __fgets_unlocked_chk)
251 __wur __warnattr ("fgets_unlocked called with bigger size than length "
252 "of destination buffer");
253
254__fortify_function __wur __fortified_attr_access (__write_only__, 1, 2) char *
255fgets_unlocked (char *__restrict __s, int __n, FILE *__restrict __stream)
256{
257 size_t sz = __glibc_objsize (__s);
258 if (__glibc_safe_or_unknown_len (__n, sizeof (char), sz))
259 return __fgets_unlocked_alias (__s, __n, __stream);
260 if (__glibc_unsafe_len (__n, sizeof (char), sz))
261 return __fgets_unlocked_chk_warn (__s, sz, __n, __stream);
262 return __fgets_unlocked_chk (__s, sz, __n, __stream);
263}
264#endif
265
266#ifdef __USE_MISC
267# undef fread_unlocked
268extern size_t __REDIRECT (__fread_unlocked_alias,
269 (void *__restrict __ptr, size_t __size,
270 size_t __n, FILE *__restrict __stream),
271 fread_unlocked) __wur;
272extern size_t __REDIRECT (__fread_unlocked_chk_warn,
273 (void *__restrict __ptr, size_t __ptrlen,
274 size_t __size, size_t __n,
275 FILE *__restrict __stream),
276 __fread_unlocked_chk)
277 __wur __warnattr ("fread_unlocked called with bigger size * nmemb than "
278 "length of destination buffer");
279
280__fortify_function __wur size_t
281fread_unlocked (void *__restrict __ptr, size_t __size, size_t __n,
282 FILE *__restrict __stream)
283{
284 size_t sz = __glibc_objsize0 (__ptr);
285 if (__glibc_safe_or_unknown_len (__n, __size, sz))
286 {
287# ifdef __USE_EXTERN_INLINES
288 if (__builtin_constant_p (__size)
289 && __builtin_constant_p (__n)
290 && (__size | __n) < (((size_t) 1) << (8 * sizeof (size_t) / 2))
291 && __size * __n <= 8)
292 {
293 size_t __cnt = __size * __n;
294 char *__cptr = (char *) __ptr;
295 if (__cnt == 0)
296 return 0;
297
298 for (; __cnt > 0; --__cnt)
299 {
300 int __c = getc_unlocked (__stream);
301 if (__c == EOF)
302 break;
303 *__cptr++ = __c;
304 }
305 return (__cptr - (char *) __ptr) / __size;
306 }
307# endif
308 return __fread_unlocked_alias (__ptr, __size, __n, __stream);
309 }
310 if (__glibc_unsafe_len (__n, __size, sz))
311 return __fread_unlocked_chk_warn (__ptr, sz, __size, __n, __stream);
312 return __fread_unlocked_chk (__ptr, sz, __size, __n, __stream);
313
314}
315#endif
316
317#endif /* bits/stdio2.h. */
318