| Message ID | 1499263226-5288-7-git-send-email-odpbot@yandex.ru |
|---|---|
| State | Superseded |
| Headers | show |
| Series | [API-NEXT,v8,1/10] linux-generic: events subtype implementation | expand |
> diff --git a/include/odp/api/spec/crypto.h b/include/odp/api/spec/crypto.h > index 454855ea..27b12c89 100644 > --- a/include/odp/api/spec/crypto.h > +++ b/include/odp/api/spec/crypto.h > @@ -16,6 +16,7 @@ > #include <odp/visibility_begin.h> > > #include <odp/api/deprecated.h> > +#include <odp/api/support.h> > > #ifdef __cplusplus > extern "C" { > @@ -276,6 +277,9 @@ typedef struct odp_crypto_session_param_t { > * data in non-posted mode */ > odp_crypto_op_mode_t ODP_DEPRECATE(pref_mode); > > + /** Operation mode when using packet interface: sync or async > */ > + odp_crypto_op_mode_t packet_op_mode; > + op_mode is enough. By default deprecated field are not visible, and when user enables those he needs to be aware of using only old definition. So, there's no need for e.g. prefixes in the new version. > /** Cipher algorithm > * > * Use odp_crypto_capability() for supported algorithms. > @@ -311,16 +315,15 @@ typedef struct odp_crypto_session_param_t { > > /** Async mode completion event queue > * > - * When odp_crypto_operation() is asynchronous, the completion > queue is > - * used to return the completion status of the operation to > the > - * application. > + * The completion queue is used to return > odp_crypto_packet_op_enq() > + * results to the application. > */ > odp_queue_t compl_queue; > > /** Output pool > * > * When the output packet is not specified during the call to > - * odp_crypto_operation(), the output packet will be allocated > + * crypto operation, the output packet will be allocated > * from this pool. > */ > odp_pool_t output_pool; > @@ -400,6 +403,44 @@ typedef struct odp_crypto_op_param_t { > typedef odp_crypto_op_param_t ODP_DEPRECATE(odp_crypto_op_params_t); > > /** > + * Crypto packet API per packet operation parameters > + */ > +typedef struct odp_crypto_packet_op_param_t { > + /** Session handle from creation */ > + odp_crypto_session_t session; > + > + /** Override session IV pointer */ > + uint8_t *override_iv_ptr; > + > + /** Offset from start of packet for hash result > + * > + * Specifies the offset where the hash result is to be stored. > In case > + * of decode sessions, input hash values will be read from > this offset, > + * and overwritten with hash results. If this offset lies > within > + * specified 'auth_range', implementation will mute this field > before > + * calculating the hash result. > + */ > + uint32_t hash_result_offset; > + > + /** Additional Authenticated Data (AAD) */ > + struct { > + /** Pointer to ADD */ > + uint8_t *ptr; > + > + /** AAD length in bytes. Use > odp_crypto_auth_capability() for > + * supported AAD lengths. */ > + uint32_t length; > + } aad; > + > + /** Data range to apply cipher */ > + odp_packet_data_range_t cipher_range; > + > + /** Data range to authenticate */ > + odp_packet_data_range_t auth_range; > + > +} odp_crypto_packet_op_param_t; If there are difference in enc/decrypto direction parameters. This type could be split in two and named odp_crypto_enc_param_t and _dec_param_t. This would avoid packet_op_param_t vs op_param_t, and would be closer to ipsec operations. > + > +/** > * Crypto API session creation return code > */ > typedef enum { > @@ -444,14 +485,17 @@ typedef enum { > /** > * Cryto API per packet operation completion status > */ > -typedef struct odp_crypto_compl_status { > +typedef struct odp_crypto_op_status { > /** Algorithm specific return code */ > odp_crypto_alg_err_t alg_err; > > /** Hardware specific return code */ > odp_crypto_hw_err_t hw_err; > > -} odp_crypto_compl_status_t; > +} odp_crypto_op_status_t; > + > +/** @deprecated Use ODP_DEPRECATE(odp_crypto_op_status_t) instead */ > +typedef odp_crypto_op_status_t ODP_DEPRECATE(odp_crypto_compl_status_t); > > /** > * Crypto API operation result > @@ -460,27 +504,51 @@ typedef struct odp_crypto_op_result { > /** Request completed successfully */ > odp_bool_t ok; > > - /** User context from request */ > - void *ctx; > + /** User context from request > + * > + * @deprecated No need to pass context around sync calls > + * */ > + void *ODP_DEPRECATE(ctx); > > /** Output packet */ > odp_packet_t pkt; > > /** Cipher status */ > - odp_crypto_compl_status_t cipher_status; > + odp_crypto_op_status_t cipher_status; > > /** Authentication status */ > - odp_crypto_compl_status_t auth_status; > + odp_crypto_op_status_t auth_status; > > } odp_crypto_op_result_t; If this type is not needed in new API, deprecate the entire type instead of a field. > > /** > + * Crypto packet API operation result > + */ > +typedef struct odp_crypto_packet_result_t { > + /** Request completed successfully */ > + odp_bool_t ok; > + > + /** Cipher status */ > + odp_crypto_op_status_t cipher_status; > + > + /** Authentication status */ > + odp_crypto_op_status_t auth_status; > + > +} odp_crypto_packet_result_t; > + > +/** > * Crypto capabilities > */ > typedef struct odp_crypto_capability_t { > /** Maximum number of crypto sessions */ > uint32_t max_sessions; > > + /** Supported packet operation in SYNC mode */ > + odp_support_t packet_sync_mode; Just sync_mode. > + > + /** Supported packet operation in ASYNC mode */ > + odp_support_t packet_async_mode; Just async_mode. > + > /** Supported cipher algorithms */ > odp_crypto_cipher_algos_t ciphers; > > @@ -711,6 +779,94 @@ uint64_t ODP_DEPRECATE(odp_crypto_compl_to_u64)( > void odp_crypto_session_param_init(odp_crypto_session_param_t *param); > > /** > + * Return crypto processed packet that is associated with event > + * > + * Get packet handle to an crypto processed packet event. Event subtype > must be > + * ODP_EVENT_PACKET_CRYPTO. Crypto operation results can be examined with > + * odp_crypto_packet_result(). > + * > + * Note: any invalid parameters will cause undefined behavior and may > cause > + * the application to abort or crash. > + * > + * @param ev Event handle > + * > + * @return Packet handle > + */ > +odp_packet_t odp_crypto_packet_from_event(odp_event_t ev); > + > +/** > + * Convert crypto packet handle to event > + * > + * The packet handle must be an output of an crypto operation. > + * > + * @param pkt Packet handle from crypto operation > + * > + * @return Event handle > + */ > +odp_event_t odp_crypto_packet_to_event(odp_packet_t pkt); > + > +/** > + * Get crypto operation results from an crypto processed packet > + * > + * Successful crypto operations of all types (SYNC and ASYNC) produce > packets > + * which contain crypto result metadata. This function copies the > operation > + * results from an crypto processed packet. Event subtype of this kind of > + * packet is ODP_EVENT_PACKET_crypto. Results are undefined if a non- > crypto > + * processed packet is passed as input. > + * > + * @param packet An crypto processed packet > (ODP_EVENT_PACKET_CRYPTO) > + * @param[out] result Pointer to operation result for output > + * > + * @retval 0 On success > + * @retval <0 On failure > + */ > +int odp_crypto_packet_result(odp_crypto_packet_result_t *result, > + odp_packet_t packet); > + > +/** > + * Crypto packet operation > + * > + * Performs the SYNC cryptographic operations specified during session > creation > + * on the packets. Caller should initialize pkt_out either with desired > output > + * packet handles or with ODP_PACKET_INVALID to make ODP allocate new > packets > + * from provided pool. All arrays should be of num_pkt size. > + * > + * @param pkt_in Packets to be processed > + * @param[in,out] pkt_out Packet handle array specifyint resulting > packets > + * @param param Operation parameters array > + * @param num_pkt Number of packets to be processed > + * > + * @return Number of input packets consumed (0 ... num_pkt) > + * @retval <0 on failure > + */ > +int odp_crypto_packet_op(const odp_packet_t pkt_in[], > + odp_packet_t pkt_out[], > + const odp_crypto_packet_op_param_t > param[], > + int num_pkt); odp_crypto_enc() odp_crypto_dec() or odp_crypto_op() if dual direction needs to be maintained. Separate functions and params per direction would improve readability and a bit performance. > + > +/** > + * Crypto packet operation > + * > + * Performs the ASYNC cryptographic operations specified during session > creation > + * on the packets. Caller should initialize pkt_out either with desired > output > + * packet handles or with ODP_PACKET_INVALID to make ODP allocate new > packets > + * from provided pool. All arrays should be of num_pkt size. Resulting > packets > + * are returned through events. > + * > + * @param pkt_in Packets to be processed > + * @param pkt_out Packet handle array specifying resulting packets > + * @param param Operation parameters array > + * @param num_pkt Number of packets to be processed > + * > + * @return Number of input packets consumed (0 ... num_pkt) > + * @retval <0 on failure > + */ > +int odp_crypto_packet_op_enq(const odp_packet_t pkt_in[], > + const odp_packet_t pkt_out[], > + const odp_crypto_packet_op_param_t > param[], > + int num_pkt); odp_crypto_enc_enq() odp_crypto_dec_enq() -Petri
On 11.07.2017 16:35, Savolainen, Petri (Nokia - FI/Espoo) wrote: > >> diff --git a/include/odp/api/spec/crypto.h b/include/odp/api/spec/crypto.h >> index 454855ea..27b12c89 100644 >> --- a/include/odp/api/spec/crypto.h >> +++ b/include/odp/api/spec/crypto.h >> @@ -16,6 +16,7 @@ >> #include <odp/visibility_begin.h> >> >> #include <odp/api/deprecated.h> >> +#include <odp/api/support.h> >> >> #ifdef __cplusplus >> extern "C" { >> @@ -276,6 +277,9 @@ typedef struct odp_crypto_session_param_t { >> * data in non-posted mode */ >> odp_crypto_op_mode_t ODP_DEPRECATE(pref_mode); >> >> + /** Operation mode when using packet interface: sync or async >> */ >> + odp_crypto_op_mode_t packet_op_mode; >> + > > op_mode is enough. By default deprecated field are not visible, and when user enables those he needs to be aware of using only old definition. So, there's no need for e.g. prefixes in the new version. Actually no. I really wanted to emphasize that this field affects only packet-mode interface. I will change it, as this issue arises on and on. > > >> /** Cipher algorithm >> * >> * Use odp_crypto_capability() for supported algorithms. >> @@ -311,16 +315,15 @@ typedef struct odp_crypto_session_param_t { >> >> /** Async mode completion event queue >> * >> - * When odp_crypto_operation() is asynchronous, the completion >> queue is >> - * used to return the completion status of the operation to >> the >> - * application. >> + * The completion queue is used to return >> odp_crypto_packet_op_enq() >> + * results to the application. >> */ >> odp_queue_t compl_queue; >> >> /** Output pool >> * >> * When the output packet is not specified during the call to >> - * odp_crypto_operation(), the output packet will be allocated >> + * crypto operation, the output packet will be allocated >> * from this pool. >> */ >> odp_pool_t output_pool; >> @@ -400,6 +403,44 @@ typedef struct odp_crypto_op_param_t { >> typedef odp_crypto_op_param_t ODP_DEPRECATE(odp_crypto_op_params_t); >> >> /** >> + * Crypto packet API per packet operation parameters >> + */ >> +typedef struct odp_crypto_packet_op_param_t { >> + /** Session handle from creation */ >> + odp_crypto_session_t session; >> + >> + /** Override session IV pointer */ >> + uint8_t *override_iv_ptr; >> + >> + /** Offset from start of packet for hash result >> + * >> + * Specifies the offset where the hash result is to be stored. >> In case >> + * of decode sessions, input hash values will be read from >> this offset, >> + * and overwritten with hash results. If this offset lies >> within >> + * specified 'auth_range', implementation will mute this field >> before >> + * calculating the hash result. >> + */ >> + uint32_t hash_result_offset; >> + >> + /** Additional Authenticated Data (AAD) */ >> + struct { >> + /** Pointer to ADD */ >> + uint8_t *ptr; >> + >> + /** AAD length in bytes. Use >> odp_crypto_auth_capability() for >> + * supported AAD lengths. */ >> + uint32_t length; >> + } aad; >> + >> + /** Data range to apply cipher */ >> + odp_packet_data_range_t cipher_range; >> + >> + /** Data range to authenticate */ >> + odp_packet_data_range_t auth_range; >> + >> +} odp_crypto_packet_op_param_t; > > > If there are difference in enc/decrypto direction parameters. This type could be split in two and named odp_crypto_enc_param_t and _dec_param_t. This would avoid packet_op_param_t vs op_param_t, and would be closer to ipsec operations. No, there is no diff in the en/dec direction. Just in crypto_operation (includes additional context) and packet_op (no context, just data). >> + >> +/** >> * Crypto API session creation return code >> */ >> typedef enum { >> @@ -444,14 +485,17 @@ typedef enum { >> /** >> * Cryto API per packet operation completion status >> */ >> -typedef struct odp_crypto_compl_status { >> +typedef struct odp_crypto_op_status { >> /** Algorithm specific return code */ >> odp_crypto_alg_err_t alg_err; >> >> /** Hardware specific return code */ >> odp_crypto_hw_err_t hw_err; >> >> -} odp_crypto_compl_status_t; >> +} odp_crypto_op_status_t; >> + >> +/** @deprecated Use ODP_DEPRECATE(odp_crypto_op_status_t) instead */ >> +typedef odp_crypto_op_status_t ODP_DEPRECATE(odp_crypto_compl_status_t); >> >> /** >> * Crypto API operation result >> @@ -460,27 +504,51 @@ typedef struct odp_crypto_op_result { >> /** Request completed successfully */ >> odp_bool_t ok; >> >> - /** User context from request */ >> - void *ctx; >> + /** User context from request >> + * >> + * @deprecated No need to pass context around sync calls >> + * */ >> + void *ODP_DEPRECATE(ctx); >> >> /** Output packet */ >> odp_packet_t pkt; >> >> /** Cipher status */ >> - odp_crypto_compl_status_t cipher_status; >> + odp_crypto_op_status_t cipher_status; >> >> /** Authentication status */ >> - odp_crypto_compl_status_t auth_status; >> + odp_crypto_op_status_t auth_status; >> >> } odp_crypto_op_result_t; > > If this type is not needed in new API, deprecate the entire type instead of a field. It is needed. It represents metadata extracted from packet -- like odp_ipsec_op_result_t. It is just one part that is no more necessary (context). > > >> >> /** >> + * Crypto packet API operation result >> + */ >> +typedef struct odp_crypto_packet_result_t { >> + /** Request completed successfully */ >> + odp_bool_t ok; >> + >> + /** Cipher status */ >> + odp_crypto_op_status_t cipher_status; >> + >> + /** Authentication status */ >> + odp_crypto_op_status_t auth_status; >> + >> +} odp_crypto_packet_result_t; >> + >> +/** >> * Crypto capabilities >> */ >> typedef struct odp_crypto_capability_t { >> /** Maximum number of crypto sessions */ >> uint32_t max_sessions; >> >> + /** Supported packet operation in SYNC mode */ >> + odp_support_t packet_sync_mode; > > Just sync_mode. > >> + >> + /** Supported packet operation in ASYNC mode */ >> + odp_support_t packet_async_mode; > > Just async_mode. > >> + >> /** Supported cipher algorithms */ >> odp_crypto_cipher_algos_t ciphers; >> >> @@ -711,6 +779,94 @@ uint64_t ODP_DEPRECATE(odp_crypto_compl_to_u64)( >> void odp_crypto_session_param_init(odp_crypto_session_param_t *param); >> >> /** >> + * Return crypto processed packet that is associated with event >> + * >> + * Get packet handle to an crypto processed packet event. Event subtype >> must be >> + * ODP_EVENT_PACKET_CRYPTO. Crypto operation results can be examined with >> + * odp_crypto_packet_result(). >> + * >> + * Note: any invalid parameters will cause undefined behavior and may >> cause >> + * the application to abort or crash. >> + * >> + * @param ev Event handle >> + * >> + * @return Packet handle >> + */ >> +odp_packet_t odp_crypto_packet_from_event(odp_event_t ev); >> + >> +/** >> + * Convert crypto packet handle to event >> + * >> + * The packet handle must be an output of an crypto operation. >> + * >> + * @param pkt Packet handle from crypto operation >> + * >> + * @return Event handle >> + */ >> +odp_event_t odp_crypto_packet_to_event(odp_packet_t pkt); >> + >> +/** >> + * Get crypto operation results from an crypto processed packet >> + * >> + * Successful crypto operations of all types (SYNC and ASYNC) produce >> packets >> + * which contain crypto result metadata. This function copies the >> operation >> + * results from an crypto processed packet. Event subtype of this kind of >> + * packet is ODP_EVENT_PACKET_crypto. Results are undefined if a non- >> crypto >> + * processed packet is passed as input. >> + * >> + * @param packet An crypto processed packet >> (ODP_EVENT_PACKET_CRYPTO) >> + * @param[out] result Pointer to operation result for output >> + * >> + * @retval 0 On success >> + * @retval <0 On failure >> + */ >> +int odp_crypto_packet_result(odp_crypto_packet_result_t *result, >> + odp_packet_t packet); >> + >> +/** >> + * Crypto packet operation >> + * >> + * Performs the SYNC cryptographic operations specified during session >> creation >> + * on the packets. Caller should initialize pkt_out either with desired >> output >> + * packet handles or with ODP_PACKET_INVALID to make ODP allocate new >> packets >> + * from provided pool. All arrays should be of num_pkt size. >> + * >> + * @param pkt_in Packets to be processed >> + * @param[in,out] pkt_out Packet handle array specifyint resulting >> packets >> + * @param param Operation parameters array >> + * @param num_pkt Number of packets to be processed >> + * >> + * @return Number of input packets consumed (0 ... num_pkt) >> + * @retval <0 on failure >> + */ >> +int odp_crypto_packet_op(const odp_packet_t pkt_in[], >> + odp_packet_t pkt_out[], >> + const odp_crypto_packet_op_param_t >> param[], >> + int num_pkt); > > odp_crypto_enc() > odp_crypto_dec() > > or > > odp_crypto_op() if dual direction needs to be maintained. Separate functions and params per direction would improve readability and a bit performance. > > >> + >> +/** >> + * Crypto packet operation >> + * >> + * Performs the ASYNC cryptographic operations specified during session >> creation >> + * on the packets. Caller should initialize pkt_out either with desired >> output >> + * packet handles or with ODP_PACKET_INVALID to make ODP allocate new >> packets >> + * from provided pool. All arrays should be of num_pkt size. Resulting >> packets >> + * are returned through events. >> + * >> + * @param pkt_in Packets to be processed >> + * @param pkt_out Packet handle array specifying resulting packets >> + * @param param Operation parameters array >> + * @param num_pkt Number of packets to be processed >> + * >> + * @return Number of input packets consumed (0 ... num_pkt) >> + * @retval <0 on failure >> + */ >> +int odp_crypto_packet_op_enq(const odp_packet_t pkt_in[], >> + const odp_packet_t pkt_out[], >> + const odp_crypto_packet_op_param_t >> param[], >> + int num_pkt); > > odp_crypto_enc_enq() > odp_crypto_dec_enq() Ack for the renames. Thanks for the review! -- With best wishes Dmitry
diff --git a/example/ipsec/odp_ipsec.c b/example/ipsec/odp_ipsec.c index 1ed03585..c618cc46 100644 --- a/example/ipsec/odp_ipsec.c +++ b/example/ipsec/odp_ipsec.c @@ -724,9 +724,9 @@ pkt_disposition_e do_ipsec_in_finish(odp_packet_t pkt, /* Check crypto result */ if (!result->ok) { - if (!is_crypto_compl_status_ok(&result->cipher_status)) + if (!is_crypto_op_status_ok(&result->cipher_status)) return PKT_DROP; - if (!is_crypto_compl_status_ok(&result->auth_status)) + if (!is_crypto_op_status_ok(&result->auth_status)) return PKT_DROP; } ip = (odph_ipv4hdr_t *)odp_packet_l3_ptr(pkt, NULL); @@ -1011,9 +1011,9 @@ pkt_disposition_e do_ipsec_out_finish(odp_packet_t pkt, /* Check crypto result */ if (!result->ok) { - if (!is_crypto_compl_status_ok(&result->cipher_status)) + if (!is_crypto_op_status_ok(&result->cipher_status)) return PKT_DROP; - if (!is_crypto_compl_status_ok(&result->auth_status)) + if (!is_crypto_op_status_ok(&result->auth_status)) return PKT_DROP; } ip = (odph_ipv4hdr_t *)odp_packet_l3_ptr(pkt, NULL); diff --git a/example/ipsec/odp_ipsec_misc.h b/example/ipsec/odp_ipsec_misc.h index 45cb022e..20ebe9fc 100644 --- a/example/ipsec/odp_ipsec_misc.h +++ b/example/ipsec/odp_ipsec_misc.h @@ -321,12 +321,12 @@ void ipv4_adjust_len(odph_ipv4hdr_t *ip, int adj) /** * Verify crypto operation completed successfully * - * @param status Pointer to cryto completion structure + * @param status Pointer to crypto op status structure * * @return TRUE if all OK else FALSE */ static inline -odp_bool_t is_crypto_compl_status_ok(odp_crypto_compl_status_t *status) +odp_bool_t is_crypto_op_status_ok(odp_crypto_op_status_t *status) { if (status->alg_err != ODP_CRYPTO_ALG_ERR_NONE) return FALSE; diff --git a/include/odp/api/spec/crypto.h b/include/odp/api/spec/crypto.h index 454855ea..27b12c89 100644 --- a/include/odp/api/spec/crypto.h +++ b/include/odp/api/spec/crypto.h @@ -16,6 +16,7 @@ #include <odp/visibility_begin.h> #include <odp/api/deprecated.h> +#include <odp/api/support.h> #ifdef __cplusplus extern "C" { @@ -276,6 +277,9 @@ typedef struct odp_crypto_session_param_t { * data in non-posted mode */ odp_crypto_op_mode_t ODP_DEPRECATE(pref_mode); + /** Operation mode when using packet interface: sync or async */ + odp_crypto_op_mode_t packet_op_mode; + /** Cipher algorithm * * Use odp_crypto_capability() for supported algorithms. @@ -311,16 +315,15 @@ typedef struct odp_crypto_session_param_t { /** Async mode completion event queue * - * When odp_crypto_operation() is asynchronous, the completion queue is - * used to return the completion status of the operation to the - * application. + * The completion queue is used to return odp_crypto_packet_op_enq() + * results to the application. */ odp_queue_t compl_queue; /** Output pool * * When the output packet is not specified during the call to - * odp_crypto_operation(), the output packet will be allocated + * crypto operation, the output packet will be allocated * from this pool. */ odp_pool_t output_pool; @@ -400,6 +403,44 @@ typedef struct odp_crypto_op_param_t { typedef odp_crypto_op_param_t ODP_DEPRECATE(odp_crypto_op_params_t); /** + * Crypto packet API per packet operation parameters + */ +typedef struct odp_crypto_packet_op_param_t { + /** Session handle from creation */ + odp_crypto_session_t session; + + /** Override session IV pointer */ + uint8_t *override_iv_ptr; + + /** Offset from start of packet for hash result + * + * Specifies the offset where the hash result is to be stored. In case + * of decode sessions, input hash values will be read from this offset, + * and overwritten with hash results. If this offset lies within + * specified 'auth_range', implementation will mute this field before + * calculating the hash result. + */ + uint32_t hash_result_offset; + + /** Additional Authenticated Data (AAD) */ + struct { + /** Pointer to ADD */ + uint8_t *ptr; + + /** AAD length in bytes. Use odp_crypto_auth_capability() for + * supported AAD lengths. */ + uint32_t length; + } aad; + + /** Data range to apply cipher */ + odp_packet_data_range_t cipher_range; + + /** Data range to authenticate */ + odp_packet_data_range_t auth_range; + +} odp_crypto_packet_op_param_t; + +/** * Crypto API session creation return code */ typedef enum { @@ -444,14 +485,17 @@ typedef enum { /** * Cryto API per packet operation completion status */ -typedef struct odp_crypto_compl_status { +typedef struct odp_crypto_op_status { /** Algorithm specific return code */ odp_crypto_alg_err_t alg_err; /** Hardware specific return code */ odp_crypto_hw_err_t hw_err; -} odp_crypto_compl_status_t; +} odp_crypto_op_status_t; + +/** @deprecated Use ODP_DEPRECATE(odp_crypto_op_status_t) instead */ +typedef odp_crypto_op_status_t ODP_DEPRECATE(odp_crypto_compl_status_t); /** * Crypto API operation result @@ -460,27 +504,51 @@ typedef struct odp_crypto_op_result { /** Request completed successfully */ odp_bool_t ok; - /** User context from request */ - void *ctx; + /** User context from request + * + * @deprecated No need to pass context around sync calls + * */ + void *ODP_DEPRECATE(ctx); /** Output packet */ odp_packet_t pkt; /** Cipher status */ - odp_crypto_compl_status_t cipher_status; + odp_crypto_op_status_t cipher_status; /** Authentication status */ - odp_crypto_compl_status_t auth_status; + odp_crypto_op_status_t auth_status; } odp_crypto_op_result_t; /** + * Crypto packet API operation result + */ +typedef struct odp_crypto_packet_result_t { + /** Request completed successfully */ + odp_bool_t ok; + + /** Cipher status */ + odp_crypto_op_status_t cipher_status; + + /** Authentication status */ + odp_crypto_op_status_t auth_status; + +} odp_crypto_packet_result_t; + +/** * Crypto capabilities */ typedef struct odp_crypto_capability_t { /** Maximum number of crypto sessions */ uint32_t max_sessions; + /** Supported packet operation in SYNC mode */ + odp_support_t packet_sync_mode; + + /** Supported packet operation in ASYNC mode */ + odp_support_t packet_async_mode; + /** Supported cipher algorithms */ odp_crypto_cipher_algos_t ciphers; @@ -711,6 +779,94 @@ uint64_t ODP_DEPRECATE(odp_crypto_compl_to_u64)( void odp_crypto_session_param_init(odp_crypto_session_param_t *param); /** + * Return crypto processed packet that is associated with event + * + * Get packet handle to an crypto processed packet event. Event subtype must be + * ODP_EVENT_PACKET_CRYPTO. Crypto operation results can be examined with + * odp_crypto_packet_result(). + * + * Note: any invalid parameters will cause undefined behavior and may cause + * the application to abort or crash. + * + * @param ev Event handle + * + * @return Packet handle + */ +odp_packet_t odp_crypto_packet_from_event(odp_event_t ev); + +/** + * Convert crypto packet handle to event + * + * The packet handle must be an output of an crypto operation. + * + * @param pkt Packet handle from crypto operation + * + * @return Event handle + */ +odp_event_t odp_crypto_packet_to_event(odp_packet_t pkt); + +/** + * Get crypto operation results from an crypto processed packet + * + * Successful crypto operations of all types (SYNC and ASYNC) produce packets + * which contain crypto result metadata. This function copies the operation + * results from an crypto processed packet. Event subtype of this kind of + * packet is ODP_EVENT_PACKET_crypto. Results are undefined if a non-crypto + * processed packet is passed as input. + * + * @param packet An crypto processed packet (ODP_EVENT_PACKET_CRYPTO) + * @param[out] result Pointer to operation result for output + * + * @retval 0 On success + * @retval <0 On failure + */ +int odp_crypto_packet_result(odp_crypto_packet_result_t *result, + odp_packet_t packet); + +/** + * Crypto packet operation + * + * Performs the SYNC cryptographic operations specified during session creation + * on the packets. Caller should initialize pkt_out either with desired output + * packet handles or with ODP_PACKET_INVALID to make ODP allocate new packets + * from provided pool. All arrays should be of num_pkt size. + * + * @param pkt_in Packets to be processed + * @param[in,out] pkt_out Packet handle array specifyint resulting packets + * @param param Operation parameters array + * @param num_pkt Number of packets to be processed + * + * @return Number of input packets consumed (0 ... num_pkt) + * @retval <0 on failure + */ +int odp_crypto_packet_op(const odp_packet_t pkt_in[], + odp_packet_t pkt_out[], + const odp_crypto_packet_op_param_t param[], + int num_pkt); + +/** + * Crypto packet operation + * + * Performs the ASYNC cryptographic operations specified during session creation + * on the packets. Caller should initialize pkt_out either with desired output + * packet handles or with ODP_PACKET_INVALID to make ODP allocate new packets + * from provided pool. All arrays should be of num_pkt size. Resulting packets + * are returned through events. + * + * @param pkt_in Packets to be processed + * @param pkt_out Packet handle array specifying resulting packets + * @param param Operation parameters array + * @param num_pkt Number of packets to be processed + * + * @return Number of input packets consumed (0 ... num_pkt) + * @retval <0 on failure + */ +int odp_crypto_packet_op_enq(const odp_packet_t pkt_in[], + const odp_packet_t pkt_out[], + const odp_crypto_packet_op_param_t param[], + int num_pkt); + +/** * @} */ diff --git a/include/odp/arch/default/api/abi/event.h b/include/odp/arch/default/api/abi/event.h index 23b16efd..871d2cf9 100644 --- a/include/odp/arch/default/api/abi/event.h +++ b/include/odp/arch/default/api/abi/event.h @@ -37,7 +37,8 @@ typedef enum odp_event_type_t { typedef enum odp_event_subtype_t { ODP_EVENT_NO_SUBTYPE = 0, ODP_EVENT_PACKET_BASIC = 1, - ODP_EVENT_PACKET_IPSEC = 2 + ODP_EVENT_PACKET_CRYPTO = 2, + ODP_EVENT_PACKET_IPSEC = 3 } odp_event_subtype_t; /** diff --git a/platform/linux-generic/include/odp/api/plat/event_types.h b/platform/linux-generic/include/odp/api/plat/event_types.h index 1987bc8b..58ce0a8b 100644 --- a/platform/linux-generic/include/odp/api/plat/event_types.h +++ b/platform/linux-generic/include/odp/api/plat/event_types.h @@ -46,7 +46,8 @@ typedef enum odp_event_type_t { typedef enum odp_event_subtype_t { ODP_EVENT_NO_SUBTYPE = 0, ODP_EVENT_PACKET_BASIC = 1, - ODP_EVENT_PACKET_IPSEC = 2 + ODP_EVENT_PACKET_CRYPTO = 2, + ODP_EVENT_PACKET_IPSEC = 3 } odp_event_subtype_t; /**