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 4B366454B2; Fri, 21 Jun 2024 04:33:34 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id C437A42E98; Fri, 21 Jun 2024 04:33:28 +0200 (CEST) Received: from mail-pf1-f179.google.com (mail-pf1-f179.google.com [209.85.210.179]) by mails.dpdk.org (Postfix) with ESMTP id 0486342E8F for ; Fri, 21 Jun 2024 04:33:26 +0200 (CEST) Received: by mail-pf1-f179.google.com with SMTP id d2e1a72fcca58-705cffc5bcfso1566494b3a.3 for ; Thu, 20 Jun 2024 19:33:25 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1718937205; x=1719542005; darn=dpdk.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:from:to:cc:subject:date:message-id :reply-to; bh=b9Z2YzdZ6Bt6BPGLubiBI/QfGdFA7MvR6ptVRJQekWA=; b=CGHIqhDUGIMreUcVvCpbeH+N19UHnA1QPsxvFRp6/nefj3va+TGKBqyro9/m+whX2+ tE0Q9HsRJoyoSoF6nHcCM6TW4FThUkEWw5U9GXu6wQk+/Ogi+D5NJEr4x5wsIUGvyv6Y 9IMvqHvg27px1pEx+B6oaTPaQ0OXk5ht/CPLb0SPDT+TPXMmlB7M5vGQ+i/1vDYTI9tU mLZYnOosn7RQRiZMCaoNpfrTAe73QqcYOEzMoe7chDaqpfLFsfYA/kBpOzWCIBCWlTgY IyK8DUSj8qL9CYWAmL7+OtKgeb1wHmy+jEQkTqW0ts3yL/6pI0Uv7qJVrtsxcbkaokeh OMFQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1718937205; x=1719542005; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=b9Z2YzdZ6Bt6BPGLubiBI/QfGdFA7MvR6ptVRJQekWA=; b=v51+qjmuR3ec3CrodbLoxq4pxmEDObVPsi7CYZsXG7gzUhSPUyv4zJbBF5aAXCR7iV 9/r0NzvrnVUdPwrLAxw6DWkcD9nznMSWlrCh3AkMZzFd4ISHS7j54flq22VrlDr95AaF 2Cae/92425o/QT17iEMVaYnxcbHTxzGn3umb7uhQRGycid7WIgkScPknUtq+7jUkQXhO yoE23jijCHfHCRqsC7n58rFaA/vG/EOBEsLfxjJLE/V/hjHZTOULes5ViKP8uisKlZUE 0glbtsElYIy9Gtsfd+3di0aKYcNsOpcnvbZgHWjjm/XlJWw2YdbvAv4JqwSuEq7wgmFv WHJg== X-Gm-Message-State: AOJu0Yy4gesZwOZpIYW7uMd03B7fgYYTgyjf2c80JM7SyM5LZgy76kla p/7MfnKbq/AbiQziOM/9R9BSBttulpX/pyIPVWx23SyFuU08DzU53zTa9xyO X-Google-Smtp-Source: AGHT+IGrYXw6K2H293z6aPIgdcVAYLW40bDG5Tk7Ji/mY3Lmy19dfLFonYTcODXlKvJ8e8EY9F+76g== X-Received: by 2002:a05:6a20:6da5:b0:1bc:c4d1:7810 with SMTP id adf61e73a8af0-1bcc4d17871mr5629149637.29.1718937204857; Thu, 20 Jun 2024 19:33:24 -0700 (PDT) Received: from localhost.localdomain (syn-076-032-089-124.res.spectrum.com. [76.32.89.124]) by smtp.gmail.com with ESMTPSA id d2e1a72fcca58-7065124df73sm334482b3a.110.2024.06.20.19.33.24 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 20 Jun 2024 19:33:24 -0700 (PDT) From: Nandini Persad To: dev@dpdk.org Subject: [PATCH v2 4/9] doc: reword service cores section in prog guide Date: Thu, 20 Jun 2024 19:32:49 -0700 Message-Id: <20240621023254.4258-4-nandinipersad361@gmail.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240621023254.4258-1-nandinipersad361@gmail.com> References: <20240513155911.31872-1-nandinipersad361@gmail.com> <20240621023254.4258-1-nandinipersad361@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit 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 I've made minor syntax changes to section 8 of programmer's guide, service cores. Signed-off-by: Nandini Persad --- doc/guides/prog_guide/service_cores.rst | 32 ++++++++++++------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/doc/guides/prog_guide/service_cores.rst b/doc/guides/prog_guide/service_cores.rst index d4e6c3d6e6..59da3964bf 100644 --- a/doc/guides/prog_guide/service_cores.rst +++ b/doc/guides/prog_guide/service_cores.rst @@ -4,38 +4,38 @@ Service Cores ============= -DPDK has a concept known as service cores, which enables a dynamic way of -performing work on DPDK lcores. Service core support is built into the EAL, and -an API is provided to optionally allow applications to control how the service +DPDK has a concept known as service cores. Service cores enable a dynamic way of +performing work on DPDK lcores. Service core support is built into the EAL. +An API is provided to give you the option of allowing applications to control how the service cores are used at runtime. -The service cores concept is built up out of services (components of DPDK that +The service cores concept is built out of services (components of DPDK that require CPU cycles to operate) and service cores (DPDK lcores, tasked with running services). The power of the service core concept is that the mapping -between service cores and services can be configured to abstract away the +between service cores and services can be configured to simplify the difference between platforms and environments. -For example, the Eventdev has hardware and software PMDs. Of these the software +For example, the Eventdev has hardware and software PMDs. Of these the software, PMD requires an lcore to perform the scheduling operations, while the hardware PMD does not. With service cores, the application would not directly notice -that the scheduling is done in software. +that the scheduling is done in the software. For detailed information about the service core API, please refer to the docs. Service Core Initialization ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -There are two methods to having service cores in a DPDK application, either by +There are two methods to having service cores in a DPDK application: by using the service coremask, or by dynamically adding cores using the API. -The simpler of the two is to pass the `-s` coremask argument to EAL, which will -take any cores available in the main DPDK coremask, and if the bits are also set -in the service coremask the cores become service-cores instead of DPDK +The simpler of the two is to pass the `-s` coremask argument to the EAL, which will +take any cores available in the main DPDK coremask. If the bits are also set +in the service coremask, the cores become service-cores instead of DPDK application lcores. Enabling Services on Cores ~~~~~~~~~~~~~~~~~~~~~~~~~~ -Each registered service can be individually mapped to a service core, or set of +Each registered service can be individually mapped to a service core, or a set of service cores. Enabling a service on a particular core means that the lcore in question will run the service. Disabling that core on the service stops the lcore in question from running the service. @@ -48,8 +48,8 @@ function to run the service. Service Core Statistics ~~~~~~~~~~~~~~~~~~~~~~~ -The service core library is capable of collecting runtime statistics like number -of calls to a specific service, and number of cycles used by the service. The +The service core library is capable of collecting runtime statistics like the number +of calls to a specific service, and the number of cycles used by the service. The cycle count collection is dynamically configurable, allowing any application to profile the services running on the system at any time. @@ -58,9 +58,9 @@ Service Core Tracing The service core library is instrumented with tracepoints using the DPDK Trace Library. These tracepoints allow you to track the service and logical cores -state. To activate tracing when launching a DPDK program it is necessary to use the +state. To activate tracing when launching a DPDK program, it is necessary to use the ``--trace`` option to specify a regular expression to select which tracepoints -to enable. Here is an example if you want to only specify service core tracing:: +to enable. Here is an example if you want to specify only service core tracing:: ./dpdk/examples/service_cores/build/service_cores --trace="lib.eal.thread*" --trace="lib.eal.service*" -- 2.34.1