[PATCH] fix xl.cfg docs to correct viridian defaults list

[PATCH] fix xl.cfg docs to correct viridian defaults list

[James Dingwall]

[-- Attachment #1: Type: text/plain, Size: 1156 bytes --]

Hi,

I was trying to work out why this would cause my Windows 10 guest to hang
when it should have been equivalent to ['defaults'] or 1.

viridian = ['base', 'freq', 'apic_assist', 'crash_ctl', 'no_vp_limit', 'cpu_hotplug', 'time_ref_count', 'stimer']

Checking the libxl sources show that in fact the defaults are:

    if (libxl_defbool_val(info->u.hvm.viridian)) {
        /* Enable defaults */
        libxl_bitmap_set(&enlightenments, LIBXL_VIRIDIAN_ENLIGHTENMENT_BASE);
        libxl_bitmap_set(&enlightenments, LIBXL_VIRIDIAN_ENLIGHTENMENT_FREQ);
        libxl_bitmap_set(&enlightenments, LIBXL_VIRIDIAN_ENLIGHTENMENT_TIME_REF_COUNT);
        libxl_bitmap_set(&enlightenments, LIBXL_VIRIDIAN_ENLIGHTENMENT_APIC_ASSIST);
        libxl_bitmap_set(&enlightenments, LIBXL_VIRIDIAN_ENLIGHTENMENT_CRASH_CTL);
        libxl_bitmap_set(&enlightenments, LIBXL_VIRIDIAN_ENLIGHTENMENT_NO_VP_LIMIT);
        libxl_bitmap_set(&enlightenments, LIBXL_VIRIDIAN_ENLIGHTENMENT_CPU_HOTPLUG);
    }

LIBXL_VIRIDIAN_ENLIGHTENMENT_STIMER was removed as a default enlightement in
e83077a3d11072708a5c38fa09fa9d011914e2a1 but the docs were not kept aligned.

Thanks,
James

[-- Attachment #2: af3b374637bae4b30091f731f2bfeea4460478da.diff --]
[-- Type: text/x-diff, Size: 1030 bytes --]

commit af3b374637bae4b30091f731f2bfeea4460478da
Author: James Dingwall <james@dingwall.me.uk>
Date:   Fri Nov 7 19:09:56 2025 +0000

    doc/man: align list of viridian default enlightenments with libxl
    
    The stimer enlightment was removed from the defaults list in
    e83077a3d11072708a5c38fa09fa9d011914e2a1 but the corresponding docs
    change was not made.  Removing from docs as enabling the enlightenment
    will hang Windows 10 guests.
    
    Signed-off-by: James Dingwall <james@dingwall.me.uk>

diff --git a/docs/man/xl.cfg.5.pod.in b/docs/man/xl.cfg.5.pod.in
index ad1553c5e9..27c455210b 100644
--- a/docs/man/xl.cfg.5.pod.in
+++ b/docs/man/xl.cfg.5.pod.in
@@ -2503,7 +2503,7 @@ guests effectively allowing vCPU hotplug.
 
 This is a special value that enables the default set of groups, which
 is currently the B<base>, B<freq>, B<time_ref_count>, B<apic_assist>,
-B<crash_ctl>, B<stimer>, B<no_vp_limit> and B<cpu_hotplug> groups.
+B<crash_ctl>, B<no_vp_limit> and B<cpu_hotplug> groups.
 
 =item B<all>
 

Re: [PATCH for-4.21] fix xl.cfg docs to correct viridian defaults list

[Andrew Cooper]

On 07/11/2025 7:23 pm, James Dingwall wrote:
> Hi,
>
> I was trying to work out why this would cause my Windows 10 guest to hang
> when it should have been equivalent to ['defaults'] or 1.
>
> viridian = ['base', 'freq', 'apic_assist', 'crash_ctl', 'no_vp_limit', 'cpu_hotplug', 'time_ref_count', 'stimer']
>
> Checking the libxl sources show that in fact the defaults are:
>
>     if (libxl_defbool_val(info->u.hvm.viridian)) {
>         /* Enable defaults */
>         libxl_bitmap_set(&enlightenments, LIBXL_VIRIDIAN_ENLIGHTENMENT_BASE);
>         libxl_bitmap_set(&enlightenments, LIBXL_VIRIDIAN_ENLIGHTENMENT_FREQ);
>         libxl_bitmap_set(&enlightenments, LIBXL_VIRIDIAN_ENLIGHTENMENT_TIME_REF_COUNT);
>         libxl_bitmap_set(&enlightenments, LIBXL_VIRIDIAN_ENLIGHTENMENT_APIC_ASSIST);
>         libxl_bitmap_set(&enlightenments, LIBXL_VIRIDIAN_ENLIGHTENMENT_CRASH_CTL);
>         libxl_bitmap_set(&enlightenments, LIBXL_VIRIDIAN_ENLIGHTENMENT_NO_VP_LIMIT);
>         libxl_bitmap_set(&enlightenments, LIBXL_VIRIDIAN_ENLIGHTENMENT_CPU_HOTPLUG);
>     }
>
> LIBXL_VIRIDIAN_ENLIGHTENMENT_STIMER was removed as a default enlightement in
> e83077a3d11072708a5c38fa09fa9d011914e2a1 but the docs were not kept aligned.

Hmm, indeed.

For the patch, Reviewed-by: Andrew Cooper <andrew.cooper3@citrix.com>

It should have a fixes tag, but I can fix that on commit.

CC'ing Oleksii.  This is a docs fix should be considered for 4.21 at
this juncture.

~Andrew

Re: [PATCH for-4.21] fix xl.cfg docs to correct viridian defaults list

[Oleksii Kurochko]

[-- Attachment #1: Type: text/plain, Size: 1673 bytes --]


On 11/7/25 11:50 PM, Andrew Cooper wrote:
> On 07/11/2025 7:23 pm, James Dingwall wrote:
>> Hi,
>>
>> I was trying to work out why this would cause my Windows 10 guest to hang
>> when it should have been equivalent to ['defaults'] or 1.
>>
>> viridian = ['base', 'freq', 'apic_assist', 'crash_ctl', 'no_vp_limit', 'cpu_hotplug', 'time_ref_count', 'stimer']
>>
>> Checking the libxl sources show that in fact the defaults are:
>>
>>      if (libxl_defbool_val(info->u.hvm.viridian)) {
>>          /* Enable defaults */
>>          libxl_bitmap_set(&enlightenments, LIBXL_VIRIDIAN_ENLIGHTENMENT_BASE);
>>          libxl_bitmap_set(&enlightenments, LIBXL_VIRIDIAN_ENLIGHTENMENT_FREQ);
>>          libxl_bitmap_set(&enlightenments, LIBXL_VIRIDIAN_ENLIGHTENMENT_TIME_REF_COUNT);
>>          libxl_bitmap_set(&enlightenments, LIBXL_VIRIDIAN_ENLIGHTENMENT_APIC_ASSIST);
>>          libxl_bitmap_set(&enlightenments, LIBXL_VIRIDIAN_ENLIGHTENMENT_CRASH_CTL);
>>          libxl_bitmap_set(&enlightenments, LIBXL_VIRIDIAN_ENLIGHTENMENT_NO_VP_LIMIT);
>>          libxl_bitmap_set(&enlightenments, LIBXL_VIRIDIAN_ENLIGHTENMENT_CPU_HOTPLUG);
>>      }
>>
>> LIBXL_VIRIDIAN_ENLIGHTENMENT_STIMER was removed as a default enlightement in
>> e83077a3d11072708a5c38fa09fa9d011914e2a1 but the docs were not kept aligned.
> Hmm, indeed.
>
> For the patch, Reviewed-by: Andrew Cooper<andrew.cooper3@citrix.com>
>
> It should have a fixes tag, but I can fix that on commit.
>
> CC'ing Oleksii.  This is a docs fix should be considered for 4.21 at
> this juncture.

Agree, it could be in 4.21:

Release-Acked-By: Oleksii Kurochko<oleksii.kurochko@gmail.com>

Thanks for notifying me.

~ Oleksii

[-- Attachment #2: Type: text/html, Size: 2325 bytes --]