Skip to content

Conversation

@JannePeltonen
Copy link
Collaborator

This PR assumes that PR 2258 "api: crypto: remove legacy operation type" has been merged.

Clarify that the output_pool crypto session parameter is unused and will be deprecated later. Specify that the parameter has default value of ODP_PACKET_INVALID and clarify that that is the only valid value for the parameter.

@odpbuild odpbuild changed the title api: crypto: clarify output_pool session parameter and specify its default value [PATCH v1] api: crypto: clarify output_pool session parameter and specify its default value Dec 19, 2025
@TuomasTaipale
Copy link
Collaborator

Just noticed odp_ipsec_cache.c still sets the pool, does that require changes?

@MatiasElo MatiasElo added this to the v1.49.0 milestone Dec 19, 2025
@JannePeltonen
Copy link
Collaborator Author

Just noticed odp_ipsec_cache.c still sets the pool, does that require changes?

It does not require changes right now since setting output_pool to ODP_POOL_INVALID (i.e. to the default value) is still ok. Setting of the output_pool should be removed from the file, but the problem is that the code is written without the odp_crypto_session_param_init() function and therefore the output_pool setting cannot be simply removed but a bit bigger change that introduces the init function call is needed. I did not want to do that as part of this API commit but left it for the future. But yes, the pool setting needs to be removed at some point.

@odpbuild odpbuild changed the title [PATCH v1] api: crypto: clarify output_pool session parameter and specify its default value [PATCH v2] api: crypto: clarify output_pool session parameter and specify its default value Dec 30, 2025
@JannePeltonen
Copy link
Collaborator Author

v2: added review tags

Now that the deprecated legacy crypto operation mode has been fully
removed from the API, the output_pool crypto session parameter is no
longer used. Change the description of the parameter to mention that
the parameter is not used and will be deprecated. Specify that the
parameter must be left to the default value and that the default value
is ODP_POOL_INVALID.

This way existing code that is setting the output_pool session parameter
to ODP_POOL_INVALID continues to be valid but it becomes possible to
remove the explicit setting of the parameter as preparation for its
eventual deprecation.

Signed-off-by: Janne Peltonen <janne.peltonen@nokia.com>
Reviewed-by: Tuomas Taipale <tuomas.taipale@nokia.com>
Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
Test that the default value of the output_pool crypto session parameter is
ODP_POOL_INVALID as now specified in the API and rely on the default value
when creating sessions.

Signed-off-by: Janne Peltonen <janne.peltonen@nokia.com>
Reviewed-by: Tuomas Taipale <tuomas.taipale@nokia.com>
Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
Do not explicitly set the output_pool crypto session parameter but rely
on the default value set by odp_crypto_session_param_init().

Signed-off-by: Janne Peltonen <janne.peltonen@nokia.com>
Reviewed-by: Tuomas Taipale <tuomas.taipale@nokia.com>
Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
@odpbuild odpbuild changed the title [PATCH v2] api: crypto: clarify output_pool session parameter and specify its default value [PATCH v3] api: crypto: clarify output_pool session parameter and specify its default value Dec 30, 2025
@JannePeltonen
Copy link
Collaborator Author

v3: rebased

@MatiasElo MatiasElo added the API Ready API change ready to be merged (with the next API version increment) label Dec 30, 2025
@MatiasElo MatiasElo enabled auto-merge (rebase) December 30, 2025 09:32
@MatiasElo MatiasElo merged commit 11f5eb8 into OpenDataPlane:master Dec 30, 2025
255 of 256 checks passed
@JannePeltonen JannePeltonen deleted the api-crypto-output-pool branch December 30, 2025 13:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

API Ready API change ready to be merged (with the next API version increment)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants