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 AB55945DA7; Tue, 26 Nov 2024 04:24:18 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 7C4304025F; Tue, 26 Nov 2024 04:24:18 +0100 (CET) Received: from mail-pf1-f171.google.com (mail-pf1-f171.google.com [209.85.210.171]) by mails.dpdk.org (Postfix) with ESMTP id 93879400EF for ; Tue, 26 Nov 2024 04:24:16 +0100 (CET) Received: by mail-pf1-f171.google.com with SMTP id d2e1a72fcca58-724e113c821so3233817b3a.3 for ; Mon, 25 Nov 2024 19:24:16 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=networkplumber-org.20230601.gappssmtp.com; s=20230601; t=1732591455; x=1733196255; darn=dpdk.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:subject:cc:to:from:date:from:to:cc:subject:date :message-id:reply-to; bh=rio5UqsmfToHAuQpDd5wBcMGzKow736eR8CP0qMdd4o=; b=eulbncPYQt9UB9nGa9uSELkOIHdW8SNUhYEE4FY1g957FkL88qPtmCkxsXBPnHLtaH nb6A1Y2ad01yD3nY22WjNdBQZKVXSD20gY2tWkhE5y+cthiV8OA3BBvgHkdajlsTGYgF e3CJmziW5OQUNKALSEupB/s+qQ1Z5naOvv6LrVHLDxzXnlMEWaHrmcC5xxOXwmN126OO mquKmyqMsU9LsY3woSQUgGMrrplUUlzjMpKLwVhgwvscCzl4/Z6AciWDQkp/q0ujqjZD Ii9wpnP+lNfDhRbG8yc8gnDzgvAU9ROZIpmKSEAEg8pLHsyWjjmsPnC0q+e+yeUPrbNC XJvw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1732591455; x=1733196255; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:subject:cc:to:from:date:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=rio5UqsmfToHAuQpDd5wBcMGzKow736eR8CP0qMdd4o=; b=F27AnIOuWq8/nzEdprKYS2ajTpvntQZHq8qzSt/3Ct1jeZEMg5IM4G28IByUittZ+X Gx2+5CZgI9lwTi4jA6FmEBO6WGduA/SkeIYdKoRj+e+rOhc1VHUGee46vjOME08ZKi/K FHMpGzc4IJTHdmGpMLXO0Rk+/fYHlX/AcSGzT+Jo8xSC6AQCzOUWxOGuv/J00KOo5k5B 09MPYYeDwZitkQ1pf2P9qjG9QLZZoU1qS62WEkHjpjDbA5k6j75E1RANg5ebUtMpE4W4 k1WXFWzNIzWDUqMWbzaYFLh2AqA0G3FJQddGQU2cedX7naBpCxVxyji9BQl0yEVHjDo8 o97w== X-Gm-Message-State: AOJu0Yy9JAO8fmWm3wh7TwhD9AH2pD/IoaFQYPOvQLYDOkJsHiBJJTOC VGaA5G9Od1nIGY8ZPXwTbOTDT9KLYwoGTt4lS2Hdu9BuTJEB7Nr6mAwSs4GT/vE= X-Gm-Gg: ASbGncvDi4JUJyMxL+8g9FJWO3zQ/XDO3r4+u6WiASqeo2cOEMJwtlFZGmRSTvmZJCp o5Sd5FNLzizg8+OJ9UDyUPaKn7/J4rfn1w6jRzrjShPRSLNdLW7T8C1jdZk97MhLK3WF9eFpZxv 1yNiw7wEqCkdrf1easrmaeSj8LSafzAKsRdbRWWTmOw5h2Xtlyywli9cxy/Q3ZfR0M3nxHYRwSH Tr46QZ+8MCDUYp9sZBpeXHLvjL3uvPWiPSykufKWE4A11JtCQZapUfMfMLeTXD/4QbvEf6E+Scq xb6ROHXvjH3iI3fStul5ro5YC8Q= X-Google-Smtp-Source: AGHT+IHymIn6+cu3yMxS6aIAG+VIMUIbkjbss9kwNlJPUSs7USumMjMMU+Dxh8dSvcdI5XpXc5K5TQ== X-Received: by 2002:a17:903:32ca:b0:20d:2804:bcde with SMTP id d9443c01a7336-2129f28a226mr216866535ad.35.1732591455296; Mon, 25 Nov 2024 19:24:15 -0800 (PST) Received: from hermes.local (204-195-96-226.wavecable.com. [204.195.96.226]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-2129dc20bb0sm73137285ad.239.2024.11.25.19.24.14 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 25 Nov 2024 19:24:15 -0800 (PST) Date: Mon, 25 Nov 2024 19:24:13 -0800 From: Stephen Hemminger To: Nandini Persad Cc: dev@dpdk.org Subject: Re: [PATCH] doc: reword glossary Message-ID: <20241125192413.41d23764@hermes.local> In-Reply-To: <20241122022645.31480-1-nandinipersad361@gmail.com> References: <20241122022645.31480-1-nandinipersad361@gmail.com> MIME-Version: 1.0 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 Thu, 21 Nov 2024 18:26:45 -0800 Nandini Persad wrote: > I added additional reference links and definitions to many > of the terms in the glossary. Please feel free to provide > feedback to ensure my definitions suit the proper context > in the DPDK community. >=20 > Signed-off-by: Nandini Persad Rather than putting links after the text, they can be embedded which solves lots of the reference warnings. Please only link to neutral third party places like IETF (RFC's), Wikipedia= , etc. Not vendor sites. I added a few more links, and there are many more that could go here. HPET, IPv4 (RFC), IPv6 (RFC), LAN (wikipedia), MTU, NIC, Out of Order execu= tion, PCI (PCI standard), PHY (wikipedia), PIE (RFC), QoS (various RFC's), RCU (wikipedia), RED(RFC), RSS (wikipedia) , SLA, srTCM, Traffic Class, TLB, TSC, TUN/TAP, VLAN, WRED, ... diff --git a/doc/guides/prog_guide/glossary.rst b/doc/guides/prog_guide/glo= ssary.rst index 9f85e46437..d832d4c0be 100644 --- a/doc/guides/prog_guide/glossary.rst +++ b/doc/guides/prog_guide/glossary.rst @@ -6,35 +6,35 @@ Glossary =20 =20 ACL - An access control list (ACL) is a set of rules that define who can acce= ss a resource and what actions they can perform. - `ACL Link `_ + An `access control list (ACL) `_ + is a set of rules that define who can access a resource and what action= s they can perform. =20 API Application Programming Interface =20 ASLR - Linux* kernel Address-Space Layout Randomization - A computer security technique that protects against buffer overflow att= acks by randomizing the location of executables in memory in Linux. - `ASLR Link `_ + `Address-Space Layout Randomization (ASLR) `_ + is a computer security technique that protects against buffer overflow = attacks by randomizing the location of + executables in memory. =20 BSD - Berkeley Software Distribution is a Unix-like operating system. + `Berkeley Software Distribution (BSD) `_ + is an version of Unix=E2=84=A2 operating system. =20 Clr Clear =20 CIDR - Classless Inter-Domain Routing - A method of assigning IP address that improves data routing efficiency = on the internet and is used in IPv4 and IPv6. - `RFC Link `_ + `Classless Inter-Domain Routing (CIDR) `_ + is a method of assigning IP address that improves data routing efficien= cy on the internet and is used in IPv4 and IPv6. =20 Control Plane - A Control Plane is a key concept in networking that refers to the part = of a network system + A `Control Plane `_ is a c= oncept in networking that refers to the part of the system responsible for managing and making decisions about where and how data = packets are forwarded within a network. =20 Core - A core may include several lcores or threads if the processor supports = simultaneous multithreading (SMT). - `Simultaneous Multithreading `_ + A core may include several lcores or threads if the processor supports + `simultaneous multithreading (SMT) `_ =20 Core Components A set of libraries provided by DPDK which are used by nearly all applic= ations and @@ -49,8 +49,9 @@ CRC =20 Data Plane In contrast to the control plane, which is responsible for setting up a= nd managing data connections, - the data plane in a network architecture includes the layers involved w= hen processing and forwarding - data packets between communicating endpoints. These layers must be high= ly optimized to achieve good performance. + the `data plane `_ in a netwo= rk architecture includes the + layers involved when processing and forwarding data packets between com= municating endpoints. + These layers must be highly optimized to achieve good performance. =20 DIMM Dual In-line Memory Module @@ -58,23 +59,22 @@ DIMM circuit board that connect it directly to the computer motherboard. =20 Doxygen - A documentation generator used in the DPDK to generate the API referenc= e. - `Doxygen Link `_ + `Doxygen `_ is a + documentation generator used in the DPDK to generate the API reference. =20 DPDK Data Plane Development Kit =20 DRAM - Dynamic Random Access Memory - A type of random access memory (RAM) that is used in computers to tempo= rarily store information. - `Link `_ + `Dynamic Random Access Memory `_ + is type of random access memory (RAM) that is used in computers to tem= porarily store information. =20 EAL - The Environment Abstraction Layer (EAL) is a DPDK core library that pro= vides a generic interface - that hides the environment specifics from the applications and librarie= s. The services expected - from the EAL are: development kit loading and launching, core affinity/= assignment procedures, system - memory allocation/description, PCI bus access, inter-partition communic= ation. - `Link `_ + :doc:`Environment Abstraction Layer (EAL) ` + is a the core DPDK library that provides a generic interface + that hides the environment specifics from the applications and librarie= s. + The services expected from the EAL are: loading and launching, core man= agement, + memory allocation, bus management, and inter-partition communication. =20 EAL Thread An EAL thread is typically a thread that runs packet processing tasks. = These threads are often @@ -83,15 +83,13 @@ EAL Thread EAL threads can also handle other tasks like managing buffers, queues, = and I/O operations. =20 FIFO - First In First Out - A method for organizing the manipulation of a data structure where the = oldest (first) entry, or + `First In First Out (FIFO) `_ + is a method for organizing the manipulation of a data structure where t= he oldest (first) entry, or "head" of the queue, is processed first. - `Link `_ =20 FPGA - Field Programmable Gate Array + `Field Programmable Gate Array (FPGA) `_ An integrated circuit with a programmable hardware fabric that can be r= econfigured to suit different purposes. - `Link `_ =20 GbE Gigabit Ethernet @@ -104,12 +102,12 @@ HPET reference on x86 platforms. =20 Huge Pages - Memory page sizes, larger than the default page size, which are support= ed by the host CPU. + `Huge pages `_ + are memory page sizes, larger than the default page size, which are sup= ported by the host CPU. These pages are generally megabytes or even a gigabytes in size, depen= ding on platform, compared to the default page size on most platforms which is measured i= n kilobytes, e.g. 4k. Where the operating system provides access to hugepage memory, DPDK wil= l take advantage of those hugepages for increased performance. - `Link `_ =20 ID Identifier @@ -135,31 +133,29 @@ lcore Also known as logical core. =20 L1 - Layer 1 + Layer 1 - `Physical Layer `_ The Physical layer of the network responsible for sending and receiving= signals to transmit data. =20 L2 - Layer 2 + Layer 2 - `Datalink Layer `_ =20 L3 - Layer 3 + Layer 3 - `Network Layer `_ Also known as the network layer, Layer 3 is responsible for packet forw= arding including routing through intermediate routers Example protocols include IP v4 and IP v6. - `Network Layer `_ =20 L4 - Layer 4 + Layer 4 - `Transport Layer `_ Examples include UDP and TCP. - `Transport Layer `_ + =20 LAN Local Area Network =20 LPM - Longest Prefix Match - A table lookup algorithm where the entry selected is that which matches= the longest initial part (or prefix) + `Longest Prefix Match `_ is + a lookup algorithm where the entry selected is that which matches the l= ongest initial part (or prefix) of the lookup key, rather than requiring an exact match on the full key. - `Reference Link `_ =20 main lcore The logical core or thread that executes the main function and that lau= nches tasks on other logical @@ -186,9 +182,8 @@ OOO Out Of Order (execution of instructions within the CPU pipeline) =20 NUMA - Non-uniform Memory Access + `Non-uniform Memory Access (NUMA) `_ A computer memory design that allows processors to access memory faster= when it's located closer to them. - `Reference Link `_ =20 PCI Peripheral Connect Interface @@ -267,15 +262,13 @@ TLB A memory cache that stores the recent translations of virtual memory to= physical memory to enable faster retrieval. =20 TLS - Thread Local Storage + `Thread Local Storage `_ A memory management method that uses static or global memory local to a= thread. - `Reference Link `_ =20 trTCM - Two Rate Three Color Marking + `Two Rate Three Color Marking ` A component that meters an IP traffic stream, marks it as one of three = color category sand assists in traffic congestion-control. - `RFC Link `_ =20 TSC Time Stamp Counter