From patchwork Sun Oct 25 10:21:33 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alejandro Colomar X-Patchwork-Id: 40867 Return-Path: X-Original-To: patchwork@sourceware.org Delivered-To: patchwork@sourceware.org Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id 861BB386EC7C; Sun, 25 Oct 2020 10:24:17 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 861BB386EC7C DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sourceware.org; s=default; t=1603621457; bh=jShZUdqUtwbgSjkrtX/OAFUVnLlIcbczdXR5KDufFy0=; h=To:Subject:Date:In-Reply-To:References:List-Id:List-Unsubscribe: List-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To:Cc: From; b=oOAPKDtubLTe6oV5+nc97G80SDurTdY/zBNZJiIWwuiptQtxm9C3lv7122R0ev6SI L6x3DgI/U7lVKiUJnXZGg2EKiQzU4M8GU8BBn0lMc7BXfzLdlDEzbfsIjfqMVL8X6O A+kgV7gP2+mRh9zkgTDoX87ocAMUlJF7BpZZagwM= X-Original-To: libc-alpha@sourceware.org Delivered-To: libc-alpha@sourceware.org Received: from mail-wm1-x344.google.com (mail-wm1-x344.google.com [IPv6:2a00:1450:4864:20::344]) by sourceware.org (Postfix) with ESMTPS id 036333851C3E for ; Sun, 25 Oct 2020 10:24:15 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.3.2 sourceware.org 036333851C3E Received: by mail-wm1-x344.google.com with SMTP id k18so9299829wmj.5 for ; Sun, 25 Oct 2020 03:24:14 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=jShZUdqUtwbgSjkrtX/OAFUVnLlIcbczdXR5KDufFy0=; b=nKjx23ifC+ISf2edvmlRT3R8/l+ipqmVgaR6edgOPqV9QjNaUC3XuUlc7Ij/z5Kild 0ttBJBBvzG2160ohpzlWigR16qN2wWarIOleIhQjroI6b+spLFLnp+whJ8LVwuY4pddy n6yD4IIaJ+Tv1wZUZx8elo5oscDp+TOJIhHT7+95Ii+u1A/dG/9Np0M6xAaD3uUvcpHn KC1qoRSFXyfLk6jGTNZzrZEcaLqd3FUNpQyqrP8N0oeSIrrFBXOEw+Y2mQoM6nKPqB2/ DVGxxTRcjpIwnA51inRR6FOmym3Dr+GBxPuuReECXCEQPubSNaxAprXyfRj4GvJJn9aD XkPA== X-Gm-Message-State: AOAM531SVWtvOY3Jp4w9LvaI4gRyLHktSXseoNh33+p7OfxM14rFdttm eI94UXQBINM76vsTLW9V01OTTFx1utI= X-Google-Smtp-Source: ABdhPJy9prRXK7iNqGTm7p4ttJC1xY0tyrvcAoH7yVHH/8Q24XGF3B7UQg5+hrgccQLf/3bohV3ftQ== X-Received: by 2002:a1c:4d01:: with SMTP id o1mr11423792wmh.39.1603621454062; Sun, 25 Oct 2020 03:24:14 -0700 (PDT) Received: from localhost.localdomain ([170.253.60.68]) by smtp.googlemail.com with ESMTPSA id s185sm15724860wmf.3.2020.10.25.03.24.13 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 25 Oct 2020 03:24:13 -0700 (PDT) To: mtk.manpages@gmail.com Subject: [PATCH 2/2] queue.3: Fix & update after forking circleq.3, list.3, slist.3, stailq.3 & tailq.3 Date: Sun, 25 Oct 2020 11:21:33 +0100 Message-Id: <20201025102132.41223-2-colomar.6.4.3@gmail.com> X-Mailer: git-send-email 2.28.0 In-Reply-To: <20201025102132.41223-1-colomar.6.4.3@gmail.com> References: <20201025102132.41223-1-colomar.6.4.3@gmail.com> MIME-Version: 1.0 X-Spam-Status: No, score=-11.3 required=5.0 tests=BAYES_00, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, FREEMAIL_ENVFROM_END_DIGIT, FREEMAIL_FROM, GIT_PATCH_0, KAM_NUMSUBJECT, RCVD_IN_DNSWL_NONE, SPF_HELO_NONE, SPF_PASS, TXREP autolearn=ham autolearn_force=no version=3.4.2 X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on server2.sourceware.org X-BeenThere: libc-alpha@sourceware.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Libc-alpha mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-Patchwork-Original-From: Alejandro Colomar via Libc-alpha From: Alejandro Colomar Reply-To: Alejandro Colomar Cc: Alejandro Colomar , linux-man@vger.kernel.org, libc-alpha@sourceware.org Errors-To: libc-alpha-bounces@sourceware.org Sender: "Libc-alpha" - ffix: Use man markup - Remove specific notes about code size increase and execution time increase, as they were (at least) inaccurate. Instead, a generic note has been added. - Structure the text into subsections. - Remove sections that were empty after the forks. - Clearly relate macro names (SLIST, TAILQ, ...) to a human readable name of which data structure they implement. Reported-by: Michael Kerrisk Signed-off-by: Alejandro Colomar --- man3/queue.3 | 189 ++++++++++++++++++++------------------------------- 1 file changed, 75 insertions(+), 114 deletions(-) diff --git a/man3/queue.3 b/man3/queue.3 index 3931f8c96..c1b8a72a8 100644 --- a/man3/queue.3 +++ b/man3/queue.3 @@ -28,160 +28,121 @@ .\" SUCH DAMAGE. .\" %%%LICENSE_END .\" -.\" @(#)queue.3 8.2 (Berkeley) 1/24/94 -.\" $FreeBSD$ .\" -.Dd February 7, 2015 -.Dt QUEUE 3 -.Os -.Sh NAME -.Nd implementations of singly-linked lists, singly-linked tail queues, -lists, tail queues, and circular queues -.Sh SYNOPSIS -.Sh DESCRIPTION -These macros define and operate on five types of data structures: -singly-linked lists, singly-linked tail queues, lists, tail queues, and -circular queues. -All five structures support the following functionality: -.Pp -.Bl -enum -compact -offset indent -.It +.TH QUEUE 3 2015-02-7 "GNU" "Linux Programmer's Manual" +.SH NAME +queue \- implementations of linked lists and queues +.SH DESCRIPTION +The +.I +header file provides a set of macros that +define and operate on the following data structures: +.IP * 3 +singly-linked lists (SLIST) +.IP * +doubly-linked lists (LIST) +.IP * +singly-linked tail queues (STAILQ) +.IP * +doubly-linked tail queues (TAILQ) +.IP * +doubly-linked circular queues (CIRCLEQ) +.PP +All structures support the following functionality: +.IP * 3 Insertion of a new entry at the head of the list. -.It +.IP * Insertion of a new entry after any element in the list. -.It +.IP * O(1) removal of an entry from the head of the list. -.It +.IP * Forward traversal through the list. -.\" .It +.\".IP * .\" Swapping the contents of two lists. -.El -.Pp -Singly-linked lists are the simplest of the four data structures +.PP +Code size and execution time +depend on the complexity of the data structure being used, +so programmers should take care of choosing the appropriate one. +.SS Singly-linked lists (SLIST) +Singly-linked lists are the simplest and support only the above functionality. -Singly-linked lists are ideal for applications with large datasets -and few or no removals, +Singly-linked lists are ideal for applications with +large datasets and few or no removals, or for implementing a LIFO queue. Singly-linked lists add the following functionality: -.Pp -.Bl -enum -compact -offset indent -.It +.IP * 3 O(n) removal of any entry in the list. -.El -.Pp +.SS Singly-linked tail queues (STAILQ) Singly-linked tail queues add the following functionality: -.Pp -.Bl -enum -compact -offset indent -.It +.IP * 3 Entries can be added at the end of a list. -.It +.IP * O(n) removal of any entry in the list. -.It +.IP * They may be concatenated. -.El -.Pp +.PP However: -.Pp -.Bl -enum -compact -offset indent -.It +.IP * 3 All list insertions must specify the head of the list. -.It +.IP * Each head entry requires two pointers rather than one. -.It -Code size is about 15% greater and operations run about 20% slower -than singly-linked lists. -.El -.Pp -Singly-linked tail queues are ideal for applications with large datasets and -few or no removals, +.PP +Singly-linked tail queues are ideal for applications with +large datasets and few or no removals, or for implementing a FIFO queue. -.Pp +.SS Doubly-linked data structures All doubly linked types of data structures (lists and tail queues) additionally allow: -.Pp -.Bl -enum -compact -offset indent -.It +.IP * 3 Insertion of a new entry before any element in the list. -.It +.IP * O(1) removal of any entry in the list. -.El -.Pp +.PP However: -.Pp -.Bl -enum -compact -offset indent -.It +.IP * 3 Each element requires two pointers rather than one. -.It -Code size and execution time of operations (except for removal) is about -twice that of the singly-linked data-structures. -.El -.Pp +.SS Doubly-linked lists (LIST) Linked lists are the simplest of the doubly linked data structures. They add the following functionality over the above: -.Pp -.Bl -enum -compact -offset indent -.It +.IP * 3 They may be traversed backwards. -.El -.Pp +.PP However: -.Pp -.Bl -enum -compact -offset indent -.It +.IP * 3 To traverse backwards, an entry to begin the traversal and the list in which it is contained must be specified. -.El -.Pp +.SS Doubly-linked tail queues (TAILQ) Tail queues add the following functionality: -.Pp -.Bl -enum -compact -offset indent -.It +.IP * 3 Entries can be added at the end of a list. -.It +.IP * They may be traversed backwards, from tail to head. -.It +.IP * They may be concatenated. -.El -.Pp +.PP However: -.Pp -.Bl -enum -compact -offset indent -.It +.IP * 3 All list insertions and removals must specify the head of the list. -.It +.IP * Each head entry requires two pointers rather than one. -.It -Code size is about 15% greater and operations run about 20% slower -than singly-linked lists. -.El -.Pp +.SS Doubly-linked circular queues (CIRCLEQ) Circular queues add the following functionality over the above: -.Pp -.Bl -enum -compact -offset indent -.It +.IP * 3 The first and last entries are connected. -.El -.Pp +.PP However: -.Pp -.Bl -enum -compact -offset indent -.It +.IP * 3 The termination condition for traversal is more complex. -.It -Code size is about 40% greater and operations run about 45% slower than lists. -.El -.Sh EXAMPLES -.Sh CONFORMING TO +.SH CONFORMING TO Not in POSIX.1, POSIX.1-2001 or POSIX.1-2008. Present on the BSDs. -.Nm queue -functions first appeared in -.Bx 4.4 . -.Sh SEE ALSO -.Xr circleq 3 -.Xr insque 3 -.Xr list 3 -.Xr slist 3 -.Xr stailq 3 -.Xr tailq 3 -.\" .Xr tree 3 +.I +macros first appeared in 4.4BSD. +.SH SEE ALSO +.BR circleq (3), +.BR insque (3), +.BR list (3), +.BR slist (3), +.BR stailq (3), +.BR tailq (3) +.\" .BR tree (3)