Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[PATCH v3] api: increment ODP API version to 1.46.0 #2165

Merged
merged 1 commit into from
Dec 20, 2024

Conversation

MatiasElo
Copy link
Collaborator

Increment API version number to reflect the following changes:

Backward incompatible:

  • crypto: change the default crypto op type to ODP_CRYPTO_OP_TYPE_BASIC
  • crypto: deprecate crypto op type ODP_CRYPTO_OP_TYPE_LEGACY
  • pktio: modify certain details of IP and TCP LSO, specify missing details, add restrictions, and clarify the API in general
  • pktio: clarify classifier back pressure API
  • pktio: deprecate ODP_PACKET_TX_COMPL_ALL define
  • pktio: deprecate odp_pktio_capability_t.tx_compl.mode_all field
  • pktio: deprecate odp_pktout_config_opt_t.bit.tx_compl_ena field
  • timer: deprecate odp_timer_pool_start() function

Backward compatible:

  • event: clarify odp_event_free() documentation
  • init: add printf format check to odp_override_log() and odp_log_func_t declarations
  • init: add odp_log_fn_get() function
  • init: add odp_abort_fn_get() function
  • pktio: add a new custom LSO operation ODP_LSO_WRITE_BITS
  • pktio: specify that all segments, except the last one, have the maximum payload length with the custom LSO protocol (ODP_LSO_PROTO_CUSTOM)

Remove deprecated APIs:

  • timer: remove deprecated odp_timeout_fresh() function
  • timer: remove deprecated odp_timer_set_t type

Helper library 1.7.0:

Backward incompatible changes:

  • linux: deprecate odph_linux_pthread_create() and odph_linux_pthread_join() functions
  • linux: deprecate odph_linux_process_fork(), odph_linux_process_fork_n(), and odph_linux_process_wait_n() functions

Backward compatible:

  • api: explicitly state that ODP must be initialized before calling helper functions and document exceptions to this rule individually
  • debug: improve debug macro documentation

@odpbuild odpbuild changed the title api: increment ODP API version to 1.46.0 [PATCH v1] api: increment ODP API version to 1.46.0 Dec 18, 2024
@MatiasElo MatiasElo added this to the v1.46.0.0 release milestone Dec 18, 2024
@MatiasElo MatiasElo added the API next API change for next release label Dec 18, 2024
@odpbuild odpbuild changed the title [PATCH v1] api: increment ODP API version to 1.46.0 [PATCH v2] api: increment ODP API version to 1.46.0 Dec 20, 2024
@MatiasElo MatiasElo added the API Ready API change ready to be merged (with the next API version increment) label Dec 20, 2024
Increment API version number to reflect the following changes:

Backward incompatible:
- crypto: change the default crypto op type to ODP_CRYPTO_OP_TYPE_BASIC
- crypto: deprecate crypto op type ODP_CRYPTO_OP_TYPE_LEGACY
- pktio: modify certain details of IP and TCP LSO, specify missing
  details, add restrictions, and clarify the API in general
- pktio: deprecate ODP_PACKET_TX_COMPL_ALL define
- pktio: deprecate odp_pktio_capability_t.tx_compl.mode_all field
- pktio: deprecate odp_pktout_config_opt_t.bit.tx_compl_ena field
- timer: deprecate odp_timer_pool_start() function

Backward compatible:
- event: clarify odp_event_free() documentation
- init: add printf format check to odp_override_log() and odp_log_func_t
  declarations
- init: add odp_log_fn_get() function
- init: add odp_abort_fn_get() function
- pktio: add a new custom LSO operation ODP_LSO_WRITE_BITS
- pktio: specify that all segments, except the last one, have the maximum
  payload length with the custom LSO protocol (ODP_LSO_PROTO_CUSTOM)

Remove deprecated APIs:
- timer: remove deprecated odp_timeout_fresh() function
- timer: remove deprecated odp_timer_set_t type

Helper library 1.7.0:

Backward incompatible changes:
- linux: deprecate odph_linux_pthread_create() and
  odph_linux_pthread_join() functions
- linux: deprecate odph_linux_process_fork(), odph_linux_process_fork_n(),
  and odph_linux_process_wait_n() functions

Backward compatible:
- api: explicitly state that ODP must be initialized before calling helper
  functions and document exceptions to this rule individually
- debug: improve debug macro documentation

Signed-off-by: Matias Elo <[email protected]>
Reviewed-by: Petri Savolainen <[email protected]>
@odpbuild odpbuild changed the title [PATCH v2] api: increment ODP API version to 1.46.0 [PATCH v3] api: increment ODP API version to 1.46.0 Dec 20, 2024
@MatiasElo MatiasElo merged commit 6c3ff35 into OpenDataPlane:master Dec 20, 2024
96 of 160 checks passed
@MatiasElo MatiasElo deleted the dev/release branch December 20, 2024 14:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API next API change for next release 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.

2 participants