RE: [PATCH v14 00/32] fs,x86/resctrl: Support AMD Assignable Bandwidth Monitoring Counters (ABMC)

Luck, Tony posted 32 patches 3 months, 4 weeks ago
Only 0 patches received!
RE: [PATCH v14 00/32] fs,x86/resctrl: Support AMD Assignable Bandwidth Monitoring Counters (ABMC)
Posted by Luck, Tony 3 months, 4 weeks ago
Babu,

Compiling with "make W=1" you have several kerneldoc comments on new functions
that do not describe their parameters.

E.g.

/**
 * resctrl_config_cntr() - Configure the counter ID for the event, RMID pair in
 * the domain.
 *
 * Assign the counter if @assign is true else unassign the counter. Reset the
 * associated non-architectural state.
 */
static void resctrl_config_cntr(struct rdt_resource *r, struct rdt_mon_domain *d,
                                enum resctrl_event_id evtid, u32 rmid, u32 closid,
                                u32 cntr_id, bool assign)


Warning: fs/resctrl/monitor.c:984 function parameter 'r' not described in 'resctrl_config_cntr'
Warning: fs/resctrl/monitor.c:984 function parameter 'd' not described in 'resctrl_config_cntr'
Warning: fs/resctrl/monitor.c:984 function parameter 'evtid' not described in 'resctrl_config_cntr'
Warning: fs/resctrl/monitor.c:984 function parameter 'rmid' not described in 'resctrl_config_cntr'
Warning: fs/resctrl/monitor.c:984 function parameter 'closid' not described in 'resctrl_config_cntr'
Warning: fs/resctrl/monitor.c:984 function parameter 'cntr_id' not described in 'resctrl_config_cntr'
Warning: fs/resctrl/monitor.c:984 function parameter 'assign' not described in 'resctrl_config_cntr'

-Tony


Re: RE: [PATCH v14 00/32] fs,x86/resctrl: Support AMD Assignable Bandwidth Monitoring Counters (ABMC)
Posted by Moger, Babu 3 months, 3 weeks ago
Hi Tony,

On 6/13/25 16:41, Luck, Tony wrote:
> Babu,
> 
> Compiling with "make W=1" you have several kerneldoc comments on new functions
> that do not describe their parameters.
> 
> E.g.
> 
> /**
>  * resctrl_config_cntr() - Configure the counter ID for the event, RMID pair in
>  * the domain.
>  *
>  * Assign the counter if @assign is true else unassign the counter. Reset the
>  * associated non-architectural state.
>  */
> static void resctrl_config_cntr(struct rdt_resource *r, struct rdt_mon_domain *d,
>                                 enum resctrl_event_id evtid, u32 rmid, u32 closid,
>                                 u32 cntr_id, bool assign)
> 
> 
> Warning: fs/resctrl/monitor.c:984 function parameter 'r' not described in 'resctrl_config_cntr'
> Warning: fs/resctrl/monitor.c:984 function parameter 'd' not described in 'resctrl_config_cntr'
> Warning: fs/resctrl/monitor.c:984 function parameter 'evtid' not described in 'resctrl_config_cntr'
> Warning: fs/resctrl/monitor.c:984 function parameter 'rmid' not described in 'resctrl_config_cntr'
> Warning: fs/resctrl/monitor.c:984 function parameter 'closid' not described in 'resctrl_config_cntr'
> Warning: fs/resctrl/monitor.c:984 function parameter 'cntr_id' not described in 'resctrl_config_cntr'
> Warning: fs/resctrl/monitor.c:984 function parameter 'assign' not described in 'resctrl_config_cntr'
>

Yes. I noticed several of them.
Warning goes away after replacing "/**" with "/*".

Now I am not sure if we fix it with replacing with "/*"  or adding
definitions for each of these parameters. There will be too many
repetitions. All these functions take r, d, eventid, and rmid as
parameters. Also these are static functions.
-- 
Thanks
Babu Moger