From patchwork Mon May 23 07:24:48 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Balasubramanian Manoharan X-Patchwork-Id: 68336 Delivered-To: patch@linaro.org Received: by 10.140.92.199 with SMTP id b65csp1076463qge; Mon, 23 May 2016 00:25:13 -0700 (PDT) X-Received: by 10.237.58.39 with SMTP id n36mr10026410qte.73.1463988313045; Mon, 23 May 2016 00:25:13 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id o91si1490727qtd.61.2016.05.23.00.25.12; Mon, 23 May 2016 00:25:13 -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 7B28B6172B; Mon, 23 May 2016 07:25:12 +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_H2, 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 EBF3661647; Mon, 23 May 2016 07:25:07 +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 3112F61649; Mon, 23 May 2016 07:25:06 +0000 (UTC) Received: from mail-pf0-f169.google.com (mail-pf0-f169.google.com [209.85.192.169]) by lists.linaro.org (Postfix) with ESMTPS id 2F95361640 for ; Mon, 23 May 2016 07:25:05 +0000 (UTC) Received: by mail-pf0-f169.google.com with SMTP id c189so63897708pfb.3 for ; Mon, 23 May 2016 00:25:05 -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=3sB4N1JocG2Wun4a1dVttnSN0vk+7LzfS/esisqnc2U=; b=f/EVPqb55EHxc9/rR/ZVjQ+4bXDmslZga/bX9+pnjwjgtQwqIUDp7df+cJ6WHTDB/7 KvpOJbMBFj1flqXNg/1pisLbwb1BugD+V+YbRIa5wn0NSGoNNAoj56f9tE3myUQuf6g6 yWJV8OxtXdjWVeOeQMvnhXGnVNuEvt/SByCz4sN+8bdRKBxtchfEuNhLvZFezcw615ol 6PckXRiT8QhJGhgD5pOnnk1Kpdnh0aINdu0vmzHoNe2PUg22MI3PDIOLVXRL5CfplIpG fCKMAt75FtAWYZjdoNTlgbNGEgC7S3tj67Ycv6uoProGfsBb7YYxXOJ9j6XpwuHpQVpC TQFQ== X-Gm-Message-State: AOPr4FVWGMbC6PLuJZ1vipoYN4XlxQb+ZJpdvIxd2GvzgYSiwyQjXG17sBRzKcNezEARGhYBUZM= X-Received: by 10.98.113.1 with SMTP id m1mr25295036pfc.150.1463988304359; Mon, 23 May 2016 00:25:04 -0700 (PDT) Received: from bala-Vostro-2520.domain.name ([61.0.115.89]) by smtp.gmail.com with ESMTPSA id uf5sm21340477pac.44.2016.05.23.00.25.02 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Mon, 23 May 2016 00:25:03 -0700 (PDT) From: Balasubramanian Manoharan To: lng-odp@lists.linaro.org Date: Mon, 23 May 2016 12:54:48 +0530 Message-Id: <1463988288-5777-1-git-send-email-bala.manoharan@linaro.org> X-Mailer: git-send-email 1.9.1 X-Topics: patch Subject: [lng-odp] [PATCHv2] 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 Reviewed-by: Bill Fischofer --- doc/users-guide/users-guide-cls.adoc | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/doc/users-guide/users-guide-cls.adoc b/doc/users-guide/users-guide-cls.adoc index d2ba743..a689826 100644 --- a/doc/users-guide/users-guide-cls.adoc +++ b/doc/users-guide/users-guide-cls.adoc @@ -109,7 +109,30 @@ 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 + +Error class of service is assigned to an 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. Multiple 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 Random Early Discard of the +pool is ignored. + +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 any packet assigned to the specific CoS are dropped. + +=== 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 +159,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: