xref: /linux-6.15/include/linux/fortify-string.h (revision 1d02f252)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _LINUX_FORTIFY_STRING_H_
3 #define _LINUX_FORTIFY_STRING_H_
4 
5 #include <linux/bug.h>
6 #include <linux/const.h>
7 #include <linux/limits.h>
8 
9 #define __FORTIFY_INLINE extern __always_inline __gnu_inline __overloadable
10 #define __RENAME(x) __asm__(#x)
11 
12 void fortify_panic(const char *name) __noreturn __cold;
13 void __read_overflow(void) __compiletime_error("detected read beyond size of object (1st parameter)");
14 void __read_overflow2(void) __compiletime_error("detected read beyond size of object (2nd parameter)");
15 void __read_overflow2_field(size_t avail, size_t wanted) __compiletime_warning("detected read beyond size of field (2nd parameter); maybe use struct_group()?");
16 void __write_overflow(void) __compiletime_error("detected write beyond size of object (1st parameter)");
17 void __write_overflow_field(size_t avail, size_t wanted) __compiletime_warning("detected write beyond size of field (1st parameter); maybe use struct_group()?");
18 
19 #define __compiletime_strlen(p)					\
20 ({								\
21 	char *__p = (char *)(p);				\
22 	size_t __ret = SIZE_MAX;				\
23 	const size_t __p_size = __member_size(p);		\
24 	if (__p_size != SIZE_MAX &&				\
25 	    __builtin_constant_p(*__p)) {			\
26 		size_t __p_len = __p_size - 1;			\
27 		if (__builtin_constant_p(__p[__p_len]) &&	\
28 		    __p[__p_len] == '\0')			\
29 			__ret = __builtin_strlen(__p);		\
30 	}							\
31 	__ret;							\
32 })
33 
34 #if defined(CONFIG_KASAN_GENERIC) || defined(CONFIG_KASAN_SW_TAGS)
35 extern void *__underlying_memchr(const void *p, int c, __kernel_size_t size) __RENAME(memchr);
36 extern int __underlying_memcmp(const void *p, const void *q, __kernel_size_t size) __RENAME(memcmp);
37 extern void *__underlying_memcpy(void *p, const void *q, __kernel_size_t size) __RENAME(memcpy);
38 extern void *__underlying_memmove(void *p, const void *q, __kernel_size_t size) __RENAME(memmove);
39 extern void *__underlying_memset(void *p, int c, __kernel_size_t size) __RENAME(memset);
40 extern char *__underlying_strcat(char *p, const char *q) __RENAME(strcat);
41 extern char *__underlying_strcpy(char *p, const char *q) __RENAME(strcpy);
42 extern __kernel_size_t __underlying_strlen(const char *p) __RENAME(strlen);
43 extern char *__underlying_strncat(char *p, const char *q, __kernel_size_t count) __RENAME(strncat);
44 extern char *__underlying_strncpy(char *p, const char *q, __kernel_size_t size) __RENAME(strncpy);
45 #else
46 
47 #if defined(__SANITIZE_MEMORY__)
48 /*
49  * For KMSAN builds all memcpy/memset/memmove calls should be replaced by the
50  * corresponding __msan_XXX functions.
51  */
52 #include <linux/kmsan_string.h>
53 #define __underlying_memcpy	__msan_memcpy
54 #define __underlying_memmove	__msan_memmove
55 #define __underlying_memset	__msan_memset
56 #else
57 #define __underlying_memcpy	__builtin_memcpy
58 #define __underlying_memmove	__builtin_memmove
59 #define __underlying_memset	__builtin_memset
60 #endif
61 
62 #define __underlying_memchr	__builtin_memchr
63 #define __underlying_memcmp	__builtin_memcmp
64 #define __underlying_strcat	__builtin_strcat
65 #define __underlying_strcpy	__builtin_strcpy
66 #define __underlying_strlen	__builtin_strlen
67 #define __underlying_strncat	__builtin_strncat
68 #define __underlying_strncpy	__builtin_strncpy
69 #endif
70 
71 /**
72  * unsafe_memcpy - memcpy implementation with no FORTIFY bounds checking
73  *
74  * @dst: Destination memory address to write to
75  * @src: Source memory address to read from
76  * @bytes: How many bytes to write to @dst from @src
77  * @justification: Free-form text or comment describing why the use is needed
78  *
79  * This should be used for corner cases where the compiler cannot do the
80  * right thing, or during transitions between APIs, etc. It should be used
81  * very rarely, and includes a place for justification detailing where bounds
82  * checking has happened, and why existing solutions cannot be employed.
83  */
84 #define unsafe_memcpy(dst, src, bytes, justification)		\
85 	__underlying_memcpy(dst, src, bytes)
86 
87 /*
88  * Clang's use of __builtin_*object_size() within inlines needs hinting via
89  * __pass_*object_size(). The preference is to only ever use type 1 (member
90  * size, rather than struct size), but there remain some stragglers using
91  * type 0 that will be converted in the future.
92  */
93 #if __has_builtin(__builtin_dynamic_object_size)
94 #define POS			__pass_dynamic_object_size(1)
95 #define POS0			__pass_dynamic_object_size(0)
96 #else
97 #define POS			__pass_object_size(1)
98 #define POS0			__pass_object_size(0)
99 #endif
100 
101 #define __compiletime_lessthan(bounds, length)	(	\
102 	__builtin_constant_p((bounds) < (length)) &&	\
103 	(bounds) < (length)				\
104 )
105 
106 /**
107  * strncpy - Copy a string to memory with non-guaranteed NUL padding
108  *
109  * @p: pointer to destination of copy
110  * @q: pointer to NUL-terminated source string to copy
111  * @size: bytes to write at @p
112  *
113  * If strlen(@q) >= @size, the copy of @q will stop after @size bytes,
114  * and @p will NOT be NUL-terminated
115  *
116  * If strlen(@q) < @size, following the copy of @q, trailing NUL bytes
117  * will be written to @p until @size total bytes have been written.
118  *
119  * Do not use this function. While FORTIFY_SOURCE tries to avoid
120  * over-reads of @q, it cannot defend against writing unterminated
121  * results to @p. Using strncpy() remains ambiguous and fragile.
122  * Instead, please choose an alternative, so that the expectation
123  * of @p's contents is unambiguous:
124  *
125  * +--------------------+--------------------+------------+
126  * | **p** needs to be: | padded to **size** | not padded |
127  * +====================+====================+============+
128  * |     NUL-terminated | strscpy_pad()      | strscpy()  |
129  * +--------------------+--------------------+------------+
130  * | not NUL-terminated | strtomem_pad()     | strtomem() |
131  * +--------------------+--------------------+------------+
132  *
133  * Note strscpy*()'s differing return values for detecting truncation,
134  * and strtomem*()'s expectation that the destination is marked with
135  * __nonstring when it is a character array.
136  *
137  */
138 __FORTIFY_INLINE __diagnose_as(__builtin_strncpy, 1, 2, 3)
139 char *strncpy(char * const POS p, const char *q, __kernel_size_t size)
140 {
141 	const size_t p_size = __member_size(p);
142 
143 	if (__compiletime_lessthan(p_size, size))
144 		__write_overflow();
145 	if (p_size < size)
146 		fortify_panic(__func__);
147 	return __underlying_strncpy(p, q, size);
148 }
149 
150 extern __kernel_size_t __real_strnlen(const char *, __kernel_size_t) __RENAME(strnlen);
151 /**
152  * strnlen - Return bounded count of characters in a NUL-terminated string
153  *
154  * @p: pointer to NUL-terminated string to count.
155  * @maxlen: maximum number of characters to count.
156  *
157  * Returns number of characters in @p (NOT including the final NUL), or
158  * @maxlen, if no NUL has been found up to there.
159  *
160  */
161 __FORTIFY_INLINE __kernel_size_t strnlen(const char * const POS p, __kernel_size_t maxlen)
162 {
163 	const size_t p_size = __member_size(p);
164 	const size_t p_len = __compiletime_strlen(p);
165 	size_t ret;
166 
167 	/* We can take compile-time actions when maxlen is const. */
168 	if (__builtin_constant_p(maxlen) && p_len != SIZE_MAX) {
169 		/* If p is const, we can use its compile-time-known len. */
170 		if (maxlen >= p_size)
171 			return p_len;
172 	}
173 
174 	/* Do not check characters beyond the end of p. */
175 	ret = __real_strnlen(p, maxlen < p_size ? maxlen : p_size);
176 	if (p_size <= ret && maxlen != ret)
177 		fortify_panic(__func__);
178 	return ret;
179 }
180 
181 /*
182  * Defined after fortified strnlen to reuse it. However, it must still be
183  * possible for strlen() to be used on compile-time strings for use in
184  * static initializers (i.e. as a constant expression).
185  */
186 /**
187  * strlen - Return count of characters in a NUL-terminated string
188  *
189  * @p: pointer to NUL-terminated string to count.
190  *
191  * Do not use this function unless the string length is known at
192  * compile-time. When @p is unterminated, this function may crash
193  * or return unexpected counts that could lead to memory content
194  * exposures. Prefer strnlen().
195  *
196  * Returns number of characters in @p (NOT including the final NUL).
197  *
198  */
199 #define strlen(p)							\
200 	__builtin_choose_expr(__is_constexpr(__builtin_strlen(p)),	\
201 		__builtin_strlen(p), __fortify_strlen(p))
202 __FORTIFY_INLINE __diagnose_as(__builtin_strlen, 1)
203 __kernel_size_t __fortify_strlen(const char * const POS p)
204 {
205 	const size_t p_size = __member_size(p);
206 	__kernel_size_t ret;
207 
208 	/* Give up if we don't know how large p is. */
209 	if (p_size == SIZE_MAX)
210 		return __underlying_strlen(p);
211 	ret = strnlen(p, p_size);
212 	if (p_size <= ret)
213 		fortify_panic(__func__);
214 	return ret;
215 }
216 
217 /* Defined after fortified strnlen() to reuse it. */
218 extern ssize_t __real_strscpy(char *, const char *, size_t) __RENAME(sized_strscpy);
219 __FORTIFY_INLINE ssize_t sized_strscpy(char * const POS p, const char * const POS q, size_t size)
220 {
221 	/* Use string size rather than possible enclosing struct size. */
222 	const size_t p_size = __member_size(p);
223 	const size_t q_size = __member_size(q);
224 	size_t len;
225 
226 	/* If we cannot get size of p and q default to call strscpy. */
227 	if (p_size == SIZE_MAX && q_size == SIZE_MAX)
228 		return __real_strscpy(p, q, size);
229 
230 	/*
231 	 * If size can be known at compile time and is greater than
232 	 * p_size, generate a compile time write overflow error.
233 	 */
234 	if (__compiletime_lessthan(p_size, size))
235 		__write_overflow();
236 
237 	/* Short-circuit for compile-time known-safe lengths. */
238 	if (__compiletime_lessthan(p_size, SIZE_MAX)) {
239 		len = __compiletime_strlen(q);
240 
241 		if (len < SIZE_MAX && __compiletime_lessthan(len, size)) {
242 			__underlying_memcpy(p, q, len + 1);
243 			return len;
244 		}
245 	}
246 
247 	/*
248 	 * This call protects from read overflow, because len will default to q
249 	 * length if it smaller than size.
250 	 */
251 	len = strnlen(q, size);
252 	/*
253 	 * If len equals size, we will copy only size bytes which leads to
254 	 * -E2BIG being returned.
255 	 * Otherwise we will copy len + 1 because of the final '\O'.
256 	 */
257 	len = len == size ? size : len + 1;
258 
259 	/*
260 	 * Generate a runtime write overflow error if len is greater than
261 	 * p_size.
262 	 */
263 	if (len > p_size)
264 		fortify_panic(__func__);
265 
266 	/*
267 	 * We can now safely call vanilla strscpy because we are protected from:
268 	 * 1. Read overflow thanks to call to strnlen().
269 	 * 2. Write overflow thanks to above ifs.
270 	 */
271 	return __real_strscpy(p, q, len);
272 }
273 
274 /* Defined after fortified strlen() to reuse it. */
275 extern size_t __real_strlcat(char *p, const char *q, size_t avail) __RENAME(strlcat);
276 /**
277  * strlcat - Append a string to an existing string
278  *
279  * @p: pointer to %NUL-terminated string to append to
280  * @q: pointer to %NUL-terminated string to append from
281  * @avail: Maximum bytes available in @p
282  *
283  * Appends %NUL-terminated string @q after the %NUL-terminated
284  * string at @p, but will not write beyond @avail bytes total,
285  * potentially truncating the copy from @q. @p will stay
286  * %NUL-terminated only if a %NUL already existed within
287  * the @avail bytes of @p. If so, the resulting number of
288  * bytes copied from @q will be at most "@avail - strlen(@p) - 1".
289  *
290  * Do not use this function. While FORTIFY_SOURCE tries to avoid
291  * read and write overflows, this is only possible when the sizes
292  * of @p and @q are known to the compiler. Prefer building the
293  * string with formatting, via scnprintf(), seq_buf, or similar.
294  *
295  * Returns total bytes that _would_ have been contained by @p
296  * regardless of truncation, similar to snprintf(). If return
297  * value is >= @avail, the string has been truncated.
298  *
299  */
300 __FORTIFY_INLINE
301 size_t strlcat(char * const POS p, const char * const POS q, size_t avail)
302 {
303 	const size_t p_size = __member_size(p);
304 	const size_t q_size = __member_size(q);
305 	size_t p_len, copy_len;
306 	size_t actual, wanted;
307 
308 	/* Give up immediately if both buffer sizes are unknown. */
309 	if (p_size == SIZE_MAX && q_size == SIZE_MAX)
310 		return __real_strlcat(p, q, avail);
311 
312 	p_len = strnlen(p, avail);
313 	copy_len = strlen(q);
314 	wanted = actual = p_len + copy_len;
315 
316 	/* Cannot append any more: report truncation. */
317 	if (avail <= p_len)
318 		return wanted;
319 
320 	/* Give up if string is already overflowed. */
321 	if (p_size <= p_len)
322 		fortify_panic(__func__);
323 
324 	if (actual >= avail) {
325 		copy_len = avail - p_len - 1;
326 		actual = p_len + copy_len;
327 	}
328 
329 	/* Give up if copy will overflow. */
330 	if (p_size <= actual)
331 		fortify_panic(__func__);
332 	__underlying_memcpy(p + p_len, q, copy_len);
333 	p[actual] = '\0';
334 
335 	return wanted;
336 }
337 
338 /* Defined after fortified strlcat() to reuse it. */
339 /**
340  * strcat - Append a string to an existing string
341  *
342  * @p: pointer to NUL-terminated string to append to
343  * @q: pointer to NUL-terminated source string to append from
344  *
345  * Do not use this function. While FORTIFY_SOURCE tries to avoid
346  * read and write overflows, this is only possible when the
347  * destination buffer size is known to the compiler. Prefer
348  * building the string with formatting, via scnprintf() or similar.
349  * At the very least, use strncat().
350  *
351  * Returns @p.
352  *
353  */
354 __FORTIFY_INLINE __diagnose_as(__builtin_strcat, 1, 2)
355 char *strcat(char * const POS p, const char *q)
356 {
357 	const size_t p_size = __member_size(p);
358 
359 	if (strlcat(p, q, p_size) >= p_size)
360 		fortify_panic(__func__);
361 	return p;
362 }
363 
364 /**
365  * strncat - Append a string to an existing string
366  *
367  * @p: pointer to NUL-terminated string to append to
368  * @q: pointer to source string to append from
369  * @count: Maximum bytes to read from @q
370  *
371  * Appends at most @count bytes from @q (stopping at the first
372  * NUL byte) after the NUL-terminated string at @p. @p will be
373  * NUL-terminated.
374  *
375  * Do not use this function. While FORTIFY_SOURCE tries to avoid
376  * read and write overflows, this is only possible when the sizes
377  * of @p and @q are known to the compiler. Prefer building the
378  * string with formatting, via scnprintf() or similar.
379  *
380  * Returns @p.
381  *
382  */
383 /* Defined after fortified strlen() and strnlen() to reuse them. */
384 __FORTIFY_INLINE __diagnose_as(__builtin_strncat, 1, 2, 3)
385 char *strncat(char * const POS p, const char * const POS q, __kernel_size_t count)
386 {
387 	const size_t p_size = __member_size(p);
388 	const size_t q_size = __member_size(q);
389 	size_t p_len, copy_len;
390 
391 	if (p_size == SIZE_MAX && q_size == SIZE_MAX)
392 		return __underlying_strncat(p, q, count);
393 	p_len = strlen(p);
394 	copy_len = strnlen(q, count);
395 	if (p_size < p_len + copy_len + 1)
396 		fortify_panic(__func__);
397 	__underlying_memcpy(p + p_len, q, copy_len);
398 	p[p_len + copy_len] = '\0';
399 	return p;
400 }
401 
402 __FORTIFY_INLINE void fortify_memset_chk(__kernel_size_t size,
403 					 const size_t p_size,
404 					 const size_t p_size_field)
405 {
406 	if (__builtin_constant_p(size)) {
407 		/*
408 		 * Length argument is a constant expression, so we
409 		 * can perform compile-time bounds checking where
410 		 * buffer sizes are also known at compile time.
411 		 */
412 
413 		/* Error when size is larger than enclosing struct. */
414 		if (__compiletime_lessthan(p_size_field, p_size) &&
415 		    __compiletime_lessthan(p_size, size))
416 			__write_overflow();
417 
418 		/* Warn when write size is larger than dest field. */
419 		if (__compiletime_lessthan(p_size_field, size))
420 			__write_overflow_field(p_size_field, size);
421 	}
422 	/*
423 	 * At this point, length argument may not be a constant expression,
424 	 * so run-time bounds checking can be done where buffer sizes are
425 	 * known. (This is not an "else" because the above checks may only
426 	 * be compile-time warnings, and we want to still warn for run-time
427 	 * overflows.)
428 	 */
429 
430 	/*
431 	 * Always stop accesses beyond the struct that contains the
432 	 * field, when the buffer's remaining size is known.
433 	 * (The SIZE_MAX test is to optimize away checks where the buffer
434 	 * lengths are unknown.)
435 	 */
436 	if (p_size != SIZE_MAX && p_size < size)
437 		fortify_panic("memset");
438 }
439 
440 #define __fortify_memset_chk(p, c, size, p_size, p_size_field) ({	\
441 	size_t __fortify_size = (size_t)(size);				\
442 	fortify_memset_chk(__fortify_size, p_size, p_size_field),	\
443 	__underlying_memset(p, c, __fortify_size);			\
444 })
445 
446 /*
447  * __struct_size() vs __member_size() must be captured here to avoid
448  * evaluating argument side-effects further into the macro layers.
449  */
450 #ifndef CONFIG_KMSAN
451 #define memset(p, c, s) __fortify_memset_chk(p, c, s,			\
452 		__struct_size(p), __member_size(p))
453 #endif
454 
455 /*
456  * To make sure the compiler can enforce protection against buffer overflows,
457  * memcpy(), memmove(), and memset() must not be used beyond individual
458  * struct members. If you need to copy across multiple members, please use
459  * struct_group() to create a named mirror of an anonymous struct union.
460  * (e.g. see struct sk_buff.) Read overflow checking is currently only
461  * done when a write overflow is also present, or when building with W=1.
462  *
463  * Mitigation coverage matrix
464  *					Bounds checking at:
465  *					+-------+-------+-------+-------+
466  *					| Compile time  |   Run time    |
467  * memcpy() argument sizes:		| write | read  | write | read  |
468  *        dest     source   length      +-------+-------+-------+-------+
469  * memcpy(known,   known,   constant)	|   y   |   y   |  n/a  |  n/a  |
470  * memcpy(known,   unknown, constant)	|   y   |   n   |  n/a  |   V   |
471  * memcpy(known,   known,   dynamic)	|   n   |   n   |   B   |   B   |
472  * memcpy(known,   unknown, dynamic)	|   n   |   n   |   B   |   V   |
473  * memcpy(unknown, known,   constant)	|   n   |   y   |   V   |  n/a  |
474  * memcpy(unknown, unknown, constant)	|   n   |   n   |   V   |   V   |
475  * memcpy(unknown, known,   dynamic)	|   n   |   n   |   V   |   B   |
476  * memcpy(unknown, unknown, dynamic)	|   n   |   n   |   V   |   V   |
477  *					+-------+-------+-------+-------+
478  *
479  * y = perform deterministic compile-time bounds checking
480  * n = cannot perform deterministic compile-time bounds checking
481  * n/a = no run-time bounds checking needed since compile-time deterministic
482  * B = can perform run-time bounds checking (currently unimplemented)
483  * V = vulnerable to run-time overflow (will need refactoring to solve)
484  *
485  */
486 __FORTIFY_INLINE bool fortify_memcpy_chk(__kernel_size_t size,
487 					 const size_t p_size,
488 					 const size_t q_size,
489 					 const size_t p_size_field,
490 					 const size_t q_size_field,
491 					 const char *func)
492 {
493 	if (__builtin_constant_p(size)) {
494 		/*
495 		 * Length argument is a constant expression, so we
496 		 * can perform compile-time bounds checking where
497 		 * buffer sizes are also known at compile time.
498 		 */
499 
500 		/* Error when size is larger than enclosing struct. */
501 		if (__compiletime_lessthan(p_size_field, p_size) &&
502 		    __compiletime_lessthan(p_size, size))
503 			__write_overflow();
504 		if (__compiletime_lessthan(q_size_field, q_size) &&
505 		    __compiletime_lessthan(q_size, size))
506 			__read_overflow2();
507 
508 		/* Warn when write size argument larger than dest field. */
509 		if (__compiletime_lessthan(p_size_field, size))
510 			__write_overflow_field(p_size_field, size);
511 		/*
512 		 * Warn for source field over-read when building with W=1
513 		 * or when an over-write happened, so both can be fixed at
514 		 * the same time.
515 		 */
516 		if ((IS_ENABLED(KBUILD_EXTRA_WARN1) ||
517 		     __compiletime_lessthan(p_size_field, size)) &&
518 		    __compiletime_lessthan(q_size_field, size))
519 			__read_overflow2_field(q_size_field, size);
520 	}
521 	/*
522 	 * At this point, length argument may not be a constant expression,
523 	 * so run-time bounds checking can be done where buffer sizes are
524 	 * known. (This is not an "else" because the above checks may only
525 	 * be compile-time warnings, and we want to still warn for run-time
526 	 * overflows.)
527 	 */
528 
529 	/*
530 	 * Always stop accesses beyond the struct that contains the
531 	 * field, when the buffer's remaining size is known.
532 	 * (The SIZE_MAX test is to optimize away checks where the buffer
533 	 * lengths are unknown.)
534 	 */
535 	if ((p_size != SIZE_MAX && p_size < size) ||
536 	    (q_size != SIZE_MAX && q_size < size))
537 		fortify_panic(func);
538 
539 	/*
540 	 * Warn when writing beyond destination field size.
541 	 *
542 	 * We must ignore p_size_field == 0 for existing 0-element
543 	 * fake flexible arrays, until they are all converted to
544 	 * proper flexible arrays.
545 	 *
546 	 * The implementation of __builtin_*object_size() behaves
547 	 * like sizeof() when not directly referencing a flexible
548 	 * array member, which means there will be many bounds checks
549 	 * that will appear at run-time, without a way for them to be
550 	 * detected at compile-time (as can be done when the destination
551 	 * is specifically the flexible array member).
552 	 * https://gcc.gnu.org/bugzilla/show_bug.cgi?id=101832
553 	 */
554 	if (p_size_field != 0 && p_size_field != SIZE_MAX &&
555 	    p_size != p_size_field && p_size_field < size)
556 		return true;
557 
558 	return false;
559 }
560 
561 #define __fortify_memcpy_chk(p, q, size, p_size, q_size,		\
562 			     p_size_field, q_size_field, op) ({		\
563 	const size_t __fortify_size = (size_t)(size);			\
564 	const size_t __p_size = (p_size);				\
565 	const size_t __q_size = (q_size);				\
566 	const size_t __p_size_field = (p_size_field);			\
567 	const size_t __q_size_field = (q_size_field);			\
568 	WARN_ONCE(fortify_memcpy_chk(__fortify_size, __p_size,		\
569 				     __q_size, __p_size_field,		\
570 				     __q_size_field, #op),		\
571 		  #op ": detected field-spanning write (size %zu) of single %s (size %zu)\n", \
572 		  __fortify_size,					\
573 		  "field \"" #p "\" at " FILE_LINE,			\
574 		  __p_size_field);					\
575 	__underlying_##op(p, q, __fortify_size);			\
576 })
577 
578 /*
579  * Notes about compile-time buffer size detection:
580  *
581  * With these types...
582  *
583  *	struct middle {
584  *		u16 a;
585  *		u8 middle_buf[16];
586  *		int b;
587  *	};
588  *	struct end {
589  *		u16 a;
590  *		u8 end_buf[16];
591  *	};
592  *	struct flex {
593  *		int a;
594  *		u8 flex_buf[];
595  *	};
596  *
597  *	void func(TYPE *ptr) { ... }
598  *
599  * Cases where destination size cannot be currently detected:
600  * - the size of ptr's object (seemingly by design, gcc & clang fail):
601  *	__builtin_object_size(ptr, 1) == SIZE_MAX
602  * - the size of flexible arrays in ptr's obj (by design, dynamic size):
603  *	__builtin_object_size(ptr->flex_buf, 1) == SIZE_MAX
604  * - the size of ANY array at the end of ptr's obj (gcc and clang bug):
605  *	__builtin_object_size(ptr->end_buf, 1) == SIZE_MAX
606  *	https://gcc.gnu.org/bugzilla/show_bug.cgi?id=101836
607  *
608  * Cases where destination size is currently detected:
609  * - the size of non-array members within ptr's object:
610  *	__builtin_object_size(ptr->a, 1) == 2
611  * - the size of non-flexible-array in the middle of ptr's obj:
612  *	__builtin_object_size(ptr->middle_buf, 1) == 16
613  *
614  */
615 
616 /*
617  * __struct_size() vs __member_size() must be captured here to avoid
618  * evaluating argument side-effects further into the macro layers.
619  */
620 #define memcpy(p, q, s)  __fortify_memcpy_chk(p, q, s,			\
621 		__struct_size(p), __struct_size(q),			\
622 		__member_size(p), __member_size(q),			\
623 		memcpy)
624 #define memmove(p, q, s)  __fortify_memcpy_chk(p, q, s,			\
625 		__struct_size(p), __struct_size(q),			\
626 		__member_size(p), __member_size(q),			\
627 		memmove)
628 
629 extern void *__real_memscan(void *, int, __kernel_size_t) __RENAME(memscan);
630 __FORTIFY_INLINE void *memscan(void * const POS0 p, int c, __kernel_size_t size)
631 {
632 	const size_t p_size = __struct_size(p);
633 
634 	if (__compiletime_lessthan(p_size, size))
635 		__read_overflow();
636 	if (p_size < size)
637 		fortify_panic(__func__);
638 	return __real_memscan(p, c, size);
639 }
640 
641 __FORTIFY_INLINE __diagnose_as(__builtin_memcmp, 1, 2, 3)
642 int memcmp(const void * const POS0 p, const void * const POS0 q, __kernel_size_t size)
643 {
644 	const size_t p_size = __struct_size(p);
645 	const size_t q_size = __struct_size(q);
646 
647 	if (__builtin_constant_p(size)) {
648 		if (__compiletime_lessthan(p_size, size))
649 			__read_overflow();
650 		if (__compiletime_lessthan(q_size, size))
651 			__read_overflow2();
652 	}
653 	if (p_size < size || q_size < size)
654 		fortify_panic(__func__);
655 	return __underlying_memcmp(p, q, size);
656 }
657 
658 __FORTIFY_INLINE __diagnose_as(__builtin_memchr, 1, 2, 3)
659 void *memchr(const void * const POS0 p, int c, __kernel_size_t size)
660 {
661 	const size_t p_size = __struct_size(p);
662 
663 	if (__compiletime_lessthan(p_size, size))
664 		__read_overflow();
665 	if (p_size < size)
666 		fortify_panic(__func__);
667 	return __underlying_memchr(p, c, size);
668 }
669 
670 void *__real_memchr_inv(const void *s, int c, size_t n) __RENAME(memchr_inv);
671 __FORTIFY_INLINE void *memchr_inv(const void * const POS0 p, int c, size_t size)
672 {
673 	const size_t p_size = __struct_size(p);
674 
675 	if (__compiletime_lessthan(p_size, size))
676 		__read_overflow();
677 	if (p_size < size)
678 		fortify_panic(__func__);
679 	return __real_memchr_inv(p, c, size);
680 }
681 
682 extern void *__real_kmemdup(const void *src, size_t len, gfp_t gfp) __RENAME(kmemdup)
683 								    __realloc_size(2);
684 __FORTIFY_INLINE void *kmemdup(const void * const POS0 p, size_t size, gfp_t gfp)
685 {
686 	const size_t p_size = __struct_size(p);
687 
688 	if (__compiletime_lessthan(p_size, size))
689 		__read_overflow();
690 	if (p_size < size)
691 		fortify_panic(__func__);
692 	return __real_kmemdup(p, size, gfp);
693 }
694 
695 /**
696  * strcpy - Copy a string into another string buffer
697  *
698  * @p: pointer to destination of copy
699  * @q: pointer to NUL-terminated source string to copy
700  *
701  * Do not use this function. While FORTIFY_SOURCE tries to avoid
702  * overflows, this is only possible when the sizes of @q and @p are
703  * known to the compiler. Prefer strscpy(), though note its different
704  * return values for detecting truncation.
705  *
706  * Returns @p.
707  *
708  */
709 /* Defined after fortified strlen to reuse it. */
710 __FORTIFY_INLINE __diagnose_as(__builtin_strcpy, 1, 2)
711 char *strcpy(char * const POS p, const char * const POS q)
712 {
713 	const size_t p_size = __member_size(p);
714 	const size_t q_size = __member_size(q);
715 	size_t size;
716 
717 	/* If neither buffer size is known, immediately give up. */
718 	if (__builtin_constant_p(p_size) &&
719 	    __builtin_constant_p(q_size) &&
720 	    p_size == SIZE_MAX && q_size == SIZE_MAX)
721 		return __underlying_strcpy(p, q);
722 	size = strlen(q) + 1;
723 	/* Compile-time check for const size overflow. */
724 	if (__compiletime_lessthan(p_size, size))
725 		__write_overflow();
726 	/* Run-time check for dynamic size overflow. */
727 	if (p_size < size)
728 		fortify_panic(__func__);
729 	__underlying_memcpy(p, q, size);
730 	return p;
731 }
732 
733 /* Don't use these outside the FORITFY_SOURCE implementation */
734 #undef __underlying_memchr
735 #undef __underlying_memcmp
736 #undef __underlying_strcat
737 #undef __underlying_strcpy
738 #undef __underlying_strlen
739 #undef __underlying_strncat
740 #undef __underlying_strncpy
741 
742 #undef POS
743 #undef POS0
744 
745 #endif /* _LINUX_FORTIFY_STRING_H_ */
746