[ovs-dev,v2] ovs-actions.xml: Better document the "bundle" and "bundle_load" actions.

Signed-off-by: Ben Pfaff <blp@ovn.org>
---
v1->v2: Add paragraph about liveness.

 lib/ovs-actions.xml | 53 +++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 49 insertions(+), 4 deletions(-)

Bleep bloop.  Greetings Ben Pfaff, I am a robot and I have tried out your patch.
Thanks for your contribution.

I encountered some error that I wasn't expecting.  See the details below.


checkpatch:
WARNING: Line is 188 characters long (recommended limit is 79)
#21 FILE: lib/ovs-actions.xml:792:
      <syntax><code>bundle(</code><var>fields</var><code>, </code><var>basis</var><code>, </code><var>algorithm</var><code>, ofport, slaves:</code><var>port</var>...<code>)</code></syntax>

WARNING: Line is 222 characters long (recommended limit is 79)
#22 FILE: lib/ovs-actions.xml:793:
      <syntax><code>bundle_load(</code><var>fields</var><code>, </code><var>basis</var><code>, </code><var>algorithm</var><code>, ofport, </code><var>dst</var><code>, slaves:</code><var>port</var>...<code>)</code></syntax>

WARNING: Line is 154 characters long (recommended limit is 79)
#59 FILE: lib/ovs-actions.xml:870:
<var>slave</var> = { <var>i</var> such that <var>weights</var>[<var>i</var>] &gt;= <var>weights</var>[<var>j</var>] for all <var>j</var> != <var>i</var> }

Lines checked: 89, Warnings: 3, Errors: 0


Please check this out.  If you feel there has been an error, please email aconole@bytheb.org

Thanks,
0-day Robot

On Thu, May 2, 2019 at 11:28 PM Ben Pfaff <blp@ovn.org> wrote:

> Signed-off-by: Ben Pfaff <blp@ovn.org>
>

Acked-by: Numan Siddique <nusiddiq@redhat.com>



> ---
> v1->v2: Add paragraph about liveness.
>
>  lib/ovs-actions.xml | 53 +++++++++++++++++++++++++++++++++++++++++----
>  1 file changed, 49 insertions(+), 4 deletions(-)
>
> diff --git a/lib/ovs-actions.xml b/lib/ovs-actions.xml
> index cfd9b81be604..76aa5afb4d06 100644
> --- a/lib/ovs-actions.xml
> +++ b/lib/ovs-actions.xml
> @@ -789,15 +789,15 @@ $ ovs-ofctl -O OpenFlow10 add-flow br0
> actions=mod_nw_src:1.2.3.4
>
>      <action name="BUNDLE,BUNDLE_LOAD">
>        <h2>The <code>bundle</code> and <code>bundle_load</code>
> actions</h2>
> -      <syntax><code>bundle(</code><var>fields</var><code>,
> </code><var>basis</var><code>, </code><var>algorithm</var><code>,
> </code>ofport<code>, slaves:</code><var>port</var>...<code>)</code></syntax>
> -      <syntax><code>bundle_load(</code><var>fields</var><code>,
> </code><var>basis</var><code>, </code><var>algorithm</var><code>,
> </code>ofport<code>, </code><var>dst</var><code>,
> slaves:</code><var>port</var>...<code>)</code></syntax>
> +      <syntax><code>bundle(</code><var>fields</var><code>,
> </code><var>basis</var><code>, </code><var>algorithm</var><code>, ofport,
> slaves:</code><var>port</var>...<code>)</code></syntax>
> +      <syntax><code>bundle_load(</code><var>fields</var><code>,
> </code><var>basis</var><code>, </code><var>algorithm</var><code>, ofport,
> </code><var>dst</var><code>,
> slaves:</code><var>port</var>...<code>)</code></syntax>
>
>        <p>
>          These actions choose a port (``slave'') from a comma-separated
> OpenFlow
>          <var>port</var> list.  After selecting the port,
> <code>bundle</code>
>          outputs to it, whereas <code>bundle_load</code> writes its port
> number
> -        to <var>dst</var>, which must be a field or subfield in the syntax
> -        described under ``Field Specifications'' above.
> +        to <var>dst</var>, which must be a 16-bit or wider field or
> subfield in
> +        the syntax described under ``Field Specifications'' above.
>        </p>
>
>        <p>
> @@ -847,6 +847,51 @@ $ ovs-ofctl -O OpenFlow10 add-flow br0
> actions=mod_nw_src:1.2.3.4
>          </dd>
>        </dl>
>
> +      <p>
> +        <var>algorithm</var> must be one of the following:
> +      </p>
> +
> +      <dl>
> +        <dt><code>active_backup</code></dt>
> +        <dd>
> +          Chooses the first live port listed in <var>slaves</var>.
> +        </dd>
> +
> +        <dt><code>hrw</code> (Highest Random Weight)</dt>
> +        <dd>
> +          <p>
> +            Computes the following, considering only the live ports in
> +            <var>slaves</var>:
> +          </p>
> +
> +          <pre>
> +for <var>i</var> in [1,<var>n_slaves</var>]:
> +    <var>weights</var>[<var>i</var>] = hash(<var>flow</var>, <var>i</var>)
> +<var>slave</var> = { <var>i</var> such that
> <var>weights</var>[<var>i</var>] &gt;= <var>weights</var>[<var>j</var>] for
> all <var>j</var> != <var>i</var> }
> +          </pre>
> +
> +          <p>
> +            This algorithm is specified by RFC 2992.
> +          </p>
> +        </dd>
> +      </dl>
> +
> +      <p>
> +        The algorithms take port liveness into account when selecting
> slaves.
> +        The definition of whether a port is live is subject to change.  It
> +        currently takes into account carrier status and link monitoring
> +        protocols such as BFD and CFM.  If none of the slaves is live,
> +        <code>bundle</code> does not output the packet and
> +        <code>bundle_load</code> stores <code>OFPP_NONE</code> (65535) in
> the
> +        output field.
> +      </p>
> +
> +      <p>
> +        Example: <code>bundle(eth_src,0,hrw,ofport,slaves:4,8)</code>
> uses an
> +        Ethernet source hash with basis 0, to select between OpenFlow
> ports 4
> +        and 8 using the Highest Random Weight algorithm.
> +      </p>
> +
>        <conformance>
>          Open vSwitch 1.2 introduced the <code>bundle</code> and
>          <code>bundle_load</code> OpenFlow extension actions.
> --
> 2.20.1
>
> _______________________________________________
> dev mailing list
> dev@openvswitch.org
> https://mail.openvswitch.org/mailman/listinfo/ovs-dev
>

On Fri, May 10, 2019 at 02:37:33PM +0530, Numan Siddique wrote:
> On Thu, May 2, 2019 at 11:28 PM Ben Pfaff <blp@ovn.org> wrote:
> 
> > Signed-off-by: Ben Pfaff <blp@ovn.org>
> >
> 
> Acked-by: Numan Siddique <nusiddiq@redhat.com>

Thanks, applied to master.