From: Thomas Monjalon <thomas@monjalon.net>
To: Jerin Jacob <jerinj@marvell.com>
Cc: Cristian Dumitrescu <cristian.dumitrescu@intel.com>,
Ferruh Yigit <ferruh.yigit@intel.com>,
Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>,
dev@dpdk.org, lizh@nvidia.com, ajit.khaparde@broadcom.com,
jasvinder.singh@intel.com, matan@nvidia.com
Subject: Re: [dpdk-dev] [PATCH v2] doc: mtr: add API walk through
Date: Wed, 04 Aug 2021 18:46:33 +0200 [thread overview]
Message-ID: <2421437.SPqgGMI9PB@thomas> (raw)
In-Reply-To: <20210804113410.3604616-1-jerinj@marvell.com>
04/08/2021 13:34, jerinj@marvell.com:
> --- a/doc/guides/prog_guide/traffic_metering_and_policing.rst
> +++ b/doc/guides/prog_guide/traffic_metering_and_policing.rst
> @@ -14,12 +14,13 @@ SW or mixed HW-SW implementation.
>
> The main features are:
>
> -* Part of DPDK rte_ethdev API
> -* Capability query API
> -* Metering algorithms: RFC 2697 Single Rate Three Color Marker (srTCM), RFC 2698
> - and RFC 4115 Two Rate Three Color Marker (trTCM)
> -* Policer actions (per meter output color): recolor, drop
> -* Statistics (per policer output color)
> +#. Part of DPDK rte_ethdev API
> +#. Capability query API
> +#. Metering algorithms: RFC 2697 Single Rate Three Color Marker (srTCM), RFC 2698
> + and RFC 4115 Two Rate Three Color Marker (trTCM)
> +#. Policer actions (per meter output color): recolor, drop
> +#. Statistics (per policer output color)
> +#. Chaining the meter objects
Why changing to numbered list? There is no specific order?
[...]
> +API Walk-through
> +----------------
> +
> +.. _figure_meter_components:
This anchor is not used. Not needed I think.
> +
> +.. figure:: img/meter.*
> +
> + Meter components
> +
> +This section will introduce the reader to the critical APIs to use
> +the traffic meter and policing library.
> +
> +In general, the following steps performed by the application to configure
I think the verb "are" is missing.
> +the traffic meter and policing library.
> +
> +#. Application gets the meter driver capabilities using ``rte_mtr_capabilities_get()``.
> +#. Application identifies the profile(s) needed for metering and creates it with
> + ``rte_mtr_meter_profile_add()``.
> +#. Application identifies the policies needed and creates it with ``rte_mtr_meter_policy_add()``.
> +#. An meter object consists of a profile and a policy. Use above created objects to create
s/An/a/
> + meter object using ``rte_mtr_create()``. Application uses
> + ``struct rte_mtr_params::meter_profile_id`` and ``struct rte_mtr_params::meter_policy_id``
> + to specify the profile(created in step 2) and policy(created in step 3).
missing space before parentheseses.
> +#. Once the meter object is created, the application shall use ``rte_flow_create()`` API to
> + instantiate the meter object using ``RTE_FLOW_ACTION_TYPE_METER`` action.
> +#. The API allows chaining the meter objects to create complex metering topology
> + by specifying ``struct rte_mtr_meter_policy_params::actions`` as
> + ``RTE_FLOW_ACTION_TYPE_METER`` the parent meter object.
Not sure this last sentence is clear about what is the parent.
next prev parent reply other threads:[~2021-08-04 16:46 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-07-18 9:44 [dpdk-dev] [PATCH] " jerinj
2021-07-27 11:21 ` Jerin Jacob
2021-08-04 11:34 ` [dpdk-dev] [PATCH v2] " jerinj
2021-08-04 16:46 ` Thomas Monjalon [this message]
2021-08-05 10:10 ` [dpdk-dev] [PATCH v3] " jerinj
2021-08-05 11:05 ` [dpdk-dev] [WARNING: UNSCANNABLE EXTRACTION FAILED][WARNING: UNSCANNABLE EXTRACTION FAILED] " Dumitrescu, Cristian
2021-08-05 12:32 ` Jerin Jacob
2021-08-05 22:17 ` Dumitrescu, Cristian
2021-08-06 8:49 ` Jerin Jacob
2021-08-06 9:43 ` [dpdk-dev] " jerinj
2021-08-06 9:45 ` [dpdk-dev] [PATCH v5] " jerinj
2021-08-06 17:46 ` [dpdk-dev] [WARNING: UNSCANNABLE EXTRACTION FAILED][WARNING: UNSCANNABLE EXTRACTION FAILED] " Dumitrescu, Cristian
2021-08-07 8:16 ` Jerin Jacob
2021-08-07 8:21 ` [dpdk-dev] [PATCH v6] " jerinj
2021-08-09 8:37 ` [dpdk-dev] [WARNING: UNSCANNABLE EXTRACTION FAILED][WARNING: UNSCANNABLE EXTRACTION FAILED] " Dumitrescu, Cristian
2021-11-26 13:45 ` David Marchand
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=2421437.SPqgGMI9PB@thomas \
--to=thomas@monjalon.net \
--cc=ajit.khaparde@broadcom.com \
--cc=andrew.rybchenko@oktetlabs.ru \
--cc=cristian.dumitrescu@intel.com \
--cc=dev@dpdk.org \
--cc=ferruh.yigit@intel.com \
--cc=jasvinder.singh@intel.com \
--cc=jerinj@marvell.com \
--cc=lizh@nvidia.com \
--cc=matan@nvidia.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).