From owner-freebsd-doc@FreeBSD.ORG  Sun Oct 16 22:00:28 2005
Return-Path: <owner-freebsd-doc@FreeBSD.ORG>
X-Original-To: freebsd-doc@hub.freebsd.org
Delivered-To: freebsd-doc@hub.freebsd.org
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id 746C316A41F
	for <freebsd-doc@hub.freebsd.org>; Sun, 16 Oct 2005 22:00:28 +0000 (GMT)
	(envelope-from gnats@FreeBSD.org)
Received: from freefall.freebsd.org (freefall.freebsd.org [216.136.204.21])
	by mx1.FreeBSD.org (Postfix) with ESMTP id EC34F43D4C
	for <freebsd-doc@hub.freebsd.org>; Sun, 16 Oct 2005 22:00:27 +0000 (GMT)
	(envelope-from gnats@FreeBSD.org)
Received: from freefall.freebsd.org (gnats@localhost [127.0.0.1])
	by freefall.freebsd.org (8.13.3/8.13.3) with ESMTP id j9GM0RCo008699
	for <freebsd-doc@freefall.freebsd.org>; Sun, 16 Oct 2005 22:00:27 GMT
	(envelope-from gnats@freefall.freebsd.org)
Received: (from gnats@localhost)
	by freefall.freebsd.org (8.13.3/8.13.1/Submit) id j9GM0RQK008697;
	Sun, 16 Oct 2005 22:00:27 GMT (envelope-from gnats)
Resent-Date: Sun, 16 Oct 2005 22:00:27 GMT
Resent-Message-Id: <200510162200.j9GM0RQK008697@freefall.freebsd.org>
Resent-From: FreeBSD-gnats-submit@FreeBSD.org (GNATS Filer)
Resent-To: freebsd-doc@FreeBSD.org
Resent-Reply-To: FreeBSD-gnats-submit@FreeBSD.org,
	David Leppik <dleppik@vocalabs.com>
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id 51A2F16A420
	for <freebsd-gnats-submit@FreeBSD.org>;
	Sun, 16 Oct 2005 21:50:16 +0000 (GMT)
	(envelope-from nobody@FreeBSD.org)
Received: from www.freebsd.org (www.freebsd.org [216.136.204.117])
	by mx1.FreeBSD.org (Postfix) with ESMTP id 84E6443D73
	for <freebsd-gnats-submit@FreeBSD.org>;
	Sun, 16 Oct 2005 21:50:12 +0000 (GMT)
	(envelope-from nobody@FreeBSD.org)
Received: from www.freebsd.org (localhost [127.0.0.1])
	by www.freebsd.org (8.13.1/8.13.1) with ESMTP id j9GLoCtm040328
	for <freebsd-gnats-submit@FreeBSD.org>; Sun, 16 Oct 2005 21:50:12 GMT
	(envelope-from nobody@www.freebsd.org)
Received: (from nobody@localhost)
	by www.freebsd.org (8.13.1/8.13.1/Submit) id j9GLoCAt040327;
	Sun, 16 Oct 2005 21:50:12 GMT (envelope-from nobody)
Message-Id: <200510162150.j9GLoCAt040327@www.freebsd.org>
Date: Sun, 16 Oct 2005 21:50:12 GMT
From: David Leppik <dleppik@vocalabs.com>
To: freebsd-gnats-submit@FreeBSD.org
X-Send-Pr-Version: www-2.3
Cc: 
Subject: docs/87548: LIST_*,
	TAILQ_* man pages include memory leak in sample code
X-BeenThere: freebsd-doc@freebsd.org
X-Mailman-Version: 2.1.5
Precedence: list
List-Id: Documentation project <freebsd-doc.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
	<mailto:freebsd-doc-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/freebsd-doc>
List-Post: <mailto:freebsd-doc@freebsd.org>
List-Help: <mailto:freebsd-doc-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
	<mailto:freebsd-doc-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Sun, 16 Oct 2005 22:00:28 -0000


>Number:         87548
>Category:       docs
>Synopsis:       LIST_*, TAILQ_* man pages include memory leak in sample code
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Sun Oct 16 22:00:27 GMT 2005
>Closed-Date:
>Last-Modified:
>Originator:     David Leppik
>Release:        None (old BSD code--see below)
>Organization:
Vocal Laboratories
>Environment:
>Description:
I've seen this on Mac OS X and Linux, so this probably affects FreeBSD as well.

The man page for TAILQ_INSERT, TAILQ_REMOVE, etc. have the following sample code:

while (head.tqh_first != NULL)
             TAILQ_REMOVE(&head, head.tqh_first, entries);

I was so shocked that I checked queue.h and sure enough, TAILQ_REMOVE does not deallocate the queue entry (nor should it.)  The same is true for the other structures mentioned in this man page.
>How-To-Repeat:

>Fix:
I'm just a lowly Java programmer, but I think the fix is:

while (head.tqh_first != NULL) {
             np = head.tqh_first;
             TAILQ_REMOVE(&head, np, entries);
             free(np);
}
>Release-Note:
>Audit-Trail:
>Unformatted: