Mailing List Archive

[RESEND][PATCH v2 7/7] xen/guest_access: Fix coding style in xen/guest_access.h
From: Julien Grall <jgrall@amazon.com>

* Add space before and after operator
* Align \
* Format comments

No functional changes expected.

Signed-off-by: Julien Grall <jgrall@amazon.com>
---
xen/include/xen/guest_access.h | 36 +++++++++++++++++++---------------
1 file changed, 20 insertions(+), 16 deletions(-)

diff --git a/xen/include/xen/guest_access.h b/xen/include/xen/guest_access.h
index 4957b8d1f2b8..52fc7a063249 100644
--- a/xen/include/xen/guest_access.h
+++ b/xen/include/xen/guest_access.h
@@ -18,20 +18,24 @@
#define guest_handle_add_offset(hnd, nr) ((hnd).p += (nr))
#define guest_handle_subtract_offset(hnd, nr) ((hnd).p -= (nr))

-/* Cast a guest handle (either XEN_GUEST_HANDLE or XEN_GUEST_HANDLE_PARAM)
- * to the specified type of XEN_GUEST_HANDLE_PARAM. */
+/*
+ * Cast a guest handle (either XEN_GUEST_HANDLE or XEN_GUEST_HANDLE_PARAM)
+ * to the specified type of XEN_GUEST_HANDLE_PARAM.
+ */
#define guest_handle_cast(hnd, type) ({ \
type *_x = (hnd).p; \
- (XEN_GUEST_HANDLE_PARAM(type)) { _x }; \
+ (XEN_GUEST_HANDLE_PARAM(type)) { _x }; \
})

/* Cast a XEN_GUEST_HANDLE to XEN_GUEST_HANDLE_PARAM */
#define guest_handle_to_param(hnd, type) ({ \
typeof((hnd).p) _x = (hnd).p; \
XEN_GUEST_HANDLE_PARAM(type) _y = { _x }; \
- /* type checking: make sure that the pointers inside \
+ /* \
+ * type checking: make sure that the pointers inside \
* XEN_GUEST_HANDLE and XEN_GUEST_HANDLE_PARAM are of \
- * the same type, then return hnd */ \
+ * the same type, then return hnd. \
+ */ \
(void)(&_x == &_y.p); \
_y; \
})
@@ -106,13 +110,13 @@
* guest_handle_subrange_okay().
*/

-#define __copy_to_guest_offset(hnd, off, ptr, nr) ({ \
- const typeof(*(ptr)) *_s = (ptr); \
- char (*_d)[sizeof(*_s)] = (void *)(hnd).p; \
- /* Check that the handle is not for a const type */ \
- void *__maybe_unused _t = (hnd).p; \
- (void)((hnd).p == _s); \
- __raw_copy_to_guest(_d+(off), _s, sizeof(*_s)*(nr));\
+#define __copy_to_guest_offset(hnd, off, ptr, nr) ({ \
+ const typeof(*(ptr)) *_s = (ptr); \
+ char (*_d)[sizeof(*_s)] = (void *)(hnd).p; \
+ /* Check that the handle is not for a const type */ \
+ void *__maybe_unused _t = (hnd).p; \
+ (void)((hnd).p == _s); \
+ __raw_copy_to_guest(_d + (off), _s, sizeof(*_s) * (nr));\
})

#define __clear_guest_offset(hnd, off, nr) ({ \
@@ -120,10 +124,10 @@
__raw_clear_guest(_d + (off), nr); \
})

-#define __copy_from_guest_offset(ptr, hnd, off, nr) ({ \
- const typeof(*(ptr)) *_s = (hnd).p; \
- typeof(*(ptr)) *_d = (ptr); \
- __raw_copy_from_guest(_d, _s+(off), sizeof(*_d)*(nr));\
+#define __copy_from_guest_offset(ptr, hnd, off, nr) ({ \
+ const typeof(*(ptr)) *_s = (hnd).p; \
+ typeof(*(ptr)) *_d = (ptr); \
+ __raw_copy_from_guest(_d, _s + (off), sizeof (*_d) * (nr)); \
})

