From patchwork Sat Aug 8 03:03:00 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 52057 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-wi0-f198.google.com (mail-wi0-f198.google.com [209.85.212.198]) by patches.linaro.org (Postfix) with ESMTPS id 8277C20539 for ; Sat, 8 Aug 2015 03:04:56 +0000 (UTC) Received: by wibdx1 with SMTP id dx1sf22935770wib.2 for ; Fri, 07 Aug 2015 20:04:55 -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=yBBJtTyRbH10EdmauakcgoV5ZzQTaOizVeyZ4/vQ/vk=; b=QWluUWCuBV58X22QhnZCP9vrbIE5xze/dFUZXstuBmRqHDAb4ryMpJG7f7kLznDRBJ mtkjFQOptNSeFcg5zo+drZwqM5ZKJKGZ0ZbvvPHIllWMlOFiBPJTTXKmliudKK9dQXFi a8B/dQA2Z5qaDKC1Thuu5hqhxoaNTI3vh/S82ZxWQ2vl0tuN0w0cUVfbj5AtBcWBvHnC LlPcKBwfdSxVkKq069kkjja0aWEkQwEyalVvdS1HZAqWELqNVebR0ioGwBMjeRpJgp+M pEnMkak4BJSEL6k+MDuebPaymxCpQD+6S2kCfC/bedrPUQzf3724Ps0kpzgzsSxDX92s RQDg== X-Gm-Message-State: ALoCoQnKbW8QI+8fomMneV9/7NRIrl+KF+86t8tyeBMMscQbiagxVrzWEhoCzirpQy1lUInZjTgU X-Received: by 10.180.216.12 with SMTP id om12mr387167wic.1.1439003095821; Fri, 07 Aug 2015 20:04:55 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.27.234 with SMTP id w10ls553585lag.41.gmail; Fri, 07 Aug 2015 20:04:55 -0700 (PDT) X-Received: by 10.112.137.97 with SMTP id qh1mr11005006lbb.1.1439003095585; Fri, 07 Aug 2015 20:04:55 -0700 (PDT) Received: from mail-lb0-f177.google.com (mail-lb0-f177.google.com. [209.85.217.177]) by mx.google.com with ESMTPS id l3si9081465lbq.158.2015.08.07.20.04.55 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Fri, 07 Aug 2015 20:04:55 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.177 as permitted sender) client-ip=209.85.217.177; Received: by lbbtg9 with SMTP id tg9so32175888lbb.1 for ; Fri, 07 Aug 2015 20:04:55 -0700 (PDT) X-Received: by 10.152.22.99 with SMTP id c3mr11326060laf.32.1439003095285; Fri, 07 Aug 2015 20:04:55 -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 l6csp717238lba; Fri, 7 Aug 2015 20:04:54 -0700 (PDT) X-Received: by 10.107.137.218 with SMTP id t87mr10945427ioi.37.1439003094001; Fri, 07 Aug 2015 20:04:54 -0700 (PDT) Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id x1si967248igl.76.2015.08.07.20.04.53; Fri, 07 Aug 2015 20:04:53 -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 0F8A1623CA; Sat, 8 Aug 2015 03:04:53 +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 0F281623A2; Sat, 8 Aug 2015 03:03:29 +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 3D72762394; Sat, 8 Aug 2015 03:03:22 +0000 (UTC) Received: from mail-oi0-f45.google.com (mail-oi0-f45.google.com [209.85.218.45]) by lists.linaro.org (Postfix) with ESMTPS id 94A136238C for ; Sat, 8 Aug 2015 03:03:20 +0000 (UTC) Received: by oip136 with SMTP id 136so63009514oip.1 for ; Fri, 07 Aug 2015 20:03:20 -0700 (PDT) X-Received: by 10.202.106.147 with SMTP id f141mr9315261oic.65.1439003000105; Fri, 07 Aug 2015 20:03:20 -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 kp7sm7375667oeb.14.2015.08.07.20.03.19 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Fri, 07 Aug 2015 20:03:19 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Fri, 7 Aug 2015 22:03:00 -0500 Message-Id: <1439002992-29285-3-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.1.4 In-Reply-To: <1439002992-29285-1-git-send-email-bill.fischofer@linaro.org> References: <1439002992-29285-1-git-send-email-bill.fischofer@linaro.org> X-Topics: patch Subject: [lng-odp] [API-NEXT PATCHv10 02/14] 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.177 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 Expand documentation of odp_queue_enq_multi() to describe support for ordered chains. 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);