[PATCH] xen: Kconfig: Add DEBUG_XEN config option

[PATCH] xen: Kconfig: Add DEBUG_XEN config option

[Andrii Anisov]

From: Andrii Anisov <andrii_anisov@epam.com>

Add a debug option to enable xen drivers debug code.

Signed-off-by: Andrii Anisov <andrii_anisov@epam.com>
---
 drivers/xen/Kconfig  | 8 ++++++++
 drivers/xen/Makefile | 2 ++
 2 files changed, 10 insertions(+)

diff --git a/drivers/xen/Kconfig b/drivers/xen/Kconfig
index f15bb3b7..733c433 100644
--- a/drivers/xen/Kconfig
+++ b/drivers/xen/Kconfig
@@ -298,4 +298,12 @@ config XEN_SYMS
 config XEN_HAVE_VPMU
        bool
 
+config DEBUG_XEN
+	bool "XEN Drivers debug"
+	depends on DEBUG_KERNEL
+	help
+	  Say Y here if you want to enable XEN drivers debug code.
+
+	  If you are unsure about this, say N here.
+
 endmenu
diff --git a/drivers/xen/Makefile b/drivers/xen/Makefile
index 8feab810..c886e9d 100644
--- a/drivers/xen/Makefile
+++ b/drivers/xen/Makefile
@@ -42,3 +42,5 @@ xen-evtchn-y				:= evtchn.o
 xen-gntdev-y				:= gntdev.o
 xen-gntalloc-y				:= gntalloc.o
 xen-privcmd-y				:= privcmd.o
+
+ccflags-$(CONFIG_DEBUG_XEN) := -DDEBUG
\ No newline at end of file
-- 
2.7.4


_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xen.org
https://lists.xen.org/xen-devel

Re: [PATCH] xen: Kconfig: Add DEBUG_XEN config option

[Juergen Gross]

On 01/02/17 12:19, Andrii Anisov wrote:
> From: Andrii Anisov <andrii_anisov@epam.com>
> 
> Add a debug option to enable xen drivers debug code.
> 
> Signed-off-by: Andrii Anisov <andrii_anisov@epam.com>

In future you might want to add the maintainers to the recipient list.

> ---
>  drivers/xen/Kconfig  | 8 ++++++++
>  drivers/xen/Makefile | 2 ++
>  2 files changed, 10 insertions(+)
> 
> diff --git a/drivers/xen/Kconfig b/drivers/xen/Kconfig
> index f15bb3b7..733c433 100644
> --- a/drivers/xen/Kconfig
> +++ b/drivers/xen/Kconfig
> @@ -298,4 +298,12 @@ config XEN_SYMS
>  config XEN_HAVE_VPMU
>         bool
>  
> +config DEBUG_XEN
> +	bool "XEN Drivers debug"
> +	depends on DEBUG_KERNEL
> +	help
> +	  Say Y here if you want to enable XEN drivers debug code.
> +
> +	  If you are unsure about this, say N here.

So is this really a sensible thing to do? I don't see the value for
such a global config option possibly switching so many different
drivers to debug mode.

In reality you want to do something like "debug" for a single driver
only during time of development. This won't need a global config
option but just a "#define" in the driver which is active while
developing and testing and which should be removed or commented out
when the final submission of the driver is done.


Juergen

_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xen.org
https://lists.xen.org/xen-devel

Re: [PATCH] xen: Kconfig: Add DEBUG_XEN config option

[Julien Grall]

Hi Juergen,

On 01/02/2017 12:17, Juergen Gross wrote:
> On 01/02/17 12:19, Andrii Anisov wrote:
>> From: Andrii Anisov <andrii_anisov@epam.com>
>>
>> Add a debug option to enable xen drivers debug code.
>>
>> Signed-off-by: Andrii Anisov <andrii_anisov@epam.com>
>
> In future you might want to add the maintainers to the recipient list.
>
>> ---
>>  drivers/xen/Kconfig  | 8 ++++++++
>>  drivers/xen/Makefile | 2 ++
>>  2 files changed, 10 insertions(+)
>>
>> diff --git a/drivers/xen/Kconfig b/drivers/xen/Kconfig
>> index f15bb3b7..733c433 100644
>> --- a/drivers/xen/Kconfig
>> +++ b/drivers/xen/Kconfig
>> @@ -298,4 +298,12 @@ config XEN_SYMS
>>  config XEN_HAVE_VPMU
>>         bool
>>
>> +config DEBUG_XEN
>> +	bool "XEN Drivers debug"
>> +	depends on DEBUG_KERNEL
>> +	help
>> +	  Say Y here if you want to enable XEN drivers debug code.
>> +
>> +	  If you are unsure about this, say N here.
>
> So is this really a sensible thing to do? I don't see the value for
> such a global config option possibly switching so many different
> drivers to debug mode.
>
> In reality you want to do something like "debug" for a single driver
> only during time of development. This won't need a global config
> option but just a "#define" in the driver which is active while
> developing and testing and which should be removed or commented out
> when the final submission of the driver is done.

This Kconfig was suggested in the context of [1]. The number of people 
working on swiotlb is very limited, but the check added is really useful 
in debug build to catch potential misuse for anyone.

Do you have any other idea to turn this check on for debug build??

Cheers,

[1] https://lists.xen.org/archives/html/xen-devel/2017-01/msg03448.html

-- 
Julien Grall

_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xen.org
https://lists.xen.org/xen-devel

Re: [PATCH] xen: Kconfig: Add DEBUG_XEN config option

[Andrii Anisov]

Dear Juergen,

> In future you might want to add the maintainers to the recipient list.
Yep, I would take care to not miss this point.

