Re: [PATCH v21 11/18] x86/resctrl: Allocate a new field in union mon_data_bits

[Reinette Chatre <reinette.chatre@intel.com>]

Hi Tony,

On 6/21/24 3:38 PM, Tony Luck wrote:
> When Sub-NUMA Cluster (SNC) mode is enabled the legacy monitor reporting
> files must report the sum of the data from all of the SNC nodes that
> share the L3 cache that is referenced by the monitor file.
> 
> Resctrl squeezes all the attributes of these files into 32-bits so they
> can be stored in the "priv" field of struct kernfs_node.
> 
> Currently only three monitor events are defined by enum resctrl_event_id
> so reducing it from 8-bits to 7-bits still provides more than enough
> space to represent all the known event types. But note that this choice
> was arbitrary. The "rid" field is also far wider than needed for the
> current number of resource id types.  This structure is purely internal
> to resctrl, no ABI issues with modifying it. Subsequent changes may
> rearrange the allocation of bits between each of the fields as needed.
> 
> Give the bit to a new "sum" field that indicates that reading this file
> must sum across SNC nodes. This bit also indicates that the domid field
> is the id of an L3 cache (instead of a domain id) to find which domains
> must be summed.
> 
> Fix up other issues in the kerneldoc description for mon_data_bits.
> 
> Signed-off-by: Tony Luck <tony.luck@intel.com>
> Reviewed-by: Reinette Chatre <reinette.chatre@intel.com>
> ---
>   arch/x86/kernel/cpu/resctrl/internal.h | 20 +++++++++++++-------
>   1 file changed, 13 insertions(+), 7 deletions(-)
> 
> diff --git a/arch/x86/kernel/cpu/resctrl/internal.h b/arch/x86/kernel/cpu/resctrl/internal.h
> index d04018b8b571..f66c7f12e91e 100644
> --- a/arch/x86/kernel/cpu/resctrl/internal.h
> +++ b/arch/x86/kernel/cpu/resctrl/internal.h
> @@ -127,19 +127,25 @@ struct mon_evt {
>   };
>   
>   /**
> - * union mon_data_bits - Monitoring details for each event file
> + * union mon_data_bits - Monitoring details for each event file.
>    * @priv:              Used to store monitoring event data in @u
> - *                     as kernfs private data
> - * @rid:               Resource id associated with the event file
> - * @evtid:             Event id associated with the event file
> - * @domid:             The domain to which the event file belongs
> - * @u:                 Name of the bit fields struct
> + *                     as kernfs private data.
> + * @u.rid:             Resource id associated with the event file.
> + * @u.evtid:           Event id associated with the event file.
> + * @u.sum:             Set when event must be summed across multiple
> + *                     domains.
> + * @u.domid:           When @u.sum is zero this is the domain to which
> + *                     the event file belongs. When @sum is one this
> + *                     is the id of the L3 cache that all domains to be
> + *                     summed share.
> + * @u:                 Name of the bit fields struct.

Thank you for including a fix to the kerneldoc.

Reinette