From: adrian <> Date: Wed, 25 Apr 2007 17:30:14 +0000 (+0000) Subject: Amos Jeffries' tidyup of the debugging sections. X-Git-Tag: SQUID_3_0_PRE6~39 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=507d0a782a0c612d6f33b9bc5c49e4a7bd3dcbe3;p=thirdparty%2Fsquid.git Amos Jeffries' tidyup of the debugging sections. --- diff --git a/doc/debug-sections.txt b/doc/debug-sections.txt index a7d44c5643..09de809458 100644 --- a/doc/debug-sections.txt +++ b/doc/debug-sections.txt @@ -1,13 +1,27 @@ + + * DEBUG: +none +none Common Removal Policy +none ETag parsing support +none FDE +none Generate squid.conf.default and cf_parser.h +none Linked list functions (deprecated) +none LRU Removal Policy +none Memory Allocation +none Refcount allocator section 0 Announcement Server -section 0 CGI Cache Manager section 0 Client Database section 0 Debug Routines section 0 DNS Resolver -section 0 WWW Client +section 0 Hash Tables +section 0 UFS Store Dump +section -- External DISKD process implementation. +section 1 Main Loop section 1 Startup and Main Loop section 2 Unlink Daemon section 3 Configuration File Parsing section 4 Error Generation +section 5 Comms section 5 Socket Functions section 6 Disk I/O Routines section 7 Multicast @@ -24,40 +38,58 @@ section 17 Request Forwarding section 18 Cache Manager Statistics section 19 Store Memory Primitives section 20 Storage Manager +section 20 Storage Manager Heap-based replacement +section 20 Storage Manager Logging Functions +section 20 Storage Manager MD5 Cache Keys +section 20 Storage Manager Swapfile Metadata +section 20 Storage Manager Swapfile Unpacker +section 20 Storage Manager Swapin Functions +section 20 Storage Manager Swapout Functions +section 20 Store Rebuild Routines +section 20 Swap Dir base object +section 21 Integer functions section 21 Misc Functions +section 21 Time Functions section 22 Refresh Calculation section 23 URL Parsing -section 24 WAIS Relay +section 23 URL Scheme parsing section 25 MIME Parsing section 26 Secure Sockets Layer Proxy section 27 Cache Announcer section 28 Access Control section 29 Authenticator +section 29 Negotiate Authenticator +section 29 NTLM Authenticator section 30 Ident (RFC 931) section 31 Hypertext Caching Protocol section 32 Asynchronous Disk I/O section 33 Client-side Routines section 34 Dnsserver interface section 35 FQDN Cache -section 36 Cache Directory Cleanup section 37 ICMP Routines section 38 Network Measurement Database section 39 Cache Array Routing Protocol -section 40 User-Agent and Referer logging +section 40 Referer Logging +section 40 User-Agent Logging section 41 Event Processing section 42 ICMP Pinger program section 43 AIOPS +section 43 Windows AIOPS section 44 Peer Selection Algorithm section 45 Callback Data Registry section 46 Access Log +section 47 Store COSS Directory Routines section 47 Store Directory Routines section 48 Persistent Connections -section 49 SNMP +section 49 SNMP Interface +section 49 SNMP support section 50 Log file handling section 51 Filedescriptor Functions section 52 URN Parsing section 53 AS Number handling +section 53 Radix Tree data structure implementation section 54 Interprocess Communication +section 54 Windows Interprocess Communication section 55 HTTP Header section 56 HTTP Message Body section 57 HTTP Status-line @@ -66,7 +98,7 @@ section 59 auto-growing Memory Buffer with printf section 60 Packer: A uniform interface to store-like modules section 61 Redirector section 62 Generic Histogram -section 63 - +section 63 Low Level Memory Pool Management section 64 HTTP Range Header section 65 HTTP Cache Control Header section 66 HTTP Header Tools @@ -81,18 +113,25 @@ section 74 HTTP Message section 75 WHOIS protocol section 76 Internal Squid Object handling section 77 Delay Pools -section 78 DNS lookups -section 79 Lowlevel store I/O -section 80 WCCP -section 81 Cache Store +section 78 DNS lookups; interacts with lib/rfc1035.c +section 79 Disk IO Routines +section 79 Squid-side DISKD I/O functions. +section 79 Squid-side Disk I/O functions. +section 79 Storage Manager COSS Interface +section 79 Storage Manager UFS Interface +section 80 WCCP Support +section 81 aio_xxx() POSIX emulation on Windows +section 81 CPU Profiling Routines +section 81 Store HEAP Removal Policies section 82 External ACL section 83 SSL accelerator support section 84 Helper process maintenance -section 85 Client side request management - after parsing, before caching +section 85 Client-side Request Routines section 86 ESI processing -section 87 client side stream management -section 88 Client side reply management - from store to stream -section 89 NAT / IP Interception -section 90 Store Client -section 91 Http Surrogate-Control Header -section 92 Store File System +section 87 Client-side Stream routines. +section 88 Client-side Reply Routines +section 89 NAT / IP Interception +section 90 HTTP Cache Control Header +section 90 Storage Manager Client-Side Interface +section 92 Storage File System +section 93 ICAP (RFC 3507) Client diff --git a/doc/mk-debugs.sh b/doc/mk-debugs.sh index c4f05995d6..5fda9e8b3c 100644 --- a/doc/mk-debugs.sh +++ b/doc/mk-debugs.sh @@ -1,4 +1,5 @@ -cat ../src/*.c \ - | grep DEBUG: \ +cat ../{src,lib,include}/*{.,/*.,/*/*.,/*/*/*.}{c,cc,h} 2>/dev/null \ + | grep " DEBUG:" \ | sed -e 's/ \* DEBUG: //' \ + | sort -u \ | sort -n +1 diff --git a/include/RefCount.h b/include/RefCount.h index 5ccf56c6ae..dd92597c55 100644 --- a/include/RefCount.h +++ b/include/RefCount.h @@ -1,8 +1,8 @@ /* - * $Id: RefCount.h,v 1.10 2007/04/06 04:40:58 rousskov Exp $ + * $Id: RefCount.h,v 1.11 2007/04/25 11:30:15 adrian Exp $ * - * DEBUG: section xx Refcount allocator + * DEBUG: none Refcount allocator * AUTHOR: Robert Collins * * SQUID Web Proxy Cache http://www.squid-cache.org/ diff --git a/lib/Profiler.c b/lib/Profiler.c index 56ab1c1093..0f0cb4a9f9 100644 --- a/lib/Profiler.c +++ b/lib/Profiler.c @@ -1,8 +1,8 @@ /* - * $Id: Profiler.c,v 1.6 2006/11/22 06:07:16 adrian Exp $ + * $Id: Profiler.c,v 1.7 2007/04/25 11:30:16 adrian Exp $ * - * DEBUG: section 81 CPU Profiling Routines + * DEBUG: section 81 CPU Profiling Routines * AUTHOR: Andres Kroonmaa, Sep.2000 * * SQUID Internet Object Cache http://squid.nlanr.net/Squid/ diff --git a/lib/radix.c b/lib/radix.c index 9f60802654..4fc5edf086 100644 --- a/lib/radix.c +++ b/lib/radix.c @@ -1,7 +1,7 @@ /* - * $Id: radix.c,v 1.22 2004/12/21 17:28:28 robertc Exp $ + * $Id: radix.c,v 1.23 2007/04/25 11:30:16 adrian Exp $ * - * DEBUG: section 53 Radix tree data structure implementation + * DEBUG: section 53 Radix Tree data structure implementation * AUTHOR: NetBSD Derived * * SQUID Web Proxy Cache http://www.squid-cache.org/ diff --git a/src/ACLChecklist.cci b/src/ACLChecklist.cci index 088836a810..2e8651a810 100644 --- a/src/ACLChecklist.cci +++ b/src/ACLChecklist.cci @@ -1,7 +1,7 @@ /* - * $Id: ACLChecklist.cci,v 1.3 2003/07/06 21:50:55 hno Exp $ + * $Id: ACLChecklist.cci,v 1.4 2007/04/25 11:30:18 adrian Exp $ * - * DEBUG: none + * DEBUG: section 28 Access Control * AUTHOR: Henrik Nordstrom * * SQUID Web Proxy Cache http://www.squid-cache.org/ diff --git a/src/AuthScheme.cc b/src/AuthScheme.cc index e6cf0ff451..4afede9299 100644 --- a/src/AuthScheme.cc +++ b/src/AuthScheme.cc @@ -1,8 +1,8 @@ /* - * $Id: AuthScheme.cc,v 1.1 2004/08/30 03:28:56 robertc Exp $ + * $Id: AuthScheme.cc,v 1.2 2007/04/25 11:30:18 adrian Exp $ * - * DEBUG: section 29 Authenticator + * DEBUG: section 29 Authenticator * AUTHOR: Robert Collins * * SQUID Web Proxy Cache http://www.squid-cache.org/ diff --git a/src/CommRead.h b/src/CommRead.h index 26eb71e0ed..25202e80d6 100644 --- a/src/CommRead.h +++ b/src/CommRead.h @@ -1,8 +1,8 @@ /* - * $Id: CommRead.h,v 1.7 2006/08/07 02:28:22 robertc Exp $ + * $Id: CommRead.h,v 1.8 2007/04/25 11:30:18 adrian Exp $ * - * DEBUG: section 5 Comms + * DEBUG: section 5 Comms * AUTHOR: Robert Collins * * SQUID Web Proxy Cache http://www.squid-cache.org/ diff --git a/src/ConfigOption.cc b/src/ConfigOption.cc index d9578eb3ab..37634ee2c7 100644 --- a/src/ConfigOption.cc +++ b/src/ConfigOption.cc @@ -1,8 +1,8 @@ /* - * $Id: ConfigOption.cc,v 1.1 2004/12/20 16:30:32 robertc Exp $ + * $Id: ConfigOption.cc,v 1.2 2007/04/25 11:30:18 adrian Exp $ * - * DEBUG: section ?? Swap Dir base object + * DEBUG: section 3 Configuration File Parsing * AUTHOR: Robert Collins * * SQUID Web Proxy Cache http://www.squid-cache.org/ diff --git a/src/ICAP/ICAPModXact.cc b/src/ICAP/ICAPModXact.cc index a2566b4ae0..343d265834 100644 --- a/src/ICAP/ICAPModXact.cc +++ b/src/ICAP/ICAPModXact.cc @@ -1,5 +1,5 @@ /* - * DEBUG: section 93 ICAP (RFC 3507) Client + * DEBUG: section 93 ICAP (RFC 3507) Client */ #include "squid.h" diff --git a/src/ICAP/ICAPOptXact.cc b/src/ICAP/ICAPOptXact.cc index 2353c41043..de5b8da3c2 100644 --- a/src/ICAP/ICAPOptXact.cc +++ b/src/ICAP/ICAPOptXact.cc @@ -1,5 +1,5 @@ /* - * DEBUG: section 93 ICAP (RFC 3507) Client + * DEBUG: section 93 ICAP (RFC 3507) Client */ #include "squid.h" diff --git a/src/ICAP/ICAPServiceRep.cc b/src/ICAP/ICAPServiceRep.cc index ab38ba94d4..a748ff9250 100644 --- a/src/ICAP/ICAPServiceRep.cc +++ b/src/ICAP/ICAPServiceRep.cc @@ -1,5 +1,5 @@ /* - * DEBUG: section 93 ICAP (RFC 3507) Client + * DEBUG: section 93 ICAP (RFC 3507) Client */ #include "squid.h" diff --git a/src/ICAP/ICAPXaction.cc b/src/ICAP/ICAPXaction.cc index bc2e260238..4c523f6bc2 100644 --- a/src/ICAP/ICAPXaction.cc +++ b/src/ICAP/ICAPXaction.cc @@ -1,5 +1,5 @@ /* - * DEBUG: section 93 ICAP (RFC 3507) Client + * DEBUG: section 93 ICAP (RFC 3507) Client */ #include "squid.h" diff --git a/src/ProfStats.cc b/src/ProfStats.cc index fbe21510d0..1bd47da4d9 100644 --- a/src/ProfStats.cc +++ b/src/ProfStats.cc @@ -1,8 +1,8 @@ /* - * $Id: ProfStats.cc,v 1.9 2006/11/22 08:07:10 adrian Exp $ + * $Id: ProfStats.cc,v 1.10 2007/04/25 11:30:18 adrian Exp $ * - * DEBUG: section 81 CPU Profiling Routines + * DEBUG: section 81 CPU Profiling Routines * AUTHOR: Andres Kroonmaa * * SQUID Internet Object Cache http://squid.nlanr.net/Squid/ diff --git a/src/RemovalPolicy.cc b/src/RemovalPolicy.cc index f3fe3b576c..77e37511d6 100644 --- a/src/RemovalPolicy.cc +++ b/src/RemovalPolicy.cc @@ -1,8 +1,8 @@ /* - * $Id: RemovalPolicy.cc,v 1.1 2006/08/21 00:50:41 robertc Exp $ + * $Id: RemovalPolicy.cc,v 1.2 2007/04/25 11:30:18 adrian Exp $ * - * DEBUG: section ? Common Removal policy + * DEBUG: none Common Removal Policy * AUTHOR: Robert Collins * * SQUID Web Proxy Cache http://www.squid-cache.org/ diff --git a/src/SquidNew.cc b/src/SquidNew.cc index f724435333..db55bd4572 100644 --- a/src/SquidNew.cc +++ b/src/SquidNew.cc @@ -1,8 +1,8 @@ /* - * $Id: SquidNew.cc,v 1.1 2003/07/07 22:44:28 robertc Exp $ + * $Id: SquidNew.cc,v 1.2 2007/04/25 11:30:18 adrian Exp $ * - * DEBUG: section ??? Memory Allocation + * DEBUG: none Memory Allocation * AUTHOR: Robert Collins * * SQUID Web Proxy Cache http://www.squid-cache.org/ diff --git a/src/StoreIOState.cc b/src/StoreIOState.cc index 80cae2e15c..5c2cd14bcf 100644 --- a/src/StoreIOState.cc +++ b/src/StoreIOState.cc @@ -1,8 +1,8 @@ /* - * $Id: StoreIOState.cc,v 1.5 2006/05/22 19:58:51 wessels Exp $ + * $Id: StoreIOState.cc,v 1.6 2007/04/25 11:30:18 adrian Exp $ * - * DEBUG: section ?? Swap Dir base object + * DEBUG: section 20 Swap Dir base object * AUTHOR: Robert Collins * * SQUID Web Proxy Cache http://www.squid-cache.org/ diff --git a/src/SwapDir.cc b/src/SwapDir.cc index 9587116a51..0f2c8c07fe 100644 --- a/src/SwapDir.cc +++ b/src/SwapDir.cc @@ -1,8 +1,8 @@ /* - * $Id: SwapDir.cc,v 1.8 2007/04/16 22:10:49 hno Exp $ + * $Id: SwapDir.cc,v 1.9 2007/04/25 11:30:18 adrian Exp $ * - * DEBUG: section ?? Swap Dir base object + * DEBUG: section 20 Swap Dir base object * AUTHOR: Robert Collins * * SQUID Web Proxy Cache http://www.squid-cache.org/ diff --git a/src/comm_epoll.cc b/src/comm_epoll.cc index 26c0fcf296..1663030f4c 100644 --- a/src/comm_epoll.cc +++ b/src/comm_epoll.cc @@ -1,8 +1,8 @@ /* - * $Id: comm_epoll.cc,v 1.13 2006/09/03 04:09:36 hno Exp $ + * $Id: comm_epoll.cc,v 1.14 2007/04/25 11:30:18 adrian Exp $ * - * DEBUG: section 5 Socket functions + * DEBUG: section 5 Socket Functions * * SQUID Web Proxy Cache http://www.squid-cache.org/ * ---------------------------------------------------------- diff --git a/src/comm_kqueue.cc b/src/comm_kqueue.cc index 37f18bf546..b44e0f1cae 100644 --- a/src/comm_kqueue.cc +++ b/src/comm_kqueue.cc @@ -1,8 +1,8 @@ /* - * $Id: comm_kqueue.cc,v 1.13 2006/11/22 06:08:32 adrian Exp $ + * $Id: comm_kqueue.cc,v 1.14 2007/04/25 11:30:18 adrian Exp $ * - * DEBUG: section 5 Socket functions + * DEBUG: section 5 Socket Functions * * SQUID Web Proxy Cache http://www.squid-cache.org/ * ---------------------------------------------------------- diff --git a/src/fde.cc b/src/fde.cc index 4e74cd8e11..64f5fcb8bd 100644 --- a/src/fde.cc +++ b/src/fde.cc @@ -1,8 +1,8 @@ /* - * $Id: fde.cc,v 1.5 2006/09/02 13:41:32 serassio Exp $ + * $Id: fde.cc,v 1.6 2007/04/25 11:30:18 adrian Exp $ * - * DEBUG: section ?? FDE + * DEBUG: none FDE * AUTHOR: Robert Collins * * SQUID Web Proxy Cache http://www.squid-cache.org/ diff --git a/src/list.cc b/src/list.cc index aa005fc1f7..c2683a1b6d 100644 --- a/src/list.cc +++ b/src/list.cc @@ -1,8 +1,8 @@ /* - * $Id: list.cc,v 1.1 2005/01/03 16:08:26 robertc Exp $ + * $Id: list.cc,v 1.2 2007/04/25 11:30:18 adrian Exp $ * - * DEBUG: section ?? Linked list functions + * DEBUG: none Linked list functions (deprecated) * AUTHOR: Harvest Derived * * SQUID Web Proxy Cache http://www.squid-cache.org/ diff --git a/src/referer.cc b/src/referer.cc index a04bac5f1b..83bd40ce74 100644 --- a/src/referer.cc +++ b/src/referer.cc @@ -1,8 +1,8 @@ /* - * $Id: referer.cc,v 1.7 2003/02/21 22:50:10 robertc Exp $ + * $Id: referer.cc,v 1.8 2007/04/25 11:30:18 adrian Exp $ * - * DEBUG: section 40 User-Agent and Referer logging + * DEBUG: section 40 Referer Logging * AUTHOR: Joe Ramey (useragent) * Jens-S. Vöckler (mod 4 referer) * diff --git a/src/repl/heap/store_repl_heap.cc b/src/repl/heap/store_repl_heap.cc index 5a9dbedad9..f686bcabd5 100644 --- a/src/repl/heap/store_repl_heap.cc +++ b/src/repl/heap/store_repl_heap.cc @@ -1,8 +1,8 @@ /* - * $Id: store_repl_heap.cc,v 1.22 2007/04/21 07:14:19 wessels Exp $ + * $Id: store_repl_heap.cc,v 1.23 2007/04/25 11:30:19 adrian Exp $ * - * DEBUG: section ? HEAP based removal policies + * DEBUG: section 81 Store HEAP Removal Policies * AUTHOR: Henrik Nordstrom * * Based on the ideas of the heap policy implemented by John Dilley of diff --git a/src/repl/lru/store_repl_lru.cc b/src/repl/lru/store_repl_lru.cc index d20291a601..853eb58bc6 100644 --- a/src/repl/lru/store_repl_lru.cc +++ b/src/repl/lru/store_repl_lru.cc @@ -1,8 +1,8 @@ /* - * $Id: store_repl_lru.cc,v 1.21 2007/04/21 07:14:19 wessels Exp $ + * $Id: store_repl_lru.cc,v 1.22 2007/04/25 11:30:19 adrian Exp $ * - * DEBUG: section ? LRU Removal policy + * DEBUG: none LRU Removal Policy * AUTHOR: Henrik Nordstrom * * SQUID Web Proxy Cache http://www.squid-cache.org/ diff --git a/src/snmp_agent.cc b/src/snmp_agent.cc index 788f52e047..538e731f83 100644 --- a/src/snmp_agent.cc +++ b/src/snmp_agent.cc @@ -1,8 +1,8 @@ /* - * $Id: snmp_agent.cc,v 1.94 2006/11/09 16:35:32 hno Exp $ + * $Id: snmp_agent.cc,v 1.95 2007/04/25 11:30:18 adrian Exp $ * - * DEBUG: section 49 SNMP Interface + * DEBUG: section 49 SNMP Interface * AUTHOR: Kostas Anagnostakis * * SQUID Web Proxy Cache http://www.squid-cache.org/ diff --git a/src/tests/testStoreSupport.cc b/src/tests/testStoreSupport.cc index a51350cfe6..fa58e43e1e 100644 --- a/src/tests/testStoreSupport.cc +++ b/src/tests/testStoreSupport.cc @@ -1,6 +1,6 @@ /* - * DEBUG: + * DEBUG: none * AUTHOR: Robert Collins * * SQUID Web Proxy Cache http://www.squid-cache.org/ diff --git a/src/tests/testStoreSupport.h b/src/tests/testStoreSupport.h index 13c0c374e3..e8d89f4f91 100644 --- a/src/tests/testStoreSupport.h +++ b/src/tests/testStoreSupport.h @@ -1,6 +1,6 @@ /* - * DEBUG: + * DEBUG: none * AUTHOR: Robert Collins * * SQUID Web Proxy Cache http://www.squid-cache.org/ diff --git a/src/useragent.cc b/src/useragent.cc index 00394ccffb..66cf7f0e90 100644 --- a/src/useragent.cc +++ b/src/useragent.cc @@ -1,8 +1,8 @@ /* - * $Id: useragent.cc,v 1.29 2006/05/09 15:47:45 wessels Exp $ + * $Id: useragent.cc,v 1.30 2007/04/25 11:30:18 adrian Exp $ * - * DEBUG: section 40 User-Agent logging + * DEBUG: section 40 User-Agent Logging * AUTHOR: Joe Ramey * * SQUID Web Proxy Cache http://www.squid-cache.org/