This patch is generated from the cleanup branch of HEAD in squid3 Tue Apr 8 00:14:17 2008 GMT See http://devel.squid-cache.org/ Index: squid3/NOTES diff -u /dev/null squid3/NOTES:1.1.2.2 --- /dev/null Thu Jan 1 01:00:00 1970 +++ squid3/NOTES Mon Mar 3 17:23:10 2008 @@ -0,0 +1,39 @@ + +TODO List for the cleanup branch operations. + +* Add automatic testing for header dependency + DONE- script to perform universal include unit-test for .h files + UNDERWAY - link to automatic unit-testing in each directory + UNDERWAY - fix all resulting compile errors! + +* Fix .h generation of: cf_gen_defines.h, cf_parser.h + +* Fix Broken Unit-test for COSS + + stub time| COSS block-size = 512 bytes + stub time| COSS largest file offset = -1 KB + stub time| COSS cache_dir size = 102400 KB + stub time| Fatal: COSS cache_dir size exceeds largest offset + .FAIL: tests/testCoss + ================================================= + 1 of 16 tests failed + + +* Obsolete typedefs.h + - remove all unneeded typedefs + - move all needed typedefs to their appropriate headers + - fix all resulting compile errors + +* Obsolete protos.h + - move all protos to their appropriate header files + - add includes for headers where needed. + +* Obsolete structs.h + - move all structs to their appropriate header files + - move modular configuration in to *Config.h files + (discussion on exactly what the modules are) + +* Auto-doc the API for modules decided above + +* Move files into appropriate sub-dirs based on modules + Index: squid3/doc/rfc/1-index.txt diff -u squid3/doc/rfc/1-index.txt:1.14 squid3/doc/rfc/1-index.txt:1.14.4.1 --- squid3/doc/rfc/1-index.txt:1.14 Mon Nov 12 15:51:27 2007 +++ squid3/doc/rfc/1-index.txt Tue Feb 26 19:19:57 2008 @@ -53,6 +53,11 @@ rfc2187.txt Internet Cache Protocol (ICP), version 2 +rfc2181.txt + Clarifications to the DNS Specification + Squid uses a number of constants from the DNS and Host specifications + (RFC 1035, RFC 1123) this defines details on their correct usage. + rfc2227.txt Simple Hit-Metering and Usage-Limiting for HTTP Index: squid3/doc/rfc/rfc2181.txt diff -u /dev/null squid3/doc/rfc/rfc2181.txt:1.1.2.1 --- /dev/null Thu Jan 1 01:00:00 1970 +++ squid3/doc/rfc/rfc2181.txt Tue Feb 26 19:19:57 2008 @@ -0,0 +1,842 @@ + + + + + + +Network Working Group R. Elz +Request for Comments: 2181 University of Melbourne +Updates: 1034, 1035, 1123 R. Bush +Category: Standards Track RGnet, Inc. + July 1997 + + + Clarifications to the DNS Specification + +Status of this Memo + + This document specifies an Internet standards track protocol for the + Internet community, and requests discussion and suggestions for + improvements. Please refer to the current edition of the "Internet + Official Protocol Standards" (STD 1) for the standardization state + and status of this protocol. Distribution of this memo is unlimited. + +1. Abstract + + This document considers some areas that have been identified as + problems with the specification of the Domain Name System, and + proposes remedies for the defects identified. Eight separate issues + are considered: + + + IP packet header address usage from multi-homed servers, + + TTLs in sets of records with the same name, class, and type, + + correct handling of zone cuts, + + three minor issues concerning SOA records and their use, + + the precise definition of the Time to Live (TTL) + + Use of the TC (truncated) header bit + + the issue of what is an authoritative, or canonical, name, + + and the issue of what makes a valid DNS label. + + The first six of these are areas where the correct behaviour has been + somewhat unclear, we seek to rectify that. The other two are already + adequately specified, however the specifications seem to be sometimes + ignored. We seek to reinforce the existing specifications. + + + + + + + + + + + + + + +Elz & Bush Standards Track [Page 1] + +RFC 2181 Clarifications to the DNS Specification July 1997 + + + + +Contents + + 1 Abstract ................................................... 1 + 2 Introduction ............................................... 2 + 3 Terminology ................................................ 3 + 4 Server Reply Source Address Selection ...................... 3 + 5 Resource Record Sets ....................................... 4 + 6 Zone Cuts .................................................. 8 + 7 SOA RRs .................................................... 10 + 8 Time to Live (TTL) ......................................... 10 + 9 The TC (truncated) header bit .............................. 11 + 10 Naming issues .............................................. 11 + 11 Name syntax ................................................ 13 + 12 Security Considerations .................................... 14 + 13 References ................................................. 14 + 14 Acknowledgements ........................................... 15 + 15 Authors' Addresses ......................................... 15 + + + + +2. Introduction + + Several problem areas in the Domain Name System specification + [RFC1034, RFC1035] have been noted through the years [RFC1123]. This + document addresses several additional problem areas. The issues here + are independent. Those issues are the question of which source + address a multi-homed DNS server should use when replying to a query, + the issue of differing TTLs for DNS records with the same label, + class and type, and the issue of canonical names, what they are, how + CNAME records relate, what names are legal in what parts of the DNS, + and what is the valid syntax of a DNS name. + + Clarifications to the DNS specification to avoid these problems are + made in this memo. A minor ambiguity in RFC1034 concerned with SOA + records is also corrected, as is one in the definition of the TTL + (Time To Live) and some possible confusion in use of the TC bit. + + + + + + + + + + + + +Elz & Bush Standards Track [Page 2] + +RFC 2181 Clarifications to the DNS Specification July 1997 + + +3. Terminology + + This memo does not use the oft used expressions MUST, SHOULD, MAY, or + their negative forms. In some sections it may seem that a + specification is worded mildly, and hence some may infer that the + specification is optional. That is not correct. Anywhere that this + memo suggests that some action should be carried out, or must be + carried out, or that some behaviour is acceptable, or not, that is to + be considered as a fundamental aspect of this specification, + regardless of the specific words used. If some behaviour or action + is truly optional, that will be clearly specified by the text. + +4. Server Reply Source Address Selection + + Most, if not all, DNS clients, expect the address from which a reply + is received to be the same address as that to which the query + eliciting the reply was sent. This is true for servers acting as + clients for the purposes of recursive query resolution, as well as + simple resolver clients. The address, along with the identifier (ID) + in the reply is used for disambiguating replies, and filtering + spurious responses. This may, or may not, have been intended when + the DNS was designed, but is now a fact of life. + + Some multi-homed hosts running DNS servers generate a reply using a + source address that is not the same as the destination address from + the client's request packet. Such replies will be discarded by the + client because the source address of the reply does not match that of + a host to which the client sent the original request. That is, it + appears to be an unsolicited response. + +4.1. UDP Source Address Selection + + To avoid these problems, servers when responding to queries using UDP + must cause the reply to be sent with the source address field in the + IP header set to the address that was in the destination address + field of the IP header of the packet containing the query causing the + response. If this would cause the response to be sent from an IP + address that is not permitted for this purpose, then the response may + be sent from any legal IP address allocated to the server. That + address should be chosen to maximise the possibility that the client + will be able to use it for further queries. Servers configured in + such a way that not all their addresses are equally reachable from + all potential clients need take particular care when responding to + queries sent to anycast, multicast, or similar, addresses. + + + + + + + +Elz & Bush Standards Track [Page 3] + +RFC 2181 Clarifications to the DNS Specification July 1997 + + +4.2. Port Number Selection + + Replies to all queries must be directed to the port from which they + were sent. When queries are received via TCP this is an inherent + part of the transport protocol. For queries received by UDP the + server must take note of the source port and use that as the + destination port in the response. Replies should always be sent from + the port to which they were directed. Except in extraordinary + circumstances, this will be the well known port assigned for DNS + queries [RFC1700]. + +5. Resource Record Sets + + Each DNS Resource Record (RR) has a label, class, type, and data. It + is meaningless for two records to ever have label, class, type and + data all equal - servers should suppress such duplicates if + encountered. It is however possible for most record types to exist + with the same label, class and type, but with different data. Such a + group of records is hereby defined to be a Resource Record Set + (RRSet). + +5.1. Sending RRs from an RRSet + + A query for a specific (or non-specific) label, class, and type, will + always return all records in the associated RRSet - whether that be + one or more RRs. The response must be marked as "truncated" if the + entire RRSet will not fit in the response. + +5.2. TTLs of RRs in an RRSet + + Resource Records also have a time to live (TTL). It is possible for + the RRs in an RRSet to have different TTLs. No uses for this have + been found that cannot be better accomplished in other ways. This + can, however, cause partial replies (not marked "truncated") from a + caching server, where the TTLs for some but not all the RRs in the + RRSet have expired. + + Consequently the use of differing TTLs in an RRSet is hereby + deprecated, the TTLs of all RRs in an RRSet must be the same. + + Should a client receive a response containing RRs from an RRSet with + differing TTLs, it should treat this as an error. If the RRSet + concerned is from a non-authoritative source for this data, the + client should simply ignore the RRSet, and if the values were + required, seek to acquire them from an authoritative source. Clients + that are configured to send all queries to one, or more, particular + servers should treat those servers as authoritative for this purpose. + Should an authoritative source send such a malformed RRSet, the + + + +Elz & Bush Standards Track [Page 4] + +RFC 2181 Clarifications to the DNS Specification July 1997 + + + client should treat the RRs for all purposes as if all TTLs in the + RRSet had been set to the value of the lowest TTL in the RRSet. In + no case may a server send an RRSet with TTLs not all equal. + +5.3. DNSSEC Special Cases + + Two of the record types added by DNS Security (DNSSEC) [RFC2065] + require special attention when considering the formation of Resource + Record Sets. Those are the SIG and NXT records. It should be noted + that DNS Security is still very new, and there is, as yet, little + experience with it. Readers should be prepared for the information + related to DNSSEC contained in this document to become outdated as + the DNS Security specification matures. + +5.3.1. SIG records and RRSets + + A SIG record provides signature (validation) data for another RRSet + in the DNS. Where a zone has been signed, every RRSet in the zone + will have had a SIG record associated with it. The data type of the + RRSet is included in the data of the SIG RR, to indicate with which + particular RRSet this SIG record is associated. Were the rules above + applied, whenever a SIG record was included with a response to + validate that response, the SIG records for all other RRSets + associated with the appropriate node would also need to be included. + In some cases, this could be a very large number of records, not + helped by their being rather large RRs. + + Thus, it is specifically permitted for the authority section to + contain only those SIG RRs with the "type covered" field equal to the + type field of an answer being returned. However, where SIG records + are being returned in the answer section, in response to a query for + SIG records, or a query for all records associated with a name + (type=ANY) the entire SIG RRSet must be included, as for any other RR + type. + + Servers that receive responses containing SIG records in the + authority section, or (probably incorrectly) as additional data, must + understand that the entire RRSet has almost certainly not been + included. Thus, they must not cache that SIG record in a way that + would permit it to be returned should a query for SIG records be + received at that server. RFC2065 actually requires that SIG queries + be directed only to authoritative servers to avoid the problems that + could be caused here, and while servers exist that do not understand + the special properties of SIG records, this will remain necessary. + However, careful design of SIG record processing in new + implementations should permit this restriction to be relaxed in the + future, so resolvers do not need to treat SIG record queries + specially. + + + +Elz & Bush Standards Track [Page 5] + +RFC 2181 Clarifications to the DNS Specification July 1997 + + + It has been occasionally stated that a received request for a SIG + record should be forwarded to an authoritative server, rather than + being answered from data in the cache. This is not necessary - a + server that has the knowledge of SIG as a special case for processing + this way would be better to correctly cache SIG records, taking into + account their characteristics. Then the server can determine when it + is safe to reply from the cache, and when the answer is not available + and the query must be forwarded. + +5.3.2. NXT RRs + + Next Resource Records (NXT) are even more peculiar. There will only + ever be one NXT record in a zone for a particular label, so + superficially, the RRSet problem is trivial. However, at a zone cut, + both the parent zone, and the child zone (superzone and subzone in + RFC2065 terminology) will have NXT records for the same name. Those + two NXT records do not form an RRSet, even where both zones are + housed at the same server. NXT RRSets always contain just a single + RR. Where both NXT records are visible, two RRSets exist. However, + servers are not required to treat this as a special case when + receiving NXT records in a response. They may elect to notice the + existence of two different NXT RRSets, and treat that as they would + two different RRSets of any other type. That is, cache one, and + ignore the other. Security aware servers will need to correctly + process the NXT record in the received response though. + +5.4. Receiving RRSets + + Servers must never merge RRs from a response with RRs in their cache + to form an RRSet. If a response contains data that would form an + RRSet with data in a server's cache the server must either ignore the + RRs in the response, or discard the entire RRSet currently in the + cache, as appropriate. Consequently the issue of TTLs varying + between the cache and a response does not cause concern, one will be + ignored. That is, one of the data sets is always incorrect if the + data from an answer differs from the data in the cache. The + challenge for the server is to determine which of the data sets is + correct, if one is, and retain that, while ignoring the other. Note + that if a server receives an answer containing an RRSet that is + identical to that in its cache, with the possible exception of the + TTL value, it may, optionally, update the TTL in its cache with the + TTL of the received answer. It should do this if the received answer + would be considered more authoritative (as discussed in the next + section) than the previously cached answer. + + + + + + + +Elz & Bush Standards Track [Page 6] + +RFC 2181 Clarifications to the DNS Specification July 1997 + + +5.4.1. Ranking data + + When considering whether to accept an RRSet in a reply, or retain an + RRSet already in its cache instead, a server should consider the + relative likely trustworthiness of the various data. An + authoritative answer from a reply should replace cached data that had + been obtained from additional information in an earlier reply. + However additional information from a reply will be ignored if the + cache contains data from an authoritative answer or a zone file. + + The accuracy of data available is assumed from its source. + Trustworthiness shall be, in order from most to least: + + + Data from a primary zone file, other than glue data, + + Data from a zone transfer, other than glue, + + The authoritative data included in the answer section of an + authoritative reply. + + Data from the authority section of an authoritative answer, + + Glue from a primary zone, or glue from a zone transfer, + + Data from the answer section of a non-authoritative answer, and + non-authoritative data from the answer section of authoritative + answers, + + Additional information from an authoritative answer, + Data from the authority section of a non-authoritative answer, + Additional information from non-authoritative answers. + + Note that the answer section of an authoritative answer normally + contains only authoritative data. However when the name sought is an + alias (see section 10.1.1) only the record describing that alias is + necessarily authoritative. Clients should assume that other records + may have come from the server's cache. Where authoritative answers + are required, the client should query again, using the canonical name + associated with the alias. + + Unauthenticated RRs received and cached from the least trustworthy of + those groupings, that is data from the additional data section, and + data from the authority section of a non-authoritative answer, should + not be cached in such a way that they would ever be returned as + answers to a received query. They may be returned as additional + information where appropriate. Ignoring this would allow the + trustworthiness of relatively untrustworthy data to be increased + without cause or excuse. + + When DNS security [RFC2065] is in use, and an authenticated reply has + been received and verified, the data thus authenticated shall be + considered more trustworthy than unauthenticated data of the same + type. Note that throughout this document, "authoritative" means a + reply with the AA bit set. DNSSEC uses trusted chains of SIG and KEY + + + +Elz & Bush Standards Track [Page 7] + +RFC 2181 Clarifications to the DNS Specification July 1997 + + + records to determine the authenticity of data, the AA bit is almost + irrelevant. However DNSSEC aware servers must still correctly set + the AA bit in responses to enable correct operation with servers that + are not security aware (almost all currently). + + Note that, glue excluded, it is impossible for data from two + correctly configured primary zone files, two correctly configured + secondary zones (data from zone transfers) or data from correctly + configured primary and secondary zones to ever conflict. Where glue + for the same name exists in multiple zones, and differs in value, the + nameserver should select data from a primary zone file in preference + to secondary, but otherwise may choose any single set of such data. + Choosing that which appears to come from a source nearer the + authoritative data source may make sense where that can be + determined. Choosing primary data over secondary allows the source + of incorrect glue data to be discovered more readily, when a problem + with such data exists. Where a server can detect from two zone files + that one or more are incorrectly configured, so as to create + conflicts, it should refuse to load the zones determined to be + erroneous, and issue suitable diagnostics. + + "Glue" above includes any record in a zone file that is not properly + part of that zone, including nameserver records of delegated sub- + zones (NS records), address records that accompany those NS records + (A, AAAA, etc), and any other stray data that might appear. + +5.5. Sending RRSets (reprise) + + A Resource Record Set should only be included once in any DNS reply. + It may occur in any of the Answer, Authority, or Additional + Information sections, as required. However it should not be repeated + in the same, or any other, section, except where explicitly required + by a specification. For example, an AXFR response requires the SOA + record (always an RRSet containing a single RR) be both the first and + last record of the reply. Where duplicates are required this way, + the TTL transmitted in each case must be the same. + +6. Zone Cuts + + The DNS tree is divided into "zones", which are collections of + domains that are treated as a unit for certain management purposes. + Zones are delimited by "zone cuts". Each zone cut separates a + "child" zone (below the cut) from a "parent" zone (above the cut). + The domain name that appears at the top of a zone (just below the cut + that separates the zone from its parent) is called the zone's + "origin". The name of the zone is the same as the name of the domain + at the zone's origin. Each zone comprises that subset of the DNS + tree that is at or below the zone's origin, and that is above the + + + +Elz & Bush Standards Track [Page 8] + +RFC 2181 Clarifications to the DNS Specification July 1997 + + + cuts that separate the zone from its children (if any). The + existence of a zone cut is indicated in the parent zone by the + existence of NS records specifying the origin of the child zone. A + child zone does not contain any explicit reference to its parent. + +6.1. Zone authority + + The authoritative servers for a zone are enumerated in the NS records + for the origin of the zone, which, along with a Start of Authority + (SOA) record are the mandatory records in every zone. Such a server + is authoritative for all resource records in a zone that are not in + another zone. The NS records that indicate a zone cut are the + property of the child zone created, as are any other records for the + origin of that child zone, or any sub-domains of it. A server for a + zone should not return authoritative answers for queries related to + names in another zone, which includes the NS, and perhaps A, records + at a zone cut, unless it also happens to be a server for the other + zone. + + Other than the DNSSEC cases mentioned immediately below, servers + should ignore data other than NS records, and necessary A records to + locate the servers listed in the NS records, that may happen to be + configured in a zone at a zone cut. + +6.2. DNSSEC issues + + The DNS security mechanisms [RFC2065] complicate this somewhat, as + some of the new resource record types added are very unusual when + compared with other DNS RRs. In particular the NXT ("next") RR type + contains information about which names exist in a zone, and hence + which do not, and thus must necessarily relate to the zone in which + it exists. The same domain name may have different NXT records in + the parent zone and the child zone, and both are valid, and are not + an RRSet. See also section 5.3.2. + + Since NXT records are intended to be automatically generated, rather + than configured by DNS operators, servers may, but are not required + to, retain all differing NXT records they receive regardless of the + rules in section 5.4. + + For a secure parent zone to securely indicate that a subzone is + insecure, DNSSEC requires that a KEY RR indicating that the subzone + is insecure, and the parent zone's authenticating SIG RR(s) be + present in the parent zone, as they by definition cannot be in the + subzone. Where a subzone is secure, the KEY and SIG records will be + present, and authoritative, in that zone, but should also always be + present in the parent zone (if secure). + + + + +Elz & Bush Standards Track [Page 9] + +RFC 2181 Clarifications to the DNS Specification July 1997 + + + Note that in none of these cases should a server for the parent zone, + not also being a server for the subzone, set the AA bit in any + response for a label at a zone cut. + +7. SOA RRs + + Three minor issues concerning the Start of Zone of Authority (SOA) + Resource Record need some clarification. + +7.1. Placement of SOA RRs in authoritative answers + + RFC1034, in section 3.7, indicates that the authority section of an + authoritative answer may contain the SOA record for the zone from + which the answer was obtained. When discussing negative caching, + RFC1034 section 4.3.4 refers to this technique but mentions the + additional section of the response. The former is correct, as is + implied by the example shown in section 6.2.5 of RFC1034. SOA + records, if added, are to be placed in the authority section. + +7.2. TTLs on SOA RRs + + It may be observed that in section 3.2.1 of RFC1035, which defines + the format of a Resource Record, that the definition of the TTL field + contains a throw away line which states that the TTL of an SOA record + should always be sent as zero to prevent caching. This is mentioned + nowhere else, and has not generally been implemented. + Implementations should not assume that SOA records will have a TTL of + zero, nor are they required to send SOA records with a TTL of zero. + +7.3. The SOA.MNAME field + + It is quite clear in the specifications, yet seems to have been + widely ignored, that the MNAME field of the SOA record should contain + the name of the primary (master) server for the zone identified by + the SOA. It should not contain the name of the zone itself. That + information would be useless, as to discover it, one needs to start + with the domain name of the SOA record - that is the name of the + zone. + +8. Time to Live (TTL) + + The definition of values appropriate to the TTL field in STD 13 is + not as clear as it could be, with respect to how many significant + bits exist, and whether the value is signed or unsigned. It is + hereby specified that a TTL value is an unsigned number, with a + minimum value of 0, and a maximum value of 2147483647. That is, a + maximum of 2^31 - 1. When transmitted, this value shall be encoded + in the less significant 31 bits of the 32 bit TTL field, with the + + + +Elz & Bush Standards Track [Page 10] + +RFC 2181 Clarifications to the DNS Specification July 1997 + + + most significant, or sign, bit set to zero. + + Implementations should treat TTL values received with the most + significant bit set as if the entire value received was zero. + + Implementations are always free to place an upper bound on any TTL + received, and treat any larger values as if they were that upper + bound. The TTL specifies a maximum time to live, not a mandatory + time to live. + +9. The TC (truncated) header bit + + The TC bit should be set in responses only when an RRSet is required + as a part of the response, but could not be included in its entirety. + The TC bit should not be set merely because some extra information + could have been included, but there was insufficient room. This + includes the results of additional section processing. In such cases + the entire RRSet that will not fit in the response should be omitted, + and the reply sent as is, with the TC bit clear. If the recipient of + the reply needs the omitted data, it can construct a query for that + data and send that separately. + + Where TC is set, the partial RRSet that would not completely fit may + be left in the response. When a DNS client receives a reply with TC + set, it should ignore that response, and query again, using a + mechanism, such as a TCP connection, that will permit larger replies. + +10. Naming issues + + It has sometimes been inferred from some sections of the DNS + specification [RFC1034, RFC1035] that a host, or perhaps an interface + of a host, is permitted exactly one authoritative, or official, name, + called the canonical name. There is no such requirement in the DNS. + +10.1. CNAME resource records + + The DNS CNAME ("canonical name") record exists to provide the + canonical name associated with an alias name. There may be only one + such canonical name for any one alias. That name should generally be + a name that exists elsewhere in the DNS, though there are some rare + applications for aliases with the accompanying canonical name + undefined in the DNS. An alias name (label of a CNAME record) may, + if DNSSEC is in use, have SIG, NXT, and KEY RRs, but may have no + other data. That is, for any label in the DNS (any domain name) + exactly one of the following is true: + + + + + + +Elz & Bush Standards Track [Page 11] + +RFC 2181 Clarifications to the DNS Specification July 1997 + + + + one CNAME record exists, optionally accompanied by SIG, NXT, and + KEY RRs, + + one or more records exist, none being CNAME records, + + the name exists, but has no associated RRs of any type, + + the name does not exist at all. + +10.1.1. CNAME terminology + + It has been traditional to refer to the label of a CNAME record as "a + CNAME". This is unfortunate, as "CNAME" is an abbreviation of + "canonical name", and the label of a CNAME record is most certainly + not a canonical name. It is, however, an entrenched usage. Care + must therefore be taken to be very clear whether the label, or the + value (the canonical name) of a CNAME resource record is intended. + In this document, the label of a CNAME resource record will always be + referred to as an alias. + +10.2. PTR records + + Confusion about canonical names has lead to a belief that a PTR + record should have exactly one RR in its RRSet. This is incorrect, + the relevant section of RFC1034 (section 3.6.2) indicates that the + value of a PTR record should be a canonical name. That is, it should + not be an alias. There is no implication in that section that only + one PTR record is permitted for a name. No such restriction should + be inferred. + + Note that while the value of a PTR record must not be an alias, there + is no requirement that the process of resolving a PTR record not + encounter any aliases. The label that is being looked up for a PTR + value might have a CNAME record. That is, it might be an alias. The + value of that CNAME RR, if not another alias, which it should not be, + will give the location where the PTR record is found. That record + gives the result of the PTR type lookup. This final result, the + value of the PTR RR, is the label which must not be an alias. + +10.3. MX and NS records + + The domain name used as the value of a NS resource record, or part of + the value of a MX resource record must not be an alias. Not only is + the specification clear on this point, but using an alias in either + of these positions neither works as well as might be hoped, nor well + fulfills the ambition that may have led to this approach. This + domain name must have as its value one or more address records. + Currently those will be A records, however in the future other record + types giving addressing information may be acceptable. It can also + have other RRs, but never a CNAME RR. + + + + +Elz & Bush Standards Track [Page 12] + +RFC 2181 Clarifications to the DNS Specification July 1997 + + + Searching for either NS or MX records causes "additional section + processing" in which address records associated with the value of the + record sought are appended to the answer. This helps avoid needless + extra queries that are easily anticipated when the first was made. + + Additional section processing does not include CNAME records, let + alone the address records that may be associated with the canonical + name derived from the alias. Thus, if an alias is used as the value + of an NS or MX record, no address will be returned with the NS or MX + value. This can cause extra queries, and extra network burden, on + every query. It is trivial for the DNS administrator to avoid this + by resolving the alias and placing the canonical name directly in the + affected record just once when it is updated or installed. In some + particular hard cases the lack of the additional section address + records in the results of a NS lookup can cause the request to fail. + +11. Name syntax + + Occasionally it is assumed that the Domain Name System serves only + the purpose of mapping Internet host names to data, and mapping + Internet addresses to host names. This is not correct, the DNS is a + general (if somewhat limited) hierarchical database, and can store + almost any kind of data, for almost any purpose. + + The DNS itself places only one restriction on the particular labels + that can be used to identify resource records. That one restriction + relates to the length of the label and the full name. The length of + any one label is limited to between 1 and 63 octets. A full domain + name is limited to 255 octets (including the separators). The zero + length full name is defined as representing the root of the DNS tree, + and is typically written and displayed as ".". Those restrictions + aside, any binary string whatever can be used as the label of any + resource record. Similarly, any binary string can serve as the value + of any record that includes a domain name as some or all of its value + (SOA, NS, MX, PTR, CNAME, and any others that may be added). + Implementations of the DNS protocols must not place any restrictions + on the labels that can be used. In particular, DNS servers must not + refuse to serve a zone because it contains labels that might not be + acceptable to some DNS client programs. A DNS server may be + configurable to issue warnings when loading, or even to refuse to + load, a primary zone containing labels that might be considered + questionable, however this should not happen by default. + + Note however, that the various applications that make use of DNS data + can have restrictions imposed on what particular values are + acceptable in their environment. For example, that any binary label + can have an MX record does not imply that any binary name can be used + as the host part of an e-mail address. Clients of the DNS can impose + + + +Elz & Bush Standards Track [Page 13] + +RFC 2181 Clarifications to the DNS Specification July 1997 + + + whatever restrictions are appropriate to their circumstances on the + values they use as keys for DNS lookup requests, and on the values + returned by the DNS. If the client has such restrictions, it is + solely responsible for validating the data from the DNS to ensure + that it conforms before it makes any use of that data. + + See also [RFC1123] section 6.1.3.5. + +12. Security Considerations + + This document does not consider security. + + In particular, nothing in section 4 is any way related to, or useful + for, any security related purposes. + + Section 5.4.1 is also not related to security. Security of DNS data + will be obtained by the Secure DNS [RFC2065], which is mostly + orthogonal to this memo. + + It is not believed that anything in this document adds to any + security issues that may exist with the DNS, nor does it do anything + to that will necessarily lessen them. Correct implementation of the + clarifications in this document might play some small part in + limiting the spread of non-malicious bad data in the DNS, but only + DNSSEC can help with deliberate attempts to subvert DNS data. + +13. References + + [RFC1034] Mockapetris, P., "Domain Names - Concepts and Facilities", + STD 13, RFC 1034, November 1987. + + [RFC1035] Mockapetris, P., "Domain Names - Implementation and + Specification", STD 13, RFC 1035, November 1987. + + [RFC1123] Braden, R., "Requirements for Internet Hosts - application + and support", STD 3, RFC 1123, January 1989. + + [RFC1700] Reynolds, J., Postel, J., "Assigned Numbers", + STD 2, RFC 1700, October 1994. + + [RFC2065] Eastlake, D., Kaufman, C., "Domain Name System Security + Extensions", RFC 2065, January 1997. + + + + + + + + + +Elz & Bush Standards Track [Page 14] + +RFC 2181 Clarifications to the DNS Specification July 1997 + + +14. Acknowledgements + + This memo arose from discussions in the DNSIND working group of the + IETF in 1995 and 1996, the members of that working group are largely + responsible for the ideas captured herein. Particular thanks to + Donald E. Eastlake, 3rd, and Olafur Gudmundsson, for help with the + DNSSEC issues in this document, and to John Gilmore for pointing out + where the clarifications were not necessarily clarifying. Bob Halley + suggested clarifying the placement of SOA records in authoritative + answers, and provided the references. Michael Patton, as usual, and + Mark Andrews, Alan Barrett and Stan Barber provided much assistance + with many details. Josh Littlefield helped make sure that the + clarifications didn't cause problems in some irritating corner cases. + +15. Authors' Addresses + + Robert Elz + Computer Science + University of Melbourne + Parkville, Victoria, 3052 + Australia. + + EMail: kre@munnari.OZ.AU + + + Randy Bush + RGnet, Inc. + 5147 Crystal Springs Drive NE + Bainbridge Island, Washington, 98110 + United States. + + EMail: randy@psg.com + + + + + + + + + + + + + + + + + + + +Elz & Bush Standards Track [Page 15] Index: squid3/helpers/ntlm_auth/fakeauth/fakeauth_auth.c diff -u squid3/helpers/ntlm_auth/fakeauth/fakeauth_auth.c:1.9 squid3/helpers/ntlm_auth/fakeauth/fakeauth_auth.c:1.9.10.2 --- squid3/helpers/ntlm_auth/fakeauth/fakeauth_auth.c:1.9 Wed Jul 18 20:50:52 2007 +++ squid3/helpers/ntlm_auth/fakeauth/fakeauth_auth.c Sun Mar 2 14:23:25 2008 @@ -369,6 +369,7 @@ main(int argc, char *argv[]) { char buf[BUFFER_SIZE]; + int buflen = 0; char user[256], *p, *decoded = NULL; struct ntlm_challenge chal; struct ntlm_negotiate *nego; @@ -390,9 +391,10 @@ if ((p = strchr(buf, '\n')) != NULL) *p = '\0'; /* strip \n */ - if (strlen(buf) > 3) + buflen = strlen(buf); /* keep this so we only scan the buffer for \0 once per loop */ + if (buflen > 3) decoded = base64_decode(buf + 3); - if ((strlen(buf) > 3) && NTLM_packet_debug_enabled) { + if (buflen > 3 && NTLM_packet_debug_enabled) { strncpy(helper_command, buf, 2); helper_command[2] = '\0'; debug("Got '%s' from Squid with data:\n", helper_command); @@ -401,7 +403,7 @@ debug("Got '%s' from Squid\n", buf); if (strncasecmp(buf, "YR", 2) == 0) { - if (strlen(buf) > 3) { + if(buflen > 3) { nego = (struct ntlm_negotiate *) decoded; ntlmMakeChallenge(&chal, nego->flags); } else Index: squid3/include/Array.h diff -u squid3/include/Array.h:1.15 squid3/include/Array.h:1.15.4.1 --- squid3/include/Array.h:1.15 Mon Nov 26 05:51:14 2007 +++ squid3/include/Array.h Mon Mar 3 19:43:16 2008 @@ -30,17 +30,19 @@ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA. * */ - #ifndef SQUID_ARRAY_H #define SQUID_ARRAY_H +/** + \todo CLEANUP: this file should be called Vector.h at least, and probably be replaced by STL Vector + */ + #include "fatal.h" #include "util.h" /* iterator support */ template - class VectorIteratorBase { @@ -72,7 +74,6 @@ }; template - class Vector { Index: squid3/include/GNUregex.h diff -u squid3/include/GNUregex.h:1.2 squid3/include/GNUregex.h:1.2.52.2 --- squid3/include/GNUregex.h:1.2 Sun Aug 3 19:12:46 2003 +++ squid3/include/GNUregex.h Sun Mar 2 03:26:57 2008 @@ -1,10 +1,11 @@ /* * $Id$ */ - #ifndef SQUID_REGEXP_LIBRARY_H #define SQUID_REGEXP_LIBRARY_H +#include "config.h" + /* Definitions for data structures and routines for the regular * expression library, version 0.12. * Index: squid3/include/IPAddress.h diff -u squid3/include/IPAddress.h:1.4 squid3/include/IPAddress.h:1.4.2.1 --- squid3/include/IPAddress.h:1.4 Tue Feb 5 14:51:15 2008 +++ squid3/include/IPAddress.h Tue Feb 19 02:27:14 2008 @@ -35,10 +35,15 @@ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA. * */ - #ifndef _INC_IPADDRESS_H #define _INC_IPADDRESS_H +#include "getaddrinfo.h" +#include "getnameinfo.h" +#include "inet_ntop.h" +#include "inet_pton.h" + + #if HAVE_SYS_SOCKET_H #include #endif @@ -56,14 +61,9 @@ #include #endif - #include #include -#include "getaddrinfo.h" -#include "getnameinfo.h" -#include "inet_ntop.h" -#include "inet_pton.h" /* FreeBSD hack: * This OS has at least one version that defines these as private @@ -402,6 +402,7 @@ #endif }; + inline std::ostream & operator << (std::ostream &os, const IPAddress &ipa) { Index: squid3/include/List.h diff -u squid3/include/List.h:1.8 squid3/include/List.h:1.7.38.4 --- squid3/include/List.h:1.8 Tue Feb 26 13:50:50 2008 +++ squid3/include/List.h Tue Feb 26 20:28:57 2008 @@ -1,4 +1,3 @@ - /* * $Id$ * @@ -34,7 +33,8 @@ #ifndef SQUID_LIST_H #define SQUID_LIST_H -#include "cbdata.h" +/** \todo FUBAR: cbdata.h is over in src/ */ +#include "../src/cbdata.h" /// \ingroup POD template Index: squid3/include/MemPool.h diff -u squid3/include/MemPool.h:1.15 squid3/include/MemPool.h:1.14.2.2 --- squid3/include/MemPool.h:1.15 Tue Feb 26 13:50:50 2008 +++ squid3/include/MemPool.h Sun Mar 2 03:26:57 2008 @@ -1,4 +1,3 @@ - #ifndef _MEM_POOLS_H_ #define _MEM_POOLS_H_ Index: squid3/include/SquidNew.h diff -u squid3/include/SquidNew.h:1.1 squid3/include/SquidNew.h:1.1.56.1 --- squid3/include/SquidNew.h:1.1 Mon Jul 7 19:12:38 2003 +++ squid3/include/SquidNew.h Tue Feb 19 14:36:23 2008 @@ -30,10 +30,11 @@ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA. * */ - #ifndef SQUID_NEW_H #define SQUID_NEW_H +#include "util.h" + /* Any code using libstdc++ must have externally resolvable overloads * for void * operator new - which means in the .o for the binary, * or in a shared library. static libs don't propogate the symbol @@ -41,6 +42,7 @@ * for the extern version in squid */ #include + _SQUID_EXTERNNEW_ void *operator new(size_t size) throw (std::bad_alloc) { return xmalloc(size); @@ -57,4 +59,5 @@ { xfree (address); } + #endif /* SQUID_NEW_H */ Index: squid3/include/asn1.h diff -u squid3/include/asn1.h:1.1 squid3/include/asn1.h:1.1.74.2 --- squid3/include/asn1.h:1.1 Sun Oct 13 17:18:18 2002 +++ squid3/include/asn1.h Tue Feb 19 04:18:54 2008 @@ -1,6 +1,8 @@ #ifndef SQUID_SNMP_ASN1_H #define SQUID_SNMP_ASN1_H +#include "config.h" + /* * Definitions for Abstract Syntax Notation One, ASN.1 * As defined in ISO/IS 8824 and ISO/IS 8825 @@ -33,7 +35,7 @@ **********************************************************************/ #ifndef EIGHTBIT_SUBIDS -typedef u_int oid; +typedef u_int8_t oid; #define MAX_SUBID 0xFFFFFFFF #else typedef u_char oid; Index: squid3/include/cache_snmp.h diff -u squid3/include/cache_snmp.h:1.4 squid3/include/cache_snmp.h:1.4.4.2 --- squid3/include/cache_snmp.h:1.4 Fri Dec 14 15:50:56 2007 +++ squid3/include/cache_snmp.h Sun Mar 2 03:26:57 2008 @@ -1,7 +1,6 @@ /* * $Id$ */ - #ifndef SQUID_CACHE_SNMP_H #define SQUID_CACHE_SNMP_H @@ -19,7 +18,9 @@ #include "snmp.h" #include "snmp_impl.h" +#if 0 #include "asn1.h" +#endif #include "snmp_api.h" #include "snmp_vars.h" Index: squid3/include/getfullhostname.h diff -u /dev/null squid3/include/getfullhostname.h:1.1.2.1 --- /dev/null Thu Jan 1 01:00:00 1970 +++ squid3/include/getfullhostname.h Tue Feb 26 19:21:33 2008 @@ -0,0 +1,11 @@ +/* + * $Id$ + */ +#ifndef _SQUID_GETFULLHOSTNAME_H +#define _SQUID_GETFULLHOSTNAME_H + +#include "config.h" + +SQUIDCEXTERN const char *getfullhostname(void); + +#endif /* _SQUID_GETFULLHOSTNAME_H */ Index: squid3/include/hash.h diff -u squid3/include/hash.h:1.2 squid3/include/hash.h:1.2.72.2 --- squid3/include/hash.h:1.2 Tue Oct 15 02:27:20 2002 +++ squid3/include/hash.h Sun Mar 2 03:26:57 2008 @@ -1,10 +1,11 @@ /* * $Id$ */ - #ifndef SQUID_HASH_H #define SQUID_HASH_H +#include "config.h" + typedef void HASHFREE(void *); typedef int HASHCMP(const void *, const void *); typedef unsigned int HASHHASH(const void *, unsigned int); Index: squid3/include/heap.h diff -u squid3/include/heap.h:1.1 squid3/include/heap.h:1.1.74.1 --- squid3/include/heap.h:1.1 Sun Oct 13 17:18:18 2002 +++ squid3/include/heap.h Tue Feb 19 02:27:14 2008 @@ -40,10 +40,12 @@ * the top of the heap (as in the smallest object key value). Child nodes * are larger than their parent. ****************************************************************************/ - #ifndef SQUID_HEAP_H #define SQUID_HEAP_H +/* Squid autoconf definitions */ +#include "config.h" + /* * Function for generating heap keys. The first argument will typically be * a dws_md_p passed in as a void *. Should find a way to get type safety Index: squid3/include/inet_ntop.h diff -u squid3/include/inet_ntop.h:1.2 squid3/include/inet_ntop.h:1.2.12.1 --- squid3/include/inet_ntop.h:1.2 Thu Dec 13 21:50:52 2007 +++ squid3/include/inet_ntop.h Tue Feb 19 02:27:14 2008 @@ -1,6 +1,8 @@ #ifndef _INC_INET_NTOP_H #define _INC_INET_NTOP_H +#include "config.h" + #if HAVE_INET_NTOP /* Use the system provided version where possible */ Index: squid3/include/inet_pton.h diff -u squid3/include/inet_pton.h:1.2 squid3/include/inet_pton.h:1.2.12.1 --- squid3/include/inet_pton.h:1.2 Thu Dec 13 21:50:52 2007 +++ squid3/include/inet_pton.h Tue Feb 19 02:27:14 2008 @@ -1,6 +1,8 @@ #ifndef _INC_INET_PTON_H #define _INC_INET_PTON_H +#include "config.h" + #if HAVE_INET_PTON /* Use the system provided version where possible */ Index: squid3/include/initgroups.h diff -u squid3/include/initgroups.h:1.2 squid3/include/initgroups.h:1.2.50.1 --- squid3/include/initgroups.h:1.2 Sat Nov 6 19:13:13 2004 +++ squid3/include/initgroups.h Tue Feb 19 02:27:14 2008 @@ -4,6 +4,8 @@ #ifndef SQUID_INITGROUPS_H #define SQUID_INITGROUPS_H +#include "config.h" + /* if you have configure you can use this */ #if defined(HAVE_CONFIG_H) #include "config.h" @@ -14,4 +16,5 @@ #endif SQUIDCEXTERN int initgroups(const char *user, gid_t group); + #endif /* SQUID_INITGROPS_H */ Index: squid3/include/md5.h diff -u squid3/include/md5.h:1.6 squid3/include/md5.h:1.6.4.1 --- squid3/include/md5.h:1.6 Thu Nov 29 20:51:21 2007 +++ squid3/include/md5.h Tue Feb 19 04:18:54 2008 @@ -1,6 +1,8 @@ #ifndef SQUID_MD5_H #define SQUID_MD5_H +#include "config.h" + /* * This is the header file for the MD5 message-digest algorithm. * The algorithm is due to Ron Rivest. This code was Index: squid3/include/memMeter.h diff -u squid3/include/memMeter.h:1.3 squid3/include/memMeter.h:1.3.42.1 --- squid3/include/memMeter.h:1.3 Wed Sep 14 19:12:42 2005 +++ squid3/include/memMeter.h Tue Feb 19 04:18:54 2008 @@ -1,7 +1,11 @@ - +/* + * $Id$ + */ #ifndef _MEM_METER_H_ #define _MEM_METER_H_ +#include "config.h" + /* object to track per-action memory usage (e.g. #idle objects) */ class MemMeter { public: Index: squid3/include/parse.h diff -u squid3/include/parse.h:1.1 squid3/include/parse.h:1.1.74.1 --- squid3/include/parse.h:1.1 Sun Oct 13 17:18:18 2002 +++ squid3/include/parse.h Tue Feb 19 04:18:54 2008 @@ -1,7 +1,6 @@ /* * $Id$ */ - #ifndef SQUID_PARSE_H #define SQUID_PARSE_H @@ -26,11 +25,12 @@ ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************/ -/* - * parse.h - */ -/* +/* NP: we only need struct variable_list and typedef oid from SNMP library */ +/* we use as ptrs. If this was true C++ we could pre-define their classes. */ +#include "snmp_vars.h" + +/** * A linked list of tag-value pairs for enumerated integers. */ struct enum_list { @@ -39,7 +39,7 @@ char *label; }; -/* +/** * A tree in the format of the tree structure of the MIB. */ struct snmp_mib_tree { @@ -63,7 +63,7 @@ #define TYPE_COUNTER 6 #define TYPE_GAUGE 7 #define TYPE_TIMETICKS 8 -#define TYPE_OPAQUE 9 +#define TYPE_OPAQUE 9 #define TYPE_NULL 10 #ifdef __cplusplus Index: squid3/include/radix.h diff -u squid3/include/radix.h:1.4 squid3/include/radix.h:1.4.52.1 --- squid3/include/radix.h:1.4 Mon Oct 20 19:12:44 2003 +++ squid3/include/radix.h Tue Feb 19 04:45:45 2008 @@ -1,10 +1,11 @@ /* * $Id$ */ - #ifndef SQUID_RADIX_H #define SQUID_RADIX_H +#include "config.h" + /* * Copyright (c) 1988, 1989, 1993 * The Regents of the University of California. All rights reserved. Index: squid3/include/rfc1035.h diff -u squid3/include/rfc1035.h:1.10 squid3/include/rfc1035.h:1.10.4.1 --- squid3/include/rfc1035.h:1.10 Thu Jan 10 19:50:54 2008 +++ squid3/include/rfc1035.h Tue Feb 26 19:19:57 2008 @@ -30,11 +30,11 @@ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA. * */ - #ifndef SQUID_RFC1035_H #define SQUID_RFC1035_H #include "config.h" + #if HAVE_SYS_TYPES_H #include #endif @@ -45,8 +45,19 @@ #include #endif -/* rfc1035 - DNS */ -#define RFC1035_MAXHOSTNAMESZ 256 +#include "rfc2181.h" + +/** + \par RFC 1035 Section 3.1: + * To simplify implementations, the total length of a domain name (i.e., + * label octets and label length octets) is restricted to 255 octets or + * less. + *\par + * Clarified by RFC 2181 Section 11. (RFC2181_MAXHOSTNAMELEN) + */ +#define RFC1035_MAXHOSTNAMESZ RFC2181_MAXHOSTNAMELEN + + typedef struct _rfc1035_rr rfc1035_rr; struct _rfc1035_rr { char name[RFC1035_MAXHOSTNAMESZ]; @@ -56,12 +67,14 @@ unsigned short rdlength; char *rdata; }; + typedef struct _rfc1035_query rfc1035_query; struct _rfc1035_query { char name[RFC1035_MAXHOSTNAMESZ]; unsigned short qtype; unsigned short qclass; }; + typedef struct _rfc1035_message rfc1035_message; struct _rfc1035_message { unsigned short id; Index: squid3/include/rfc2181.h diff -u /dev/null squid3/include/rfc2181.h:1.1.2.1 --- /dev/null Thu Jan 1 01:00:00 1970 +++ squid3/include/rfc2181.h Tue Feb 26 19:21:33 2008 @@ -0,0 +1,27 @@ +/* + * $Id$ + */ +#ifndef _SQUID_INCLUDE_RFC1123_H +#define _SQUID_INCLUDE_RFC1123_H + +/** + \par RFC 2181 section 11: + * A full domain name is limited to 255 octets (including the separators). + * + \par RFC 1123 section 2.1: + * Host software MUST handle host names of up to 63 characters and + * SHOULD handle host names of up to 255 characters. + * + *\par + * Also Ref: RFC 1035 Section 3.1 (RFC1035_MAXHOSTNAMESZ) + * + \par + * Squid accepts up to 255 character Hostname and Fully-Qualified Domain Names. + * Squid still NULL-terminates its FQDN and hotsname strings. + */ +#define RFC2181_MAXHOSTNAMELEN 256 + + /// Back-port macro for old squid code still using SQUIDHOSTNAMELEN without RFC reference. +#define SQUIDHOSTNAMELEN RFC2181_MAXHOSTNAMELEN + +#endif /* _SQUID_INCLUDE_RFC1123_H */ Index: squid3/include/rfc2617.h diff -u squid3/include/rfc2617.h:1.1 squid3/include/rfc2617.h:1.1.74.1 --- squid3/include/rfc2617.h:1.1 Sun Oct 13 17:18:18 2002 +++ squid3/include/rfc2617.h Tue Feb 19 04:45:45 2008 @@ -46,10 +46,11 @@ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA. * */ - #ifndef SQUID_RFC2617_H #define SQUID_RFC2617_H +#include "config.h" + #define HASHLEN 16 typedef char HASH[HASHLEN]; #define HASHHEXLEN 32 Index: squid3/include/snmp.h diff -u squid3/include/snmp.h:1.1 squid3/include/snmp.h:1.1.74.1 --- squid3/include/snmp.h:1.1 Sun Oct 13 17:18:18 2002 +++ squid3/include/snmp.h Tue Feb 19 04:18:54 2008 @@ -39,7 +39,9 @@ #endif /* These come first */ +#if 0 #include "asn1.h" +#endif #include "snmp_error.h" #if 0 #include "mibii.h" Index: squid3/include/snmp_api_util.h diff -u squid3/include/snmp_api_util.h:1.1 squid3/include/snmp_api_util.h:1.1.74.1 --- squid3/include/snmp_api_util.h:1.1 Sun Oct 13 17:18:18 2002 +++ squid3/include/snmp_api_util.h Tue Feb 19 04:45:45 2008 @@ -1,10 +1,12 @@ /* * $Id$ */ - #ifndef SQUID_SNMP_API_UTIL_H #define SQUID_SNMP_API_UTIL_H +/* NP: required for typedef ipaddr and indirect config.h */ +#include "snmp_pdu.h" + /*********************************************************** Copyright 1997 by Carnegie Mellon University Index: squid3/include/snmp_debug.h diff -u squid3/include/snmp_debug.h:1.1 squid3/include/snmp_debug.h:1.1.74.1 --- squid3/include/snmp_debug.h:1.1 Sun Oct 13 17:18:18 2002 +++ squid3/include/snmp_debug.h Tue Feb 19 13:54:28 2008 @@ -1,23 +1,15 @@ /* * $Id$ */ - #ifndef SQUID_SNMP_DEBUG_H #define SQUID_SNMP_DEBUG_H -#ifdef __cplusplus -extern "C" { -#endif +#include "config.h" #if STDC_HEADERS -extern void -snmplib_debug(int, const char *,...) PRINTF_FORMAT_ARG2; +SQUIDCEXTERN void snmplib_debug(int, const char *,...) PRINTF_FORMAT_ARG2; #else -extern void snmplib_debug (va_alist); -#endif - -#ifdef __cplusplus -}; +SQUIDCEXTERN void snmplib_debug(va_alist); #endif #endif /* SQUID_SNMP_DEBUG_H */ Index: squid3/include/snmp_impl.h diff -u squid3/include/snmp_impl.h:1.1 squid3/include/snmp_impl.h:1.1.74.1 --- squid3/include/snmp_impl.h:1.1 Sun Oct 13 17:18:18 2002 +++ squid3/include/snmp_impl.h Tue Feb 19 13:54:28 2008 @@ -1,10 +1,11 @@ /* * $Id$ */ - #ifndef SQUID_SNMP_IMPL_H #define SQUID_SNMP_IMPL_H +#include "asn1.h" + /* * Definitions for SNMP (RFC 1067) implementation. * @@ -46,6 +47,8 @@ #define SID_MAX_LEN 64 +#if 0 /* defines performed globally by config.h */ + #ifndef NULL #define NULL 0 #endif @@ -56,6 +59,7 @@ #ifndef FALSE #define FALSE 0 #endif +#endif /* dead code. */ #define READ 1 #define WRITE 0 Index: squid3/include/snmp_msg.h diff -u squid3/include/snmp_msg.h:1.1 squid3/include/snmp_msg.h:1.1.74.1 --- squid3/include/snmp_msg.h:1.1 Sun Oct 13 17:18:18 2002 +++ squid3/include/snmp_msg.h Tue Feb 19 13:54:28 2008 @@ -2,6 +2,8 @@ #ifndef SQUID_SNMP_MSG_H #define SQUID_SNMP_MSG_H +#include "config.h" + /********************************************************************** * * Copyright 1997 by Carnegie Mellon University @@ -37,10 +39,8 @@ extern "C" { #endif - u_char *snmp_msg_Encode(u_char *, int *, u_char *, - int, int, struct snmp_pdu *); - u_char *snmp_msg_Decode(u_char *, int *, u_char *, - int *, int *, struct snmp_pdu *); +u_char *snmp_msg_Encode(u_char *, int *, u_char *, int, int, struct snmp_pdu *); +u_char *snmp_msg_Decode(u_char *, int *, u_char *, int *, int *, struct snmp_pdu *); #ifdef __cplusplus } Index: squid3/include/snmp_pdu.h diff -u squid3/include/snmp_pdu.h:1.1 squid3/include/snmp_pdu.h:1.1.74.1 --- squid3/include/snmp_pdu.h:1.1 Sun Oct 13 17:18:18 2002 +++ squid3/include/snmp_pdu.h Tue Feb 19 04:45:45 2008 @@ -1,6 +1,15 @@ #ifndef SQUID_SNMP_PDU_H #define SQUID_SNMP_PDU_H +#include "config.h" +/* required for oid typedef */ +#include "asn1.h" + +#if HAVE_NETINET_IN_H +/* required for sockaddr_in definition */ +#include +#endif + /********************************************************************** * * Copyright 1997 by Carnegie Mellon University Index: squid3/include/snmp_session.h diff -u squid3/include/snmp_session.h:1.1 squid3/include/snmp_session.h:1.1.74.1 --- squid3/include/snmp_session.h:1.1 Sun Oct 13 17:18:18 2002 +++ squid3/include/snmp_session.h Tue Feb 19 13:54:28 2008 @@ -2,6 +2,8 @@ #ifndef SQUID_SNMP_SESSION_H #define SQUID_SNMP_SESSION_H +#include "config.h" + /********************************************************************** * * Copyright 1997 by Carnegie Mellon University @@ -31,7 +33,6 @@ struct snmp_session { int Version; /* SNMP Version for this session */ - u_char *community; /* community for outgoing requests. */ int community_len; /* Length of community name. */ int retries; /* Number of retries before timeout. */ Index: squid3/include/snmp_util.h diff -u squid3/include/snmp_util.h:1.1 squid3/include/snmp_util.h:1.1.74.1 --- squid3/include/snmp_util.h:1.1 Sun Oct 13 17:18:18 2002 +++ squid3/include/snmp_util.h Tue Feb 19 13:54:28 2008 @@ -1,10 +1,11 @@ /* * $Id$ */ - #ifndef SQUID_SNMP_UTIL_H #define SQUID_SNMP_UTIL_H +#include "config.h" + #ifdef __cplusplus extern "C" { #endif Index: squid3/include/snmp_vars.h diff -u squid3/include/snmp_vars.h:1.2 squid3/include/snmp_vars.h:1.2.4.1 --- squid3/include/snmp_vars.h:1.2 Fri Dec 14 15:50:56 2007 +++ squid3/include/snmp_vars.h Tue Feb 19 04:18:54 2008 @@ -29,6 +29,8 @@ * **********************************************************************/ +#include "asn1.h" + #ifdef __cplusplus extern "C" { #endif Index: squid3/include/squid_mswin.h diff -u squid3/include/squid_mswin.h:1.11 squid3/include/squid_mswin.h:1.10.2.2 --- squid3/include/squid_mswin.h:1.11 Tue Feb 26 13:50:50 2008 +++ squid3/include/squid_mswin.h Tue Feb 26 20:28:57 2008 @@ -31,6 +31,12 @@ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA. * */ +#ifndef _INC_SQUID_MSWIN_H +#define _INC_SQUID_MSWIN_H + +#include "config.h" + +#ifdef _SQUID_WIN32_ #define ACL WindowsACL #if defined(_MSC_VER) /* Microsoft C Compiler ONLY */ @@ -738,3 +744,8 @@ }; #undef ACL + + +#endif /* _SQUID_WIN32_ */ + +#endif /* _INC_SQUID_MSWIN_H */ Index: squid3/include/squid_windows.h diff -u squid3/include/squid_windows.h:1.3 squid3/include/squid_windows.h:1.3.34.1 --- squid3/include/squid_windows.h:1.3 Sat Sep 9 08:50:33 2006 +++ squid3/include/squid_windows.h Tue Feb 19 14:36:23 2008 @@ -30,6 +30,12 @@ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA. * */ +#ifndef _INC_SQUID_WINDOWS_H +#define _INC_SQUID_WINDOWS_H + +#include "config.h" + +#ifdef _SQUID_WIN32_ #ifndef ACL #define ACL WindowsACL @@ -40,3 +46,7 @@ #undef ACL #undef _MSWIN_ACL_WAS_NOT_DEFINED #endif + +#endif /* _SQUID_WIN32_ */ + +#endif /* _INC_SQUID_WINDOWS_H */ Index: squid3/include/sspwin32.h diff -u squid3/include/sspwin32.h:1.4 squid3/include/sspwin32.h:1.4.34.1 --- squid3/include/sspwin32.h:1.4 Sat Sep 9 08:50:33 2006 +++ squid3/include/sspwin32.h Tue Feb 19 14:36:23 2008 @@ -1,4 +1,3 @@ - /* * $Id$ * @@ -32,9 +31,11 @@ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA. * */ - #ifndef _LIBSSPWIN32_H_ #define _LIBSSPWIN32_H_ + +#ifdef _SQUID_WIN32_ + #define SECURITY_WIN32 #define NTLM_PACKAGE_NAME "NTLM" #define NEGOTIATE_PACKAGE_NAME "Negotiate" @@ -74,4 +75,7 @@ extern BOOL Use_Unicode; extern BOOL NTLM_LocalCall; + +#endif /* _SQUID_WIN32_ */ + #endif /* LIBSSPWIN32_H_ */ Index: squid3/include/strsep.h diff -u squid3/include/strsep.h:1.2 squid3/include/strsep.h:1.2.44.1 --- squid3/include/strsep.h:1.2 Wed Jul 5 12:50:52 2006 +++ squid3/include/strsep.h Tue Feb 19 17:12:26 2008 @@ -16,38 +16,43 @@ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 * USA. */ - #ifndef GNULIB_STRSEP_H_ #define GNULIB_STRSEP_H_ +#include "config.h" + #if HAVE_STRSEP /* * Get strsep() declaration. */ +#if HAVE_STRING_H #include +#endif #else -/* Searches the next delimiter (char listed in DELIM) starting at *STRINGP. - If one is found, it is overwritten with a NUL, and *STRINGP is advanced +/** +\par + Searches the next delimiter (char listed in DELIM) starting at *STRINGP. + If one is found, it is overwritten with a NULL, and *STRINGP is advanced to point to the next char after it. Otherwise, *STRINGP is set to NULL. If *STRINGP was already NULL, nothing happens. Returns the old value of *STRINGP. - +\par This is a variant of strtok() that is multithread-safe and supports empty fields. - Caveat: It modifies the original string. - Caveat: These functions cannot be used on constant strings. - Caveat: The identity of the delimiting character is lost. - Caveat: It doesn't work with multibyte strings unless all of the delimiter - characters are ASCII characters < 0x30. +\note Caveat: It modifies the original string. +\note Caveat: These functions cannot be used on constant strings. +\note Caveat: The identity of the delimiting character is lost. +\note Caveat: It doesn't work with multibyte strings unless all of the delimiter + characters are ASCII characters < 0x30. - See also strtok_r(). */ - -SQUIDCEXTERN char *strsep (char **stringp, const char *delim); + See also strtok_r(). + */ +SQUIDCEXTERN char *strsep(char **stringp, const char *delim); -#endif +#endif /* HAVE_STRSEP */ #endif /* GNULIB_STRSEP_H_ */ Index: squid3/include/strtoll.h diff -u squid3/include/strtoll.h:1.1 squid3/include/strtoll.h:1.1.22.1 --- squid3/include/strtoll.h:1.1 Fri Aug 17 12:51:26 2007 +++ squid3/include/strtoll.h Tue Feb 19 17:12:26 2008 @@ -1,19 +1,31 @@ +/* + * $Id$ + */ +#ifndef _SQUIDINC_STRTOLL_H +#define _SQUIDINC_STRTOLL_H + +#include "config.h" + #if HAVE_STRTOLL /* * Get strtoll() declaration. */ +#if HAVE_STDLIB_H #include +#endif #else -/* +/** + \par * Convert a string to a int64 integer. - * + \par * Ignores `locale' stuff. Assumes that the upper and lower case * alphabets and digits are each contiguous. */ +SQUIDCEXTERN int64_t strtoll(const char *nptr, char **endptr, int base); -SQUIDCEXTERN int64_t strtoll (const char *nptr, char **endptr, int base); +#endif /* !HAVE_STRTOLL */ -#endif +#endif /* _SQUIDINC_STRTOLL_H */ Index: squid3/include/util.h diff -u squid3/include/util.h:1.20 squid3/include/util.h:1.20.4.1 --- squid3/include/util.h:1.20 Fri Dec 14 15:50:56 2007 +++ squid3/include/util.h Tue Feb 26 19:19:57 2008 @@ -49,15 +49,10 @@ #include #endif -#if !defined(SQUIDHOSTNAMELEN) -#define SQUIDHOSTNAMELEN 256 -#endif - #if defined(_SQUID_FREEBSD_) #define _etext etext #endif -SQUIDCEXTERN const char *getfullhostname(void); SQUIDCEXTERN const char *mkhttpdlogtime(const time_t *); SQUIDCEXTERN const char *mkrfc1123(time_t); SQUIDCEXTERN char *uudecode(const char *); Index: squid3/include/xusleep.h diff -u squid3/include/xusleep.h:1.1 squid3/include/xusleep.h:1.1.44.1 --- squid3/include/xusleep.h:1.1 Mon Apr 23 23:54:56 2007 +++ squid3/include/xusleep.h Tue Feb 19 17:12:26 2008 @@ -1 +1,11 @@ +/* + * $Id$ + */ +#ifndef _INC_XUSLEEP_H +#define _INC_XUSLEEP_H + +#include "config.h" + SQUIDCEXTERN int xusleep(unsigned int); + +#endif /* _INC_XUSLEEP_H */ Index: squid3/lib/Makefile.am diff -u squid3/lib/Makefile.am:1.26 squid3/lib/Makefile.am:1.26.4.5 --- squid3/lib/Makefile.am:1.26 Fri Dec 14 15:50:56 2007 +++ squid3/lib/Makefile.am Tue Feb 26 20:10:03 2008 @@ -96,7 +96,14 @@ ##FIXME - set these in configure.in and reuse TESTS=$(check_PROGRAMS) -check_PROGRAMS=tests/testAll +check_PROGRAMS= \ + testHeaders \ + tests/testAll + +## Special Universal .h dependency test script +## aborts if error encountered +testHeaders: $(top_srcdir)/include/*.h + $(top_srcdir)/test-suite/testheaders.sh "$(CXXCOMPILE)" "$(top_srcdir)/include" || exit 1 tests_testAll_SOURCES= \ tests/testArray.h \ @@ -114,3 +121,4 @@ tests_testAll_LDADD= @SQUID_CPPUNIT_LA@ @SQUID_CPPUNIT_LIBS@ tests_testAll_LDFLAGS = $(LIBADD_DL) + Index: squid3/lib/getfullhostname.c diff -u squid3/lib/getfullhostname.c:1.1 squid3/lib/getfullhostname.c:1.1.74.1 --- squid3/lib/getfullhostname.c:1.1 Sun Oct 13 17:18:18 2002 +++ squid3/lib/getfullhostname.c Tue Feb 26 19:19:57 2008 @@ -1,4 +1,3 @@ - /* * $Id$ * @@ -32,9 +31,9 @@ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA. * */ +#include "getfullhostname.h" -#include "config.h" - +#if 0 /* we SHOULD NOT need ALL these here. */ #if HAVE_LIBC_H #include #endif @@ -62,30 +61,43 @@ #if HAVE_ARPA_INET_H #include #endif + +#endif // 0 + + +#if HAVE_UNISTD_H +/* for gethostname() function */ +#include +#endif #if HAVE_NETDB_H && !defined(_SQUID_NETDB_H_) /* protect on NEXTSTEP */ #define _SQUID_NETDB_H_ +/* for gethostbyname() */ #include #endif -#if HAVE_UNISTD_H -#include -#endif +/* for RFC 2181 constants */ +#include "rfc2181.h" + +/* for xstrncpy() - may need breakign out of there. */ #include "util.h" -/* - * getfullhostname() - Returns the fully qualified name of the current - * host, or NULL on error. Pointer is only valid until the next call - * to the gethost*() functions. +/** + \retval NULL An error occured. + \retval * The fully qualified name (FQDN) of the current host. + * Pointer is only valid until the next call to the gethost*() functions. + * + \todo Make this a squid String result so the duration limit is flexible. */ const char * getfullhostname(void) { const struct hostent *hp = NULL; - static char buf[SQUIDHOSTNAMELEN + 1]; + static char buf[RFC2181_MAXHOSTNAMELEN + 1]; - if (gethostname(buf, SQUIDHOSTNAMELEN) < 0) + if (gethostname(buf, RFC2181_MAXHOSTNAMELEN) < 0) return NULL; + /** \todo convert this to a xgetaddrinfo() call */ if ((hp = gethostbyname(buf)) != NULL) - xstrncpy(buf, hp->h_name, SQUIDHOSTNAMELEN); + xstrncpy(buf, hp->h_name, RFC2181_MAXHOSTNAMELEN); return buf; } Index: squid3/src/ACL.h diff -u squid3/src/ACL.h:1.20 squid3/src/ACL.h:1.19.10.2 --- squid3/src/ACL.h:1.20 Tue Feb 26 13:50:50 2008 +++ squid3/src/ACL.h Tue Feb 26 20:28:57 2008 @@ -64,10 +64,10 @@ SQUIDCEXTERN err_type aclGetDenyInfoPage(acl_deny_info_list ** head, const char *name, int redirect_allowed); /// \ingroup ACLAPI -SQUIDCEXTERN void aclParseDenyInfoLine(struct _acl_deny_info_list **); +SQUIDCEXTERN void aclParseDenyInfoLine(struct acl_deny_info_list **); /// \ingroup ACLAPI -SQUIDCEXTERN void aclDestroyDenyInfoList(struct _acl_deny_info_list **); +SQUIDCEXTERN void aclDestroyDenyInfoList(struct acl_deny_info_list **); /// \ingroup ACLAPI SQUIDCEXTERN wordlist *aclDumpGeneric(const ACL *); /// \ingroup ACLAPI Index: squid3/src/ACLData.h diff -u squid3/src/ACLData.h:1.7 squid3/src/ACLData.h:1.6.44.2 --- squid3/src/ACLData.h:1.7 Tue Feb 26 13:50:50 2008 +++ squid3/src/ACLData.h Sun Mar 2 03:26:57 2008 @@ -31,10 +31,11 @@ * * Copyright (c) 2003, Robert Collins */ - #ifndef SQUID_ACLDATA_H #define SQUID_ACLDATA_H +class wordlist; + /// \ingroup ACLAPI template class ACLData Index: squid3/src/ACLHTTPHeaderData.h diff -u squid3/src/ACLHTTPHeaderData.h:1.5 squid3/src/ACLHTTPHeaderData.h:1.4.20.2 --- squid3/src/ACLHTTPHeaderData.h:1.5 Tue Feb 26 13:50:50 2008 +++ squid3/src/ACLHTTPHeaderData.h Sun Mar 2 03:26:57 2008 @@ -31,11 +31,20 @@ * * Copyright (c) 2003, Robert Collins */ - #ifndef SQUID_ACLHTTPHEADERDATA_H #define SQUID_ACLHTTPHEADERDATA_H +class HttpHeader; +class wordlist; + +/* becaue we inherit from it */ #include "ACLData.h" +/* for String field */ +#include "SquidString.h" +/* for http_hdr_type field */ +#include "HttpHeader.h" +/* because weuse its MEMPROXY_CLASS() macros */ +#include "MemPool.h" /// \ingroup ACLAPI class ACLHTTPHeaderData : public ACLData @@ -53,11 +62,11 @@ virtual ACLData *clone() const; private: - http_hdr_type hdrId; // set if header is known - String hdrName; // always set + http_hdr_type hdrId; /**< set if header is known */ + String hdrName; /**< always set */ ACLData * regex_rule; }; -MEMPROXY_CLASS_INLINE(ACLHTTPHeaderData) /**DOCS_NOSEMI*/ +MEMPROXY_CLASS_INLINE(ACLHTTPHeaderData); #endif /* SQUID_ACLHTTPHEADERDATA_H */ Index: squid3/src/ACLIP.h diff -u squid3/src/ACLIP.h:1.10 squid3/src/ACLIP.h:1.9.4.2 --- squid3/src/ACLIP.h:1.10 Tue Feb 26 13:50:50 2008 +++ squid3/src/ACLIP.h Sun Mar 2 23:31:39 2008 @@ -57,16 +57,16 @@ IPAddress addr2; - IPAddress mask; /* This should perhapse be stored as a CIDR range now instead of a full IP mask. */ + IPAddress mask; /**< \todo This should perhapse be stored as a CIDR range now instead of a full IP mask. */ - acl_ip_data *next; /* used for parsing, not for storing */ + acl_ip_data *next; /**< used for parsing, not for storing */ private: static bool DecodeMask(const char *asc, IPAddress &mask, int string_format_type); }; -MEMPROXY_CLASS_INLINE(acl_ip_data) /**DOCS_NOSEMI*/ +MEMPROXY_CLASS_INLINE(acl_ip_data); /// \ingroup ACLAPI class ACLIP : public ACL Index: squid3/src/ACLIdent.h diff -u squid3/src/ACLIdent.h:1.9 squid3/src/ACLIdent.h:1.8.44.2 --- squid3/src/ACLIdent.h:1.9 Tue Feb 26 13:50:50 2008 +++ squid3/src/ACLIdent.h Sun Mar 2 03:32:28 2008 @@ -35,9 +35,7 @@ #ifndef SQUID_ACLIDENT_H #define SQUID_ACLIDENT_H -#include "ACL.h" #include "ACLChecklist.h" -#include "ACLData.h" /// \ingroup ACLAPI class IdentLookup : public ACLChecklist::AsyncState @@ -52,6 +50,10 @@ static void LookupDone(const char *ident, void *data); }; + +#include "ACL.h" +#include "ACLData.h" + /// \ingroup ACLAPI class ACLIdent : public ACL { @@ -82,6 +84,6 @@ char const *type_; }; -MEMPROXY_CLASS_INLINE(ACLIdent) /**DOCS_NOSEMI*/ +MEMPROXY_CLASS_INLINE(ACLIdent); #endif /* SQUID_ACLIDENT_H */ Index: squid3/src/ACLRegexData.h diff -u squid3/src/ACLRegexData.h:1.7 squid3/src/ACLRegexData.h:1.6.44.2 --- squid3/src/ACLRegexData.h:1.7 Tue Feb 26 13:50:50 2008 +++ squid3/src/ACLRegexData.h Sun Mar 2 03:26:57 2008 @@ -31,10 +31,14 @@ * * Copyright (c) 2003, Robert Collins */ - #ifndef SQUID_ACLREGEXDATA_H #define SQUID_ACLREGEXDATA_H + #include "ACLData.h" +#include "MemPool.h" + +/** \todo CLEANUP: break out relist, we don't need the rest. */ +#include "structs.h" class ACLRegexData : public ACLData { @@ -53,6 +57,6 @@ relist *data; }; -MEMPROXY_CLASS_INLINE(ACLRegexData) /**DOCS_NOSEMI*/ +MEMPROXY_CLASS_INLINE(ACLRegexData); #endif /* SQUID_ACLREGEXDATA_H */ Index: squid3/src/ACLReplyHeaderStrategy.h diff -u squid3/src/ACLReplyHeaderStrategy.h:1.7 squid3/src/ACLReplyHeaderStrategy.h:1.7.38.1 --- squid3/src/ACLReplyHeaderStrategy.h:1.7 Sat May 6 15:50:34 2006 +++ squid3/src/ACLReplyHeaderStrategy.h Mon Mar 3 00:23:36 2008 @@ -1,4 +1,3 @@ - /* * $Id$ * @@ -32,9 +31,11 @@ * * Copyright (c) 2003, Robert Collins */ - #ifndef SQUID_ACLREPLYHEADERSTRATEGY_H #define SQUID_ACLREPLYHEADERSTRATEGY_H + +class ACLChecklist; + #include "ACL.h" #include "ACLData.h" #include "ACLStrategy.h" @@ -42,7 +43,6 @@ #include "HttpReply.h" template - class ACLReplyHeaderStrategy : public ACLStrategy { Index: squid3/src/ACLReplyMIMEType.h diff -u squid3/src/ACLReplyMIMEType.h:1.6 squid3/src/ACLReplyMIMEType.h:1.6.38.2 --- squid3/src/ACLReplyMIMEType.h:1.6 Sat May 6 15:50:34 2006 +++ squid3/src/ACLReplyMIMEType.h Mon Mar 3 00:23:36 2008 @@ -1,4 +1,3 @@ - /* * $Id$ * @@ -32,15 +31,11 @@ * * Copyright (c) 2003, Robert Collins */ - #ifndef SQUID_ACLREPLYMIMETYPE_H #define SQUID_ACLREPLYMIMETYPE_H + #include "ACL.h" -#include "ACLData.h" -#include "ACLReplyHeaderStrategy.h" #include "ACLStrategised.h" -#include "ACLChecklist.h" -#include "HttpReply.h" class ACLReplyMIMEType { @@ -52,9 +47,13 @@ /* partial specialisation */ +#include "ACLData.h" +#include "ACLReplyHeaderStrategy.h" +#include "ACLChecklist.h" + template <> -int -ACLReplyHeaderStrategy::match (ACLData * &data, ACLChecklist *checklist) +inline int +ACLReplyHeaderStrategy::match(ACLData * &data, ACLChecklist *checklist) { char const *theHeader = checklist->reply->header.getStr(HDR_CONTENT_TYPE); Index: squid3/src/ACLRequestMIMEType.h diff -u squid3/src/ACLRequestMIMEType.h:1.4 squid3/src/ACLRequestMIMEType.h:1.4.38.1 --- squid3/src/ACLRequestMIMEType.h:1.4 Sat May 6 15:50:34 2006 +++ squid3/src/ACLRequestMIMEType.h Mon Mar 3 00:23:36 2008 @@ -1,4 +1,3 @@ - /* * $Id$ * @@ -32,14 +31,11 @@ * * Copyright (c) 2003, Robert Collins */ - #ifndef SQUID_ACLREQUESTMIMETYPE_H #define SQUID_ACLREQUESTMIMETYPE_H + #include "ACL.h" -#include "ACLData.h" -#include "ACLRequestHeaderStrategy.h" #include "ACLStrategised.h" -#include "ACLChecklist.h" class ACLRequestMIMEType { @@ -51,8 +47,12 @@ /* partial specialisation */ +#include "ACLData.h" +#include "ACLRequestHeaderStrategy.h" +#include "ACLChecklist.h" + template <> -int +inline int ACLRequestHeaderStrategy::match (ACLData * &data, ACLChecklist *checklist) { char const *theHeader = checklist->request->header.getStr(HDR_CONTENT_TYPE); Index: squid3/src/ACLSourceASN.h diff -u squid3/src/ACLSourceASN.h:1.3 squid3/src/ACLSourceASN.h:1.3.4.1 --- squid3/src/ACLSourceASN.h:1.3 Fri Dec 14 15:50:57 2007 +++ squid3/src/ACLSourceASN.h Sun Mar 2 23:31:39 2008 @@ -32,10 +32,15 @@ * * Copyright (c) 2003, Robert Collins */ - #ifndef SQUID_ACLSOURCEASN_H #define SQUID_ACLSOURCEASN_H + +#if 0 #include "ACLASN.h" +#endif + +class ACLChecklist; + #include "ACLStrategy.h" #include "IPAddress.h" Index: squid3/src/AccessLogEntry.h diff -u squid3/src/AccessLogEntry.h:1.11 squid3/src/AccessLogEntry.h:1.10.4.3 --- squid3/src/AccessLogEntry.h:1.11 Mon Feb 25 16:50:41 2008 +++ squid3/src/AccessLogEntry.h Tue Feb 26 20:28:57 2008 @@ -1,4 +1,3 @@ - /* * $Id$ * @@ -31,7 +30,6 @@ * * Copyright (c) 2003, Robert Collins */ - #ifndef SQUID_HTTPACCESSLOGENTRY_H #define SQUID_HTTPACCESSLOGENTRY_H @@ -39,10 +37,12 @@ #include "HttpRequestMethod.h" #include "HierarchyLogEntry.h" #include "IPAddress.h" +#include "HttpRequestMethod.h" /* forward decls */ - class CacheManager; +class HttpReply; +class HttpRequest; class AccessLogEntry { @@ -127,6 +127,8 @@ headers; + // Why is this a sub-class and not a set of real "private:" fields? + // It looks like its duplicating HTTPRequestMethod anyway! class Private { @@ -142,6 +144,10 @@ HttpRequest *request; }; +class ACLChecklist; +class StoreEntry; +class logformat_token; + /* Should be in 'AccessLog.h' as the driver */ extern void accessLogLog(AccessLogEntry *, ACLChecklist * checklist); extern void accessLogRotate(void); Index: squid3/src/AuthConfig.h diff -u squid3/src/AuthConfig.h:1.4 squid3/src/AuthConfig.h:1.3.26.2 --- squid3/src/AuthConfig.h:1.4 Tue Feb 26 13:50:51 2008 +++ squid3/src/AuthConfig.h Mon Mar 3 17:08:47 2008 @@ -1,4 +1,3 @@ - /* * $Id$ * @@ -30,24 +29,30 @@ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA. * */ - #ifndef SQUID_AUTHCONFIG_H #define SQUID_AUTHCONFIG_H -/* +class AuthUserRequest; +class StoreEntry; +class HttpReply; +class HttpRequest; +class CacheManager; + +/* for http_hdr_type parameters-by-value */ +#include "HttpHeader.h" + + +/** + \ingroup AuthAPI + \par * I am the configuration for an auth scheme. * Currently each scheme has only one instance of me, * but this may change. - */ - -/* This class is treated like a ref counted class. + \par + * This class is treated like a ref counted class. * If the children ever stop being singletons, implement the * ref counting... */ - -class AuthUserRequest; - -/// \ingroup AuthAPI class AuthConfig { Index: squid3/src/AuthUser.cc diff -u squid3/src/AuthUser.cc:1.10 squid3/src/AuthUser.cc:1.10.4.1 --- squid3/src/AuthUser.cc:1.10 Fri Dec 14 15:50:57 2007 +++ squid3/src/AuthUser.cc Mon Feb 11 18:15:20 2008 @@ -157,7 +157,7 @@ * This must complete all at once, because we are ensuring correctness. */ AuthUserHashPointer *usernamehash; - auth_user_t *auth_user; + AuthUser *auth_user; char const *username = NULL; debugs(29, 3, "AuthUser::CachedACLsReset: Flushing the ACL caches for all users."); hash_first(proxy_auth_username_cache); @@ -182,7 +182,7 @@ * entries at a time. Lets see how it flys first. */ AuthUserHashPointer *usernamehash; - auth_user_t *auth_user; + AuthUser *auth_user; char const *username = NULL; debugs(29, 3, "AuthUser::cacheCleanup: Cleaning the user cache now"); debugs(29, 3, "AuthUser::cacheCleanup: Current time: " << current_time.tv_sec); Index: squid3/src/AuthUser.cci diff -u squid3/src/AuthUser.cci:1.3 squid3/src/AuthUser.cci:1.3.26.1 --- squid3/src/AuthUser.cci:1.3 Wed May 9 08:50:34 2007 +++ squid3/src/AuthUser.cci Mon Mar 3 17:08:47 2008 @@ -1,4 +1,3 @@ - /* * $Id$ * @@ -34,6 +33,11 @@ * Copyright (c) 2003, Robert Collins */ +/* for assert() */ +#include "assert.h" +/* for xstrdup() */ +#include "util.h" + char const * AuthUser::username () const { Index: squid3/src/AuthUser.h diff -u squid3/src/AuthUser.h:1.7 squid3/src/AuthUser.h:1.6.4.3 --- squid3/src/AuthUser.h:1.7 Tue Feb 26 13:50:51 2008 +++ squid3/src/AuthUser.h Mon Mar 3 17:08:47 2008 @@ -1,4 +1,3 @@ - /* * $Id$ * @@ -35,9 +34,15 @@ #ifndef SQUID_AUTHUSER_H #define SQUID_AUTHUSER_H -#include "IPAddress.h" - class AuthUserRequest; +class AuthConfig; +class AuthUserHashPointer; + +/* for auth_type_t */ +#include "enums.h" + +#include "IPAddress.h" +#include "dlink.h" /** * \ingroup AuthAPI @@ -60,7 +65,7 @@ /** the config for this user */ AuthConfig *config; /** we only have one username associated with a given auth_user struct */ - auth_user_hash_pointer *usernamehash; + AuthUserHashPointer *usernamehash; /** we may have many proxy-authenticate strings that decode to the same user */ dlink_list proxy_auth_list; dlink_list proxy_match_cache; @@ -72,11 +77,11 @@ * but how many requests will a single username have in parallel? */ dlink_list requests; - static void cacheInit (); + static void cacheInit(); static void CachedACLsReset(); void absorb(AuthUser *from); - virtual ~AuthUser (); + virtual ~AuthUser(); _SQUID_INLINE_ char const *username() const; _SQUID_INLINE_ void username(char const *); void clearIp(); @@ -84,9 +89,7 @@ void addIp(IPAddress); _SQUID_INLINE_ void addRequest(AuthUserRequest *); - void lock() - - ; + void lock(); void unlock(); void addToNameCache(); Index: squid3/src/AuthUserRequest.cc diff -u squid3/src/AuthUserRequest.cc:1.21 squid3/src/AuthUserRequest.cc:1.20.4.2 --- squid3/src/AuthUserRequest.cc:1.21 Tue Feb 12 15:51:31 2008 +++ squid3/src/AuthUserRequest.cc Tue Feb 12 19:52:51 2008 @@ -202,7 +202,7 @@ static void authenticateAuthUserRequestSetIp(AuthUserRequest * auth_user_request, IPAddress &ipaddr) { - auth_user_t *auth_user = auth_user_request->user(); + AuthUser *auth_user = auth_user_request->user(); if (!auth_user) return; @@ -213,7 +213,7 @@ void authenticateAuthUserRequestRemoveIp(AuthUserRequest * auth_user_request, IPAddress const &ipaddr) { - auth_user_t *auth_user = auth_user_request->user(); + AuthUser *auth_user = auth_user_request->user(); if (!auth_user) return; @@ -328,7 +328,6 @@ * Caller is responsible for locking and unlocking their *auth_user_request! */ auth_acl_t - AuthUserRequest::authenticate(AuthUserRequest ** auth_user_request, http_hdr_type headertype, HttpRequest * request, ConnStateData * conn, IPAddress &src_addr) { const char *proxy_auth; Index: squid3/src/AuthUserRequest.h diff -u squid3/src/AuthUserRequest.h:1.11 squid3/src/AuthUserRequest.h:1.9.4.3 --- squid3/src/AuthUserRequest.h:1.11 Tue Feb 26 13:50:51 2008 +++ squid3/src/AuthUserRequest.h Tue Feb 26 20:28:57 2008 @@ -66,7 +66,7 @@ * it has request specific data, and links to user specific data * the user */ - auth_user_t *_auth_user; + AuthUser *_auth_user; /** * Used by squid to determine what the next step in performing authentication for a given scheme is. @@ -107,7 +107,7 @@ virtual const AuthUser *user() const {return _auth_user;} - virtual void user (AuthUser *aUser) {_auth_user=aUser;} + virtual void user(AuthUser *aUser) {_auth_user=aUser;} static auth_acl_t tryToAuthenticateAndSetAuthUser(AuthUserRequest **, http_hdr_type, HttpRequest *, ConnStateData *, IPAddress &); static void addReplyAuthHeader(HttpReply * rep, AuthUserRequest * auth_user_request, HttpRequest * request, int accelerated, int internal); @@ -115,21 +115,21 @@ AuthUserRequest(); virtual ~AuthUserRequest(); - void *operator new (size_t byteCount); - void operator delete (void *address); + void *operator new(size_t byteCount); + void operator delete(void *address); - void start ( RH * handler, void *data); - char const * denyMessage (char const * const default_message = NULL); + void start( RH * handler, void *data); + char const * denyMessage(char const * const default_message = NULL); /** Possibly overrideable in future */ - void setDenyMessage (char const *); + void setDenyMessage(char const *); /** Possibly overrideable in future */ - char const * getDenyMessage (); + char const * getDenyMessage(); size_t refCount() const; - void _lock (); // please use AUTHUSERREQUESTLOCK() - void _unlock (); // please use AUTHUSERREQUESTUNLOCK() + void _lock(); // please use AUTHUSERREQUESTLOCK() + void _unlock(); // please use AUTHUSERREQUESTUNLOCK() /** * Squid does not make assumptions about where the username is stored. Index: squid3/src/ChunkedCodingParser.h diff -u squid3/src/ChunkedCodingParser.h:1.2 squid3/src/ChunkedCodingParser.h:1.2.8.1 --- squid3/src/ChunkedCodingParser.h:1.2 Wed Dec 26 14:51:36 2007 +++ squid3/src/ChunkedCodingParser.h Mon Mar 3 19:43:17 2008 @@ -1,4 +1,3 @@ - /* * $Id$ * @@ -29,18 +28,27 @@ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA. * */ - #ifndef SQUID_CHUNKEDCODINGPARSER_H #define SQUID_CHUNKEDCODINGPARSER_H +class MemBuf; + +#if 0 #include "RefCount.h" +#endif -// ChunkedCodingParser is an incremental parser for chunked transfer coding -// used by HTTP and ICAP. The parser shovels content bytes from the raw -// input buffer into the content output buffer, both caller-supplied. -// Ignores chunk extensions except for ICAP's ieof. -// Has a trailer-handling placeholder. +/* for size_t */ +#include "config.h" +/** + \ingroup ChunkEncodingAPI Chunked Encoding API + \par + * ChunkedCodingParser is an incremental parser for chunked transfer coding + * used by HTTP and ICAP. The parser shovels content bytes from the raw + * input buffer into the content output buffer, both caller-supplied. + * Ignores chunk extensions except for ICAP's ieof. + * Has a trailer-handling placeholder. + */ class ChunkedCodingParser { @@ -49,8 +57,12 @@ void reset(); - // true = complete success; false == needs more data - bool parse(MemBuf *rawData, MemBuf *parsedContent); // throws on error + /** + \retval true complete success + \retval false needs more data + \throws ?? error. + */ + bool parse(MemBuf *rawData, MemBuf *parsedContent); bool needsMoreData() const; bool needsMoreSpace() const; Index: squid3/src/ClientRequestContext.h diff -u squid3/src/ClientRequestContext.h:1.4 squid3/src/ClientRequestContext.h:1.4.20.1 --- squid3/src/ClientRequestContext.h:1.4 Fri May 25 23:50:45 2007 +++ squid3/src/ClientRequestContext.h Mon Mar 3 19:43:17 2008 @@ -1,3 +1,15 @@ +#ifndef SQUID_CLIENTREQUESTCONTEXT_H +#define SQUID_CLIENTREQUESTCONTEXT_H + +class ACLChecklist; +class ClientHttpRequest; + +#include "config.h" +/* for RefCountable */ +#include "RefCount.h" +/* for CBDATA_CLASS() */ +#include "cbdata.h" + #if ICAP_CLIENT #include "ICAP/ICAPServiceRep.h" #endif @@ -44,3 +56,4 @@ CBDATA_CLASS(ClientRequestContext); }; +#endif /* SQUID_CLIENTREQUESTCONTEXT_H */ Index: squid3/src/ConfigOption.h diff -u squid3/src/ConfigOption.h:1.1 squid3/src/ConfigOption.h:1.1.52.1 --- squid3/src/ConfigOption.h:1.1 Mon Dec 20 19:14:16 2004 +++ squid3/src/ConfigOption.h Mon Mar 3 19:43:17 2008 @@ -29,12 +29,15 @@ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA. * */ - #ifndef SQUID_CONFIGOPTION_H #define SQUID_CONFIGOPTION_H +class StoreEntry; + +/* for Vector<> */ #include "Array.h" + /* cache option parsers */ class ConfigOption @@ -58,12 +61,11 @@ }; template - class ConfigOptionAdapter : public ConfigOption { public: - ConfigOptionAdapter (C& theObject, bool (C::*parseFP)(char const *option, const char *value, int reconfiguring), void (C::*dumpFP) (StoreEntry * e) const) : object(theObject), parser (parseFP), dumper(dumpFP) {} + ConfigOptionAdapter(C& theObject, bool (C::*parseFP)(char const *option, const char *value, int reconfiguring), void (C::*dumpFP) (StoreEntry * e) const) : object(theObject), parser (parseFP), dumper(dumpFP) {} bool parse(char const *option, const char *value, int reconfiguring) { @@ -73,7 +75,7 @@ return false; } - void dump (StoreEntry * e) const + void dump(StoreEntry * e) const { if (dumper) (object.*dumper) (e); Index: squid3/src/Debug.h diff -u squid3/src/Debug.h:1.13 squid3/src/Debug.h:1.12.4.2 --- squid3/src/Debug.h:1.13 Tue Feb 26 10:51:02 2008 +++ squid3/src/Debug.h Mon Mar 3 19:43:17 2008 @@ -31,9 +31,8 @@ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA. * */ - -#ifndef SQUID_DEBUG -#define SQUID_DEBUG +#ifndef SQUID_DEBUG_H +#define SQUID_DEBUG_H #include #undef assert @@ -52,6 +51,9 @@ #define assert(EX) ((EX)?((void)0):xassert("EX", __FILE__, __LINE__)) #endif +/* defined debug section limits */ +#define MAX_DEBUG_SECTIONS 100 + /* defined names for Debug Levels */ #define DBG_CRITICAL 0 /**< critical messages always shown when they occur */ #define DBG_IMPORTANT 1 /**< important messages always shown when their section is being checked */ @@ -97,4 +99,4 @@ return (os << (int)d); } -#endif /* SQUID_DEBUG */ +#endif /* SQUID_DEBUG_H */ Index: squid3/src/DelayBucket.h diff -u squid3/src/DelayBucket.h:1.3 squid3/src/DelayBucket.h:1.2.56.2 --- squid3/src/DelayBucket.h:1.3 Tue Feb 26 13:50:51 2008 +++ squid3/src/DelayBucket.h Mon Mar 3 19:43:17 2008 @@ -31,11 +31,12 @@ * * Copyright (c) 2003, Robert Collins */ - #ifndef SQUID_DELAYBUCKET_H #define SQUID_DELAYBUCKET_H class DelaySpec; +class StoreEntry; + /* don't use remote storage for these */ /// \ingroup DelayPoolsAPI Index: squid3/src/DelayConfig.h diff -u squid3/src/DelayConfig.h:1.5 squid3/src/DelayConfig.h:1.4.4.2 --- squid3/src/DelayConfig.h:1.5 Tue Feb 26 13:50:51 2008 +++ squid3/src/DelayConfig.h Mon Mar 3 19:43:17 2008 @@ -33,10 +33,10 @@ * * Copyright (c) 2003, Robert Collins */ - #ifndef SQUID_DELAYCONFIG_H #define SQUID_DELAYCONFIG_H +class StoreEntry; class ConfigParser; /// \ingroup DelayPoolsAPI Index: squid3/src/DelayPools.h diff -u squid3/src/DelayPools.h:1.5 squid3/src/DelayPools.h:1.4.38.2 --- squid3/src/DelayPools.h:1.5 Tue Feb 26 13:50:51 2008 +++ squid3/src/DelayPools.h Mon Mar 3 19:43:17 2008 @@ -31,7 +31,6 @@ * * Copyright (c) 2003, Robert Collins */ - #ifndef SQUID_DELAYPOOLS_H #define SQUID_DELAYPOOLS_H @@ -40,11 +39,6 @@ \ingroup Components */ -/* forward decls */ -class CacheManager; - -#include "Array.h" - /// \ingroup DelayPoolsAPI class Updateable { @@ -55,7 +49,14 @@ virtual void update(int) = 0; }; +/* forward decls */ +class CacheManager; class DelayPool; +class Updateable; +class StoreEntry; + +/* for Vector<> */ +#include "Array.h" /// \ingroup DelayPoolsAPI class DelayPools Index: squid3/src/DelaySpec.h diff -u squid3/src/DelaySpec.h:1.3 squid3/src/DelaySpec.h:1.2.56.2 --- squid3/src/DelaySpec.h:1.3 Tue Feb 26 13:50:51 2008 +++ squid3/src/DelaySpec.h Tue Mar 4 14:18:45 2008 @@ -29,18 +29,19 @@ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA. * */ - #ifndef SQUID_DELAYSPEC_H #define SQUID_DELAYSPEC_H +class StoreEntry; + /// \ingroup DelyPoolsAPI class DelaySpec { public: DelaySpec(); - void stats (StoreEntry * sentry, char const *) const; - void dump (StoreEntry *) const; + void stats(StoreEntry * sentry, char const *) const; + void dump(StoreEntry *) const; void parse(); int restore_bps; int max_bytes; Index: squid3/src/ESICustomParser.h diff -u squid3/src/ESICustomParser.h:1.8 squid3/src/ESICustomParser.h:1.8.20.1 --- squid3/src/ESICustomParser.h:1.8 Tue May 29 06:51:36 2007 +++ squid3/src/ESICustomParser.h Tue Mar 4 14:18:45 2008 @@ -29,14 +29,20 @@ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA. * */ - #ifndef SQUID_ESICUSTOMPARSER_H #define SQUID_ESICUSTOMPARSER_H +class Trie; + +/* inherits from */ #include "ESIParser.h" -class Trie; +/* for String variables */ +#include "SquidString.h" +/** + \ingroup ESIAPI + */ class ESICustomParser : public ESIParser { Index: squid3/src/ESIParser.h diff -u squid3/src/ESIParser.h:1.6 squid3/src/ESIParser.h:1.5.44.2 --- squid3/src/ESIParser.h:1.6 Tue Feb 26 13:50:51 2008 +++ squid3/src/ESIParser.h Tue Mar 4 14:18:45 2008 @@ -29,32 +29,41 @@ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA. * */ - #ifndef SQUID_ESIPARSER_H #define SQUID_ESIPARSER_H +/* for size_t */ +#include "config.h" + class ESIParserClient { - public: virtual void start(const char *el, const char **attr, size_t attrCount) = 0; virtual void end(const char *el) = 0; virtual void parserDefault (const char *s, int len) =0; virtual void parserComment (const char *s) = 0; virtual ~ESIParserClient() {}; - }; + +/* for RefCountable */ +#include "RefCount.h" + class ESIParser : public RefCountable { - public: typedef RefCount Pointer; + static void registerParser(const char *name, Pointer (*new_func)(ESIParserClient *aClient)); static Pointer NewParser(ESIParserClient *aClient); static char *Type; - /* true on success */ + + /** + \retval true on success + \retval false on what? + */ virtual bool parse(char const *dataToParse, size_t const lengthOfData, bool const endOfStream) = 0; + virtual long int lineNumber() const =0; virtual char const * errorString() const =0; @@ -95,4 +104,6 @@ #define ESI_PARSER_TYPE \ static ESIParser::Pointer NewParser(ESIParserClient *aClient); \ static ESIParser::Register thisParser + + #endif /* SQUID_ESIPARSER_H */ Index: squid3/src/ExternalACL.h diff -u squid3/src/ExternalACL.h:1.10 squid3/src/ExternalACL.h:1.9.38.2 --- squid3/src/ExternalACL.h:1.10 Tue Feb 26 13:50:51 2008 +++ squid3/src/ExternalACL.h Sun Mar 2 03:26:57 2008 @@ -1,4 +1,3 @@ - /* * $Id$ * @@ -32,10 +31,9 @@ * * Copyright (c) 2003, Robert Collins */ - #ifndef SQUID_EXTERNALACL_H #define SQUID_EXTERNALACL_H -#include "ACL.h" + #include "ACLChecklist.h" class external_acl; @@ -52,8 +50,11 @@ static void LookupDone(void *data, void *result); }; +/** \todo CLEANUP: kill this typedef. */ typedef struct _external_acl_data external_acl_data; +#include "ACL.h" + class ACLExternal : public ACL { @@ -89,7 +90,7 @@ char const *class_; }; -MEMPROXY_CLASS_INLINE(ACLExternal) /**DOCS_NOSEMI*/ +MEMPROXY_CLASS_INLINE(ACLExternal); extern void externalAclRegisterWithCacheManager(CacheManager & manager); Index: squid3/src/Generic.h diff -u squid3/src/Generic.h:1.6 squid3/src/Generic.h:1.6.48.2 --- squid3/src/Generic.h:1.6 Mon Dec 20 19:14:16 2004 +++ squid3/src/Generic.h Tue Mar 4 17:47:02 2008 @@ -1,4 +1,3 @@ - /* * $Id$ * @@ -30,12 +29,15 @@ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA. * */ - #ifndef SQUID_GENERIC_H #define SQUID_GENERIC_H -template +/** \todo CLEANUP: checks towrap this header properly */ +#include + +#include "dlink.h" +template struct unary_function { typedef _Arg argument_type; @@ -61,7 +63,6 @@ } template - class Stack; template @@ -78,7 +79,6 @@ */ template - class InstanceToSingletonAdapter : public C { @@ -119,7 +119,6 @@ /* generic ostream printer */ template - struct PointerPrinter { PointerPrinter(std::ostream &astream, std::string aDelimiter) : os(astream), delimiter (aDelimiter) {} Index: squid3/src/HierarchyLogEntry.h diff -u squid3/src/HierarchyLogEntry.h:1.1 squid3/src/HierarchyLogEntry.h:1.1.56.1 --- squid3/src/HierarchyLogEntry.h:1.1 Thu Oct 16 19:12:32 2003 +++ squid3/src/HierarchyLogEntry.h Tue Feb 26 19:19:57 2008 @@ -1,4 +1,3 @@ - /* * $Id$ * @@ -35,8 +34,12 @@ #ifndef SQUID_HTTPHIERARCHYLOGENTRY_H #define SQUID_HTTPHIERARCHYLOGENTRY_H +#include "rfc2181.h" #include "PingData.h" +/** todo Cleanup: break hier_code type out. We don't need the rest. */ +#include "enums.h" + class HierarchyLogEntry { Index: squid3/src/HttpHeader.h diff -u squid3/src/HttpHeader.h:1.26 squid3/src/HttpHeader.h:1.25.2.3 --- squid3/src/HttpHeader.h:1.26 Tue Feb 26 13:50:51 2008 +++ squid3/src/HttpHeader.h Mon Mar 3 00:23:36 2008 @@ -36,6 +36,7 @@ /* forward decls */ class CacheManager; + /* because we pass a spec by value */ #include "HttpHeaderRange.h" /* HttpHeader holds a HttpHeaderMask */ @@ -167,8 +168,10 @@ /* these two are defined in structs.h */ +/// \todo CLEANUP: Kill this. typedef struct _TimeOrTag TimeOrTag; +/// \todo CLEANUP: Kill this. typedef struct _ETag ETag; class HttpHeaderEntry Index: squid3/src/HttpRequestMethod.h diff -u squid3/src/HttpRequestMethod.h:1.10 squid3/src/HttpRequestMethod.h:1.6.2.4 --- squid3/src/HttpRequestMethod.h:1.10 Mon Feb 25 16:50:41 2008 +++ squid3/src/HttpRequestMethod.h Wed Mar 5 03:13:04 2008 @@ -72,9 +72,6 @@ METHOD_ENUM_END // MUST be last, (yuck) this is used as an array-initialization index constant! }; -/* forward decls */ -typedef struct _SquidConfig SquidConfig; - /** * This class represents an HTTP Request METHOD Index: squid3/src/Makefile.am diff -u squid3/src/Makefile.am:1.141 squid3/src/Makefile.am:1.138.2.9 --- squid3/src/Makefile.am:1.141 Mon Feb 25 16:50:41 2008 +++ squid3/src/Makefile.am Wed Mar 5 03:13:04 2008 @@ -239,7 +239,7 @@ $(UNLINKD) cf_gen_SOURCES = cf_gen.cc defines.h debug.cc time.cc -nodist_cf_gen_SOURCES = globals.cc +nodist_cf_gen_SOURCES = SquidConfig.cc globals.cc nodist_cf_gen_HEADER = cf_gen_defines.h cf_gen.$(OBJEXT): cf_gen_defines.h @@ -479,6 +479,7 @@ disk.cc \ $(DISKIO_SOURCE) \ dlink.h \ + dlink.cc \ $(DNSSOURCE) \ enums.h \ errorpage.cc \ @@ -739,6 +740,7 @@ pinger.cc \ debug.cc \ time.cc \ + SquidConfig.cc \ SquidNew.cc dnsserver_SOURCES = dnsserver.cc SquidNew.cc @@ -816,6 +818,8 @@ defines.h \ $(DELAY_POOL_SOURCE) \ disk.cc \ + dlink.h \ + dlink.cc \ $(DNSSOURCE) \ enums.h \ errorpage.cc \ @@ -1155,9 +1159,9 @@ event.cc \ AsyncCallQueue.cc \ AsyncCall.cc - -check_PROGRAMS+= \ + +check_PROGRAMS+= testHeaders \ tests/testAuth \ tests/testACLMaxUserIP \ tests/testBoilerplate \ @@ -1165,7 +1169,6 @@ tests/testDiskIO \ tests/testEvent \ tests/testEventLoop \ - tests/testHeaders \ tests/test_http_range \ tests/testHttpRequest \ tests/testICMP \ @@ -1174,6 +1177,15 @@ tests/testURL \ @STORE_TESTS@ +## Special Universal .h dependency test script +## aborts if error encountered +testHeaders: *.h DiskIO/*.h ICAP/*.h + ../test-suite/testheaders.sh "$(CXXCOMPILE)" "." || exit 1 + ../test-suite/testheaders.sh "$(CXXCOMPILE)" "DiskIO" || exit 1 + ../test-suite/testheaders.sh "$(CXXCOMPILE)" "ICAP" || exit 1 +## src/repl/ has no .h files and its own makefile. + + ### Template for new Unit Test Program ## - add tests/testX to check_PROGRAMS above. ## - copy template below and substitue X for class name @@ -1794,43 +1806,6 @@ @SQUID_CPPUNIT_LA@ \ @ICAP_LIBS@ -## test headers checks that individual headers can be parsed with no dependencies. -## as such, it needs a new .cc file for each header it parses, so that they -## can be #included with no baggage. If the binary links, the test passed. -## We could write a script to pull out the compiler configuration from autoconf, -## but this is easier to understand and more robust against changes in autoconf. -## RBC 20060422. -HEADERS_TO_TEST = \ - tests/testHeader_ACL.cc \ - tests/testHeader_AsyncEngine.cc \ - tests/testHeader_cbdata.cc \ - tests/testHeader_CompletionDispatcher.cc \ - tests/testHeader_ConfigParser.cc \ - tests/testHeader_client_side_request.cc \ - tests/testHeader_comm.cc \ - tests/testHeader_dlink.cc \ - tests/testHeader_errorpage.cc \ - tests/testHeader_event.cc \ - tests/testHeader_EventLoop.cc \ - tests/testHeader_HttpHeader.cc \ - tests/testHeader_HttpHeaderRange.cc \ - tests/testHeader_HttpReply.cc \ - tests/testHeader_HttpRequestMethod.cc \ - tests/testHeader_RemovalPolicy.cc \ - tests/testHeader_SquidTime.cc \ - tests/testHeader_Store.cc \ - tests/testHeader_StoreEntryStream.cc \ - tests/testHeader_URL.cc \ - tests/testHeader_URLScheme.cc \ - tests/testHeader_wordlist.cc -tests_testHeaders_SOURCES= tests/testMain.cc $(HEADERS_TO_TEST) -tests_testHeaders_LDADD= \ - @SQUID_CPPUNIT_LIBS@ \ - @SSLLIB@ -tests_testHeaders_LDFLAGS = $(LIBADD_DL) -tests_testHeaders_DEPENDENCIES = \ - @SQUID_CPPUNIT_LA@ - tests_test_http_range_SOURCES = \ tests/test_http_range.cc \ access_log.cc \ Index: squid3/src/PeerDigest.h diff -u squid3/src/PeerDigest.h:1.4 squid3/src/PeerDigest.h:1.4.10.1 --- squid3/src/PeerDigest.h:1.4 Fri Sep 21 04:51:35 2007 +++ squid3/src/PeerDigest.h Sun Mar 2 03:26:57 2008 @@ -95,24 +95,17 @@ void *operator new (size_t); void operator delete(void *); - struct _peer *peer; /* pointer back to peer structure, argh */ - CacheDigest *cd; /* actual digest structure */ - String host; /* copy of peer->host */ - const char *req_result; /* text status of the last request */ + struct peer *peer; /**< pointer back to peer structure, argh */ + CacheDigest *cd; /**< actual digest structure */ + String host; /**< copy of peer->host */ + const char *req_result; /**< text status of the last request */ struct { - -unsigned int needed: - 1; /* there were requests for this digest */ - -unsigned int usable: - 1; /* can be used for lookups */ - -unsigned int requested: - 1; /* in process of receiving [fresh] digest */ + unsigned int needed:1; /**< there were requests for this digest */ + unsigned int usable:1; /**< can be used for lookups */ + unsigned int requested:1; /**< in process of receiving [fresh] digest */ } - flags; struct @@ -127,7 +120,6 @@ time_t received; /* received the current copy of a digest */ time_t disabled; /* disabled for good */ } - times; struct @@ -143,7 +135,6 @@ sent, recv; } - stats; private: @@ -151,6 +142,7 @@ }; extern const Version CacheDigestVer; -#endif + +#endif /* USE_CACHE_DIGESTS */ #endif /* SQUID_PEERDIGEST_H */ Index: squid3/src/PingData.h diff -u squid3/src/PingData.h:1.1 squid3/src/PingData.h:1.1.56.1 --- squid3/src/PingData.h:1.1 Thu Oct 16 19:12:32 2003 +++ squid3/src/PingData.h Sun Feb 24 18:34:09 2008 @@ -1,4 +1,3 @@ - /* * $Id$ * @@ -31,10 +30,15 @@ * * Copyright (c) 2003, Robert Collins */ - #ifndef SQUID_PINGDATA_H #define SQUID_PINGDATA_H +#include "config.h" + +#ifdef HAVE_SYS_TIME_H +#include +#endif + class ping_data { Index: squid3/src/SquidString.h diff -u squid3/src/SquidString.h:1.18 squid3/src/SquidString.h:1.15.2.2 --- squid3/src/SquidString.h:1.18 Mon Feb 11 15:50:26 2008 +++ squid3/src/SquidString.h Sun Mar 2 03:26:57 2008 @@ -41,6 +41,10 @@ class CacheManager; +/** todo checks to wrap this include properly */ +#include + + #define DEBUGSTRINGS 0 #if DEBUGSTRINGS #include "splay.h" Index: squid3/src/Store.h diff -u squid3/src/Store.h:1.43 squid3/src/Store.h:1.41.4.4 --- squid3/src/Store.h:1.43 Tue Feb 26 13:50:52 2008 +++ squid3/src/Store.h Tue Feb 26 20:28:58 2008 @@ -29,7 +29,6 @@ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA. * */ - #ifndef SQUID_STORE_H #define SQUID_STORE_H @@ -55,15 +54,13 @@ #endif class AsyncCall; - class StoreClient; - class MemObject; - class Store; - class StoreSearch; +typedef unsigned int ping_status_t; + /** \ingroup StoreAPI */ @@ -143,24 +140,18 @@ u_short flags; /* END OF ON-DISK STORE_META_STD */ -sfileno swap_filen: - 25; + sfileno swap_filen:25; -sdirno swap_dirn: - 7; + sdirno swap_dirn:7; u_short lock_count; /* Assume < 65536! */ -mem_status_t mem_status: - 3; + mem_status_t mem_status:3; -ping_status_t ping_status: - 3; + ping_status_t ping_status:3; -store_status_t store_status: - 3; + store_status_t store_status:3; -swap_status_t swap_status: - 3; + swap_status_t swap_status:3; public: static size_t inUseCount(); @@ -373,6 +364,7 @@ /// \ingroup StoreAPI SQUIDCEXTERN int storeTooManyDiskFilesOpen(void); +class SwapDir; /// \ingroup StoreAPI SQUIDCEXTERN void storeHeapPositionUpdate(StoreEntry *, SwapDir *); Index: squid3/src/StoreFileSystem.h diff -u squid3/src/StoreFileSystem.h:1.2 squid3/src/StoreFileSystem.h:1.2.38.1 --- squid3/src/StoreFileSystem.h:1.2 Sun May 28 17:50:18 2006 +++ squid3/src/StoreFileSystem.h Mon Feb 11 18:15:20 2008 @@ -41,6 +41,8 @@ class CacheManager; +class SwapDir; + class StoreFileSystem { @@ -52,7 +54,7 @@ static Vector const &FileSystems(); typedef Vector::iterator iterator; typedef Vector::const_iterator const_iterator; - StoreFileSystem() : initialised (false) {} + StoreFileSystem() : initialised(false) {} virtual ~StoreFileSystem(){} Index: squid3/src/String.cci diff -u squid3/src/String.cci:1.14 squid3/src/String.cci:1.11.4.1 --- squid3/src/String.cci:1.14 Mon Feb 11 15:50:26 2008 +++ squid3/src/String.cci Mon Feb 11 18:15:20 2008 @@ -160,7 +160,9 @@ len_ = newLength; - if(len_ == 0 && buf_ == NULL) return; // buf_ may be NULL on zero-length strings. + // buf_ may be NULL on zero-length strings. + if(len_ == 0 && buf_ == NULL) return; + buf_[newLength] = '\0'; } Index: squid3/src/SwapDir.h diff -u squid3/src/SwapDir.h:1.16 squid3/src/SwapDir.h:1.16.10.2 --- squid3/src/SwapDir.h:1.16 Thu Sep 27 17:51:09 2007 +++ squid3/src/SwapDir.h Wed Mar 5 03:13:04 2008 @@ -1,4 +1,3 @@ - /* * $Id$ * @@ -30,7 +29,6 @@ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA. * */ - #ifndef SQUID_SWAPDIR_H #define SQUID_SWAPDIR_H @@ -92,8 +90,8 @@ }; /* migrating from the Config based list of swapdirs */ -extern void allocate_new_swapdir(_SquidConfig::_cacheSwap *); -extern void free_cachedir(_SquidConfig::_cacheSwap * swap); +extern void allocate_new_swapdir(SquidConfig::_cacheSwap *); +extern void free_cachedir(SquidConfig::_cacheSwap * swap); SQUIDCEXTERN OBJH storeDirStats; SQUIDCEXTERN char *storeDirSwapLogFile(int, const char *); SQUIDCEXTERN char *storeSwapFullPath(int, char *); Index: squid3/src/access_log.cc diff -u squid3/src/access_log.cc:1.53 squid3/src/access_log.cc:1.53.2.1 --- squid3/src/access_log.cc:1.53 Wed Jan 23 13:51:00 2008 +++ squid3/src/access_log.cc Tue Feb 26 20:10:07 2008 @@ -1,4 +1,3 @@ - /* * $Id$ * @@ -396,8 +395,10 @@ LOG_QUOTE_RAW }; -struct _logformat_token +/* FIXME: public class so we can pre-define its type. */ +class logformat_token { +public: logformat_bcode_t type; union { char *string; @@ -416,14 +417,11 @@ enum log_quote quote; -unsigned int left: - 1; +unsigned int left:1; -unsigned int space: - 1; +unsigned int space:1; -unsigned int zero: - 1; +unsigned int zero:1; int divisor; logformat_token *next; /* todo: move from linked list to array */ }; Index: squid3/src/acl_noncore.cc diff -u squid3/src/acl_noncore.cc:1.6 squid3/src/acl_noncore.cc:1.6.10.1 --- squid3/src/acl_noncore.cc:1.6 Fri Aug 31 23:51:11 2007 +++ squid3/src/acl_noncore.cc Mon Feb 11 18:15:20 2008 @@ -285,7 +285,7 @@ } /* maex@space.net (06.09.1996) - * destroy an _acl_deny_info_list */ + * destroy an acl_deny_info_list */ void aclDestroyDenyInfoList(acl_deny_info_list ** list) Index: squid3/src/authenticate.cc diff -u squid3/src/authenticate.cc:1.22 squid3/src/authenticate.cc:1.21.26.1 --- squid3/src/authenticate.cc:1.22 Tue Feb 26 13:50:52 2008 +++ squid3/src/authenticate.cc Mon Feb 11 18:15:20 2008 @@ -113,41 +113,41 @@ } } +/** + \retval 0 not in use + \retval ? in use + */ int -authenticateAuthUserInuse(auth_user_t * auth_user) -/* returns 0 for not in use */ +authenticateAuthUserInuse(AuthUser * auth_user) { assert(auth_user != NULL); return auth_user->references; } void -authenticateAuthUserMerge(auth_user_t * from, auth_user_t * to) +authenticateAuthUserMerge(AuthUser * from, AuthUser * to) { to->absorb (from); } -/* - * authenticateUserCacheRestart() cleans all config-dependent data from the - * auth_user cache. It DOES NOT Flush the user cache. +/** + * Cleans all config-dependent data from the auth_user cache. + \note It DOES NOT Flush the user cache. */ - void authenticateUserCacheRestart(void) { AuthUserHashPointer *usernamehash; - auth_user_t *auth_user; - debugs(29, 3, "authenticateUserCacheRestart: Clearing config dependent cache data."); + AuthUser *auth_user; + debugs(29, 3, HERE << "Clearing config dependent cache data."); hash_first(proxy_auth_username_cache); while ((usernamehash = ((AuthUserHashPointer *) hash_next(proxy_auth_username_cache)))) { auth_user = usernamehash->user(); debugs(29, 5, "authenticateUserCacheRestat: Clearing cache ACL results for user: " << auth_user->username()); } - } -/* _auth_user_hash_pointe */ void AuthUserHashPointer::removeFromCache(void *usernamehash_p) @@ -165,14 +165,14 @@ */ } -AuthUserHashPointer::AuthUserHashPointer (AuthUser * anAuth_user): - auth_user (anAuth_user) +AuthUserHashPointer::AuthUserHashPointer(AuthUser * anAuth_user): + auth_user(anAuth_user) { key = (void *)anAuth_user->username(); next = NULL; hash_join(proxy_auth_username_cache, (hash_link *) this); - /* lock for presence in the cache */ + /** lock for presence in the cache */ auth_user->lock(); } @@ -181,5 +181,3 @@ { return auth_user; } - - Index: squid3/src/authenticate.h diff -u squid3/src/authenticate.h:1.15 squid3/src/authenticate.h:1.14.38.2 --- squid3/src/authenticate.h:1.15 Tue Feb 26 13:50:52 2008 +++ squid3/src/authenticate.h Tue Feb 26 20:28:58 2008 @@ -54,7 +54,7 @@ static void removeFromCache (void *anAuthUserHashPointer); MEMPROXY_CLASS(AuthUserHashPointer); - AuthUserHashPointer (AuthUser *); + AuthUserHashPointer(AuthUser *); AuthUser *user() const; @@ -62,7 +62,7 @@ AuthUser *auth_user; }; -MEMPROXY_CLASS_INLINE(AuthUserHashPointer) /**DOCS_NOSEMI*/ +MEMPROXY_CLASS_INLINE(AuthUserHashPointer); class ConnStateData; @@ -79,7 +79,7 @@ * subsumed by the C++ interface \todo does 'subsumed' mean deprecated use a C++ API call? */ -extern void authenticateAuthUserMerge(auth_user_t *, auth_user_t *); +extern void authenticateAuthUserMerge(AuthUser *, AuthUser *); /// \ingroup AuthAPI extern void authenticateInit(authConfig *); @@ -88,7 +88,7 @@ /// \ingroup AuthAPI extern void authenticateShutdown(void); /// \ingroup AuthAPI -extern int authenticateAuthUserInuse(auth_user_t * auth_user); +extern int authenticateAuthUserInuse(AuthUser * auth_user); /// \ingroup AuthAPI extern void authenticateFreeProxyAuthUserACLResults(void *data); Index: squid3/src/client_side_reply.cc diff -u squid3/src/client_side_reply.cc:1.127 squid3/src/client_side_reply.cc:1.125.2.3 --- squid3/src/client_side_reply.cc:1.127 Sat Feb 16 09:51:20 2008 +++ squid3/src/client_side_reply.cc Mon Mar 3 17:08:47 2008 @@ -1,4 +1,3 @@ - /* * $Id$ * @@ -33,6 +32,10 @@ * */ +/* for ClientActiveRequests global */ +#include "dlink.h" + +/* old includes without reasons given. */ #include "squid.h" #include "client_side_reply.h" #include "errorpage.h" @@ -41,7 +44,6 @@ #include "HttpReply.h" #include "HttpRequest.h" #include "forward.h" - #include "clientStream.h" #include "AuthUserRequest.h" #if USE_SQUID_ESI Index: squid3/src/debug.cc diff -u squid3/src/debug.cc:1.24 squid3/src/debug.cc:1.23.4.2 --- squid3/src/debug.cc:1.24 Tue Feb 26 10:51:03 2008 +++ squid3/src/debug.cc Wed Mar 5 03:13:04 2008 @@ -31,12 +31,17 @@ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA. * */ - +#if 0 #include "squid.h" +#endif + #include "Debug.h" #include "SquidTime.h" #include +/* for Config */ +#include "structs.h" + int Debug::Levels[MAX_DEBUG_SECTIONS]; int Debug::level; Index: squid3/src/defines.h diff -u squid3/src/defines.h:1.17 squid3/src/defines.h:1.17.4.2 --- squid3/src/defines.h:1.17 Fri Dec 14 15:51:00 2007 +++ squid3/src/defines.h Wed Mar 5 03:13:04 2008 @@ -1,4 +1,3 @@ - /* * $Id$ * @@ -30,7 +29,6 @@ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA. * */ - #ifndef SQUID_DEFINES_H #define SQUID_DEFINES_H @@ -41,6 +39,10 @@ #define FALSE 0 #endif +#ifndef BUFSIZ +#define BUFSIZ 4096 /* make unreasonable guess */ +#endif + #define ACL_NAME_SZ 32 #define BROWSERNAMELEN 128 @@ -59,7 +61,6 @@ /* Select types. */ #define COMM_SELECT_READ (0x1) #define COMM_SELECT_WRITE (0x2) -#define MAX_DEBUG_SECTIONS 100 #define COMM_NONBLOCKING 0x01 #define COMM_NOCLOEXEC 0x02 Index: squid3/src/dlink.cc diff -u /dev/null squid3/src/dlink.cc:1.1.2.1 --- /dev/null Thu Jan 1 01:00:00 1970 +++ squid3/src/dlink.cc Mon Mar 3 17:08:47 2008 @@ -0,0 +1,101 @@ +/* + * $Id$ + */ +#include "dlink.h" + +/* dlink are Mem-pooled */ +#include "MemPool.h" +/* for xstrdup() */ +#include "util.h" + + +dlink_list ClientActiveRequests; + +MemAllocator *dlink_node_pool = NULL; + +dlink_node * +dlinkNodeNew() +{ + if (dlink_node_pool == NULL) + dlink_node_pool = memPoolCreate("Dlink list nodes", sizeof(dlink_node)); + + /* where should we call delete dlink_node_pool;dlink_node_pool = NULL; */ + return (dlink_node *)dlink_node_pool->alloc(); +} + +/** The node needs to be unlinked FIRST */ +void +dlinkNodeDelete(dlink_node * m) +{ + if (m == NULL) + return; + + dlink_node_pool->free(m); +} + +void +dlinkAdd(void *data, dlink_node * m, dlink_list * list) +{ + m->data = data; + m->prev = NULL; + m->next = list->head; + + if (list->head) + list->head->prev = m; + + list->head = m; + + if (list->tail == NULL) + list->tail = m; +} + +void +dlinkAddAfter(void *data, dlink_node * m, dlink_node * n, dlink_list * list) +{ + m->data = data; + m->prev = n; + m->next = n->next; + + if (n->next) + n->next->prev = m; + else { + assert(list->tail == n); + list->tail = m; + } + + n->next = m; +} + +void +dlinkAddTail(void *data, dlink_node * m, dlink_list * list) +{ + m->data = data; + m->next = NULL; + m->prev = list->tail; + + if (list->tail) + list->tail->next = m; + + list->tail = m; + + if (list->head == NULL) + list->head = m; +} + +void +dlinkDelete(dlink_node * m, dlink_list * list) +{ + if (m->next) + m->next->prev = m->prev; + + if (m->prev) + m->prev->next = m->next; + + if (m == list->head) + list->head = m->next; + + if (m == list->tail) + list->tail = m->prev; + + m->next = m->prev = NULL; +} Index: squid3/src/dlink.h diff -u squid3/src/dlink.h:1.1 squid3/src/dlink.h:1.1.48.1 --- squid3/src/dlink.h:1.1 Sun Apr 23 04:27:37 2006 +++ squid3/src/dlink.h Mon Mar 3 17:08:47 2008 @@ -1,4 +1,3 @@ - /* * $Id$ * @@ -30,7 +29,6 @@ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA. * */ - #ifndef SQUID_DLINK_H #define SQUID_DLINK_H @@ -47,14 +45,22 @@ dlink_node *next; }; -struct _dlink_list +struct dlink_list { dlink_node *head; dlink_node *tail; }; -class dlink_node; +/* mported form globals.h */ +extern dlink_list ClientActiveRequests; + +/* imported directly from protos.h */ -typedef struct _dlink_list dlink_list; +SQUIDCEXTERN void dlinkAdd(void *data, dlink_node *, dlink_list *); +SQUIDCEXTERN void dlinkAddAfter(void *, dlink_node *, dlink_node *, dlink_list *); +SQUIDCEXTERN void dlinkAddTail(void *data, dlink_node *, dlink_list *); +SQUIDCEXTERN void dlinkDelete(dlink_node * m, dlink_list * list); +SQUIDCEXTERN void dlinkNodeDelete(dlink_node * m); +SQUIDCEXTERN dlink_node *dlinkNodeNew(void); #endif /* SQUID_DLINK_H */ Index: squid3/src/globals.h diff -u squid3/src/globals.h:1.34 squid3/src/globals.h:1.33.4.4 --- squid3/src/globals.h:1.34 Mon Feb 11 14:50:56 2008 +++ squid3/src/globals.h Wed Mar 5 03:13:04 2008 @@ -1,4 +1,3 @@ - /* * $Id$ * @@ -30,26 +29,34 @@ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA. * */ - #ifndef SQUID_GLOBALS_H #define SQUID_GLOBALS_H +#if HAVE_STDIO_H +#include +#endif + +#include "rfc2181.h" + +/* for ERROR_BUF_SZ, BUFSIZ, MAXHTTPPORTS */ +#include "defines.h" + #ifdef __cplusplus extern "C" { #endif extern FILE *debug_log; /* NULL */ - extern SquidConfig Config; - extern SquidConfig2 Config2; +//MOVED:structs.h extern SquidConfig Config; +//MOVED:structs.h extern SquidConfig2 Config2; extern char *ConfigFile; /* NULL */ extern char *IcpOpcodeStr[]; extern const char *dns_error_message; /* NULL */ extern const char *log_tags[]; extern char tmp_error_buf[ERROR_BUF_SZ]; extern char *volatile debug_options; /* NULL */ - extern char ThisCache[SQUIDHOSTNAMELEN << 1]; - extern char ThisCache2[SQUIDHOSTNAMELEN << 1]; + extern char ThisCache[RFC2181_MAXHOSTNAMELEN << 1]; + extern char ThisCache2[RFC2181_MAXHOSTNAMELEN << 1]; extern char config_input_line[BUFSIZ]; extern const char *DefaultConfigFile; /* DEFAULT_CONFIG_FILE */ extern const char *cfg_filename; /* NULL */ @@ -67,6 +74,7 @@ extern const char *pingStatusStr[]; extern const char *storeStatusStr[]; extern const char *swapStatusStr[]; + class fde; extern fde *fd_table; /* NULL */ extern int Biggest_FD; /* -1 */ extern int Number_FD; /* 0 */ @@ -79,7 +87,7 @@ extern int config_lineno; /* 0 */ extern int do_mallinfo; /* 0 */ extern int opt_reuseaddr; /* 1 */ - extern int icmp_sock; /* -1 */ +//DEAD extern int icmp_sock; /* -1 */ extern int neighbors_do_private_keys; /* 1 */ extern int opt_catch_signals; /* 1 */ extern int opt_debug_stderr; /* -1 */ @@ -109,11 +117,10 @@ extern int n_disk_objects; /* 0 */ extern iostats IOStats; - extern struct _acl_deny_info_list *DenyInfoList; /* NULL */ - - extern IPAddress theOutICPAddr; + extern struct acl_deny_info_list *DenyInfoList; /* NULL */ - extern IPAddress theOutSNMPAddr; +//MOVED:icp_v2.cc extern IPAddress theOutICPAddr; +//MOVED:snmp_core.cc extern IPAddress theOutSNMPAddr; extern struct timeval squid_start; extern int shutting_down; /* 0 */ @@ -128,7 +135,7 @@ extern double request_failure_ratio; /* 0.0 */ extern int store_hash_buckets; /* 0 */ extern hash_table *store_table; /* NULL */ - extern dlink_list ClientActiveRequests; +//MOVED:dlink.h extern dlink_list ClientActiveRequests; extern int hot_obj_count; /* 0 */ extern const int CacheDigestHashFuncCount; /* 4 */ extern CacheDigest *store_digest; /* NULL */ Index: squid3/src/icp_v2.cc diff -u squid3/src/icp_v2.cc:1.36 squid3/src/icp_v2.cc:1.35.4.2 --- squid3/src/icp_v2.cc:1.36 Tue Feb 26 13:50:53 2008 +++ squid3/src/icp_v2.cc Wed Mar 5 03:13:04 2008 @@ -48,6 +48,7 @@ #include "wordlist.h" #include "SquidTime.h" #include "SwapDir.h" +#include "IPAddress.h" /// \ingroup ServerProtocolICPInternal2 static void icpLogIcp(const IPAddress &, log_type, int, const char *, int); @@ -67,6 +68,9 @@ /// \ingroup ServerProtocolICPInternal2 static icpUdpData *IcpQueueTail = NULL; +/// \ingroup ServerProtocolICPInternal2 +IPAddress theOutICPAddr; + /* icp_common_t */ _icp_common_t::_icp_common_t() : opcode(ICP_INVALID), version(0), length(0), reqnum(0), flags(0), pad(0), shostid(0) {} Index: squid3/src/protos.h diff -u squid3/src/protos.h:1.97 squid3/src/protos.h:1.95.2.4 --- squid3/src/protos.h:1.97 Tue Feb 26 13:50:53 2008 +++ squid3/src/protos.h Mon Mar 3 17:08:47 2008 @@ -59,6 +59,7 @@ * cache_cf.c */ SQUIDCEXTERN void configFreeMemory(void); +class MemBuf; SQUIDCEXTERN void wordlistCat(const wordlist *, MemBuf * mb); SQUIDCEXTERN void self_destruct(void); SQUIDCEXTERN void add_http_port(char *portspec); @@ -185,6 +186,8 @@ /// \ingroup ServerProtocolFTPAPI SQUIDCEXTERN void ftpStart(FwdState *); +class HttpRequest; + /// \ingroup ServerProtocolFTPAPI SQUIDCEXTERN const char *ftpUrlWith2f(HttpRequest *); @@ -211,6 +214,8 @@ /* http.c */ +/* for http_hdr_type field */ +#include "HttpHeader.h" SQUIDCEXTERN int httpCachable(const HttpRequestMethod&); SQUIDCEXTERN void httpStart(FwdState *); SQUIDCEXTERN mb_size_t httpBuildRequestPrefix(HttpRequest * request, @@ -255,6 +260,7 @@ SQUIDCEXTERN void httpHdrCcStatDumper(StoreEntry * sentry, int idx, double val, double size, int count); /* Http Header Tools */ +class HttpHeaderFieldInfo; SQUIDCEXTERN HttpHeaderFieldInfo *httpHeaderBuildFieldsInfo(const HttpHeaderFieldAttrs * attrs, int count); SQUIDCEXTERN void httpHeaderDestroyFieldsInfo(HttpHeaderFieldInfo * info, int count); SQUIDCEXTERN http_hdr_type httpHeaderIdByName(const char *name, int name_len, const HttpHeaderFieldInfo * attrs, int end); @@ -433,6 +439,7 @@ SQUIDCEXTERN void peerSelectInit(void); /* peer_digest.c */ +class PeerDigest; SQUIDCEXTERN PeerDigest *peerDigestCreate(peer * p); SQUIDCEXTERN void peerDigestNeeded(PeerDigest * pd); SQUIDCEXTERN void peerDigestNotePeerGone(PeerDigest * pd); @@ -579,6 +586,7 @@ /* * store_swapin.c */ +class store_client; SQUIDCEXTERN void storeSwapInStart(store_client *); /* @@ -667,12 +675,13 @@ SQUIDCEXTERN peer_t parseNeighborType(const char *s); /* tools.c */ -SQUIDCEXTERN void dlinkAdd(void *data, dlink_node *, dlink_list *); -SQUIDCEXTERN void dlinkAddAfter(void *, dlink_node *, dlink_node *, dlink_list *); -SQUIDCEXTERN void dlinkAddTail(void *data, dlink_node *, dlink_list *); -SQUIDCEXTERN void dlinkDelete(dlink_node * m, dlink_list * list); -SQUIDCEXTERN void dlinkNodeDelete(dlink_node * m); -SQUIDCEXTERN dlink_node *dlinkNodeNew(void); +//UNUSED #include "dlink.h" +//UNUSED SQUIDCEXTERN void dlinkAdd(void *data, dlink_node *, dlink_list *); +//UNUSED SQUIDCEXTERN void dlinkAddAfter(void *, dlink_node *, dlink_node *, dlink_list *); +//UNUSED SQUIDCEXTERN void dlinkAddTail(void *data, dlink_node *, dlink_list *); +//UNUSED SQUIDCEXTERN void dlinkDelete(dlink_node * m, dlink_list * list); +//UNUSED SQUIDCEXTERN void dlinkNodeDelete(dlink_node * m); +//UNUSED SQUIDCEXTERN dlink_node *dlinkNodeNew(void); SQUIDCEXTERN void kb_incr(kb_t *, size_t); SQUIDCEXTERN int stringHasWhitespace(const char *); @@ -798,6 +807,7 @@ #endif /* external_acl.c */ +class external_acl; SQUIDCEXTERN void parse_externalAclHelper(external_acl **); SQUIDCEXTERN void dump_externalAclHelper(StoreEntry * sentry, const char *name, const external_acl *); @@ -805,7 +815,7 @@ SQUIDCEXTERN void free_externalAclHelper(external_acl **); typedef void EAH(void *data, void *result); - +class ACLChecklist; SQUIDCEXTERN void externalAclLookup(ACLChecklist * ch, void *acl_data, EAH * handler, void *data); SQUIDCEXTERN void externalAclInit(void); Index: squid3/src/snmp_core.cc diff -u squid3/src/snmp_core.cc:1.25 squid3/src/snmp_core.cc:1.25.2.1 --- squid3/src/snmp_core.cc:1.25 Tue Jan 22 13:50:57 2008 +++ squid3/src/snmp_core.cc Wed Mar 5 03:13:04 2008 @@ -1,4 +1,3 @@ - /* * $Id$ * @@ -36,10 +35,13 @@ #include "comm.h" #include "cache_snmp.h" #include "ACLChecklist.h" +#include "IPAddress.h" #define SNMP_REQUEST_SIZE 4096 #define MAX_PROTOSTAT 5 +IPAddress theOutSNMPAddr; + typedef struct _mib_tree_entry mib_tree_entry; typedef oid *(instance_Fn) (oid * name, snint * len, mib_tree_entry * current, oid_ParseFn ** Fn); Index: squid3/src/squid.h diff -u squid3/src/squid.h:1.44 squid3/src/squid.h:1.43.2.3 --- squid3/src/squid.h:1.44 Tue Feb 26 13:50:53 2008 +++ squid3/src/squid.h Wed Mar 5 03:13:05 2008 @@ -255,7 +255,9 @@ #include #endif +#if 0 // moved to include/rfc2181.h - RFC defined constants #define SQUIDHOSTNAMELEN 256 +#endif #define SQUID_MAXPATHLEN 256 #ifndef MAXPATHLEN @@ -299,11 +301,6 @@ SQUIDCEXTERN size_t getpagesize(void); #endif /* _SQUID_MSWIN_ */ -#ifndef BUFSIZ -#define BUFSIZ 4096 /* make reasonable guess */ -#endif - - #ifndef SA_RESTART #define SA_RESTART 0 #endif Index: squid3/src/structs.h diff -u squid3/src/structs.h:1.128 squid3/src/structs.h:1.127.2.5 --- squid3/src/structs.h:1.128 Mon Feb 11 14:50:56 2008 +++ squid3/src/structs.h Wed Mar 5 03:13:05 2008 @@ -1,4 +1,3 @@ - /* * $Id$ * @@ -30,7 +29,6 @@ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA. * */ - #ifndef SQUID_STRUCTS_H #define SQUID_STRUCTS_H @@ -43,13 +41,13 @@ /* needed for the global config */ #include "HttpHeader.h" -struct _acl_name_list +struct acl_name_list { char name[ACL_NAME_SZ]; acl_name_list *next; }; -struct _acl_deny_info_list +struct acl_deny_info_list { err_type err_page_id; char *err_page_name; @@ -66,6 +64,8 @@ char *replacement; }; +class ACLChecklist; + #if SQUID_SNMP struct _snmp_request_t @@ -88,8 +88,9 @@ #endif +class ACLList; -struct _acl_address +struct acl_address { acl_address *next; ACLList *aclList; @@ -97,27 +98,27 @@ IPAddress addr; }; -struct _acl_tos +struct acl_tos { acl_tos *next; ACLList *aclList; int tos; }; -struct _acl_size_t +struct acl_size_t { acl_size_t *next; ACLList *aclList; int64_t size; }; -struct _ushortlist +struct ushortlist { u_short i; ushortlist *next; }; -struct _relist +struct relist { char *pattern; regex_t regex; @@ -135,13 +136,10 @@ /* forward decl for SquidConfig, see RemovalPolicy.h */ class RemovalPolicySettings; - - class external_acl; - class Store; -struct _SquidConfig +struct SquidConfig { struct @@ -694,9 +692,10 @@ char *accept_filter; }; -struct _SquidConfig2 -{ +SQUIDCEXTERN SquidConfig Config; +struct SquidConfig2 +{ struct { int enable_purge; @@ -708,6 +707,8 @@ gid_t effectiveGroupID; }; +SQUIDCEXTERN SquidConfig2 Config2; + struct _close_handler { PF *handler; @@ -917,7 +918,9 @@ #endif -struct _peer +class PeerDigest; + +struct peer { u_int index; char *name; @@ -1594,6 +1597,8 @@ int syslog_priority; }; +class logformat_token; + struct _logformat { char *name; Index: squid3/src/tools.cc diff -u squid3/src/tools.cc:1.51 squid3/src/tools.cc:1.50.4.2 --- squid3/src/tools.cc:1.51 Mon Feb 11 14:50:56 2008 +++ squid3/src/tools.cc Mon Mar 3 17:08:47 2008 @@ -84,8 +84,6 @@ SQUIDCEXTERN void (*failure_notify) (const char *); -MemAllocator *dlink_node_pool = NULL; - void releaseServerSockets(void) {