Commit 6182e0b8 authored by Donald Hunter's avatar Donald Hunter Committed by Andrii Nakryiko
Browse files

docs/bpf: Add missing BPF program types to docs 



Update the table of program types in the libbpf documentation with the
recently added program types.

Signed-off-by: default avatarDonald Hunter <donald.hunter@gmail.com>
Signed-off-by: default avatarAndrii Nakryiko <andrii@kernel.org>
Link: https://lore.kernel.org/bpf/20240912095944.6386-1-donald.hunter@gmail.com
parent c229c17a

Documentation/bpf/libbpf/program_types.rst

+26 −4
Original line number Diff line number Diff line
@@ -121,6 +121,8 @@ described in more detail in the footnotes. 
+-------------------------------------------+----------------------------------------+----------------------------------+-----------+

| ``BPF_PROG_TYPE_LWT_XMIT``                |                                        | ``lwt_xmit``                     |           |

+-------------------------------------------+----------------------------------------+----------------------------------+-----------+

| ``BPF_PROG_TYPE_NETFILTER``               |                                        | ``netfilter``                    |           |

+-------------------------------------------+----------------------------------------+----------------------------------+-----------+

| ``BPF_PROG_TYPE_PERF_EVENT``              |                                        | ``perf_event``                   |           |

+-------------------------------------------+----------------------------------------+----------------------------------+-----------+

| ``BPF_PROG_TYPE_RAW_TRACEPOINT_WRITABLE`` |                                        | ``raw_tp.w+`` [#rawtp]_          |           |
@@ -131,11 +133,23 @@ described in more detail in the footnotes. 
+                                           +                                        +----------------------------------+-----------+

|                                           |                                        | ``raw_tracepoint+``              |           |

+-------------------------------------------+----------------------------------------+----------------------------------+-----------+

| ``BPF_PROG_TYPE_SCHED_ACT``               |                                        | ``action``                       |           |

| ``BPF_PROG_TYPE_SCHED_ACT``               |                                        | ``action`` [#tc_legacy]_         |           |

+-------------------------------------------+----------------------------------------+----------------------------------+-----------+

| ``BPF_PROG_TYPE_SCHED_CLS``               |                                        | ``classifier``                   |           |

| ``BPF_PROG_TYPE_SCHED_CLS``               |                                        | ``classifier`` [#tc_legacy]_     |           |

+                                           +                                        +----------------------------------+-----------+

|                                           |                                        | ``tc``                           |           |

|                                           |                                        | ``tc`` [#tc_legacy]_             |           |

+                                           +----------------------------------------+----------------------------------+-----------+

|                                           | ``BPF_NETKIT_PRIMARY``                 | ``netkit/primary``               |           |

+                                           +----------------------------------------+----------------------------------+-----------+

|                                           | ``BPF_NETKIT_PEER``                    | ``netkit/peer``                  |           |

+                                           +----------------------------------------+----------------------------------+-----------+

|                                           | ``BPF_TCX_INGRESS``                    | ``tc/ingress``                   |           |

+                                           +----------------------------------------+----------------------------------+-----------+

|                                           | ``BPF_TCX_EGRESS``                     | ``tc/egress``                    |           |

+                                           +----------------------------------------+----------------------------------+-----------+

|                                           | ``BPF_TCX_INGRESS``                    | ``tcx/ingress``                  |           |

+                                           +----------------------------------------+----------------------------------+-----------+

|                                           | ``BPF_TCX_EGRESS``                     | ``tcx/egress``                   |           |

+-------------------------------------------+----------------------------------------+----------------------------------+-----------+

| ``BPF_PROG_TYPE_SK_LOOKUP``               | ``BPF_SK_LOOKUP``                      | ``sk_lookup``                    |           |

+-------------------------------------------+----------------------------------------+----------------------------------+-----------+
@@ -155,7 +169,9 @@ described in more detail in the footnotes. 
+-------------------------------------------+----------------------------------------+----------------------------------+-----------+

| ``BPF_PROG_TYPE_SOCK_OPS``                | ``BPF_CGROUP_SOCK_OPS``                | ``sockops``                      |           |

+-------------------------------------------+----------------------------------------+----------------------------------+-----------+

| ``BPF_PROG_TYPE_STRUCT_OPS``              |                                        | ``struct_ops+``                  |           |

| ``BPF_PROG_TYPE_STRUCT_OPS``              |                                        | ``struct_ops+`` [#struct_ops]_   |           |

+                                           +                                        +----------------------------------+-----------+

|                                           |                                        | ``struct_ops.s+`` [#struct_ops]_ | Yes       |

+-------------------------------------------+----------------------------------------+----------------------------------+-----------+

| ``BPF_PROG_TYPE_SYSCALL``                 |                                        | ``syscall``                      | Yes       |

+-------------------------------------------+----------------------------------------+----------------------------------+-----------+
@@ -209,5 +225,11 @@ described in more detail in the footnotes. 
              ``a-zA-Z0-9_.*?``.

.. [#lsm] The ``lsm`` attachment format is ``lsm[.s]/<hook>``.

.. [#rawtp] The ``raw_tp`` attach format is ``raw_tracepoint[.w]/<tracepoint>``.

.. [#tc_legacy] The ``tc``, ``classifier`` and ``action`` attach types are deprecated, use

                ``tcx/*`` instead.

.. [#struct_ops] The ``struct_ops`` attach format supports ``struct_ops[.s]/<name>`` convention,

                 but ``name`` is ignored and it is recommended to just use plain

                 ``SEC("struct_ops[.s]")``. The attachments are defined in a struct initializer

                 that is tagged with ``SEC(".struct_ops[.link]")``.

.. [#tp] The ``tracepoint`` attach format is ``tracepoint/<category>/<name>``.

.. [#iter] The ``iter`` attach format is ``iter[.s]/<struct-name>``.