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 B85164401C; Mon, 13 May 2024 18:02:04 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 1173940A79; Mon, 13 May 2024 18:01:41 +0200 (CEST) Received: from mail-pf1-f175.google.com (mail-pf1-f175.google.com [209.85.210.175]) by mails.dpdk.org (Postfix) with ESMTP id D97B140687 for ; Mon, 13 May 2024 17:59:36 +0200 (CEST) Received: by mail-pf1-f175.google.com with SMTP id d2e1a72fcca58-6f44dd41a5cso4593278b3a.0 for ; Mon, 13 May 2024 08:59:36 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1715615976; x=1716220776; darn=dpdk.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=Vw3KutvrNMUJxXkyW/HjN0/L1LNmCWrtE2KRtp1LAzQ=; b=I5A2rw8cV+P98BI62hEO3lxWOqCeFm5nvzqEOULjRYLXEMAZXjN9QBPmaBSWg2WFws 8d8rd70jUz1HU46EMBie0jBBy/P1Il9zP/nrN51a2UYPUEo1GhMUPyfbqt+HyQN+vOdQ iNsuZP5t4RGYhpStxX6n2LmMancdXkgzMWLMbNsyFEGWIdwGh14fQwQ1v1bBaL1l7dnH 72C3bSF/mBDVMNEQDe7rj5MjDskfZpvH8iFNMxVCzBlR5Y2NrIOTI9sCwXLGHzVLUssl doaSMj1Jn+7T7CDACcUV+9e4lvJNuZgMa4xuB4DK5aUQ0qRDbugyJMT4PGH6z1BHdWvo 9b4g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1715615976; x=1716220776; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=Vw3KutvrNMUJxXkyW/HjN0/L1LNmCWrtE2KRtp1LAzQ=; b=OFdhXpQHYXhmgnnBpI50iCKF45RS0LrvYtdHI3u1DQ8D/HJ6qXXp8YmR0O+BYEird7 DO/kWm+D6BGB6iMSLw7v11iG6y2kI9iSUyNx7Tuy0/Fhog9EtqaYq0Gq3jSgO9sDd5HT e5LyysIOvvBYeAQWTzKpQKX3yFt+GZCPwClZptPkdw2BWfJ29xFGjt7Qe9XFrSK/uZzR cMnxu6upgx9duW+e3kIYZg0pPeM5FuVEqcfAWvyVryPCb4jjk5LPKxJ/8na4Q/flBaNo j+KKgFyXQDT0EKs+B1ZxftR9V4ZIIsB+rO556ywYJawrzTrc4xXFpC8SNR1wDYtJZzHx qKsQ== X-Gm-Message-State: AOJu0Yy3/6TjLPVS7kvECEMbV1kfTKnoTPSDZ3B9MV8FzEJHHRPrcPmb W9ukpsAJVXnCARpK6p5fnSHmQQT4qG50S9OBx52PMIQaE9KE5LRE0VZD+A== X-Google-Smtp-Source: AGHT+IHOKee2PxZ93se+yhmP3bf/ViXHUqmHKg1ToISWRVdE2Wyq+qChqlHosTmG6eJSM/WYwXUcKQ== X-Received: by 2002:a05:6a20:f397:b0:1af:ad46:cd4a with SMTP id adf61e73a8af0-1afde09f3c5mr11155372637.12.1715615975800; Mon, 13 May 2024 08:59:35 -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-6f4d2aa16dfsm7715078b3a.93.2024.05.13.08.59.35 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 13 May 2024 08:59:35 -0700 (PDT) From: Nandini Persad To: dev@dpdk.org Cc: Harry van Haaren Subject: [PATCH 4/9] doc: reword service cores section in prog guide Date: Mon, 13 May 2024 08:59:06 -0700 Message-Id: <20240513155911.31872-5-nandinipersad361@gmail.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240513155911.31872-1-nandinipersad361@gmail.com> References: <20240513155911.31872-1-nandinipersad361@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Mailman-Approved-At: Mon, 13 May 2024 18:01:34 +0200 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 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