From owner-freebsd-doc@FreeBSD.ORG Sat Feb 26 06:20:54 2005 Return-Path: Delivered-To: freebsd-doc@freebsd.org Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 76E3A16A4CE; Sat, 26 Feb 2005 06:20:54 +0000 (GMT) Received: from pittgoth.com (14.zlnp1.xdsl.nauticom.net [209.195.149.111]) by mx1.FreeBSD.org (Postfix) with ESMTP id B804143D3F; Sat, 26 Feb 2005 06:20:53 +0000 (GMT) (envelope-from trhodes@FreeBSD.org) Received: from mobile.pittgoth.com (ip68-230-188-82.dc.dc.cox.net [68.230.188.82]) (authenticated bits=0) by pittgoth.com (8.12.10/8.12.10) with ESMTP id j1Q6KlKw071798 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NOT); Sat, 26 Feb 2005 01:20:52 -0500 (EST) (envelope-from trhodes@FreeBSD.org) Date: Sat, 26 Feb 2005 01:20:34 -0500 From: Tom Rhodes To: FreeBSD-gnats-submit@FreeBSD.org, freebsd-doc@FreeBSD.org, Brad Davis Message-ID: <20050226012034.0021ebb4@mobile.pittgoth.com> X-Mailer: Sylpheed-Claws 1.0.0 (GTK+ 1.2.10; i386-portbld-freebsd6.0) Mime-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit Subject: Re: docs/78096: Add info on setting up ATLQ X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.1 Precedence: list List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 26 Feb 2005 06:20:54 -0000 Hi Brad, This is extremely useful and I agree we need it in the docs, but I have some comments on it. --- doc-ori/en_US.ISO8859-1/books/handbook/firewalls/chapter.sgml Fri Feb 25 13:31:41 2005 +++ doc/en_US.ISO8859-1/books/handbook/firewalls/chapter.sgml Fri Feb 25 14:05:54 2005 @@ -198,7 +198,7 @@ - The Packet Filter (PF) Firewall + The Packet Filter (PF) Firewall and ALTQ firewall @@ -211,9 +211,9 @@ contained PF as an integrated part of the base system was &os; 5.3 in November 2004. PF is a complete, fully featured firewall - that contains ALTQ for bandwidth usage - management in a way similar to what DUMMYNET provides in - IPFW. The OpenBSD project does an + that contains ALTQ (Alternate Queuing) for + bandwidth usage management in a way similar to what DUMMYNET + provides in IPFW. The OpenBSD project does an outstanding job of maintaining the PF users' guide that it will not be made part of this handbook firewall section as that would just be duplicated effort. Good, here is where we introduce what ALTQ stands for. Now, I may be out of context, but what does it do? :) @@ -356,6 +356,61 @@ enable the following option as well: gateway_enable="YES" # Enable as Lan gateway + + + + Enabling ALTQ + + ALTQ is only avaliable by compiling the options into the + &os; Kernel. + + ALTQ is not supported by all of the avaliable network card + drivers. Please see the &man.altq.4; manual page for a list of + drivers that are supported in your release of &os;. Missing , tags here. These two can probably be merged together, something like: While ALTQ is a useful option ... explain why ... it is not yet supported by all network interface card drivers. Please see the &man.altq.4; manual page for an up to date list on supported drivers. To gain ALTQ support, the following options must be compiled into the kernel: Then list the kernel options, like you do here: + + options ALTQ +options ALTQ_CBQ # Class Bases Queuing +options ALTQ_RED # Random Early Detection +options ALTQ_RIO # RED In/Out +options ALTQ_HFSC # Hierarchical Packet Scheduler +options ALTQ_PRIQ # Priority Queuing +options ALTQ_NOPCC # Required for SMP build + + options ALTQ enables the ALTQ framework. + + options ALTQ_CBQ enables Class Based + Queuing (CBQ). CBQ allows you to divide a connections's + bandwidth into different classes or queues. + + options ALTQ_RED enables Random Early + Detection (RED). RED is used to avoid network congestion. RED + does this by measuring the length of the queue and comparing + it to the minimum and maximum thresholds for the queue. If the + queue is over the maximum all new packets will be dropped. True + to its name, RED drops packets from different connections + randomly. + + options ALTQ_RIO enables Random Early + Detection In and Out. + + options ALTQ_HFSC enables Hierarchical + Fair Service Curve Packet Scheduler. See + for more info. + + options ALTQ_PRIQ enables Priority + Queuing (PRIQ). PRIQ will always pass traffic that is in a + higher queue first. + + options ALTQ_NOPCC enables SMP support + for ALTQ. This option is required on SMP systems. This will give you better content in a single section in place of scattered information. And don't forget the other comment in the PR trail. :) -- Tom Rhodes