From patchwork Thu Oct 12 15:59:31 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mark Kavanagh X-Patchwork-Id: 30307 Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 6DB461B5E1; Thu, 12 Oct 2017 17:59:41 +0200 (CEST) Received: from mga14.intel.com (mga14.intel.com [192.55.52.115]) by dpdk.org (Postfix) with ESMTP id 4F6C91B5DB for ; Thu, 12 Oct 2017 17:59:40 +0200 (CEST) Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by fmsmga103.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 12 Oct 2017 08:59:39 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos; i="5.43,366,1503385200"; d="scan'208"; a="1230070526" Received: from irvmail001.ir.intel.com ([163.33.26.43]) by fmsmga002.fm.intel.com with ESMTP; 12 Oct 2017 08:59:36 -0700 Received: from sivswdev01.ir.intel.com (sivswdev01.ir.intel.com [10.237.217.45]) by irvmail001.ir.intel.com (8.14.3/8.13.6/MailSET/Hub) with ESMTP id v9CFxZgk006055; Thu, 12 Oct 2017 16:59:35 +0100 Received: from sivswdev01.ir.intel.com (localhost [127.0.0.1]) by sivswdev01.ir.intel.com with ESMTP id v9CFxZB6011090; Thu, 12 Oct 2017 16:59:35 +0100 Received: (from mbkavana@localhost) by sivswdev01.ir.intel.com with LOCAL id v9CFxZXn011086; Thu, 12 Oct 2017 16:59:35 +0100 From: Mark Kavanagh To: dev@dpdk.org Cc: jiayu.hu@intel.com, jianfeng.tan@intel.com, konstantin.ananyev@intel.com, ferruh.yigit@intel.com, thomas@monjalon.net, Mark Kavanagh Date: Thu, 12 Oct 2017 16:59:31 +0100 Message-Id: <1507823971-10998-1-git-send-email-mark.b.kavanagh@intel.com> X-Mailer: git-send-email 1.7.0.7 In-Reply-To: <1507815955-23275-1-git-send-email-mark.b.kavanagh@intel.com> References: <1507815955-23275-1-git-send-email-mark.b.kavanagh@intel.com> Subject: [dpdk-dev] [PATCH V2] doc: minor fixes for GSO prog_guide X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Correct two minor issues in the GSO programmer's guide: - a note is rendered incorrectly in the middle of an unordered list; this results in the remainder of the list appearing inside the note. Correct indentation of the note to resolve same. - two minor visual artifacts are present in the 'three-part-output-segment' diagram. Remove same. Fixes: f6010c7 ("doc: add GSO programmer's guide") Signed-off-by: Mark Kavanagh Acked-by: John McNamara --- v2: - Move note back to original position. - Remove link to note, as it is no longer needed. - Correct note's indentation, inline with text. .../generic_segmentation_offload_lib.rst | 18 ++-- doc/guides/prog_guide/img/gso-three-seg-mbuf.svg | 116 ++++++++++----------- 2 files changed, 68 insertions(+), 66 deletions(-) diff --git a/doc/guides/prog_guide/generic_segmentation_offload_lib.rst b/doc/guides/prog_guide/generic_segmentation_offload_lib.rst index 5e78f16..1c5a048 100644 --- a/doc/guides/prog_guide/generic_segmentation_offload_lib.rst +++ b/doc/guides/prog_guide/generic_segmentation_offload_lib.rst @@ -195,14 +195,8 @@ To segment an outgoing packet, an application must: used to store the GSO segments' packet headers. - a pointer to the mbuf pool for allocating indirect buffers, which are - used to locate GSO segments' packet payloads. - -.. note:: - - 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. + used to locate GSO segments' packet payloads. See note_ below for + additional details regarding this mempool. - the size of each output segment, including packet headers and payload, measured in bytes. @@ -219,6 +213,14 @@ To segment an outgoing packet, an application must: - a flag, that indicates whether the IPv4 headers of output segments should contain fixed or incremental ID values. +.. _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. + 2. Set the appropriate ol_flags in the mbuf. - The GSO library use the value of an mbuf's ``ol_flags`` attribute to diff --git a/doc/guides/prog_guide/img/gso-three-seg-mbuf.svg b/doc/guides/prog_guide/img/gso-three-seg-mbuf.svg index f18a327..0431012 100644 --- a/doc/guides/prog_guide/img/gso-three-seg-mbuf.svg +++ b/doc/guides/prog_guide/img/gso-three-seg-mbuf.svg @@ -1,9 +1,9 @@ - + + xmlns:v="http://schemas.microsoft.com/visio/2003/SVGExtensions/" width="25.5895in" height="9.63966in" + viewBox="0 0 1842.44 694.055" xml:space="preserve" color-interpolation-filters="sRGB" class="st23"> GSO three-part output segment @@ -132,7 +132,7 @@ - Payload 1 + Payload 1 Sheet.15 @@ -178,21 +178,14 @@ Payload 1 - + Sheet.35 Logical output segment - Logical output segment - - Sheet.38 - Three-part output segment - - - - Three-part output segment - + Logical output segment + Sheet.39 - + Sheet.40 - + Sheet.46 - + Sheet.47 - + Sheet.48 Direct mbuf Direct mbuf - + Sheet.51 (copy of headers) (copy of headers) - + Sheet.53 next next - + Sheet.54 - + Sheet.55 segsz segsz - + Sheet.56 - + Sheet.57 - + Sheet.58 - + Sheet.59 Payload 1 - Payload 1 - + Payload 1 + Sheet.60 Payload 2 Payload 2 - + Sheet.63 Multi-segment input packet - Multi-segment input packet - + Multi-segment input packet + Sheet.70 - + Sheet.71 - - + Sheet.72 Indirect mbuf Indirect mbuf - + Sheet.75 (pointer to data) (pointer to data) - + Sheet.77 next next - + Sheet.78 - + Sheet.79 - + Sheet.80 - + Sheet.81 pkt_len pkt_len - + Sheet.82 % segsz % segsz - + Sheet.34 - + Sheet.85 - + Sheet.87 1 1 - + Sheet.88 - + Sheet.90 2 2 - + Sheet.95 next next - + Sheet.97 - - + Sheet.100 - + Sheet.104 - + Sheet.105 Indirect mbuf Indirect mbuf - + Sheet.106 (pointer to data) (pointer to data) - + Sheet.107 - + Sheet.108 3 3 - + Sheet.109 (pointer to data) (pointer to data) + + Sheet.113 + Three-part output segment + + + + Three-part output segment