Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
MIME-Version: 1.0
References: <20210707174022.517-1-royujjal@gmail.com>
In-Reply-To: <20210707174022.517-1-royujjal@gmail.com>
From:   Song Liu <song@kernel.org>
Date:   Wed, 7 Jul 2021 15:22:57 -0700
Message-ID: <CAPhsuW78LzzFL_=9LmfXWxfh9=mG1CP33+w_cko1=W8BSag+RA@mail.gmail.com>
Subject: Re: [PATCH] docs: bpf: Added more extension example
To:     UjjaL Roy <royujjal@gmail.com>
Cc:     Alexei Starovoitov <ast@kernel.org>,
        Daniel Borkmann <daniel@iogearbox.net>,
        Andrii Nakryiko <andrii@kernel.org>,
        Martin KaFai Lau <kafai@fb.com>,
        Song Liu <songliubraving@fb.com>, Yonghong Song <yhs@fb.com>,
        John Fastabend <john.fastabend@gmail.com>,
        KP Singh <kpsingh@kernel.org>,
        "David S . Miller" <davem@davemloft.net>,
        Jakub Kicinski <kuba@kernel.org>,
        Jonathan Corbet <corbet@lwn.net>,
        Paul Walmsley <paul.walmsley@sifive.com>,
        Palmer Dabbelt <palmer@dabbelt.com>,
        Albert Ou <aou@eecs.berkeley.edu>,
        Nathan Chancellor <nathan@kernel.org>,
        Nick Desaulniers <ndesaulniers@google.com>,
        Networking <netdev@vger.kernel.org>, bpf <bpf@vger.kernel.org>,
        Linux Doc Mailing List <linux-doc@vger.kernel.org>,
        open list <linux-kernel@vger.kernel.org>,
        linux-riscv@lists.infradead.org, clang-built-linux@googlegroups.com
Content-Type: text/plain; charset="UTF-8"
Precedence: bulk

On Wed, Jul 7, 2021 at 10:50 AM UjjaL Roy <royujjal@gmail.com> wrote:
>
> From: "Roy, UjjaL" <royujjal@gmail.com>
>
> After reading this document observed that for new users it is
> hard to find an example of "extension" easily.
>
> So, added a new heading for extensions for better readability.
> Now, the new readers can easily identify "extension" examples.
> Also, added one more example of filtering interface index.
>
> Signed-off-by: Roy, UjjaL <royujjal@gmail.com>

Please prefix the subject with the target tree. In this case, the subject should
say [PATCH bpf-next] xxx. Also, please revise the commit log as suggested in
Documentation/process/submitting-patches.rst:

Describe your changes in imperative mood, e.g. "make xyzzy do frotz"
instead of "[This patch] makes xyzzy do frotz" or "[I] changed xyzzy
to do frotz", as if you are giving orders to the codebase to change
its behaviour.

Otherwise, this change looks good to me. You can add my Acked-by
tag in v2. (prefix v2 with [PATCH v2 bpf-next].

Thanks,
Song

Acked-by: Song Liu <songliubraving@fb.com>

> ---
>  Documentation/networking/filter.rst | 23 ++++++++++++++++-------
>  1 file changed, 16 insertions(+), 7 deletions(-)
>
> diff --git a/Documentation/networking/filter.rst b/Documentation/networking/filter.rst
> index 3e2221f4abe4..5f13905b12e0 100644
> --- a/Documentation/networking/filter.rst
> +++ b/Documentation/networking/filter.rst
> @@ -320,13 +320,6 @@ Examples for low-level BPF:
>    ret #-1
>    drop: ret #0
>
> -**(Accelerated) VLAN w/ id 10**::
> -
> -  ld vlan_tci
> -  jneq #10, drop
> -  ret #-1
> -  drop: ret #0
> -
>  **icmp random packet sampling, 1 in 4**::
>
>    ldh [12]
> @@ -358,6 +351,22 @@ Examples for low-level BPF:
>    bad: ret #0             /* SECCOMP_RET_KILL_THREAD */
>    good: ret #0x7fff0000   /* SECCOMP_RET_ALLOW */
>
> +Examples for low-level BPF extension:
> +
> +**Packet for interface index 13**::
> +
> +  ld ifidx
> +  jneq #13, drop
> +  ret #-1
> +  drop: ret #0
> +
> +**(Accelerated) VLAN w/ id 10**::
> +
> +  ld vlan_tci
> +  jneq #10, drop
> +  ret #-1
> +  drop: ret #0
> +
>  The above example code can be placed into a file (here called "foo"), and
>  then be passed to the bpf_asm tool for generating opcodes, output that xt_bpf
>  and cls_bpf understands and can directly be loaded with. Example with above
> --
> 2.17.1
>