14b22b933Srs /* -*- Mode: C; tab-width: 4 -*-
24b22b933Srs  *
3*472cd20dSToomas Soome  * Copyright (c) 2002-2020 Apple Inc. All rights reserved.
44b22b933Srs  *
54b22b933Srs  * Licensed under the Apache License, Version 2.0 (the "License");
64b22b933Srs  * you may not use this file except in compliance with the License.
74b22b933Srs  * You may obtain a copy of the License at
85ffb0c9bSToomas Soome  *
94b22b933Srs  *     http://www.apache.org/licenses/LICENSE-2.0
105ffb0c9bSToomas Soome  *
114b22b933Srs  * Unless required by applicable law or agreed to in writing, software
124b22b933Srs  * distributed under the License is distributed on an "AS IS" BASIS,
134b22b933Srs  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
144b22b933Srs  * See the License for the specific language governing permissions and
154b22b933Srs  * limitations under the License.
164b22b933Srs  */
174b22b933Srs 
184b22b933Srs #ifndef __DNSCOMMON_H_
194b22b933Srs #define __DNSCOMMON_H_
204b22b933Srs 
214b22b933Srs #include "mDNSEmbeddedAPI.h"
224b22b933Srs 
235ffb0c9bSToomas Soome #ifdef  __cplusplus
245ffb0c9bSToomas Soome extern "C" {
254b22b933Srs #endif
264b22b933Srs 
275ffb0c9bSToomas Soome //*************************************************************************************************************
285ffb0c9bSToomas Soome // Macros
295ffb0c9bSToomas Soome 
305ffb0c9bSToomas Soome // Note: The C preprocessor stringify operator ('#') makes a string from its argument, without macro expansion
315ffb0c9bSToomas Soome // e.g. If "version" is #define'd to be "4", then STRINGIFY_AWE(version) will return the string "version", not "4"
325ffb0c9bSToomas Soome // To expand "version" to its value before making the string, use STRINGIFY(version) instead
335ffb0c9bSToomas Soome #define STRINGIFY_ARGUMENT_WITHOUT_EXPANSION(s) # s
345ffb0c9bSToomas Soome #define STRINGIFY(s) STRINGIFY_ARGUMENT_WITHOUT_EXPANSION(s)
354b22b933Srs 
364b22b933Srs // ***************************************************************************
374b22b933Srs #if COMPILER_LIKES_PRAGMA_MARK
384b22b933Srs #pragma mark - DNS Protocol Constants
394b22b933Srs #endif
404b22b933Srs 
414b22b933Srs typedef enum
425ffb0c9bSToomas Soome {
43c65ebfc7SToomas Soome     kDNSFlag0_QR_Mask        = 0x80,    // Query or response?
44c65ebfc7SToomas Soome     kDNSFlag0_QR_Query       = 0x00,
45c65ebfc7SToomas Soome     kDNSFlag0_QR_Response    = 0x80,
46c65ebfc7SToomas Soome 
47*472cd20dSToomas Soome     kDNSFlag0_OP_Mask        = 0xF << 3, // Operation type
48*472cd20dSToomas Soome     kDNSFlag0_OP_StdQuery    = 0x0 << 3,
49*472cd20dSToomas Soome     kDNSFlag0_OP_Iquery      = 0x1 << 3,
50*472cd20dSToomas Soome     kDNSFlag0_OP_Status      = 0x2 << 3,
51*472cd20dSToomas Soome     kDNSFlag0_OP_Unused3     = 0x3 << 3,
52*472cd20dSToomas Soome     kDNSFlag0_OP_Notify      = 0x4 << 3,
53*472cd20dSToomas Soome     kDNSFlag0_OP_Update      = 0x5 << 3,
54*472cd20dSToomas Soome     kDNSFlag0_OP_DSO         = 0x6 << 3,
555ffb0c9bSToomas Soome 
565ffb0c9bSToomas Soome     kDNSFlag0_QROP_Mask   = kDNSFlag0_QR_Mask | kDNSFlag0_OP_Mask,
575ffb0c9bSToomas Soome 
585ffb0c9bSToomas Soome     kDNSFlag0_AA          = 0x04,       // Authoritative Answer?
595ffb0c9bSToomas Soome     kDNSFlag0_TC          = 0x02,       // Truncated?
605ffb0c9bSToomas Soome     kDNSFlag0_RD          = 0x01,       // Recursion Desired?
615ffb0c9bSToomas Soome     kDNSFlag1_RA          = 0x80,       // Recursion Available?
625ffb0c9bSToomas Soome 
635ffb0c9bSToomas Soome     kDNSFlag1_Zero        = 0x40,       // Reserved; must be zero
645ffb0c9bSToomas Soome     kDNSFlag1_AD          = 0x20,       // Authentic Data [RFC 2535]
655ffb0c9bSToomas Soome     kDNSFlag1_CD          = 0x10,       // Checking Disabled [RFC 2535]
665ffb0c9bSToomas Soome 
675ffb0c9bSToomas Soome     kDNSFlag1_RC_Mask     = 0x0F,       // Response code
685ffb0c9bSToomas Soome     kDNSFlag1_RC_NoErr    = 0x00,
695ffb0c9bSToomas Soome     kDNSFlag1_RC_FormErr  = 0x01,
705ffb0c9bSToomas Soome     kDNSFlag1_RC_ServFail = 0x02,
715ffb0c9bSToomas Soome     kDNSFlag1_RC_NXDomain = 0x03,
725ffb0c9bSToomas Soome     kDNSFlag1_RC_NotImpl  = 0x04,
735ffb0c9bSToomas Soome     kDNSFlag1_RC_Refused  = 0x05,
745ffb0c9bSToomas Soome     kDNSFlag1_RC_YXDomain = 0x06,
755ffb0c9bSToomas Soome     kDNSFlag1_RC_YXRRSet  = 0x07,
765ffb0c9bSToomas Soome     kDNSFlag1_RC_NXRRSet  = 0x08,
775ffb0c9bSToomas Soome     kDNSFlag1_RC_NotAuth  = 0x09,
78*472cd20dSToomas Soome     kDNSFlag1_RC_NotZone  = 0x0A,
79*472cd20dSToomas Soome 	kDNSFlag1_RC_DSOTypeNI = 0x0B
805ffb0c9bSToomas Soome } DNS_Flags;
814b22b933Srs 
824b22b933Srs typedef enum
835ffb0c9bSToomas Soome {
845ffb0c9bSToomas Soome     TSIG_ErrBadSig  = 16,
855ffb0c9bSToomas Soome     TSIG_ErrBadKey  = 17,
865ffb0c9bSToomas Soome     TSIG_ErrBadTime = 18
875ffb0c9bSToomas Soome } TSIG_ErrorCode;
884b22b933Srs 
89c65ebfc7SToomas Soome 
904b22b933Srs // ***************************************************************************
914b22b933Srs #if COMPILER_LIKES_PRAGMA_MARK
924b22b933Srs #pragma mark -
934b22b933Srs #pragma mark - General Utility Functions
944b22b933Srs #endif
954b22b933Srs 
965ffb0c9bSToomas Soome extern NetworkInterfaceInfo *GetFirstActiveInterface(NetworkInterfaceInfo *intf);
974b22b933Srs extern mDNSInterfaceID GetNextActiveInterfaceID(const NetworkInterfaceInfo *intf);
984b22b933Srs 
995ffb0c9bSToomas Soome extern mDNSu32 mDNSRandom(mDNSu32 max);     // Returns pseudo-random result from zero to max inclusive
1004b22b933Srs 
101*472cd20dSToomas Soome #if !MDNSRESPONDER_SUPPORTS(APPLE, QUERIER)
102*472cd20dSToomas Soome extern mDNSu32 mDNS_GetNextResolverGroupID(void);
103*472cd20dSToomas Soome #endif
104*472cd20dSToomas Soome 
1054b22b933Srs // ***************************************************************************
1064b22b933Srs #if COMPILER_LIKES_PRAGMA_MARK
1074b22b933Srs #pragma mark -
1084b22b933Srs #pragma mark - Domain Name Utility Functions
1094b22b933Srs #endif
1105ffb0c9bSToomas Soome 
1115ffb0c9bSToomas Soome #define mDNSSubTypeLabel   "\x04_sub"
1125ffb0c9bSToomas Soome 
1135ffb0c9bSToomas Soome #define mDNSIsDigit(X)     ((X) >= '0' && (X) <= '9')
1144b22b933Srs #define mDNSIsUpperCase(X) ((X) >= 'A' && (X) <= 'Z')
1154b22b933Srs #define mDNSIsLowerCase(X) ((X) >= 'a' && (X) <= 'z')
1165ffb0c9bSToomas Soome #define mDNSIsLetter(X)    (mDNSIsUpperCase(X) || mDNSIsLowerCase(X))
1173b436d06SToomas Soome 
1183b436d06SToomas Soome // We believe we have adequate safeguards to protect against cache poisoning.
1193b436d06SToomas Soome // In the event that someone does find a workable cache poisoning attack, we want to limit the lifetime of the poisoned entry.
1203b436d06SToomas Soome // We set the maximum allowable TTL to one hour.
1213b436d06SToomas Soome // With the 25% correction factor to avoid the DNS Zeno's paradox bug, that gives us an actual maximum lifetime of 75 minutes.
1223b436d06SToomas Soome 
123*472cd20dSToomas Soome #define mDNSMaximumMulticastTTLSeconds  (mDNSu32)4500
124*472cd20dSToomas Soome #define mDNSMaximumUnicastTTLSeconds    (mDNSu32)3600
1255ffb0c9bSToomas Soome 
1265ffb0c9bSToomas Soome #define mDNSValidHostChar(X, notfirst, notlast) (mDNSIsLetter(X) || mDNSIsDigit(X) || ((notfirst) && (notlast) && (X) == '-') )
1274b22b933Srs 
1284b22b933Srs extern mDNSu16 CompressedDomainNameLength(const domainname *const name, const domainname *parent);
1295ffb0c9bSToomas Soome extern int CountLabels(const domainname *d);
1305ffb0c9bSToomas Soome extern const domainname *SkipLeadingLabels(const domainname *d, int skip);
1314b22b933Srs 
1324b22b933Srs extern mDNSu32 TruncateUTF8ToLength(mDNSu8 *string, mDNSu32 length, mDNSu32 max);
1334b22b933Srs extern mDNSBool LabelContainsSuffix(const domainlabel *const name, const mDNSBool RichText);
1344b22b933Srs extern mDNSu32 RemoveLabelSuffix(domainlabel *name, mDNSBool RichText);
1355ffb0c9bSToomas Soome extern void AppendLabelSuffix(domainlabel *const name, mDNSu32 val, const mDNSBool RichText);
1364b22b933Srs #define ValidateDomainName(N) (DomainNameLength(N) <= MAX_DOMAIN_NAME)
1374b22b933Srs 
1384b22b933Srs // ***************************************************************************
1394b22b933Srs #if COMPILER_LIKES_PRAGMA_MARK
1404b22b933Srs #pragma mark -
1414b22b933Srs #pragma mark - Resource Record Utility Functions
1424b22b933Srs #endif
1434b22b933Srs 
1445ffb0c9bSToomas Soome // IdenticalResourceRecord returns true if two resources records have
1455ffb0c9bSToomas Soome // the same name, type, class, and identical rdata (InterfaceID and TTL may differ)
1465ffb0c9bSToomas Soome 
1475ffb0c9bSToomas Soome // IdenticalSameNameRecord is the same, except it skips the expensive SameDomainName() check,
1485ffb0c9bSToomas Soome // which is at its most expensive and least useful in cases where we know in advance that the names match
1495ffb0c9bSToomas Soome 
1505ffb0c9bSToomas Soome // Note: The dominant use of IdenticalResourceRecord is from ProcessQuery(), handling known-answer lists. In this case
1515ffb0c9bSToomas Soome // it's common to have a whole bunch or records with exactly the same name (e.g. "_http._tcp.local") but different RDATA.
1525ffb0c9bSToomas Soome // The SameDomainName() check is expensive when the names match, and in this case *all* the names match, so we
1535ffb0c9bSToomas Soome // used to waste a lot of CPU time verifying that the names match, only then to find that the RDATA is different.
1545ffb0c9bSToomas Soome // We observed mDNSResponder spending 30% of its total CPU time on this single task alone.
1555ffb0c9bSToomas Soome // By swapping the checks so that we check the RDATA first, we can quickly detect when it's different
1565ffb0c9bSToomas Soome // (99% of the time) and then bail out before we waste time on the expensive SameDomainName() check.
1575ffb0c9bSToomas Soome 
1585ffb0c9bSToomas Soome #define IdenticalResourceRecord(r1,r2) ( \
1595ffb0c9bSToomas Soome         (r1)->rrtype    == (r2)->rrtype      && \
1605ffb0c9bSToomas Soome         (r1)->rrclass   == (r2)->rrclass     && \
1615ffb0c9bSToomas Soome         (r1)->namehash  == (r2)->namehash    && \
1625ffb0c9bSToomas Soome         (r1)->rdlength  == (r2)->rdlength    && \
1635ffb0c9bSToomas Soome         (r1)->rdatahash == (r2)->rdatahash   && \
1645ffb0c9bSToomas Soome         SameRDataBody((r1), &(r2)->rdata->u, SameDomainName) && \
1655ffb0c9bSToomas Soome         SameDomainName((r1)->name, (r2)->name))
1665ffb0c9bSToomas Soome 
1675ffb0c9bSToomas Soome #define IdenticalSameNameRecord(r1,r2) ( \
1685ffb0c9bSToomas Soome         (r1)->rrtype    == (r2)->rrtype      && \
1695ffb0c9bSToomas Soome         (r1)->rrclass   == (r2)->rrclass     && \
1705ffb0c9bSToomas Soome         (r1)->rdlength  == (r2)->rdlength    && \
1715ffb0c9bSToomas Soome         (r1)->rdatahash == (r2)->rdatahash   && \
1725ffb0c9bSToomas Soome         SameRDataBody((r1), &(r2)->rdata->u, SameDomainName))
1735ffb0c9bSToomas Soome 
1745ffb0c9bSToomas Soome // A given RRType answers a QuestionType if RRType is CNAME, or types match, or QuestionType is ANY,
1755ffb0c9bSToomas Soome // or the RRType is NSEC and positively asserts the nonexistence of the type being requested
1765ffb0c9bSToomas Soome #define RRTypeAnswersQuestionType(R,Q) ((R)->rrtype == kDNSType_CNAME || (R)->rrtype == (Q) || (Q) == kDNSQType_ANY || RRAssertsNonexistence((R),(Q)))
1775ffb0c9bSToomas Soome // Unicast NSEC records have the NSEC bit set whereas the multicast NSEC ones don't
1785ffb0c9bSToomas Soome #define UNICAST_NSEC(rr) ((rr)->rrtype == kDNSType_NSEC && RRAssertsExistence((rr), kDNSType_NSEC))
1795ffb0c9bSToomas Soome 
1805ffb0c9bSToomas Soome extern mDNSu32 RDataHashValue(const ResourceRecord *const rr);
1815ffb0c9bSToomas Soome extern mDNSBool SameRDataBody(const ResourceRecord *const r1, const RDataBody *const r2, DomainNameComparisonFn *samename);
182*472cd20dSToomas Soome extern mDNSBool SameNameCacheRecordAnswersQuestion(const CacheRecord *const cr, const DNSQuestion *const q);
1834b22b933Srs extern mDNSBool ResourceRecordAnswersQuestion(const ResourceRecord *const rr, const DNSQuestion *const q);
184*472cd20dSToomas Soome extern mDNSBool AuthRecordAnswersQuestion(const AuthRecord *const ar, const DNSQuestion *const q);
185*472cd20dSToomas Soome extern mDNSBool CacheRecordAnswersQuestion(const CacheRecord *const cr, const DNSQuestion *const q);
186*472cd20dSToomas Soome extern mDNSBool AnyTypeRecordAnswersQuestion (const AuthRecord *const ar, const DNSQuestion *const q);
1875ffb0c9bSToomas Soome extern mDNSBool ResourceRecordAnswersUnicastResponse(const ResourceRecord *const rr, const DNSQuestion *const q);
1885ffb0c9bSToomas Soome extern mDNSBool LocalOnlyRecordAnswersQuestion(AuthRecord *const rr, const DNSQuestion *const q);
1894b22b933Srs extern mDNSu16 GetRDLength(const ResourceRecord *const rr, mDNSBool estimate);
1905ffb0c9bSToomas Soome extern mDNSBool ValidateRData(const mDNSu16 rrtype, const mDNSu16 rdlength, const RData *const rd);
1915ffb0c9bSToomas Soome extern mStatus DNSNameToLowerCase(domainname *d, domainname *result);
1924b22b933Srs 
1934b22b933Srs #define GetRRDomainNameTarget(RR) (                                                                          \
1945ffb0c9bSToomas Soome         ((RR)->rrtype == kDNSType_NS || (RR)->rrtype == kDNSType_CNAME || (RR)->rrtype == kDNSType_PTR || (RR)->rrtype == kDNSType_DNAME) ? &(RR)->rdata->u.name        : \
1955ffb0c9bSToomas Soome         ((RR)->rrtype == kDNSType_MX || (RR)->rrtype == kDNSType_AFSDB || (RR)->rrtype == kDNSType_RT  || (RR)->rrtype == kDNSType_KX   ) ? &(RR)->rdata->u.mx.exchange : \
1965ffb0c9bSToomas Soome         ((RR)->rrtype == kDNSType_SRV                                  ) ? &(RR)->rdata->u.srv.target : mDNSNULL )
1974b22b933Srs 
1985ffb0c9bSToomas Soome #define LocalRecordReady(X) ((X)->resrec.RecordType != kDNSRecordTypeUnique)
1994b22b933Srs 
2004b22b933Srs // ***************************************************************************
2014b22b933Srs #if COMPILER_LIKES_PRAGMA_MARK
2024b22b933Srs #pragma mark -
2034b22b933Srs #pragma mark - DNS Message Creation Functions
2044b22b933Srs #endif
2054b22b933Srs 
2064b22b933Srs extern void InitializeDNSMessage(DNSMessageHeader *h, mDNSOpaque16 id, mDNSOpaque16 flags);
2074b22b933Srs extern const mDNSu8 *FindCompressionPointer(const mDNSu8 *const base, const mDNSu8 *const end, const mDNSu8 *const domname);
2084b22b933Srs extern mDNSu8 *putDomainNameAsLabels(const DNSMessage *const msg, mDNSu8 *ptr, const mDNSu8 *const limit, const domainname *const name);
2095ffb0c9bSToomas Soome extern mDNSu8 *putRData(const DNSMessage *const msg, mDNSu8 *ptr, const mDNSu8 *const limit, const ResourceRecord *const rr);
2104b22b933Srs 
2114b22b933Srs // If we have a single large record to put in the packet, then we allow the packet to be up to 9K bytes,
2125ffb0c9bSToomas Soome // but in the normal case we try to keep the packets below 1500 to avoid IP fragmentation on standard Ethernet
2134b22b933Srs 
2145ffb0c9bSToomas Soome #define AllowedRRSpace(msg) (((msg)->h.numAnswers || (msg)->h.numAuthorities || (msg)->h.numAdditionals) ? NormalMaxDNSMessageData : AbsoluteMaxDNSMessageData)
2154b22b933Srs 
216*472cd20dSToomas Soome extern mDNSu8 *PutResourceRecordTTLWithLimit(DNSMessage *const msg, mDNSu8 *ptr, mDNSu16 *count, const ResourceRecord *rr,
217*472cd20dSToomas Soome     mDNSu32 ttl, const mDNSu8 *limit);
2184b22b933Srs 
2195ffb0c9bSToomas Soome #define PutResourceRecordTTL(msg, ptr, count, rr, ttl) \
2205ffb0c9bSToomas Soome     PutResourceRecordTTLWithLimit((msg), (ptr), (count), (rr), (ttl), (msg)->data + AllowedRRSpace(msg))
2214b22b933Srs 
2225ffb0c9bSToomas Soome #define PutResourceRecordTTLJumbo(msg, ptr, count, rr, ttl) \
2235ffb0c9bSToomas Soome     PutResourceRecordTTLWithLimit((msg), (ptr), (count), (rr), (ttl), (msg)->data + AbsoluteMaxDNSMessageData)
2244b22b933Srs 
2255ffb0c9bSToomas Soome #define PutResourceRecord(MSG, P, C, RR) PutResourceRecordTTL((MSG), (P), (C), (RR), (RR)->rroriginalttl)
2264b22b933Srs 
2275ffb0c9bSToomas Soome // The PutRR_OS variants assume a local variable 'm', put build the packet at m->omsg,
2285ffb0c9bSToomas Soome // and assume local variables 'OwnerRecordSpace' & 'TraceRecordSpace' indicating how many bytes (if any) to reserve to add an OWNER/TRACER option at the end
2295ffb0c9bSToomas Soome #define PutRR_OS_TTL(ptr, count, rr, ttl) \
2305ffb0c9bSToomas Soome     PutResourceRecordTTLWithLimit(&m->omsg, (ptr), (count), (rr), (ttl), m->omsg.data + AllowedRRSpace(&m->omsg) - OwnerRecordSpace - TraceRecordSpace)
2314b22b933Srs 
2325ffb0c9bSToomas Soome #define PutRR_OS(P, C, RR) PutRR_OS_TTL((P), (C), (RR), (RR)->rroriginalttl)
2334b22b933Srs 
2345ffb0c9bSToomas Soome extern mDNSu8 *putQuestion(DNSMessage *const msg, mDNSu8 *ptr, const mDNSu8 *const limit, const domainname *const name, mDNSu16 rrtype, mDNSu16 rrclass);
2355ffb0c9bSToomas Soome extern mDNSu8 *putZone(DNSMessage *const msg, mDNSu8 *ptr, mDNSu8 *limit, const domainname *zone, mDNSOpaque16 zoneClass);
2365ffb0c9bSToomas Soome extern mDNSu8 *putPrereqNameNotInUse(const domainname *const name, DNSMessage *const msg, mDNSu8 *const ptr, mDNSu8 *const end);
2374b22b933Srs extern mDNSu8 *putDeletionRecord(DNSMessage *msg, mDNSu8 *ptr, ResourceRecord *rr);
2385ffb0c9bSToomas Soome extern mDNSu8 *putDeletionRecordWithLimit(DNSMessage *msg, mDNSu8 *ptr, ResourceRecord *rr, mDNSu8 *limit);
2395ffb0c9bSToomas Soome extern mDNSu8 *putDeleteRRSetWithLimit(DNSMessage *msg, mDNSu8 *ptr, const domainname *name, mDNSu16 rrtype, mDNSu8 *limit);
2404b22b933Srs extern mDNSu8 *putDeleteAllRRSets(DNSMessage *msg, mDNSu8 *ptr, const domainname *name);
241cda73f64SToomas Soome extern mDNSu8 *putUpdateLease(DNSMessage *msg, mDNSu8 *ptr, mDNSu32 lease);
2425ffb0c9bSToomas Soome extern mDNSu8 *putUpdateLeaseWithLimit(DNSMessage *msg, mDNSu8 *ptr, mDNSu32 lease, mDNSu8 *limit);
2435ffb0c9bSToomas Soome 
2445ffb0c9bSToomas Soome extern int baseEncode(char *buffer, int blen, const mDNSu8 *data, int len, int encAlg);
2455ffb0c9bSToomas Soome extern void NSEC3Parse(const ResourceRecord *const rr, mDNSu8 **salt, int *hashLength, mDNSu8 **nxtName, int *bitmaplen, mDNSu8 **bitmap);
2464b22b933Srs 
2474b22b933Srs // ***************************************************************************
2484b22b933Srs #if COMPILER_LIKES_PRAGMA_MARK
2494b22b933Srs #pragma mark -
2504b22b933Srs #pragma mark - DNS Message Parsing Functions
2514b22b933Srs #endif
2524b22b933Srs 
253c65ebfc7SToomas Soome #define HashSlotFromNameHash(X) ((X) % CACHE_HASH_SLOTS)
2544b22b933Srs extern mDNSu32 DomainNameHashValue(const domainname *const name);
2554b22b933Srs extern void SetNewRData(ResourceRecord *const rr, RData *NewRData, mDNSu16 rdlength);
2564b22b933Srs extern const mDNSu8 *skipDomainName(const DNSMessage *const msg, const mDNSu8 *ptr, const mDNSu8 *const end);
2574b22b933Srs extern const mDNSu8 *getDomainName(const DNSMessage *const msg, const mDNSu8 *ptr, const mDNSu8 *const end,
2585ffb0c9bSToomas Soome                                    domainname *const name);
2594b22b933Srs extern const mDNSu8 *skipResourceRecord(const DNSMessage *msg, const mDNSu8 *ptr, const mDNSu8 *end);
2605ffb0c9bSToomas Soome extern const mDNSu8 *GetLargeResourceRecord(mDNS *const m, const DNSMessage * const msg, const mDNSu8 *ptr,
2615ffb0c9bSToomas Soome                                             const mDNSu8 * end, const mDNSInterfaceID InterfaceID, mDNSu8 RecordType, LargeCacheRecord *const largecr);
262*472cd20dSToomas Soome extern mDNSBool SetRData(const DNSMessage *const msg, const mDNSu8 *ptr, const mDNSu8 *end, ResourceRecord *rr,
263*472cd20dSToomas Soome     mDNSu16 rdlength);
2644b22b933Srs extern const mDNSu8 *skipQuestion(const DNSMessage *msg, const mDNSu8 *ptr, const mDNSu8 *end);
2654b22b933Srs extern const mDNSu8 *getQuestion(const DNSMessage *msg, const mDNSu8 *ptr, const mDNSu8 *end, const mDNSInterfaceID InterfaceID,
2665ffb0c9bSToomas Soome                                  DNSQuestion *question);
2674b22b933Srs extern const mDNSu8 *LocateAnswers(const DNSMessage *const msg, const mDNSu8 *const end);
2684b22b933Srs extern const mDNSu8 *LocateAuthorities(const DNSMessage *const msg, const mDNSu8 *const end);
2694b22b933Srs extern const mDNSu8 *LocateAdditionals(const DNSMessage *const msg, const mDNSu8 *const end);
2705ffb0c9bSToomas Soome extern const mDNSu8 *LocateOptRR(const DNSMessage *const msg, const mDNSu8 *const end, int minsize);
2715ffb0c9bSToomas Soome extern const rdataOPT *GetLLQOptData(mDNS *const m, const DNSMessage *const msg, const mDNSu8 *const end);
272c65ebfc7SToomas Soome extern mDNSBool GetPktLease(mDNS *const m, const DNSMessage *const msg, const mDNSu8 *const end, mDNSu32 *const lease);
273*472cd20dSToomas Soome extern void DumpPacket(mStatus status, mDNSBool sent, const char *transport, const mDNSAddr *srcaddr, mDNSIPPort srcport,
274*472cd20dSToomas Soome     const mDNSAddr *dstaddr, mDNSIPPort dstport, const DNSMessage *const msg, const mDNSu8 *const end,
275*472cd20dSToomas Soome     mDNSInterfaceID interfaceID);
2765ffb0c9bSToomas Soome extern mDNSBool RRAssertsNonexistence(const ResourceRecord *const rr, mDNSu16 type);
2775ffb0c9bSToomas Soome extern mDNSBool RRAssertsExistence(const ResourceRecord *const rr, mDNSu16 type);
2785ffb0c9bSToomas Soome extern mDNSBool BitmapTypeCheck(mDNSu8 *bmap, int bitmaplen, mDNSu16 type);
2795ffb0c9bSToomas Soome 
2805ffb0c9bSToomas Soome extern mDNSu16 swap16(mDNSu16 x);
2815ffb0c9bSToomas Soome extern mDNSu32 swap32(mDNSu32 x);
2824b22b933Srs 
283*472cd20dSToomas Soome extern mDNSBool GetReverseIPv6Addr(const domainname *inQName, mDNSu8 outIPv6[16]);
284*472cd20dSToomas Soome 
2854b22b933Srs // ***************************************************************************
2864b22b933Srs #if COMPILER_LIKES_PRAGMA_MARK
2874b22b933Srs #pragma mark -
2884b22b933Srs #pragma mark - Packet Sending Functions
2894b22b933Srs #endif
2905ffb0c9bSToomas Soome extern mStatus mDNSSendDNSMessage(mDNS *const m, DNSMessage *const msg, mDNSu8 *end,
291*472cd20dSToomas Soome                                   mDNSInterfaceID InterfaceID, TCPSocket *tcpSrc, UDPSocket *udpSrc, const mDNSAddr *dst,
292*472cd20dSToomas Soome                                   mDNSIPPort dstport, DomainAuthInfo *authInfo, mDNSBool useBackgroundTrafficClass);
2934b22b933Srs 
2944b22b933Srs // ***************************************************************************
2954b22b933Srs #if COMPILER_LIKES_PRAGMA_MARK
2964b22b933Srs #pragma mark -
2974b22b933Srs #pragma mark - RR List Management & Task Management
2984b22b933Srs #endif
2994b22b933Srs 
3005ffb0c9bSToomas Soome extern void ShowTaskSchedulingError(mDNS *const m);
3015ffb0c9bSToomas Soome extern void mDNS_Lock_(mDNS *const m, const char * const functionname);
3025ffb0c9bSToomas Soome extern void mDNS_Unlock_(mDNS *const m, const char * const functionname);
303*472cd20dSToomas Soome 
3045ffb0c9bSToomas Soome #if defined(_WIN32)
3055ffb0c9bSToomas Soome  #define __func__ __FUNCTION__
3065ffb0c9bSToomas Soome #endif
3075ffb0c9bSToomas Soome 
3085ffb0c9bSToomas Soome #define mDNS_Lock(X) mDNS_Lock_((X), __func__)
3095ffb0c9bSToomas Soome 
3105ffb0c9bSToomas Soome #define mDNS_Unlock(X) mDNS_Unlock_((X), __func__)
3115ffb0c9bSToomas Soome 
312cda73f64SToomas Soome #define mDNS_CheckLock(X) \
313cda73f64SToomas Soome     if ((X)->mDNS_busy != (X)->mDNS_reentrancy+1) LogMsg("%s: Lock not held! mDNS_busy (%ld) mDNS_reentrancy (%ld)", __func__, (X)->mDNS_busy, (X)->mDNS_reentrancy)
3145ffb0c9bSToomas Soome 
3155ffb0c9bSToomas Soome #define mDNS_DropLockBeforeCallback() do { m->mDNS_reentrancy++; \
316cda73f64SToomas Soome     if (m->mDNS_busy != m->mDNS_reentrancy) LogMsg("%s: Locking Failure! mDNS_busy (%ld) != mDNS_reentrancy (%ld)", __func__, m->mDNS_busy, m->mDNS_reentrancy); \
317cda73f64SToomas Soome     } while (0)
3185ffb0c9bSToomas Soome 
3195ffb0c9bSToomas Soome #define mDNS_ReclaimLockAfterCallback() do { \
320cda73f64SToomas Soome     if (m->mDNS_busy != m->mDNS_reentrancy) LogMsg("%s: Unlocking Failure! mDNS_busy (%ld) != mDNS_reentrancy (%ld)", __func__, m->mDNS_busy, m->mDNS_reentrancy); \
321cda73f64SToomas Soome     m->mDNS_reentrancy--; } while (0)
3224b22b933Srs 
3235ffb0c9bSToomas Soome #ifdef  __cplusplus
3245ffb0c9bSToomas Soome }
3254b22b933Srs #endif
3264b22b933Srs 
3274b22b933Srs #endif // __DNSCOMMON_H_
328