Add function attribute to copy_from_user to warn for unchecked results
Hi,
gcc 3.4 (CVS) has a new function attribute (warn_unused_result) that
will make gcc spit out a warning in the event that a "marked" function's result is ignored by the caller. The patch below adds a #define for this attribute (conditional on compiler version), and uses this for copy_from_user() and copy_to_user().
Callers of either of these functions basically are required for checking the return value (quite often a missing check can be a security hole), now gcc will
generate a warning for this. Hopefully this will prevent future (security) bugs due to this happening.
Greetings,
Arjan van de Ven
include/asm-i386/uaccess.h renamed from include.org/asm-i386/uaccess.h +7 -6
@@ -9,6 +9,7 @@#include <linux/thread_info.h> #include <linux/prefetch.h> #include <linux/string.h> +#include <linux/compiler.h> #include <asm/page.h> #define VERIFY_READ 0
@@ -371,8 +371,8 @@ do { \ : "m"(__m(addr)), "i"(errret), "0"(err)) -unsigned long __copy_to_user_ll (void __user *to,const void *from,unsigned long n); -unsigned long __copy_from_user_ll (void *to,const void __user *from,unsigned long n); +unsigned long __must_check __copy_to_user_ll (void __user *to,const void *from,unsigned long n); +unsigned long __must_check __copy_from_user_ll (void *to,const void __user *from,unsigned long n);/* * Here we special-case 1, 2 and 4-byte copy_*_user invocations. On a fault
@@ -395,7 +395,7 @@ unsigned long __copy_from_user_ll(void ** Returns number of bytes that could not be copied. * On success, this will be zero. */ -static inline unsigned long +static inline unsigned long __must_check __copy_to_user (void __user *to,const void *from,unsigned long n) {if (__builtin_constant_p (n)) {
@@ -433,7 +433,7 @@ __copy_to_user(void __user *to, const vo* If some data could not be copied, this function will pad the copied * data to the requested size using zero bytes. */ -static inline unsigned long +static inline unsigned long __must_check __copy_from_user (void *to,const void __user *from,unsigned long n) {if (__builtin_constant_p (n)) {
@@ -467,7 +467,7 @@ __copy_from_user(void *to, const void __* Returns number of bytes that could not be copied. * On success, this will be zero. */ -static inline unsigned long +static inline unsigned long __must_check copy_to_user (void __user *to,const void *from,unsigned long n) {might_sleep ();
@@ -492,7 +492,7 @@ copy_to_user(void __user *to, const void* If some data could not be copied, this function will pad the copied * data to the requested size using zero bytes. */ -static inline unsigned long +static inline unsigned long __must_check copy_from_user (void *to,const void __user *from,unsigned long n) {might_sleep ();
include/linux/compiler.h renamed from include.org/linux/compiler.h +11 -0
@@ -15,6 +15,17 @@#define __inline __inline__ __attribute__((always_inline))#endif +/* +* GCC 3.4 and later have an attribute to mark a function in a way +* that if the calling code does not look at the return value, a warning +* is generated. Useful for things like copy_from_user(). +*/ +#if (__GNUC__ >3 ) || (__GNUC__ ==3 && __GNUC_MINOR__ >=4 ) +#define __must_check __attribute__((warn_unused_result)) +#else +#define __must_check +#endif +/* Somewhere in the middle of the GCC 2.96 development cycle, we implemented a mechanism by which the user can annotate likely branch directions and expect the blocks to be reordered appropriately. Define __builtin_expect
include/linux/poll.h renamed from include/linux/poll.h~ +3 -1
@@ -81,11 +81,13 @@return 0 ; } +/* warning: this function has no way to return -EFAULT on bad userspace access */ static inline void set_fd_set (unsigned long nr,void __user *ufdset,unsigned long *fdset) { +int dummy;if (ufdset) -__copy_to_user (ufdset, fdset,FDS_BYTES (nr)); + dummy =__copy_to_user (ufdset, fdset,FDS_BYTES (nr)); } static inline
Quoted 6 lines · Arjan van de Ven
Hi,
gcc 3.4 (CVS) has a new function attribute (
warn_unused_result) that will make gcc spit out a warning in the event that a "marked" function's result is ignored by the caller.
Nice.
include/linux/poll.h line 91
Quoted 10 lines
include/linux/poll.h renamed from include/linux/poll.h~ +3
-1+/* warning: this function has no way to return -EFAULT on bad userspace access */ static inline void set_fd_set (unsigned long nr,void __user *ufdset,unsigned long *fdset) { +int dummy;if (ufdset) -__copy_to_user (ufdset, fdset,FDS_BYTES (nr)); + dummy =__copy_to_user (ufdset, fdset,FDS_BYTES (nr)); }
Wouldn't it be neater to make this return the __copy_to_user() result? And to mark it __must_check? And to fix the bug you just found in sys_select()? ;)
Quoted 9 lines · Andrew Morton
Quoted 6 lines · Arjan van de Ven
Hi,
gcc 3.4 (CVS) has a new function attribute (
warn_unused_result) that will make gcc spit out a warning in the event that a "marked" function's result is ignored by the caller.Nice.
Note that for macros like get_user something like this should be used (as the attribute is only for functions):
extern inline __must_check int check_int_result (int arg) { return arg; }
#define get_user(x,ptr) \
check_int_result ( ({ \
int __ret_gu,__val_gu; \
switch(sizeof (*(ptr))) { \
case 1: __get_user_x(1,__ret_gu,__val_gu,ptr); break; \
case 2: __get_user_x(2,__ret_gu,__val_gu,ptr); break; \
case 4: __get_user_x(4,__ret_gu,__val_gu,ptr); break; \
default: __get_user_x(X,__ret_gu,__val_gu,ptr); break; \
} \
(x) = (__typeof__(*(ptr)))__val_gu; \
__ret_gu; \
}) )Jakub