From patchwork Thu Jul 6 22:00:17 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Github ODP bot X-Patchwork-Id: 107175 Delivered-To: patch@linaro.org Received: by 10.140.101.44 with SMTP id t41csp2657565qge; Thu, 6 Jul 2017 15:05:53 -0700 (PDT) X-Received: by 10.200.51.23 with SMTP id t23mr61246140qta.38.1499378753306; Thu, 06 Jul 2017 15:05:53 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1499378753; cv=none; d=google.com; s=arc-20160816; b=v9yi3ixz5s2Ytkh56m9zEaFYfphrYYC+gq5Q8rYeJ1hrB9rffHB6FyrEHYgeVP/QFv a076NsoSCOeWvo5uw4pJmd7GH9JnrwYUckSTo6YqNR0IsU1XrzZisfmvaFC7hMtNmxb1 j+mUM2eOGrl/mxyKEOT0VDDjPyUNgYnOwLQ9PqPjhxx0EQnAEXxuLRpm0e9l13pHDtOt OyJhMWwWOCdR4VeBhvdCuIR7qjeapx9KkxZe4l/XgS2yyBO4JicEVdAnRf/SiOgITW4D JZcK75XuSLjDoIHYZo2V+vTd52fEvNEOxfelRzjbMpSqyLSim/AhIQw/Lri+sIctE+WF l8Fg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:subject:github-pr-num :references:in-reply-to:message-id:date:to:from:delivered-to :arc-authentication-results; bh=syP5502ipgtJT47WY9OEw2kVk5clnqeG3Y8bghVtC70=; b=ThJGsUzUSQN4cIiBIwZj1WAW6UBYBUEaC1j6qJtOL2087vHafj7TZqaJVbIq80Ag0l PqliHCc8FGJey0nU4hPpFVdMTV5uoJgRhWzrnklxQ6vR7IncArEA373DeXnkgvCcXgNi ZO41uiy7+C5MNvzE4oIc47cr6v40nqcmbadVMWr9ouLypacdyy9GhoHQZMbwYqySt5aJ AXhf/UmSVLnRT3GbmwnDDhtuzwnYFmlN/F02XfSJkzz5R+D7JV+SEywHtwrHu9/bXXIC PIJrgvVzuREt3FCCWesGE1RUMgFdwXsWeUP4BnTEXrz3Cp6j6BC0RG7UcfOEwE13JiEC wo+g== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) smtp.mailfrom=lng-odp-bounces@lists.linaro.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=yandex.ru Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id x123si1295842qkc.143.2017.07.06.15.05.52; Thu, 06 Jul 2017 15:05:53 -0700 (PDT) Received-SPF: pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) client-ip=54.225.227.206; Authentication-Results: mx.google.com; spf=pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) smtp.mailfrom=lng-odp-bounces@lists.linaro.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=yandex.ru Received: by lists.linaro.org (Postfix, from userid 109) id C67EF62CE2; Thu, 6 Jul 2017 22:05:52 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on ip-10-142-244-252 X-Spam-Level: X-Spam-Status: No, score=-2.6 required=5.0 tests=BAYES_00,FREEMAIL_FROM, RCVD_IN_DNSWL_LOW,URIBL_BLOCKED autolearn=disabled version=3.4.0 Received: from [127.0.0.1] (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id A9E7762D06; Thu, 6 Jul 2017 22:02:22 +0000 (UTC) X-Original-To: lng-odp@lists.linaro.org Delivered-To: lng-odp@lists.linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id E78CF62DF3; Thu, 6 Jul 2017 22:02:17 +0000 (UTC) Received: from forward3h.cmail.yandex.net (forward3h.cmail.yandex.net [87.250.230.18]) by lists.linaro.org (Postfix) with ESMTPS id 45CF060672 for ; Thu, 6 Jul 2017 22:00:45 +0000 (UTC) Received: from smtp4j.mail.yandex.net (smtp4j.mail.yandex.net [IPv6:2a02:6b8:0:1619::15:6]) by forward3h.cmail.yandex.net (Yandex) with ESMTP id D3CED20D54 for ; Fri, 7 Jul 2017 01:00:43 +0300 (MSK) Received: from smtp4j.mail.yandex.net (localhost.localdomain [127.0.0.1]) by smtp4j.mail.yandex.net (Yandex) with ESMTP id 9AE3B3240AA4 for ; Fri, 7 Jul 2017 01:00:42 +0300 (MSK) Received: by smtp4j.mail.yandex.net (nwsmtp/Yandex) with ESMTPSA id raPULT54Tn-0gtKquba; Fri, 07 Jul 2017 01:00:42 +0300 (using TLSv1.2 with cipher ECDHE-RSA-AES128-SHA256 (128/128 bits)) (Client certificate not present) X-Yandex-Suid-Status: 1 0 From: Github ODP bot To: lng-odp@lists.linaro.org Date: Fri, 7 Jul 2017 01:00:17 +0300 Message-Id: <1499378421-25511-7-git-send-email-odpbot@yandex.ru> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1499378421-25511-1-git-send-email-odpbot@yandex.ru> References: <1499378421-25511-1-git-send-email-odpbot@yandex.ru> Github-pr-num: 71 Subject: [lng-odp] [PATCH API-NEXT v1 6/10] doc: drop images full paths, we have imagesdir properly set X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.16 Precedence: list List-Id: "The OpenDataPlane \(ODP\) List" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: lng-odp-bounces@lists.linaro.org Sender: "lng-odp" From: Dmitry Eremin-Solenikov Signed-off-by: Dmitry Eremin-Solenikov Reviewed-by: Bill Fischofer Signed-off-by: Maxim Uvarov --- /** Email created from pull request 71 (muvarov:api-next) ** https://github.com/Linaro/odp/pull/71 ** Patch: https://github.com/Linaro/odp/pull/71.patch ** Base sha: 15c97427d01c81dc9f4d0aafe9b0a99cdb2d1fc6 ** Merge commit sha: e20c61ba5eae9586adcbc76e43cdfaa869055b55 **/ doc/users-guide/users-guide-pktio.adoc | 14 +++++++------- doc/users-guide/users-guide-tm.adoc | 4 ++-- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/doc/users-guide/users-guide-pktio.adoc b/doc/users-guide/users-guide-pktio.adoc index 9ca91f76..80a58d2f 100644 --- a/doc/users-guide/users-guide-pktio.adoc +++ b/doc/users-guide/users-guide-pktio.adoc @@ -10,7 +10,7 @@ PktIO objects are manipulated through various state transitions via `odp_pktio_xxx()` API calls as shown below: .ODP PktIO Finite State Machine -image::../images/pktio_fsm.svg[align="center"] +image::pktio_fsm.svg[align="center"] PktIOs begin in the *Unallocated* state. From here a call `odp_pktio_open()` is used to create an *odp_pktio_t* handle that is used in all subsequent calls @@ -159,7 +159,7 @@ maximum flexibility to the data plane application writer. The processing of DIRECT input is shown below: .PktIO DIRECT Mode Receive Processing -image::../images/pktin_direct_recv.svg[align="center"] +image::pktin_direct_recv.svg[align="center"] In DIRECT mode, received packets are stored in one or more special PktIO queues of type *odp_pktin_queue_t* and are retrieved by threads calling the @@ -376,7 +376,7 @@ to structure itself. A PktIO operating in DIRECT mode performs TX processing as shown here: .PktIO DIRECT Mode Transmit Processing -image::../images/pktout_direct_send.svg[align="center"] +image::pktout_direct_send.svg[align="center"] Direct TX processing operates similarly to Direct RX processing. Following open, the `odp_pktout_queue_config()` API is used to create and configure @@ -501,7 +501,7 @@ QUEUE mode uses standard ODP event queues to service packets. The processing for QUEUE input processing is shown below: .PktIO QUEUE Mode Receive Processing -image::../images/pktin_queue_recv.svg[align="center"] +image::pktin_queue_recv.svg[align="center"] In QUEUE mode, received packets are stored in one or more standard ODP queues. The difference is that these queues are not created directly by the @@ -550,7 +550,7 @@ with the PktIO. Transmit processing for PktIOs operating in QUEUE mode is shown below: .PktIO QUEUE Mode Transmit Processing -image::../images/pktout_queue_send.svg[align="center] +image::pktout_queue_send.svg[align="center] For TX processing QUEUE mode behaves similar to DIRECT mode except that output queues are regular ODP event queues that receive packets via @@ -578,7 +578,7 @@ input queues created by a subsequent `odp_pktin_queue_config()` call are to be used as input to the *ODP Scheduler*. .PktIO SCHED Mode Receive Processing -image::../images/pktin_sched_recv.svg[align="center'] +image::pktin_sched_recv.svg[align="center'] For basic use, SCHED mode simply associates the PktIO input event queues created by `odp_pktin_queue_config()` with the scheduler. Hashing may still be @@ -593,7 +593,7 @@ In its fullest form, PktIOs operating in SCHED mode use the *ODP Classifier* to permit fine-grained flow separation on *Class of Service (CoS)* boundaries. .PktIO SCHED Mode Receive Processing with Classification -image::../images/pktin_sched_cls.svg[align="center"] +image::pktin_sched_cls.svg[align="center"] In this mode of operation, the hash function of `odp_pktin_queue_config()` is typically not used. Instead, the event queues created by this call, diff --git a/doc/users-guide/users-guide-tm.adoc b/doc/users-guide/users-guide-tm.adoc index 36fa9ece..25129733 100644 --- a/doc/users-guide/users-guide-tm.adoc +++ b/doc/users-guide/users-guide-tm.adoc @@ -162,7 +162,7 @@ into one fan-in of a subsequent tm_node or egresss object - forming a proper tree. .Hierarchical Scheduling -image::../images/tm_hierarchy.svg[align="center"] +image::tm_hierarchy.svg[align="center"] Multi-level/hierarchical scheduling adds both great control and significant complexity. Logically, despite the implication of the tm_node tree diagrams, @@ -183,7 +183,7 @@ some very sophisticated behaviours. Each tm_node can contain a set of scheduler shaper and a WRED component - or a subset of these. .Traffic Manager Node -image::../images/tm_node.svg[align="center"] +image::tm_node.svg[align="center"] In its full generality an tm_node consists of a set of "fan-in" connections to preceding tm_queues or tm_nodes. The fan-in for a single tm_node can range