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 DBFDC45DFF; Mon, 2 Dec 2024 06:24:02 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 9E627402A7; Mon, 2 Dec 2024 06:24:02 +0100 (CET) Received: from mail-pl1-f174.google.com (mail-pl1-f174.google.com [209.85.214.174]) by mails.dpdk.org (Postfix) with ESMTP id 0831C40285 for ; Mon, 2 Dec 2024 06:24:00 +0100 (CET) Received: by mail-pl1-f174.google.com with SMTP id d9443c01a7336-2156e078563so8374715ad.2 for ; Sun, 01 Dec 2024 21:23:59 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1733117039; x=1733721839; 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=jCfypl+PmSBkYGEV5wy0EIDxkYYbUZmN+vfKFJ5N3lY=; b=nbiwAVz6Du6y6xZdXP8v9FyToc7QT8YoF7OJu3b/E6sEH9nnapVDFPzNq6kQgCWYpk eM4FsUwpksxJrpmSmoG2eeH3HrGVvx0sfeaadsXQCgmGKtFI6azj0BThf78airQc9S+T G+tR3fSJ+f6F6yIwMTvKpMUXJzSELrADY37k0mG0uE78mDCWEoAAjtqx5z9udzR+nUwT Ee8+jFEYgpkh5IPJYSLjE//SkSlDhx4R/qUOi11YIGRvQ0PiSL5fqN9k54xVEtZKD3N6 SZmV6wKpa6HOL5SVNpSYhBpXQv9evoeSDq0SQXIuU3WBOqQqW8hsZnD9rraaxCeEB7hh JqHg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1733117039; x=1733721839; 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=jCfypl+PmSBkYGEV5wy0EIDxkYYbUZmN+vfKFJ5N3lY=; b=g+7XreQYt15XwRVLOsWdcDHtjsZPVmyVa216ileQJKX5yQGQY1/FPNhy4uIQF49O2y r7s2ynyNx8KN8cZzhe+Z8xmd/Cw5Qd3G50Ng8npdg9w9amGc5Ir00DX8I5Igq47wyULa YG1MOQvqAJVczyGHbXGRkEZZBoXMBeFTm6cOS/Y6O/k7GT8YmIEN2omhcLnbwBOJF5M0 bzekGIN/NJnGCnRtIwhFod3wKgZCtURZ6sodb9RYENVKXi3rrsP6mfhJAG+iG0BvqOYF B+vLNh1oTd025RCFQ8IhnuLRZYwutrFsMdpb7nPYYXyM4q92AfxCAzymu1TBdC5XbFYI sPMg== X-Gm-Message-State: AOJu0YxbJQ+qRtZ0DqLL5L7hENBZeZrYqQ6WJdbsLtkEpxhG4ovTJDyL datZECSAXNylqcicddutXQbEJpVST/z1WRTXYsLiKjoLKifR6VvtGiIBEw== X-Gm-Gg: ASbGncv5vvqKBYSUOgf+A3fnHYKKR9JLxovhZ9Q0gFkHWWKvN85K2J4S0D4206khSMZ +vtqowKcgeg1CV5aX7SP5c3fTZNNRoJlpx6tu3weu1f+a0wEYb+tgYetWduU9zAf3oQZGH6ErI/ RzwGAhV1zd65LuYoX0hOmfdKvuy4ufvpSbqE15SgYnvi7cKCke3KX/RwMdMOi9TttbKyrq0g3YG imXDIVHyP/7efeFbDpNcxbR8leKWzjpGYgVqlpAzcfLVgPjSP0ayGdFvObblCAeuAhCpcuMwsLA 0MbHnwVo2bQCQTFURlCbGsaQfFhc98X04ahCQ5iJ9x1ypbvo X-Google-Smtp-Source: AGHT+IGnyh152hUd8bJXQ11YSidQEEZ2jcljmXQMkw+mZNrVhY7nBY2zs7XwXre/fTwM6Ltpge9RYg== X-Received: by 2002:a17:902:ccc1:b0:215:7a1a:cb9b with SMTP id d9443c01a7336-2157a1acd70mr69775985ad.21.1733117038815; Sun, 01 Dec 2024 21:23:58 -0800 (PST) Received: from localhost.localdomain (syn-076-032-089-124.res.spectrum.com. [76.32.89.124]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-215219d799fsm65971275ad.282.2024.12.01.21.23.58 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 01 Dec 2024 21:23:58 -0800 (PST) From: Nandini Persad To: dev@dpdk.org Subject: [PATCH v3] doc: reword glossary Date: Sun, 1 Dec 2024 21:23:49 -0800 Message-Id: <20241202052349.37261-1-nandinipersad361@gmail.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20241122024023.31914-1-nandinipersad361@gmail.com> References: <20241122024023.31914-1-nandinipersad361@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 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 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. Signed-off-by: Nandini Persad --- doc/guides/prog_guide/glossary.rst | 120 ++++++++++++++++++++--------- 1 file changed, 84 insertions(+), 36 deletions(-) diff --git a/doc/guides/prog_guide/glossary.rst b/doc/guides/prog_guide/glossary.rst index 8d6349701e..d832d4c0be 100644 --- a/doc/guides/prog_guide/glossary.rst +++ b/doc/guides/prog_guide/glossary.rst @@ -6,70 +6,90 @@ Glossary ACL - Access Control List + An `access control list (ACL) `_ + is a set of rules that define who can access a resource and what actions they can perform. API Application Programming Interface ASLR - Linux* kernel Address-Space Layout Randomization + `Address-Space Layout Randomization (ASLR) `_ + is a computer security technique that protects against buffer overflow attacks by randomizing the location of + executables in memory. BSD - Berkeley Software Distribution + `Berkeley Software Distribution (BSD) `_ + is an version of Unix™ operating system. Clr Clear CIDR - Classless Inter-Domain Routing + `Classless Inter-Domain Routing (CIDR) `_ + is a method of assigning IP address that improves data routing efficiency on the internet and is used in IPv4 and IPv6. Control Plane - The control plane is concerned with the routing of packets and with - providing a start or end point. + A `Control Plane `_ is a concept 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. Core A core may include several lcores or threads if the processor supports - hyperthreading. + `simultaneous multithreading (SMT) `_ Core Components - A set of libraries provided by the DPDK, including eal, ring, mempool, - mbuf, timers, and so on. + A set of libraries provided by DPDK which are used by nearly all applications and + upon which other DPDK libraries and drivers depend. For example, eal, ring, mempool and mbuf. CPU Central Processing Unit CRC Cyclic Redundancy Check + An algorithm that detects errors in data transmission and storage. Data Plane - In contrast to the control plane, the data plane in a network architecture - are the layers involved when forwarding packets. These layers must be - highly optimized to achieve good performance. + In contrast to the control plane, which is responsible for setting up and managing data connections, + the `data plane `_ in a network architecture includes the + layers involved when processing and forwarding data packets between communicating endpoints. + These layers must be highly optimized to achieve good performance. DIMM Dual In-line Memory Module + A module containing one or several Random Access Memory (RAM) or Dynamic RAM (DRAM) chips on a printed + circuit board that connect it directly to the computer motherboard. Doxygen - A documentation generator used in the DPDK to generate the API reference. + `Doxygen `_ is a + documentation generator used in the DPDK to generate the API reference. DPDK Data Plane Development Kit DRAM - Dynamic Random Access Memory + `Dynamic Random Access Memory `_ + is type of random access memory (RAM) that is used in computers to temporarily store information. EAL - The Environment Abstraction Layer (EAL) provides a generic interface that - hides the environment specifics from the applications and libraries. 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 communication. + :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 libraries. + The services expected from the EAL are: loading and launching, core management, + memory allocation, bus management, and inter-partition communication. + +EAL Thread + An EAL thread is typically a thread that runs packet processing tasks. These threads are often + pinned to logical cores (lcores), which helps to ensure that packet processing tasks are executed with + minimal interruption and maximal performance by utilizing specific CPU resources dedicated to those tasks. + EAL threads can also handle other tasks like managing buffers, queues, and I/O operations. FIFO - First In First Out + `First In First Out (FIFO) `_ + is a method for organizing the manipulation of a data structure where the oldest (first) entry, or + "head" of the queue, is processed first. FPGA - Field Programmable Gate Array + `Field Programmable Gate Array (FPGA) `_ + An integrated circuit with a programmable hardware fabric that can be reconfigured to suit different purposes. GbE Gigabit Ethernet @@ -81,11 +101,20 @@ HPET High Precision Event Timer; a hardware timer that provides a precise time reference on x86 platforms. +Huge Pages + `Huge pages `_ + are memory page sizes, larger than the default page size, which are supported by the host CPU. + These pages are generally megabytes or even a gigabytes in size, depending on platform, + compared to the default page size on most platforms which is measured in kilobytes, e.g. 4k. + Where the operating system provides access to hugepage memory, DPDK will take advantage of + those hugepages for increased performance. + ID Identifier IOCTL Input/Output Control + A system call that allows applications to communicate with device drivers to perform specific input/output operations. I/O Input/Output @@ -100,30 +129,37 @@ IPv6 Internet Protocol version 6 lcore - A logical execution unit of the processor, sometimes called a *hardware - thread*. + A logical execution unit of the processor, sometimes called a hardware thread or EAL thread; + Also known as logical core. L1 - Layer 1 + Layer 1 - `Physical Layer `_ + The Physical layer of the network responsible for sending and receiving signals to transmit data. L2 - Layer 2 + Layer 2 - `Datalink Layer `_ L3 - Layer 3 + Layer 3 - `Network Layer `_ + Also known as the network layer, Layer 3 is responsible for packet forwarding including routing through intermediate routers + Example protocols include IP v4 and IP v6. L4 - Layer 4 + Layer 4 - `Transport Layer `_ + Examples include UDP and TCP. + LAN Local Area Network LPM - Longest Prefix Match + `Longest Prefix Match `_ is + a lookup algorithm where the entry selected is that which matches the longest initial part (or prefix) + of the lookup key, rather than requiring an exact match on the full key. main lcore - The execution unit that executes the main() function and that launches - other lcores. + The logical core or thread that executes the main function and that launches tasks on other logical + cores used by the application. master lcore Deprecated name for *main lcore*. No longer used. @@ -134,20 +170,20 @@ mbuf concepts of packet buffers or mbuf, refer to *TCP/IP Illustrated, Volume 2: The Implementation*. -MESI - Modified Exclusive Shared Invalid (CPU cache coherency protocol) - MTU Maximum Transfer Unit + The size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction. NIC Network Interface Card + A hardware component, usually a circuit board or chip, installed on a computer so it can connect to a network. OOO Out Of Order (execution of instructions within the CPU pipeline) 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. PCI Peripheral Connect Interface @@ -163,12 +199,16 @@ pktmbuf PMD Poll Mode Driver + A program that continuously polls a network interface card (NIC) for new packets, + instead of waiting for the NIC to interrupt the CPU. PMDs are used to quickly receive, + process, and deliver packets in a user's application and use APIs to configure devices and queues. QoS Quality of Service RCU Read-Copy-Update algorithm, an alternative to simple rwlocks. + A synchronization mechanism that allows multiple threads to read and update shared data structures without using locks. Rd Read @@ -198,6 +238,7 @@ SLA srTCM Single Rate Three Color Marking + A policer meters an IP packet stream and marks its packets either green, yellow, or red. SRTD Scheduler Round Trip Delay @@ -218,12 +259,16 @@ TC TLB Translation Lookaside Buffer + A memory cache that stores the recent translations of virtual memory to physical memory to enable faster retrieval. TLS - Thread Local Storage + `Thread Local Storage `_ + A memory management method that uses static or global memory local to a thread. 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. TSC Time Stamp Counter @@ -245,6 +290,9 @@ Worker lcore WRED Weighted Random Early Detection + A queueing discipline that allows the router to drop random packets to prevent tail drop. + This is helpful for TCP/IP connections. WRR Weighted Round Robin + A scheduling algorithm used to distribute workloads across multiple resources based on assigned weights. -- 2.34.1