Regards,
Bala
On 15 June 2017 at 19:51, Petri Savolainen <petri.savolai...@linaro.org>
wrote:
> Added packet pool parameters for more fine grained pool
> configuration. The basic usage of the parameters is not changed,
> except that implementation may now round up 'num' by default.
> Application can limit the round up with new 'max_num' parameter.
> Another new parameter (opt) allows application give hints and
> requirements about e.g. memory to be used for a pool (or parts
> of the pool).
>
> Additionally, pool configuration may be extended with a table of
> num/len/opt values. This gives application more flexibility to
> specify requirements for various packet sizes.
>
> For example, the new specification allows to create this kind of
> pool:
>
> ^
> |
> max_num | - - - - - - - -
> |
> | *
> NUM | * *
> | * * *
> | o * * * *
> | o * * * * *
> +--------------->
> LEN
>
> o == small number of short packets into fast memory
> * == all other packets into DDR
>
> Signed-off-by: Petri Savolainen <petri.savolai...@linaro.org>
> ---
> include/odp/api/spec/pool.h | 132 ++++++++++++++++++++++++++++++
> +++++++++-----
> 1 file changed, 118 insertions(+), 14 deletions(-)
>
> diff --git a/include/odp/api/spec/pool.h b/include/odp/api/spec/pool.h
> index 6fc5b6b4..6b4e7495 100644
> --- a/include/odp/api/spec/pool.h
> +++ b/include/odp/api/spec/pool.h
> @@ -41,6 +41,9 @@ extern "C" {
> * Maximum pool name length in chars including null char
> */
>
> +/** Maximum number of packet pool subparameters */
> +#define ODP_POOL_PKT_SUB_MAX 7
> +
> /**
> * Pool capabilities
> */
> @@ -156,6 +159,30 @@ typedef struct odp_pool_capability_t {
> int odp_pool_capability(odp_pool_capability_t *capa);
>
> /**
> + * Pool memory type
> + */
> +typedef enum odp_pool_mem_type_t {
> + /** Default memory type */
> + ODP_POOL_MEM_DEFAULT = 0,
> +
> + /** Fast memory. Some implementations may have a restricted amount
> of
> + * (e.g. chip internal) pool memory that is faster access than the
> + * default memory type. */
> + ODP_POOL_MEM_FAST
> +
> +} odp_pool_mem_type_t;
>
We need to add this to capability for implementations to expose which is
supported.
> +
> +/**
> + * Additional options for packet pool creation
> + */
> +typedef struct odp_pool_pkt_opt_t {
> + /** Pool memory type. Hint which memory type should be used for the
> + * pool or a subset of the pool. */
> + odp_pool_mem_type_t mem_type;
> +
> +} odp_pool_pkt_opt_t;
> +
> +/**
> * Pool parameters
> * Used to communicate pool creation options.
> * @note A single thread may not be able to allocate all 'num' elements
> @@ -185,35 +212,96 @@ typedef struct odp_pool_param_t {
>
> /** Parameters for packet pools */
> struct {
> - /** The number of packets that the pool must
> provide
> - that are packet length 'len' bytes or smaller.
> - The maximum value is defined by pool capability
> - pkt.max_num. */
> + /** The minimum number of packets that are packet
> length
> + * 'len' bytes or smaller. The maximum value is
> defined
> + * by pool capability pkt.max_num. An
> implementation
> + * may round up the value, as long as the
> 'max_num'
> + * parameter below is not violated.
> + */
> uint32_t num;
>
> - /** Minimum packet length that the pool must
> provide
> - 'num' packets. The number of packets may be
> less
> - than 'num' when packets are larger than 'len'.
> - The maximum value is defined by pool capability
> - pkt.max_len. Use 0 for default. */
> + /** The minimum packet length that at least 'num'
> + * packets are required. The maximum value is
> defined
> + * by pool capability pkt.max_len. Use 0 for
> default.
> + */
> uint32_t len;
>
> + /** Packet pool options
> + *
> + * Options contain additional hints and
> requirements,
> + * which quide implementation e.g. to select
> correct
> + * memory type for the pool.
> + */
> + odp_pool_pkt_opt_t opt;
>
If lets say the implementation does not support MEM_FAST then it could be
documented saying it will revert to DEFAULT memory type.
+
> + /** Number of subparameters
> + *
> + * The number of subparameter table (pkt.sub[])
> entries
> + * filled in. Subparameters continue pool
> configuration
> + * after the three parameters ('num', 'len' and
> 'opt').
> + * above. The value must not exceed
> + * ODP_POOL_PKT_SUB_MAX. The default value is 0.
> + */
> + uint8_t num_sub;
> +
> /** Maximum packet length that will be allocated
> from
> the pool. The maximum value is defined by pool
> capability pkt.max_len. Use 0 for default (the
> pool maximum). */
> uint32_t max_len;
>
> + /** Maximum number of packets
> + *
> + * This is the maximum number of packets of any
> length
> + * that can be allocated from the pool. The
> maximum
> + * value is defined by pool capability
> pkt.max_num.
> + * Use 0 for no requirement for maximum number.
> + * The default value is 0.
> + */
> + uint32_t max_num;
> +
> /** Minimum number of packet data bytes that are
> stored
> - in the first segment of a packet. The maximum
> value
> - is defined by pool capability pkt.max_seg_len.
> - Use 0 for default. */
> + * in the first segment of a packet. The maximum
> value
> + * is defined by pool capability pkt.max_seg_len.
> + * Use equal value with 'max_len' to ensure that
> all
> + * packets are single segment. Use 0 for default.
> + */
> uint32_t seg_len;
>
> /** User area size in bytes. The maximum value is
> defined by pool capability pkt.max_uarea_size.
> Specify as 0 if no user area is needed. */
> uint32_t uarea_size;
> +
> + /** Packet pool subparameters
> + *
> + * This table gives more fine grained
> requirements for
> + * pool configuration. The table continues from
> + * num/len/opt specification above. Therefore,
> + * pkt.sub[0].len must be greater than pkt.len,
> and
> + * pkt.sub[0].num refers to packet lengths between
> + * pkt.len + 1 and pkt.sub[0].len.
> + *
> + * Table enties must be ordered by the packet
> length.
> + * A number of packets figure (pkt.sub[N].num)
> refers
> + * to packet lengths between pkt.sub[N-1].len + 1
> and
> + * pkt.sub[N].len. Each number of packets
> requirement
> + * may be rounded up, as long as the 'max_num'
> + * parameter is not violated. A pool fulfills each
> + * num/len requirement separately (when there are
> no
> + * other allocations from the pool).
> + */
> + struct {
> + /** Number of packets */
> + uint32_t num;
> +
> + /** Packet length in bytes */
> + uint32_t len;
> +
> + /** Packet pool options */
> + odp_pool_pkt_opt_t opt;
> +
> + } sub[ODP_POOL_PKT_SUB_MAX];
> } pkt;
>
> /** Parameters for timeout pools */
> @@ -278,8 +366,24 @@ odp_pool_t odp_pool_lookup(const char *name);
> * Used to get information about a pool.
> */
> typedef struct odp_pool_info_t {
> - const char *name; /**< pool name */
> - odp_pool_param_t params; /**< pool parameters */
> + /** Pool name */
> + const char *name;
> +
> + /** Copy of the pool parameters */
> + odp_pool_param_t params;
> +
> + /** Packet pool info */
> + struct {
> + /** Maximum number of packets of any length
> + *
> + * This many packets in maximum can be allocated from the
> pool.
> + * Application can use this e.g. to prepare enough per
> packet
> + * contexts.
> + */
> + uint32_t max_num;
> +
> + } pkt;
> +
> } odp_pool_info_t;
>
> /**
> --
> 2.13.0
>
>