And +1 to Julien's  comment.

Sincerely,
Andrii Anisov.

_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xen.org
https://lists.xen.org/xen-devel

Re: [PATCH] xen: Kconfig: Add DEBUG_XEN config option

[Juergen Gross]

On 01/02/17 13:55, Julien Grall wrote:
> Hi Juergen,
> 
> On 01/02/2017 12:17, Juergen Gross wrote:
>> On 01/02/17 12:19, Andrii Anisov wrote:
>>> From: Andrii Anisov <andrii_anisov@epam.com>
>>>
>>> Add a debug option to enable xen drivers debug code.
>>>
>>> Signed-off-by: Andrii Anisov <andrii_anisov@epam.com>
>>
>> In future you might want to add the maintainers to the recipient list.
>>
>>> ---
>>>  drivers/xen/Kconfig  | 8 ++++++++
>>>  drivers/xen/Makefile | 2 ++
>>>  2 files changed, 10 insertions(+)
>>>
>>> diff --git a/drivers/xen/Kconfig b/drivers/xen/Kconfig
>>> index f15bb3b7..733c433 100644
>>> --- a/drivers/xen/Kconfig
>>> +++ b/drivers/xen/Kconfig
>>> @@ -298,4 +298,12 @@ config XEN_SYMS
>>>  config XEN_HAVE_VPMU
>>>         bool
>>>
>>> +config DEBUG_XEN
>>> +    bool "XEN Drivers debug"
>>> +    depends on DEBUG_KERNEL
>>> +    help
>>> +      Say Y here if you want to enable XEN drivers debug code.
>>> +
>>> +      If you are unsure about this, say N here.
>>
>> So is this really a sensible thing to do? I don't see the value for
>> such a global config option possibly switching so many different
>> drivers to debug mode.
>>
>> In reality you want to do something like "debug" for a single driver
>> only during time of development. This won't need a global config
>> option but just a "#define" in the driver which is active while
>> developing and testing and which should be removed or commented out
>> when the final submission of the driver is done.
> 
> This Kconfig was suggested in the context of [1]. The number of people
> working on swiotlb is very limited, but the check added is really useful
> in debug build to catch potential misuse for anyone.
> 
> Do you have any other idea to turn this check on for debug build??

I think for this use case we would want either a more specific config
option name (e.g. DEBUG_XEN_SWIOTLB) or a more specific description
what it is doing, like e.g.:

"Say Y here if you want to enable XEN drivers debug code adding more
 sanity checks to Xen drivers eventually crashing the kernel in case
 of detected inconsistencies. Enabling this option might slow down
 the kernel. It is not appropriate for production.

 If you are unsure about this, say N here."

This would make clear that this option should not be used to spam the
console with thousands of messages by dozens of different drivers,
but for catching potential bugs early, and shipping a kernel with this
option enabled is not a good idea.


Juergen


_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xen.org
https://lists.xen.org/xen-devel

Re: [PATCH] xen: Kconfig: Add DEBUG_XEN config option

[Konrad Rzeszutek Wilk]

On Wed, Feb 01, 2017 at 02:12:13PM +0100, Juergen Gross wrote:
> On 01/02/17 13:55, Julien Grall wrote:
> > Hi Juergen,
> > 
> > On 01/02/2017 12:17, Juergen Gross wrote:
> >> On 01/02/17 12:19, Andrii Anisov wrote:
> >>> From: Andrii Anisov <andrii_anisov@epam.com>
> >>>
> >>> Add a debug option to enable xen drivers debug code.
> >>>
> >>> Signed-off-by: Andrii Anisov <andrii_anisov@epam.com>
> >>
> >> In future you might want to add the maintainers to the recipient list.
> >>
> >>> ---
> >>>  drivers/xen/Kconfig  | 8 ++++++++
> >>>  drivers/xen/Makefile | 2 ++
> >>>  2 files changed, 10 insertions(+)
> >>>
> >>> diff --git a/drivers/xen/Kconfig b/drivers/xen/Kconfig
> >>> index f15bb3b7..733c433 100644
> >>> --- a/drivers/xen/Kconfig
> >>> +++ b/drivers/xen/Kconfig
> >>> @@ -298,4 +298,12 @@ config XEN_SYMS
> >>>  config XEN_HAVE_VPMU
> >>>         bool
> >>>
> >>> +config DEBUG_XEN
> >>> +    bool "XEN Drivers debug"
> >>> +    depends on DEBUG_KERNEL
> >>> +    help
> >>> +      Say Y here if you want to enable XEN drivers debug code.
> >>> +
> >>> +      If you are unsure about this, say N here.
> >>
> >> So is this really a sensible thing to do? I don't see the value for
> >> such a global config option possibly switching so many different
> >> drivers to debug mode.
> >>
> >> In reality you want to do something like "debug" for a single driver
> >> only during time of development. This won't need a global config
> >> option but just a "#define" in the driver which is active while
> >> developing and testing and which should be removed or commented out
> >> when the final submission of the driver is done.
> > 
> > This Kconfig was suggested in the context of [1]. The number of people
> > working on swiotlb is very limited, but the check added is really useful
> > in debug build to catch potential misuse for anyone.
> > 
> > Do you have any other idea to turn this check on for debug build??
> 
> I think for this use case we would want either a more specific config
> option name (e.g. DEBUG_XEN_SWIOTLB) or a more specific description
> what it is doing, like e.g.:

I really don't want to add this in the Xen SWIOTLB.

It is kind of pointless - I would prefer if the debug code had
just #if 0 with a comment explaining why it is such and what it
can be used for.

_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xen.org
https://lists.xen.org/xen-devel