From patchwork Mon Aug 3 01:17:34 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 51831 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 E81F7229FD for ; Mon, 3 Aug 2015 01:23:41 +0000 (UTC) Received: by labjb5 with SMTP id jb5sf3373360lab.1 for ; Sun, 02 Aug 2015 18:23:40 -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=W9IOXBHkK5HMjtSj2ibTnHzDYoeBU08O4+mWsdwy4QY5rdThhFVuysyo3V1D3APcAi 7vnePUW3m3oc4nLuEpFKBLYcDsRp/ORNaVwUSJqX2sCLwHSaBx4sWwO+EWBYFWjoiwiR VDuCT74BWO6o2Cu4R/l2EWctSHQ/F+vm0Z9JLki2cWcEyj00jcQDW8o1AwCfekMv/sF7 ZAqAZSoLnirksbb6zKmMqZD66U/kTvTOmCvZhmIX68UoIOP9+IPePGHCnp5UgVT63oPF eIsttQ8WObkreRUkVwgUlSzFwij6gph+jlTrQT4aOSfN7+H9ecwYtCOFcq4pkXbhw+d2 3Low== X-Gm-Message-State: ALoCoQnTvLoWcsKC/MUcRC9y5pGGzszW8jrWNnuSyQDL4bzXlpdWIK4zgae1ZrBzN2mpB4D/PhNn X-Received: by 10.194.80.69 with SMTP id p5mr2910540wjx.2.1438565020910; Sun, 02 Aug 2015 18:23:40 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.7.105 with SMTP id i9ls480263laa.96.gmail; Sun, 02 Aug 2015 18:23:40 -0700 (PDT) X-Received: by 10.112.53.229 with SMTP id e5mr14281338lbp.61.1438565020621; Sun, 02 Aug 2015 18:23:40 -0700 (PDT) Received: from mail-la0-f48.google.com (mail-la0-f48.google.com. [209.85.215.48]) by mx.google.com with ESMTPS id xk9si10623916lac.145.2015.08.02.18.23.40 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Sun, 02 Aug 2015 18:23:40 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.48 as permitted sender) client-ip=209.85.215.48; Received: by labgo9 with SMTP id go9so17626961lab.3 for ; Sun, 02 Aug 2015 18:23:40 -0700 (PDT) X-Received: by 10.152.4.163 with SMTP id l3mr14615292lal.35.1438565020498; Sun, 02 Aug 2015 18:23:40 -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 l6csp1599337lba; Sun, 2 Aug 2015 18:23:39 -0700 (PDT) X-Received: by 10.140.237.4 with SMTP id i4mr22810412qhc.3.1438565018996; Sun, 02 Aug 2015 18:23:38 -0700 (PDT) Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id 136si15321147qhc.102.2015.08.02.18.23.38; Sun, 02 Aug 2015 18:23:38 -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 4D18F61D14; Mon, 3 Aug 2015 01:23:38 +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 5886A61DA2; Mon, 3 Aug 2015 01:19:33 +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 7D86061D7A; Mon, 3 Aug 2015 01:19:15 +0000 (UTC) Received: from mail-qk0-f180.google.com (mail-qk0-f180.google.com [209.85.220.180]) by lists.linaro.org (Postfix) with ESMTPS id 1CA3961D14 for ; Mon, 3 Aug 2015 01:18:44 +0000 (UTC) Received: by qkdg63 with SMTP id g63so46358689qkd.0 for ; Sun, 02 Aug 2015 18:18:43 -0700 (PDT) X-Received: by 10.55.15.20 with SMTP id z20mr21053919qkg.16.1438564723879; Sun, 02 Aug 2015 18:18:43 -0700 (PDT) Received: from localhost.localdomain ([64.88.227.134]) by smtp.gmail.com with ESMTPSA id 60sm6125044qgy.37.2015.08.02.18.18.39 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Sun, 02 Aug 2015 18:18:43 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Sun, 2 Aug 2015 18:17:34 -0700 Message-Id: <1438564655-12686-9-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.1.4 In-Reply-To: <1438564655-12686-1-git-send-email-bill.fischofer@linaro.org> References: <1438564655-12686-1-git-send-email-bill.fischofer@linaro.org> X-Topics: patch Subject: [lng-odp] [API-NEXT PATCHv5 8/9] 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.215.48 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);