From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 3B72C4234C; Tue, 10 Oct 2023 15:31:59 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id BF1FD402C2; Tue, 10 Oct 2023 15:31:58 +0200 (CEST) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by mails.dpdk.org (Postfix) with ESMTP id 6EF3D40297 for ; Tue, 10 Oct 2023 15:31:57 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1696944716; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=eRj+pBj4yO6szB1IcRnyKXJOScezhdZPMhktdJemiY8=; b=gM4Rl6ABgbh0zkDOjVvn8a3MAlCMbcsf6dZ6KmveEAVKVFDn6J/5ghUkwTFRhz5n8lpnJ3 uUYP1yEgCQhPKUcAzkRqcmmIqyHNGniQpdY9oXHRnM3pGHXlXuLgxdVkKMW/qGwWqu/eVg DubCt+x7kbkUB8GW+GcqYSxnnLA+HbY= Received: from mail-lj1-f198.google.com (mail-lj1-f198.google.com [209.85.208.198]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-37-n94jxVJsNlqRlh47BnBk8A-1; Tue, 10 Oct 2023 09:31:52 -0400 X-MC-Unique: n94jxVJsNlqRlh47BnBk8A-1 Received: by mail-lj1-f198.google.com with SMTP id 38308e7fff4ca-2c030cea151so46831951fa.0 for ; Tue, 10 Oct 2023 06:31:52 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1696944711; x=1697549511; h=content-transfer-encoding:cc:to:subject:message-id:date:from :in-reply-to:references:mime-version:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=eRj+pBj4yO6szB1IcRnyKXJOScezhdZPMhktdJemiY8=; b=SayRAH6YWlxN6eFBIVNBTyhUSjp80LvOlgjqbQ9MgfRrFsjr7dppzD0+RkKJ6drqKF GyHZfrd1NGcN34LIVoaeY6cfJO5kJTJGF333q4P8sGd6566jcGEmqfGvE4iylCtzSJz4 +t/1ROlLvU+9y+AguzSLmRVjrknC9qVbJfELXH0UdSPm+dNur9tv5EJB3UJdbEYxOTiz nRPGDS5+3Ar5RSpA444B/wciLP0C1Y3D5mLPFEbpPxmfws2Fip9ROuTbtXhA2A49vCX7 ZAQV4tky2yXyD8/9Xka4hNeuIUe+2MnWJd1f4wk2kIDq6uQY/l4g9vREtA9v/uDAJjpa 2EtA== X-Gm-Message-State: AOJu0YwjGDOaGF66RK9WybCft8FAxofMtZp13Q6gS1JpKNgP77qPm2QO 7v87ejVUqeUTKEOQN9IO7WyF9RAvkZyISGWT8CJq1opulbQhSrUDe7PEsy5OKGLkBxrEDdVFGPu 1IpW9lrj+L50xcN39giQ= X-Received: by 2002:a05:6512:758:b0:503:59d:fbff with SMTP id c24-20020a056512075800b00503059dfbffmr7272716lfs.2.1696944710876; Tue, 10 Oct 2023 06:31:50 -0700 (PDT) X-Google-Smtp-Source: AGHT+IF2U0CJ9tCA9TyIOMH2z6gdU7JiIEqNP8Itixx7M+NRk2whSP7spM+5BK+LcjrbrsBV9JPisSk9szicCSkoRcA= X-Received: by 2002:a05:6512:758:b0:503:59d:fbff with SMTP id c24-20020a056512075800b00503059dfbffmr7272680lfs.2.1696944710495; Tue, 10 Oct 2023 06:31:50 -0700 (PDT) MIME-Version: 1.0 References: <20230928073056.359356-2-mattias.ronnblom@ericsson.com> <20231009181711.440865-1-mattias.ronnblom@ericsson.com> <20231009181711.440865-4-mattias.ronnblom@ericsson.com> In-Reply-To: <20231009181711.440865-4-mattias.ronnblom@ericsson.com> From: David Marchand Date: Tue, 10 Oct 2023 15:31:38 +0200 Message-ID: Subject: Re: [PATCH v6 3/3] doc: add dispatcher programming guide To: =?UTF-8?Q?Mattias_R=C3=B6nnblom?= Cc: dev@dpdk.org, Jerin Jacob , techboard@dpdk.org, harry.van.haaren@intel.com, hofors@lysator.liu.se, Peter Nilsson , Heng Wang , Naga Harish K S V , Pavan Nikhilesh , Gujjar Abhinandan S , Erik Gabriel Carrillo , Shijith Thotton , Hemant Agrawal , Sachin Saxena , Liang Ma , Peter Mccarthy , Zhirun Yan X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org On Mon, Oct 9, 2023 at 8:23=E2=80=AFPM Mattias R=C3=B6nnblom wrote: [snip] > +A module may use more than one event handler, for convenience or to > +further decouple sub-modules. However, the dispatcher may impose an > +upper limit of the number handlers. In addition, installing a large > +number of handlers increase dispatcher overhead, although this does > +not nessarily translate to a system-level performance degradation. See necessarily* [snip] > +Event Clustering > +^^^^^^^^^^^^^^^^ > + > +The dispatcher maintains the order of events destined for the same > +handler. > + > +*Order* here refers to the order in which the events were delivered > +from the event device to the dispatcher (i.e., in the event array > +populated by ``rte_event_dequeue_burst()``), in relation to the order > +in which the dispatcher deliveres these events to the application. > + > +The dispatcher *does not* guarantee to maintain the order of events > +delivered to *different* handlers. > + > +For example, assume that ``MODULE_A_QUEUE_ID`` expands to the value 0, > +and ``MODULE_B_STAGE_0_QUEUE_ID`` expands to the value 1. Then > +consider a scenario where the following events are dequeued from the > +event device (qid is short for event queue id). > + > +.. code-block:: Surprisingly, Ubuntu in GHA sphinx complains about this code-block directive while generating on my Fedora runs fine... FAILED: doc/guides/html /usr/bin/python3 ../buildtools/call-sphinx-build.py /usr/bin/sphinx-build 23.11.0-rc0 /home/runner/work/dpdk/dpdk/doc/guides /home/runner/work/dpdk/dpdk/build/doc/guides -a -W Warning, treated as error: /home/runner/work/dpdk/dpdk/doc/guides/prog_guide/dispatcher_lib.rst:253:Er= ror in "code-block" directive: 1 argument(s) required, 0 supplied. .. code-block:: [e0: qid=3D1], [e1: qid=3D1], [e2: qid=3D0], [e3: qid=3D1] Looking at https://www.sphinx-doc.org/en/master/usage/restructuredtext/dire= ctives.html#directive-code-block, I suspect there is probably a difference in the default settings of sphinx in those Ubuntu containers. This is pseudo-code / close to C, so we could probably mark this block as "C", but "none" works fine too. WDYT? --=20 David Marchand