From patchwork Thu May 19 09:23:47 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Balasubramanian Manoharan X-Patchwork-Id: 68117 Delivered-To: patch@linaro.org Received: by 10.140.92.199 with SMTP id b65csp3087343qge; Thu, 19 May 2016 02:24:17 -0700 (PDT) X-Received: by 10.55.39.149 with SMTP id n143mr13297477qkn.55.1463649857516; Thu, 19 May 2016 02:24:17 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id j6si11491474qgf.34.2016.05.19.02.24.17; Thu, 19 May 2016 02:24:17 -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=pass (p=NONE dis=NONE) header.from=linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id ECABB6161C; Thu, 19 May 2016 09:24:16 +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, RCVD_IN_DNSWL_LOW, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL, 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 03A22615CE; Thu, 19 May 2016 09:24:12 +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 4A130615CF; Thu, 19 May 2016 09:24:10 +0000 (UTC) Received: from mail-pa0-f45.google.com (mail-pa0-f45.google.com [209.85.220.45]) by lists.linaro.org (Postfix) with ESMTPS id 640026158E for ; Thu, 19 May 2016 09:24:09 +0000 (UTC) Received: by mail-pa0-f45.google.com with SMTP id qo8so27526027pab.1 for ; Thu, 19 May 2016 02:24:09 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id; bh=K5+IX4mQ55uz8e1ZXWFMcrqzzRHtIW37aD7Lg+PeGXY=; b=esThg0M8n+UI7dcr9qPuI9CH0pNO+I7uLNzvTq9xyRA9uiAOPM5AmCPm6RMllvwzXe 3UOVMP7ihiNmAsKYP7rYc9uubXLL/B/hgjhE9hgvCvI+UE6hdIyZI/cPuRtJgn2amGBq S3tbe6I3xkB4K5x37C7cdaYSV2gurlOv1bzKCotMWtDHj//LextQ4AupolemllSSEzaR /ruGkm0gmqxFIYbde9VKpAFpzXurV6MtKm1B2cQtiqwY9O0LYF7KBsfyeWS/Z6fDUPe8 x0yW/E50dbllm+xb516lmn8dnlFDjggDp87GsZ8KaoBTdedlrepKreqA1NGf16/5p3Ld nfKQ== X-Gm-Message-State: AOPr4FVtqVEqmSK6op0JRTi/bFvUqdfBZ18mS4cFj465rcPWZn4xxYDK+1Btvzj81hm7EK+07no= X-Received: by 10.66.81.136 with SMTP id a8mr17978952pay.113.1463649848695; Thu, 19 May 2016 02:24:08 -0700 (PDT) Received: from localhost.localdomain ([122.166.219.57]) by smtp.gmail.com with ESMTPSA id ym8sm18209845pab.22.2016.05.19.02.24.06 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Thu, 19 May 2016 02:24:08 -0700 (PDT) From: Balasubramanian Manoharan To: lng-odp@lists.linaro.org Date: Thu, 19 May 2016 14:53:47 +0530 Message-Id: <1463649827-17897-1-git-send-email-bala.manoharan@linaro.org> X-Mailer: git-send-email 1.9.1 X-Topics: patch Subject: [lng-odp] [PATCH] doc: users-guide: add packet drop and error CoS documentation 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: , MIME-Version: 1.0 Errors-To: lng-odp-bounces@lists.linaro.org Sender: "lng-odp" Adds documentation for packet drop policy and Error Class of service Signed-off-by: Balasubramanian Manoharan --- doc/users-guide/users-guide-cls.adoc | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/doc/users-guide/users-guide-cls.adoc b/doc/users-guide/users-guide-cls.adoc index d2ba743..b158122 100644 --- a/doc/users-guide/users-guide-cls.adoc +++ b/doc/users-guide/users-guide-cls.adoc @@ -109,7 +109,32 @@ pools. Multiple odp_pktio instances (i.e., multiple ports) may each have their own default odp_cos, or may share a odp_cos with other ports, based on application requirements. -Packet Classification +=== Error packet handling + +Any Error class of service is assigned to ingress port using the function +odp_pktio_error_cos_set(). All the packets received with error from this +specific ingress port are assigned to this error class-of-service. +At minimum this error class-of-service must have a queue and a buffer pool +assigned to it on platforms that support multiple packet buffer pools. +Multiple odp_pktio instances (_i.e.,_ multiple ports) may each have their own +error class of service, or may share an error CoS with other ports, based on +application requirements. + +=== Packet dropping + +Each class of service has a `drop_policy` configured during creation. The +valid value are ODP_COS_DROP_POOL and ODP_COS_DROP_NEVER. If the `drop_policy` +is set to ODP_COS_DROP_POOL then the packets assigned to the CoS follows the +drop policy of the associated pool _i.e.,_ depending on the Random Early Discard +or any other configuration of the pool the packet might get dropped. If the +`drop_policy` is set to ODP_COS_DROP_NEVER then the drop policy of the pool is +ignored and the packet is never dropped by the implementation. + +During creation of the Class of service if the pool or queue is set as INVALID +using ODP_POOL_INVALID or ODP_QUEUE_INVALID field then the packets received in +the specific CoS gets dropped by the implementation. + +=== Packet Classification For each odp_pktio port, the API allows the assignment of a class-of-service to a packet using one of three methods: @@ -136,7 +161,7 @@ destination or source port numbers, and appropriately assign these packets a class-of-service that maps to a higher priority queue, assuring voice packets a lower and bound latency. -Packet meta data Elements +=== Packet meta data Elements Here are the specific information elements that are stored within the packet meta data structure: