Re: [PATCH net-next v2 1/4] flow_offload: add control flag checking helpers

[Asbjørn Sloth Tønnesen]

On 4/10/24 9:32 AM, Asbjørn Sloth Tønnesen wrote:
> These helpers aim to help drivers, with checking
> for the presence of unsupported control flags.
>
> For drivers supporting at least one control flag:
>    flow_rule_is_supp_control_flags()
>
> For drivers using flow_rule_match_control(), but not using flags:
>    flow_rule_has_control_flags()
>
> For drivers not using flow_rule_match_control():
>    flow_rule_match_has_control_flags()
>
> While primarily aimed at FLOW_DISSECTOR_KEY_CONTROL
> and flow_rule_match_control(), then the first two
> can also be used with FLOW_DISSECTOR_KEY_ENC_CONTROL
> and flow_rule_match_enc_control().
>
> These helpers mirrors the existing check done in sfc:
>    drivers/net/ethernet/sfc/tc.c +276
>
> Only compile-tested.
>
> Signed-off-by: Asbjørn Sloth Tønnesen <ast@xxxxxxxxxxx>
> ---
>   include/net/flow_offload.h | 55 ++++++++++++++++++++++++++++++++++++++
>   1 file changed, 55 insertions(+)
>
> diff --git a/include/net/flow_offload.h b/include/net/flow_offload.h
> index 314087a5e1818..9ee3ad4a308a8 100644
> --- a/include/net/flow_offload.h
> +++ b/include/net/flow_offload.h
> @@ -449,6 +449,61 @@ static inline bool flow_rule_match_key(const struct flow_rule *rule,
>   	return dissector_uses_key(rule->match.dissector, key);
>   }
>   
> +/**
> + * flow_rule_is_supp_control_flags() - check for supported control flags
> + * @supp_flags: control flags supported by driver
> + * @ctrl_flags: control flags present in rule
> + * @extack: The netlink extended ACK for reporting errors.
> + *
> + * @returns true if only supported control flags are set, false otherwise.
> + */


The kdoc test failed:
> include/net/flow_offload.h:463: warning: No description found for return value of 'flow_rule_is_supp_control_flags'

For some reason I didn't find kernel-doc.rst, because I searched for autodoc sphinx stuff.

Will do proper "Return:" in v3.

I wasn't able to reproduce the kdoc failure[1] locally:

$ ./scripts/kernel-doc -none include/net/flow_offload.h
$ ./scripts/kernel-doc -none -v include/net/flow_offload.h
include/net/flow_offload.h:345: info: Scanning doc for function flow_offload_has_one_action
include/net/flow_offload.h:453: info: Scanning doc for function flow_rule_is_supp_control_flags
include/net/flow_offload.h:475: info: Scanning doc for function flow_rule_has_control_flags
include/net/flow_offload.h:488: info: Scanning doc for function flow_rule_match_has_control_flags

[1] https://netdev.bots.linux.dev/static/nipa/843159/13623977/kdoc/

pw-bot: changes-requested


> +static inline bool flow_rule_is_supp_control_flags(const u32 supp_flags,
> +						   const u32 ctrl_flags,
> +						   struct netlink_ext_ack *extack)
> +{
> +	if (likely((ctrl_flags & ~supp_flags) == 0))
> +		return true;
> +
> +	NL_SET_ERR_MSG_FMT_MOD(extack,
> +			       "Unsupported match on control.flags %#x",
> +			       ctrl_flags);
> +
> +	return false;
> +}
> +
> +/**
> + * flow_rule_has_control_flags() - check for presence of any control flags
> + * @ctrl_flags: control flags present in rule
> + * @extack: The netlink extended ACK for reporting errors.
> + *
> + * @returns true if control flags are set, false otherwise.
> + */
> +static inline bool flow_rule_has_control_flags(const u32 ctrl_flags,
> +					       struct netlink_ext_ack *extack)
> +{
> +	return !flow_rule_is_supp_control_flags(0, ctrl_flags, extack);
> +}
> +
> +/**
> + * flow_rule_match_has_control_flags() - match and check for any control flags
> + * @rule: The flow_rule under evaluation.
> + * @extack: The netlink extended ACK for reporting errors.
> + *
> + * @returns true if control flags are set, false otherwise.
> + */
> +static inline bool flow_rule_match_has_control_flags(struct flow_rule *rule,
> +						     struct netlink_ext_ack *extack)
> +{
> +	struct flow_match_control match;
> +
> +	if (!flow_rule_match_key(rule, FLOW_DISSECTOR_KEY_CONTROL))
> +		return false;
> +
> +	flow_rule_match_control(rule, &match);
> +
> +	return flow_rule_has_control_flags(match.mask->flags, extack);
> +}
> +
>   struct flow_stats {
>   	u64	pkts;
>   	u64	bytes;

--
Best regards
Asbjørn Sloth Tønnesen
Network Engineer
Fiberby - AS42541