From patchwork Tue Aug 4 22:41:20 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 51923 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-la0-f72.google.com (mail-la0-f72.google.com [209.85.215.72]) by patches.linaro.org (Postfix) with ESMTPS id D173622E8E for ; Tue, 4 Aug 2015 22:51:04 +0000 (UTC) Received: by labby2 with SMTP id by2sf8790579lab.3 for ; Tue, 04 Aug 2015 15:51:03 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:delivered-to:delivered-to:from:to:date :message-id:in-reply-to:references:subject:precedence:list-id :list-unsubscribe:list-archive:list-post:list-help:list-subscribe :mime-version:content-type:content-transfer-encoding:errors-to :sender:x-original-sender:x-original-authentication-results :mailing-list; bh=etGmQdQD36oDLVuh2zX8nVDn4vK19nPycoEUmLDAL0M=; b=XPVK44WUuBs/3YMHWYtYelWt6ZLlCBzcnnsNbqQdlOLQtsAPAZN+kD9LSEuqAV7xCQ Nx3Vz5OQTpmU575S2xiZE6wxiTkrzpVI0CoucMS/djwAlDllBAEPYRYT+PipWepH+Etw 7Cb0stp9mPsvk3gxoNN9ZSEpG6VKTQ3SYzTAl/YMj+FjL34jXb+cVq+fmeqa1xcw1JNZ CI5La550MpcsPP3wIoN+hH/ZQvM44qJUDVWSRiWulRROubY882RnVrkrq+M2l5GTVQV9 NkWBDJn48l5Hng3co/JglPDYCoNKexyuknTBecPrHnknSljipsRA2GczjI+7TLq4NcIR RBtA== X-Gm-Message-State: ALoCoQlPzwhhEzwebT0ZnjSebXcZp8lHI4Iu9BG96O7rDmJ/nXTe/kpd7awbLJt4wKP+otmEVjP0 X-Received: by 10.194.179.42 with SMTP id dd10mr1777736wjc.7.1438728663826; Tue, 04 Aug 2015 15:51:03 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.5.225 with SMTP id v1ls119709lav.71.gmail; Tue, 04 Aug 2015 15:51:03 -0700 (PDT) X-Received: by 10.112.158.70 with SMTP id ws6mr6701017lbb.28.1438728663535; Tue, 04 Aug 2015 15:51:03 -0700 (PDT) Received: from mail-lb0-f178.google.com (mail-lb0-f178.google.com. [209.85.217.178]) by mx.google.com with ESMTPS id b1si823069lbd.146.2015.08.04.15.51.02 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 04 Aug 2015 15:51:02 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.178 as permitted sender) client-ip=209.85.217.178; Received: by lbbpo9 with SMTP id po9so14649702lbb.2 for ; Tue, 04 Aug 2015 15:51:02 -0700 (PDT) X-Received: by 10.152.121.4 with SMTP id lg4mr6609992lab.112.1438728662573; Tue, 04 Aug 2015 15:51:02 -0700 (PDT) X-Forwarded-To: patchwork-forward@linaro.org X-Forwarded-For: patch@linaro.org patchwork-forward@linaro.org Delivered-To: patch@linaro.org Received: by 10.112.7.198 with SMTP id l6csp35892lba; Tue, 4 Aug 2015 15:51:01 -0700 (PDT) X-Received: by 10.50.171.228 with SMTP id ax4mr2326614igc.45.1438728660942; Tue, 04 Aug 2015 15:51:00 -0700 (PDT) Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id u65si827845ioi.29.2015.08.04.15.51.00; Tue, 04 Aug 2015 15:51:00 -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; Received: by lists.linaro.org (Postfix, from userid 109) id E85E961D9E; Tue, 4 Aug 2015 22:50:59 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on ip-10-142-244-252.ec2.internal 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 ip-10-142-244-252.ec2.internal (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id 9F88E61FAA; Tue, 4 Aug 2015 22:45:36 +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 98DE261E32; Tue, 4 Aug 2015 22:43:12 +0000 (UTC) Received: from mail-ob0-f180.google.com (mail-ob0-f180.google.com [209.85.214.180]) by lists.linaro.org (Postfix) with ESMTPS id 89B1D61FA8 for ; Tue, 4 Aug 2015 22:41:38 +0000 (UTC) Received: by obre1 with SMTP id e1so18625710obr.1 for ; Tue, 04 Aug 2015 15:41:38 -0700 (PDT) X-Received: by 10.182.142.74 with SMTP id ru10mr5513721obb.75.1438728098129; Tue, 04 Aug 2015 15:41:38 -0700 (PDT) Received: from localhost.localdomain (cpe-24-28-70-239.austin.res.rr.com. [24.28.70.239]) by smtp.gmail.com with ESMTPSA id sx2sm519170obc.0.2015.08.04.15.41.37 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Tue, 04 Aug 2015 15:41:37 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Tue, 4 Aug 2015 17:41:20 -0500 Message-Id: <1438728085-3240-9-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.1.4 In-Reply-To: <1438728085-3240-1-git-send-email-bill.fischofer@linaro.org> References: <1438728085-3240-1-git-send-email-bill.fischofer@linaro.org> X-Topics: patch Subject: [lng-odp] [API-NEXT PATCHv7 08/13] api: queue: document ordered chain enq support X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.16 Precedence: list List-Id: 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" X-Removed-Original-Auth: Dkim didn't pass. X-Original-Sender: bill.fischofer@linaro.org X-Original-Authentication-Results: mx.google.com; spf=pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.178 as permitted sender) smtp.mail=patch+caf_=patchwork-forward=linaro.org@linaro.org Mailing-list: list patchwork-forward@linaro.org; contact patchwork-forward+owners@linaro.org X-Google-Group-Id: 836684582541 Signed-off-by: Bill Fischofer --- include/odp/api/queue.h | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/include/odp/api/queue.h b/include/odp/api/queue.h index ce04eb4..5a6dbc0 100644 --- a/include/odp/api/queue.h +++ b/include/odp/api/queue.h @@ -173,6 +173,29 @@ int odp_queue_enq(odp_queue_t queue, odp_event_t ev); * * @return Number of events actually enqueued (0 ... num) * @retval <0 on failure + * + * @note odp_queue_enq_multi() serves two purposes. First, it allows + * multiple events to be enqueued via a single call. In addition, it + * permits multiple events to partitipate in ordering. When an event + * originating from an ordered queue is followed by one or more events + * that did not originate from an ordered queue, then these subsequent + * events are "chained" to the ordered event such that they participate + * in its ordering. This provides a convenient means for an application + * to split a packet into multiple packets and have them retain the + * relative order of the original packet. + * + * @note If multiple events originating from ordered queues are passed + * to odp_queue_enq_multi() then they (and their associated chains, if + * any) are handled independently. To see this, consider the following + * array of events: uo1, uo2, o1, uo3, uo4, o2, o3, uo5. When this + * array is passed to odp_queue_enq_multi() then unordered events uo1 and + * uo2 will be added to queue, then ordered event o1 and the chained + * events uo3, and uo4, will be added, then ordered event o2, then ordered + * event o3 and the chained event uo5 will be added. In all cases, + * unordered events that are chained to ordered events inherit the relative + * order of their ordered lead event. Note also that there is no + * requirement that the ordered events passed to this routine all originate + * from the same ordered queue sine each is treated independently. */ int odp_queue_enq_multi(odp_queue_t queue, const odp_event_t events[], int num);