| /dpdk/doc/guides/prog_guide/ |
| H A D | build-sdk-meson.rst | 37 available as a suitable package, it can also be installed using the Python
46 If not available as a package, it can be downloaded as source or binary from
60 to be used for the build e.g. ``meson build``, as shown above. If calling
69 properties or the presence of dependencies, such as libpcap, or openssl
75 older versions). Some options, such as ``buildtype``, or ``werror`` are
76 built into meson, while others, such as ``max_lcores``, or the list of
83 meson --werror werrorbuild # build with warnings as errors
87 meson -Dexamples=l3fwd,l2fwd fwdbuild # build some examples as
134 As well as those settings taken from ``meson configure``, other options
157 printing each command on a new line as it runs.
[all …]
|
| H A D | meson_ut.rst | 20 * Tests which produce lists of objects as output, and therefore that need
23 These tests can be run using the argument to ``meson test`` as
31 the ``-C <build path>`` option can be skipped as below::
42 For example, tests will by default run on as many available cores as is needed
54 Arguments of ``test()`` that can be provided in meson.build are as below:
65 their environment. If a test can't run, then it should be skipped, as described
74 will be reported as skipped if they cannot run. To enable those test cases,
|
| H A D | reorder_lib.rst | 41 The reorder library is implemented as a pair of buffers, which referred to as
52 This means that as long as there is room in the Ready buffer, the window will
61 the Order buffer to the Ready buffer, as long as there is room in the Ready buffer.
63 be reported as late packets when they arrive. The process of moving packets
80 hence a reorder buffer can be used to order as many packets as possible.
|
| H A D | switch_representation.rst | 344 down as:
349 - **F to A**: PF MAC as destination.
354 - **D to A**: VF 1 MAC as source and PF MAC as destination.
355 - **D to E**: VF 1 MAC as source and VF 2 MAC as destination.
356 - **D to F**: VF 1 MAC as source.
361 - **E to A**: VF 2 MAC as source and PF MAC as destination.
362 - **E to D**: VF 2 MAC as source and VF 1 MAC as destination.
363 - **E to F**: VF 2 MAC as source.
618 Same restrictions as `PORT_ID pattern item`_.
639 Same restrictions as `PF pattern item`_.
[all …]
|
| H A D | traffic_management.rst | 41 parameters such as maximum number of nodes, maximum number of hierarchical
50 the level if node is non-leaf type etc., are exposed as a result of
69 Algorithms such as Weighed Round Robin (WRR), byte-level WRR, Deficit WRR
97 bigger than zero, as well as greater than or equal to the rate of the committed
112 unmodified, as opposed to the Head Drop* algorithm, which drops the packet
148 DEI bit is left as is (either set or not).
152 the current color, otherwise the ECN field is left as is.
154 All IPv4/IPv6 packets have their color marked into DSCP bits 3 and 4 as
158 color is left as is.
190 node and all the nodes that are subsequently added have to be added as
[all …]
|
| H A D | rte_flow.rst | 48 In order to remain as hardware-agnostic as possible, by default all rules
111 as well as depending on the value of flow attributes transfer bit.
309 .. table:: TCPv4 as L4
376 items, as long as those remain stacked properly. The resulting matching
623 As a device property, the list of allowed values as well as the value
949 order as on the wire.
3086 Any arbitrary header field (as well as mark, metadata or tag values)
3101 as well as any tag element in the tag array.
3456 The returned value is guaranteed to remain valid only as long as no
4064 as long as its associated DPDK port remains configured. Closing the
[all …]
|
| H A D | fib_lib.rst | 34 The prefix serves as the key and the next hop ID as the value while doing an LPM
65 This algorithm uses ``rte_rib`` as a dataplane struct. Lookups are relatively slow,
69 This algorithm will be used if the ``RTE_FIB_DUMMY`` type is configured as the
83 This algorithm will be used if the ``RTE_FIB_DIR24_8`` type is configured as the
116 ideally we would have 2\ :sup:`24` tbl8s, which would be the same as having a
134 algorithm such as IP forwarding or packet classification.
136 More complex use cases are also possible, as it is possible to have next hop IDs
137 which are 63 bits long (using ``RTE_FIB_DIR24_8_8B`` as a next hop size).
|
| H A D | rib_lib.rst | 9 There are more suitable libraries for use in data plane applications such as
20 ``uint32_t`` values. IPv6 addresses are represented as ``uint8_t[16]`` values.
30 Internally RIB is represented as a binary tree as shown in :numref:`figure_rib_internals`:
92 This returns ``NULL`` as no exact match can be found.
112 By default, an ``rte_rib_node`` node contains only crucial information such as the prefix and
113 next hop ID, but it doesn't contain protocol specific information such as
121 Consider a RIB with a number of routes with different next hops (A and B) as
|
| /dpdk/doc/guides/contributing/ |
| H A D | abi_policy.rst | 29 #. Libraries or APIs marked as :ref:`experimental <experimental_apis>`
31 as they are not considered part of an ABI version.
68 example. The ABI of a milestone release may be declared as a 'major ABI
164 as not to break consuming applications.
231 This is not a problem as long as the symbol ``rte_foo@DPDK_21`` is
296 This is commonly known as the *ABI breakage window*,
303 as described in the section :ref:`abi_changes`.
306 as described in the section :ref:`deprecating_entire_abi`.
308 as described in section :ref:`aliasing_experimental_symbols`,
331 Note that marking an API as experimental is a multi step process.
[all …]
|
| H A D | abi_versioning.rst | 42 reason to bump a dependent library's ABI version, as there may have been no
49 number of releases as described in the section :doc:`abi_policy`, means
73 version, as described in the section :ref:`example_abi_macro_usage`. The
171 Assume we have a function as follows
189 private, is safe), but it also requires modifying the code as follows
241 This file needs to be modified as follows
276 list of exported symbols when DPDK is compiled as a shared library.
331 This code serves as our new API call. Its the same as our old call, but adds the
510 symbol as before, we now add the symbol to both the ``EXPERIMENTAL``
624 it as static. This is a coding style choice.
[all …]
|
| H A D | coding_style.rst | 214 /* report a unit tests as unsupported on Windows */
295 Ordering by size then ensures that as little padding is added to the structure as possible.
365 with an existing (as of 2020) hardware or protocol
398 …red exactly once, whereas an incomplete structure type can be mentioned as many times as necessary.
453 var3 == var4){ /* confusing to read as */
608 …The second and subsequent lines should be further indented as for line statement continuations as …
695 The above rule about not typecasting ``void *`` applies to malloc, as well as to DPDK functions.
761 The ``const`` attribute should be used as often as possible when a variable is read-only.
833 Each PMD, library or component can create as many specializations as required.
863 In order to catch possible issues as soon as possible,
[all …]
|
| H A D | vulnerability.rst | 22 If in doubt, please consider the vulnerability as security sensitive.
31 Please report any security issue you find in DPDK as described below.
46 as part of the security process.
51 as that can speed up the process considerably.
60 the reporting process must be followed anyway, as described below.
166 as described below. It must not be considered as the standard process.
215 to give you, as downstream stakeholders, a chance to coordinate
217 Please treat the following information as confidential until
253 to give you, as downstream stakeholders, a chance to coordinate
256 Please treat the following information as confidential until
[all …]
|
| H A D | documentation.rst | 145 It can be installed as follows:
197 * Document the obvious as well as the obscure since it won't always be obvious to the reader.
301 * Bullet lists should be formatted with a leading ``*`` as follows::
358 That can be applied as follows::
371 Which would be rendered as:
396 This would be rendered as:
419 This can be done as follows:
471 * Images in the documentation should be formatted as follows:
513 * Tables in the documentation should be formatted as follows:
547 The following is rendered as https://dpdk.org::
[all …]
|
| /dpdk/doc/guides/eventdevs/ |
| H A D | octeontx.rst | 9 SoC family as well as their virtual functions (VF) in SR-IOV context.
48 The OCTEON TX eventdev is exposed as a vdev device which consists of a set
88 When eth_octeontx is used as Rx adapter event schedule type
94 When timvf is used as Event timer adapter the clock source mapping is as
104 When timvf is used as Event timer adapter event schedule type
111 and they can be configured by passing limits to kernel bootargs as follows:
125 as (Rx/Timer) should be limited to the above configured value.
|
| /dpdk/doc/guides/sample_app_ug/ |
| H A D | multi_process.rst | 17 and as documented in the *DPDK Getting Started Guide*.
40 passing at least two cores in the coremask/corelist, as follows:
82 When running a secondary process such as that shown above, the proc-type parameter can again be spe…
139 such as a client-server mode of operation seen in the next example,
176 the following commands can be used (assuming run as root):
196 Instead, that process can be restarted as a secondary,
282 as there is no support in the server application for it to run as a secondary process.
288 …rk port and data structure initialization much as the symmetric multi-process application does whe…
291 as is done for the symmetric multi-process application, and therefore eliminates mismatched paramet…
298 which will, as in the symmetric multi-process example,
[all …]
|
| H A D | qos_metering.rst | 8 as defined by RFC2697 for Single Rate Three Color Marker (srTCM) and RFC 2698 for Two Rate Three Co…
19 The operation mode can be selected as compile time out of the following options:
35 all the incoming packets are colored as green.
47 The application execution command line is as below:
70 the color is defined as the LSB byte of the destination MAC address.
80 and green, the expected output traffic should be marked as shown in the following table:
106 To set up the policing scheme as desired, it is necessary to modify the main.h source file,
107 where this policy is implemented as a static structure, as follows:
111 :start-after: Policy implemented as a static structure. 8<
112 :end-before: >8 End of policy implemented as a static structure.
|
| /dpdk/doc/guides/nics/ |
| H A D | vdev_netvsc.rst | 19 NetVSC interface proper and its SR-IOV VF (referred to as "physical" from
23 VM migration. From a VM standpoint they appear as hot-plug devices that come
28 through NetVSC. Otherwise, NetVSC acts as a fallback for all traffic.
32 device driver (also known as *vdev*) manages other PMDs as summarized by the
80 Same as ``iface`` except a suitable NetVSC interface is located using its
85 If nonzero, forces the use of specified interfaces even if not detected as
|
| /dpdk/examples/l2fwd/ |
| H A D | meson.build | 4 # meson file, for building this example as part of a main DPDK build.
6 # To build this example as a standalone application with an already-installed
9 # Enable experimental API flag as l2fwd uses rte_ethdev_set_ptype API
|
| /dpdk/buildtools/ |
| H A D | check-symbols.sh | 40 $SYM is not flagged as experimental
57 $SYM is flagged as experimental
71 $SYM is not flagged as internal
88 $SYM is flagged as internal
|
| /dpdk/doc/guides/howto/ |
| H A D | packet_capture_framework.rst | 33 It runs as a DPDK secondary process and captures packets
36 most of the same options as the Wireshark ``dumpcap`` command.
42 the packet capture framework and acts as a server,
43 and the ``dpdk-dumpcap`` tool acts as a client.
62 created as demonstration of ``librte_pdump`` library.
90 #. Launch testpmd as the primary application::
94 #. Launch the dpdk-dumpcap as follows::
100 such as tcpdump or tshark that can interpret Pcapng files::
|
| /dpdk/doc/guides/linux_gsg/ |
| H A D | build_dpdk.rst | 74 The last two commands above generally need to be run as root,
80 On some linux distributions, such as Fedora or Redhat, paths in `/usr/local` are
90 DPDK has a number of options that can be adjusted as part of the build configuration process.
109 of the same architecture as the build machine.
125 parameter to the instruction set of your choice (such as ``corei7``, ``power8``, etc.).
127 ``cpu_instruction_set`` is not used in Arm builds, as setting the instruction set
139 automatically built as part of a meson build too.
141 `-Dexamples` meson option as below::
166 assuming the relevant 32-bit development packages, such as a 32-bit libc, are installed::
177 DPDK can be compiled using ``ninja`` as described above.
[all …]
|
| /dpdk/config/ppc/ |
| H A D | meson.build | 36 # cpu_instruction_set specified in cross-compile file as "cpu"
111 # Certain POWER9 systems can scale as high as 1536 LCORES, but setting such a
114 # default 64 LCORES seems too small as most POWER9 dual socket systems will have
115 # at least 128 LCORES available. Set RTE_MAX_LCORE to 128 for POWER systems as
122 # systems can scale even higher with as many as 32 NUMA nodes.
|
| /dpdk/doc/guides/testpmd_app_ug/ |
| H A D | intro.rst | 7 This document is a user guide for the ``testpmd`` example application that is shipped as part of th…
10 and also to access NIC hardware features such as Flow Director.
11 It also serves as a example of how to build a more fully-featured application using the DPDK SDK.
|
| /dpdk/doc/guides/windows_gsg/ |
| H A D | intro.rst | 12 \*Other names and brands may be claimed as the property of others.
18 compile. Support is being added in pieces so as to limit the overall scope
23 as function versioning is not supported on Windows,
|
| /dpdk/buildtools/pkg-config/ |
| H A D | meson.build | 21 # Another requirement is to allow linking dependencies as shared libraries,
24 # As a consequence, the regular DPDK libraries are already listed as static
27 # are skipped in the case of static linkage thanks to the flag --as-needed.
37 libraries: ['-Wl,--as-needed'] + dpdk_libraries,
57 # For static linking with dependencies as shared libraries,
|