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 34B734585A; Wed, 11 Sep 2024 17:55:55 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 2361A42F05; Wed, 11 Sep 2024 17:55:55 +0200 (CEST) Received: from mail-pl1-f175.google.com (mail-pl1-f175.google.com [209.85.214.175]) by mails.dpdk.org (Postfix) with ESMTP id 4C1854029E for ; Wed, 11 Sep 2024 17:55:54 +0200 (CEST) Received: by mail-pl1-f175.google.com with SMTP id d9443c01a7336-2054e22ce3fso106425ad.2 for ; Wed, 11 Sep 2024 08:55:54 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=networkplumber-org.20230601.gappssmtp.com; s=20230601; t=1726070153; x=1726674953; 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=FvG8h9LqVZVKvmLohgsHEiKSdUzY+cqwoxHJ6MSZPok=; b=VTB6U5ceJXKwplQ03Xo8GrzGKIXcsMMB2Gkaj1BJ0E3+C1D8AJUuNlAhfAbXdCdh/N dhG/BSlQs+JXutIMer1MsV7s6DPRJx+Cj5ZFWdu8JxLWpZZROV50dnOZw7AFyQHd8ILs F+wzHvvZdfuXEndW+vF+U4Z93WuKMydwbmGLdeDUN+ChTfgy5y9FZVb6SmA34YrTIIAL ZEPfgZxojkx6Y5zhnkbBuFWKpEUp4mZiH2Ao/0OsFJKp0izqjIsj9tsFPt4RPcXctp4W xmKLuRq8637V+RBrnb73TMQ0N8TO3HVv9hEKIZ4/IG8fseBgQHIGmh+DqRh9jaOWDius +p/A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1726070153; x=1726674953; 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=FvG8h9LqVZVKvmLohgsHEiKSdUzY+cqwoxHJ6MSZPok=; b=B2OD8aKDvdz6w7rrFKJnl9nHhY/HxeQnS6cFkoU/iF7Dn/c4AJKHlNksMInYDjZD0a YasX0fCIGWpdE3SGBdNm1pkLjLn5FK2wBel/5yFmXAj6pa7ngv1Fh+sV0BBDhgIJOkle kHqbQC3qxx2hk8lbbwHkG4gWDYHMBA4QXPR5sSaEj4J4/uc3ec+QVvazPhrtpvR4O8hR luc7LJ+n3KsKF2q0bbqbrkdSGOsDpnclfGicWWIlPuZ6lLCWGhJ+2QGxWVdPpGnuQ1yW gdtVEbVUbb7ebwxxPG51nzwiOOM2jGs9WYixaS9BMhIMSM+js9htgAJnQVgigXuGDDHN RpWw== X-Gm-Message-State: AOJu0Yy3f2em3Q6k//4TP/pkQ6KIz9M+Fv6W4H8BbL1dnai9wXDucVWT 3QiOjAk/UPBGJeVciXvi0wa2mKYQPAOsflF5WXs03sl707pahIa3tU6T32PmSR232SXxgObR3tE 3 X-Google-Smtp-Source: AGHT+IEGyPYAvSnjrGkq+bWYMlDd+qLOkHaGQVbofF/N+0ui8xDHmvWrcKbHWx6YzuF75N3H0WGKig== X-Received: by 2002:a17:903:124d:b0:203:a13a:c49e with SMTP id d9443c01a7336-2075219d5b2mr46127105ad.1.1726070153287; Wed, 11 Sep 2024 08:55:53 -0700 (PDT) Received: from hermes.local (204-195-96-226.wavecable.com. [204.195.96.226]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-2076af477b7sm1324065ad.98.2024.09.11.08.55.52 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 11 Sep 2024 08:55:53 -0700 (PDT) Date: Wed, 11 Sep 2024 08:55:51 -0700 From: Stephen Hemminger To: David Young Cc: dev@dpdk.org, Bruce Richardson , Aaron Conole Subject: Re: [PATCH v4 6/6] Section 6: Glossary Message-ID: <20240911085551.03dd1a9e@hermes.local> In-Reply-To: <20231123012633.2005-7-dave@youngcopy.com> References: <20231103040202.2849-1-dave@youngcopy.com> <20231123012633.2005-1-dave@youngcopy.com> <20231123012633.2005-7-dave@youngcopy.com> MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit 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 Wed, 22 Nov 2023 20:26:27 -0500 David Young wrote: > -Glossary Introduction Formatting: Refined the introduction's formatting for clarity. > -Directive Implementation: Used .. glossary:: directive for structured term definitions. > -Term Definitions and Linking: Expanded definitions for terms like BIOS, > Bifurcated Driver, Clang-LLVM, etc., with reference tags and links to their respective > content pages. > Enhanced Navigation: Integrated hyperlinks for each term, directing to detailed information > on content pages. > --- > doc/guides/getting_started_guide/glossary.rst | 78 +++++++++++++++++++ > 1 file changed, 78 insertions(+) > create mode 100644 doc/guides/getting_started_guide/glossary.rst > > diff --git a/doc/guides/getting_started_guide/glossary.rst b/doc/guides/getting_started_guide/glossary.rst > new file mode 100644 > index 0000000000..29e3f041ba > --- /dev/null > +++ b/doc/guides/getting_started_guide/glossary.rst > @@ -0,0 +1,78 @@ > +.. SPDX-License-Identifier: BSD-3-Clause > + Copyright(c) 2010-2025 Intel Corporation. > + > +Glossary > +======== > + > +This glossary provides definitions for key terms and concepts used within DPDK. Understanding > +these terms will help in comprehending the functionality and architecture of DPDK. Just for giggles asked ChatGpt to make a glossary Creating a glossary for terms used in the DPDK (Data Plane Development Kit) documentation involves defining key concepts, components, and terminology relevant to DPDK. Here's a glossary to help you navigate the DPDK documentation: A Adapter: A hardware component that facilitates the communication between the CPU and network interface card (NIC). B Burst: A group of packets processed or transmitted in a single operation or cycle. C Core: A processing unit within a CPU that can execute tasks independently. In DPDK, cores are often used to handle packet processing. Core Mask: A bitmask used to specify which CPU cores should be used by DPDK applications. Configuration File: A file used to configure the DPDK environment, including options for devices and performance parameters. D DPDK: Data Plane Development Kit, a set of libraries and drivers for fast packet processing. Driver: Software that allows DPDK to interact with hardware components like NICs. Direct Memory Access (DMA): A method for hardware components to access system memory without involving the CPU, improving performance. E Ethernet: A common networking technology used for local area networks (LANs). DPDK often deals with Ethernet packets. F Flow: A sequence of packets with common characteristics, such as source and destination addresses, that can be processed together. Frame: A packet of data transmitted over a network. G Gigabit Ethernet (GbE): A standard for Ethernet networks that supports data rates of 1 gigabit per second. H Hardware Abstraction Layer (HAL): An abstraction layer that hides the complexity of hardware interactions from higher-level software. I Interrupt: A signal sent to the CPU by hardware or software indicating an event that needs immediate attention. IP (Internet Protocol): A protocol used for routing packets across network boundaries. J Jumbo Frame: Ethernet frames that are larger than the standard maximum transmission unit (MTU) size, used to improve network efficiency. K Kernel: The core part of an operating system that manages system resources and hardware communication. L Latency: The time delay between sending and receiving data, critical for performance in packet processing. M Memory Pool: A pool of pre-allocated memory blocks used for efficient allocation and deallocation of memory for packet processing. N NIC (Network Interface Card): A hardware component that connects a computer to a network. NUMA (Non-Uniform Memory Access): A memory design where memory access time depends on the memory location relative to a processor, affecting performance in multi-core systems. O Offloading: The process of delegating certain tasks from the CPU to hardware components to improve performance. P Packet: A unit of data transmitted over a network. Poll Mode Driver (PMD): A driver that uses busy polling to check for incoming packets, providing lower latency and higher performance compared to interrupt-driven drivers. Pipeline: A series of processing stages through which packets pass. Q Queue: A buffer where packets are stored temporarily before being processed or transmitted. R RTE (Runtime Environment): The environment provided by DPDK to manage resources and execute applications. Ring Buffer: A circular buffer used to manage data efficiently, often for inter-process communication. S Socket: A communication endpoint used in network programming. In DPDK, it refers to the hardware or memory allocation context associated with a CPU core. Shared Memory: A memory space that can be accessed by multiple processes or threads, used in DPDK for inter-process communication. T Thread: A separate path of execution within a process, allowing concurrent operations. U Uplink: A connection from a device to a higher-level network, often used to refer to connections between switches or routers. V Virtualization: The creation of virtual instances of hardware or software resources, such as virtual NICs, to improve resource utilization. W Workload: The amount of processing or network traffic handled by DPDK applications. X X86 Architecture: A family of instruction set architectures used in most CPUs, supported by DPDK. Y Yield: The process of allowing other threads or processes to run, typically used in context with CPU resource management. Z Zero-Copy: A technique where data is transferred without being copied between buffers, reducing overhead and improving performance. This glossary covers a broad range of terms relevant to DPDK, but you might encounter additional terms specific to certain features or components of the DPDK ecosystem. For detailed explanations and up-to-date information, always refer to the official DPDK documentation.