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