#define __copy_field_to_guest(hnd, ptr, field) ({ \
--
2.17.1
Re: [RESEND][PATCH v2 7/7] xen/guest_access: Fix coding style in xen/guest_access.h [ In reply to ]
On Thu, 30 Jul 2020, Julien Grall wrote:
> From: Julien Grall <jgrall@amazon.com>
>
> * Add space before and after operator
> * Align \
> * Format comments
>
> No functional changes expected.
>
> Signed-off-by: Julien Grall <jgrall@amazon.com>

Acked-by: Stefano Stabellini <sstabellini@kernel.org>


> ---
> xen/include/xen/guest_access.h | 36 +++++++++++++++++++---------------
> 1 file changed, 20 insertions(+), 16 deletions(-)
>
> diff --git a/xen/include/xen/guest_access.h b/xen/include/xen/guest_access.h
> index 4957b8d1f2b8..52fc7a063249 100644
> --- a/xen/include/xen/guest_access.h
> +++ b/xen/include/xen/guest_access.h
> @@ -18,20 +18,24 @@
> #define guest_handle_add_offset(hnd, nr) ((hnd).p += (nr))
> #define guest_handle_subtract_offset(hnd, nr) ((hnd).p -= (nr))
>
> -/* Cast a guest handle (either XEN_GUEST_HANDLE or XEN_GUEST_HANDLE_PARAM)
> - * to the specified type of XEN_GUEST_HANDLE_PARAM. */
> +/*
> + * Cast a guest handle (either XEN_GUEST_HANDLE or XEN_GUEST_HANDLE_PARAM)
> + * to the specified type of XEN_GUEST_HANDLE_PARAM.
> + */
> #define guest_handle_cast(hnd, type) ({ \
> type *_x = (hnd).p; \
> - (XEN_GUEST_HANDLE_PARAM(type)) { _x }; \
> + (XEN_GUEST_HANDLE_PARAM(type)) { _x }; \
> })
>
> /* Cast a XEN_GUEST_HANDLE to XEN_GUEST_HANDLE_PARAM */
> #define guest_handle_to_param(hnd, type) ({ \
> typeof((hnd).p) _x = (hnd).p; \
> XEN_GUEST_HANDLE_PARAM(type) _y = { _x }; \
> - /* type checking: make sure that the pointers inside \
> + /* \
> + * type checking: make sure that the pointers inside \
> * XEN_GUEST_HANDLE and XEN_GUEST_HANDLE_PARAM are of \
> - * the same type, then return hnd */ \
> + * the same type, then return hnd. \
> + */ \
> (void)(&_x == &_y.p); \
> _y; \
> })
> @@ -106,13 +110,13 @@
> * guest_handle_subrange_okay().
> */
>
> -#define __copy_to_guest_offset(hnd, off, ptr, nr) ({ \
> - const typeof(*(ptr)) *_s = (ptr); \
> - char (*_d)[sizeof(*_s)] = (void *)(hnd).p; \
> - /* Check that the handle is not for a const type */ \
> - void *__maybe_unused _t = (hnd).p; \
> - (void)((hnd).p == _s); \
> - __raw_copy_to_guest(_d+(off), _s, sizeof(*_s)*(nr));\
> +#define __copy_to_guest_offset(hnd, off, ptr, nr) ({ \
> + const typeof(*(ptr)) *_s = (ptr); \
> + char (*_d)[sizeof(*_s)] = (void *)(hnd).p; \
> + /* Check that the handle is not for a const type */ \
> + void *__maybe_unused _t = (hnd).p; \
> + (void)((hnd).p == _s); \
> + __raw_copy_to_guest(_d + (off), _s, sizeof(*_s) * (nr));\
> })
>
> #define __clear_guest_offset(hnd, off, nr) ({ \
> @@ -120,10 +124,10 @@
> __raw_clear_guest(_d + (off), nr); \
> })
>
> -#define __copy_from_guest_offset(ptr, hnd, off, nr) ({ \
> - const typeof(*(ptr)) *_s = (hnd).p; \
> - typeof(*(ptr)) *_d = (ptr); \
> - __raw_copy_from_guest(_d, _s+(off), sizeof(*_d)*(nr));\
> +#define __copy_from_guest_offset(ptr, hnd, off, nr) ({ \
> + const typeof(*(ptr)) *_s = (hnd).p; \
> + typeof(*(ptr)) *_d = (ptr); \
> + __raw_copy_from_guest(_d, _s + (off), sizeof (*_d) * (nr)); \
> })
>
> #define __copy_field_to_guest(hnd, ptr, field) ({ \
> --
> 2.17.1
>
Re: [RESEND][PATCH v2 7/7] xen/guest_access: Fix coding style in xen/guest_access.h [ In reply to ]
On 30.07.2020 20:18, Julien Grall wrote:
> From: Julien Grall <jgrall@amazon.com>
>
> * Add space before and after operator
> * Align \
> * Format comments

