| Message ID | 1499781629-30670-7-git-send-email-odpbot@yandex.ru |
|---|---|
| State | New |
| Headers | show |
| Series | [API-NEXT,v9,1/10] linux-generic: events subtype implementation | expand |
On Tue, Jul 11, 2017 at 7:30 PM, Github ODP bot <odpbot@yandex.ru> wrote: > From: Dmitry Eremin-Solenikov <dmitry.ereminsolenikov@linaro.org> > > Input and output of crypto operations are packets. API is more flexible > for application and API pipelining when output is packet with additional > metadata. Application or API pipeline stages which do not care about > crypto results may work on basic packet metadata. > > Crypto result event type changes from ODP_EVENT_CRYPTO_COMPL to > ODP_EVENT_PACKET. Event subtype (ODP_EVENT_PACKET_CRYPTO) can be > used to identify packets with crypto metadata. > > Signed-off-by: Dmitry Eremin-Solenikov <dmitry.ereminsolenikov@linaro.org> > --- > /** Email created from pull request 64 (lumag:crypto-packet) > ** https://github.com/Linaro/odp/pull/64 > ** Patch: https://github.com/Linaro/odp/pull/64.patch > ** Base sha: c7718962c6633c80eb71a0400d89c31f11f88045 > ** Merge commit sha: 6b4b95ac299d32801f55cf75ba31016675ac1afb > **/ > example/ipsec/odp_ipsec.c | 8 +- > example/ipsec/odp_ipsec_misc.h | 4 +- > include/odp/api/spec/crypto.h | 176 +++++++++++++++++++-- > include/odp/arch/default/api/abi/event.h | 3 +- > .../include/odp/api/plat/event_types.h | 3 +- > 5 files changed, 176 insertions(+), 18 deletions(-) > > 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 b9d42937..013507f9 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; > Does it mean "completion queue is used to return event of subtype ODP_CRYPTO_COMPL for event of type ODP_EVENT_PACKET" ?We don't deque result, we deque event right? > /** 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; > > @@ -713,6 +781,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); > + Is there any specific reason why we are not using odp_packet_from_event() API here? and then odp_crypto_result_from_packet()? > +/** > + * 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; > > /** >
On 24/07/17 14:11, shally verma wrote: > On Tue, Jul 11, 2017 at 7:30 PM, Github ODP bot <odpbot@yandex.ru> wrote: >> From: Dmitry Eremin-Solenikov <dmitry.ereminsolenikov@linaro.org> >> @@ -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; >> > Does it mean "completion queue is used to return event of subtype > ODP_CRYPTO_COMPL for event of type ODP_EVENT_PACKET" ?We don't deque > result, we deque event right? Actually no. Probably I should re-clarify this. This queue can be used to deliver both ODP_CRYPTO_COMPL (if application uses odp_crypto_operation()) and ODP_EVENT_PACKET (if application uses odp_crypto_op_enq()). >> 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); >> + > > Is there any specific reason why we are not using > odp_packet_from_event() API here? > and then odp_crypto_result_from_packet()? As suggested by Petri for IPsec packets, implementation might have faster implementation for such conversion functions if it knows packet subtype. -- With best wishes Dmitry
On Mon, Jul 24, 2017 at 5:27 PM, Dmitry Eremin-Solenikov <dmitry.ereminsolenikov@linaro.org> wrote: > On 24/07/17 14:11, shally verma wrote: >> On Tue, Jul 11, 2017 at 7:30 PM, Github ODP bot <odpbot@yandex.ru> wrote: >>> From: Dmitry Eremin-Solenikov <dmitry.ereminsolenikov@linaro.org> > >>> @@ -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; >>> >> Does it mean "completion queue is used to return event of subtype >> ODP_CRYPTO_COMPL for event of type ODP_EVENT_PACKET" ?We don't deque >> result, we deque event right? > > Actually no. Probably I should re-clarify this. This queue can be used > to deliver both ODP_CRYPTO_COMPL (if application uses > odp_crypto_operation()) and ODP_EVENT_PACKET (if application uses > odp_crypto_op_enq()). > Are we keeping odp_crypto_operation() in backward compatible mode? if user call this with input type as packets then it will work as designated earlier (posting results to completion queue with event ODP_CRYPTO_COMPL for async mode)? And introducing new API odp_crypto_packet_op_enq() (not *odp_crypto_op_enq()*)? which en-queue ODP_EVENT_PACKET ? May be I missed some updates here. Shally > >>> 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); >>> + >> >> Is there any specific reason why we are not using >> odp_packet_from_event() API here? >> and then odp_crypto_result_from_packet()? > > As suggested by Petri for IPsec packets, implementation might have > faster implementation for such conversion functions if it knows > packet subtype. > > -- > With best wishes > Dmitry
On 24/07/17 15:12, shally verma wrote: > On Mon, Jul 24, 2017 at 5:27 PM, Dmitry Eremin-Solenikov > <dmitry.ereminsolenikov@linaro.org> wrote: >> On 24/07/17 14:11, shally verma wrote: >>> On Tue, Jul 11, 2017 at 7:30 PM, Github ODP bot <odpbot@yandex.ru> wrote: >>>> From: Dmitry Eremin-Solenikov <dmitry.ereminsolenikov@linaro.org> >> >>>> @@ -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; >>>> >>> Does it mean "completion queue is used to return event of subtype >>> ODP_CRYPTO_COMPL for event of type ODP_EVENT_PACKET" ?We don't deque >>> result, we deque event right? >> >> Actually no. Probably I should re-clarify this. This queue can be used >> to deliver both ODP_CRYPTO_COMPL (if application uses >> odp_crypto_operation()) and ODP_EVENT_PACKET (if application uses >> odp_crypto_op_enq()). >> > > Are we keeping odp_crypto_operation() in backward compatible mode? if > user call this with input type as packets then it will work as > designated earlier (posting results to completion queue with event > ODP_CRYPTO_COMPL for async mode)? > And introducing new API odp_crypto_packet_op_enq() (not > *odp_crypto_op_enq()*)? which en-queue ODP_EVENT_PACKET ? > May be I missed some updates here. Yes, we are keeping odp_crypto_operation() for some time, because it was a part of API for quite some time and we would like to allow users to still use it, comparing it with packet interface. If application calls odp_crypto_operation() it might receive ODP_CRYPTO_COMPL events. If application calls odp_crypto_op_enq(), it will receive only ODP_EVENT_PACKET events. > > Shally >> >>>> 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); >>>> + >>> >>> Is there any specific reason why we are not using >>> odp_packet_from_event() API here? >>> and then odp_crypto_result_from_packet()? >> >> As suggested by Petri for IPsec packets, implementation might have >> faster implementation for such conversion functions if it knows >> packet subtype. >> >> -- >> With best wishes >> Dmitry -- With best wishes Dmitry
On Mon, Jul 24, 2017 at 5:55 PM, Dmitry Eremin-Solenikov <dmitry.ereminsolenikov@linaro.org> wrote: > On 24/07/17 15:12, shally verma wrote: >> On Mon, Jul 24, 2017 at 5:27 PM, Dmitry Eremin-Solenikov >> <dmitry.ereminsolenikov@linaro.org> wrote: >>> On 24/07/17 14:11, shally verma wrote: >>>> On Tue, Jul 11, 2017 at 7:30 PM, Github ODP bot <odpbot@yandex.ru> wrote: >>>>> From: Dmitry Eremin-Solenikov <dmitry.ereminsolenikov@linaro.org> >>> >>>>> @@ -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; >>>>> >>>> Does it mean "completion queue is used to return event of subtype >>>> ODP_CRYPTO_COMPL for event of type ODP_EVENT_PACKET" ?We don't deque >>>> result, we deque event right? >>> >>> Actually no. Probably I should re-clarify this. This queue can be used >>> to deliver both ODP_CRYPTO_COMPL (if application uses >>> odp_crypto_operation()) and ODP_EVENT_PACKET (if application uses >>> odp_crypto_op_enq()). >>> >> >> Are we keeping odp_crypto_operation() in backward compatible mode? if >> user call this with input type as packets then it will work as >> designated earlier (posting results to completion queue with event >> ODP_CRYPTO_COMPL for async mode)? >> And introducing new API odp_crypto_packet_op_enq() (not >> *odp_crypto_op_enq()*)? which en-queue ODP_EVENT_PACKET ? >> May be I missed some updates here. > > Yes, we are keeping odp_crypto_operation() for some time, because it was > a part of API for quite some time and we would like to allow users to > still use it, comparing it with packet interface. > > If application calls odp_crypto_operation() it might receive > ODP_CRYPTO_COMPL events. If application calls odp_crypto_op_enq(), it > will receive only ODP_EVENT_PACKET events. > You are referring odp_crypto_op_enq() but this patch has odp_crypto_packet_op_enq(). so this API (odp_crypto_packet_op_enq()) not relevant? >> >> Shally >>> >>>>> 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); >>>>> + >>>> >>>> Is there any specific reason why we are not using >>>> odp_packet_from_event() API here? >>>> and then odp_crypto_result_from_packet()? >>> >>> As suggested by Petri for IPsec packets, implementation might have >>> faster implementation for such conversion functions if it knows >>> packet subtype. >>> >>> -- >>> With best wishes >>> Dmitry > > > -- > With best wishes > Dmitry
On 24/07/17 15:28, shally verma wrote: > On Mon, Jul 24, 2017 at 5:55 PM, Dmitry Eremin-Solenikov > <dmitry.ereminsolenikov@linaro.org> wrote: >> On 24/07/17 15:12, shally verma wrote: >>> On Mon, Jul 24, 2017 at 5:27 PM, Dmitry Eremin-Solenikov >>> <dmitry.ereminsolenikov@linaro.org> wrote: >>>> On 24/07/17 14:11, shally verma wrote: >>>>> On Tue, Jul 11, 2017 at 7:30 PM, Github ODP bot <odpbot@yandex.ru> wrote: >>>>>> From: Dmitry Eremin-Solenikov <dmitry.ereminsolenikov@linaro.org> >>>> >>>>>> @@ -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; >>>>>> >>>>> Does it mean "completion queue is used to return event of subtype >>>>> ODP_CRYPTO_COMPL for event of type ODP_EVENT_PACKET" ?We don't deque >>>>> result, we deque event right? >>>> >>>> Actually no. Probably I should re-clarify this. This queue can be used >>>> to deliver both ODP_CRYPTO_COMPL (if application uses >>>> odp_crypto_operation()) and ODP_EVENT_PACKET (if application uses >>>> odp_crypto_op_enq()). >>>> >>> >>> Are we keeping odp_crypto_operation() in backward compatible mode? if >>> user call this with input type as packets then it will work as >>> designated earlier (posting results to completion queue with event >>> ODP_CRYPTO_COMPL for async mode)? >>> And introducing new API odp_crypto_packet_op_enq() (not >>> *odp_crypto_op_enq()*)? which en-queue ODP_EVENT_PACKET ? >>> May be I missed some updates here. >> >> Yes, we are keeping odp_crypto_operation() for some time, because it was >> a part of API for quite some time and we would like to allow users to >> still use it, comparing it with packet interface. >> >> If application calls odp_crypto_operation() it might receive >> ODP_CRYPTO_COMPL events. If application calls odp_crypto_op_enq(), it >> will receive only ODP_EVENT_PACKET events. >> > > You are referring odp_crypto_op_enq() but this patch has > odp_crypto_packet_op_enq(). so this API (odp_crypto_packet_op_enq()) > not relevant? The comment is a leftover from earlier patchset version. I will post documentation clarification soon. -- 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 b9d42937..013507f9 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; @@ -713,6 +781,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; /**