X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fprog_guide%2Fgeneric_segmentation_offload_lib.rst;h=9959f0d29c998eb06286bbbcf3c3f5179e60cb7c;hb=f779053ab37adf731558b4b758b5058a28bb33f8;hp=5e78f1625e802bee7155be5e590efe61e45002c2;hpb=f6010c7655ccb1a4ba198796477f0cbb7a5ec5b2;p=dpdk.git diff --git a/doc/guides/prog_guide/generic_segmentation_offload_lib.rst b/doc/guides/prog_guide/generic_segmentation_offload_lib.rst index 5e78f1625e..9959f0d29c 100644 --- a/doc/guides/prog_guide/generic_segmentation_offload_lib.rst +++ b/doc/guides/prog_guide/generic_segmentation_offload_lib.rst @@ -1,32 +1,5 @@ -.. BSD LICENSE - Copyright(c) 2017 Intel Corporation. All rights reserved. - All rights reserved. - - Redistribution and use in source and binary forms, with or without - modification, are permitted provided that the following conditions - are met: - - * Redistributions of source code must retain the above copyright - notice, this list of conditions and the following disclaimer. - * Redistributions in binary form must reproduce the above copyright - notice, this list of conditions and the following disclaimer in - the documentation and/or other materials provided with the - distribution. - * Neither the name of Intel Corporation nor the names of its - contributors may be used to endorse or promote products derived - from this software without specific prior written permission. - - THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2017 Intel Corporation. Generic Segmentation Offload Library ==================================== @@ -120,7 +93,7 @@ in :numref:`figure_gso-output-segment-format`. .. _figure_gso-output-segment-format: -.. figure:: img/gso-output-segment-format.svg +.. figure:: img/gso-output-segment-format.* :align: center Two-part GSO output segment @@ -160,7 +133,7 @@ next input segment). .. _figure_gso-three-seg-mbuf: -.. figure:: img/gso-three-seg-mbuf.svg +.. figure:: img/gso-three-seg-mbuf.* :align: center Three-part GSO output segment @@ -197,12 +170,13 @@ To segment an outgoing packet, an application must: - a pointer to the mbuf pool for allocating indirect buffers, which are used to locate GSO segments' packet payloads. -.. note:: + .. note:: + + An application may use the same pool for both direct and indirect + buffers. However, since indirect mbufs simply store a pointer, the + application may reduce its memory consumption by creating a separate memory + pool, containing smaller elements, for the indirect pool. - An application may use the same pool for both direct and indirect - buffers. However, since each indirect mbuf simply stores a pointer, the - application may reduce its memory consumption by creating a separate memory - pool, containing smaller elements, for the indirect pool. - the size of each output segment, including packet headers and payload, measured in bytes.