How about also

* remove/replace leading underscores

?

Jan
Re: [RESEND][PATCH v2 7/7] xen/guest_access: Fix coding style in xen/guest_access.h [ In reply to ]
> On 30 Jul 2020, at 20:18, Julien Grall <julien@xen.org> wrote:
>
> From: Julien Grall <jgrall@amazon.com>
>
> * Add space before and after operator
> * Align \
> * Format comments
>
> No functional changes expected.
>
> Signed-off-by: Julien Grall <jgrall@amazon.com>
Reviewed-by: Bertrand Marquis <bertrand.marquis@arm.com>

> ---
> xen/include/xen/guest_access.h | 36 +++++++++++++++++++---------------
> 1 file changed, 20 insertions(+), 16 deletions(-)
>
> diff --git a/xen/include/xen/guest_access.h b/xen/include/xen/guest_access.h
> index 4957b8d1f2b8..52fc7a063249 100644
> --- a/xen/include/xen/guest_access.h
> +++ b/xen/include/xen/guest_access.h
> @@ -18,20 +18,24 @@
> #define guest_handle_add_offset(hnd, nr) ((hnd).p += (nr))
> #define guest_handle_subtract_offset(hnd, nr) ((hnd).p -= (nr))
>
> -/* Cast a guest handle (either XEN_GUEST_HANDLE or XEN_GUEST_HANDLE_PARAM)
> - * to the specified type of XEN_GUEST_HANDLE_PARAM. */
> +/*
> + * Cast a guest handle (either XEN_GUEST_HANDLE or XEN_GUEST_HANDLE_PARAM)
> + * to the specified type of XEN_GUEST_HANDLE_PARAM.
> + */
> #define guest_handle_cast(hnd, type) ({ \
> type *_x = (hnd).p; \
> - (XEN_GUEST_HANDLE_PARAM(type)) { _x }; \
> + (XEN_GUEST_HANDLE_PARAM(type)) { _x }; \
> })
>
> /* Cast a XEN_GUEST_HANDLE to XEN_GUEST_HANDLE_PARAM */
> #define guest_handle_to_param(hnd, type) ({ \
> typeof((hnd).p) _x = (hnd).p; \
> XEN_GUEST_HANDLE_PARAM(type) _y = { _x }; \
> - /* type checking: make sure that the pointers inside \
> + /* \
> + * type checking: make sure that the pointers inside \
> * XEN_GUEST_HANDLE and XEN_GUEST_HANDLE_PARAM are of \
> - * the same type, then return hnd */ \
> + * the same type, then return hnd. \
> + */ \
> (void)(&_x == &_y.p); \
> _y; \
> })
> @@ -106,13 +110,13 @@
> * guest_handle_subrange_okay().
> */
>
> -#define __copy_to_guest_offset(hnd, off, ptr, nr) ({ \
> - const typeof(*(ptr)) *_s = (ptr); \
> - char (*_d)[sizeof(*_s)] = (void *)(hnd).p; \
> - /* Check that the handle is not for a const type */ \
> - void *__maybe_unused _t = (hnd).p; \
> - (void)((hnd).p == _s); \
> - __raw_copy_to_guest(_d+(off), _s, sizeof(*_s)*(nr));\
> +#define __copy_to_guest_offset(hnd, off, ptr, nr) ({ \
> + const typeof(*(ptr)) *_s = (ptr); \
> + char (*_d)[sizeof(*_s)] = (void *)(hnd).p; \
> + /* Check that the handle is not for a const type */ \
> + void *__maybe_unused _t = (hnd).p; \
> + (void)((hnd).p == _s); \
> + __raw_copy_to_guest(_d + (off), _s, sizeof(*_s) * (nr));\
> })
>
> #define __clear_guest_offset(hnd, off, nr) ({ \
> @@ -120,10 +124,10 @@
> __raw_clear_guest(_d + (off), nr); \
> })
>
> -#define __copy_from_guest_offset(ptr, hnd, off, nr) ({ \
> - const typeof(*(ptr)) *_s = (hnd).p; \
> - typeof(*(ptr)) *_d = (ptr); \
> - __raw_copy_from_guest(_d, _s+(off), sizeof(*_d)*(nr));\
> +#define __copy_from_guest_offset(ptr, hnd, off, nr) ({ \
> + const typeof(*(ptr)) *_s = (hnd).p; \
> + typeof(*(ptr)) *_d = (ptr); \
> + __raw_copy_from_guest(_d, _s + (off), sizeof (*_d) * (nr)); \
> })
>
> #define __copy_field_to_guest(hnd, ptr, field) ({ \
> --
> 2.17.1
>
>
Re: [RESEND][PATCH v2 7/7] xen/guest_access: Fix coding style in xen/guest_access.h [ In reply to ]
Hi Jan,

