docs/core-api/mm: fix user memory accessors formatting (bc8ff3ca) · Commits · 戴 / test

arch/x86/include/asm/uaccess.h

+12 −12

Original line number	Diff line number	Diff line
		@@ -75,7 +75,7 @@ static inline bool __chk_range_not_ok(unsigned long addr, unsigned long size, un
		#endif

		/**
		* access_ok: - Checks if a user space pointer is valid
		* access_ok - Checks if a user space pointer is valid
		* @addr: User space pointer to start of block to check
		* @size: Size of block to check
		*
		@@ -84,12 +84,12 @@ static inline bool __chk_range_not_ok(unsigned long addr, unsigned long size, un
		*
		* Checks if a pointer to a block of memory in user space is valid.
		*
		* Returns true (nonzero) if the memory block may be valid, false (zero)
		* if it is definitely invalid.
		*
		* Note that, depending on architecture, this function probably just
		* checks that the pointer is in the user space range - after calling
		* this function, memory access functions may still return -EFAULT.
		*
		* Return: true (nonzero) if the memory block may be valid, false (zero)
		* if it is definitely invalid.
		*/
		#define access_ok(addr, size) \
		({ \
		@@ -134,7 +134,7 @@ extern int __get_user_bad(void);
		__typeof__(__builtin_choose_expr(sizeof(x) > sizeof(0UL), 0ULL, 0UL))

		/**
		* get_user: - Get a simple variable from user space.
		* get_user - Get a simple variable from user space.
		* @x: Variable to store result.
		* @ptr: Source address, in user space.
		*
		@@ -148,7 +148,7 @@ __typeof__(__builtin_choose_expr(sizeof(x) > sizeof(0UL), 0ULL, 0UL))
		* @ptr must have pointer-to-simple-variable type, and the result of
		* dereferencing @ptr must be assignable to @x without a cast.
		*
		* Returns zero on success, or -EFAULT on error.
		* Return: zero on success, or -EFAULT on error.
		* On error, the variable @x is set to zero.
		*/
		/*
		@@ -226,7 +226,7 @@ extern void __put_user_4(void);
		extern void __put_user_8(void);

		/**
		* put_user: - Write a simple value into user space.
		* put_user - Write a simple value into user space.
		* @x: Value to copy to user space.
		* @ptr: Destination address, in user space.
		*
		@@ -240,7 +240,7 @@ extern void __put_user_8(void);
		* @ptr must have pointer-to-simple-variable type, and @x must be assignable
		* to the result of dereferencing @ptr.
		*
		* Returns zero on success, or -EFAULT on error.
		* Return: zero on success, or -EFAULT on error.
		*/
		#define put_user(x, ptr) \
		({ \
		@@ -502,7 +502,7 @@ struct __large_struct { unsigned long buf[100]; };
		} while (0)

		/**
		* __get_user: - Get a simple variable from user space, with less checking.
		* __get_user - Get a simple variable from user space, with less checking.
		* @x: Variable to store result.
		* @ptr: Source address, in user space.
		*
		@@ -519,7 +519,7 @@ struct __large_struct { unsigned long buf[100]; };
		* Caller must check the pointer with access_ok() before calling this
		* function.
		*
		* Returns zero on success, or -EFAULT on error.
		* Return: zero on success, or -EFAULT on error.
		* On error, the variable @x is set to zero.
		*/

		@@ -527,7 +527,7 @@ struct __large_struct { unsigned long buf[100]; };
		__get_user_nocheck((x), (ptr), sizeof(*(ptr)))

		/**
		* __put_user: - Write a simple value into user space, with less checking.
		* __put_user - Write a simple value into user space, with less checking.
		* @x: Value to copy to user space.
		* @ptr: Destination address, in user space.
		*
		@@ -544,7 +544,7 @@ struct __large_struct { unsigned long buf[100]; };
		* Caller must check the pointer with access_ok() before calling this
		* function.
		*
		* Returns zero on success, or -EFAULT on error.
		* Return: zero on success, or -EFAULT on error.
		*/

		#define __put_user(x, ptr) \

arch/x86/lib/usercopy_32.c

+4 −4

Original line number	Diff line number	Diff line
		@@ -54,13 +54,13 @@ do { \
		} while (0)

		/**
		* clear_user: - Zero a block of memory in user space.
		* clear_user - Zero a block of memory in user space.
		* @to: Destination address, in user space.
		* @n: Number of bytes to zero.
		*
		* Zero a block of memory in user space.
		*
		* Returns number of bytes that could not be cleared.
		* Return: number of bytes that could not be cleared.
		* On success, this will be zero.
		*/
		unsigned long
		@@ -74,14 +74,14 @@ clear_user(void __user *to, unsigned long n)
		EXPORT_SYMBOL(clear_user);

		/**
		* __clear_user: - Zero a block of memory in user space, with less checking.
		* __clear_user - Zero a block of memory in user space, with less checking.
		* @to: Destination address, in user space.
		* @n: Number of bytes to zero.
		*
		* Zero a block of memory in user space. Caller must check
		* the specified block with access_ok() before calling this function.
		*
		* Returns number of bytes that could not be cleared.
		* Return: number of bytes that could not be cleared.
		* On success, this will be zero.
		*/
		unsigned long

Admin message