From patchwork Fri Apr 7 00:23:00 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "John Daley (johndale)" X-Patchwork-Id: 23307 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [IPv6:::1]) by dpdk.org (Postfix) with ESMTP id C04F2326B; Fri, 7 Apr 2017 02:23:07 +0200 (CEST) Received: from rcdn-iport-2.cisco.com (rcdn-iport-2.cisco.com [173.37.86.73]) by dpdk.org (Postfix) with ESMTP id 2E1D42C6E for ; Fri, 7 Apr 2017 02:23:05 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=cisco.com; i=@cisco.com; l=2401; q=dns/txt; s=iport; t=1491524586; x=1492734186; h=from:to:cc:subject:date:message-id:in-reply-to: references; bh=6hWs3f3gLH6wcFMuaucFmqzk+tJLoxK27KNlOAn5XbQ=; b=WhigDxGKSIkQlxpi+I21AP1AMtZBX+aX8ooEqw5kdrzRI1EWqvz88lYi q1Fjo4vKUQcMm/tKswYDxVLcfQAnugAjIyrrtaXyQGykunl8pxAVDixB8 rwoy9WVecOuJaoyZb8aP7TI5Lla0uUcSkqMF6PRA/P6YBgBsc5JPSD0/B 0=; X-IronPort-AV: E=Sophos;i="5.37,161,1488844800"; d="scan'208";a="232883514" Received: from alln-core-10.cisco.com ([173.36.13.132]) by rcdn-iport-2.cisco.com with ESMTP/TLS/DHE-RSA-AES256-SHA; 07 Apr 2017 00:23:05 +0000 Received: from cisco.com (savbu-usnic-a.cisco.com [10.193.184.48]) by alln-core-10.cisco.com (8.14.5/8.14.5) with ESMTP id v370N58m024163; Fri, 7 Apr 2017 00:23:05 GMT Received: by cisco.com (Postfix, from userid 392789) id 1C9853FAAED4; Thu, 6 Apr 2017 17:23:05 -0700 (PDT) From: John Daley To: adrien.mazarguil@6wind.com Cc: dev@dpdk.org, John Daley Date: Thu, 6 Apr 2017 17:23:00 -0700 Message-Id: <20170407002300.14433-1-johndale@cisco.com> X-Mailer: git-send-email 2.12.0 In-Reply-To: <20170406224126.30345-2-johndale@cisco.com> References: <20170406224126.30345-2-johndale@cisco.com> Subject: [dpdk-dev] [PATCH v3] ethdev: fix flow validate comments 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" Change comments for rte_flow_validate() function to indicate that flow rule collision and resource validation is optional for PMD and therefore the return codes may have different meanings. Fixes: b1a4b4cbc0a8 ("ethdev: introduce generic flow API") Signed-off-by: John Daley --- v2: another crack at the comments v3: fix typos, rewording, put back a sentence omitted in v2 lib/librte_ether/rte_flow.h | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/lib/librte_ether/rte_flow.h b/lib/librte_ether/rte_flow.h index 8013ecab2..85ce4ec90 100644 --- a/lib/librte_ether/rte_flow.h +++ b/lib/librte_ether/rte_flow.h @@ -983,9 +983,11 @@ struct rte_flow_error { /** * Check whether a flow rule can be created on a given port. * - * While this function has no effect on the target device, the flow rule is - * validated against its current configuration state and the returned value - * should be considered valid by the caller for that state only. + * The flow rule is validated for correctness and whether it could be accepted + * by the device given sufficient resources. The rule is checked against the + * current device mode and queue configuration. The flow rule may also + * optionally be validated against existing flow rules and device resources. + * This function has no effect on the target device. * * The returned value is guaranteed to remain valid only as long as no * successful calls to rte_flow_create() or rte_flow_destroy() are made in @@ -1016,9 +1018,13 @@ struct rte_flow_error { * -ENOTSUP: valid but unsupported rule specification (e.g. partial * bit-masks are unsupported). * - * -EEXIST: collision with an existing rule. + * -EEXIST: collision with an existing rule. Only returned if device + * supports flow rule collision checking and there was a flow rule + * collision. Not receiving this return code is no guarantee that creating + * the rule will not fail due to a collision. * - * -ENOMEM: not enough resources. + * -ENOMEM: Not enough memory to execute the function, or if the device + * supports resource validation, resource limitation on the device. * * -EBUSY: action cannot be performed due to busy device resources, may * succeed if the affected queues or even the entire port are in a stopped