On 31/07/2020 12:41, Jan Beulich wrote:
> On 30.07.2020 20:18, Julien Grall wrote:
>> From: Julien Grall <jgrall@amazon.com>
>>
>> * Add space before and after operator
>> * Align \
>> * Format comments
>
> How about also
>
> * remove/replace leading underscores
>
> ?

I don't have any plan for this. You are welcome to send a patch for this.

Cheers,

--
Julien Grall
Re: [RESEND][PATCH v2 7/7] xen/guest_access: Fix coding style in xen/guest_access.h [ In reply to ]
On 14.08.2020 21:18, Julien Grall wrote:
> On 31/07/2020 12:41, Jan Beulich wrote:
>> On 30.07.2020 20:18, Julien Grall wrote:
>>> From: Julien Grall <jgrall@amazon.com>
>>>
>>>      * Add space before and after operator
>>>      * Align \
>>>      * Format comments
>>
>> How about also
>>
>>      * remove/replace leading underscores
>>
>> ?
>
> I don't have any plan for this. You are welcome to send a patch for this.

In which case may I ask that you replace "Fix" by "Improve" or some
such in the title?

Jan
Re: [RESEND][PATCH v2 7/7] xen/guest_access: Fix coding style in xen/guest_access.h [ In reply to ]
Hi Jan,

On 18/08/2020 09:52, Jan Beulich wrote:
> On 14.08.2020 21:18, Julien Grall wrote:
>> On 31/07/2020 12:41, Jan Beulich wrote:
>>> On 30.07.2020 20:18, Julien Grall wrote:
>>>> From: Julien Grall <jgrall@amazon.com>
>>>>
>>>>      * Add space before and after operator
>>>>      * Align \
>>>>      * Format comments
>>>
>>> How about also
>>>
>>>      * remove/replace leading underscores
>>>
>>> ?
>>
>> I don't have any plan for this. You are welcome to send a patch for this.
>
> In which case may I ask that you replace "Fix" by "Improve" or some
> such in the title?

I will do it if. Although, this doesn't mean I agree with your implicit
coding style.

Cheers,

--
Julien Grall