xref: /illumos-gate/usr/src/contrib/mDNSResponder/mDNSCore/mDNS.c (revision 6523a3aa7f325d64841382707603be7a86e68147)
1 /* -*- Mode: C; tab-width: 4 -*-
2  *
3  * Copyright (c) 2002-2018 Apple Inc. All rights reserved.
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  *     http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  * This code is completely 100% portable C. It does not depend on any external header files
18  * from outside the mDNS project -- all the types it expects to find are defined right here.
19  *
20  * The previous point is very important: This file does not depend on any external
21  * header files. It should compile on *any* platform that has a C compiler, without
22  * making *any* assumptions about availability of so-called "standard" C functions,
23  * routines, or types (which may or may not be present on any given platform).
24  */
25 
26 #include "DNSCommon.h"                  // Defines general DNS utility routines
27 #include "uDNS.h"                       // Defines entry points into unicast-specific routines
28 #include "nsec.h"
29 #include "dnssec.h"
30 #include "anonymous.h"
31 
32 // Disable certain benign warnings with Microsoft compilers
33 #if (defined(_MSC_VER))
34 // Disable "conditional expression is constant" warning for debug macros.
35 // Otherwise, this generates warnings for the perfectly natural construct "while(1)"
36 // If someone knows a variant way of writing "while(1)" that doesn't generate warning messages, please let us know
37     #pragma warning(disable:4127)
38 
39 // Disable "assignment within conditional expression".
40 // Other compilers understand the convention that if you place the assignment expression within an extra pair
41 // of parentheses, this signals to the compiler that you really intended an assignment and no warning is necessary.
42 // The Microsoft compiler doesn't understand this convention, so in the absense of any other way to signal
43 // to the compiler that the assignment is intentional, we have to just turn this warning off completely.
44     #pragma warning(disable:4706)
45 #endif
46 
47 #include "dns_sd.h" // for kDNSServiceFlags* definitions
48 #include "dns_sd_internal.h"
49 
50 #if APPLE_OSX_mDNSResponder
51 #include <WebFilterDNS/WebFilterDNS.h>
52 
53 // Delay in seconds before disabling multicast after there are no active queries or registrations.
54 #define BONJOUR_DISABLE_DELAY 60
55 
56 #if !NO_WCF
57 WCFConnection *WCFConnectionNew(void) __attribute__((weak_import));
58 void WCFConnectionDealloc(WCFConnection* c) __attribute__((weak_import));
59 
60 // Do we really need to define a macro for "if"?
61 #define CHECK_WCF_FUNCTION(X) if (X)
62 #endif // ! NO_WCF
63 
64 #else
65 
66 #define NO_WCF 1
67 #endif // APPLE_OSX_mDNSResponder
68 
69 #if AWD_METRICS
70 #include "Metrics.h"
71 #endif
72 
73 #if USE_DNS64
74 #include "DNS64.h"
75 #endif
76 
77 #ifdef UNIT_TEST
78 #include "unittest.h"
79 #endif
80 
81 // Forward declarations
82 mDNSlocal void BeginSleepProcessing(mDNS *const m);
83 mDNSlocal void RetrySPSRegistrations(mDNS *const m);
84 mDNSlocal void SendWakeup(mDNS *const m, mDNSInterfaceID InterfaceID, mDNSEthAddr *EthAddr, mDNSOpaque48 *password, mDNSBool unicastOnly);
85 mDNSlocal mDNSBool LocalRecordRmvEventsForQuestion(mDNS *const m, DNSQuestion *q);
86 mDNSlocal void mDNS_PurgeBeforeResolve(mDNS *const m, DNSQuestion *q);
87 mDNSlocal void CheckForDNSSECRecords(mDNS *const m, DNSQuestion *q);
88 mDNSlocal void mDNS_SendKeepalives(mDNS *const m);
89 mDNSlocal void mDNS_ExtractKeepaliveInfo(AuthRecord *ar, mDNSu32 *timeout, mDNSAddr *laddr, mDNSAddr *raddr, mDNSEthAddr *eth,
90                                          mDNSu32 *seq, mDNSu32 *ack, mDNSIPPort *lport, mDNSIPPort *rport, mDNSu16 *win);
91 
92 mDNSlocal void AdvertiseAllInterfaceRecords(mDNS *const m);
93 mDNSlocal void DeadvertiseAllInterfaceRecords(mDNS *const m);
94 mDNSlocal void FreeNSECRecords(mDNS *const m, CacheRecord *NSECRecords);
95 mDNSlocal void mDNSParseNSEC3Records(mDNS *const m, const DNSMessage *const response, const mDNSu8 *end,
96                                         const mDNSInterfaceID InterfaceID, CacheRecord **NSEC3Records);
97 mDNSlocal mDNSu8 *GetValueForMACAddr(mDNSu8 *ptr, mDNSu8 *limit, mDNSEthAddr *eth);
98 
99 
100 // ***************************************************************************
101 #if COMPILER_LIKES_PRAGMA_MARK
102 #pragma mark - Program Constants
103 #endif
104 
105 // To Turn OFF mDNS_Tracer set MDNS_TRACER to 0 or undef it
106 #define MDNS_TRACER 1
107 
108 #define NO_HINFO 1
109 
110 // Any records bigger than this are considered 'large' records
111 #define SmallRecordLimit 1024
112 
113 #define kMaxUpdateCredits 10
114 #define kUpdateCreditRefreshInterval (mDNSPlatformOneSecond * 6)
115 
116 // define special NR_AnswerTo values
117 #define NR_AnswerMulticast  (mDNSu8*)~0
118 #define NR_AnswerUnicast    (mDNSu8*)~1
119 
120 // Question default timeout values
121 #define DEFAULT_MCAST_TIMEOUT       5
122 #define DEFAULT_LO_OR_P2P_TIMEOUT   5
123 
124 // The code (see SendQueries() and BuildQuestion()) needs to have the
125 // RequestUnicast value set to a value one greater than the number of times you want the query
126 // sent with the "request unicast response" (QU) bit set.
127 #define SET_QU_IN_FIRST_QUERY   2
128 #define kDefaultRequestUnicastCount SET_QU_IN_FIRST_QUERY
129 
130 // The time needed to offload records to a sleep proxy after powerd sends the kIOMessageSystemWillSleep notification
131 #define DARK_WAKE_DELAY_SLEEP  5
132 #define kDarkWakeDelaySleep    (mDNSPlatformOneSecond * DARK_WAKE_DELAY_SLEEP)
133 
134 // The maximum number of times we delay probing to prevent spurious conflicts due to stale packets
135 #define MAX_CONFLICT_PROCESSING_DELAYS 3
136 
137 // RFC 6762 defines Passive Observation Of Failures (POOF)
138 //
139 //    A host observes the multicast queries issued by the other hosts on
140 //    the network.  One of the major benefits of also sending responses
141 //    using multicast is that it allows all hosts to see the responses
142 //    (or lack thereof) to those queries.
143 //
144 //    If a host sees queries, for which a record in its cache would be
145 //    expected to be given as an answer in a multicast response, but no
146 //    such answer is seen, then the host may take this as an indication
147 //    that the record may no longer be valid.
148 //
149 //    After seeing two or more of these queries, and seeing no multicast
150 //    response containing the expected answer within ten seconds, then even
151 //    though its TTL may indicate that it is not yet due to expire, that
152 //    record SHOULD be flushed from the cache.
153 //
154 // <https://tools.ietf.org/html/rfc6762#section-10.5>
155 
156 #define POOF_ENABLED 1
157 
158 mDNSexport const char *const mDNS_DomainTypeNames[] =
159 {
160     "b._dns-sd._udp.",      // Browse
161     "db._dns-sd._udp.",     // Default Browse
162     "lb._dns-sd._udp.",     // Automatic Browse
163     "r._dns-sd._udp.",      // Registration
164     "dr._dns-sd._udp."      // Default Registration
165 };
166 
167 #ifdef UNICAST_DISABLED
168 #define uDNS_IsActiveQuery(q, u) mDNSfalse
169 #endif
170 
171 // ***************************************************************************
172 #if COMPILER_LIKES_PRAGMA_MARK
173 #pragma mark -
174 #pragma mark - General Utility Functions
175 #endif
176 
177 // Returns true if this is a  unique, authoritative LocalOnly record that answers questions of type
178 // A, AAAA , CNAME, or PTR.  The caller should answer the question with this record and not send out
179 // the question on the wire if LocalOnlyRecordAnswersQuestion() also returns true.
180 // Main use is to handle /etc/hosts records and the LocalOnly PTR records created for localhost.
181 #define UniqueLocalOnlyRecord(rr) ((rr)->ARType == AuthRecordLocalOnly && \
182                                         (rr)->resrec.RecordType & kDNSRecordTypeUniqueMask && \
183                                         ((rr)->resrec.rrtype == kDNSType_A || (rr)->resrec.rrtype == kDNSType_AAAA || \
184                                          (rr)->resrec.rrtype == kDNSType_CNAME || \
185                                          (rr)->resrec.rrtype == kDNSType_PTR))
186 
187 mDNSlocal void SetNextQueryStopTime(mDNS *const m, const DNSQuestion *const q)
188 {
189     mDNS_CheckLock(m);
190 
191     if (m->NextScheduledStopTime - q->StopTime > 0)
192         m->NextScheduledStopTime = q->StopTime;
193 }
194 
195 mDNSexport void SetNextQueryTime(mDNS *const m, const DNSQuestion *const q)
196 {
197     mDNS_CheckLock(m);
198 
199     if (ActiveQuestion(q))
200     {
201         // Depending on whether this is a multicast or unicast question we want to set either:
202         // m->NextScheduledQuery = NextQSendTime(q) or
203         // m->NextuDNSEvent      = NextQSendTime(q)
204         mDNSs32 *const timer = mDNSOpaque16IsZero(q->TargetQID) ? &m->NextScheduledQuery : &m->NextuDNSEvent;
205         if (*timer - NextQSendTime(q) > 0)
206             *timer = NextQSendTime(q);
207     }
208 }
209 
210 mDNSlocal void ReleaseAuthEntity(AuthHash *r, AuthEntity *e)
211 {
212 #if APPLE_OSX_mDNSResponder && MACOSX_MDNS_MALLOC_DEBUGGING >= 1
213     unsigned int i;
214     for (i=0; i<sizeof(*e); i++) ((char*)e)[i] = 0xFF;
215 #endif
216     e->next = r->rrauth_free;
217     r->rrauth_free = e;
218     r->rrauth_totalused--;
219 }
220 
221 mDNSlocal void ReleaseAuthGroup(AuthHash *r, AuthGroup **cp)
222 {
223     AuthEntity *e = (AuthEntity *)(*cp);
224     LogMsg("ReleaseAuthGroup:  Releasing AuthGroup %##s", (*cp)->name->c);
225     if ((*cp)->rrauth_tail != &(*cp)->members)
226         LogMsg("ERROR: (*cp)->members == mDNSNULL but (*cp)->rrauth_tail != &(*cp)->members)");
227     if ((*cp)->name != (domainname*)((*cp)->namestorage)) mDNSPlatformMemFree((*cp)->name);
228     (*cp)->name = mDNSNULL;
229     *cp = (*cp)->next;          // Cut record from list
230     ReleaseAuthEntity(r, e);
231 }
232 
233 mDNSlocal AuthEntity *GetAuthEntity(AuthHash *r, const AuthGroup *const PreserveAG)
234 {
235     AuthEntity *e = mDNSNULL;
236 
237     if (r->rrauth_lock) { LogMsg("GetFreeCacheRR ERROR! Cache already locked!"); return(mDNSNULL); }
238     r->rrauth_lock = 1;
239 
240     if (!r->rrauth_free)
241     {
242         // We allocate just one AuthEntity at a time because we need to be able
243         // free them all individually which normally happens when we parse /etc/hosts into
244         // AuthHash where we add the "new" entries and discard (free) the already added
245         // entries. If we allocate as chunks, we can't free them individually.
246         AuthEntity *storage = mDNSPlatformMemAllocate(sizeof(AuthEntity));
247         storage->next = mDNSNULL;
248         r->rrauth_free = storage;
249     }
250 
251     // If we still have no free records, recycle all the records we can.
252     // Enumerating the entire auth is moderately expensive, so when we do it, we reclaim all the records we can in one pass.
253     if (!r->rrauth_free)
254     {
255         mDNSu32 oldtotalused = r->rrauth_totalused;
256         mDNSu32 slot;
257         for (slot = 0; slot < AUTH_HASH_SLOTS; slot++)
258         {
259             AuthGroup **cp = &r->rrauth_hash[slot];
260             while (*cp)
261             {
262                 if ((*cp)->members || (*cp)==PreserveAG) cp=&(*cp)->next;
263                 else ReleaseAuthGroup(r, cp);
264             }
265         }
266         LogInfo("GetAuthEntity: Recycled %d records to reduce auth cache from %d to %d",
267                 oldtotalused - r->rrauth_totalused, oldtotalused, r->rrauth_totalused);
268     }
269 
270     if (r->rrauth_free) // If there are records in the free list, take one
271     {
272         e = r->rrauth_free;
273         r->rrauth_free = e->next;
274         if (++r->rrauth_totalused >= r->rrauth_report)
275         {
276             LogInfo("RR Auth now using %ld objects", r->rrauth_totalused);
277             if      (r->rrauth_report <  100) r->rrauth_report += 10;
278             else if (r->rrauth_report < 1000) r->rrauth_report += 100;
279             else r->rrauth_report += 1000;
280         }
281         mDNSPlatformMemZero(e, sizeof(*e));
282     }
283 
284     r->rrauth_lock = 0;
285 
286     return(e);
287 }
288 
289 mDNSexport AuthGroup *AuthGroupForName(AuthHash *r, const mDNSu32 namehash, const domainname *const name)
290 {
291     AuthGroup *ag;
292     const mDNSu32 slot = namehash % AUTH_HASH_SLOTS;
293 
294     for (ag = r->rrauth_hash[slot]; ag; ag=ag->next)
295         if (ag->namehash == namehash && SameDomainName(ag->name, name))
296             break;
297     return(ag);
298 }
299 
300 mDNSexport AuthGroup *AuthGroupForRecord(AuthHash *r, const ResourceRecord *const rr)
301 {
302     return(AuthGroupForName(r, rr->namehash, rr->name));
303 }
304 
305 mDNSlocal AuthGroup *GetAuthGroup(AuthHash *r, const ResourceRecord *const rr)
306 {
307     mDNSu16 namelen = DomainNameLength(rr->name);
308     AuthGroup *ag = (AuthGroup*)GetAuthEntity(r, mDNSNULL);
309     const mDNSu32 slot = rr->namehash % AUTH_HASH_SLOTS;
310     if (!ag) { LogMsg("GetAuthGroup: Failed to allocate memory for %##s", rr->name->c); return(mDNSNULL); }
311     ag->next         = r->rrauth_hash[slot];
312     ag->namehash     = rr->namehash;
313     ag->members      = mDNSNULL;
314     ag->rrauth_tail  = &ag->members;
315     ag->NewLocalOnlyRecords = mDNSNULL;
316     if (namelen > sizeof(ag->namestorage))
317         ag->name = mDNSPlatformMemAllocate(namelen);
318     else
319         ag->name = (domainname*)ag->namestorage;
320     if (!ag->name)
321     {
322         LogMsg("GetAuthGroup: Failed to allocate name storage for %##s", rr->name->c);
323         ReleaseAuthEntity(r, (AuthEntity*)ag);
324         return(mDNSNULL);
325     }
326     AssignDomainName(ag->name, rr->name);
327 
328     if (AuthGroupForRecord(r, rr)) LogMsg("GetAuthGroup: Already have AuthGroup for %##s", rr->name->c);
329     r->rrauth_hash[slot] = ag;
330     if (AuthGroupForRecord(r, rr) != ag) LogMsg("GetAuthGroup: Not finding AuthGroup for %##s", rr->name->c);
331 
332     return(ag);
333 }
334 
335 // Returns the AuthGroup in which the AuthRecord was inserted
336 mDNSexport AuthGroup *InsertAuthRecord(mDNS *const m, AuthHash *r, AuthRecord *rr)
337 {
338     AuthGroup *ag;
339 
340     (void)m;
341     ag = AuthGroupForRecord(r, &rr->resrec);
342     if (!ag) ag = GetAuthGroup(r, &rr->resrec);   // If we don't have a AuthGroup for this name, make one now
343     if (ag)
344     {
345         *(ag->rrauth_tail) = rr;                // Append this record to tail of cache slot list
346         ag->rrauth_tail = &(rr->next);          // Advance tail pointer
347     }
348     return ag;
349 }
350 
351 mDNSexport AuthGroup *RemoveAuthRecord(mDNS *const m, AuthHash *r, AuthRecord *rr)
352 {
353     AuthGroup *a;
354     AuthRecord **rp;
355 
356     a = AuthGroupForRecord(r, &rr->resrec);
357     if (!a) { LogMsg("RemoveAuthRecord: ERROR!! AuthGroup not found for %s", ARDisplayString(m, rr)); return mDNSNULL; }
358     rp = &a->members;
359     while (*rp)
360     {
361         if (*rp != rr)
362             rp=&(*rp)->next;
363         else
364         {
365             // We don't break here, so that we can set the tail below without tracking "prev" pointers
366 
367             LogInfo("RemoveAuthRecord: removing auth record %s from table", ARDisplayString(m, rr));
368             *rp = (*rp)->next;          // Cut record from list
369         }
370     }
371     // TBD: If there are no more members, release authgroup ?
372     a->rrauth_tail = rp;
373     return a;
374 }
375 
376 mDNSexport CacheGroup *CacheGroupForName(const mDNS *const m, const mDNSu32 namehash, const domainname *const name)
377 {
378     CacheGroup *cg;
379     mDNSu32    slot = HashSlotFromNameHash(namehash);
380     for (cg = m->rrcache_hash[slot]; cg; cg=cg->next)
381         if (cg->namehash == namehash && SameDomainName(cg->name, name))
382             break;
383     return(cg);
384 }
385 
386 mDNSlocal CacheGroup *CacheGroupForRecord(const mDNS *const m, const ResourceRecord *const rr)
387 {
388     return(CacheGroupForName(m, rr->namehash, rr->name));
389 }
390 
391 mDNSexport mDNSBool mDNS_AddressIsLocalSubnet(mDNS *const m, const mDNSInterfaceID InterfaceID, const mDNSAddr *addr)
392 {
393     NetworkInterfaceInfo *intf;
394 
395     if (addr->type == mDNSAddrType_IPv4)
396     {
397         // Normally we resist touching the NotAnInteger fields, but here we're doing tricky bitwise masking so we make an exception
398         if (mDNSv4AddressIsLinkLocal(&addr->ip.v4)) return(mDNStrue);
399         for (intf = m->HostInterfaces; intf; intf = intf->next)
400             if (intf->ip.type == addr->type && intf->InterfaceID == InterfaceID && intf->McastTxRx)
401                 if (((intf->ip.ip.v4.NotAnInteger ^ addr->ip.v4.NotAnInteger) & intf->mask.ip.v4.NotAnInteger) == 0)
402                     return(mDNStrue);
403     }
404 
405     if (addr->type == mDNSAddrType_IPv6)
406     {
407         if (mDNSv6AddressIsLinkLocal(&addr->ip.v6)) return(mDNStrue);
408         for (intf = m->HostInterfaces; intf; intf = intf->next)
409             if (intf->ip.type == addr->type && intf->InterfaceID == InterfaceID && intf->McastTxRx)
410                 if ((((intf->ip.ip.v6.l[0] ^ addr->ip.v6.l[0]) & intf->mask.ip.v6.l[0]) == 0) &&
411                     (((intf->ip.ip.v6.l[1] ^ addr->ip.v6.l[1]) & intf->mask.ip.v6.l[1]) == 0) &&
412                     (((intf->ip.ip.v6.l[2] ^ addr->ip.v6.l[2]) & intf->mask.ip.v6.l[2]) == 0) &&
413                     (((intf->ip.ip.v6.l[3] ^ addr->ip.v6.l[3]) & intf->mask.ip.v6.l[3]) == 0))
414                         return(mDNStrue);
415     }
416 
417     return(mDNSfalse);
418 }
419 
420 mDNSlocal NetworkInterfaceInfo *FirstInterfaceForID(mDNS *const m, const mDNSInterfaceID InterfaceID)
421 {
422     NetworkInterfaceInfo *intf = m->HostInterfaces;
423     while (intf && intf->InterfaceID != InterfaceID) intf = intf->next;
424     return(intf);
425 }
426 
427 mDNSlocal NetworkInterfaceInfo *FirstIPv4LLInterfaceForID(mDNS *const m, const mDNSInterfaceID InterfaceID)
428 {
429     NetworkInterfaceInfo *intf;
430 
431     if (!InterfaceID)
432         return mDNSNULL;
433 
434     // Note: We don't check for InterfaceActive, as the active interface could be IPv6 and
435     // we still want to find the first IPv4 Link-Local interface
436     for (intf = m->HostInterfaces; intf; intf = intf->next)
437     {
438         if (intf->InterfaceID == InterfaceID &&
439             intf->ip.type == mDNSAddrType_IPv4 && mDNSv4AddressIsLinkLocal(&intf->ip.ip.v4))
440         {
441             debugf("FirstIPv4LLInterfaceForID: found LL interface with address %.4a", &intf->ip.ip.v4);
442             return intf;
443         }
444     }
445     return (mDNSNULL);
446 }
447 
448 mDNSexport char *InterfaceNameForID(mDNS *const m, const mDNSInterfaceID InterfaceID)
449 {
450     NetworkInterfaceInfo *intf = FirstInterfaceForID(m, InterfaceID);
451     return(intf ? intf->ifname : mDNSNULL);
452 }
453 
454 // Caller should hold the lock
455 mDNSlocal void GenerateNegativeResponse(mDNS *const m, mDNSInterfaceID InterfaceID, QC_result qc)
456 {
457     DNSQuestion *q;
458     if (!m->CurrentQuestion) { LogMsg("GenerateNegativeResponse: ERROR!! CurrentQuestion not set"); return; }
459     q = m->CurrentQuestion;
460     LogInfo("GenerateNegativeResponse: Generating negative response for question %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
461 
462     MakeNegativeCacheRecord(m, &m->rec.r, &q->qname, q->qnamehash, q->qtype, q->qclass, 60, InterfaceID, mDNSNULL);
463 
464     // We need to force the response through in the following cases
465     //
466     //  a) SuppressUnusable questions that are suppressed
467     //  b) Append search domains and retry the question
468     //
469     // The question may not have set Intermediates in which case we don't deliver negative responses. So, to force
470     // through we use "QC_forceresponse".
471     AnswerCurrentQuestionWithResourceRecord(m, &m->rec.r, qc);
472     if (m->CurrentQuestion == q) { q->ThisQInterval = 0; }              // Deactivate this question
473     // Don't touch the question after this
474     m->rec.r.resrec.RecordType = 0;     // Clear RecordType to show we're not still using it
475 }
476 
477 mDNSexport void AnswerQuestionByFollowingCNAME(mDNS *const m, DNSQuestion *q, ResourceRecord *rr)
478 {
479     const mDNSBool selfref = SameDomainName(&q->qname, &rr->rdata->u.name);
480     if (q->CNAMEReferrals >= 10 || selfref)
481     {
482         LogMsg("AnswerQuestionByFollowingCNAME: %p %##s (%s) NOT following CNAME referral %d%s for %s",
483                q, q->qname.c, DNSTypeName(q->qtype), q->CNAMEReferrals, selfref ? " (Self-Referential)" : "", RRDisplayString(m, rr));
484     }
485     else
486     {
487         const mDNSu32 c = q->CNAMEReferrals + 1;        // Stash a copy of the new q->CNAMEReferrals value
488         UDPSocket *sock = q->LocalSocket;
489         mDNSOpaque16 id = q->TargetQID;
490 #if AWD_METRICS
491         uDNSMetrics metrics;
492 #endif
493 
494         q->LocalSocket = mDNSNULL;
495 
496         // The SameDomainName check above is to ignore bogus CNAME records that point right back at
497         // themselves. Without that check we can get into a case where we have two duplicate questions,
498         // A and B, and when we stop question A, UpdateQuestionDuplicates copies the value of CNAMEReferrals
499         // from A to B, and then A is re-appended to the end of the list as a duplicate of B (because
500         // the target name is still the same), and then when we stop question B, UpdateQuestionDuplicates
501         // copies the B's value of CNAMEReferrals back to A, and we end up not incrementing CNAMEReferrals
502         // for either of them. This is not a problem for CNAME loops of two or more records because in
503         // those cases the newly re-appended question A has a different target name and therefore cannot be
504         // a duplicate of any other question ('B') which was itself a duplicate of the previous question A.
505 
506         // Right now we just stop and re-use the existing query. If we really wanted to be 100% perfect,
507         // and track CNAMEs coming and going, we should really create a subordinate query here,
508         // which we would subsequently cancel and retract if the CNAME referral record were removed.
509         // In reality this is such a corner case we'll ignore it until someone actually needs it.
510 
511         LogInfo("AnswerQuestionByFollowingCNAME: %p %##s (%s) following CNAME referral %d for %s",
512                 q, q->qname.c, DNSTypeName(q->qtype), q->CNAMEReferrals, RRDisplayString(m, rr));
513 
514 #if AWD_METRICS
515         if ((q->CNAMEReferrals == 0) && !q->metrics.originalQName)
516         {
517             domainname *    qName;
518             mDNSu16         qNameLen;
519 
520             qNameLen = DomainNameLength(&q->qname);
521             if ((qNameLen > 0) && (qNameLen <= MAX_DOMAIN_NAME))
522             {
523                 qName = mDNSPlatformMemAllocate(qNameLen);
524                 if (qName)
525                 {
526                     mDNSPlatformMemCopy(qName->c, q->qname.c, qNameLen);
527                     q->metrics.originalQName = qName;
528                 }
529             }
530         }
531         metrics = q->metrics;
532         mDNSPlatformMemZero(&q->metrics, sizeof(q->metrics));
533 #endif
534         mDNS_StopQuery_internal(m, q);                              // Stop old query
535         AssignDomainName(&q->qname, &rr->rdata->u.name);            // Update qname
536         q->qnamehash = DomainNameHashValue(&q->qname);              // and namehash
537         // If a unicast query results in a CNAME that points to a .local, we need to re-try
538         // this as unicast. Setting the mDNSInterface_Unicast tells mDNS_StartQuery_internal
539         // to try this as unicast query even though it is a .local name
540         if (!mDNSOpaque16IsZero(q->TargetQID) && IsLocalDomain(&q->qname))
541         {
542             LogInfo("AnswerQuestionByFollowingCNAME: Resolving a .local CNAME %p %##s (%s) Record %s",
543                     q, q->qname.c, DNSTypeName(q->qtype), RRDisplayString(m, rr));
544             q->InterfaceID = mDNSInterface_Unicast;
545         }
546         mDNS_StartQuery_internal(m, q);                             // start new query
547         // Record how many times we've done this. We need to do this *after* mDNS_StartQuery_internal,
548         // because mDNS_StartQuery_internal re-initializes CNAMEReferrals to zero
549         q->CNAMEReferrals = c;
550 #if AWD_METRICS
551         metrics.expiredAnswerState = q->metrics.expiredAnswerState; //  We want the newly initialized state for this value
552         q->metrics = metrics;
553 #endif
554         if (sock)
555         {
556             // If our new query is a duplicate, then it can't have a socket of its own, so we have to close the one we saved.
557             if (q->DuplicateOf) mDNSPlatformUDPClose(sock);
558             else
559             {
560                 // Transplant the old socket into the new question, and copy the query ID across too.
561                 // No need to close the old q->LocalSocket value because it won't have been created yet (they're made lazily on-demand).
562                 q->LocalSocket = sock;
563                 q->TargetQID = id;
564             }
565         }
566     }
567 }
568 
569 #ifdef USE_LIBIDN
570 
571 #include <unicode/uidna.h>
572 
573 // #define DEBUG_PUNYCODE 1
574 
575 mDNSlocal mDNSu8 *PunycodeConvert(const mDNSu8 *const src, mDNSu8 *const dst, const mDNSu8 *const end)
576 {
577     UErrorCode errorCode = U_ZERO_ERROR;
578     UIDNAInfo info = UIDNA_INFO_INITIALIZER;
579     UIDNA *uts46 = uidna_openUTS46(UIDNA_USE_STD3_RULES|UIDNA_NONTRANSITIONAL_TO_UNICODE, &errorCode);
580     int32_t len = uidna_nameToASCII_UTF8(uts46, (const char *)src+1, src[0], (char *)dst+1, end-(dst+1), &info, &errorCode);
581     uidna_close(uts46);
582     #if DEBUG_PUNYCODE
583     if (errorCode) LogMsg("uidna_nameToASCII_UTF8(%##s) failed errorCode %d", src, errorCode);
584     if (info.errors) LogMsg("uidna_nameToASCII_UTF8(%##s) failed info.errors 0x%08X", src, info.errors);
585     if (len > MAX_DOMAIN_LABEL) LogMsg("uidna_nameToASCII_UTF8(%##s) result too long %d", src, len);
586     #endif
587     if (errorCode || info.errors || len > MAX_DOMAIN_LABEL) return mDNSNULL;
588     *dst = len;
589     return(dst + 1 + len);
590 }
591 
592 mDNSlocal mDNSBool IsHighASCIILabel(const mDNSu8 *d)
593 {
594     int i;
595     for (i=1; i<=d[0]; i++) if (d[i] & 0x80) return mDNStrue;
596     return mDNSfalse;
597 }
598 
599 mDNSlocal const mDNSu8 *FindLastHighASCIILabel(const domainname *const d)
600 {
601     const mDNSu8 *ptr = d->c;
602     const mDNSu8 *ans = mDNSNULL;
603     while (ptr[0])
604     {
605         const mDNSu8 *const next = ptr + 1 + ptr[0];
606         if (ptr[0] > MAX_DOMAIN_LABEL || next >= d->c + MAX_DOMAIN_NAME) return mDNSNULL;
607         if (IsHighASCIILabel(ptr)) ans = ptr;
608         ptr = next;
609     }
610     return ans;
611 }
612 
613 mDNSlocal mDNSBool PerformNextPunycodeConversion(const DNSQuestion *const q, domainname *const newname)
614 {
615     const mDNSu8 *h = FindLastHighASCIILabel(&q->qname);
616     #if DEBUG_PUNYCODE
617     LogMsg("PerformNextPunycodeConversion: %##s (%s) Last High-ASCII Label %##s", q->qname.c, DNSTypeName(q->qtype), h);
618     #endif
619     if (!h) return mDNSfalse;  // There are no high-ascii labels to convert
620 
621     mDNSu8 *const dst = PunycodeConvert(h, newname->c + (h - q->qname.c), newname->c + MAX_DOMAIN_NAME);
622     if (!dst)
623         return mDNSfalse;  // The label was not convertible to Punycode
624     else
625     {
626         // If Punycode conversion of final eligible label was successful, copy the rest of the domainname
627         const mDNSu8 *const src = h + 1 + h[0];
628         const mDNSu8 remainder  = DomainNameLength((domainname*)src);
629         if (dst + remainder > newname->c + MAX_DOMAIN_NAME) return mDNSfalse;  // Name too long -- cannot be converted to Punycode
630 
631         mDNSPlatformMemCopy(newname->c, q->qname.c, h - q->qname.c);  // Fill in the leading part
632         mDNSPlatformMemCopy(dst, src, remainder);                     // Fill in the trailing part
633         #if DEBUG_PUNYCODE
634         LogMsg("PerformNextPunycodeConversion: %##s converted to %##s", q->qname.c, newname->c);
635         #endif
636         return mDNStrue;
637     }
638 }
639 
640 #endif // USE_LIBIDN
641 
642 // For a single given DNSQuestion pointed to by CurrentQuestion, deliver an add/remove result for the single given AuthRecord
643 // Note: All the callers should use the m->CurrentQuestion to see if the question is still valid or not
644 mDNSlocal void AnswerLocalQuestionWithLocalAuthRecord(mDNS *const m, AuthRecord *rr, QC_result AddRecord)
645 {
646     DNSQuestion *q = m->CurrentQuestion;
647     mDNSBool followcname;
648 
649     if (!q)
650     {
651         LogMsg("AnswerLocalQuestionWithLocalAuthRecord: ERROR!! CurrentQuestion NULL while answering with %s", ARDisplayString(m, rr));
652         return;
653     }
654 
655     followcname = FollowCNAME(q, &rr->resrec, AddRecord);
656 
657     // We should not be delivering results for record types Unregistered, Deregistering, and (unverified) Unique
658     if (!(rr->resrec.RecordType & kDNSRecordTypeActiveMask))
659     {
660         LogMsg("AnswerLocalQuestionWithLocalAuthRecord: *NOT* delivering %s event for local record type %X %s",
661                AddRecord ? "Add" : "Rmv", rr->resrec.RecordType, ARDisplayString(m, rr));
662         return;
663     }
664 
665     // Indicate that we've given at least one positive answer for this record, so we should be prepared to send a goodbye for it
666     if (AddRecord) rr->AnsweredLocalQ = mDNStrue;
667     mDNS_DropLockBeforeCallback();      // Allow client to legally make mDNS API calls from the callback
668     if (q->QuestionCallback && !q->NoAnswer)
669     {
670         q->CurrentAnswers += AddRecord ? 1 : -1;
671         if (UniqueLocalOnlyRecord(rr))
672         {
673             if (!followcname || q->ReturnIntermed)
674             {
675                 // Don't send this packet on the wire as we answered from /etc/hosts
676                 q->ThisQInterval = 0;
677                 q->LOAddressAnswers += AddRecord ? 1 : -1;
678                 q->QuestionCallback(m, q, &rr->resrec, AddRecord);
679             }
680             mDNS_ReclaimLockAfterCallback();    // Decrement mDNS_reentrancy to block mDNS API calls again
681             // The callback above could have caused the question to stop. Detect that
682             // using m->CurrentQuestion
683             if (followcname && m->CurrentQuestion == q)
684                 AnswerQuestionByFollowingCNAME(m, q, &rr->resrec);
685             return;
686         }
687         else
688         {
689             q->QuestionCallback(m, q, &rr->resrec, AddRecord);
690         }
691     }
692     mDNS_ReclaimLockAfterCallback();    // Decrement mDNS_reentrancy to block mDNS API calls again
693 }
694 
695 mDNSlocal void AnswerInterfaceAnyQuestionsWithLocalAuthRecord(mDNS *const m, AuthRecord *rr, QC_result AddRecord)
696 {
697     if (m->CurrentQuestion)
698         LogMsg("AnswerInterfaceAnyQuestionsWithLocalAuthRecord: ERROR m->CurrentQuestion already set: %##s (%s)",
699                m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
700     m->CurrentQuestion = m->Questions;
701     while (m->CurrentQuestion && m->CurrentQuestion != m->NewQuestions)
702     {
703         mDNSBool answered;
704         DNSQuestion *q = m->CurrentQuestion;
705         if (RRAny(rr))
706             answered = ResourceRecordAnswersQuestion(&rr->resrec, q);
707         else
708             answered = LocalOnlyRecordAnswersQuestion(rr, q);
709         if (answered)
710             AnswerLocalQuestionWithLocalAuthRecord(m, rr, AddRecord);       // MUST NOT dereference q again
711         if (m->CurrentQuestion == q)    // If m->CurrentQuestion was not auto-advanced, do it ourselves now
712             m->CurrentQuestion = q->next;
713     }
714     m->CurrentQuestion = mDNSNULL;
715 }
716 
717 // When a new local AuthRecord is created or deleted, AnswerAllLocalQuestionsWithLocalAuthRecord()
718 // delivers the appropriate add/remove events to listening questions:
719 // 1. It runs though all our LocalOnlyQuestions delivering answers as appropriate,
720 //    stopping if it reaches a NewLocalOnlyQuestion -- brand-new questions are handled by AnswerNewLocalOnlyQuestion().
721 // 2. If the AuthRecord is marked mDNSInterface_LocalOnly or mDNSInterface_P2P, then it also runs though
722 //    our main question list, delivering answers to mDNSInterface_Any questions as appropriate,
723 //    stopping if it reaches a NewQuestion -- brand-new questions are handled by AnswerNewQuestion().
724 //
725 // AnswerAllLocalQuestionsWithLocalAuthRecord is used by the m->NewLocalRecords loop in mDNS_Execute(),
726 // and by mDNS_Deregister_internal()
727 
728 mDNSlocal void AnswerAllLocalQuestionsWithLocalAuthRecord(mDNS *const m, AuthRecord *rr, QC_result AddRecord)
729 {
730     if (m->CurrentQuestion)
731         LogMsg("AnswerAllLocalQuestionsWithLocalAuthRecord ERROR m->CurrentQuestion already set: %##s (%s)",
732                m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
733 
734     m->CurrentQuestion = m->LocalOnlyQuestions;
735     while (m->CurrentQuestion && m->CurrentQuestion != m->NewLocalOnlyQuestions)
736     {
737         mDNSBool answered;
738         DNSQuestion *q = m->CurrentQuestion;
739         // We are called with both LocalOnly/P2P record or a regular AuthRecord
740         if (RRAny(rr))
741             answered = ResourceRecordAnswersQuestion(&rr->resrec, q);
742         else
743             answered = LocalOnlyRecordAnswersQuestion(rr, q);
744         if (answered)
745             AnswerLocalQuestionWithLocalAuthRecord(m, rr, AddRecord);           // MUST NOT dereference q again
746         if (m->CurrentQuestion == q)    // If m->CurrentQuestion was not auto-advanced, do it ourselves now
747             m->CurrentQuestion = q->next;
748     }
749 
750     m->CurrentQuestion = mDNSNULL;
751 
752     // If this AuthRecord is marked LocalOnly or P2P, then we want to deliver it to all local 'mDNSInterface_Any' questions
753     if (rr->ARType == AuthRecordLocalOnly || rr->ARType == AuthRecordP2P)
754         AnswerInterfaceAnyQuestionsWithLocalAuthRecord(m, rr, AddRecord);
755 
756 }
757 
758 // ***************************************************************************
759 #if COMPILER_LIKES_PRAGMA_MARK
760 #pragma mark -
761 #pragma mark - Resource Record Utility Functions
762 #endif
763 
764 #define RRTypeIsAddressType(T) ((T) == kDNSType_A || (T) == kDNSType_AAAA)
765 
766 #define ResourceRecordIsValidAnswer(RR) ( ((RR)->resrec.RecordType & kDNSRecordTypeActiveMask)  && \
767                                           ((RR)->Additional1 == mDNSNULL || ((RR)->Additional1->resrec.RecordType & kDNSRecordTypeActiveMask)) && \
768                                           ((RR)->Additional2 == mDNSNULL || ((RR)->Additional2->resrec.RecordType & kDNSRecordTypeActiveMask)) && \
769                                           ((RR)->DependentOn == mDNSNULL || ((RR)->DependentOn->resrec.RecordType & kDNSRecordTypeActiveMask))  )
770 
771 #define ResourceRecordIsValidInterfaceAnswer(RR, INTID) \
772     (ResourceRecordIsValidAnswer(RR) && \
773      ((RR)->resrec.InterfaceID == mDNSInterface_Any || (RR)->resrec.InterfaceID == (INTID)))
774 
775 #define DefaultProbeCountForTypeUnique ((mDNSu8)3)
776 #define DefaultProbeCountForRecordType(X)      ((X) == kDNSRecordTypeUnique ? DefaultProbeCountForTypeUnique : (mDNSu8)0)
777 
778 // See RFC 6762: "8.3 Announcing"
779 // "The Multicast DNS responder MUST send at least two unsolicited responses, one second apart."
780 // Send 4, which is really 8 since we send on both IPv4 and IPv6.
781 #define InitialAnnounceCount ((mDNSu8)4)
782 
783 // For goodbye packets we set the count to 3, and for wakeups we set it to 18
784 // (which will be up to 15 wakeup attempts over the course of 30 seconds,
785 // and then if the machine fails to wake, 3 goodbye packets).
786 #define GoodbyeCount ((mDNSu8)3)
787 #define WakeupCount ((mDNSu8)18)
788 #define MAX_PROBE_RESTARTS ((mDNSu8)20)
789 #define MAX_GHOST_TIME ((mDNSs32)((60*60*24*7)*mDNSPlatformOneSecond))  //  One week
790 
791 // Number of wakeups we send if WakeOnResolve is set in the question
792 #define InitialWakeOnResolveCount ((mDNSu8)3)
793 
794 // Note that the announce intervals use exponential backoff, doubling each time. The probe intervals do not.
795 // This means that because the announce interval is doubled after sending the first packet, the first
796 // observed on-the-wire inter-packet interval between announcements is actually one second.
797 // The half-second value here may be thought of as a conceptual (non-existent) half-second delay *before* the first packet is sent.
798 #define DefaultProbeIntervalForTypeUnique (mDNSPlatformOneSecond/4)
799 #define DefaultAnnounceIntervalForTypeShared (mDNSPlatformOneSecond/2)
800 #define DefaultAnnounceIntervalForTypeUnique (mDNSPlatformOneSecond/2)
801 
802 #define DefaultAPIntervalForRecordType(X)  ((X) &kDNSRecordTypeActiveSharedMask ? DefaultAnnounceIntervalForTypeShared : \
803                                             (X) &kDNSRecordTypeUnique           ? DefaultProbeIntervalForTypeUnique    : \
804                                             (X) &kDNSRecordTypeActiveUniqueMask ? DefaultAnnounceIntervalForTypeUnique : 0)
805 
806 #define TimeToAnnounceThisRecord(RR,time) ((RR)->AnnounceCount && (time) - ((RR)->LastAPTime + (RR)->ThisAPInterval) >= 0)
807 #define TicksTTL(RR) ((mDNSs32)(RR)->resrec.rroriginalttl * mDNSPlatformOneSecond)
808 #define RRExpireTime(RR) ((RR)->TimeRcvd + TicksTTL(RR))
809 
810 // Adjustment factor to avoid race condition (used for unicast cache entries) :
811 // Suppose real record has TTL of 3600, and our local caching server has held it for 3500 seconds, so it returns an aged TTL of 100.
812 // If we do our normal refresh at 80% of the TTL, our local caching server will return 20 seconds, so we'll do another
813 // 80% refresh after 16 seconds, and then the server will return 4 seconds, and so on, in the fashion of Zeno's paradox.
814 // To avoid this, we extend the record's effective TTL to give it a little extra grace period.
815 // We adjust the 100 second TTL to 127. This means that when we do our 80% query at 102 seconds,
816 // the cached copy at our local caching server will already have expired, so the server will be forced
817 // to fetch a fresh copy from the authoritative server, and then return a fresh record with the full TTL of 3600 seconds.
818 
819 #define RRAdjustTTL(ttl) ((ttl) + ((ttl)/4) + 2)
820 #define RRUnadjustedTTL(ttl) ((((ttl) - 2) * 4) / 5)
821 
822 #define MaxUnansweredQueries 4
823 
824 // SameResourceRecordSignature returns true if two resources records have the same name, type, and class, and may be sent
825 // (or were received) on the same interface (i.e. if *both* records specify an interface, then it has to match).
826 // TTL and rdata may differ.
827 // This is used for cache flush management:
828 // When sending a unique record, all other records matching "SameResourceRecordSignature" must also be sent
829 // When receiving a unique record, all old cache records matching "SameResourceRecordSignature" are flushed
830 
831 // SameResourceRecordNameClassInterface is functionally the same as SameResourceRecordSignature, except rrtype does not have to match
832 
833 #define SameResourceRecordSignature(A,B) (A)->resrec.rrtype == (B)->resrec.rrtype && SameResourceRecordNameClassInterface((A),(B))
834 
835 mDNSlocal mDNSBool SameResourceRecordNameClassInterface(const AuthRecord *const r1, const AuthRecord *const r2)
836 {
837     if (!r1) { LogMsg("SameResourceRecordSignature ERROR: r1 is NULL"); return(mDNSfalse); }
838     if (!r2) { LogMsg("SameResourceRecordSignature ERROR: r2 is NULL"); return(mDNSfalse); }
839     if (r1->resrec.InterfaceID &&
840         r2->resrec.InterfaceID &&
841         r1->resrec.InterfaceID != r2->resrec.InterfaceID) return(mDNSfalse);
842     return (mDNSBool)(
843                r1->resrec.rrclass  == r2->resrec.rrclass &&
844                r1->resrec.namehash == r2->resrec.namehash &&
845                SameDomainName(r1->resrec.name, r2->resrec.name));
846 }
847 
848 // PacketRRMatchesSignature behaves as SameResourceRecordSignature, except that types may differ if our
849 // authoratative record is unique (as opposed to shared). For unique records, we are supposed to have
850 // complete ownership of *all* types for this name, so *any* record type with the same name is a conflict.
851 // In addition, when probing we send our questions with the wildcard type kDNSQType_ANY,
852 // so a response of any type should match, even if it is not actually the type the client plans to use.
853 
854 // For now, to make it easier to avoid false conflicts, we treat SPS Proxy records like shared records,
855 // and require the rrtypes to match for the rdata to be considered potentially conflicting
856 mDNSlocal mDNSBool PacketRRMatchesSignature(const CacheRecord *const pktrr, const AuthRecord *const authrr)
857 {
858     if (!pktrr)  { LogMsg("PacketRRMatchesSignature ERROR: pktrr is NULL"); return(mDNSfalse); }
859     if (!authrr) { LogMsg("PacketRRMatchesSignature ERROR: authrr is NULL"); return(mDNSfalse); }
860     if (pktrr->resrec.InterfaceID &&
861         authrr->resrec.InterfaceID &&
862         pktrr->resrec.InterfaceID != authrr->resrec.InterfaceID) return(mDNSfalse);
863     if (!(authrr->resrec.RecordType & kDNSRecordTypeUniqueMask) || authrr->WakeUp.HMAC.l[0])
864         if (pktrr->resrec.rrtype != authrr->resrec.rrtype) return(mDNSfalse);
865     if ((authrr->resrec.InterfaceID == mDNSInterface_Any) &&
866         !mDNSPlatformValidRecordForInterface(authrr, pktrr->resrec.InterfaceID)) return(mDNSfalse);
867     return (mDNSBool)(
868                pktrr->resrec.rrclass == authrr->resrec.rrclass &&
869                pktrr->resrec.namehash == authrr->resrec.namehash &&
870                SameDomainName(pktrr->resrec.name, authrr->resrec.name));
871 }
872 
873 // CacheRecord *ka is the CacheRecord from the known answer list in the query.
874 // This is the information that the requester believes to be correct.
875 // AuthRecord *rr is the answer we are proposing to give, if not suppressed.
876 // This is the information that we believe to be correct.
877 // We've already determined that we plan to give this answer on this interface
878 // (either the record is non-specific, or it is specific to this interface)
879 // so now we just need to check the name, type, class, rdata and TTL.
880 mDNSlocal mDNSBool ShouldSuppressKnownAnswer(const CacheRecord *const ka, const AuthRecord *const rr)
881 {
882     // If RR signature is different, or data is different, then don't suppress our answer
883     if (!IdenticalResourceRecord(&ka->resrec, &rr->resrec)) return(mDNSfalse);
884 
885     // If the requester's indicated TTL is less than half the real TTL,
886     // we need to give our answer before the requester's copy expires.
887     // If the requester's indicated TTL is at least half the real TTL,
888     // then we can suppress our answer this time.
889     // If the requester's indicated TTL is greater than the TTL we believe,
890     // then that's okay, and we don't need to do anything about it.
891     // (If two responders on the network are offering the same information,
892     // that's okay, and if they are offering the information with different TTLs,
893     // the one offering the lower TTL should defer to the one offering the higher TTL.)
894     return (mDNSBool)(ka->resrec.rroriginalttl >= rr->resrec.rroriginalttl / 2);
895 }
896 
897 mDNSlocal void SetNextAnnounceProbeTime(mDNS *const m, const AuthRecord *const rr)
898 {
899     if (rr->resrec.RecordType == kDNSRecordTypeUnique)
900     {
901         if ((rr->LastAPTime + rr->ThisAPInterval) - m->timenow > mDNSPlatformOneSecond * 10)
902         {
903             LogMsg("SetNextAnnounceProbeTime: ProbeCount %d Next in %d %s", rr->ProbeCount, (rr->LastAPTime + rr->ThisAPInterval) - m->timenow, ARDisplayString(m, rr));
904             LogMsg("SetNextAnnounceProbeTime: m->SuppressProbes %d m->timenow %d diff %d", m->SuppressProbes, m->timenow, m->SuppressProbes - m->timenow);
905         }
906         if (m->NextScheduledProbe - (rr->LastAPTime + rr->ThisAPInterval) >= 0)
907             m->NextScheduledProbe = (rr->LastAPTime + rr->ThisAPInterval);
908         // Some defensive code:
909         // If (rr->LastAPTime + rr->ThisAPInterval) happens to be far in the past, we don't want to allow
910         // NextScheduledProbe to be set excessively in the past, because that can cause bad things to happen.
911         // See: <rdar://problem/7795434> mDNS: Sometimes advertising stops working and record interval is set to zero
912         if (m->NextScheduledProbe - m->timenow < 0)
913             m->NextScheduledProbe = m->timenow;
914     }
915     else if (rr->AnnounceCount && (ResourceRecordIsValidAnswer(rr) || rr->resrec.RecordType == kDNSRecordTypeDeregistering))
916     {
917         if (m->NextScheduledResponse - (rr->LastAPTime + rr->ThisAPInterval) >= 0)
918             m->NextScheduledResponse = (rr->LastAPTime + rr->ThisAPInterval);
919     }
920 }
921 
922 mDNSlocal void InitializeLastAPTime(mDNS *const m, AuthRecord *const rr)
923 {
924     // For reverse-mapping Sleep Proxy PTR records, probe interval is one second
925     rr->ThisAPInterval = rr->AddressProxy.type ? mDNSPlatformOneSecond : DefaultAPIntervalForRecordType(rr->resrec.RecordType);
926 
927     // * If this is a record type that's going to probe, then we use the m->SuppressProbes time.
928     // * Otherwise, if it's not going to probe, but m->SuppressProbes is set because we have other
929     //   records that are going to probe, then we delay its first announcement so that it will
930     //   go out synchronized with the first announcement for the other records that *are* probing.
931     //   This is a minor performance tweak that helps keep groups of related records synchronized together.
932     //   The addition of "interval / 2" is to make sure that, in the event that any of the probes are
933     //   delayed by a few milliseconds, this announcement does not inadvertently go out *before* the probing is complete.
934     //   When the probing is complete and those records begin to announce, these records will also be picked up and accelerated,
935     //   because they will meet the criterion of being at least half-way to their scheduled announcement time.
936     // * If it's not going to probe and m->SuppressProbes is not already set then we should announce immediately.
937 
938     if (rr->ProbeCount)
939     {
940         // If we have no probe suppression time set, or it is in the past, set it now
941         if (m->SuppressProbes == 0 || m->SuppressProbes - m->timenow < 0)
942         {
943             // To allow us to aggregate probes when a group of services are registered together,
944             // the first probe is delayed by a random delay in the range 1/8 to 1/4 second.
945             // This means the common-case behaviour is:
946             // randomized wait; probe
947             // 1/4 second wait; probe
948             // 1/4 second wait; probe
949             // 1/4 second wait; announce (i.e. service is normally announced 7/8 to 1 second after being registered)
950             m->SuppressProbes = NonZeroTime(m->timenow + DefaultProbeIntervalForTypeUnique/2 + mDNSRandom(DefaultProbeIntervalForTypeUnique/2));
951 
952             // If we already have a *probe* scheduled to go out sooner, then use that time to get better aggregation
953             if (m->SuppressProbes - m->NextScheduledProbe >= 0)
954                 m->SuppressProbes = NonZeroTime(m->NextScheduledProbe);
955             if (m->SuppressProbes - m->timenow < 0)     // Make sure we don't set m->SuppressProbes excessively in the past
956                 m->SuppressProbes = m->timenow;
957 
958             // If we already have a *query* scheduled to go out sooner, then use that time to get better aggregation
959             if (m->SuppressProbes - m->NextScheduledQuery >= 0)
960                 m->SuppressProbes = NonZeroTime(m->NextScheduledQuery);
961             if (m->SuppressProbes - m->timenow < 0)     // Make sure we don't set m->SuppressProbes excessively in the past
962                 m->SuppressProbes = m->timenow;
963 
964             // except... don't expect to be able to send before the m->SuppressSending timer fires
965             if (m->SuppressSending && m->SuppressProbes - m->SuppressSending < 0)
966                 m->SuppressProbes = NonZeroTime(m->SuppressSending);
967 
968             if (m->SuppressProbes - m->timenow > mDNSPlatformOneSecond * 8)
969             {
970                 LogMsg("InitializeLastAPTime ERROR m->SuppressProbes %d m->NextScheduledProbe %d m->NextScheduledQuery %d m->SuppressSending %d %d",
971                        m->SuppressProbes     - m->timenow,
972                        m->NextScheduledProbe - m->timenow,
973                        m->NextScheduledQuery - m->timenow,
974                        m->SuppressSending,
975                        m->SuppressSending    - m->timenow);
976                 m->SuppressProbes = NonZeroTime(m->timenow + DefaultProbeIntervalForTypeUnique/2 + mDNSRandom(DefaultProbeIntervalForTypeUnique/2));
977             }
978         }
979         rr->LastAPTime = m->SuppressProbes - rr->ThisAPInterval;
980     }
981     // Skip kDNSRecordTypeKnownUnique and kDNSRecordTypeShared records here and set their LastAPTime in the "else" block below so
982     // that they get announced immediately, otherwise, their announcement would be delayed until the based on the SuppressProbes value.
983     else if ((rr->resrec.RecordType != kDNSRecordTypeKnownUnique) && (rr->resrec.RecordType != kDNSRecordTypeShared) && m->SuppressProbes && (m->SuppressProbes - m->timenow >= 0))
984         rr->LastAPTime = m->SuppressProbes - rr->ThisAPInterval + DefaultProbeIntervalForTypeUnique * DefaultProbeCountForTypeUnique + rr->ThisAPInterval / 2;
985     else
986         rr->LastAPTime = m->timenow - rr->ThisAPInterval;
987 
988     // For reverse-mapping Sleep Proxy PTR records we don't want to start probing instantly -- we
989     // wait one second to give the client a chance to go to sleep, and then start our ARP/NDP probing.
990     // After three probes one second apart with no answer, we conclude the client is now sleeping
991     // and we can begin broadcasting our announcements to take over ownership of that IP address.
992     // If we don't wait for the client to go to sleep, then when the client sees our ARP Announcements there's a risk
993     // (depending on the OS and networking stack it's using) that it might interpret it as a conflict and change its IP address.
994     if (rr->AddressProxy.type)
995         rr->LastAPTime = m->timenow;
996 
997     // Set LastMCTime to now, to inhibit multicast responses
998     // (no need to send additional multicast responses when we're announcing anyway)
999     rr->LastMCTime      = m->timenow;
1000     rr->LastMCInterface = mDNSInterfaceMark;
1001 
1002     SetNextAnnounceProbeTime(m, rr);
1003 }
1004 
1005 mDNSlocal const domainname *SetUnicastTargetToHostName(mDNS *const m, AuthRecord *rr)
1006 {
1007     const domainname *target;
1008     if (rr->AutoTarget)
1009     {
1010         // For autotunnel services pointing at our IPv6 ULA we don't need or want a NAT mapping, but for all other
1011         // advertised services referencing our uDNS hostname, we want NAT mappings automatically created as appropriate,
1012         // with the port number in our advertised SRV record automatically tracking the external mapped port.
1013         DomainAuthInfo *AuthInfo = GetAuthInfoForName_internal(m, rr->resrec.name);
1014         if (!AuthInfo || !AuthInfo->AutoTunnel) rr->AutoTarget = Target_AutoHostAndNATMAP;
1015     }
1016 
1017     target = GetServiceTarget(m, rr);
1018     if (!target || target->c[0] == 0)
1019     {
1020         // defer registration until we've got a target
1021         LogInfo("SetUnicastTargetToHostName No target for %s", ARDisplayString(m, rr));
1022         rr->state = regState_NoTarget;
1023         return mDNSNULL;
1024     }
1025     else
1026     {
1027         LogInfo("SetUnicastTargetToHostName target %##s for resource record %s", target->c, ARDisplayString(m,rr));
1028         return target;
1029     }
1030 }
1031 
1032 // Right now this only applies to mDNS (.local) services where the target host is always m->MulticastHostname
1033 // Eventually we should unify this with GetServiceTarget() in uDNS.c
1034 mDNSlocal void SetTargetToHostName(mDNS *const m, AuthRecord *const rr)
1035 {
1036     domainname *const target = GetRRDomainNameTarget(&rr->resrec);
1037     const domainname *newname = &m->MulticastHostname;
1038 
1039     if (!target) LogInfo("SetTargetToHostName: Don't know how to set the target of rrtype %s", DNSTypeName(rr->resrec.rrtype));
1040 
1041     if (!(rr->ForceMCast || rr->ARType == AuthRecordLocalOnly || rr->ARType == AuthRecordP2P || IsLocalDomain(&rr->namestorage)))
1042     {
1043         const domainname *const n = SetUnicastTargetToHostName(m, rr);
1044         if (n) newname = n;
1045         else { if (target) target->c[0] = 0; SetNewRData(&rr->resrec, mDNSNULL, 0); return; }
1046     }
1047 
1048     if (target && SameDomainName(target, newname))
1049         debugf("SetTargetToHostName: Target of %##s is already %##s", rr->resrec.name->c, target->c);
1050 
1051     if (target && !SameDomainName(target, newname))
1052     {
1053         AssignDomainName(target, newname);
1054         SetNewRData(&rr->resrec, mDNSNULL, 0);      // Update rdlength, rdestimate, rdatahash
1055 
1056         // If we're in the middle of probing this record, we need to start again,
1057         // because changing its rdata may change the outcome of the tie-breaker.
1058         // (If the record type is kDNSRecordTypeUnique (unconfirmed unique) then DefaultProbeCountForRecordType is non-zero.)
1059         rr->ProbeCount     = DefaultProbeCountForRecordType(rr->resrec.RecordType);
1060 
1061         // If we've announced this record, we really should send a goodbye packet for the old rdata before
1062         // changing to the new rdata. However, in practice, we only do SetTargetToHostName for unique records,
1063         // so when we announce them we'll set the kDNSClass_UniqueRRSet and clear any stale data that way.
1064         if (rr->RequireGoodbye && rr->resrec.RecordType == kDNSRecordTypeShared)
1065             debugf("Have announced shared record %##s (%s) at least once: should have sent a goodbye packet before updating",
1066                    rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype));
1067 
1068         rr->AnnounceCount  = InitialAnnounceCount;
1069         rr->RequireGoodbye = mDNSfalse;
1070         rr->ProbeRestartCount = 0;
1071         InitializeLastAPTime(m, rr);
1072     }
1073 }
1074 
1075 mDNSlocal void AcknowledgeRecord(mDNS *const m, AuthRecord *const rr)
1076 {
1077     if (rr->RecordCallback)
1078     {
1079         // CAUTION: MUST NOT do anything more with rr after calling rr->Callback(), because the client's callback function
1080         // is allowed to do anything, including starting/stopping queries, registering/deregistering records, etc.
1081         rr->Acknowledged = mDNStrue;
1082         mDNS_DropLockBeforeCallback();      // Allow client to legally make mDNS API calls from the callback
1083         rr->RecordCallback(m, rr, mStatus_NoError);
1084         mDNS_ReclaimLockAfterCallback();    // Decrement mDNS_reentrancy to block mDNS API calls again
1085     }
1086 }
1087 
1088 mDNSexport void ActivateUnicastRegistration(mDNS *const m, AuthRecord *const rr)
1089 {
1090     // Make sure that we don't activate the SRV record and associated service records, if it is in
1091     // NoTarget state. First time when a service is being instantiated, SRV record may be in NoTarget state.
1092     // We should not activate any of the other reords (PTR, TXT) that are part of the service. When
1093     // the target becomes available, the records will be reregistered.
1094     if (rr->resrec.rrtype != kDNSType_SRV)
1095     {
1096         AuthRecord *srvRR = mDNSNULL;
1097         if (rr->resrec.rrtype == kDNSType_PTR)
1098             srvRR = rr->Additional1;
1099         else if (rr->resrec.rrtype == kDNSType_TXT)
1100             srvRR = rr->DependentOn;
1101         if (srvRR)
1102         {
1103             if (srvRR->resrec.rrtype != kDNSType_SRV)
1104             {
1105                 LogMsg("ActivateUnicastRegistration: ERROR!! Resource record %s wrong, expecting SRV type", ARDisplayString(m, srvRR));
1106             }
1107             else
1108             {
1109                 LogInfo("ActivateUnicastRegistration: Found Service Record %s in state %d for %##s (%s)",
1110                         ARDisplayString(m, srvRR), srvRR->state, rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype));
1111                 rr->state = srvRR->state;
1112             }
1113         }
1114     }
1115 
1116     if (rr->state == regState_NoTarget)
1117     {
1118         LogInfo("ActivateUnicastRegistration record %s in regState_NoTarget, not activating", ARDisplayString(m, rr));
1119         return;
1120     }
1121     // When we wake up from sleep, we call ActivateUnicastRegistration. It is possible that just before we went to sleep,
1122     // the service/record was being deregistered. In that case, we should not try to register again. For the cases where
1123     // the records are deregistered due to e.g., no target for the SRV record, we would have returned from above if it
1124     // was already in NoTarget state. If it was in the process of deregistration but did not complete fully before we went
1125     // to sleep, then it is okay to start in Pending state as we will go back to NoTarget state if we don't have a target.
1126     if (rr->resrec.RecordType == kDNSRecordTypeDeregistering)
1127     {
1128         LogInfo("ActivateUnicastRegistration: Resource record %s, current state %d, moving to DeregPending", ARDisplayString(m, rr), rr->state);
1129         rr->state = regState_DeregPending;
1130     }
1131     else
1132     {
1133         LogInfo("ActivateUnicastRegistration: Resource record %s, current state %d, moving to Pending", ARDisplayString(m, rr), rr->state);
1134         rr->state = regState_Pending;
1135     }
1136     rr->ProbeCount     = 0;
1137     rr->ProbeRestartCount = 0;
1138     rr->AnnounceCount  = 0;
1139     rr->ThisAPInterval = INIT_RECORD_REG_INTERVAL;
1140     rr->LastAPTime     = m->timenow - rr->ThisAPInterval;
1141     rr->expire         = 0; // Forget about all the leases, start fresh
1142     rr->uselease       = mDNStrue;
1143     rr->updateid       = zeroID;
1144     rr->SRVChanged     = mDNSfalse;
1145     rr->updateError    = mStatus_NoError;
1146     // RestartRecordGetZoneData calls this function whenever a new interface gets registered with core.
1147     // The records might already be registered with the server and hence could have NAT state.
1148     if (rr->NATinfo.clientContext)
1149     {
1150         mDNS_StopNATOperation_internal(m, &rr->NATinfo);
1151         rr->NATinfo.clientContext = mDNSNULL;
1152     }
1153     if (rr->nta) { CancelGetZoneData(m, rr->nta); rr->nta = mDNSNULL; }
1154     if (rr->tcp) { DisposeTCPConn(rr->tcp);       rr->tcp = mDNSNULL; }
1155     if (m->NextuDNSEvent - (rr->LastAPTime + rr->ThisAPInterval) >= 0)
1156         m->NextuDNSEvent = (rr->LastAPTime + rr->ThisAPInterval);
1157 }
1158 
1159 // Two records qualify to be local duplicates if:
1160 // (a) the RecordTypes are the same, or
1161 // (b) one is Unique and the other Verified
1162 // (c) either is in the process of deregistering
1163 #define RecordLDT(A,B) ((A)->resrec.RecordType == (B)->resrec.RecordType || \
1164                         ((A)->resrec.RecordType | (B)->resrec.RecordType) == (kDNSRecordTypeUnique | kDNSRecordTypeVerified) || \
1165                         ((A)->resrec.RecordType == kDNSRecordTypeDeregistering || (B)->resrec.RecordType == kDNSRecordTypeDeregistering))
1166 
1167 #define RecordIsLocalDuplicate(A,B) \
1168     ((A)->resrec.InterfaceID == (B)->resrec.InterfaceID && RecordLDT((A),(B)) && IdenticalResourceRecord(& (A)->resrec, & (B)->resrec))
1169 
1170 mDNSlocal AuthRecord *CheckAuthIdenticalRecord(AuthHash *r, AuthRecord *rr)
1171 {
1172     const AuthGroup *a;
1173     AuthRecord *rp;
1174 
1175     a = AuthGroupForRecord(r, &rr->resrec);
1176     if (!a) return mDNSNULL;
1177     rp = a->members;
1178     while (rp)
1179     {
1180         if (!RecordIsLocalDuplicate(rp, rr))
1181             rp = rp->next;
1182         else
1183         {
1184             if (rp->resrec.RecordType == kDNSRecordTypeDeregistering)
1185             {
1186                 rp->AnnounceCount = 0;
1187                 rp = rp->next;
1188             }
1189             else return rp;
1190         }
1191     }
1192     return (mDNSNULL);
1193 }
1194 
1195 mDNSlocal mDNSBool CheckAuthRecordConflict(AuthHash *r, AuthRecord *rr)
1196 {
1197     const AuthGroup *a;
1198     const AuthRecord *rp;
1199 
1200     a = AuthGroupForRecord(r, &rr->resrec);
1201     if (!a) return mDNSfalse;
1202     rp = a->members;
1203     while (rp)
1204     {
1205         const AuthRecord *s1 = rr->RRSet ? rr->RRSet : rr;
1206         const AuthRecord *s2 = rp->RRSet ? rp->RRSet : rp;
1207         if (s1 != s2 && SameResourceRecordSignature(rp, rr) && !IdenticalSameNameRecord(&rp->resrec, &rr->resrec))
1208             return mDNStrue;
1209         else
1210             rp = rp->next;
1211     }
1212     return (mDNSfalse);
1213 }
1214 
1215 // checks to see if "rr" is already present
1216 mDNSlocal AuthRecord *CheckAuthSameRecord(AuthHash *r, AuthRecord *rr)
1217 {
1218     const AuthGroup *a;
1219     AuthRecord *rp;
1220 
1221     a = AuthGroupForRecord(r, &rr->resrec);
1222     if (!a) return mDNSNULL;
1223     rp = a->members;
1224     while (rp)
1225     {
1226         if (rp != rr)
1227             rp = rp->next;
1228         else
1229         {
1230             return rp;
1231         }
1232     }
1233     return (mDNSNULL);
1234 }
1235 
1236 
1237 mDNSlocal void DecrementAutoTargetServices(mDNS *const m, AuthRecord *const rr)
1238 {
1239     if (RRLocalOnly(rr))
1240     {
1241         // A sanity check, this should be prevented in calling code.
1242         LogInfo("DecrementAutoTargetServices: called for RRLocalOnly() record: %s", ARDisplayString(m, rr));
1243         return;
1244     }
1245 
1246     if (!AuthRecord_uDNS(rr) && rr->resrec.rrtype == kDNSType_SRV && rr->AutoTarget == Target_AutoHost)
1247     {
1248         // If about to get rid of the last advertised service
1249         if (m->AutoTargetServices == 1)
1250             DeadvertiseAllInterfaceRecords(m);
1251 
1252         m->AutoTargetServices--;
1253         LogInfo("DecrementAutoTargetServices: AutoTargetServices %d Record %s", m->AutoTargetServices, ARDisplayString(m, rr));
1254     }
1255 
1256 #if BONJOUR_ON_DEMAND
1257     if (!AuthRecord_uDNS(rr))
1258     {
1259         if (m->NumAllInterfaceRecords + m->NumAllInterfaceQuestions == 1)
1260             m->NextBonjourDisableTime = NonZeroTime(m->timenow + (BONJOUR_DISABLE_DELAY * mDNSPlatformOneSecond));
1261         m->NumAllInterfaceRecords--;
1262         LogInfo("DecrementAutoTargetServices: NumAllInterfaceRecords %d NumAllInterfaceQuestions %d %s",
1263             m->NumAllInterfaceRecords, m->NumAllInterfaceQuestions, ARDisplayString(m, rr));
1264     }
1265 #endif // BONJOUR_ON_DEMAND
1266 }
1267 
1268 mDNSlocal void IncrementAutoTargetServices(mDNS *const m, AuthRecord *const rr)
1269 {
1270     mDNSBool enablingBonjour = 0;
1271 
1272     if (RRLocalOnly(rr))
1273     {
1274         // A sanity check, this should be prevented in calling code.
1275         LogInfo("IncrementAutoTargetServices: called for RRLocalOnly() record: %s", ARDisplayString(m, rr));
1276         return;
1277     }
1278 
1279 #if BONJOUR_ON_DEMAND
1280     if (!AuthRecord_uDNS(rr))
1281     {
1282         m->NumAllInterfaceRecords++;
1283         LogInfo("IncrementAutoTargetServices: NumAllInterfaceRecords %d NumAllInterfaceQuestions %d %s",
1284             m->NumAllInterfaceRecords, m->NumAllInterfaceQuestions, ARDisplayString(m, rr));
1285         if (m->NumAllInterfaceRecords + m->NumAllInterfaceQuestions == 1)
1286         {
1287             m->NextBonjourDisableTime = 0;
1288             if (m->BonjourEnabled == 0)
1289             {
1290                 // Enable Bonjour immediately by scheduling network changed processing where
1291                 // we will join the multicast group on each active interface.
1292                 m->BonjourEnabled = 1;
1293                 enablingBonjour = 1;
1294                 m->NetworkChanged = m->timenow;
1295             }
1296         }
1297     }
1298 #endif // BONJOUR_ON_DEMAND
1299 
1300     if (!AuthRecord_uDNS(rr) && rr->resrec.rrtype == kDNSType_SRV && rr->AutoTarget == Target_AutoHost)
1301     {
1302         m->AutoTargetServices++;
1303         LogInfo("IncrementAutoTargetServices: AutoTargetServices %d Record %s", m->AutoTargetServices, ARDisplayString(m, rr));
1304 
1305         // If this is the first advertised service and we did not just enable Bonjour above, then
1306         // advertise all the interface records.  If we did enable Bonjour above, the interface records will
1307         // be advertised during the network changed processing scheduled above, so no need
1308         // to do it here.
1309         if ((m->AutoTargetServices == 1) && (enablingBonjour == 0))
1310             AdvertiseAllInterfaceRecords(m);
1311     }
1312 }
1313 
1314 mDNSlocal void getKeepaliveRaddr(mDNS *const m, AuthRecord *rr, mDNSAddr *raddr)
1315 {
1316     mDNSAddr     laddr = zeroAddr;
1317     mDNSEthAddr  eth = zeroEthAddr;
1318     mDNSIPPort   lport = zeroIPPort;
1319     mDNSIPPort   rport = zeroIPPort;
1320     mDNSu32      timeout = 0;
1321     mDNSu32      seq = 0;
1322     mDNSu32      ack = 0;
1323     mDNSu16      win = 0;
1324 
1325     if (mDNS_KeepaliveRecord(&rr->resrec))
1326     {
1327         mDNS_ExtractKeepaliveInfo(rr, &timeout, &laddr, raddr, &eth, &seq, &ack, &lport, &rport, &win);
1328         if (!timeout || mDNSAddressIsZero(&laddr) || mDNSAddressIsZero(raddr) || mDNSIPPortIsZero(lport) || mDNSIPPortIsZero(rport))
1329         {
1330             LogMsg("getKeepaliveRaddr: not a valid record %s for keepalive %#a:%d %#a:%d", ARDisplayString(m, rr), &laddr, lport.NotAnInteger, raddr, rport.NotAnInteger);
1331             return;
1332         }
1333     }
1334 }
1335 
1336 // Exported so uDNS.c can call this
1337 mDNSexport mStatus mDNS_Register_internal(mDNS *const m, AuthRecord *const rr)
1338 {
1339     domainname *target = GetRRDomainNameTarget(&rr->resrec);
1340     AuthRecord *r;
1341     AuthRecord **p = &m->ResourceRecords;
1342     AuthRecord **d = &m->DuplicateRecords;
1343 
1344     if ((mDNSs32)rr->resrec.rroriginalttl <= 0)
1345     { LogMsg("mDNS_Register_internal: TTL %X should be 1 - 0x7FFFFFFF %s", rr->resrec.rroriginalttl, ARDisplayString(m, rr)); return(mStatus_BadParamErr); }
1346 
1347     if (!rr->resrec.RecordType)
1348     { LogMsg("mDNS_Register_internal: RecordType must be non-zero %s", ARDisplayString(m, rr)); return(mStatus_BadParamErr); }
1349 
1350     if (m->ShutdownTime)
1351     { LogMsg("mDNS_Register_internal: Shutting down, can't register %s", ARDisplayString(m, rr)); return(mStatus_ServiceNotRunning); }
1352 
1353     if (m->DivertMulticastAdvertisements && !AuthRecord_uDNS(rr))
1354     {
1355         mDNSInterfaceID previousID = rr->resrec.InterfaceID;
1356         if (rr->resrec.InterfaceID == mDNSInterface_Any || rr->resrec.InterfaceID == mDNSInterface_P2P)
1357         {
1358             rr->resrec.InterfaceID = mDNSInterface_LocalOnly;
1359             rr->ARType = AuthRecordLocalOnly;
1360         }
1361         if (rr->resrec.InterfaceID != mDNSInterface_LocalOnly)
1362         {
1363             NetworkInterfaceInfo *intf = FirstInterfaceForID(m, rr->resrec.InterfaceID);
1364             if (intf && !intf->Advertise) { rr->resrec.InterfaceID = mDNSInterface_LocalOnly; rr->ARType = AuthRecordLocalOnly; }
1365         }
1366         if (rr->resrec.InterfaceID != previousID)
1367             LogInfo("mDNS_Register_internal: Diverting record to local-only %s", ARDisplayString(m, rr));
1368     }
1369 
1370     if (RRLocalOnly(rr))
1371     {
1372         if (CheckAuthSameRecord(&m->rrauth, rr))
1373         {
1374             LogMsg("mDNS_Register_internal: ERROR!! Tried to register LocalOnly AuthRecord %p %##s (%s) that's already in the list",
1375                    rr, rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype));
1376             return(mStatus_AlreadyRegistered);
1377         }
1378     }
1379     else
1380     {
1381         while (*p && *p != rr) p=&(*p)->next;
1382         if (*p)
1383         {
1384             LogMsg("mDNS_Register_internal: ERROR!! Tried to register AuthRecord %p %##s (%s) that's already in the list",
1385                    rr, rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype));
1386             return(mStatus_AlreadyRegistered);
1387         }
1388     }
1389 
1390     while (*d && *d != rr) d=&(*d)->next;
1391     if (*d)
1392     {
1393         LogMsg("mDNS_Register_internal: ERROR!! Tried to register AuthRecord %p %##s (%s) that's already in the Duplicate list",
1394                rr, rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype));
1395         return(mStatus_AlreadyRegistered);
1396     }
1397 
1398     if (rr->DependentOn)
1399     {
1400         if (rr->resrec.RecordType == kDNSRecordTypeUnique)
1401             rr->resrec.RecordType =  kDNSRecordTypeVerified;
1402         else if (rr->resrec.RecordType != kDNSRecordTypeKnownUnique)
1403         {
1404             LogMsg("mDNS_Register_internal: ERROR! %##s (%s): rr->DependentOn && RecordType != kDNSRecordTypeUnique or kDNSRecordTypeKnownUnique",
1405                    rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype));
1406             return(mStatus_Invalid);
1407         }
1408         if (!(rr->DependentOn->resrec.RecordType & (kDNSRecordTypeUnique | kDNSRecordTypeVerified | kDNSRecordTypeKnownUnique)))
1409         {
1410             LogMsg("mDNS_Register_internal: ERROR! %##s (%s): rr->DependentOn->RecordType bad type %X",
1411                    rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype), rr->DependentOn->resrec.RecordType);
1412             return(mStatus_Invalid);
1413         }
1414     }
1415 
1416     rr->next = mDNSNULL;
1417 
1418     // Field Group 1: The actual information pertaining to this resource record
1419     // Set up by client prior to call
1420 
1421     // Field Group 2: Persistent metadata for Authoritative Records
1422 //  rr->Additional1       = set to mDNSNULL  in mDNS_SetupResourceRecord; may be overridden by client
1423 //  rr->Additional2       = set to mDNSNULL  in mDNS_SetupResourceRecord; may be overridden by client
1424 //  rr->DependentOn       = set to mDNSNULL  in mDNS_SetupResourceRecord; may be overridden by client
1425 //  rr->RRSet             = set to mDNSNULL  in mDNS_SetupResourceRecord; may be overridden by client
1426 //  rr->Callback          = already set      in mDNS_SetupResourceRecord
1427 //  rr->Context           = already set      in mDNS_SetupResourceRecord
1428 //  rr->RecordType        = already set      in mDNS_SetupResourceRecord
1429 //  rr->HostTarget        = set to mDNSfalse in mDNS_SetupResourceRecord; may be overridden by client
1430 //  rr->AllowRemoteQuery  = set to mDNSfalse in mDNS_SetupResourceRecord; may be overridden by client
1431     // Make sure target is not uninitialized data, or we may crash writing debugging log messages
1432     if (rr->AutoTarget && target) target->c[0] = 0;
1433 
1434     // Field Group 3: Transient state for Authoritative Records
1435     rr->Acknowledged      = mDNSfalse;
1436     rr->ProbeCount        = DefaultProbeCountForRecordType(rr->resrec.RecordType);
1437     rr->ProbeRestartCount = 0;
1438     rr->AnnounceCount     = InitialAnnounceCount;
1439     rr->RequireGoodbye    = mDNSfalse;
1440     rr->AnsweredLocalQ    = mDNSfalse;
1441     rr->IncludeInProbe    = mDNSfalse;
1442     rr->ImmedUnicast      = mDNSfalse;
1443     rr->SendNSECNow       = mDNSNULL;
1444     rr->ImmedAnswer       = mDNSNULL;
1445     rr->ImmedAdditional   = mDNSNULL;
1446     rr->SendRNow          = mDNSNULL;
1447     rr->v4Requester       = zerov4Addr;
1448     rr->v6Requester       = zerov6Addr;
1449     rr->NextResponse      = mDNSNULL;
1450     rr->NR_AnswerTo       = mDNSNULL;
1451     rr->NR_AdditionalTo   = mDNSNULL;
1452     if (!rr->AutoTarget) InitializeLastAPTime(m, rr);
1453 //  rr->LastAPTime        = Set for us in InitializeLastAPTime()
1454 //  rr->LastMCTime        = Set for us in InitializeLastAPTime()
1455 //  rr->LastMCInterface   = Set for us in InitializeLastAPTime()
1456     rr->NewRData          = mDNSNULL;
1457     rr->newrdlength       = 0;
1458     rr->UpdateCallback    = mDNSNULL;
1459     rr->UpdateCredits     = kMaxUpdateCredits;
1460     rr->NextUpdateCredit  = 0;
1461     rr->UpdateBlocked     = 0;
1462 
1463     // For records we're holding as proxy (except reverse-mapping PTR records) two announcements is sufficient
1464     if (rr->WakeUp.HMAC.l[0] && !rr->AddressProxy.type) rr->AnnounceCount = 2;
1465 
1466     // Field Group 4: Transient uDNS state for Authoritative Records
1467     rr->state             = regState_Zero;
1468     rr->uselease          = 0;
1469     rr->expire            = 0;
1470     rr->Private           = 0;
1471     rr->updateid          = zeroID;
1472     rr->updateIntID       = zeroOpaque64;
1473     rr->zone              = rr->resrec.name;
1474     rr->nta               = mDNSNULL;
1475     rr->tcp               = mDNSNULL;
1476     rr->OrigRData         = 0;
1477     rr->OrigRDLen         = 0;
1478     rr->InFlightRData     = 0;
1479     rr->InFlightRDLen     = 0;
1480     rr->QueuedRData       = 0;
1481     rr->QueuedRDLen       = 0;
1482     //mDNSPlatformMemZero(&rr->NATinfo, sizeof(rr->NATinfo));
1483     // We should be recording the actual internal port for this service record here. Once we initiate our NAT mapping
1484     // request we'll subsequently overwrite srv.port with the allocated external NAT port -- potentially multiple
1485     // times with different values if the external NAT port changes during the lifetime of the service registration.
1486     //if (rr->resrec.rrtype == kDNSType_SRV) rr->NATinfo.IntPort = rr->resrec.rdata->u.srv.port;
1487 
1488 //  rr->resrec.interface         = already set in mDNS_SetupResourceRecord
1489 //  rr->resrec.name->c           = MUST be set by client
1490 //  rr->resrec.rrtype            = already set in mDNS_SetupResourceRecord
1491 //  rr->resrec.rrclass           = already set in mDNS_SetupResourceRecord
1492 //  rr->resrec.rroriginalttl     = already set in mDNS_SetupResourceRecord
1493 //  rr->resrec.rdata             = MUST be set by client, unless record type is CNAME or PTR and rr->HostTarget is set
1494 
1495     // BIND named (name daemon) doesn't allow TXT records with zero-length rdata. This is strictly speaking correct,
1496     // since RFC 1035 specifies a TXT record as "One or more <character-string>s", not "Zero or more <character-string>s".
1497     // Since some legacy apps try to create zero-length TXT records, we'll silently correct it here.
1498     if (rr->resrec.rrtype == kDNSType_TXT && rr->resrec.rdlength == 0) { rr->resrec.rdlength = 1; rr->resrec.rdata->u.txt.c[0] = 0; }
1499 
1500     if (rr->AutoTarget)
1501     {
1502         SetTargetToHostName(m, rr); // Also sets rdlength and rdestimate for us, and calls InitializeLastAPTime();
1503 #ifndef UNICAST_DISABLED
1504         // If we have no target record yet, SetTargetToHostName will set rr->state == regState_NoTarget
1505         // In this case we leave the record half-formed in the list, and later we'll remove it from the list and re-add it properly.
1506         if (rr->state == regState_NoTarget)
1507         {
1508             // Initialize the target so that we don't crash while logging etc.
1509             domainname *tar = GetRRDomainNameTarget(&rr->resrec);
1510             if (tar) tar->c[0] = 0;
1511             LogInfo("mDNS_Register_internal: record %s in NoTarget state", ARDisplayString(m, rr));
1512         }
1513 #endif
1514     }
1515     else
1516     {
1517         rr->resrec.rdlength   = GetRDLength(&rr->resrec, mDNSfalse);
1518         rr->resrec.rdestimate = GetRDLength(&rr->resrec, mDNStrue);
1519     }
1520 
1521     if (!ValidateDomainName(rr->resrec.name))
1522     { LogMsg("Attempt to register record with invalid name: %s", ARDisplayString(m, rr)); return(mStatus_Invalid); }
1523 
1524     // Don't do this until *after* we've set rr->resrec.rdlength
1525     if (!ValidateRData(rr->resrec.rrtype, rr->resrec.rdlength, rr->resrec.rdata))
1526     { LogMsg("Attempt to register record with invalid rdata: %s", ARDisplayString(m, rr)); return(mStatus_Invalid); }
1527 
1528     rr->resrec.namehash   = DomainNameHashValue(rr->resrec.name);
1529     rr->resrec.rdatahash  = target ? DomainNameHashValue(target) : RDataHashValue(&rr->resrec);
1530 
1531     if (RRLocalOnly(rr))
1532     {
1533         // If this is supposed to be unique, make sure we don't have any name conflicts.
1534         // If we found a conflict, we may still want to insert the record in the list but mark it appropriately
1535         // (kDNSRecordTypeDeregistering) so that we deliver RMV events to the application. But this causes more
1536         // complications and not clear whether there are any benefits. See rdar:9304275 for details.
1537         // Hence, just bail out.
1538         // This comment is doesn’t make any sense. -- SC
1539         if (rr->resrec.RecordType & kDNSRecordTypeUniqueMask)
1540         {
1541             if (CheckAuthRecordConflict(&m->rrauth, rr))
1542             {
1543                 LogInfo("mDNS_Register_internal: Name conflict %s (%p), InterfaceID %p", ARDisplayString(m, rr), rr, rr->resrec.InterfaceID);
1544                 return mStatus_NameConflict;
1545             }
1546         }
1547     }
1548 
1549     // For uDNS records, we don't support duplicate checks at this time.
1550 #ifndef UNICAST_DISABLED
1551     if (AuthRecord_uDNS(rr))
1552     {
1553         if (!m->NewLocalRecords) m->NewLocalRecords = rr;
1554         // When we called SetTargetToHostName, it may have caused mDNS_Register_internal to be re-entered, appending new
1555         // records to the list, so we now need to update p to advance to the new end to the list before appending our new record.
1556         // Note that for AutoTunnel this should never happen, but this check makes the code future-proof.
1557         while (*p) p=&(*p)->next;
1558         *p = rr;
1559         if (rr->resrec.RecordType == kDNSRecordTypeUnique) rr->resrec.RecordType = kDNSRecordTypeVerified;
1560         rr->ProbeCount    = 0;
1561         rr->ProbeRestartCount = 0;
1562         rr->AnnounceCount = 0;
1563         if (rr->state != regState_NoTarget) ActivateUnicastRegistration(m, rr);
1564         return(mStatus_NoError);            // <--- Note: For unicast records, code currently bails out at this point
1565     }
1566 #endif
1567 
1568     // Now that we've finished building our new record, make sure it's not identical to one we already have
1569     if (RRLocalOnly(rr))
1570     {
1571         rr->ProbeCount    = 0;
1572         rr->ProbeRestartCount = 0;
1573         rr->AnnounceCount = 0;
1574         r = CheckAuthIdenticalRecord(&m->rrauth, rr);
1575     }
1576     else
1577     {
1578         for (r = m->ResourceRecords; r; r=r->next)
1579             if (RecordIsLocalDuplicate(r, rr))
1580             {
1581                 if (r->resrec.RecordType == kDNSRecordTypeDeregistering) r->AnnounceCount = 0;
1582                 else break;
1583             }
1584     }
1585 
1586     if (r)
1587     {
1588         LogInfo("mDNS_Register_internal: Adding to duplicate list %s", ARDisplayString(m,rr));
1589         *d = rr;
1590         // If the previous copy of this record is already verified unique,
1591         // then indicate that we should move this record promptly to kDNSRecordTypeUnique state.
1592         // Setting ProbeCount to zero will cause SendQueries() to advance this record to
1593         // kDNSRecordTypeVerified state and call the client callback at the next appropriate time.
1594         if (rr->resrec.RecordType == kDNSRecordTypeUnique && r->resrec.RecordType == kDNSRecordTypeVerified)
1595             rr->ProbeCount = 0;
1596     }
1597     else
1598     {
1599         LogInfo("mDNS_Register_internal: Adding to active record list %s", ARDisplayString(m,rr));
1600         if (RRLocalOnly(rr))
1601         {
1602             AuthGroup *ag;
1603             ag = InsertAuthRecord(m, &m->rrauth, rr);
1604             if (ag && !ag->NewLocalOnlyRecords)
1605             {
1606                 m->NewLocalOnlyRecords = mDNStrue;
1607                 ag->NewLocalOnlyRecords = rr;
1608             }
1609             // No probing for LocalOnly records; acknowledge them right away
1610             if (rr->resrec.RecordType == kDNSRecordTypeUnique) rr->resrec.RecordType = kDNSRecordTypeVerified;
1611             AcknowledgeRecord(m, rr);
1612             return(mStatus_NoError);
1613         }
1614         else
1615         {
1616             if (!m->NewLocalRecords) m->NewLocalRecords = rr;
1617             *p = rr;
1618         }
1619     }
1620 
1621     if (!AuthRecord_uDNS(rr))   // This check is superfluous, given that for unicast records we (currently) bail out above
1622     {
1623         // We have inserted the record in the list. See if we have to advertise the A/AAAA, HINFO, PTR records.
1624         IncrementAutoTargetServices(m, rr);
1625 
1626         // For records that are not going to probe, acknowledge them right away
1627         if (rr->resrec.RecordType != kDNSRecordTypeUnique && rr->resrec.RecordType != kDNSRecordTypeDeregistering)
1628             AcknowledgeRecord(m, rr);
1629 
1630         // Adding a record may affect whether or not we should sleep
1631         mDNS_UpdateAllowSleep(m);
1632     }
1633 
1634     // If this is a non-sleep proxy keepalive record, fetch the MAC address of the remote host.
1635     // This is used by the in-NIC proxy to send the keepalive packets.
1636     if (!rr->WakeUp.HMAC.l[0] && mDNS_KeepaliveRecord(&rr->resrec))
1637     {
1638         mDNSAddr raddr;
1639         // Set the record type to known unique to prevent probing keep alive records.
1640         // Also make sure we do not announce the keepalive records.
1641        rr->resrec.RecordType = kDNSRecordTypeKnownUnique;
1642        rr->AnnounceCount     = 0;
1643        getKeepaliveRaddr(m, rr, &raddr);
1644        // This is an asynchronous call. Once the remote MAC address is available, helper will schedule an
1645        // asynchronous task to update the resource record
1646        mDNSPlatformGetRemoteMacAddr(&raddr);
1647     }
1648 
1649     return(mStatus_NoError);
1650 }
1651 
1652 mDNSlocal void RecordProbeFailure(mDNS *const m, const AuthRecord *const rr)
1653 {
1654     m->ProbeFailTime = m->timenow;
1655     m->NumFailedProbes++;
1656     // If we've had fifteen or more probe failures, rate-limit to one every five seconds.
1657     // If a bunch of hosts have all been configured with the same name, then they'll all
1658     // conflict and run through the same series of names: name-2, name-3, name-4, etc.,
1659     // up to name-10. After that they'll start adding random increments in the range 1-100,
1660     // so they're more likely to branch out in the available namespace and settle on a set of
1661     // unique names quickly. If after five more tries the host is still conflicting, then we
1662     // may have a serious problem, so we start rate-limiting so we don't melt down the network.
1663     if (m->NumFailedProbes >= 15)
1664     {
1665         m->SuppressProbes = NonZeroTime(m->timenow + mDNSPlatformOneSecond * 5);
1666         LogMsg("Excessive name conflicts (%lu) for %##s (%s); rate limiting in effect",
1667                m->NumFailedProbes, rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype));
1668     }
1669 }
1670 
1671 mDNSlocal void CompleteRDataUpdate(mDNS *const m, AuthRecord *const rr)
1672 {
1673     RData *OldRData = rr->resrec.rdata;
1674     mDNSu16 OldRDLen = rr->resrec.rdlength;
1675     SetNewRData(&rr->resrec, rr->NewRData, rr->newrdlength);    // Update our rdata
1676     rr->NewRData = mDNSNULL;                                    // Clear the NewRData pointer ...
1677     if (rr->UpdateCallback)
1678         rr->UpdateCallback(m, rr, OldRData, OldRDLen);          // ... and let the client know
1679 }
1680 
1681 // Note: mDNS_Deregister_internal can call a user callback, which may change the record list and/or question list.
1682 // Any code walking either list must use the CurrentQuestion and/or CurrentRecord mechanism to protect against this.
1683 // Exported so uDNS.c can call this
1684 mDNSexport mStatus mDNS_Deregister_internal(mDNS *const m, AuthRecord *const rr, mDNS_Dereg_type drt)
1685 {
1686     AuthRecord *r2;
1687     mDNSu8 RecordType = rr->resrec.RecordType;
1688     AuthRecord **p = &m->ResourceRecords;   // Find this record in our list of active records
1689     mDNSBool dupList = mDNSfalse;
1690 
1691     if (RRLocalOnly(rr))
1692     {
1693         AuthGroup *a;
1694         AuthRecord **rp;
1695 
1696         a = AuthGroupForRecord(&m->rrauth, &rr->resrec);
1697         if (!a) return mDNSfalse;
1698         rp = &a->members;
1699         while (*rp && *rp != rr) rp=&(*rp)->next;
1700         p = rp;
1701     }
1702     else
1703     {
1704         while (*p && *p != rr) p=&(*p)->next;
1705     }
1706 
1707     if (*p)
1708     {
1709         // We found our record on the main list. See if there are any duplicates that need special handling.
1710         if (drt == mDNS_Dereg_conflict)     // If this was a conflict, see that all duplicates get the same treatment
1711         {
1712             // Scan for duplicates of rr, and mark them for deregistration at the end of this routine, after we've finished
1713             // deregistering rr. We need to do this scan *before* we give the client the chance to free and reuse the rr memory.
1714             for (r2 = m->DuplicateRecords; r2; r2=r2->next) if (RecordIsLocalDuplicate(r2, rr)) r2->ProbeCount = 0xFF;
1715         }
1716         else
1717         {
1718             // Before we delete the record (and potentially send a goodbye packet)
1719             // first see if we have a record on the duplicate list ready to take over from it.
1720             AuthRecord **d = &m->DuplicateRecords;
1721             while (*d && !RecordIsLocalDuplicate(*d, rr)) d=&(*d)->next;
1722             if (*d)
1723             {
1724                 AuthRecord *dup = *d;
1725                 debugf("mDNS_Register_internal: Duplicate record %p taking over from %p %##s (%s)",
1726                        dup, rr, rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype));
1727                 *d        = dup->next;      // Cut replacement record from DuplicateRecords list
1728                 if (RRLocalOnly(rr))
1729                 {
1730                     dup->next = mDNSNULL;
1731                     if (!InsertAuthRecord(m, &m->rrauth, dup)) LogMsg("mDNS_Deregister_internal: ERROR!! cannot insert %s", ARDisplayString(m, dup));
1732                 }
1733                 else
1734                 {
1735                     dup->next = rr->next;       // And then...
1736                     rr->next  = dup;            // ... splice it in right after the record we're about to delete
1737                 }
1738                 dup->resrec.RecordType        = rr->resrec.RecordType;
1739                 dup->ProbeCount      = rr->ProbeCount;
1740                 dup->ProbeRestartCount = rr->ProbeRestartCount;
1741                 dup->AnnounceCount   = rr->AnnounceCount;
1742                 dup->RequireGoodbye  = rr->RequireGoodbye;
1743                 dup->AnsweredLocalQ  = rr->AnsweredLocalQ;
1744                 dup->ImmedAnswer     = rr->ImmedAnswer;
1745                 dup->ImmedUnicast    = rr->ImmedUnicast;
1746                 dup->ImmedAdditional = rr->ImmedAdditional;
1747                 dup->v4Requester     = rr->v4Requester;
1748                 dup->v6Requester     = rr->v6Requester;
1749                 dup->ThisAPInterval  = rr->ThisAPInterval;
1750                 dup->LastAPTime      = rr->LastAPTime;
1751                 dup->LastMCTime      = rr->LastMCTime;
1752                 dup->LastMCInterface = rr->LastMCInterface;
1753                 dup->Private         = rr->Private;
1754                 dup->state           = rr->state;
1755                 rr->RequireGoodbye = mDNSfalse;
1756                 rr->AnsweredLocalQ = mDNSfalse;
1757             }
1758         }
1759     }
1760     else
1761     {
1762         // We didn't find our record on the main list; try the DuplicateRecords list instead.
1763         p = &m->DuplicateRecords;
1764         while (*p && *p != rr) p=&(*p)->next;
1765         // If we found our record on the duplicate list, then make sure we don't send a goodbye for it
1766         if (*p)
1767         {
1768             // Duplicate records are not used for sending wakeups or goodbyes. Hence, deregister them
1769             // immediately. When there is a conflict, we deregister all the conflicting duplicate records
1770             // also that have been marked above in this function. In that case, we come here and if we don't
1771             // deregister (unilink from the DuplicateRecords list), we will be recursing infinitely. Hence,
1772             // clear the HMAC which will cause it to deregister. See <rdar://problem/10380988> for
1773             // details.
1774             rr->WakeUp.HMAC    = zeroEthAddr;
1775             rr->RequireGoodbye = mDNSfalse;
1776             rr->resrec.RecordType = kDNSRecordTypeDeregistering;
1777             dupList = mDNStrue;
1778         }
1779         if (*p) debugf("mDNS_Deregister_internal: Deleting DuplicateRecord %p %##s (%s)",
1780                        rr, rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype));
1781     }
1782 
1783     if (!*p)
1784     {
1785         // No need to log an error message if we already know this is a potentially repeated deregistration
1786         if (drt != mDNS_Dereg_repeat)
1787             LogMsg("mDNS_Deregister_internal: Record %p not found in list %s", rr, ARDisplayString(m,rr));
1788         return(mStatus_BadReferenceErr);
1789     }
1790 
1791     // If this is a shared record and we've announced it at least once,
1792     // we need to retract that announcement before we delete the record
1793 
1794     // If this is a record (including mDNSInterface_LocalOnly records) for which we've given local-only answers then
1795     // it's tempting to just do "AnswerAllLocalQuestionsWithLocalAuthRecord(m, rr, mDNSfalse)" here, but that would not not be safe.
1796     // The AnswerAllLocalQuestionsWithLocalAuthRecord routine walks the question list invoking client callbacks, using the "m->CurrentQuestion"
1797     // mechanism to cope with the client callback modifying the question list while that's happening.
1798     // However, mDNS_Deregister could have been called from a client callback (e.g. from the domain enumeration callback FoundDomain)
1799     // which means that the "m->CurrentQuestion" mechanism is already in use to protect that list, so we can't use it twice.
1800     // More generally, if we invoke callbacks from within a client callback, then those callbacks could deregister other
1801     // records, thereby invoking yet more callbacks, without limit.
1802     // The solution is to defer delivering the "Remove" events until mDNS_Execute time, just like we do for sending
1803     // actual goodbye packets.
1804 
1805 #ifndef UNICAST_DISABLED
1806     if (AuthRecord_uDNS(rr))
1807     {
1808         if (rr->RequireGoodbye)
1809         {
1810             if (rr->tcp) { DisposeTCPConn(rr->tcp); rr->tcp = mDNSNULL; }
1811             rr->resrec.RecordType    = kDNSRecordTypeDeregistering;
1812             m->LocalRemoveEvents     = mDNStrue;
1813             uDNS_DeregisterRecord(m, rr);
1814             // At this point unconditionally we bail out
1815             // Either uDNS_DeregisterRecord will have completed synchronously, and called CompleteDeregistration,
1816             // which calls us back here with RequireGoodbye set to false, or it will have initiated the deregistration
1817             // process and will complete asynchronously. Either way we don't need to do anything more here.
1818             return(mStatus_NoError);
1819         }
1820         // Sometimes the records don't complete proper deregistration i.e., don't wait for a response
1821         // from the server. In that case, if the records have been part of a group update, clear the
1822         // state here. Some recors e.g., AutoTunnel gets reused without ever being completely initialized
1823         rr->updateid = zeroID;
1824 
1825         // We defer cleaning up NAT state only after sending goodbyes. This is important because
1826         // RecordRegistrationGotZoneData guards against creating NAT state if clientContext is non-NULL.
1827         // This happens today when we turn on/off interface where we get multiple network transitions
1828         // and RestartRecordGetZoneData triggers re-registration of the resource records even though
1829         // they may be in Registered state which causes NAT information to be setup multiple times. Defering
1830         // the cleanup here keeps clientContext non-NULL and hence prevents that. Note that cleaning up
1831         // NAT state here takes care of the case where we did not send goodbyes at all.
1832         if (rr->NATinfo.clientContext)
1833         {
1834             mDNS_StopNATOperation_internal(m, &rr->NATinfo);
1835             rr->NATinfo.clientContext = mDNSNULL;
1836         }
1837         if (rr->nta) { CancelGetZoneData(m, rr->nta); rr->nta = mDNSNULL; }
1838         if (rr->tcp) { DisposeTCPConn(rr->tcp);       rr->tcp = mDNSNULL; }
1839     }
1840 #endif // UNICAST_DISABLED
1841 
1842     if      (RecordType == kDNSRecordTypeUnregistered)
1843         LogMsg("mDNS_Deregister_internal: %s already marked kDNSRecordTypeUnregistered", ARDisplayString(m, rr));
1844     else if (RecordType == kDNSRecordTypeDeregistering)
1845     {
1846         LogMsg("mDNS_Deregister_internal: %s already marked kDNSRecordTypeDeregistering", ARDisplayString(m, rr));
1847         return(mStatus_BadReferenceErr);
1848     }
1849 
1850     // <rdar://problem/7457925> Local-only questions don't get remove events for unique records
1851     // We may want to consider changing this code so that we generate local-only question "rmv"
1852     // events (and maybe goodbye packets too) for unique records as well as for shared records
1853     // Note: If we change the logic for this "if" statement, need to ensure that the code in
1854     // CompleteDeregistration() sets the appropriate state variables to gaurantee that "else"
1855     // clause will execute here and the record will be cut from the list.
1856     if (rr->WakeUp.HMAC.l[0] ||
1857         (RecordType == kDNSRecordTypeShared && (rr->RequireGoodbye || rr->AnsweredLocalQ)))
1858     {
1859         verbosedebugf("mDNS_Deregister_internal: Starting deregistration for %s", ARDisplayString(m, rr));
1860         rr->resrec.RecordType    = kDNSRecordTypeDeregistering;
1861         rr->resrec.rroriginalttl = 0;
1862         rr->AnnounceCount        = rr->WakeUp.HMAC.l[0] ? WakeupCount : (drt == mDNS_Dereg_rapid) ? 1 : GoodbyeCount;
1863         rr->ThisAPInterval       = mDNSPlatformOneSecond * 2;
1864         rr->LastAPTime           = m->timenow - rr->ThisAPInterval;
1865         m->LocalRemoveEvents     = mDNStrue;
1866         if (m->NextScheduledResponse - (m->timenow + mDNSPlatformOneSecond/10) >= 0)
1867             m->NextScheduledResponse = (m->timenow + mDNSPlatformOneSecond/10);
1868     }
1869     else
1870     {
1871         if (!dupList && RRLocalOnly(rr))
1872         {
1873             AuthGroup *ag = RemoveAuthRecord(m, &m->rrauth, rr);
1874             if (ag->NewLocalOnlyRecords == rr) ag->NewLocalOnlyRecords = rr->next;
1875         }
1876         else
1877         {
1878             *p = rr->next;                  // Cut this record from the list
1879             if (m->NewLocalRecords == rr) m->NewLocalRecords = rr->next;
1880             DecrementAutoTargetServices(m, rr);
1881         }
1882         // If someone is about to look at this, bump the pointer forward
1883         if (m->CurrentRecord   == rr) m->CurrentRecord   = rr->next;
1884         rr->next = mDNSNULL;
1885 
1886         // Should we generate local remove events here?
1887         // i.e. something like:
1888         // if (rr->AnsweredLocalQ) { AnswerAllLocalQuestionsWithLocalAuthRecord(m, rr, mDNSfalse); rr->AnsweredLocalQ = mDNSfalse; }
1889 
1890         verbosedebugf("mDNS_Deregister_internal: Deleting record for %s", ARDisplayString(m, rr));
1891         rr->resrec.RecordType = kDNSRecordTypeUnregistered;
1892 
1893         if ((drt == mDNS_Dereg_conflict || drt == mDNS_Dereg_repeat) && RecordType == kDNSRecordTypeShared)
1894             debugf("mDNS_Deregister_internal: Cannot have a conflict on a shared record! %##s (%s)",
1895                    rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype));
1896 
1897         // If we have an update queued up which never executed, give the client a chance to free that memory
1898         if (rr->NewRData) CompleteRDataUpdate(m, rr);   // Update our rdata, clear the NewRData pointer, and return memory to the client
1899 
1900 
1901         // CAUTION: MUST NOT do anything more with rr after calling rr->Callback(), because the client's callback function
1902         // is allowed to do anything, including starting/stopping queries, registering/deregistering records, etc.
1903         // In this case the likely client action to the mStatus_MemFree message is to free the memory,
1904         // so any attempt to touch rr after this is likely to lead to a crash.
1905         if (drt != mDNS_Dereg_conflict)
1906         {
1907             mDNS_DropLockBeforeCallback();      // Allow client to legally make mDNS API calls from the callback
1908             LogInfo("mDNS_Deregister_internal: callback with mStatus_MemFree for %s", ARDisplayString(m, rr));
1909             if (rr->RecordCallback)
1910                 rr->RecordCallback(m, rr, mStatus_MemFree);         // MUST NOT touch rr after this
1911             mDNS_ReclaimLockAfterCallback();    // Decrement mDNS_reentrancy to block mDNS API calls again
1912         }
1913         else
1914         {
1915             RecordProbeFailure(m, rr);
1916             mDNS_DropLockBeforeCallback();      // Allow client to legally make mDNS API calls from the callback
1917             if (rr->RecordCallback)
1918                 rr->RecordCallback(m, rr, mStatus_NameConflict);    // MUST NOT touch rr after this
1919             mDNS_ReclaimLockAfterCallback();    // Decrement mDNS_reentrancy to block mDNS API calls again
1920             // Now that we've finished deregistering rr, check our DuplicateRecords list for any that we marked previously.
1921             // Note that with all the client callbacks going on, by the time we get here all the
1922             // records we marked may have been explicitly deregistered by the client anyway.
1923             r2 = m->DuplicateRecords;
1924             while (r2)
1925             {
1926                 if (r2->ProbeCount != 0xFF)
1927                 {
1928                     r2 = r2->next;
1929                 }
1930                 else
1931                 {
1932 #if APPLE_OSX_mDNSResponder
1933                     // See if this record was also registered with any D2D plugins.
1934                     D2D_stop_advertising_record(r2);
1935 #endif
1936                     mDNS_Deregister_internal(m, r2, mDNS_Dereg_conflict);
1937                     // As this is a duplicate record, it will be unlinked from the list
1938                     // immediately
1939                     r2 = m->DuplicateRecords;
1940                 }
1941             }
1942         }
1943     }
1944     mDNS_UpdateAllowSleep(m);
1945     return(mStatus_NoError);
1946 }
1947 
1948 // ***************************************************************************
1949 #if COMPILER_LIKES_PRAGMA_MARK
1950 #pragma mark -
1951 #pragma mark - Packet Sending Functions
1952 #endif
1953 
1954 mDNSlocal void AddRecordToResponseList(AuthRecord ***nrpp, AuthRecord *rr, AuthRecord *add)
1955 {
1956     if (rr->NextResponse == mDNSNULL && *nrpp != &rr->NextResponse)
1957     {
1958         **nrpp = rr;
1959         // NR_AdditionalTo must point to a record with NR_AnswerTo set (and not NR_AdditionalTo)
1960         // If 'add' does not meet this requirement, then follow its NR_AdditionalTo pointer to a record that does
1961         // The referenced record will definitely be acceptable (by recursive application of this rule)
1962         if (add && add->NR_AdditionalTo) add = add->NR_AdditionalTo;
1963         rr->NR_AdditionalTo = add;
1964         *nrpp = &rr->NextResponse;
1965     }
1966     debugf("AddRecordToResponseList: %##s (%s) already in list", rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype));
1967 }
1968 
1969 mDNSlocal void AddRRSetAdditionalsToResponseList(mDNS *const m, AuthRecord ***nrpp, AuthRecord *rr, AuthRecord *additional, const mDNSInterfaceID InterfaceID)
1970 {
1971     AuthRecord *rr2;
1972     if (additional->resrec.RecordType & kDNSRecordTypeUniqueMask)
1973     {
1974         for (rr2 = m->ResourceRecords; rr2; rr2 = rr2->next)
1975         {
1976             if ((rr2->resrec.namehash == additional->resrec.namehash) &&
1977                 (rr2->resrec.rrtype   == additional->resrec.rrtype) &&
1978                 (rr2 != additional) &&
1979                 (rr2->resrec.RecordType & kDNSRecordTypeUniqueMask) &&
1980                 (rr2->resrec.rrclass  == additional->resrec.rrclass) &&
1981                 ResourceRecordIsValidInterfaceAnswer(rr2, InterfaceID) &&
1982                 SameDomainName(rr2->resrec.name, additional->resrec.name))
1983             {
1984                 AddRecordToResponseList(nrpp, rr2, rr);
1985             }
1986         }
1987     }
1988 }
1989 
1990 mDNSlocal void AddAdditionalsToResponseList(mDNS *const m, AuthRecord *ResponseRecords, AuthRecord ***nrpp, const mDNSInterfaceID InterfaceID)
1991 {
1992     AuthRecord  *rr, *rr2;
1993     for (rr=ResponseRecords; rr; rr=rr->NextResponse)           // For each record we plan to put
1994     {
1995         // (Note: This is an "if", not a "while". If we add a record, we'll find it again
1996         // later in the "for" loop, and we will follow further "additional" links then.)
1997         if (rr->Additional1 && ResourceRecordIsValidInterfaceAnswer(rr->Additional1, InterfaceID))
1998         {
1999             AddRecordToResponseList(nrpp, rr->Additional1, rr);
2000             AddRRSetAdditionalsToResponseList(m, nrpp, rr, rr->Additional1, InterfaceID);
2001         }
2002 
2003         if (rr->Additional2 && ResourceRecordIsValidInterfaceAnswer(rr->Additional2, InterfaceID))
2004         {
2005             AddRecordToResponseList(nrpp, rr->Additional2, rr);
2006             AddRRSetAdditionalsToResponseList(m, nrpp, rr, rr->Additional2, InterfaceID);
2007         }
2008 
2009         // For SRV records, automatically add the Address record(s) for the target host
2010         if (rr->resrec.rrtype == kDNSType_SRV)
2011         {
2012             for (rr2=m->ResourceRecords; rr2; rr2=rr2->next)                    // Scan list of resource records
2013                 if (RRTypeIsAddressType(rr2->resrec.rrtype) &&                  // For all address records (A/AAAA) ...
2014                     ResourceRecordIsValidInterfaceAnswer(rr2, InterfaceID) &&   // ... which are valid for answer ...
2015                     rr->resrec.rdatahash == rr2->resrec.namehash &&         // ... whose name is the name of the SRV target
2016                     SameDomainName(&rr->resrec.rdata->u.srv.target, rr2->resrec.name))
2017                     AddRecordToResponseList(nrpp, rr2, rr);
2018         }
2019         else if (RRTypeIsAddressType(rr->resrec.rrtype))    // For A or AAAA, put counterpart as additional
2020         {
2021             for (rr2=m->ResourceRecords; rr2; rr2=rr2->next)                    // Scan list of resource records
2022                 if (RRTypeIsAddressType(rr2->resrec.rrtype) &&                  // For all address records (A/AAAA) ...
2023                     ResourceRecordIsValidInterfaceAnswer(rr2, InterfaceID) &&   // ... which are valid for answer ...
2024                     rr->resrec.namehash == rr2->resrec.namehash &&              // ... and have the same name
2025                     SameDomainName(rr->resrec.name, rr2->resrec.name))
2026                     AddRecordToResponseList(nrpp, rr2, rr);
2027         }
2028         else if (rr->resrec.rrtype == kDNSType_PTR)         // For service PTR, see if we want to add DeviceInfo record
2029         {
2030             if (ResourceRecordIsValidInterfaceAnswer(&m->DeviceInfo, InterfaceID) &&
2031                 SameDomainLabel(rr->resrec.rdata->u.name.c, m->DeviceInfo.resrec.name->c))
2032                 AddRecordToResponseList(nrpp, &m->DeviceInfo, rr);
2033         }
2034     }
2035 }
2036 
2037 mDNSlocal int AnonInfoSpace(AnonymousInfo *info)
2038 {
2039     ResourceRecord *rr = info->nsec3RR;
2040 
2041     // 2 bytes for compressed name + type (2) class (2) TTL (4) rdlength (2) rdata (n)
2042     return (2 + 10 + rr->rdlength);
2043 }
2044 
2045 mDNSlocal void SendDelayedUnicastResponse(mDNS *const m, const mDNSAddr *const dest, const mDNSInterfaceID InterfaceID)
2046 {
2047     AuthRecord *rr;
2048     AuthRecord  *ResponseRecords = mDNSNULL;
2049     AuthRecord **nrp             = &ResponseRecords;
2050     NetworkInterfaceInfo *intf = FirstInterfaceForID(m, InterfaceID);
2051     int AnoninfoSpace = 0;
2052 
2053     // Make a list of all our records that need to be unicast to this destination
2054     for (rr = m->ResourceRecords; rr; rr=rr->next)
2055     {
2056         // If we find we can no longer unicast this answer, clear ImmedUnicast
2057         if (rr->ImmedAnswer == mDNSInterfaceMark               ||
2058             mDNSSameIPv4Address(rr->v4Requester, onesIPv4Addr) ||
2059             mDNSSameIPv6Address(rr->v6Requester, onesIPv6Addr)  )
2060             rr->ImmedUnicast = mDNSfalse;
2061 
2062         if (rr->ImmedUnicast && rr->ImmedAnswer == InterfaceID)
2063         {
2064             if ((dest->type == mDNSAddrType_IPv4 && mDNSSameIPv4Address(rr->v4Requester, dest->ip.v4)) ||
2065                 (dest->type == mDNSAddrType_IPv6 && mDNSSameIPv6Address(rr->v6Requester, dest->ip.v6)))
2066             {
2067                 rr->ImmedAnswer  = mDNSNULL;                // Clear the state fields
2068                 rr->ImmedUnicast = mDNSfalse;
2069                 rr->v4Requester  = zerov4Addr;
2070                 rr->v6Requester  = zerov6Addr;
2071 
2072                 // Only sent records registered for P2P over P2P interfaces
2073                 if (intf && !mDNSPlatformValidRecordForInterface(rr, intf->InterfaceID))
2074                 {
2075                     continue;
2076                 }
2077 
2078                 if (rr->NextResponse == mDNSNULL && nrp != &rr->NextResponse)   // rr->NR_AnswerTo
2079                 {
2080                     rr->NR_AnswerTo = NR_AnswerMulticast;
2081                     *nrp = rr;
2082                     nrp = &rr->NextResponse;
2083                 }
2084             }
2085         }
2086     }
2087 
2088     AddAdditionalsToResponseList(m, ResponseRecords, &nrp, InterfaceID);
2089 
2090     while (ResponseRecords)
2091     {
2092         mDNSu8 *responseptr = m->omsg.data;
2093         mDNSu8 *newptr;
2094         InitializeDNSMessage(&m->omsg.h, zeroID, ResponseFlags);
2095 
2096         // Put answers in the packet
2097         while (ResponseRecords && ResponseRecords->NR_AnswerTo)
2098         {
2099             rr = ResponseRecords;
2100             if (rr->resrec.AnonInfo)
2101             {
2102                 AnoninfoSpace += AnonInfoSpace(rr->resrec.AnonInfo);
2103                 rr->resrec.AnonInfo->SendNow = mDNSInterfaceMark;
2104             }
2105             if (rr->resrec.RecordType & kDNSRecordTypeUniqueMask)
2106                 rr->resrec.rrclass |= kDNSClass_UniqueRRSet;        // Temporarily set the cache flush bit so PutResourceRecord will set it
2107 
2108             // Retract the limit by AnoninfoSpace which we need to put the AnoInfo option.
2109             newptr = PutResourceRecordTTLWithLimit(&m->omsg, responseptr, &m->omsg.h.numAnswers, &rr->resrec, rr->resrec.rroriginalttl,
2110                  m->omsg.data + (AllowedRRSpace(&m->omsg) - AnoninfoSpace));
2111 
2112             rr->resrec.rrclass &= ~kDNSClass_UniqueRRSet;           // Make sure to clear cache flush bit back to normal state
2113             if (!newptr && m->omsg.h.numAnswers)
2114             {
2115                 break; // If packet full, send it now
2116             }
2117             if (newptr) responseptr = newptr;
2118             ResponseRecords = rr->NextResponse;
2119             rr->NextResponse    = mDNSNULL;
2120             rr->NR_AnswerTo     = mDNSNULL;
2121             rr->NR_AdditionalTo = mDNSNULL;
2122             rr->RequireGoodbye  = mDNStrue;
2123         }
2124 
2125         // We have reserved the space for AnonInfo option. PutResourceRecord uses the
2126         // standard limit (AllowedRRSpace) and we should have space now.
2127         for (rr = m->ResourceRecords; rr; rr=rr->next)
2128         {
2129             if (rr->resrec.AnonInfo && rr->resrec.AnonInfo->SendNow == mDNSInterfaceMark)
2130             {
2131                 ResourceRecord *nsec3RR = rr->resrec.AnonInfo->nsec3RR;
2132 
2133                 newptr = PutResourceRecord(&m->omsg, responseptr, &m->omsg.h.numAuthorities, nsec3RR);
2134                 if (newptr)
2135                 {
2136                     responseptr = newptr;
2137                     debugf("SendDelayedUnicastResponse: Added NSEC3 Record %s on %p", RRDisplayString(m, nsec3RR), intf->InterfaceID);
2138                 }
2139                 else
2140                 {
2141                     // We allocated space and we should not fail. Don't break, we need to clear the SendNow flag.
2142                     LogMsg("SendDelayedUnicastResponse: ERROR!! Cannot Add NSEC3 Record %s on %p", RRDisplayString(m, nsec3RR), intf->InterfaceID);
2143                 }
2144                 rr->resrec.AnonInfo->SendNow = mDNSNULL;
2145             }
2146         }
2147 
2148         // Add additionals, if there's space
2149         while (ResponseRecords && !ResponseRecords->NR_AnswerTo)
2150         {
2151             rr = ResponseRecords;
2152             if (rr->resrec.RecordType & kDNSRecordTypeUniqueMask)
2153                 rr->resrec.rrclass |= kDNSClass_UniqueRRSet;        // Temporarily set the cache flush bit so PutResourceRecord will set it
2154             newptr = PutResourceRecord(&m->omsg, responseptr, &m->omsg.h.numAdditionals, &rr->resrec);
2155             rr->resrec.rrclass &= ~kDNSClass_UniqueRRSet;           // Make sure to clear cache flush bit back to normal state
2156 
2157             if (newptr) responseptr = newptr;
2158             if (newptr && m->omsg.h.numAnswers) rr->RequireGoodbye = mDNStrue;
2159             else if (rr->resrec.RecordType & kDNSRecordTypeUniqueMask) rr->ImmedAnswer = mDNSInterfaceMark;
2160             ResponseRecords = rr->NextResponse;
2161             rr->NextResponse    = mDNSNULL;
2162             rr->NR_AnswerTo     = mDNSNULL;
2163             rr->NR_AdditionalTo = mDNSNULL;
2164         }
2165 
2166         if (m->omsg.h.numAnswers)
2167             mDNSSendDNSMessage(m, &m->omsg, responseptr, InterfaceID, mDNSNULL, dest, MulticastDNSPort, mDNSNULL, mDNSNULL, mDNSfalse);
2168     }
2169 }
2170 
2171 // CompleteDeregistration guarantees that on exit the record will have been cut from the m->ResourceRecords list
2172 // and the client's mStatus_MemFree callback will have been invoked
2173 mDNSexport void CompleteDeregistration(mDNS *const m, AuthRecord *rr)
2174 {
2175     LogInfo("CompleteDeregistration: called for Resource record %s", ARDisplayString(m, rr));
2176     // Clearing rr->RequireGoodbye signals mDNS_Deregister_internal() that
2177     // it should go ahead and immediately dispose of this registration
2178     rr->resrec.RecordType = kDNSRecordTypeShared;
2179     rr->RequireGoodbye    = mDNSfalse;
2180     rr->WakeUp.HMAC       = zeroEthAddr;
2181     if (rr->AnsweredLocalQ) { AnswerAllLocalQuestionsWithLocalAuthRecord(m, rr, QC_rmv); rr->AnsweredLocalQ = mDNSfalse; }
2182     mDNS_Deregister_internal(m, rr, mDNS_Dereg_normal);     // Don't touch rr after this
2183 }
2184 
2185 // DiscardDeregistrations is used on shutdown and sleep to discard (forcibly and immediately)
2186 // any deregistering records that remain in the m->ResourceRecords list.
2187 // DiscardDeregistrations calls mDNS_Deregister_internal which can call a user callback,
2188 // which may change the record list and/or question list.
2189 // Any code walking either list must use the CurrentQuestion and/or CurrentRecord mechanism to protect against this.
2190 mDNSlocal void DiscardDeregistrations(mDNS *const m)
2191 {
2192     if (m->CurrentRecord)
2193         LogMsg("DiscardDeregistrations ERROR m->CurrentRecord already set %s", ARDisplayString(m, m->CurrentRecord));
2194     m->CurrentRecord = m->ResourceRecords;
2195 
2196     while (m->CurrentRecord)
2197     {
2198         AuthRecord *rr = m->CurrentRecord;
2199         if (!AuthRecord_uDNS(rr) && rr->resrec.RecordType == kDNSRecordTypeDeregistering)
2200             CompleteDeregistration(m, rr);      // Don't touch rr after this
2201         else
2202             m->CurrentRecord = rr->next;
2203     }
2204 }
2205 
2206 mDNSlocal mStatus GetLabelDecimalValue(const mDNSu8 *const src, mDNSu8 *dst)
2207 {
2208     int i, val = 0;
2209     if (src[0] < 1 || src[0] > 3) return(mStatus_Invalid);
2210     for (i=1; i<=src[0]; i++)
2211     {
2212         if (src[i] < '0' || src[i] > '9') return(mStatus_Invalid);
2213         val = val * 10 + src[i] - '0';
2214     }
2215     if (val > 255) return(mStatus_Invalid);
2216     *dst = (mDNSu8)val;
2217     return(mStatus_NoError);
2218 }
2219 
2220 mDNSlocal mStatus GetIPv4FromName(mDNSAddr *const a, const domainname *const name)
2221 {
2222     int skip = CountLabels(name) - 6;
2223     if (skip < 0) { LogMsg("GetIPFromName: Need six labels in IPv4 reverse mapping name %##s", name); return mStatus_Invalid; }
2224     if (GetLabelDecimalValue(SkipLeadingLabels(name, skip+3)->c, &a->ip.v4.b[0]) ||
2225         GetLabelDecimalValue(SkipLeadingLabels(name, skip+2)->c, &a->ip.v4.b[1]) ||
2226         GetLabelDecimalValue(SkipLeadingLabels(name, skip+1)->c, &a->ip.v4.b[2]) ||
2227         GetLabelDecimalValue(SkipLeadingLabels(name, skip+0)->c, &a->ip.v4.b[3])) return mStatus_Invalid;
2228     a->type = mDNSAddrType_IPv4;
2229     return(mStatus_NoError);
2230 }
2231 
2232 #define HexVal(X) ( ((X) >= '0' && (X) <= '9') ? ((X) - '0'     ) :   \
2233                     ((X) >= 'A' && (X) <= 'F') ? ((X) - 'A' + 10) :   \
2234                     ((X) >= 'a' && (X) <= 'f') ? ((X) - 'a' + 10) : -1)
2235 
2236 mDNSlocal mStatus GetIPv6FromName(mDNSAddr *const a, const domainname *const name)
2237 {
2238     int i, h, l;
2239     const domainname *n;
2240 
2241     int skip = CountLabels(name) - 34;
2242     if (skip < 0) { LogMsg("GetIPFromName: Need 34 labels in IPv6 reverse mapping name %##s", name); return mStatus_Invalid; }
2243 
2244     n = SkipLeadingLabels(name, skip);
2245     for (i=0; i<16; i++)
2246     {
2247         if (n->c[0] != 1) return mStatus_Invalid;
2248         l = HexVal(n->c[1]);
2249         n = (const domainname *)(n->c + 2);
2250 
2251         if (n->c[0] != 1) return mStatus_Invalid;
2252         h = HexVal(n->c[1]);
2253         n = (const domainname *)(n->c + 2);
2254 
2255         if (l<0 || h<0) return mStatus_Invalid;
2256         a->ip.v6.b[15-i] = (mDNSu8)((h << 4) | l);
2257     }
2258 
2259     a->type = mDNSAddrType_IPv6;
2260     return(mStatus_NoError);
2261 }
2262 
2263 mDNSlocal mDNSs32 ReverseMapDomainType(const domainname *const name)
2264 {
2265     int skip = CountLabels(name) - 2;
2266     if (skip >= 0)
2267     {
2268         const domainname *suffix = SkipLeadingLabels(name, skip);
2269         if (SameDomainName(suffix, (const domainname*)"\x7" "in-addr" "\x4" "arpa")) return mDNSAddrType_IPv4;
2270         if (SameDomainName(suffix, (const domainname*)"\x3" "ip6"     "\x4" "arpa")) return mDNSAddrType_IPv6;
2271     }
2272     return(mDNSAddrType_None);
2273 }
2274 
2275 mDNSlocal void SendARP(mDNS *const m, const mDNSu8 op, const AuthRecord *const rr,
2276                        const mDNSv4Addr *const spa, const mDNSEthAddr *const tha, const mDNSv4Addr *const tpa, const mDNSEthAddr *const dst)
2277 {
2278     int i;
2279     mDNSu8 *ptr = m->omsg.data;
2280     NetworkInterfaceInfo *intf = FirstInterfaceForID(m, rr->resrec.InterfaceID);
2281     if (!intf) { LogMsg("SendARP: No interface with InterfaceID %p found %s", rr->resrec.InterfaceID, ARDisplayString(m,rr)); return; }
2282 
2283     // 0x00 Destination address
2284     for (i=0; i<6; i++) *ptr++ = dst->b[i];
2285 
2286     // 0x06 Source address (Note: Since we don't currently set the BIOCSHDRCMPLT option, BPF will fill in the real interface address for us)
2287     for (i=0; i<6; i++) *ptr++ = intf->MAC.b[0];
2288 
2289     // 0x0C ARP Ethertype (0x0806)
2290     *ptr++ = 0x08; *ptr++ = 0x06;
2291 
2292     // 0x0E ARP header
2293     *ptr++ = 0x00; *ptr++ = 0x01;   // Hardware address space; Ethernet = 1
2294     *ptr++ = 0x08; *ptr++ = 0x00;   // Protocol address space; IP = 0x0800
2295     *ptr++ = 6;                     // Hardware address length
2296     *ptr++ = 4;                     // Protocol address length
2297     *ptr++ = 0x00; *ptr++ = op;     // opcode; Request = 1, Response = 2
2298 
2299     // 0x16 Sender hardware address (our MAC address)
2300     for (i=0; i<6; i++) *ptr++ = intf->MAC.b[i];
2301 
2302     // 0x1C Sender protocol address
2303     for (i=0; i<4; i++) *ptr++ = spa->b[i];
2304 
2305     // 0x20 Target hardware address
2306     for (i=0; i<6; i++) *ptr++ = tha->b[i];
2307 
2308     // 0x26 Target protocol address
2309     for (i=0; i<4; i++) *ptr++ = tpa->b[i];
2310 
2311     // 0x2A Total ARP Packet length 42 bytes
2312     mDNSPlatformSendRawPacket(m->omsg.data, ptr, rr->resrec.InterfaceID);
2313 }
2314 
2315 mDNSlocal mDNSu16 CheckSum(const void *const data, mDNSs32 length, mDNSu32 sum)
2316 {
2317     const mDNSu16 *ptr = data;
2318     while (length > 0) { length -= 2; sum += *ptr++; }
2319     sum = (sum & 0xFFFF) + (sum >> 16);
2320     sum = (sum & 0xFFFF) + (sum >> 16);
2321     return(sum != 0xFFFF ? sum : 0);
2322 }
2323 
2324 mDNSlocal mDNSu16 IPv6CheckSum(const mDNSv6Addr *const src, const mDNSv6Addr *const dst, const mDNSu8 protocol, const void *const data, const mDNSu32 length)
2325 {
2326     IPv6PseudoHeader ph;
2327     ph.src = *src;
2328     ph.dst = *dst;
2329     ph.len.b[0] = length >> 24;
2330     ph.len.b[1] = length >> 16;
2331     ph.len.b[2] = length >> 8;
2332     ph.len.b[3] = length;
2333     ph.pro.b[0] = 0;
2334     ph.pro.b[1] = 0;
2335     ph.pro.b[2] = 0;
2336     ph.pro.b[3] = protocol;
2337     return CheckSum(&ph, sizeof(ph), CheckSum(data, length, 0));
2338 }
2339 
2340 mDNSlocal void SendNDP(mDNS *const m, const mDNSu8 op, const mDNSu8 flags, const AuthRecord *const rr,
2341                        const mDNSv6Addr *const spa, const mDNSEthAddr *const tha, const mDNSv6Addr *const tpa, const mDNSEthAddr *const dst)
2342 {
2343     int i;
2344     mDNSOpaque16 checksum;
2345     mDNSu8 *ptr = m->omsg.data;
2346     // Some recipient hosts seem to ignore Neighbor Solicitations if the IPv6-layer destination address is not the
2347     // appropriate IPv6 solicited node multicast address, so we use that IPv6-layer destination address, even though
2348     // at the Ethernet-layer we unicast the packet to the intended target, to avoid wasting network bandwidth.
2349     const mDNSv6Addr mc = { { 0xFF,0x02,0x00,0x00, 0,0,0,0, 0,0,0,1, 0xFF,tpa->b[0xD],tpa->b[0xE],tpa->b[0xF] } };
2350     const mDNSv6Addr *const v6dst = (op == NDP_Sol) ? &mc : tpa;
2351     NetworkInterfaceInfo *intf = FirstInterfaceForID(m, rr->resrec.InterfaceID);
2352     if (!intf) { LogMsg("SendNDP: No interface with InterfaceID %p found %s", rr->resrec.InterfaceID, ARDisplayString(m,rr)); return; }
2353 
2354     // 0x00 Destination address
2355     for (i=0; i<6; i++) *ptr++ = dst->b[i];
2356     // Right now we only send Neighbor Solicitations to verify whether the host we're proxying for has gone to sleep yet.
2357     // Since we know who we're looking for, we send it via Ethernet-layer unicast, rather than bothering every host on the
2358     // link with a pointless link-layer multicast.
2359     // Should we want to send traditional Neighbor Solicitations in the future, where we really don't know in advance what
2360     // Ethernet-layer address we're looking for, we'll need to send to the appropriate Ethernet-layer multicast address:
2361     // *ptr++ = 0x33;
2362     // *ptr++ = 0x33;
2363     // *ptr++ = 0xFF;
2364     // *ptr++ = tpa->b[0xD];
2365     // *ptr++ = tpa->b[0xE];
2366     // *ptr++ = tpa->b[0xF];
2367 
2368     // 0x06 Source address (Note: Since we don't currently set the BIOCSHDRCMPLT option, BPF will fill in the real interface address for us)
2369     for (i=0; i<6; i++)
2370 	if (tha)
2371 	    *ptr++ = tha->b[i];
2372 	else
2373 	    *ptr++ = intf->MAC.b[i];
2374 
2375     // 0x0C IPv6 Ethertype (0x86DD)
2376     *ptr++ = 0x86; *ptr++ = 0xDD;
2377 
2378     // 0x0E IPv6 header
2379     *ptr++ = 0x60; *ptr++ = 0x00; *ptr++ = 0x00; *ptr++ = 0x00;     // Version, Traffic Class, Flow Label
2380     *ptr++ = 0x00; *ptr++ = 0x20;                                   // Length
2381     *ptr++ = 0x3A;                                                  // Protocol == ICMPv6
2382     *ptr++ = 0xFF;                                                  // Hop Limit
2383 
2384     // 0x16 Sender IPv6 address
2385     for (i=0; i<16; i++) *ptr++ = spa->b[i];
2386 
2387     // 0x26 Destination IPv6 address
2388     for (i=0; i<16; i++) *ptr++ = v6dst->b[i];
2389 
2390     // 0x36 NDP header
2391     *ptr++ = op;                    // 0x87 == Neighbor Solicitation, 0x88 == Neighbor Advertisement
2392     *ptr++ = 0x00;                  // Code
2393     *ptr++ = 0x00; *ptr++ = 0x00;   // Checksum placeholder (0x38, 0x39)
2394     *ptr++ = flags;
2395     *ptr++ = 0x00; *ptr++ = 0x00; *ptr++ = 0x00;
2396 
2397     if (op == NDP_Sol)  // Neighbor Solicitation. The NDP "target" is the address we seek.
2398     {
2399         // 0x3E NDP target.
2400         for (i=0; i<16; i++) *ptr++ = tpa->b[i];
2401         // 0x4E Source Link-layer Address
2402         // <http://www.ietf.org/rfc/rfc2461.txt>
2403         // MUST NOT be included when the source IP address is the unspecified address.
2404         // Otherwise, on link layers that have addresses this option MUST be included
2405         // in multicast solicitations and SHOULD be included in unicast solicitations.
2406         if (!mDNSIPv6AddressIsZero(*spa))
2407         {
2408             *ptr++ = NDP_SrcLL; // Option Type 1 == Source Link-layer Address
2409             *ptr++ = 0x01;      // Option length 1 (in units of 8 octets)
2410             for (i=0; i<6; i++)
2411 		if (tha)
2412 		    *ptr++ = tha->b[i];
2413 		else
2414 		    *ptr++ = intf->MAC.b[i];
2415         }
2416     }
2417     else            // Neighbor Advertisement. The NDP "target" is the address we're giving information about.
2418     {
2419         // 0x3E NDP target.
2420         for (i=0; i<16; i++) *ptr++ = spa->b[i];
2421         // 0x4E Target Link-layer Address
2422         *ptr++ = NDP_TgtLL; // Option Type 2 == Target Link-layer Address
2423         *ptr++ = 0x01;      // Option length 1 (in units of 8 octets)
2424         for (i=0; i<6; i++)
2425 	    if (tha)
2426 		*ptr++ = tha->b[i];
2427 	    else
2428 		*ptr++ = intf->MAC.b[i];
2429     }
2430 
2431     // 0x4E or 0x56 Total NDP Packet length 78 or 86 bytes
2432     m->omsg.data[0x13] = ptr - &m->omsg.data[0x36];     // Compute actual length
2433     checksum.NotAnInteger = ~IPv6CheckSum(spa, v6dst, 0x3A, &m->omsg.data[0x36], m->omsg.data[0x13]);
2434     m->omsg.data[0x38] = checksum.b[0];
2435     m->omsg.data[0x39] = checksum.b[1];
2436 
2437     mDNSPlatformSendRawPacket(m->omsg.data, ptr, rr->resrec.InterfaceID);
2438 }
2439 
2440 mDNSlocal void SetupTracerOpt(const mDNS *const m, rdataOPT *const Trace)
2441 {
2442     mDNSu32 DNS_VERS = _DNS_SD_H;
2443     Trace->u.tracer.platf    = m->mDNS_plat;
2444     Trace->u.tracer.mDNSv    = DNS_VERS;
2445 
2446     Trace->opt              = kDNSOpt_Trace;
2447     Trace->optlen           = DNSOpt_TraceData_Space - 4;
2448 }
2449 
2450 mDNSlocal void SetupOwnerOpt(const mDNS *const m, const NetworkInterfaceInfo *const intf, rdataOPT *const owner)
2451 {
2452     owner->u.owner.vers     = 0;
2453     owner->u.owner.seq      = m->SleepSeqNum;
2454     owner->u.owner.HMAC     = m->PrimaryMAC;
2455     owner->u.owner.IMAC     = intf->MAC;
2456     owner->u.owner.password = zeroEthAddr;
2457 
2458     // Don't try to compute the optlen until *after* we've set up the data fields
2459     // Right now the DNSOpt_Owner_Space macro does not depend on the owner->u.owner being set up correctly, but in the future it might
2460     owner->opt              = kDNSOpt_Owner;
2461     owner->optlen           = DNSOpt_Owner_Space(&m->PrimaryMAC, &intf->MAC) - 4;
2462 }
2463 
2464 mDNSlocal void GrantUpdateCredit(AuthRecord *rr)
2465 {
2466     if (++rr->UpdateCredits >= kMaxUpdateCredits) rr->NextUpdateCredit = 0;
2467     else rr->NextUpdateCredit = NonZeroTime(rr->NextUpdateCredit + kUpdateCreditRefreshInterval);
2468 }
2469 
2470 mDNSlocal mDNSBool ShouldSendGoodbyesBeforeSleep(mDNS *const m, const NetworkInterfaceInfo *intf, AuthRecord *rr)
2471 {
2472     // If there are no sleep proxies, we set the state to SleepState_Sleeping explicitly
2473     // and hence there is no need to check for Transfering state. But if we have sleep
2474     // proxies and partially sending goodbyes for some records, we will be in Transfering
2475     // state and hence need to make sure that we send goodbyes in that case too. Checking whether
2476     // we are not awake handles both cases.
2477     if ((rr->AuthFlags & AuthFlagsWakeOnly) && (m->SleepState != SleepState_Awake))
2478     {
2479         debugf("ShouldSendGoodbyesBeforeSleep: marking for goodbye", ARDisplayString(m, rr));
2480         return mDNStrue;
2481     }
2482 
2483     if (m->SleepState != SleepState_Sleeping)
2484         return mDNSfalse;
2485 
2486     // If we are going to sleep and in SleepState_Sleeping, SendGoodbyes on the interface tell you
2487     // whether you can send goodbyes or not.
2488     if (!intf->SendGoodbyes)
2489     {
2490         debugf("ShouldSendGoodbyesBeforeSleep: not sending goodbye %s, int %p", ARDisplayString(m, rr), intf->InterfaceID);
2491         return mDNSfalse;
2492     }
2493     else
2494     {
2495         debugf("ShouldSendGoodbyesBeforeSleep: sending goodbye %s, int %p", ARDisplayString(m, rr), intf->InterfaceID);
2496         return mDNStrue;
2497     }
2498 }
2499 
2500 mDNSlocal mDNSBool IsInterfaceValidForAuthRecord(const AuthRecord *ar, mDNSInterfaceID InterfaceID)
2501 {
2502     mDNSBool result;
2503 
2504     if (ar->resrec.InterfaceID == mDNSInterface_Any)
2505     {
2506         result = mDNSPlatformValidRecordForInterface(ar, InterfaceID);
2507     }
2508     else
2509     {
2510         result = (ar->resrec.InterfaceID == InterfaceID);
2511     }
2512 
2513     return(result);
2514 }
2515 
2516 // Note about acceleration of announcements to facilitate automatic coalescing of
2517 // multiple independent threads of announcements into a single synchronized thread:
2518 // The announcements in the packet may be at different stages of maturity;
2519 // One-second interval, two-second interval, four-second interval, and so on.
2520 // After we've put in all the announcements that are due, we then consider
2521 // whether there are other nearly-due announcements that are worth accelerating.
2522 // To be eligible for acceleration, a record MUST NOT be older (further along
2523 // its timeline) than the most mature record we've already put in the packet.
2524 // In other words, younger records can have their timelines accelerated to catch up
2525 // with their elder bretheren; this narrows the age gap and helps them eventually get in sync.
2526 // Older records cannot have their timelines accelerated; this would just widen
2527 // the gap between them and their younger bretheren and get them even more out of sync.
2528 
2529 // Note: SendResponses calls mDNS_Deregister_internal which can call a user callback, which may change
2530 // the record list and/or question list.
2531 // Any code walking either list must use the CurrentQuestion and/or CurrentRecord mechanism to protect against this.
2532 mDNSlocal void SendResponses(mDNS *const m)
2533 {
2534     int pktcount = 0;
2535     AuthRecord *rr, *r2;
2536     mDNSs32 maxExistingAnnounceInterval = 0;
2537     const NetworkInterfaceInfo *intf = GetFirstActiveInterface(m->HostInterfaces);
2538 
2539     m->NextScheduledResponse = m->timenow + FutureTime;
2540 
2541     if (m->SleepState == SleepState_Transferring) RetrySPSRegistrations(m);
2542 
2543     for (rr = m->ResourceRecords; rr; rr=rr->next)
2544         if (rr->ImmedUnicast)
2545         {
2546             mDNSAddr v4 = { mDNSAddrType_IPv4, {{{0}}} };
2547             mDNSAddr v6 = { mDNSAddrType_IPv6, {{{0}}} };
2548             v4.ip.v4 = rr->v4Requester;
2549             v6.ip.v6 = rr->v6Requester;
2550             if (!mDNSIPv4AddressIsZero(rr->v4Requester)) SendDelayedUnicastResponse(m, &v4, rr->ImmedAnswer);
2551             if (!mDNSIPv6AddressIsZero(rr->v6Requester)) SendDelayedUnicastResponse(m, &v6, rr->ImmedAnswer);
2552             if (rr->ImmedUnicast)
2553             {
2554                 LogMsg("SendResponses: ERROR: rr->ImmedUnicast still set: %s", ARDisplayString(m, rr));
2555                 rr->ImmedUnicast = mDNSfalse;
2556             }
2557         }
2558 
2559     // ***
2560     // *** 1. Setup: Set the SendRNow and ImmedAnswer fields to indicate which interface(s) the records need to be sent on
2561     // ***
2562 
2563     // Run through our list of records, and decide which ones we're going to announce on all interfaces
2564     for (rr = m->ResourceRecords; rr; rr=rr->next)
2565     {
2566         while (rr->NextUpdateCredit && m->timenow - rr->NextUpdateCredit >= 0) GrantUpdateCredit(rr);
2567         if (TimeToAnnounceThisRecord(rr, m->timenow))
2568         {
2569             if (rr->resrec.RecordType == kDNSRecordTypeDeregistering)
2570             {
2571                 if (!rr->WakeUp.HMAC.l[0])
2572                 {
2573                     if (rr->AnnounceCount) rr->ImmedAnswer = mDNSInterfaceMark;     // Send goodbye packet on all interfaces
2574                 }
2575                 else
2576                 {
2577                     mDNSBool unicastOnly;
2578                     LogSPS("SendResponses: Sending wakeup %2d for %.6a %s", rr->AnnounceCount-3, &rr->WakeUp.IMAC, ARDisplayString(m, rr));
2579                     unicastOnly = ((rr->AnnounceCount == WakeupCount) || (rr->AnnounceCount == WakeupCount - 1)) ? mDNStrue : mDNSfalse;
2580                     SendWakeup(m, rr->resrec.InterfaceID, &rr->WakeUp.IMAC, &rr->WakeUp.password, unicastOnly);
2581                     for (r2 = rr; r2; r2=r2->next)
2582                         if ((r2->resrec.RecordType == kDNSRecordTypeDeregistering) && r2->AnnounceCount && (r2->resrec.InterfaceID == rr->resrec.InterfaceID) &&
2583                             mDNSSameEthAddress(&r2->WakeUp.IMAC, &rr->WakeUp.IMAC) && !mDNSSameEthAddress(&zeroEthAddr, &r2->WakeUp.HMAC))
2584                         {
2585                             // For now we only want to send a single Unsolicited Neighbor Advertisement restoring the address to the original
2586                             // owner, because these packets can cause some IPv6 stacks to falsely conclude that there's an address conflict.
2587                             if (r2->AddressProxy.type == mDNSAddrType_IPv6 && r2->AnnounceCount == WakeupCount)
2588                             {
2589                                 LogSPS("NDP Announcement %2d Releasing traffic for H-MAC %.6a I-MAC %.6a %s",
2590                                        r2->AnnounceCount-3, &r2->WakeUp.HMAC, &r2->WakeUp.IMAC, ARDisplayString(m,r2));
2591                                 SendNDP(m, NDP_Adv, NDP_Override, r2, &r2->AddressProxy.ip.v6, &r2->WakeUp.IMAC, &AllHosts_v6, &AllHosts_v6_Eth);
2592                             }
2593                             r2->LastAPTime = m->timenow;
2594                             // After 15 wakeups without success (maybe host has left the network) send three goodbyes instead
2595                             if (--r2->AnnounceCount <= GoodbyeCount) r2->WakeUp.HMAC = zeroEthAddr;
2596                         }
2597                 }
2598             }
2599             else if (ResourceRecordIsValidAnswer(rr))
2600             {
2601                 if (rr->AddressProxy.type)
2602                 {
2603                     if (!mDNSSameEthAddress(&zeroEthAddr, &rr->WakeUp.HMAC))
2604                     {
2605                         rr->AnnounceCount--;
2606                         rr->ThisAPInterval *= 2;
2607                         rr->LastAPTime = m->timenow;
2608                         if (rr->AddressProxy.type == mDNSAddrType_IPv4)
2609                         {
2610                             LogSPS("ARP Announcement %2d Capturing traffic for H-MAC %.6a I-MAC %.6a %s",
2611                                     rr->AnnounceCount, &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, ARDisplayString(m,rr));
2612                             SendARP(m, 1, rr, &rr->AddressProxy.ip.v4, &zeroEthAddr, &rr->AddressProxy.ip.v4, &onesEthAddr);
2613                         }
2614                         else if (rr->AddressProxy.type == mDNSAddrType_IPv6)
2615                         {
2616                             LogSPS("NDP Announcement %2d Capturing traffic for H-MAC %.6a I-MAC %.6a %s",
2617                                     rr->AnnounceCount, &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, ARDisplayString(m,rr));
2618                             SendNDP(m, NDP_Adv, NDP_Override, rr, &rr->AddressProxy.ip.v6, mDNSNULL, &AllHosts_v6, &AllHosts_v6_Eth);
2619                         }
2620                     }
2621                 }
2622                 else
2623                 {
2624                     rr->ImmedAnswer = mDNSInterfaceMark;        // Send on all interfaces
2625                     if (maxExistingAnnounceInterval < rr->ThisAPInterval)
2626                         maxExistingAnnounceInterval = rr->ThisAPInterval;
2627                     if (rr->UpdateBlocked) rr->UpdateBlocked = 0;
2628                 }
2629             }
2630         }
2631     }
2632 
2633     // Any interface-specific records we're going to send are marked as being sent on all appropriate interfaces (which is just one)
2634     // Eligible records that are more than half-way to their announcement time are accelerated
2635     for (rr = m->ResourceRecords; rr; rr=rr->next)
2636         if ((rr->resrec.InterfaceID && rr->ImmedAnswer) ||
2637             (rr->ThisAPInterval <= maxExistingAnnounceInterval &&
2638              TimeToAnnounceThisRecord(rr, m->timenow + rr->ThisAPInterval/2) &&
2639              !rr->AddressProxy.type &&                  // Don't include ARP Annoucements when considering which records to accelerate
2640              ResourceRecordIsValidAnswer(rr)))
2641             rr->ImmedAnswer = mDNSInterfaceMark;        // Send on all interfaces
2642 
2643     // When sending SRV records (particularly when announcing a new service) automatically add related Address record(s) as additionals
2644     // Note: Currently all address records are interface-specific, so it's safe to set ImmedAdditional to their InterfaceID,
2645     // which will be non-null. If by some chance there is an address record that's not interface-specific (should never happen)
2646     // then all that means is that it won't get sent -- which would not be the end of the world.
2647     for (rr = m->ResourceRecords; rr; rr=rr->next)
2648     {
2649         if (rr->ImmedAnswer && rr->resrec.rrtype == kDNSType_SRV)
2650             for (r2=m->ResourceRecords; r2; r2=r2->next)                // Scan list of resource records
2651                 if (RRTypeIsAddressType(r2->resrec.rrtype) &&           // For all address records (A/AAAA) ...
2652                     ResourceRecordIsValidAnswer(r2) &&                  // ... which are valid for answer ...
2653                     rr->LastMCTime - r2->LastMCTime >= 0 &&             // ... which we have not sent recently ...
2654                     rr->resrec.rdatahash == r2->resrec.namehash &&      // ... whose name is the name of the SRV target
2655                     SameDomainName(&rr->resrec.rdata->u.srv.target, r2->resrec.name) &&
2656                     (rr->ImmedAnswer == mDNSInterfaceMark || rr->ImmedAnswer == r2->resrec.InterfaceID))
2657                     r2->ImmedAdditional = r2->resrec.InterfaceID;       // ... then mark this address record for sending too
2658         // We also make sure we send the DeviceInfo TXT record too, if necessary
2659         // We check for RecordType == kDNSRecordTypeShared because we don't want to tag the
2660         // DeviceInfo TXT record onto a goodbye packet (RecordType == kDNSRecordTypeDeregistering).
2661         if (rr->ImmedAnswer && rr->resrec.RecordType == kDNSRecordTypeShared && rr->resrec.rrtype == kDNSType_PTR)
2662             if (ResourceRecordIsValidAnswer(&m->DeviceInfo) && SameDomainLabel(rr->resrec.rdata->u.name.c, m->DeviceInfo.resrec.name->c))
2663             {
2664                 if (!m->DeviceInfo.ImmedAnswer) m->DeviceInfo.ImmedAnswer = rr->ImmedAnswer;
2665                 else m->DeviceInfo.ImmedAnswer = mDNSInterfaceMark;
2666             }
2667     }
2668 
2669     // If there's a record which is supposed to be unique that we're going to send, then make sure that we give
2670     // the whole RRSet as an atomic unit. That means that if we have any other records with the same name/type/class
2671     // then we need to mark them for sending too. Otherwise, if we set the kDNSClass_UniqueRRSet bit on a
2672     // record, then other RRSet members that have not been sent recently will get flushed out of client caches.
2673     // -- If a record is marked to be sent on a certain interface, make sure the whole set is marked to be sent on that interface
2674     // -- If any record is marked to be sent on all interfaces, make sure the whole set is marked to be sent on all interfaces
2675     for (rr = m->ResourceRecords; rr; rr=rr->next)
2676         if (rr->resrec.RecordType & kDNSRecordTypeUniqueMask)
2677         {
2678             if (rr->ImmedAnswer)            // If we're sending this as answer, see that its whole RRSet is similarly marked
2679             {
2680                 for (r2 = m->ResourceRecords; r2; r2=r2->next)
2681                 {
2682                     if ((r2->resrec.RecordType & kDNSRecordTypeUniqueMask) && ResourceRecordIsValidAnswer(r2) &&
2683                         (r2->ImmedAnswer != mDNSInterfaceMark) && (r2->ImmedAnswer != rr->ImmedAnswer) &&
2684                         SameResourceRecordSignature(r2, rr) &&
2685                         ((rr->ImmedAnswer == mDNSInterfaceMark) || IsInterfaceValidForAuthRecord(r2, rr->ImmedAnswer)))
2686                     {
2687                         r2->ImmedAnswer = !r2->ImmedAnswer ? rr->ImmedAnswer : mDNSInterfaceMark;
2688                     }
2689                 }
2690             }
2691             else if (rr->ImmedAdditional)   // If we're sending this as additional, see that its whole RRSet is similarly marked
2692             {
2693                 for (r2 = m->ResourceRecords; r2; r2=r2->next)
2694                 {
2695                     if ((r2->resrec.RecordType & kDNSRecordTypeUniqueMask) && ResourceRecordIsValidAnswer(r2) &&
2696                         (r2->ImmedAdditional != rr->ImmedAdditional) &&
2697                         SameResourceRecordSignature(r2, rr) &&
2698                         IsInterfaceValidForAuthRecord(r2, rr->ImmedAdditional))
2699                     {
2700                         r2->ImmedAdditional = rr->ImmedAdditional;
2701                     }
2702                 }
2703             }
2704         }
2705 
2706     // Now set SendRNow state appropriately
2707     for (rr = m->ResourceRecords; rr; rr=rr->next)
2708     {
2709         if (rr->ImmedAnswer == mDNSInterfaceMark)       // Sending this record on all appropriate interfaces
2710         {
2711             rr->SendRNow = !intf ? mDNSNULL : (rr->resrec.InterfaceID) ? rr->resrec.InterfaceID : intf->InterfaceID;
2712             rr->ImmedAdditional = mDNSNULL;             // No need to send as additional if sending as answer
2713             rr->LastMCTime      = m->timenow;
2714             rr->LastMCInterface = rr->ImmedAnswer;
2715             rr->ProbeRestartCount = 0;                  // Reset the probe restart count
2716             // If we're announcing this record, and it's at least half-way to its ordained time, then consider this announcement done
2717             if (TimeToAnnounceThisRecord(rr, m->timenow + rr->ThisAPInterval/2))
2718             {
2719                 rr->AnnounceCount--;
2720                 if (rr->resrec.RecordType != kDNSRecordTypeDeregistering)
2721                     rr->ThisAPInterval *= 2;
2722                 rr->LastAPTime = m->timenow;
2723                 debugf("Announcing %##s (%s) %d", rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype), rr->AnnounceCount);
2724             }
2725         }
2726         else if (rr->ImmedAnswer)                       // Else, just respond to a single query on single interface:
2727         {
2728             rr->SendRNow        = rr->ImmedAnswer;      // Just respond on that interface
2729             rr->ImmedAdditional = mDNSNULL;             // No need to send as additional too
2730             rr->LastMCTime      = m->timenow;
2731             rr->LastMCInterface = rr->ImmedAnswer;
2732         }
2733         SetNextAnnounceProbeTime(m, rr);
2734         //if (rr->SendRNow) LogMsg("%-15.4a %s", &rr->v4Requester, ARDisplayString(m, rr));
2735     }
2736 
2737     // ***
2738     // *** 2. Loop through interface list, sending records as appropriate
2739     // ***
2740 
2741     while (intf)
2742     {
2743         int OwnerRecordSpace = (m->AnnounceOwner && intf->MAC.l[0]) ? DNSOpt_Header_Space + DNSOpt_Owner_Space(&m->PrimaryMAC, &intf->MAC) : 0;
2744         int TraceRecordSpace = (mDNS_McastTracingEnabled && MDNS_TRACER) ? DNSOpt_Header_Space + DNSOpt_TraceData_Space : 0;
2745         int numDereg    = 0;
2746         int numAnnounce = 0;
2747         int numAnswer   = 0;
2748         int AnoninfoSpace = 0;
2749         mDNSu8 *responseptr = m->omsg.data;
2750         mDNSu8 *newptr;
2751         InitializeDNSMessage(&m->omsg.h, zeroID, ResponseFlags);
2752 
2753         // First Pass. Look for:
2754         // 1. Deregistering records that need to send their goodbye packet
2755         // 2. Updated records that need to retract their old data
2756         // 3. Answers and announcements we need to send
2757         for (rr = m->ResourceRecords; rr; rr=rr->next)
2758         {
2759 
2760             // Skip this interface if the record InterfaceID is *Any and the record is not
2761             // appropriate for the interface type.
2762             if ((rr->SendRNow == intf->InterfaceID) &&
2763                 ((rr->resrec.InterfaceID == mDNSInterface_Any) && !mDNSPlatformValidRecordForInterface(rr, intf->InterfaceID)))
2764             {
2765                 rr->SendRNow = GetNextActiveInterfaceID(intf);
2766             }
2767             else if (rr->SendRNow == intf->InterfaceID)
2768             {
2769                 RData  *OldRData    = rr->resrec.rdata;
2770                 mDNSu16 oldrdlength = rr->resrec.rdlength;
2771                 mDNSu8 active = (mDNSu8)
2772                                 (rr->resrec.RecordType != kDNSRecordTypeDeregistering && !ShouldSendGoodbyesBeforeSleep(m, intf, rr));
2773                 newptr = mDNSNULL;
2774                 if (rr->NewRData && active)
2775                 {
2776                     // See if we should send a courtesy "goodbye" for the old data before we replace it.
2777                     if (ResourceRecordIsValidAnswer(rr) && rr->resrec.RecordType == kDNSRecordTypeShared && rr->RequireGoodbye)
2778                     {
2779                         newptr = PutRR_OS_TTL(responseptr, &m->omsg.h.numAnswers, &rr->resrec, 0);
2780                         if (newptr) { responseptr = newptr; numDereg++; rr->RequireGoodbye = mDNSfalse; }
2781                         else continue; // If this packet is already too full to hold the goodbye for this record, skip it for now and we'll retry later
2782                     }
2783                     SetNewRData(&rr->resrec, rr->NewRData, rr->newrdlength);
2784                 }
2785 
2786                 if (rr->resrec.AnonInfo)
2787                 {
2788                     int tmp = AnonInfoSpace(rr->resrec.AnonInfo);
2789 
2790                     AnoninfoSpace += tmp;
2791                     // Adjust OwnerRecordSpace/TraceRecordSpace which is used by PutRR_OS_TTL below so that
2792                     // we have space to put in the NSEC3 record in the authority section.
2793                     OwnerRecordSpace += tmp;
2794                     TraceRecordSpace += tmp;
2795                 }
2796 
2797                 if (rr->resrec.RecordType & kDNSRecordTypeUniqueMask)
2798                     rr->resrec.rrclass |= kDNSClass_UniqueRRSet;        // Temporarily set the cache flush bit so PutResourceRecord will set it
2799                 newptr = PutRR_OS_TTL(responseptr, &m->omsg.h.numAnswers, &rr->resrec, active ? rr->resrec.rroriginalttl : 0);
2800                 rr->resrec.rrclass &= ~kDNSClass_UniqueRRSet;           // Make sure to clear cache flush bit back to normal state
2801                 if (newptr)
2802                 {
2803                     responseptr = newptr;
2804                     rr->RequireGoodbye = active;
2805                     if (rr->resrec.RecordType == kDNSRecordTypeDeregistering) numDereg++;
2806                     else if (rr->LastAPTime == m->timenow) numAnnounce++;else numAnswer++;
2807                 }
2808 
2809                 if (rr->NewRData && active)
2810                     SetNewRData(&rr->resrec, OldRData, oldrdlength);
2811 
2812                 // The first time through (pktcount==0), if this record is verified unique
2813                 // (i.e. typically A, AAAA, SRV, TXT and reverse-mapping PTR), set the flag to add an NSEC too.
2814                 if (!pktcount && active && (rr->resrec.RecordType & kDNSRecordTypeActiveUniqueMask) && !rr->SendNSECNow)
2815                     rr->SendNSECNow = mDNSInterfaceMark;
2816 
2817                 if (newptr)     // If succeeded in sending, advance to next interface
2818                 {
2819                     if (rr->resrec.AnonInfo)
2820                     {
2821                         debugf("SendResponses: Marking %s, OwnerRecordSpace %d, TraceRecordSpace %d, limit %p", ARDisplayString(m, rr), OwnerRecordSpace,
2822                                 TraceRecordSpace, m->omsg.data + AllowedRRSpace(&m->omsg) - OwnerRecordSpace - TraceRecordSpace);
2823                         rr->resrec.AnonInfo->SendNow = intf->InterfaceID;
2824                     }
2825 
2826                     // If sending on all interfaces, go to next interface; else we're finished now
2827                     if (rr->ImmedAnswer == mDNSInterfaceMark && rr->resrec.InterfaceID == mDNSInterface_Any)
2828                         rr->SendRNow = GetNextActiveInterfaceID(intf);
2829                     else
2830                         rr->SendRNow = mDNSNULL;
2831                 }
2832             }
2833         }
2834 
2835         // Get the reserved space back
2836         OwnerRecordSpace -= AnoninfoSpace;
2837         TraceRecordSpace -= AnoninfoSpace;
2838         newptr = responseptr;
2839         for (rr = m->ResourceRecords; rr; rr=rr->next)
2840         {
2841             if (rr->resrec.AnonInfo && rr->resrec.AnonInfo->SendNow == intf->InterfaceID)
2842             {
2843                 ResourceRecord *nsec3RR = rr->resrec.AnonInfo->nsec3RR;
2844 
2845                 newptr = PutRR_OS_TTL(newptr, &m->omsg.h.numAuthorities, nsec3RR,  nsec3RR->rroriginalttl);
2846                 if (newptr)
2847                 {
2848                     responseptr = newptr;
2849                     debugf("SendResponses: Added NSEC3 %s, OwnerRecordSpace %d, TraceRecordSpace %d, limit %p", ARDisplayString(m, rr), OwnerRecordSpace,
2850                             TraceRecordSpace, m->omsg.data + AllowedRRSpace(&m->omsg) - OwnerRecordSpace - TraceRecordSpace);
2851                 }
2852                 else
2853                 {
2854                     LogMsg("SendResponses: Cannot add NSEC3 %s, OwnerRecordSpace %d, TraceRecordSpace %d, limit %p", ARDisplayString(m, rr), OwnerRecordSpace,
2855                             TraceRecordSpace, m->omsg.data + AllowedRRSpace(&m->omsg) - OwnerRecordSpace - TraceRecordSpace);
2856                 }
2857                 rr->resrec.AnonInfo->SendNow = mDNSNULL;
2858             }
2859         }
2860         // Second Pass. Add additional records, if there's space.
2861         newptr = responseptr;
2862         for (rr = m->ResourceRecords; rr; rr=rr->next)
2863             if (rr->ImmedAdditional == intf->InterfaceID)
2864                 if (ResourceRecordIsValidAnswer(rr))
2865                 {
2866                     // If we have at least one answer already in the packet, then plan to add additionals too
2867                     mDNSBool SendAdditional = (m->omsg.h.numAnswers > 0);
2868 
2869                     // If we're not planning to send any additionals, but this record is a unique one, then
2870                     // make sure we haven't already sent any other members of its RRSet -- if we have, then they
2871                     // will have had the cache flush bit set, so now we need to finish the job and send the rest.
2872                     if (!SendAdditional && (rr->resrec.RecordType & kDNSRecordTypeUniqueMask))
2873                     {
2874                         const AuthRecord *a;
2875                         for (a = m->ResourceRecords; a; a=a->next)
2876                             if (a->LastMCTime      == m->timenow &&
2877                                 a->LastMCInterface == intf->InterfaceID &&
2878                                 SameResourceRecordSignature(a, rr)) { SendAdditional = mDNStrue; break; }
2879                     }
2880                     if (!SendAdditional)                    // If we don't want to send this after all,
2881                         rr->ImmedAdditional = mDNSNULL;     // then cancel its ImmedAdditional field
2882                     else if (newptr)                        // Else, try to add it if we can
2883                     {
2884                         // The first time through (pktcount==0), if this record is verified unique
2885                         // (i.e. typically A, AAAA, SRV, TXT and reverse-mapping PTR), set the flag to add an NSEC too.
2886                         if (!pktcount && (rr->resrec.RecordType & kDNSRecordTypeActiveUniqueMask) && !rr->SendNSECNow)
2887                             rr->SendNSECNow = mDNSInterfaceMark;
2888 
2889                         if (rr->resrec.RecordType & kDNSRecordTypeUniqueMask)
2890                             rr->resrec.rrclass |= kDNSClass_UniqueRRSet;    // Temporarily set the cache flush bit so PutResourceRecord will set it
2891                         newptr = PutRR_OS(newptr, &m->omsg.h.numAdditionals, &rr->resrec);
2892                         rr->resrec.rrclass &= ~kDNSClass_UniqueRRSet;       // Make sure to clear cache flush bit back to normal state
2893                         if (newptr)
2894                         {
2895                             responseptr = newptr;
2896                             rr->ImmedAdditional = mDNSNULL;
2897                             rr->RequireGoodbye = mDNStrue;
2898                             // If we successfully put this additional record in the packet, we record LastMCTime & LastMCInterface.
2899                             // This matters particularly in the case where we have more than one IPv6 (or IPv4) address, because otherwise,
2900                             // when we see our own multicast with the cache flush bit set, if we haven't set LastMCTime, then we'll get
2901                             // all concerned and re-announce our record again to make sure it doesn't get flushed from peer caches.
2902                             rr->LastMCTime      = m->timenow;
2903                             rr->LastMCInterface = intf->InterfaceID;
2904                         }
2905                     }
2906                 }
2907 
2908         // Third Pass. Add NSEC records, if there's space.
2909         // When we're generating an NSEC record in response to a specify query for that type
2910         // (recognized by rr->SendNSECNow == intf->InterfaceID) we should really put the NSEC in the Answer Section,
2911         // not Additional Section, but for now it's easier to handle both cases in this Additional Section loop here.
2912         for (rr = m->ResourceRecords; rr; rr=rr->next)
2913             if (rr->SendNSECNow == mDNSInterfaceMark || rr->SendNSECNow == intf->InterfaceID)
2914             {
2915                 AuthRecord nsec;
2916                 mDNSu8 *ptr;
2917                 int len;
2918                 mDNS_SetupResourceRecord(&nsec, mDNSNULL, mDNSInterface_Any, kDNSType_NSEC, rr->resrec.rroriginalttl, kDNSRecordTypeUnique, AuthRecordAny, mDNSNULL, mDNSNULL);
2919                 nsec.resrec.rrclass |= kDNSClass_UniqueRRSet;
2920                 AssignDomainName(&nsec.namestorage, rr->resrec.name);
2921                 ptr = nsec.rdatastorage.u.data;
2922                 len = DomainNameLength(rr->resrec.name);
2923                 // We have a nxt name followed by window number, window length and a window bitmap
2924                 nsec.resrec.rdlength = len + 2 + NSEC_MCAST_WINDOW_SIZE;
2925                 if (nsec.resrec.rdlength <= StandardAuthRDSize)
2926                 {
2927                     mDNSPlatformMemZero(ptr, nsec.resrec.rdlength);
2928                     AssignDomainName((domainname *)ptr, rr->resrec.name);
2929                     ptr += len;
2930                     *ptr++ = 0; // window number
2931                     *ptr++ = NSEC_MCAST_WINDOW_SIZE; // window length
2932                     for (r2 = m->ResourceRecords; r2; r2=r2->next)
2933                         if (ResourceRecordIsValidAnswer(r2) && SameResourceRecordNameClassInterface(r2, rr))
2934                         {
2935                             if (r2->resrec.rrtype >= kDNSQType_ANY) { LogMsg("SendResponses: Can't create NSEC for record %s", ARDisplayString(m, r2)); break; }
2936                             else ptr[r2->resrec.rrtype >> 3] |= 128 >> (r2->resrec.rrtype & 7);
2937                         }
2938                     newptr = responseptr;
2939                     if (!r2)    // If we successfully built our NSEC record, add it to the packet now
2940                     {
2941                         newptr = PutRR_OS(responseptr, &m->omsg.h.numAdditionals, &nsec.resrec);
2942                         if (newptr) responseptr = newptr;
2943                     }
2944                 }
2945                 else LogMsg("SendResponses: not enough space (%d)  in authrecord for nsec", nsec.resrec.rdlength);
2946 
2947                 // If we successfully put the NSEC record, clear the SendNSECNow flag
2948                 // If we consider this NSEC optional, then we unconditionally clear the SendNSECNow flag, even if we fail to put this additional record
2949                 if (newptr || rr->SendNSECNow == mDNSInterfaceMark)
2950                 {
2951                     rr->SendNSECNow = mDNSNULL;
2952                     // Run through remainder of list clearing SendNSECNow flag for all other records which would generate the same NSEC
2953                     for (r2 = rr->next; r2; r2=r2->next)
2954                         if (SameResourceRecordNameClassInterface(r2, rr))
2955                             if (r2->SendNSECNow == mDNSInterfaceMark || r2->SendNSECNow == intf->InterfaceID)
2956                                 r2->SendNSECNow = mDNSNULL;
2957                 }
2958             }
2959 
2960         if (m->omsg.h.numAnswers || m->omsg.h.numAdditionals)
2961         {
2962             // If we have data to send, add OWNER/TRACER/OWNER+TRACER option if necessary, then send packet
2963             if (OwnerRecordSpace || TraceRecordSpace)
2964             {
2965                 AuthRecord opt;
2966                 mDNS_SetupResourceRecord(&opt, mDNSNULL, mDNSInterface_Any, kDNSType_OPT, kStandardTTL, kDNSRecordTypeKnownUnique, AuthRecordAny, mDNSNULL, mDNSNULL);
2967                 opt.resrec.rrclass    = NormalMaxDNSMessageData;
2968                 opt.resrec.rdlength   = sizeof(rdataOPT);
2969                 opt.resrec.rdestimate = sizeof(rdataOPT);
2970                 if (OwnerRecordSpace && TraceRecordSpace)
2971                 {
2972                     opt.resrec.rdlength   += sizeof(rdataOPT); // Two options in this OPT record
2973                     opt.resrec.rdestimate += sizeof(rdataOPT);
2974                     SetupOwnerOpt(m, intf, &opt.resrec.rdata->u.opt[0]);
2975                     SetupTracerOpt(m, &opt.resrec.rdata->u.opt[1]);
2976                 }
2977                 else if (OwnerRecordSpace)
2978                 {
2979                     SetupOwnerOpt(m, intf, &opt.resrec.rdata->u.opt[0]);
2980                 }
2981                 else if (TraceRecordSpace)
2982                 {
2983                     SetupTracerOpt(m, &opt.resrec.rdata->u.opt[0]);
2984                 }
2985                 newptr = PutResourceRecord(&m->omsg, responseptr, &m->omsg.h.numAdditionals, &opt.resrec);
2986                 if (newptr)
2987                 {
2988                     responseptr = newptr;
2989                 }
2990                 else if (m->omsg.h.numAnswers + m->omsg.h.numAuthorities + m->omsg.h.numAdditionals == 1)
2991                 {
2992                     LogInfo("SendResponses: No space in packet for %s %s OPT record (%d/%d/%d/%d) %s", OwnerRecordSpace ? "OWNER" : "", TraceRecordSpace ? "TRACER" : "",
2993                             m->omsg.h.numQuestions, m->omsg.h.numAnswers, m->omsg.h.numAuthorities, m->omsg.h.numAdditionals, ARDisplayString(m, &opt));
2994                 }
2995                 else
2996                 {
2997                     LogMsg("SendResponses: How did we fail to have space for %s %s OPT record (%d/%d/%d/%d) %s", OwnerRecordSpace ? "OWNER" : "", TraceRecordSpace ? "TRACER" : "",
2998                            m->omsg.h.numQuestions, m->omsg.h.numAnswers, m->omsg.h.numAuthorities, m->omsg.h.numAdditionals, ARDisplayString(m, &opt));
2999                 }
3000             }
3001 
3002             debugf("SendResponses: Sending %d Deregistration%s, %d Announcement%s, %d Answer%s, %d Additional%s on %p",
3003                    numDereg,                 numDereg                 == 1 ? "" : "s",
3004                    numAnnounce,              numAnnounce              == 1 ? "" : "s",
3005                    numAnswer,                numAnswer                == 1 ? "" : "s",
3006                    m->omsg.h.numAdditionals, m->omsg.h.numAdditionals == 1 ? "" : "s", intf->InterfaceID);
3007 
3008             if (intf->IPv4Available) mDNSSendDNSMessage(m, &m->omsg, responseptr, intf->InterfaceID, mDNSNULL, &AllDNSLinkGroup_v4, MulticastDNSPort, mDNSNULL, mDNSNULL, mDNSfalse);
3009             if (intf->IPv6Available) mDNSSendDNSMessage(m, &m->omsg, responseptr, intf->InterfaceID, mDNSNULL, &AllDNSLinkGroup_v6, MulticastDNSPort, mDNSNULL, mDNSNULL, mDNSfalse);
3010             if (!m->SuppressSending) m->SuppressSending = NonZeroTime(m->timenow + (mDNSPlatformOneSecond+9)/10);
3011             if (++pktcount >= 1000) { LogMsg("SendResponses exceeded loop limit %d: giving up", pktcount); break; }
3012             // There might be more things to send on this interface, so go around one more time and try again.
3013         }
3014         else    // Nothing more to send on this interface; go to next
3015         {
3016             const NetworkInterfaceInfo *next = GetFirstActiveInterface(intf->next);
3017             #if MDNS_DEBUGMSGS && 0
3018             const char *const msg = next ? "SendResponses: Nothing more on %p; moving to %p" : "SendResponses: Nothing more on %p";
3019             debugf(msg, intf, next);
3020             #endif
3021             intf = next;
3022             pktcount = 0;       // When we move to a new interface, reset packet count back to zero -- NSEC generation logic uses it
3023         }
3024     }
3025 
3026     // ***
3027     // *** 3. Cleanup: Now that everything is sent, call client callback functions, and reset state variables
3028     // ***
3029 
3030     if (m->CurrentRecord)
3031         LogMsg("SendResponses ERROR m->CurrentRecord already set %s", ARDisplayString(m, m->CurrentRecord));
3032     m->CurrentRecord = m->ResourceRecords;
3033     while (m->CurrentRecord)
3034     {
3035         rr = m->CurrentRecord;
3036         m->CurrentRecord = rr->next;
3037 
3038         if (rr->SendRNow)
3039         {
3040             if (rr->ARType != AuthRecordLocalOnly && rr->ARType != AuthRecordP2P)
3041                 LogInfo("SendResponses: No active interface %d to send: %d %02X %s",
3042                      (uint32_t)rr->SendRNow, (uint32_t)rr->resrec.InterfaceID, rr->resrec.RecordType, ARDisplayString(m, rr));
3043             rr->SendRNow = mDNSNULL;
3044         }
3045 
3046         if (rr->ImmedAnswer || rr->resrec.RecordType == kDNSRecordTypeDeregistering)
3047         {
3048             if (rr->NewRData) CompleteRDataUpdate(m, rr);   // Update our rdata, clear the NewRData pointer, and return memory to the client
3049 
3050             if (rr->resrec.RecordType == kDNSRecordTypeDeregistering && rr->AnnounceCount == 0)
3051             {
3052                 // For Unicast, when we get the response from the server, we will call CompleteDeregistration
3053                 if (!AuthRecord_uDNS(rr)) CompleteDeregistration(m, rr);        // Don't touch rr after this
3054             }
3055             else
3056             {
3057                 rr->ImmedAnswer  = mDNSNULL;
3058                 rr->ImmedUnicast = mDNSfalse;
3059                 rr->v4Requester  = zerov4Addr;
3060                 rr->v6Requester  = zerov6Addr;
3061             }
3062         }
3063     }
3064     verbosedebugf("SendResponses: Next in %ld ticks", m->NextScheduledResponse - m->timenow);
3065 }
3066 
3067 // Calling CheckCacheExpiration() is an expensive operation because it has to look at the entire cache,
3068 // so we want to be lazy about how frequently we do it.
3069 // 1. If a cache record is currently referenced by *no* active questions,
3070 //    then we don't mind expiring it up to a minute late (who will know?)
3071 // 2. Else, if a cache record is due for some of its final expiration queries,
3072 //    we'll allow them to be late by up to 2% of the TTL
3073 // 3. Else, if a cache record has completed all its final expiration queries without success,
3074 //    and is expiring, and had an original TTL more than ten seconds, we'll allow it to be one second late
3075 // 4. Else, it is expiring and had an original TTL of ten seconds or less (includes explicit goodbye packets),
3076 //    so allow at most 1/10 second lateness
3077 // 5. For records with rroriginalttl set to zero, that means we really want to delete them immediately
3078 //    (we have a new record with DelayDelivery set, waiting for the old record to go away before we can notify clients).
3079 #define CacheCheckGracePeriod(RR) (                                                   \
3080         ((RR)->CRActiveQuestion == mDNSNULL            ) ? (60 * mDNSPlatformOneSecond) : \
3081         ((RR)->UnansweredQueries < MaxUnansweredQueries) ? (TicksTTL(rr)/50)            : \
3082         ((RR)->resrec.rroriginalttl > 10               ) ? (mDNSPlatformOneSecond)      : \
3083         ((RR)->resrec.rroriginalttl > 0                ) ? (mDNSPlatformOneSecond/10)   : 0)
3084 
3085 #define NextCacheCheckEvent(RR) ((RR)->NextRequiredQuery + CacheCheckGracePeriod(RR))
3086 
3087 mDNSexport void ScheduleNextCacheCheckTime(mDNS *const m, const mDNSu32 slot, const mDNSs32 event)
3088 {
3089     if (m->rrcache_nextcheck[slot] - event > 0)
3090         m->rrcache_nextcheck[slot] = event;
3091     if (m->NextCacheCheck          - event > 0)
3092         m->NextCacheCheck          = event;
3093 }
3094 
3095 // Note: MUST call SetNextCacheCheckTimeForRecord any time we change:
3096 // rr->TimeRcvd
3097 // rr->resrec.rroriginalttl
3098 // rr->UnansweredQueries
3099 // rr->CRActiveQuestion
3100 mDNSexport void SetNextCacheCheckTimeForRecord(mDNS *const m, CacheRecord *const rr)
3101 {
3102     rr->NextRequiredQuery = RRExpireTime(rr);
3103 
3104     // If we have an active question, then see if we want to schedule a refresher query for this record.
3105     // Usually we expect to do four queries, at 80-82%, 85-87%, 90-92% and then 95-97% of the TTL.
3106     if (rr->CRActiveQuestion && rr->UnansweredQueries < MaxUnansweredQueries)
3107     {
3108         rr->NextRequiredQuery -= TicksTTL(rr)/20 * (MaxUnansweredQueries - rr->UnansweredQueries);
3109         rr->NextRequiredQuery += mDNSRandom((mDNSu32)TicksTTL(rr)/50);
3110         verbosedebugf("SetNextCacheCheckTimeForRecord: NextRequiredQuery in %ld sec CacheCheckGracePeriod %d ticks for %s",
3111                       (rr->NextRequiredQuery - m->timenow) / mDNSPlatformOneSecond, CacheCheckGracePeriod(rr), CRDisplayString(m,rr));
3112     }
3113     ScheduleNextCacheCheckTime(m, HashSlotFromNameHash(rr->resrec.namehash), NextCacheCheckEvent(rr));
3114 }
3115 
3116 #define kMinimumReconfirmTime                     ((mDNSu32)mDNSPlatformOneSecond *  5)
3117 #define kDefaultReconfirmTimeForWake              ((mDNSu32)mDNSPlatformOneSecond *  5)
3118 #define kDefaultReconfirmTimeForNoAnswer          ((mDNSu32)mDNSPlatformOneSecond *  5)
3119 
3120 // Delay before restarting questions on a flapping interface.
3121 #define kDefaultQueryDelayTimeForFlappingInterface ((mDNSu32)mDNSPlatformOneSecond *  3)
3122 // After kDefaultQueryDelayTimeForFlappingInterface seconds, allow enough time for up to three queries (0, 1, and 4 seconds)
3123 // plus three seconds for "response delay" before removing the reconfirmed records from the cache.
3124 #define kDefaultReconfirmTimeForFlappingInterface (kDefaultQueryDelayTimeForFlappingInterface + ((mDNSu32)mDNSPlatformOneSecond *  7))
3125 
3126 mDNSexport mStatus mDNS_Reconfirm_internal(mDNS *const m, CacheRecord *const rr, mDNSu32 interval)
3127 {
3128     if (interval < kMinimumReconfirmTime)
3129         interval = kMinimumReconfirmTime;
3130     if (interval > 0x10000000)  // Make sure interval doesn't overflow when we multiply by four below
3131         interval = 0x10000000;
3132 
3133     // If the expected expiration time for this record is more than interval+33%, then accelerate its expiration
3134     if (RRExpireTime(rr) - m->timenow > (mDNSs32)((interval * 4) / 3))
3135     {
3136         // Add a 33% random amount to the interval, to avoid synchronization between multiple hosts
3137         // For all the reconfirmations in a given batch, we want to use the same random value
3138         // so that the reconfirmation questions can be grouped into a single query packet
3139         if (!m->RandomReconfirmDelay) m->RandomReconfirmDelay = 1 + mDNSRandom(FutureTime);
3140         interval += m->RandomReconfirmDelay % ((interval/3) + 1);
3141         rr->TimeRcvd          = m->timenow - (mDNSs32)interval * 3;
3142         rr->resrec.rroriginalttl     = (interval * 4 + mDNSPlatformOneSecond - 1) / mDNSPlatformOneSecond;
3143         SetNextCacheCheckTimeForRecord(m, rr);
3144     }
3145     debugf("mDNS_Reconfirm_internal:%6ld ticks to go for %s %p",
3146            RRExpireTime(rr) - m->timenow, CRDisplayString(m, rr), rr->CRActiveQuestion);
3147     return(mStatus_NoError);
3148 }
3149 
3150 // BuildQuestion puts a question into a DNS Query packet and if successful, updates the value of queryptr.
3151 // It also appends to the list of known answer records that need to be included,
3152 // and updates the forcast for the size of the known answer section.
3153 mDNSlocal mDNSBool BuildQuestion(mDNS *const m, const NetworkInterfaceInfo *intf, DNSMessage *query, mDNSu8 **queryptr,
3154                                  DNSQuestion *q, CacheRecord ***kalistptrptr, mDNSu32 *answerforecast)
3155 {
3156     mDNSBool ucast = (q->LargeAnswers || q->RequestUnicast) && m->CanReceiveUnicastOn5353 && intf->SupportsUnicastMDNSResponse;
3157     mDNSu16 ucbit = (mDNSu16)(ucast ? kDNSQClass_UnicastResponse : 0);
3158     const mDNSu8 *const limit = query->data + NormalMaxDNSMessageData;
3159     mDNSu8 anoninfo_space = q->AnonInfo ? AnonInfoSpace(q->AnonInfo) : 0;
3160     mDNSu8 *newptr = putQuestion(query, *queryptr, limit - *answerforecast - anoninfo_space, &q->qname, q->qtype, (mDNSu16)(q->qclass | ucbit));
3161     if (!newptr)
3162     {
3163         debugf("BuildQuestion: No more space in this packet for question %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
3164         return(mDNSfalse);
3165     }
3166     else
3167     {
3168         mDNSu32 forecast = *answerforecast + anoninfo_space;
3169         const CacheGroup *const cg = CacheGroupForName(m, q->qnamehash, &q->qname);
3170         CacheRecord *rr;
3171         CacheRecord **ka = *kalistptrptr;   // Make a working copy of the pointer we're going to update
3172 
3173         for (rr = cg ? cg->members : mDNSNULL; rr; rr=rr->next)             // If we have a resource record in our cache,
3174             if (rr->resrec.InterfaceID == q->SendQNow &&                    // received on this interface
3175                 !(rr->resrec.RecordType & kDNSRecordTypeUniqueMask) &&      // which is a shared (i.e. not unique) record type
3176                 rr->NextInKAList == mDNSNULL && ka != &rr->NextInKAList &&  // which is not already in the known answer list
3177                 rr->resrec.rdlength <= SmallRecordLimit &&                  // which is small enough to sensibly fit in the packet
3178                 SameNameRecordAnswersQuestion(&rr->resrec, q) &&            // which answers our question
3179                 rr->TimeRcvd + TicksTTL(rr)/2 - m->timenow >                // and its half-way-to-expiry time is at least 1 second away
3180                 mDNSPlatformOneSecond)                                      // (also ensures we never include goodbye records with TTL=1)
3181             {
3182                 // We don't want to include unique records in the Known Answer section. The Known Answer section
3183                 // is intended to suppress floods of shared-record replies from many other devices on the network.
3184                 // That concept really does not apply to unique records, and indeed if we do send a query for
3185                 // which we have a unique record already in our cache, then including that unique record as a
3186                 // Known Answer, so as to suppress the only answer we were expecting to get, makes little sense.
3187 
3188                 *ka = rr;   // Link this record into our known answer chain
3189                 ka = &rr->NextInKAList;
3190                 // We forecast: compressed name (2) type (2) class (2) TTL (4) rdlength (2) rdata (n)
3191                 forecast += 12 + rr->resrec.rdestimate;
3192                 // If we're trying to put more than one question in this packet, and it doesn't fit
3193                 // then undo that last question and try again next time
3194                 if (query->h.numQuestions > 1 && newptr + forecast >= limit)
3195                 {
3196                     query->h.numQuestions--;
3197                     debugf("BuildQuestion: Retracting question %##s (%s) new forecast total %d, total questions %d",
3198                            q->qname.c, DNSTypeName(q->qtype), newptr + forecast - query->data, query->h.numQuestions);
3199                     ka = *kalistptrptr;     // Go back to where we started and retract these answer records
3200                     while (*ka) { CacheRecord *c = *ka; *ka = mDNSNULL; ka = &c->NextInKAList; }
3201                     return(mDNSfalse);      // Return false, so we'll try again in the next packet
3202                 }
3203             }
3204 
3205         // Success! Update our state pointers, increment UnansweredQueries as appropriate, and return
3206         *queryptr        = newptr;              // Update the packet pointer
3207         *answerforecast  = forecast;            // Update the forecast
3208         *kalistptrptr    = ka;                  // Update the known answer list pointer
3209         if (ucast) q->ExpectUnicastResp = NonZeroTime(m->timenow);
3210 
3211         for (rr = cg ? cg->members : mDNSNULL; rr; rr=rr->next)             // For every resource record in our cache,
3212             if (rr->resrec.InterfaceID == q->SendQNow &&                    // received on this interface
3213                 rr->NextInKAList == mDNSNULL && ka != &rr->NextInKAList &&  // which is not in the known answer list
3214                 SameNameRecordAnswersQuestion(&rr->resrec, q))              // which answers our question
3215             {
3216                 rr->UnansweredQueries++;                                    // indicate that we're expecting a response
3217                 rr->LastUnansweredTime = m->timenow;
3218                 SetNextCacheCheckTimeForRecord(m, rr);
3219             }
3220 
3221         return(mDNStrue);
3222     }
3223 }
3224 
3225 // When we have a query looking for a specified name, but there appear to be no answers with
3226 // that name, ReconfirmAntecedents() is called with depth=0 to start the reconfirmation process
3227 // for any records in our cache that reference the given name (e.g. PTR and SRV records).
3228 // For any such cache record we find, we also recursively call ReconfirmAntecedents() for *its* name.
3229 // We increment depth each time we recurse, to guard against possible infinite loops, with a limit of 5.
3230 // A typical reconfirmation scenario might go like this:
3231 // Depth 0: Name "myhost.local" has no address records
3232 // Depth 1: SRV "My Service._example._tcp.local." refers to "myhost.local"; may be stale
3233 // Depth 2: PTR "_example._tcp.local." refers to "My Service"; may be stale
3234 // Depth 3: PTR "_services._dns-sd._udp.local." refers to "_example._tcp.local."; may be stale
3235 // Currently depths 4 and 5 are not expected to occur; if we did get to depth 5 we'd reconfim any records we
3236 // found referring to the given name, but not recursively descend any further reconfirm *their* antecedents.
3237 mDNSlocal void ReconfirmAntecedents(mDNS *const m, const domainname *const name, const mDNSu32 namehash, const mDNSInterfaceID InterfaceID, const int depth)
3238 {
3239     mDNSu32 slot;
3240     const CacheGroup *cg;
3241     CacheRecord *cr;
3242     debugf("ReconfirmAntecedents (depth=%d) for %##s", depth, name->c);
3243     if (!InterfaceID) return; // mDNS records have a non-zero InterfaceID. If InterfaceID is 0, then there's nothing to do.
3244     FORALL_CACHERECORDS(slot, cg, cr)
3245     {
3246         const domainname *crtarget;
3247         if (cr->resrec.InterfaceID != InterfaceID) continue; // Skip non-mDNS records and mDNS records from other interfaces.
3248         if (cr->resrec.rdatahash != namehash)      continue; // Skip records whose rdata hash doesn't match the name hash.
3249         crtarget = GetRRDomainNameTarget(&cr->resrec);
3250         if (crtarget && SameDomainName(crtarget, name))
3251         {
3252             LogInfo("ReconfirmAntecedents: Reconfirming (depth=%d, InterfaceID=%p) %s", depth, InterfaceID, CRDisplayString(m, cr));
3253             mDNS_Reconfirm_internal(m, cr, kDefaultReconfirmTimeForNoAnswer);
3254             if (depth < 5)
3255                 ReconfirmAntecedents(m, cr->resrec.name, cr->resrec.namehash, InterfaceID, depth+1);
3256         }
3257     }
3258 }
3259 
3260 // If we get no answer for a AAAA query, then before doing an automatic implicit ReconfirmAntecedents
3261 // we check if we have an address record for the same name. If we do have an IPv4 address for a given
3262 // name but not an IPv6 address, that's okay (it just means the device doesn't do IPv6) so the failure
3263 // to get a AAAA response is not grounds to doubt the PTR/SRV chain that lead us to that name.
3264 mDNSlocal const CacheRecord *CacheHasAddressTypeForName(mDNS *const m, const domainname *const name, const mDNSu32 namehash)
3265 {
3266     CacheGroup *const cg = CacheGroupForName(m, namehash, name);
3267     const CacheRecord *cr = cg ? cg->members : mDNSNULL;
3268     while (cr && !RRTypeIsAddressType(cr->resrec.rrtype)) cr=cr->next;
3269     return(cr);
3270 }
3271 
3272 
3273 mDNSlocal const CacheRecord *FindSPSInCache1(mDNS *const m, const DNSQuestion *const q, const CacheRecord *const c0, const CacheRecord *const c1)
3274 {
3275 #ifndef SPC_DISABLED
3276     CacheGroup *const cg = CacheGroupForName(m, q->qnamehash, &q->qname);
3277     const CacheRecord *cr, *bestcr = mDNSNULL;
3278     mDNSu32 bestmetric = 1000000;
3279     for (cr = cg ? cg->members : mDNSNULL; cr; cr=cr->next)
3280         if (cr->resrec.rrtype == kDNSType_PTR && cr->resrec.rdlength >= 6)                      // If record is PTR type, with long enough name,
3281             if (cr != c0 && cr != c1)                                                           // that's not one we've seen before,
3282                 if (SameNameRecordAnswersQuestion(&cr->resrec, q))                              // and answers our browse query,
3283                     if (!IdenticalSameNameRecord(&cr->resrec, &m->SPSRecords.RR_PTR.resrec))    // and is not our own advertised service...
3284                     {
3285                         mDNSu32 metric = SPSMetric(cr->resrec.rdata->u.name.c);
3286                         if (bestmetric > metric) { bestmetric = metric; bestcr = cr; }
3287                     }
3288     return(bestcr);
3289 #else // SPC_DISABLED
3290     (void) m;
3291     (void) q;
3292     (void) c0;
3293     (void) c1;
3294     (void) c1;
3295     return mDNSNULL;
3296 #endif // SPC_DISABLED
3297 }
3298 
3299 mDNSlocal void CheckAndSwapSPS(const CacheRecord **sps1, const CacheRecord **sps2)
3300 {
3301     const CacheRecord *swap_sps;
3302     mDNSu32 metric1, metric2;
3303 
3304     if (!(*sps1) || !(*sps2)) return;
3305     metric1 = SPSMetric((*sps1)->resrec.rdata->u.name.c);
3306     metric2 = SPSMetric((*sps2)->resrec.rdata->u.name.c);
3307     if (!SPSFeatures((*sps1)->resrec.rdata->u.name.c) && SPSFeatures((*sps2)->resrec.rdata->u.name.c) && (metric2 >= metric1))
3308     {
3309         swap_sps = *sps1;
3310         *sps1    = *sps2;
3311         *sps2    = swap_sps;
3312     }
3313 }
3314 
3315 mDNSlocal void ReorderSPSByFeature(const CacheRecord *sps[3])
3316 {
3317     CheckAndSwapSPS(&sps[0], &sps[1]);
3318     CheckAndSwapSPS(&sps[0], &sps[2]);
3319     CheckAndSwapSPS(&sps[1], &sps[2]);
3320 }
3321 
3322 
3323 // Finds the three best Sleep Proxies we currently have in our cache
3324 mDNSexport void FindSPSInCache(mDNS *const m, const DNSQuestion *const q, const CacheRecord *sps[3])
3325 {
3326     sps[0] =                      FindSPSInCache1(m, q, mDNSNULL, mDNSNULL);
3327     sps[1] = !sps[0] ? mDNSNULL : FindSPSInCache1(m, q, sps[0],   mDNSNULL);
3328     sps[2] = !sps[1] ? mDNSNULL : FindSPSInCache1(m, q, sps[0],   sps[1]);
3329 
3330     // SPS is already sorted by metric. We want to move the entries to the beginning of the array
3331     // only if they have equally good metric and support features.
3332     ReorderSPSByFeature(sps);
3333 }
3334 
3335 // Only DupSuppressInfos newer than the specified 'time' are allowed to remain active
3336 mDNSlocal void ExpireDupSuppressInfo(DupSuppressInfo ds[DupSuppressInfoSize], mDNSs32 time)
3337 {
3338     int i;
3339     for (i=0; i<DupSuppressInfoSize; i++) if (ds[i].Time - time < 0) ds[i].InterfaceID = mDNSNULL;
3340 }
3341 
3342 mDNSlocal void ExpireDupSuppressInfoOnInterface(DupSuppressInfo ds[DupSuppressInfoSize], mDNSs32 time, mDNSInterfaceID InterfaceID)
3343 {
3344     int i;
3345     for (i=0; i<DupSuppressInfoSize; i++) if (ds[i].InterfaceID == InterfaceID && ds[i].Time - time < 0) ds[i].InterfaceID = mDNSNULL;
3346 }
3347 
3348 mDNSlocal mDNSBool SuppressOnThisInterface(const DupSuppressInfo ds[DupSuppressInfoSize], const NetworkInterfaceInfo * const intf)
3349 {
3350     int i;
3351     mDNSBool v4 = !intf->IPv4Available;     // If this interface doesn't do v4, we don't need to find a v4 duplicate of this query
3352     mDNSBool v6 = !intf->IPv6Available;     // If this interface doesn't do v6, we don't need to find a v6 duplicate of this query
3353     for (i=0; i<DupSuppressInfoSize; i++)
3354         if (ds[i].InterfaceID == intf->InterfaceID)
3355         {
3356             if      (ds[i].Type == mDNSAddrType_IPv4) v4 = mDNStrue;
3357             else if (ds[i].Type == mDNSAddrType_IPv6) v6 = mDNStrue;
3358             if (v4 && v6) return(mDNStrue);
3359         }
3360     return(mDNSfalse);
3361 }
3362 
3363 mDNSlocal void RecordDupSuppressInfo(DupSuppressInfo ds[DupSuppressInfoSize], mDNSs32 Time, mDNSInterfaceID InterfaceID, mDNSs32 Type)
3364 {
3365     int i, j;
3366 
3367     // See if we have this one in our list somewhere already
3368     for (i=0; i<DupSuppressInfoSize; i++) if (ds[i].InterfaceID == InterfaceID && ds[i].Type == Type) break;
3369 
3370     // If not, find a slot we can re-use
3371     if (i >= DupSuppressInfoSize)
3372     {
3373         i = 0;
3374         for (j=1; j<DupSuppressInfoSize && ds[i].InterfaceID; j++)
3375             if (!ds[j].InterfaceID || ds[j].Time - ds[i].Time < 0)
3376                 i = j;
3377     }
3378 
3379     // Record the info about this query we saw
3380     ds[i].Time        = Time;
3381     ds[i].InterfaceID = InterfaceID;
3382     ds[i].Type        = Type;
3383 }
3384 
3385 mDNSlocal void mDNSSendWakeOnResolve(mDNS *const m, DNSQuestion *q)
3386 {
3387     int len, i, cnt;
3388     mDNSInterfaceID InterfaceID = q->InterfaceID;
3389     domainname *d = &q->qname;
3390 
3391     // We can't send magic packets without knowing which interface to send it on.
3392     if (InterfaceID == mDNSInterface_Any || LocalOnlyOrP2PInterface(InterfaceID))
3393     {
3394         LogMsg("mDNSSendWakeOnResolve: ERROR!! Invalid InterfaceID %p for question %##s", InterfaceID, q->qname.c);
3395         return;
3396     }
3397 
3398     // Split MAC@IPAddress and pass them separately
3399     len = d->c[0];
3400     cnt = 0;
3401     for (i = 1; i < len; i++)
3402     {
3403         if (d->c[i] == '@')
3404         {
3405             char EthAddr[18];   // ethernet adddress : 12 bytes + 5 ":" + 1 NULL byte
3406             char IPAddr[47];    // Max IP address len: 46 bytes (IPv6) + 1 NULL byte
3407             if (cnt != 5)
3408             {
3409                 LogMsg("mDNSSendWakeOnResolve: ERROR!! Malformed Ethernet address %##s, cnt %d", q->qname.c, cnt);
3410                 return;
3411             }
3412             if ((i - 1) > (int) (sizeof(EthAddr) - 1))
3413             {
3414                 LogMsg("mDNSSendWakeOnResolve: ERROR!! Malformed Ethernet address %##s, length %d", q->qname.c, i - 1);
3415                 return;
3416             }
3417             if ((len - i) > (int)(sizeof(IPAddr) - 1))
3418             {
3419                 LogMsg("mDNSSendWakeOnResolve: ERROR!! Malformed IP address %##s, length %d", q->qname.c, len - i);
3420                 return;
3421             }
3422             mDNSPlatformMemCopy(EthAddr, &d->c[1], i - 1);
3423             EthAddr[i - 1] = 0;
3424             mDNSPlatformMemCopy(IPAddr, &d->c[i + 1], len - i);
3425             IPAddr[len - i] = 0;
3426             m->mDNSStats.WakeOnResolves++;
3427             mDNSPlatformSendWakeupPacket(InterfaceID, EthAddr, IPAddr, InitialWakeOnResolveCount - q->WakeOnResolveCount);
3428             return;
3429         }
3430         else if (d->c[i] == ':')
3431             cnt++;
3432     }
3433     LogMsg("mDNSSendWakeOnResolve: ERROR!! Malformed WakeOnResolve name %##s", q->qname.c);
3434 }
3435 
3436 
3437 mDNSlocal mDNSBool AccelerateThisQuery(mDNS *const m, DNSQuestion *q)
3438 {
3439     // If more than 90% of the way to the query time, we should unconditionally accelerate it
3440     if (TimeToSendThisQuestion(q, m->timenow + q->ThisQInterval/10))
3441         return(mDNStrue);
3442 
3443     // If half-way to next scheduled query time, only accelerate if it will add less than 512 bytes to the packet
3444     if (TimeToSendThisQuestion(q, m->timenow + q->ThisQInterval/2))
3445     {
3446         // We forecast: qname (n) type (2) class (2)
3447         mDNSu32 forecast = (mDNSu32)DomainNameLength(&q->qname) + 4;
3448         const CacheGroup *const cg = CacheGroupForName(m, q->qnamehash, &q->qname);
3449         const CacheRecord *rr;
3450         for (rr = cg ? cg->members : mDNSNULL; rr; rr=rr->next)             // If we have a resource record in our cache,
3451             if (rr->resrec.rdlength <= SmallRecordLimit &&                  // which is small enough to sensibly fit in the packet
3452                 SameNameRecordAnswersQuestion(&rr->resrec, q) &&            // which answers our question
3453                 rr->TimeRcvd + TicksTTL(rr)/2 - m->timenow >= 0 &&          // and it is less than half-way to expiry
3454                 rr->NextRequiredQuery - (m->timenow + q->ThisQInterval) > 0) // and we'll ask at least once again before NextRequiredQuery
3455             {
3456                 // We forecast: compressed name (2) type (2) class (2) TTL (4) rdlength (2) rdata (n)
3457                 forecast += 12 + rr->resrec.rdestimate;
3458                 if (forecast >= 512) return(mDNSfalse); // If this would add 512 bytes or more to the packet, don't accelerate
3459             }
3460         return(mDNStrue);
3461     }
3462 
3463     return(mDNSfalse);
3464 }
3465 
3466 // How Standard Queries are generated:
3467 // 1. The Question Section contains the question
3468 // 2. The Additional Section contains answers we already know, to suppress duplicate responses
3469 
3470 // How Probe Queries are generated:
3471 // 1. The Question Section contains queries for the name we intend to use, with QType=ANY because
3472 // if some other host is already using *any* records with this name, we want to know about it.
3473 // 2. The Authority Section contains the proposed values we intend to use for one or more
3474 // of our records with that name (analogous to the Update section of DNS Update packets)
3475 // because if some other host is probing at the same time, we each want to know what the other is
3476 // planning, in order to apply the tie-breaking rule to see who gets to use the name and who doesn't.
3477 
3478 mDNSlocal void SendQueries(mDNS *const m)
3479 {
3480     mDNSu32 slot;
3481     CacheGroup *cg;
3482     CacheRecord *cr;
3483     AuthRecord *ar;
3484     int pktcount = 0;
3485     DNSQuestion *q;
3486     // For explanation of maxExistingQuestionInterval logic, see comments for maxExistingAnnounceInterval
3487     mDNSs32 maxExistingQuestionInterval = 0;
3488     const NetworkInterfaceInfo *intf = GetFirstActiveInterface(m->HostInterfaces);
3489     CacheRecord *KnownAnswerList = mDNSNULL;
3490 
3491     // 1. If time for a query, work out what we need to do
3492 
3493     // We're expecting to send a query anyway, so see if any expiring cache records are close enough
3494     // to their NextRequiredQuery to be worth batching them together with this one
3495     FORALL_CACHERECORDS(slot, cg, cr)
3496     {
3497         if (cr->CRActiveQuestion && cr->UnansweredQueries < MaxUnansweredQueries)
3498         {
3499             if (m->timenow + TicksTTL(cr)/50 - cr->NextRequiredQuery >= 0)
3500             {
3501                 debugf("Sending %d%% cache expiration query for %s", 80 + 5 * cr->UnansweredQueries, CRDisplayString(m, cr));
3502                 q = cr->CRActiveQuestion;
3503                 ExpireDupSuppressInfoOnInterface(q->DupSuppress, m->timenow - TicksTTL(cr)/20, cr->resrec.InterfaceID);
3504                 // For uDNS queries (TargetQID non-zero) we adjust LastQTime,
3505                 // and bump UnansweredQueries so that we don't spin trying to send the same cache expiration query repeatedly
3506                 if (q->Target.type)
3507                 {
3508                     q->SendQNow = mDNSInterfaceMark; // If targeted query, mark it
3509                 }
3510                 else if (!mDNSOpaque16IsZero(q->TargetQID))
3511                 {
3512                     q->LastQTime = m->timenow - q->ThisQInterval;
3513                     cr->UnansweredQueries++;
3514                     m->mDNSStats.CacheRefreshQueries++;
3515                 }
3516                 else if (q->SendQNow == mDNSNULL)
3517                 {
3518                     q->SendQNow = cr->resrec.InterfaceID;
3519                 }
3520                 else if (q->SendQNow != cr->resrec.InterfaceID)
3521                 {
3522                     q->SendQNow = mDNSInterfaceMark;
3523                 }
3524 
3525                 // Indicate that this question was marked for sending
3526                 // to update an existing cached answer record.
3527                 // The browse throttling logic below uses this to determine
3528                 // if the query should be sent.
3529                 if (mDNSOpaque16IsZero(q->TargetQID))
3530                     q->CachedAnswerNeedsUpdate = mDNStrue;
3531             }
3532         }
3533     }
3534 
3535     // Scan our list of questions to see which:
3536     //     *WideArea*  queries need to be sent
3537     //     *unicast*   queries need to be sent
3538     //     *multicast* queries we're definitely going to send
3539     if (m->CurrentQuestion)
3540         LogMsg("SendQueries ERROR m->CurrentQuestion already set: %##s (%s)", m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
3541     m->CurrentQuestion = m->Questions;
3542     while (m->CurrentQuestion && m->CurrentQuestion != m->NewQuestions)
3543     {
3544         q = m->CurrentQuestion;
3545         if (q->Target.type && (q->SendQNow || TimeToSendThisQuestion(q, m->timenow)))
3546         {
3547             mDNSu8       *qptr        = m->omsg.data;
3548             const mDNSu8 *const limit = m->omsg.data + sizeof(m->omsg.data);
3549 
3550             // If we fail to get a new on-demand socket (should only happen cases of the most extreme resource exhaustion), we'll try again next time
3551             if (!q->LocalSocket) q->LocalSocket = mDNSPlatformUDPSocket(zeroIPPort);
3552             if (q->LocalSocket)
3553             {
3554                 InitializeDNSMessage(&m->omsg.h, q->TargetQID, QueryFlags);
3555                 qptr = putQuestion(&m->omsg, qptr, limit, &q->qname, q->qtype, q->qclass);
3556                 mDNSSendDNSMessage(m, &m->omsg, qptr, mDNSInterface_Any, q->LocalSocket, &q->Target, q->TargetPort, mDNSNULL, mDNSNULL, q->UseBackgroundTrafficClass);
3557                 q->ThisQInterval    *= QuestionIntervalStep;
3558             }
3559             if (q->ThisQInterval > MaxQuestionInterval)
3560                 q->ThisQInterval = MaxQuestionInterval;
3561             q->LastQTime         = m->timenow;
3562             q->LastQTxTime       = m->timenow;
3563             q->RecentAnswerPkts  = 0;
3564             q->SendQNow          = mDNSNULL;
3565             q->ExpectUnicastResp = NonZeroTime(m->timenow);
3566         }
3567         else if (mDNSOpaque16IsZero(q->TargetQID) && !q->Target.type && TimeToSendThisQuestion(q, m->timenow))
3568         {
3569             //LogInfo("Time to send %##s (%s) %d", q->qname.c, DNSTypeName(q->qtype), m->timenow - NextQSendTime(q));
3570             q->SendQNow = mDNSInterfaceMark;        // Mark this question for sending on all interfaces
3571             if (maxExistingQuestionInterval < q->ThisQInterval)
3572                 maxExistingQuestionInterval = q->ThisQInterval;
3573         }
3574         // If m->CurrentQuestion wasn't modified out from under us, advance it now
3575         // We can't do this at the start of the loop because uDNS_CheckCurrentQuestion() depends on having
3576         // m->CurrentQuestion point to the right question
3577         if (q == m->CurrentQuestion) m->CurrentQuestion = m->CurrentQuestion->next;
3578     }
3579     while (m->CurrentQuestion)
3580     {
3581         LogInfo("SendQueries question loop 1: Skipping NewQuestion %##s (%s)", m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
3582         m->CurrentQuestion = m->CurrentQuestion->next;
3583     }
3584     m->CurrentQuestion = mDNSNULL;
3585 
3586     // Scan our list of questions
3587     // (a) to see if there are any more that are worth accelerating, and
3588     // (b) to update the state variables for *all* the questions we're going to send
3589     // Note: Don't set NextScheduledQuery until here, because uDNS_CheckCurrentQuestion in the loop above can add new questions to the list,
3590     // which causes NextScheduledQuery to get (incorrectly) set to m->timenow. Setting it here is the right place, because the very
3591     // next thing we do is scan the list and call SetNextQueryTime() for every question we find, so we know we end up with the right value.
3592     m->NextScheduledQuery = m->timenow + FutureTime;
3593     for (q = m->Questions; q && q != m->NewQuestions; q=q->next)
3594     {
3595         if (mDNSOpaque16IsZero(q->TargetQID)
3596             && (q->SendQNow || (!q->Target.type && ActiveQuestion(q) && q->ThisQInterval <= maxExistingQuestionInterval && AccelerateThisQuery(m,q))))
3597         {
3598             // If at least halfway to next query time, advance to next interval
3599             // If less than halfway to next query time, then
3600             // treat this as logically a repeat of the last transmission, without advancing the interval
3601             if (m->timenow - (q->LastQTime + (q->ThisQInterval/2)) >= 0)
3602             {
3603                 // If we have reached the answer threshold for this question,
3604                 // don't send it again until MaxQuestionInterval unless:
3605                 //  one of its cached answers needs to be refreshed,
3606                 //  or it's the initial query for a kDNSServiceFlagsThresholdFinder mode browse.
3607                 if (q->BrowseThreshold
3608                     && (q->CurrentAnswers >= q->BrowseThreshold)
3609                     && (q->CachedAnswerNeedsUpdate == mDNSfalse)
3610                     && !((q->flags & kDNSServiceFlagsThresholdFinder) && (q->ThisQInterval == InitialQuestionInterval)))
3611                 {
3612                     q->SendQNow = mDNSNULL;
3613                     q->ThisQInterval = MaxQuestionInterval;
3614                     q->LastQTime = m->timenow;
3615                     q->RequestUnicast = 0;
3616                     LogInfo("SendQueries: (%s) %##s reached threshold of %d answers",
3617                          DNSTypeName(q->qtype), q->qname.c, q->BrowseThreshold);
3618                 }
3619                 else
3620                 {
3621                     // Mark this question for sending on all interfaces
3622                     q->SendQNow = mDNSInterfaceMark;
3623                     q->ThisQInterval *= QuestionIntervalStep;
3624                 }
3625 
3626                 debugf("SendQueries: %##s (%s) next interval %d seconds RequestUnicast = %d",
3627                        q->qname.c, DNSTypeName(q->qtype), q->ThisQInterval / InitialQuestionInterval, q->RequestUnicast);
3628 
3629                 if (q->ThisQInterval > MaxQuestionInterval)
3630                 {
3631                     q->ThisQInterval = MaxQuestionInterval;
3632                 }
3633                 else if (mDNSOpaque16IsZero(q->TargetQID) && q->InterfaceID &&
3634                          q->CurrentAnswers == 0 && q->ThisQInterval == InitialQuestionInterval * QuestionIntervalStep3 && !q->RequestUnicast &&
3635                          !(RRTypeIsAddressType(q->qtype) && CacheHasAddressTypeForName(m, &q->qname, q->qnamehash)))
3636                 {
3637                     // Generally don't need to log this.
3638                     // It's not especially noteworthy if a query finds no results -- this usually happens for domain
3639                     // enumeration queries in the LL subdomain (e.g. "db._dns-sd._udp.0.0.254.169.in-addr.arpa")
3640                     // and when there simply happen to be no instances of the service the client is looking
3641                     // for (e.g. iTunes is set to look for RAOP devices, and the current network has none).
3642                     debugf("SendQueries: Zero current answers for %##s (%s); will reconfirm antecedents",
3643                            q->qname.c, DNSTypeName(q->qtype));
3644                     // Sending third query, and no answers yet; time to begin doubting the source
3645                     ReconfirmAntecedents(m, &q->qname, q->qnamehash, q->InterfaceID, 0);
3646                 }
3647             }
3648 
3649             // Mark for sending. (If no active interfaces, then don't even try.)
3650             q->SendOnAll = (q->SendQNow == mDNSInterfaceMark);
3651             if (q->SendOnAll)
3652             {
3653                 q->SendQNow  = !intf ? mDNSNULL : (q->InterfaceID) ? q->InterfaceID : intf->InterfaceID;
3654                 q->LastQTime = m->timenow;
3655             }
3656 
3657             // If we recorded a duplicate suppression for this question less than half an interval ago,
3658             // then we consider it recent enough that we don't need to do an identical query ourselves.
3659             ExpireDupSuppressInfo(q->DupSuppress, m->timenow - q->ThisQInterval/2);
3660 
3661             q->LastQTxTime      = m->timenow;
3662             q->RecentAnswerPkts = 0;
3663             if (q->RequestUnicast) q->RequestUnicast--;
3664         }
3665         // For all questions (not just the ones we're sending) check what the next scheduled event will be
3666         // We don't need to consider NewQuestions here because for those we'll set m->NextScheduledQuery in AnswerNewQuestion
3667         SetNextQueryTime(m,q);
3668     }
3669 
3670     // 2. Scan our authoritative RR list to see what probes we might need to send
3671 
3672     m->NextScheduledProbe = m->timenow + FutureTime;
3673 
3674     if (m->CurrentRecord)
3675         LogMsg("SendQueries ERROR m->CurrentRecord already set %s", ARDisplayString(m, m->CurrentRecord));
3676     m->CurrentRecord = m->ResourceRecords;
3677     while (m->CurrentRecord)
3678     {
3679         ar = m->CurrentRecord;
3680         m->CurrentRecord = ar->next;
3681         if (!AuthRecord_uDNS(ar) && ar->resrec.RecordType == kDNSRecordTypeUnique)  // For all records that are still probing...
3682         {
3683             // 1. If it's not reached its probe time, just make sure we update m->NextScheduledProbe correctly
3684             if (m->timenow - (ar->LastAPTime + ar->ThisAPInterval) < 0)
3685             {
3686                 SetNextAnnounceProbeTime(m, ar);
3687             }
3688             // 2. else, if it has reached its probe time, mark it for sending and then update m->NextScheduledProbe correctly
3689             else if (ar->ProbeCount)
3690             {
3691                 if (ar->AddressProxy.type == mDNSAddrType_IPv4)
3692                 {
3693                     // There's a problem here. If a host is waking up, and we probe to see if it responds, then
3694                     // it will see those ARP probes as signalling intent to use the address, so it picks a different one.
3695                     // A more benign way to find out if a host is responding to ARPs might be send a standard ARP *request*
3696                     // (using our sender IP address) instead of an ARP *probe* (using all-zero sender IP address).
3697                     // A similar concern may apply to the NDP Probe too. -- SC
3698                     LogSPS("SendQueries ARP Probe %d %s %s", ar->ProbeCount, InterfaceNameForID(m, ar->resrec.InterfaceID), ARDisplayString(m,ar));
3699                     SendARP(m, 1, ar, &zerov4Addr, &zeroEthAddr, &ar->AddressProxy.ip.v4, &ar->WakeUp.IMAC);
3700                 }
3701                 else if (ar->AddressProxy.type == mDNSAddrType_IPv6)
3702                 {
3703                     LogSPS("SendQueries NDP Probe %d %s %s", ar->ProbeCount, InterfaceNameForID(m, ar->resrec.InterfaceID), ARDisplayString(m,ar));
3704                     // IPv6 source = zero
3705                     // No target hardware address
3706                     // IPv6 target address is address we're probing
3707                     // Ethernet destination address is Ethernet interface address of the Sleep Proxy client we're probing
3708                     SendNDP(m, NDP_Sol, 0, ar, &zerov6Addr, mDNSNULL, &ar->AddressProxy.ip.v6, &ar->WakeUp.IMAC);
3709                 }
3710                 // Mark for sending. (If no active interfaces, then don't even try.)
3711                 ar->SendRNow   = (!intf || ar->WakeUp.HMAC.l[0]) ? mDNSNULL : ar->resrec.InterfaceID ? ar->resrec.InterfaceID : intf->InterfaceID;
3712                 ar->LastAPTime = m->timenow;
3713                 // When we have a late conflict that resets a record to probing state we use a special marker value greater
3714                 // than DefaultProbeCountForTypeUnique. Here we detect that state and reset ar->ProbeCount back to the right value.
3715                 if (ar->ProbeCount > DefaultProbeCountForTypeUnique)
3716                     ar->ProbeCount = DefaultProbeCountForTypeUnique;
3717                 ar->ProbeCount--;
3718                 SetNextAnnounceProbeTime(m, ar);
3719                 if (ar->ProbeCount == 0)
3720                 {
3721                     // If this is the last probe for this record, then see if we have any matching records
3722                     // on our duplicate list which should similarly have their ProbeCount cleared to zero...
3723                     AuthRecord *r2;
3724                     for (r2 = m->DuplicateRecords; r2; r2=r2->next)
3725                         if (r2->resrec.RecordType == kDNSRecordTypeUnique && RecordIsLocalDuplicate(r2, ar))
3726                             r2->ProbeCount = 0;
3727                     // ... then acknowledge this record to the client.
3728                     // We do this optimistically, just as we're about to send the third probe.
3729                     // This helps clients that both advertise and browse, and want to filter themselves
3730                     // from the browse results list, because it helps ensure that the registration
3731                     // confirmation will be delivered 1/4 second *before* the browse "add" event.
3732                     // A potential downside is that we could deliver a registration confirmation and then find out
3733                     // moments later that there's a name conflict, but applications have to be prepared to handle
3734                     // late conflicts anyway (e.g. on connection of network cable, etc.), so this is nothing new.
3735                     if (!ar->Acknowledged) AcknowledgeRecord(m, ar);
3736                 }
3737             }
3738             // else, if it has now finished probing, move it to state Verified,
3739             // and update m->NextScheduledResponse so it will be announced
3740             else
3741             {
3742                 if (!ar->Acknowledged) AcknowledgeRecord(m, ar);    // Defensive, just in case it got missed somehow
3743                 ar->resrec.RecordType     = kDNSRecordTypeVerified;
3744                 ar->ThisAPInterval = DefaultAnnounceIntervalForTypeUnique;
3745                 ar->LastAPTime     = m->timenow - DefaultAnnounceIntervalForTypeUnique;
3746                 SetNextAnnounceProbeTime(m, ar);
3747             }
3748         }
3749     }
3750     m->CurrentRecord = m->DuplicateRecords;
3751     while (m->CurrentRecord)
3752     {
3753         ar = m->CurrentRecord;
3754         m->CurrentRecord = ar->next;
3755         if (ar->resrec.RecordType == kDNSRecordTypeUnique && ar->ProbeCount == 0 && !ar->Acknowledged)
3756             AcknowledgeRecord(m, ar);
3757     }
3758 
3759     // 3. Now we know which queries and probes we're sending,
3760     // go through our interface list sending the appropriate queries on each interface
3761     while (intf)
3762     {
3763         int OwnerRecordSpace = (m->AnnounceOwner && intf->MAC.l[0]) ? DNSOpt_Header_Space + DNSOpt_Owner_Space(&m->PrimaryMAC, &intf->MAC) : 0;
3764         int TraceRecordSpace = (mDNS_McastTracingEnabled && MDNS_TRACER) ? DNSOpt_Header_Space + DNSOpt_TraceData_Space : 0;
3765         mDNSu8 *queryptr = m->omsg.data;
3766         mDNSBool useBackgroundTrafficClass = mDNSfalse;    // set if we should use background traffic class
3767 
3768         InitializeDNSMessage(&m->omsg.h, zeroID, QueryFlags);
3769         if (KnownAnswerList) verbosedebugf("SendQueries:   KnownAnswerList set... Will continue from previous packet");
3770         if (!KnownAnswerList)
3771         {
3772             // Start a new known-answer list
3773             CacheRecord **kalistptr = &KnownAnswerList;
3774             mDNSu32 answerforecast = OwnerRecordSpace + TraceRecordSpace;  // Start by assuming we'll need at least enough space to put the Owner+Tracer Option
3775 
3776             // Put query questions in this packet
3777             for (q = m->Questions; q && q != m->NewQuestions; q=q->next)
3778             {
3779                 if (mDNSOpaque16IsZero(q->TargetQID) && (q->SendQNow == intf->InterfaceID))
3780                 {
3781                     mDNSBool Suppress = mDNSfalse;
3782                     debugf("SendQueries: %s question for %##s (%s) at %d forecast total %d",
3783                            SuppressOnThisInterface(q->DupSuppress, intf) ? "Suppressing" : "Putting    ",
3784                            q->qname.c, DNSTypeName(q->qtype), queryptr - m->omsg.data, queryptr + answerforecast - m->omsg.data);
3785 
3786                     // If interface is P2P type, verify that query should be sent over it.
3787                     if (!mDNSPlatformValidQuestionForInterface(q, intf))
3788                     {
3789                         q->SendQNow = (q->InterfaceID || !q->SendOnAll) ? mDNSNULL : GetNextActiveInterfaceID(intf);
3790                     }
3791                     // If we're suppressing this question, or we successfully put it, update its SendQNow state
3792                     else if ((Suppress = SuppressOnThisInterface(q->DupSuppress, intf)) ||
3793                         BuildQuestion(m, intf, &m->omsg, &queryptr, q, &kalistptr, &answerforecast))
3794                     {
3795                         // We successfully added the question to the packet. Make sure that
3796                         // we also send the NSEC3 record if required. BuildQuestion accounted for
3797                         // the space.
3798                         //
3799                         // Note: We don't suppress anonymous questions and hence Suppress should always
3800                         // be zero.
3801 
3802                         if (Suppress)
3803                             m->mDNSStats.DupQuerySuppressions++;
3804 
3805                         if (!Suppress && q->AnonInfo)
3806                         {
3807                             debugf("SendQueries: marking for question %##s, Suppress %d", q->qname.c, Suppress);
3808                             q->AnonInfo->SendNow = intf->InterfaceID;
3809                         }
3810                         q->SendQNow = (q->InterfaceID || !q->SendOnAll) ? mDNSNULL : GetNextActiveInterfaceID(intf);
3811                         if (q->WakeOnResolveCount)
3812                         {
3813                             mDNSSendWakeOnResolve(m, q);
3814                             q->WakeOnResolveCount--;
3815                         }
3816 
3817                         // use background traffic class if any included question requires it
3818                         if (q->UseBackgroundTrafficClass)
3819                         {
3820                             useBackgroundTrafficClass = mDNStrue;
3821                         }
3822                     }
3823                 }
3824             }
3825 
3826             // Put probe questions in this packet
3827             for (ar = m->ResourceRecords; ar; ar=ar->next)
3828             {
3829                 if (ar->SendRNow != intf->InterfaceID)
3830                     continue;
3831 
3832                 // If interface is a P2P variant, verify that the probe should be sent over it.
3833                 if (!mDNSPlatformValidRecordForInterface(ar, intf->InterfaceID))
3834                 {
3835                     ar->SendRNow = (ar->resrec.InterfaceID) ? mDNSNULL : GetNextActiveInterfaceID(intf);
3836                     ar->IncludeInProbe = mDNSfalse;
3837                 }
3838                 else
3839                 {
3840                     mDNSBool ucast = (ar->ProbeCount >= DefaultProbeCountForTypeUnique-1) && m->CanReceiveUnicastOn5353 && intf->SupportsUnicastMDNSResponse;
3841                     mDNSu16 ucbit = (mDNSu16)(ucast ? kDNSQClass_UnicastResponse : 0);
3842                     const mDNSu8 *const limit = m->omsg.data + (m->omsg.h.numQuestions ? NormalMaxDNSMessageData : AbsoluteMaxDNSMessageData);
3843                     // We forecast: compressed name (2) type (2) class (2) TTL (4) rdlength (2) rdata (n)
3844                     mDNSu32 forecast = answerforecast + 12 + ar->resrec.rdestimate;
3845                     mDNSBool putProbe = mDNStrue;
3846                     mDNSu16 qclass = ar->resrec.rrclass | ucbit;
3847 
3848                     {// Determine if this probe question is already in packet's dns message
3849                         const mDNSu8 *questionptr = m->omsg.data;
3850                         DNSQuestion question;
3851                         mDNSu16 n;
3852                         for (n = 0; n < m->omsg.h.numQuestions && questionptr; n++)
3853                         {
3854                             questionptr = getQuestion(&m->omsg, questionptr, limit, mDNSInterface_Any, &question);
3855                             if (questionptr && (question.qtype == kDNSQType_ANY) && (question.qclass == qclass) &&
3856                                 (question.qnamehash == ar->resrec.namehash) && SameDomainName(&question.qname, ar->resrec.name))
3857                             {
3858                                 putProbe = mDNSfalse;  // set to false if already in message
3859                                 break;
3860                             }
3861                         }
3862                     }
3863 
3864                     if (putProbe)
3865                     {
3866                         mDNSu8 *newptr = putQuestion(&m->omsg, queryptr, limit - forecast, ar->resrec.name, kDNSQType_ANY, qclass);
3867                         if (newptr)
3868                         {
3869                             queryptr       = newptr;
3870                             answerforecast = forecast;
3871                             ar->SendRNow = (ar->resrec.InterfaceID) ? mDNSNULL : GetNextActiveInterfaceID(intf);
3872                             ar->IncludeInProbe = mDNStrue;
3873                             verbosedebugf("SendQueries:   Put Question %##s (%s) probecount %d InterfaceID= %d %d %d",
3874                                       ar->resrec.name->c, DNSTypeName(ar->resrec.rrtype), ar->ProbeCount, ar->resrec.InterfaceID, ar->resrec.rdestimate, answerforecast);
3875                         }
3876                     }
3877                     else
3878                     {
3879                         ar->SendRNow = (ar->resrec.InterfaceID) ? mDNSNULL : GetNextActiveInterfaceID(intf);
3880                         ar->IncludeInProbe = mDNStrue;
3881                     }
3882                 }
3883             }
3884         }
3885 
3886         // Put our known answer list (either new one from this question or questions, or remainder of old one from last time)
3887         while (KnownAnswerList)
3888         {
3889             CacheRecord *ka = KnownAnswerList;
3890             mDNSu32 SecsSinceRcvd = ((mDNSu32)(m->timenow - ka->TimeRcvd)) / mDNSPlatformOneSecond;
3891             mDNSu8 *newptr = PutResourceRecordTTLWithLimit(&m->omsg, queryptr, &m->omsg.h.numAnswers, &ka->resrec, ka->resrec.rroriginalttl - SecsSinceRcvd,
3892                                                            m->omsg.data + NormalMaxDNSMessageData - OwnerRecordSpace - TraceRecordSpace);
3893             if (newptr)
3894             {
3895                 verbosedebugf("SendQueries:   Put %##s (%s) at %d - %d",
3896                               ka->resrec.name->c, DNSTypeName(ka->resrec.rrtype), queryptr - m->omsg.data, newptr - m->omsg.data);
3897                 queryptr = newptr;
3898                 KnownAnswerList = ka->NextInKAList;
3899                 ka->NextInKAList = mDNSNULL;
3900             }
3901             else
3902             {
3903                 // If we ran out of space and we have more than one question in the packet, that's an error --
3904                 // we shouldn't have put more than one question if there was a risk of us running out of space.
3905                 if (m->omsg.h.numQuestions > 1)
3906                     LogMsg("SendQueries:   Put %d answers; No more space for known answers", m->omsg.h.numAnswers);
3907                 m->omsg.h.flags.b[0] |= kDNSFlag0_TC;
3908                 break;
3909             }
3910         }
3911 
3912         for (ar = m->ResourceRecords; ar; ar=ar->next)
3913         {
3914             if (ar->IncludeInProbe)
3915             {
3916                 mDNSu8 *newptr = PutResourceRecord(&m->omsg, queryptr, &m->omsg.h.numAuthorities, &ar->resrec);
3917                 ar->IncludeInProbe = mDNSfalse;
3918                 if (newptr) queryptr = newptr;
3919                 else LogMsg("SendQueries:   How did we fail to have space for the Update record %s", ARDisplayString(m,ar));
3920             }
3921         }
3922 
3923         for (q = m->Questions; q; q = q->next)
3924         {
3925             if (q->AnonInfo && q->AnonInfo->SendNow == intf->InterfaceID)
3926             {
3927                 mDNSu8 *newptr = PutResourceRecord(&m->omsg, queryptr, &m->omsg.h.numAuthorities, q->AnonInfo->nsec3RR);
3928                 if (newptr)
3929                 {
3930                     debugf("SendQueries: Added NSEC3 record %s on InterfaceID %p", RRDisplayString(m, q->AnonInfo->nsec3RR), intf->InterfaceID);
3931                     queryptr = newptr;
3932                 }
3933                 else
3934                 {
3935                     LogMsg("SendQueries: ERROR!! Cannot add NSEC3 record %s on InterfaceID %p", RRDisplayString(m, q->AnonInfo->nsec3RR), intf->InterfaceID);
3936                 }
3937                 q->AnonInfo->SendNow = mDNSNULL;
3938             }
3939         }
3940 
3941         if (queryptr > m->omsg.data)
3942         {
3943             // If we have data to send, add OWNER/TRACER/OWNER+TRACER option if necessary, then send packet
3944             if (OwnerRecordSpace || TraceRecordSpace)
3945             {
3946                 AuthRecord opt;
3947                 mDNS_SetupResourceRecord(&opt, mDNSNULL, mDNSInterface_Any, kDNSType_OPT, kStandardTTL, kDNSRecordTypeKnownUnique, AuthRecordAny, mDNSNULL, mDNSNULL);
3948                 opt.resrec.rrclass    = NormalMaxDNSMessageData;
3949                 opt.resrec.rdlength   = sizeof(rdataOPT);
3950                 opt.resrec.rdestimate = sizeof(rdataOPT);
3951                 if (OwnerRecordSpace && TraceRecordSpace)
3952                 {
3953                     opt.resrec.rdlength   += sizeof(rdataOPT);  // Two options in this OPT record
3954                     opt.resrec.rdestimate += sizeof(rdataOPT);
3955                     SetupOwnerOpt(m, intf, &opt.resrec.rdata->u.opt[0]);
3956                     SetupTracerOpt(m, &opt.resrec.rdata->u.opt[1]);
3957                 }
3958                 else if (OwnerRecordSpace)
3959                 {
3960                     SetupOwnerOpt(m, intf, &opt.resrec.rdata->u.opt[0]);
3961                 }
3962                 else if (TraceRecordSpace)
3963                 {
3964                     SetupTracerOpt(m, &opt.resrec.rdata->u.opt[0]);
3965                 }
3966                 queryptr = PutResourceRecordTTLWithLimit(&m->omsg, queryptr, &m->omsg.h.numAdditionals,
3967                                                          &opt.resrec, opt.resrec.rroriginalttl, m->omsg.data + AbsoluteMaxDNSMessageData);
3968                 if (!queryptr)
3969                 {
3970                     LogMsg("SendQueries: How did we fail to have space for %s %s OPT record (%d/%d/%d/%d) %s", OwnerRecordSpace ? "OWNER" : "", TraceRecordSpace ? "TRACER" : "",
3971                            m->omsg.h.numQuestions, m->omsg.h.numAnswers, m->omsg.h.numAuthorities, m->omsg.h.numAdditionals, ARDisplayString(m, &opt));
3972                 }
3973                 if (queryptr > m->omsg.data + NormalMaxDNSMessageData)
3974                 {
3975                     if (m->omsg.h.numQuestions != 1 || m->omsg.h.numAnswers != 0 || m->omsg.h.numAuthorities != 1 || m->omsg.h.numAdditionals != 1)
3976                         LogMsg("SendQueries: Why did we generate oversized packet with %s %s OPT record %p %p %p (%d/%d/%d/%d) %s", OwnerRecordSpace ? "OWNER" : "",
3977                                 TraceRecordSpace ? "TRACER" : "", m->omsg.data, m->omsg.data + NormalMaxDNSMessageData, queryptr, m->omsg.h.numQuestions, m->omsg.h.numAnswers,
3978                                 m->omsg.h.numAuthorities, m->omsg.h.numAdditionals, ARDisplayString(m, &opt));
3979                 }
3980             }
3981 
3982             if ((m->omsg.h.flags.b[0] & kDNSFlag0_TC) && m->omsg.h.numQuestions > 1)
3983                 LogMsg("SendQueries: Should not have more than one question (%d) in a truncated packet", m->omsg.h.numQuestions);
3984             debugf("SendQueries:   Sending %d Question%s %d Answer%s %d Update%s on %p",
3985                    m->omsg.h.numQuestions,   m->omsg.h.numQuestions   == 1 ? "" : "s",
3986                    m->omsg.h.numAnswers,     m->omsg.h.numAnswers     == 1 ? "" : "s",
3987                    m->omsg.h.numAuthorities, m->omsg.h.numAuthorities == 1 ? "" : "s", intf->InterfaceID);
3988             if (intf->IPv4Available) mDNSSendDNSMessage(m, &m->omsg, queryptr, intf->InterfaceID, mDNSNULL, &AllDNSLinkGroup_v4, MulticastDNSPort, mDNSNULL, mDNSNULL, useBackgroundTrafficClass);
3989             if (intf->IPv6Available) mDNSSendDNSMessage(m, &m->omsg, queryptr, intf->InterfaceID, mDNSNULL, &AllDNSLinkGroup_v6, MulticastDNSPort, mDNSNULL, mDNSNULL, useBackgroundTrafficClass);
3990             if (!m->SuppressSending) m->SuppressSending = NonZeroTime(m->timenow + (mDNSPlatformOneSecond+9)/10);
3991             if (++pktcount >= 1000)
3992             { LogMsg("SendQueries exceeded loop limit %d: giving up", pktcount); break; }
3993             // There might be more records left in the known answer list, or more questions to send
3994             // on this interface, so go around one more time and try again.
3995         }
3996         else    // Nothing more to send on this interface; go to next
3997         {
3998             const NetworkInterfaceInfo *next = GetFirstActiveInterface(intf->next);
3999             #if MDNS_DEBUGMSGS && 0
4000             const char *const msg = next ? "SendQueries:   Nothing more on %p; moving to %p" : "SendQueries:   Nothing more on %p";
4001             debugf(msg, intf, next);
4002             #endif
4003             intf = next;
4004         }
4005     }
4006 
4007     // 4. Final housekeeping
4008 
4009     // 4a. Debugging check: Make sure we announced all our records
4010     for (ar = m->ResourceRecords; ar; ar=ar->next)
4011         if (ar->SendRNow)
4012         {
4013             if (ar->ARType != AuthRecordLocalOnly && ar->ARType != AuthRecordP2P)
4014                 LogInfo("SendQueries: No active interface %d to send probe: %d %s",
4015                     (uint32_t)ar->SendRNow, (uint32_t)ar->resrec.InterfaceID, ARDisplayString(m, ar));
4016             ar->SendRNow = mDNSNULL;
4017         }
4018 
4019     // 4b. When we have lingering cache records that we're keeping around for a few seconds in the hope
4020     // that their interface which went away might come back again, the logic will want to send queries
4021     // for those records, but we can't because their interface isn't here any more, so to keep the
4022     // state machine ticking over we just pretend we did so.
4023     // If the interface does not come back in time, the cache record will expire naturally
4024     FORALL_CACHERECORDS(slot, cg, cr)
4025     {
4026         if (cr->CRActiveQuestion && cr->UnansweredQueries < MaxUnansweredQueries)
4027         {
4028             if (m->timenow + TicksTTL(cr)/50 - cr->NextRequiredQuery >= 0)
4029             {
4030                 cr->UnansweredQueries++;
4031                 cr->CRActiveQuestion->SendQNow = mDNSNULL;
4032                 SetNextCacheCheckTimeForRecord(m, cr);
4033             }
4034         }
4035     }
4036 
4037     // 4c. Debugging check: Make sure we sent all our planned questions
4038     // Do this AFTER the lingering cache records check above, because that will prevent spurious warnings for questions
4039     // we legitimately couldn't send because the interface is no longer available
4040     for (q = m->Questions; q; q=q->next)
4041     {
4042         if (q->SendQNow)
4043         {
4044             DNSQuestion *x;
4045             for (x = m->NewQuestions; x; x=x->next) if (x == q) break;  // Check if this question is a NewQuestion
4046             // There will not be an active interface for questions applied to mDNSInterface_BLE
4047             // so don't log the warning in that case.
4048             if (q->InterfaceID != mDNSInterface_BLE)
4049                 LogInfo("SendQueries: No active interface %d to send %s question: %d %##s (%s)",
4050                     (uint32_t)q->SendQNow, x ? "new" : "old", (uint32_t)q->InterfaceID, q->qname.c, DNSTypeName(q->qtype));
4051             q->SendQNow = mDNSNULL;
4052         }
4053         q->CachedAnswerNeedsUpdate = mDNSfalse;
4054     }
4055 }
4056 
4057 mDNSlocal void SendWakeup(mDNS *const m, mDNSInterfaceID InterfaceID, mDNSEthAddr *EthAddr, mDNSOpaque48 *password, mDNSBool unicastOnly)
4058 {
4059     int i, j;
4060 
4061     mDNSu8 *ptr = m->omsg.data;
4062     NetworkInterfaceInfo *intf = FirstInterfaceForID(m, InterfaceID);
4063     if (!intf) { LogMsg("SendARP: No interface with InterfaceID %p found", InterfaceID); return; }
4064 
4065     // 0x00 Destination address
4066     for (i=0; i<6; i++) *ptr++ = EthAddr->b[i];
4067 
4068     // 0x06 Source address (Note: Since we don't currently set the BIOCSHDRCMPLT option, BPF will fill in the real interface address for us)
4069     for (i=0; i<6; i++) *ptr++ = intf->MAC.b[0];
4070 
4071     // 0x0C Ethertype (0x0842)
4072     *ptr++ = 0x08;
4073     *ptr++ = 0x42;
4074 
4075     // 0x0E Wakeup sync sequence
4076     for (i=0; i<6; i++) *ptr++ = 0xFF;
4077 
4078     // 0x14 Wakeup data
4079     for (j=0; j<16; j++) for (i=0; i<6; i++) *ptr++ = EthAddr->b[i];
4080 
4081     // 0x74 Password
4082     for (i=0; i<6; i++) *ptr++ = password->b[i];
4083 
4084     mDNSPlatformSendRawPacket(m->omsg.data, ptr, InterfaceID);
4085 
4086     if (!unicastOnly)
4087     {
4088         // For Ethernet switches that don't flood-foward packets with unknown unicast destination MAC addresses,
4089         // broadcast is the only reliable way to get a wakeup packet to the intended target machine.
4090         // For 802.11 WPA networks, where a sleeping target machine may have missed a broadcast/multicast
4091         // key rotation, unicast is the only way to get a wakeup packet to the intended target machine.
4092         // So, we send one of each, unicast first, then broadcast second.
4093         for (i=0; i<6; i++) m->omsg.data[i] = 0xFF;
4094         mDNSPlatformSendRawPacket(m->omsg.data, ptr, InterfaceID);
4095     }
4096 }
4097 
4098 // ***************************************************************************
4099 #if COMPILER_LIKES_PRAGMA_MARK
4100 #pragma mark -
4101 #pragma mark - RR List Management & Task Management
4102 #endif
4103 
4104 // Whenever a question is answered, reset its state so that we don't query
4105 // the network repeatedly. This happens first time when we answer the question and
4106 // and later when we refresh the cache.
4107 mDNSlocal void ResetQuestionState(mDNS *const m, DNSQuestion *q)
4108 {
4109     q->LastQTime        = m->timenow;
4110     q->LastQTxTime      = m->timenow;
4111     q->RecentAnswerPkts = 0;
4112     q->ThisQInterval    = MaxQuestionInterval;
4113     q->RequestUnicast   = 0;
4114     // Reset unansweredQueries so that we don't penalize this server later when we
4115     // start sending queries when the cache expires.
4116     q->unansweredQueries = 0;
4117     debugf("ResetQuestionState: Set MaxQuestionInterval for %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
4118 }
4119 
4120 // Note: AnswerCurrentQuestionWithResourceRecord can call a user callback, which may change the record list and/or question list.
4121 // Any code walking either list must use the m->CurrentQuestion (and possibly m->CurrentRecord) mechanism to protect against this.
4122 // In fact, to enforce this, the routine will *only* answer the question currently pointed to by m->CurrentQuestion,
4123 // which will be auto-advanced (possibly to NULL) if the client callback cancels the question.
4124 mDNSexport void AnswerCurrentQuestionWithResourceRecord(mDNS *const m, CacheRecord *const rr, const QC_result AddRecord)
4125 {
4126     DNSQuestion *const q = m->CurrentQuestion;
4127     const mDNSBool followcname = FollowCNAME(q, &rr->resrec, AddRecord);
4128 
4129     verbosedebugf("AnswerCurrentQuestionWithResourceRecord:%4lu %s (%s) TTL %d %s",
4130                   q->CurrentAnswers, AddRecord ? "Add" : "Rmv", MortalityDisplayString(rr->resrec.mortality),
4131                   rr->resrec.rroriginalttl, CRDisplayString(m, rr));
4132 
4133     // When the response for the question was validated, the entire rrset was validated. If we deliver
4134     // a RMV for a single record in the rrset, we invalidate the response. If we deliver another add
4135     // in the future, we will do the revalidation again.
4136     //
4137     // Also, if we deliver an ADD for a negative cache record and it has no NSEC/NSEC3, the ValidationStatus needs
4138     // to be reset. This happens normally when we deliver a "secure" negative response followed by an insecure
4139     // negative response which can happen e.g., when disconnecting from network that leads to a negative response
4140     // due to no DNS servers. As we don't deliver RMVs for negative responses that were delivered before, we need
4141     // to do it on the next ADD of a negative cache record. This ADD could be the result of a timeout, no DNS servers
4142     // etc. in which case we need to reset the state to make sure we don't deliver them as secure. If this is
4143     // a real negative response, we would reset the state here and validate the results at the end of this function.
4144     // or the real response again if we purge the cache.
4145     if (q->ValidationRequired && ((AddRecord == QC_rmv) ||
4146         (rr->resrec.RecordType == kDNSRecordTypePacketNegative && (AddRecord == QC_add))))
4147     {
4148         q->ValidationStatus = 0;
4149         q->ValidationState = DNSSECValRequired;
4150     }
4151 
4152     // Normally we don't send out the unicast query if we have answered using our local only auth records e.g., /etc/hosts.
4153     // But if the query for "A" record has a local answer but query for "AAAA" record has no local answer, we might
4154     // send the AAAA query out which will come back with CNAME and will also answer the "A" query. To prevent that,
4155     // we check to see if that query already has a unique local answer.
4156     if (q->LOAddressAnswers)
4157     {
4158         LogInfo("AnswerCurrentQuestionWithResourceRecord: Question %p %##s (%s) not answering with record %s due to "
4159                 "LOAddressAnswers %d", q, q->qname.c, DNSTypeName(q->qtype), ARDisplayString(m, rr),
4160                 q->LOAddressAnswers);
4161         return;
4162     }
4163 
4164     if (QuerySuppressed(q))
4165     {
4166         // If the query is suppressed, then we don't want to answer from the cache. But if this query is
4167         // supposed to time out, we still want to callback the clients. We do this only for TimeoutQuestions
4168         // that are timing out, which we know are answered with negative cache record when timing out.
4169         if (!q->TimeoutQuestion || rr->resrec.RecordType != kDNSRecordTypePacketNegative || (m->timenow - q->StopTime < 0))
4170             return;
4171     }
4172 
4173     //  Set the record to immortal if appropriate
4174     if (AddRecord == QC_add && Question_uDNS(q) && rr->resrec.RecordType != kDNSRecordTypePacketNegative &&
4175         q->allowExpired != AllowExpired_None && rr->resrec.mortality == Mortality_Mortal ) rr->resrec.mortality = Mortality_Immortal; // Update a non-expired cache record to immortal if appropriate
4176 
4177 #if AWD_METRICS
4178     if ((AddRecord == QC_add) && Question_uDNS(q) && !followcname)
4179     {
4180         const domainname *  queryName;
4181         mDNSu32             responseLatencyMs;
4182         mDNSBool            isForCellular;
4183 
4184         queryName = q->metrics.originalQName ? q->metrics.originalQName : &q->qname;
4185         isForCellular = (q->qDNSServer && q->qDNSServer->cellIntf);
4186         if (!q->metrics.answered)
4187         {
4188             if (q->metrics.querySendCount > 0)
4189             {
4190                 responseLatencyMs = ((m->timenow - q->metrics.firstQueryTime) * 1000) / mDNSPlatformOneSecond;
4191             }
4192             else
4193             {
4194                 responseLatencyMs = 0;
4195             }
4196 
4197             MetricsUpdateDNSQueryStats(queryName, q->qtype, &rr->resrec, q->metrics.querySendCount, q->metrics.expiredAnswerState, responseLatencyMs, isForCellular);
4198             q->metrics.answered = mDNStrue;
4199         }
4200         if (q->metrics.querySendCount > 0)
4201         {
4202             MetricsUpdateDNSResolveStats(queryName, &rr->resrec, isForCellular);
4203         }
4204     }
4205 #endif
4206     // Note: Use caution here. In the case of records with rr->DelayDelivery set, AnswerCurrentQuestionWithResourceRecord(... mDNStrue)
4207     // may be called twice, once when the record is received, and again when it's time to notify local clients.
4208     // If any counters or similar are added here, care must be taken to ensure that they are not double-incremented by this.
4209 
4210     if (AddRecord == QC_add && !q->DuplicateOf && rr->CRActiveQuestion != q && rr->resrec.mortality != Mortality_Ghost)
4211     {
4212         if (!rr->CRActiveQuestion) m->rrcache_active++; // If not previously active, increment rrcache_active count
4213         debugf("AnswerCurrentQuestionWithResourceRecord: Updating CRActiveQuestion from %p to %p for cache record %s, CurrentAnswer %d",
4214                rr->CRActiveQuestion, q, CRDisplayString(m,rr), q->CurrentAnswers);
4215         rr->CRActiveQuestion = q;                       // We know q is non-null
4216         SetNextCacheCheckTimeForRecord(m, rr);
4217     }
4218 
4219     // If this is:
4220     // (a) a no-cache add, where we've already done at least one 'QM' query, or
4221     // (b) a normal add, where we have at least one unique-type answer,
4222     // then there's no need to keep polling the network.
4223     // (If we have an answer in the cache, then we'll automatically ask again in time to stop it expiring.)
4224     // We do this for mDNS questions and uDNS one-shot questions, but not for
4225     // uDNS LongLived questions, because that would mess up our LLQ lease renewal timing.
4226     if ((AddRecord == QC_addnocache && !q->RequestUnicast) ||
4227         (AddRecord == QC_add && (q->ExpectUnique || (rr->resrec.RecordType & kDNSRecordTypePacketUniqueMask))))
4228         if (ActiveQuestion(q) && (mDNSOpaque16IsZero(q->TargetQID) || !q->LongLived))
4229         {
4230             ResetQuestionState(m, q);
4231         }
4232 
4233     if (rr->DelayDelivery) return;      // We'll come back later when CacheRecordDeferredAdd() calls us
4234 
4235 #if USE_DNS64
4236     // If DNS64StateMachine() returns true, then the question was restarted as a different question, so return.
4237     if (!mDNSOpaque16IsZero(q->TargetQID) && DNS64StateMachine(m, q, &rr->resrec, AddRecord)) return;
4238 #endif
4239 
4240 #ifdef USE_LIBIDN
4241     if (rr->resrec.RecordType == kDNSRecordTypePacketNegative)  // If negative answer, check if we need to try Punycode conversion
4242     {
4243         domainname newname;
4244         if (PerformNextPunycodeConversion(q, &newname))         // Itertative Punycode conversion succeeded, so reissue question with new name
4245         {
4246             UDPSocket *const sock = q->LocalSocket;             // Save old socket and transaction ID
4247             const mDNSOpaque16 id = q->TargetQID;
4248             q->LocalSocket = mDNSNULL;
4249             mDNS_StopQuery_internal(m, q);                      // Stop old query
4250             AssignDomainName(&q->qname, &newname);              // Update qname
4251             q->qnamehash = DomainNameHashValue(&q->qname);      // and namehash
4252             mDNS_StartQuery_internal(m, q);                     // Start new query
4253 
4254             if (sock)                                           // Transplant saved socket, if appropriate
4255             {
4256                 if (q->DuplicateOf) mDNSPlatformUDPClose(sock);
4257                 else { q->LocalSocket = sock; q->TargetQID = id; }
4258             }
4259             return;                                             // All done for now; wait until we get the next answer
4260         }
4261     }
4262 #endif // USE_LIBIDN
4263 
4264     // Only deliver negative answers if client has explicitly requested them except when we are forcing a negative response
4265     // for the purpose of retrying search domains/timeout OR the question is suppressed
4266     if (rr->resrec.RecordType == kDNSRecordTypePacketNegative || (q->qtype != kDNSType_NSEC && RRAssertsNonexistence(&rr->resrec, q->qtype)))
4267         if (!AddRecord || (AddRecord != QC_suppressed && AddRecord != QC_forceresponse && !q->ReturnIntermed)) return;
4268 
4269     // For CNAME results to non-CNAME questions, only inform the client if they explicitly requested that
4270     if (q->QuestionCallback && !q->NoAnswer && (!followcname || q->ReturnIntermed))
4271     {
4272         mDNS_DropLockBeforeCallback();      // Allow client (and us) to legally make mDNS API calls
4273         if (q->qtype != kDNSType_NSEC && RRAssertsNonexistence(&rr->resrec, q->qtype))
4274         {
4275             CacheRecord neg;
4276             MakeNegativeCacheRecord(m, &neg, &q->qname, q->qnamehash, q->qtype, q->qclass, 1, rr->resrec.InterfaceID, q->qDNSServer);
4277             q->QuestionCallback(m, q, &neg.resrec, AddRecord);
4278         }
4279         else
4280         {
4281 #if USE_DNS64
4282             if (DNS64ShouldAnswerQuestion(q, &rr->resrec))
4283             {
4284                 DNS64AnswerQuestion(m, q, &rr->resrec, AddRecord);
4285             }
4286             else
4287 #endif
4288             {
4289                 q->QuestionCallback(m, q, &rr->resrec, AddRecord);
4290             }
4291         }
4292         mDNS_ReclaimLockAfterCallback();    // Decrement mDNS_reentrancy to block mDNS API calls again
4293     }
4294     // If this is an "Add" operation and this question needs validation, validate the response.
4295     // In the case of negative responses, extra care should be taken. Negative cache records are
4296     // used for many purposes. For example,
4297     //
4298     // 1) Suppressing questions (SuppressUnusable)
4299     // 2) Timeout questions
4300     // 3) The name does not exist
4301     // 4) No DNS servers are available and we need a quick response for the application
4302     //
4303     // (1) and (2) are handled by "QC_add" check as AddRecord would be "QC_forceresponse" or "QC_suppressed"
4304     // in that case. For (3), it is possible that we don't get nsecs back but we still need to call
4305     // VerifySignature so that we can deliver the appropriate DNSSEC result. There is no point in verifying
4306     // signature for (4) and hence the explicit check for q->qDNSServer.
4307     //
4308     if (m->CurrentQuestion == q && (AddRecord == QC_add) && !q->ValidatingResponse && q->ValidationRequired &&
4309         q->ValidationState == DNSSECValRequired && q->qDNSServer)
4310     {
4311         q->ValidationState = DNSSECValInProgress;
4312         // Treat it as callback call as that's what dnssec code expects
4313         mDNS_DropLockBeforeCallback();      // Allow client (and us) to legally make mDNS API calls
4314         VerifySignature(m, mDNSNULL, q);
4315         mDNS_ReclaimLockAfterCallback();    // Decrement mDNS_reentrancy to block mDNS API calls again
4316         return;
4317     }
4318 
4319     if ((m->CurrentQuestion == q) && !ValidatingQuestion(q))
4320     {
4321         // If we get a CNAME back while we are validating the response (i.e., CNAME for DS, DNSKEY, RRSIG),
4322         // don't follow them. If it is a ValidationRequired question, wait for the CNAME to be validated
4323         // first before following it
4324         if (followcname)  AnswerQuestionByFollowingCNAME(m, q, &rr->resrec);
4325 
4326         // If we are returning expired RRs, then remember the first expired qname we we can start the query again
4327         if (rr->resrec.mortality == Mortality_Ghost && !q->firstExpiredQname.c[0] && (q->allowExpired == AllowExpired_AllowExpiredAnswers) && rr->resrec.RecordType != kDNSRecordTypePacketNegative)
4328         {
4329             debugf("AnswerCurrentQuestionWithResourceRecord: Keeping track of domain for expired RR %s for question %p", CRDisplayString(m,rr), q);
4330             // Note: question->qname is already changed at this point if following a CNAME
4331             AssignDomainName(&q->firstExpiredQname, rr->resrec.name);           // Update firstExpiredQname
4332         }
4333     }
4334 }
4335 
4336 mDNSlocal void CacheRecordDeferredAdd(mDNS *const m, CacheRecord *rr)
4337 {
4338     rr->DelayDelivery = 0;
4339     if (m->CurrentQuestion)
4340         LogMsg("CacheRecordDeferredAdd ERROR m->CurrentQuestion already set: %##s (%s)",
4341                m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
4342     m->CurrentQuestion = m->Questions;
4343     while (m->CurrentQuestion && m->CurrentQuestion != m->NewQuestions)
4344     {
4345         DNSQuestion *q = m->CurrentQuestion;
4346         if (ResourceRecordAnswersQuestion(&rr->resrec, q))
4347             AnswerCurrentQuestionWithResourceRecord(m, rr, QC_add);
4348         if (m->CurrentQuestion == q)    // If m->CurrentQuestion was not auto-advanced, do it ourselves now
4349             m->CurrentQuestion = q->next;
4350     }
4351     m->CurrentQuestion = mDNSNULL;
4352 }
4353 
4354 mDNSlocal mDNSs32 CheckForSoonToExpireRecords(mDNS *const m, const domainname *const name, const mDNSu32 namehash)
4355 {
4356     const mDNSs32 threshold = m->timenow + mDNSPlatformOneSecond;  // See if there are any records expiring within one second
4357     const mDNSs32 start      = m->timenow - 0x10000000;
4358     mDNSs32 delay = start;
4359     CacheGroup *cg = CacheGroupForName(m, namehash, name);
4360     const CacheRecord *rr;
4361 
4362     for (rr = cg ? cg->members : mDNSNULL; rr; rr=rr->next)
4363     {
4364         if (threshold - RRExpireTime(rr) >= 0)     // If we have records about to expire within a second
4365         {
4366             if (delay - RRExpireTime(rr) < 0)       // then delay until after they've been deleted
4367                 delay = RRExpireTime(rr);
4368         }
4369     }
4370     if (delay - start > 0)
4371         return(NonZeroTime(delay));
4372     else
4373         return(0);
4374 }
4375 
4376 // CacheRecordAdd is only called from CreateNewCacheEntry, *never* directly as a result of a client API call.
4377 // If new questions are created as a result of invoking client callbacks, they will be added to
4378 // the end of the question list, and m->NewQuestions will be set to indicate the first new question.
4379 // rr is a new CacheRecord just received into our cache
4380 // (kDNSRecordTypePacketAns/PacketAnsUnique/PacketAdd/PacketAddUnique).
4381 // Note: CacheRecordAdd calls AnswerCurrentQuestionWithResourceRecord which can call a user callback,
4382 // which may change the record list and/or question list.
4383 // Any code walking either list must use the CurrentQuestion and/or CurrentRecord mechanism to protect against this.
4384 mDNSlocal void CacheRecordAdd(mDNS *const m, CacheRecord *rr)
4385 {
4386     DNSQuestion *q;
4387 
4388     // We stop when we get to NewQuestions -- if we increment their CurrentAnswers/LargeAnswers/UniqueAnswers
4389     // counters here we'll end up double-incrementing them when we do it again in AnswerNewQuestion().
4390     for (q = m->Questions; q && q != m->NewQuestions; q=q->next)
4391     {
4392         if (ResourceRecordAnswersQuestion(&rr->resrec, q))
4393         {
4394 	    mDNSIPPort zp = zeroIPPort;
4395             // If this question is one that's actively sending queries, and it's received ten answers within one
4396             // second of sending the last query packet, then that indicates some radical network topology change,
4397             // so reset its exponential backoff back to the start. We must be at least at the eight-second interval
4398             // to do this. If we're at the four-second interval, or less, there's not much benefit accelerating
4399             // because we will anyway send another query within a few seconds. The first reset query is sent out
4400             // randomized over the next four seconds to reduce possible synchronization between machines.
4401             if (q->LastAnswerPktNum != m->PktNum)
4402             {
4403                 q->LastAnswerPktNum = m->PktNum;
4404                 if (mDNSOpaque16IsZero(q->TargetQID) && ActiveQuestion(q) && ++q->RecentAnswerPkts >= 10 &&
4405                     q->ThisQInterval > InitialQuestionInterval * QuestionIntervalStep3 && m->timenow - q->LastQTxTime < mDNSPlatformOneSecond)
4406                 {
4407                     LogMsg("CacheRecordAdd: %##s (%s) got immediate answer burst (%d); restarting exponential backoff sequence (%d)",
4408                            q->qname.c, DNSTypeName(q->qtype), q->RecentAnswerPkts, q->ThisQInterval);
4409                     q->LastQTime      = m->timenow - InitialQuestionInterval + (mDNSs32)mDNSRandom((mDNSu32)mDNSPlatformOneSecond*4);
4410                     q->ThisQInterval  = InitialQuestionInterval;
4411                     SetNextQueryTime(m,q);
4412                 }
4413             }
4414             verbosedebugf("CacheRecordAdd %p %##s (%s) %lu %#a:%d question %p", rr, rr->resrec.name->c,
4415                           DNSTypeName(rr->resrec.rrtype), rr->resrec.rroriginalttl, rr->resrec.rDNSServer ?
4416                           &rr->resrec.rDNSServer->addr : mDNSNULL, mDNSVal16(rr->resrec.rDNSServer ?
4417                                                                              rr->resrec.rDNSServer->port : zp), q);
4418             q->CurrentAnswers++;
4419 
4420             q->unansweredQueries = 0;
4421             if (rr->resrec.rdlength > SmallRecordLimit) q->LargeAnswers++;
4422             if (rr->resrec.RecordType & kDNSRecordTypePacketUniqueMask) q->UniqueAnswers++;
4423             if (q->CurrentAnswers > 4000)
4424             {
4425                 static int msgcount = 0;
4426                 if (msgcount++ < 10)
4427                     LogMsg("CacheRecordAdd: %##s (%s) has %d answers; shedding records to resist DOS attack",
4428                            q->qname.c, DNSTypeName(q->qtype), q->CurrentAnswers);
4429                 rr->resrec.rroriginalttl = 0;
4430                 rr->UnansweredQueries = MaxUnansweredQueries;
4431             }
4432         }
4433     }
4434 
4435     if (!rr->DelayDelivery)
4436     {
4437         if (m->CurrentQuestion)
4438             LogMsg("CacheRecordAdd ERROR m->CurrentQuestion already set: %##s (%s)", m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
4439         m->CurrentQuestion = m->Questions;
4440         while (m->CurrentQuestion && m->CurrentQuestion != m->NewQuestions)
4441         {
4442             q = m->CurrentQuestion;
4443             if (ResourceRecordAnswersQuestion(&rr->resrec, q))
4444                 AnswerCurrentQuestionWithResourceRecord(m, rr, QC_add);
4445             if (m->CurrentQuestion == q)    // If m->CurrentQuestion was not auto-advanced, do it ourselves now
4446                 m->CurrentQuestion = q->next;
4447         }
4448         m->CurrentQuestion = mDNSNULL;
4449     }
4450 
4451     SetNextCacheCheckTimeForRecord(m, rr);
4452 }
4453 
4454 // NoCacheAnswer is only called from mDNSCoreReceiveResponse, *never* directly as a result of a client API call.
4455 // If new questions are created as a result of invoking client callbacks, they will be added to
4456 // the end of the question list, and m->NewQuestions will be set to indicate the first new question.
4457 // rr is a new CacheRecord just received from the wire (kDNSRecordTypePacketAns/AnsUnique/Add/AddUnique)
4458 // but we don't have any place to cache it. We'll deliver question 'add' events now, but we won't have any
4459 // way to deliver 'remove' events in future, nor will we be able to include this in known-answer lists,
4460 // so we immediately bump ThisQInterval up to MaxQuestionInterval to avoid pounding the network.
4461 // Note: NoCacheAnswer calls AnswerCurrentQuestionWithResourceRecord which can call a user callback,
4462 // which may change the record list and/or question list.
4463 // Any code walking either list must use the CurrentQuestion and/or CurrentRecord mechanism to protect against this.
4464 mDNSlocal void NoCacheAnswer(mDNS *const m, CacheRecord *rr)
4465 {
4466     LogMsg("No cache space: Delivering non-cached result for %##s", m->rec.r.resrec.name->c);
4467     if (m->CurrentQuestion)
4468         LogMsg("NoCacheAnswer ERROR m->CurrentQuestion already set: %##s (%s)", m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
4469     m->CurrentQuestion = m->Questions;
4470     // We do this for *all* questions, not stopping when we get to m->NewQuestions,
4471     // since we're not caching the record and we'll get no opportunity to do this later
4472     while (m->CurrentQuestion)
4473     {
4474         DNSQuestion *q = m->CurrentQuestion;
4475         if (ResourceRecordAnswersQuestion(&rr->resrec, q))
4476             AnswerCurrentQuestionWithResourceRecord(m, rr, QC_addnocache);  // QC_addnocache means "don't expect remove events for this"
4477         if (m->CurrentQuestion == q)    // If m->CurrentQuestion was not auto-advanced, do it ourselves now
4478             m->CurrentQuestion = q->next;
4479     }
4480     m->CurrentQuestion = mDNSNULL;
4481 }
4482 
4483 // CacheRecordRmv is only called from CheckCacheExpiration, which is called from mDNS_Execute.
4484 // Note that CacheRecordRmv is *only* called for records that are referenced by at least one active question.
4485 // If new questions are created as a result of invoking client callbacks, they will be added to
4486 // the end of the question list, and m->NewQuestions will be set to indicate the first new question.
4487 // rr is an existing cache CacheRecord that just expired and is being deleted
4488 // (kDNSRecordTypePacketAns/PacketAnsUnique/PacketAdd/PacketAddUnique).
4489 // Note: CacheRecordRmv calls AnswerCurrentQuestionWithResourceRecord which can call a user callback,
4490 // which may change the record list and/or question list.
4491 // Any code walking either list must use the CurrentQuestion and/or CurrentRecord mechanism to protect against this.
4492 mDNSlocal void CacheRecordRmv(mDNS *const m, CacheRecord *rr)
4493 {
4494     if (m->CurrentQuestion)
4495         LogMsg("CacheRecordRmv ERROR m->CurrentQuestion already set: %##s (%s)",
4496                m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
4497     m->CurrentQuestion = m->Questions;
4498 
4499     // We stop when we get to NewQuestions -- for new questions their CurrentAnswers/LargeAnswers/UniqueAnswers counters
4500     // will all still be zero because we haven't yet gone through the cache counting how many answers we have for them.
4501     while (m->CurrentQuestion && m->CurrentQuestion != m->NewQuestions)
4502     {
4503         DNSQuestion *q = m->CurrentQuestion;
4504         // When a question enters suppressed state, we generate RMV events and generate a negative
4505         // response. A cache may be present that answers this question e.g., cache entry generated
4506         // before the question became suppressed. We need to skip the suppressed questions here as
4507         // the RMV event has already been generated.
4508         if (!QuerySuppressed(q) && ResourceRecordAnswersQuestion(&rr->resrec, q) &&
4509             (q->allowExpired == AllowExpired_None || rr->resrec.mortality == Mortality_Mortal))
4510         {
4511             verbosedebugf("CacheRecordRmv %p %s", rr, CRDisplayString(m, rr));
4512             q->FlappingInterface1 = mDNSNULL;
4513             q->FlappingInterface2 = mDNSNULL;
4514 
4515             if (q->CurrentAnswers == 0) {
4516 		mDNSIPPort zp = zeroIPPort;
4517                 LogMsg("CacheRecordRmv ERROR!!: How can CurrentAnswers already be zero for %p %##s (%s) DNSServer %#a:%d",
4518                        q, q->qname.c, DNSTypeName(q->qtype), q->qDNSServer ? &q->qDNSServer->addr : mDNSNULL,
4519                        mDNSVal16(q->qDNSServer ? q->qDNSServer->port : zp));
4520 	    }
4521             else
4522             {
4523                 q->CurrentAnswers--;
4524                 if (rr->resrec.rdlength > SmallRecordLimit) q->LargeAnswers--;
4525                 if (rr->resrec.RecordType & kDNSRecordTypePacketUniqueMask) q->UniqueAnswers--;
4526             }
4527 
4528             // If we have dropped below the answer threshold for this mDNS question,
4529             // restart the queries at InitialQuestionInterval.
4530             if (mDNSOpaque16IsZero(q->TargetQID) && (q->BrowseThreshold > 0) && (q->CurrentAnswers < q->BrowseThreshold))
4531             {
4532                 q->ThisQInterval = InitialQuestionInterval;
4533                 q->LastQTime     = m->timenow - q->ThisQInterval;
4534                 SetNextQueryTime(m,q);
4535                 LogInfo("CacheRecordRmv: (%s) %##s dropped below threshold of %d answers",
4536                     DNSTypeName(q->qtype), q->qname.c, q->BrowseThreshold);
4537             }
4538             if (rr->resrec.rdata->MaxRDLength) // Never generate "remove" events for negative results
4539             {
4540                 if ((q->CurrentAnswers == 0) && mDNSOpaque16IsZero(q->TargetQID))
4541                 {
4542                     LogInfo("CacheRecordRmv: Last answer for %##s (%s) expired from cache; will reconfirm antecedents",
4543                             q->qname.c, DNSTypeName(q->qtype));
4544                     ReconfirmAntecedents(m, &q->qname, q->qnamehash, rr->resrec.InterfaceID, 0);
4545                 }
4546                 AnswerCurrentQuestionWithResourceRecord(m, rr, QC_rmv);
4547             }
4548         }
4549         if (m->CurrentQuestion == q)    // If m->CurrentQuestion was not auto-advanced, do it ourselves now
4550             m->CurrentQuestion = q->next;
4551     }
4552     m->CurrentQuestion = mDNSNULL;
4553 }
4554 
4555 mDNSlocal void ReleaseCacheEntity(mDNS *const m, CacheEntity *e)
4556 {
4557 #if APPLE_OSX_mDNSResponder && MACOSX_MDNS_MALLOC_DEBUGGING >= 1
4558     unsigned int i;
4559     for (i=0; i<sizeof(*e); i++) ((char*)e)[i] = 0xFF;
4560 #endif
4561     e->next = m->rrcache_free;
4562     m->rrcache_free = e;
4563     m->rrcache_totalused--;
4564 }
4565 
4566 mDNSlocal void ReleaseCacheGroup(mDNS *const m, CacheGroup **cp)
4567 {
4568     CacheEntity *e = (CacheEntity *)(*cp);
4569     //LogMsg("ReleaseCacheGroup:  Releasing CacheGroup for %p, %##s", (*cp)->name->c, (*cp)->name->c);
4570     if ((*cp)->rrcache_tail != &(*cp)->members)
4571         LogMsg("ERROR: (*cp)->members == mDNSNULL but (*cp)->rrcache_tail != &(*cp)->members)");
4572     //if ((*cp)->name != (domainname*)((*cp)->namestorage))
4573     //  LogMsg("ReleaseCacheGroup: %##s, %p %p", (*cp)->name->c, (*cp)->name, (domainname*)((*cp)->namestorage));
4574     if ((*cp)->name != (domainname*)((*cp)->namestorage)) mDNSPlatformMemFree((*cp)->name);
4575     (*cp)->name = mDNSNULL;
4576     *cp = (*cp)->next;          // Cut record from list
4577     ReleaseCacheEntity(m, e);
4578 }
4579 
4580 mDNSlocal void ReleaseAdditionalCacheRecords(mDNS *const m, CacheRecord **rp)
4581 {
4582     while (*rp)
4583     {
4584         CacheRecord *rr = *rp;
4585         *rp = (*rp)->next;          // Cut record from list
4586         if (rr->resrec.rdata && rr->resrec.rdata != (RData*)&rr->smallrdatastorage)
4587         {
4588             mDNSPlatformMemFree(rr->resrec.rdata);
4589             rr->resrec.rdata = mDNSNULL;
4590         }
4591         // NSEC or SOA records that are not added to the CacheGroup do not share the name
4592         // of the CacheGroup.
4593         if (rr->resrec.name)
4594         {
4595             debugf("ReleaseAdditionalCacheRecords: freeing cached record %##s (%s)", rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype));
4596             mDNSPlatformMemFree((void *)rr->resrec.name);
4597             rr->resrec.name = mDNSNULL;
4598         }
4599         // Don't count the NSEC3 records used by anonymous browse/reg
4600         if (!rr->resrec.InterfaceID)
4601         {
4602             m->rrcache_totalused_unicast -= rr->resrec.rdlength;
4603             if (DNSSECRecordType(rr->resrec.rrtype))
4604                 BumpDNSSECStats(m, kStatsActionDecrement, kStatsTypeMemoryUsage, rr->resrec.rdlength);
4605         }
4606         ReleaseCacheEntity(m, (CacheEntity *)rr);
4607     }
4608 }
4609 
4610 mDNSexport void ReleaseCacheRecord(mDNS *const m, CacheRecord *r)
4611 {
4612     CacheGroup *cg;
4613 
4614     //LogMsg("ReleaseCacheRecord: Releasing %s", CRDisplayString(m, r));
4615     if (r->resrec.rdata && r->resrec.rdata != (RData*)&r->smallrdatastorage) mDNSPlatformMemFree(r->resrec.rdata);
4616     r->resrec.rdata = mDNSNULL;
4617 
4618     cg = CacheGroupForRecord(m, &r->resrec);
4619 
4620     if (!cg)
4621     {
4622         // It is okay to have this printed for NSEC/NSEC3s
4623         LogInfo("ReleaseCacheRecord: ERROR!! cg NULL for %##s (%s)", r->resrec.name->c, DNSTypeName(r->resrec.rrtype));
4624     }
4625     // When NSEC records are not added to the cache, it is usually cached at the "nsec" list
4626     // of the CacheRecord. But sometimes they may be freed without adding to the "nsec" list
4627     // (which is handled below) and in that case it should be freed here.
4628     if (r->resrec.name && cg && r->resrec.name != cg->name)
4629     {
4630         debugf("ReleaseCacheRecord: freeing %##s (%s)", r->resrec.name->c, DNSTypeName(r->resrec.rrtype));
4631         mDNSPlatformMemFree((void *)r->resrec.name);
4632     }
4633     r->resrec.name = mDNSNULL;
4634 
4635     if (r->resrec.AnonInfo)
4636     {
4637         debugf("ReleaseCacheRecord: freeing AnonInfo for %##s (%s)", r->resrec.name->c, DNSTypeName(r->resrec.rrtype));
4638         FreeAnonInfo((void *)r->resrec.AnonInfo);
4639     }
4640     r->resrec.AnonInfo = mDNSNULL;
4641 
4642     if (!r->resrec.InterfaceID)
4643     {
4644         m->rrcache_totalused_unicast -= r->resrec.rdlength;
4645         if (DNSSECRecordType(r->resrec.rrtype))
4646             BumpDNSSECStats(m, kStatsActionDecrement, kStatsTypeMemoryUsage, r->resrec.rdlength);
4647     }
4648 
4649     ReleaseAdditionalCacheRecords(m, &r->nsec);
4650     ReleaseAdditionalCacheRecords(m, &r->soa);
4651 
4652     ReleaseCacheEntity(m, (CacheEntity *)r);
4653 }
4654 
4655 // Note: We want to be careful that we deliver all the CacheRecordRmv calls before delivering
4656 // CacheRecordDeferredAdd calls. The in-order nature of the cache lists ensures that all
4657 // callbacks for old records are delivered before callbacks for newer records.
4658 mDNSlocal void CheckCacheExpiration(mDNS *const m, const mDNSu32 slot, CacheGroup *const cg)
4659 {
4660     CacheRecord **rp = &cg->members;
4661 
4662     if (m->lock_rrcache) { LogMsg("CheckCacheExpiration ERROR! Cache already locked!"); return; }
4663     m->lock_rrcache = 1;
4664 
4665     while (*rp)
4666     {
4667         CacheRecord *const rr = *rp;
4668         mDNSBool recordReleased = mDNSfalse;
4669         mDNSs32 event = RRExpireTime(rr);
4670         if (m->timenow - event >= 0)    // If expired, delete it
4671         {
4672             if (rr->CRActiveQuestion)   // If this record has one or more active questions, tell them it's going away
4673             {
4674                 DNSQuestion *q = rr->CRActiveQuestion;
4675                 verbosedebugf("CheckCacheExpiration: Removing%7d %7d %p %s",
4676                               m->timenow - rr->TimeRcvd, rr->resrec.rroriginalttl, rr->CRActiveQuestion, CRDisplayString(m, rr));
4677                 // When a cache record is about to expire, we expect to do four queries at 80-82%, 85-87%, 90-92% and
4678                 // then 95-97% of the TTL. If the DNS server does not respond, then we will remove the cache entry
4679                 // before we pick a new DNS server. As the question interval is set to MaxQuestionInterval, we may
4680                 // not send out a query anytime soon. Hence, we need to reset the question interval. If this is
4681                 // a normal deferred ADD case, then AnswerCurrentQuestionWithResourceRecord will reset it to
4682                 // MaxQuestionInterval. If we have inactive questions referring to negative cache entries,
4683                 // don't ressurect them as they will deliver duplicate "No such Record" ADD events
4684                 if (!mDNSOpaque16IsZero(q->TargetQID) && !q->LongLived && ActiveQuestion(q))
4685                 {
4686                     q->ThisQInterval = InitialQuestionInterval;
4687                     q->LastQTime     = m->timenow - q->ThisQInterval;
4688                     SetNextQueryTime(m, q);
4689                 }
4690                 CacheRecordRmv(m, rr);
4691                 m->rrcache_active--;
4692             }
4693 
4694             event += MAX_GHOST_TIME;                                                    // Adjust so we can check for a ghost expiration
4695             if (rr->resrec.mortality == Mortality_Mortal ||                             // Normal expired mortal record that needs released
4696                 (rr->resrec.mortality == Mortality_Ghost && m->timenow - event >= 0))   // A ghost record that expired more than MAX_GHOST_TIME ago
4697             {   //  Release as normal
4698                 *rp = rr->next;                                     // Cut it from the list before ReleaseCacheRecord
4699                 verbosedebugf("CheckCacheExpiration: Deleting (%s)%7d %7d %p %s",
4700                               MortalityDisplayString(rr->resrec.mortality),
4701                               m->timenow - rr->TimeRcvd, rr->resrec.rroriginalttl, rr->CRActiveQuestion, CRDisplayString(m, rr));
4702                 ReleaseCacheRecord(m, rr);
4703                 recordReleased = mDNStrue;
4704             }
4705             else                                                    // An immortal record needs to become a ghost when it expires
4706             {   // Don't release this entry
4707                 if (rr->resrec.mortality == Mortality_Immortal)
4708                 {
4709                     rr->resrec.mortality = Mortality_Ghost;         // Expired immortal records become ghosts
4710                     verbosedebugf("CheckCacheExpiration: NOT Deleting (%s)%7d %7d %p %s",
4711                                   MortalityDisplayString(rr->resrec.mortality),
4712                                   m->timenow - rr->TimeRcvd, rr->resrec.rroriginalttl, rr->CRActiveQuestion, CRDisplayString(m, rr));
4713                 }
4714             }
4715         }
4716         else                                                        // else, not expired; see if we need to query
4717         {
4718             // If waiting to delay delivery, do nothing until then
4719             if (rr->DelayDelivery && rr->DelayDelivery - m->timenow > 0)
4720                 event = rr->DelayDelivery;
4721             else
4722             {
4723                 if (rr->DelayDelivery) CacheRecordDeferredAdd(m, rr);
4724                 if (rr->CRActiveQuestion && rr->UnansweredQueries < MaxUnansweredQueries)
4725                 {
4726                     if (m->timenow - rr->NextRequiredQuery < 0)     // If not yet time for next query
4727                         event = NextCacheCheckEvent(rr);            // then just record when we want the next query
4728                     else                                            // else trigger our question to go out now
4729                     {
4730                         // Set NextScheduledQuery to timenow so that SendQueries() will run.
4731                         // SendQueries() will see that we have records close to expiration, and send FEQs for them.
4732                         m->NextScheduledQuery = m->timenow;
4733                         // After sending the query we'll increment UnansweredQueries and call SetNextCacheCheckTimeForRecord(),
4734                         // which will correctly update m->NextCacheCheck for us.
4735                         event = m->timenow + FutureTime;
4736                     }
4737                 }
4738             }
4739         }
4740 
4741         if (!recordReleased)  //  Schedule if we did not release the record
4742         {
4743             verbosedebugf("CheckCacheExpiration:%6d %5d %s",
4744                           (event - m->timenow) / mDNSPlatformOneSecond, CacheCheckGracePeriod(rr), CRDisplayString(m, rr));
4745             if (m->rrcache_nextcheck[slot] - event > 0)
4746                 m->rrcache_nextcheck[slot] = event;
4747             rp = &rr->next;
4748         }
4749     }
4750     if (cg->rrcache_tail != rp) verbosedebugf("CheckCacheExpiration: Updating CacheGroup tail from %p to %p", cg->rrcache_tail, rp);
4751     cg->rrcache_tail = rp;
4752     m->lock_rrcache = 0;
4753 }
4754 
4755 // "LORecord" includes both LocalOnly and P2P record. This function assumes m->CurrentQuestion is pointing to "q".
4756 //
4757 // If "CheckOnly" is set to "true", the question won't be answered but just check to see if there is an answer and
4758 // returns true if there is an answer.
4759 //
4760 // If "CheckOnly" is set to "false", the question will be answered if there is a LocalOnly/P2P record and
4761 // returns true to indicate the same.
4762 mDNSlocal mDNSBool AnswerQuestionWithLORecord(mDNS *const m, DNSQuestion *q, mDNSBool checkOnly)
4763 {
4764     AuthRecord *lr;
4765     AuthGroup *ag;
4766 
4767     if (m->CurrentRecord)
4768         LogMsg("AnswerQuestionWithLORecord ERROR m->CurrentRecord already set %s", ARDisplayString(m, m->CurrentRecord));
4769 
4770     ag = AuthGroupForName(&m->rrauth, q->qnamehash, &q->qname);
4771     if (ag)
4772     {
4773         m->CurrentRecord = ag->members;
4774         while (m->CurrentRecord && m->CurrentRecord != ag->NewLocalOnlyRecords)
4775         {
4776             AuthRecord *rr = m->CurrentRecord;
4777             m->CurrentRecord = rr->next;
4778             //
4779             // If the question is mDNSInterface_LocalOnly, all records local to the machine should be used
4780             // to answer the query. This is handled in AnswerNewLocalOnlyQuestion.
4781             //
4782             // We handle mDNSInterface_Any and scoped questions here. See LocalOnlyRecordAnswersQuestion for more
4783             // details on how we handle this case. For P2P we just handle "Interface_Any" questions. For LocalOnly
4784             // we handle both mDNSInterface_Any and scoped questions.
4785 
4786             if (rr->ARType == AuthRecordLocalOnly || (rr->ARType == AuthRecordP2P && (q->InterfaceID == mDNSInterface_Any || q->InterfaceID == mDNSInterface_BLE)))
4787                 if (LocalOnlyRecordAnswersQuestion(rr, q))
4788                 {
4789                     if (checkOnly)
4790                     {
4791                         LogInfo("AnswerQuestionWithLORecord: question %##s (%s) answered by %s", q->qname.c, DNSTypeName(q->qtype),
4792                             ARDisplayString(m, rr));
4793                         m->CurrentRecord = mDNSNULL;
4794                         return mDNStrue;
4795                     }
4796                     AnswerLocalQuestionWithLocalAuthRecord(m, rr, QC_add);
4797                     if (m->CurrentQuestion != q)
4798                         break;     // If callback deleted q, then we're finished here
4799                 }
4800         }
4801     }
4802     m->CurrentRecord = mDNSNULL;
4803 
4804     if (m->CurrentQuestion != q)
4805     {
4806         LogInfo("AnswerQuestionWithLORecord: Question deleted while while answering LocalOnly record answers");
4807         return mDNStrue;
4808     }
4809 
4810     if (q->LOAddressAnswers)
4811     {
4812         LogInfo("AnswerQuestionWithLORecord: Question %p %##s (%s) answered using local auth records LOAddressAnswers %d",
4813                 q, q->qname.c, DNSTypeName(q->qtype), q->LOAddressAnswers);
4814         return mDNStrue;
4815     }
4816 
4817     // Before we go check the cache and ship this query on the wire, we have to be sure that there are
4818     // no local records that could possibly answer this question. As we did not check the NewLocalRecords, we
4819     // need to just peek at them to see whether it will answer this question. If it would answer, pretend
4820     // that we answered. AnswerAllLocalQuestionsWithLocalAuthRecord will answer shortly. This happens normally
4821     // when we add new /etc/hosts entries and restart the question. It is a new question and also a new record.
4822     if (ag)
4823     {
4824         lr = ag->NewLocalOnlyRecords;
4825         while (lr)
4826         {
4827             if (UniqueLocalOnlyRecord(lr) && LocalOnlyRecordAnswersQuestion(lr, q))
4828             {
4829                 LogInfo("AnswerQuestionWithLORecord: Question %p %##s (%s) will be answered using new local auth records "
4830                         " LOAddressAnswers %d", q, q->qname.c, DNSTypeName(q->qtype), q->LOAddressAnswers);
4831                 return mDNStrue;
4832             }
4833             lr = lr->next;
4834         }
4835     }
4836     return mDNSfalse;
4837 }
4838 
4839 // Today, we suppress questions (not send them on the wire) for several reasons e.g.,
4840 // AAAA query is suppressed because no IPv6 capability or PID is not allowed to make
4841 // DNS requests. We need to temporarily suspend the suppress status so that we can
4842 // deliver a negative response (AnswerCurrentQuestionWithResourceRecord does not answer
4843 // suppressed questions) and reset it back. In the future, if there are other
4844 // reasons for suppressing the query, this function should be updated.
4845 mDNSlocal void AnswerSuppressedQuestion(mDNS *const m, DNSQuestion *q)
4846 {
4847     mDNSBool SuppressQuery;
4848     mDNSBool DisallowPID;
4849 
4850     // If the client did not set the kDNSServiceFlagsReturnIntermediates flag, then don't generate a negative response, just
4851     // deactivate the DNSQuestion.
4852     if (!q->ReturnIntermed)
4853     {
4854         q->ThisQInterval = 0;
4855         return;
4856     }
4857 
4858     SuppressQuery = q->SuppressQuery;
4859     DisallowPID   = q->DisallowPID;
4860 
4861     // make sure that QuerySuppressed() returns false
4862     q->SuppressQuery = mDNSfalse;
4863     q->DisallowPID   = mDNSfalse;
4864 
4865     GenerateNegativeResponse(m, mDNSInterface_Any, QC_suppressed);
4866 
4867     q->SuppressQuery = SuppressQuery;
4868     q->DisallowPID   = DisallowPID;
4869 }
4870 
4871 mDNSlocal void AnswerNewQuestion(mDNS *const m)
4872 {
4873     mDNSBool ShouldQueryImmediately = mDNStrue;
4874     DNSQuestion *const q = m->NewQuestions;     // Grab the question we're going to answer
4875 #if USE_DNS64
4876     if (!mDNSOpaque16IsZero(q->TargetQID)) DNS64HandleNewQuestion(m, q);
4877 #endif
4878     CacheGroup *const cg = CacheGroupForName(m, q->qnamehash, &q->qname);
4879     mDNSBool AnsweredFromCache = mDNSfalse;
4880 
4881     verbosedebugf("AnswerNewQuestion: Answering %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
4882 
4883     if (cg) CheckCacheExpiration(m, HashSlotFromNameHash(q->qnamehash), cg);
4884     if (m->NewQuestions != q) { LogInfo("AnswerNewQuestion: Question deleted while doing CheckCacheExpiration"); goto exit; }
4885     m->NewQuestions = q->next;
4886     // Advance NewQuestions to the next *after* calling CheckCacheExpiration, because if we advance it first
4887     // then CheckCacheExpiration may give this question add/remove callbacks, and it's not yet ready for that.
4888     //
4889     // Also, CheckCacheExpiration() calls CacheRecordDeferredAdd() and CacheRecordRmv(), which invoke
4890     // client callbacks, which may delete their own or any other question. Our mechanism for detecting
4891     // whether our current m->NewQuestions question got deleted by one of these callbacks is to store the
4892     // value of m->NewQuestions in 'q' before calling CheckCacheExpiration(), and then verify afterwards
4893     // that they're still the same. If m->NewQuestions has changed (because mDNS_StopQuery_internal
4894     // advanced it), that means the question was deleted, so we no longer need to worry about answering
4895     // it (and indeed 'q' is now a dangling pointer, so dereferencing it at all would be bad, and the
4896     // values we computed for slot and cg are now stale and relate to a question that no longer exists).
4897     //
4898     // We can't use the usual m->CurrentQuestion mechanism for this because  CacheRecordDeferredAdd() and
4899     // CacheRecordRmv() both use that themselves when walking the list of (non-new) questions generating callbacks.
4900     // Fortunately mDNS_StopQuery_internal auto-advances both m->CurrentQuestion *AND* m->NewQuestions when
4901     // deleting a question, so luckily we have an easy alternative way of detecting if our question got deleted.
4902 
4903     if (m->lock_rrcache) LogMsg("AnswerNewQuestion ERROR! Cache already locked!");
4904     // This should be safe, because calling the client's question callback may cause the
4905     // question list to be modified, but should not ever cause the rrcache list to be modified.
4906     // If the client's question callback deletes the question, then m->CurrentQuestion will
4907     // be advanced, and we'll exit out of the loop
4908     m->lock_rrcache = 1;
4909     if (m->CurrentQuestion)
4910         LogMsg("AnswerNewQuestion ERROR m->CurrentQuestion already set: %##s (%s)",
4911                m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
4912     m->CurrentQuestion = q;     // Indicate which question we're answering, so we'll know if it gets deleted
4913 
4914     if (q->NoAnswer == NoAnswer_Fail)
4915     {
4916         LogMsg("AnswerNewQuestion: NoAnswer_Fail %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
4917         MakeNegativeCacheRecord(m, &m->rec.r, &q->qname, q->qnamehash, q->qtype, q->qclass, 60, mDNSInterface_Any, q->qDNSServer);
4918         q->NoAnswer = NoAnswer_Normal;      // Temporarily turn off answer suppression
4919         AnswerCurrentQuestionWithResourceRecord(m, &m->rec.r, QC_addnocache);
4920         // Don't touch the question if it has been stopped already
4921         if (m->CurrentQuestion == q) q->NoAnswer = NoAnswer_Fail;       // Restore NoAnswer state
4922         m->rec.r.resrec.RecordType = 0;     // Clear RecordType to show we're not still using it
4923     }
4924 
4925     if (m->CurrentQuestion != q)
4926     {
4927         LogInfo("AnswerNewQuestion: Question deleted while generating NoAnswer_Fail response");
4928         goto exit;
4929     }
4930 
4931     // See if we want to tell it about LocalOnly/P2P records. If we answered them using LocalOnly
4932     // or P2P record, then we are done.
4933     if (AnswerQuestionWithLORecord(m, q, mDNSfalse))
4934         goto exit;
4935 
4936     // If we are not supposed to answer this question, generate a negative response.
4937     // Temporarily suspend the SuppressQuery so that AnswerCurrentQuestionWithResourceRecord can answer the question
4938     //
4939     // If it is a question trying to validate some response, it already checked the cache for a response. If it still
4940     // reissues a question it means it could not find the RRSIGs. So, we need to bypass the cache check and send
4941     // the question out.
4942     if (QuerySuppressed(q))
4943     {
4944         AnswerSuppressedQuestion(m, q);
4945     }
4946     else if (!q->ValidatingResponse)
4947     {
4948         CacheRecord *rr;
4949         for (rr = cg ? cg->members : mDNSNULL; rr; rr=rr->next)
4950             if (SameNameRecordAnswersQuestion(&rr->resrec, q))
4951             {
4952                 // SecsSinceRcvd is whole number of elapsed seconds, rounded down
4953                 mDNSu32 SecsSinceRcvd = ((mDNSu32)(m->timenow - rr->TimeRcvd)) / mDNSPlatformOneSecond;
4954                 if (rr->resrec.rroriginalttl <= SecsSinceRcvd && q->allowExpired != AllowExpired_AllowExpiredAnswers) continue;   // Go to next one in loop
4955 
4956                 // If this record set is marked unique, then that means we can reasonably assume we have the whole set
4957                 // -- we don't need to rush out on the network and query immediately to see if there are more answers out there
4958                 if ((rr->resrec.RecordType & kDNSRecordTypePacketUniqueMask) || (q->ExpectUnique))
4959                     ShouldQueryImmediately = mDNSfalse;
4960                 q->CurrentAnswers++;
4961                 if (rr->resrec.rdlength > SmallRecordLimit) q->LargeAnswers++;
4962                 if (rr->resrec.RecordType & kDNSRecordTypePacketUniqueMask) q->UniqueAnswers++;
4963                 AnsweredFromCache = mDNStrue;
4964 #if AWD_METRICS
4965                 if (q->metrics.expiredAnswerState == ExpiredAnswer_Allowed) q->metrics.expiredAnswerState = ExpiredAnswer_AnsweredWithExpired;
4966 #endif
4967                 AnswerCurrentQuestionWithResourceRecord(m, rr, QC_add);
4968                 if (m->CurrentQuestion != q) break;     // If callback deleted q, then we're finished here
4969             }
4970             else if (mDNSOpaque16IsZero(q->TargetQID) && RRTypeIsAddressType(rr->resrec.rrtype) && RRTypeIsAddressType(q->qtype))
4971                 ShouldQueryImmediately = mDNSfalse;
4972     }
4973     // We don't use LogInfo for this "Question deleted" message because it happens so routinely that
4974     // it's not remotely remarkable, and therefore unlikely to be of much help tracking down bugs.
4975     if (m->CurrentQuestion != q) { debugf("AnswerNewQuestion: Question deleted while giving cache answers"); goto exit; }
4976 
4977     // Neither a local record nor a cache entry could answer this question. If this question need to be retried
4978     // with search domains, generate a negative response which will now retry after appending search domains.
4979     // If the query was suppressed above, we already generated a negative response. When it gets unsuppressed,
4980     // we will retry with search domains.
4981     if (!QuerySuppressed(q) && !AnsweredFromCache && q->RetryWithSearchDomains)
4982     {
4983         LogInfo("AnswerNewQuestion: Generating response for retrying with search domains %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
4984         GenerateNegativeResponse(m, mDNSInterface_Any, QC_forceresponse);
4985     }
4986 
4987     if (m->CurrentQuestion != q) { debugf("AnswerNewQuestion: Question deleted while giving negative answer"); goto exit; }
4988 
4989     if (q->allowExpired == AllowExpired_AllowExpiredAnswers)
4990     {
4991         q->allowExpired = AllowExpired_MakeAnswersImmortal;             // After looking through the cache for an answer, demote to make immortal
4992         if (q->firstExpiredQname.c[0])                                  // If an original query name was saved on an expired answer, start it over in case it is updated
4993         {
4994             LogMsg("AnswerNewQuestion: Restarting original question %p firstExpiredQname %##s for allowExpiredAnswers question", q, &q->firstExpiredQname.c);
4995             mDNS_StopQuery_internal(m, q);                              // Stop old query
4996             AssignDomainName(&q->qname, &q->firstExpiredQname);         // Update qname
4997             q->qnamehash = DomainNameHashValue(&q->qname);              // and namehash
4998             mDNS_StartQuery_internal(m, q);                             // start new query
4999             q->CNAMEReferrals = 0;                                      // Reset referral count
5000             q->firstExpiredQname.c[0] = 0;                              // Erase the domain name
5001         }
5002     }
5003 
5004     // Note: When a query gets suppressed or retried with search domains, we de-activate the question.
5005     // Hence we don't execute the following block of code for those cases.
5006     if (ShouldQueryImmediately && ActiveQuestion(q))
5007     {
5008         debugf("AnswerNewQuestion: ShouldQueryImmediately %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
5009         q->ThisQInterval  = InitialQuestionInterval;
5010         q->LastQTime      = m->timenow - q->ThisQInterval;
5011         if (mDNSOpaque16IsZero(q->TargetQID))       // For mDNS, spread packets to avoid a burst of simultaneous queries
5012         {
5013             // Compute random delay in the range 1-6 seconds, then divide by 50 to get 20-120ms
5014             if (!m->RandomQueryDelay)
5015                 m->RandomQueryDelay = (mDNSPlatformOneSecond + mDNSRandom(mDNSPlatformOneSecond*5) - 1) / 50 + 1;
5016             q->LastQTime += m->RandomQueryDelay;
5017         }
5018     }
5019 
5020     // IN ALL CASES make sure that m->NextScheduledQuery is set appropriately.
5021     // In cases where m->NewQuestions->DelayAnswering is set, we may have delayed generating our
5022     // answers for this question until *after* its scheduled transmission time, in which case
5023     // m->NextScheduledQuery may now be set to 'never', and in that case -- even though we're *not* doing
5024     // ShouldQueryImmediately -- we still need to make sure we set m->NextScheduledQuery correctly.
5025     SetNextQueryTime(m,q);
5026 
5027 exit:
5028     m->CurrentQuestion = mDNSNULL;
5029     m->lock_rrcache = 0;
5030 }
5031 
5032 // When a NewLocalOnlyQuestion is created, AnswerNewLocalOnlyQuestion runs though our ResourceRecords delivering any
5033 // appropriate answers, stopping if it reaches a NewLocalOnlyRecord -- these will be handled by AnswerAllLocalQuestionsWithLocalAuthRecord
5034 mDNSlocal void AnswerNewLocalOnlyQuestion(mDNS *const m)
5035 {
5036     AuthGroup *ag;
5037     DNSQuestion *q = m->NewLocalOnlyQuestions;      // Grab the question we're going to answer
5038     mDNSBool retEv = mDNSfalse;
5039     m->NewLocalOnlyQuestions = q->next;             // Advance NewLocalOnlyQuestions to the next (if any)
5040 
5041     debugf("AnswerNewLocalOnlyQuestion: Answering %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
5042 
5043     if (m->CurrentQuestion)
5044         LogMsg("AnswerNewLocalOnlyQuestion ERROR m->CurrentQuestion already set: %##s (%s)",
5045                m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
5046     m->CurrentQuestion = q;     // Indicate which question we're answering, so we'll know if it gets deleted
5047 
5048     if (m->CurrentRecord)
5049         LogMsg("AnswerNewLocalOnlyQuestion ERROR m->CurrentRecord already set %s", ARDisplayString(m, m->CurrentRecord));
5050 
5051     // 1. First walk the LocalOnly records answering the LocalOnly question
5052     // 2. As LocalOnly questions should also be answered by any other Auth records local to the machine,
5053     //    walk the ResourceRecords list delivering the answers
5054     ag = AuthGroupForName(&m->rrauth, q->qnamehash, &q->qname);
5055     if (ag)
5056     {
5057         m->CurrentRecord = ag->members;
5058         while (m->CurrentRecord && m->CurrentRecord != ag->NewLocalOnlyRecords)
5059         {
5060             AuthRecord *rr = m->CurrentRecord;
5061             m->CurrentRecord = rr->next;
5062             if (LocalOnlyRecordAnswersQuestion(rr, q))
5063             {
5064                 retEv = mDNStrue;
5065                 AnswerLocalQuestionWithLocalAuthRecord(m, rr, mDNStrue);
5066                 if (m->CurrentQuestion != q) break;     // If callback deleted q, then we're finished here
5067             }
5068         }
5069     }
5070 
5071     if (m->CurrentQuestion == q)
5072     {
5073         m->CurrentRecord = m->ResourceRecords;
5074 
5075         while (m->CurrentRecord && m->CurrentRecord != m->NewLocalRecords)
5076         {
5077             AuthRecord *rr = m->CurrentRecord;
5078             m->CurrentRecord = rr->next;
5079             if (ResourceRecordAnswersQuestion(&rr->resrec, q))
5080             {
5081                 retEv = mDNStrue;
5082                 AnswerLocalQuestionWithLocalAuthRecord(m, rr, mDNStrue);
5083                 if (m->CurrentQuestion != q) break;     // If callback deleted q, then we're finished here
5084             }
5085         }
5086     }
5087 
5088     // The local host is the authoritative source for LocalOnly questions
5089     // so if no records exist and client requested intermediates, then generate a negative response
5090     if (!retEv && (m->CurrentQuestion == q) && q->ReturnIntermed)
5091         GenerateNegativeResponse(m, mDNSInterface_LocalOnly, QC_forceresponse);
5092 
5093     m->CurrentQuestion = mDNSNULL;
5094     m->CurrentRecord   = mDNSNULL;
5095 }
5096 
5097 mDNSlocal CacheEntity *GetCacheEntity(mDNS *const m, const CacheGroup *const PreserveCG)
5098 {
5099     CacheEntity *e = mDNSNULL;
5100 
5101     if (m->lock_rrcache) { LogMsg("GetFreeCacheRR ERROR! Cache already locked!"); return(mDNSNULL); }
5102     m->lock_rrcache = 1;
5103 
5104     // If we have no free records, ask the client layer to give us some more memory
5105     if (!m->rrcache_free && m->MainCallback)
5106     {
5107         if (m->rrcache_totalused != m->rrcache_size)
5108             LogMsg("GetFreeCacheRR: count mismatch: m->rrcache_totalused %lu != m->rrcache_size %lu",
5109                    m->rrcache_totalused, m->rrcache_size);
5110 
5111         // We don't want to be vulnerable to a malicious attacker flooding us with an infinite
5112         // number of bogus records so that we keep growing our cache until the machine runs out of memory.
5113         // To guard against this, if our cache grows above 512kB (approx 3168 records at 164 bytes each),
5114         // and we're actively using less than 1/32 of that cache, then we purge all the unused records
5115         // and recycle them, instead of allocating more memory.
5116         if (m->rrcache_size > 5000 && m->rrcache_size / 32 > m->rrcache_active)
5117             LogInfo("Possible denial-of-service attack in progress: m->rrcache_size %lu; m->rrcache_active %lu",
5118                     m->rrcache_size, m->rrcache_active);
5119         else
5120         {
5121             mDNS_DropLockBeforeCallback();      // Allow client to legally make mDNS API calls from the callback
5122             m->MainCallback(m, mStatus_GrowCache);
5123             mDNS_ReclaimLockAfterCallback();    // Decrement mDNS_reentrancy to block mDNS API calls again
5124         }
5125     }
5126 
5127     // If we still have no free records, recycle all the records we can.
5128     // Enumerating the entire cache is moderately expensive, so when we do it, we reclaim all the records we can in one pass.
5129     if (!m->rrcache_free)
5130     {
5131         mDNSu32 oldtotalused = m->rrcache_totalused;
5132         mDNSu32 slot;
5133         for (slot = 0; slot < CACHE_HASH_SLOTS; slot++)
5134         {
5135             CacheGroup **cp = &m->rrcache_hash[slot];
5136             while (*cp)
5137             {
5138                 CacheRecord **rp = &(*cp)->members;
5139                 while (*rp)
5140                 {
5141                     // Records that answer still-active questions are not candidates for recycling
5142                     // Records that are currently linked into the CacheFlushRecords list may not be recycled, or we'll crash
5143                     if ((*rp)->CRActiveQuestion || (*rp)->NextInCFList)
5144                         rp=&(*rp)->next;
5145                     else
5146                     {
5147                         CacheRecord *rr = *rp;
5148                         *rp = (*rp)->next;          // Cut record from list
5149                         ReleaseCacheRecord(m, rr);
5150                     }
5151                 }
5152                 if ((*cp)->rrcache_tail != rp)
5153                     verbosedebugf("GetFreeCacheRR: Updating rrcache_tail[%lu] from %p to %p", slot, (*cp)->rrcache_tail, rp);
5154                 (*cp)->rrcache_tail = rp;
5155                 if ((*cp)->members || (*cp)==PreserveCG) cp=&(*cp)->next;
5156                 else ReleaseCacheGroup(m, cp);
5157             }
5158         }
5159         LogInfo("GetCacheEntity recycled %d records to reduce cache from %d to %d",
5160                 oldtotalused - m->rrcache_totalused, oldtotalused, m->rrcache_totalused);
5161     }
5162 
5163     if (m->rrcache_free)    // If there are records in the free list, take one
5164     {
5165         e = m->rrcache_free;
5166         m->rrcache_free = e->next;
5167         if (++m->rrcache_totalused >= m->rrcache_report)
5168         {
5169             LogInfo("RR Cache now using %ld objects", m->rrcache_totalused);
5170             if      (m->rrcache_report <  100) m->rrcache_report += 10;
5171             else if (m->rrcache_report < 1000) m->rrcache_report += 100;
5172             else m->rrcache_report += 1000;
5173         }
5174         mDNSPlatformMemZero(e, sizeof(*e));
5175     }
5176 
5177     m->lock_rrcache = 0;
5178 
5179     return(e);
5180 }
5181 
5182 mDNSlocal CacheRecord *GetCacheRecord(mDNS *const m, CacheGroup *cg, mDNSu16 RDLength)
5183 {
5184     CacheRecord *r = (CacheRecord *)GetCacheEntity(m, cg);
5185     if (r)
5186     {
5187         r->resrec.rdata = (RData*)&r->smallrdatastorage;    // By default, assume we're usually going to be using local storage
5188         if (RDLength > InlineCacheRDSize)           // If RDLength is too big, allocate extra storage
5189         {
5190             r->resrec.rdata = (RData*)mDNSPlatformMemAllocate(sizeofRDataHeader + RDLength);
5191             if (r->resrec.rdata) r->resrec.rdata->MaxRDLength = r->resrec.rdlength = RDLength;
5192             else { ReleaseCacheEntity(m, (CacheEntity*)r); r = mDNSNULL; }
5193         }
5194     }
5195     return(r);
5196 }
5197 
5198 mDNSlocal CacheGroup *GetCacheGroup(mDNS *const m, const mDNSu32 slot, const ResourceRecord *const rr)
5199 {
5200     mDNSu16 namelen = DomainNameLength(rr->name);
5201     CacheGroup *cg = (CacheGroup*)GetCacheEntity(m, mDNSNULL);
5202     if (!cg) { LogMsg("GetCacheGroup: Failed to allocate memory for %##s", rr->name->c); return(mDNSNULL); }
5203     cg->next         = m->rrcache_hash[slot];
5204     cg->namehash     = rr->namehash;
5205     cg->members      = mDNSNULL;
5206     cg->rrcache_tail = &cg->members;
5207     if (namelen > sizeof(cg->namestorage))
5208         cg->name = mDNSPlatformMemAllocate(namelen);
5209     else
5210         cg->name = (domainname*)cg->namestorage;
5211     if (!cg->name)
5212     {
5213         LogMsg("GetCacheGroup: Failed to allocate name storage for %##s", rr->name->c);
5214         ReleaseCacheEntity(m, (CacheEntity*)cg);
5215         return(mDNSNULL);
5216     }
5217     AssignDomainName(cg->name, rr->name);
5218 
5219     if (CacheGroupForRecord(m, rr)) LogMsg("GetCacheGroup: Already have CacheGroup for %##s", rr->name->c);
5220     m->rrcache_hash[slot] = cg;
5221     if (CacheGroupForRecord(m, rr) != cg) LogMsg("GetCacheGroup: Not finding CacheGroup for %##s", rr->name->c);
5222 
5223     return(cg);
5224 }
5225 
5226 mDNSexport void mDNS_PurgeCacheResourceRecord(mDNS *const m, CacheRecord *rr)
5227 {
5228     mDNS_CheckLock(m);
5229 
5230     // Make sure we mark this record as thoroughly expired -- we don't ever want to give
5231     // a positive answer using an expired record (e.g. from an interface that has gone away).
5232     // We don't want to clear CRActiveQuestion here, because that would leave the record subject to
5233     // summary deletion without giving the proper callback to any questions that are monitoring it.
5234     // By setting UnansweredQueries to MaxUnansweredQueries we ensure it won't trigger any further expiration queries.
5235     rr->TimeRcvd          = m->timenow - mDNSPlatformOneSecond * 60;
5236     rr->UnansweredQueries = MaxUnansweredQueries;
5237     rr->resrec.rroriginalttl     = 0;
5238     SetNextCacheCheckTimeForRecord(m, rr);
5239 }
5240 
5241 mDNSexport mDNSs32 mDNS_TimeNow(const mDNS *const m)
5242 {
5243     mDNSs32 time;
5244     mDNSPlatformLock(m);
5245     if (m->mDNS_busy)
5246     {
5247         LogMsg("mDNS_TimeNow called while holding mDNS lock. This is incorrect. Code protected by lock should just use m->timenow.");
5248         if (!m->timenow) LogMsg("mDNS_TimeNow: m->mDNS_busy is %ld but m->timenow not set", m->mDNS_busy);
5249     }
5250 
5251     if (m->timenow) time = m->timenow;
5252     else time = mDNS_TimeNow_NoLock(m);
5253     mDNSPlatformUnlock(m);
5254     return(time);
5255 }
5256 
5257 // To avoid pointless CPU thrash, we use SetSPSProxyListChanged(X) to record the last interface that
5258 // had its Sleep Proxy client list change, and defer to actual BPF reconfiguration to mDNS_Execute().
5259 // (GetNextScheduledEvent() returns "now" when m->SPSProxyListChanged is set)
5260 #define SetSPSProxyListChanged(X) do { \
5261         if (m->SPSProxyListChanged && m->SPSProxyListChanged != (X)) mDNSPlatformUpdateProxyList(m->SPSProxyListChanged); \
5262         m->SPSProxyListChanged = (X); } while(0)
5263 
5264 // Called from mDNS_Execute() to expire stale proxy records
5265 mDNSlocal void CheckProxyRecords(mDNS *const m, AuthRecord *list)
5266 {
5267     m->CurrentRecord = list;
5268     while (m->CurrentRecord)
5269     {
5270         AuthRecord *rr = m->CurrentRecord;
5271         if (rr->resrec.RecordType != kDNSRecordTypeDeregistering && rr->WakeUp.HMAC.l[0])
5272         {
5273             // If m->SPSSocket is NULL that means we're not acting as a sleep proxy any more,
5274             // so we need to cease proxying for *all* records we may have, expired or not.
5275             if (m->SPSSocket && m->timenow - rr->TimeExpire < 0)    // If proxy record not expired yet, update m->NextScheduledSPS
5276             {
5277                 if (m->NextScheduledSPS - rr->TimeExpire > 0)
5278                     m->NextScheduledSPS = rr->TimeExpire;
5279             }
5280             else                                                    // else proxy record expired, so remove it
5281             {
5282                 LogSPS("CheckProxyRecords: Removing %d H-MAC %.6a I-MAC %.6a %d %s",
5283                        m->ProxyRecords, &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, rr->WakeUp.seq, ARDisplayString(m, rr));
5284                 SetSPSProxyListChanged(rr->resrec.InterfaceID);
5285                 mDNS_Deregister_internal(m, rr, mDNS_Dereg_normal);
5286                 // Don't touch rr after this -- memory may have been free'd
5287             }
5288         }
5289         // Mustn't advance m->CurrentRecord until *after* mDNS_Deregister_internal, because
5290         // new records could have been added to the end of the list as a result of that call.
5291         if (m->CurrentRecord == rr) // If m->CurrentRecord was not advanced for us, do it now
5292             m->CurrentRecord = rr->next;
5293     }
5294 }
5295 
5296 mDNSlocal void CheckRmvEventsForLocalRecords(mDNS *const m)
5297 {
5298     while (m->CurrentRecord)
5299     {
5300         AuthRecord *rr = m->CurrentRecord;
5301         if (rr->AnsweredLocalQ && rr->resrec.RecordType == kDNSRecordTypeDeregistering)
5302         {
5303             debugf("CheckRmvEventsForLocalRecords: Generating local RMV events for %s", ARDisplayString(m, rr));
5304             rr->resrec.RecordType = kDNSRecordTypeShared;
5305             AnswerAllLocalQuestionsWithLocalAuthRecord(m, rr, QC_rmv);
5306             if (m->CurrentRecord == rr) // If rr still exists in list, restore its state now
5307             {
5308                 rr->resrec.RecordType = kDNSRecordTypeDeregistering;
5309                 rr->AnsweredLocalQ = mDNSfalse;
5310                 // SendResponses normally calls CompleteDeregistration after sending goodbyes.
5311                 // For LocalOnly records, we don't do that and hence we need to do that here.
5312                 if (RRLocalOnly(rr)) CompleteDeregistration(m, rr);
5313             }
5314         }
5315         if (m->CurrentRecord == rr)     // If m->CurrentRecord was not auto-advanced, do it ourselves now
5316             m->CurrentRecord = rr->next;
5317     }
5318 }
5319 
5320 mDNSlocal void TimeoutQuestions_internal(mDNS *const m, DNSQuestion* questions, mDNSInterfaceID InterfaceID)
5321 {
5322     if (m->CurrentQuestion)
5323         LogMsg("TimeoutQuestions ERROR m->CurrentQuestion already set: %##s (%s)", m->CurrentQuestion->qname.c,
5324                DNSTypeName(m->CurrentQuestion->qtype));
5325     m->CurrentQuestion = questions;
5326     while (m->CurrentQuestion)
5327     {
5328         DNSQuestion *const q = m->CurrentQuestion;
5329         if (q->StopTime)
5330         {
5331             if (!q->TimeoutQuestion)
5332                 LogMsg("TimeoutQuestions: ERROR!! TimeoutQuestion not set, but StopTime set for %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
5333 
5334             if (m->timenow - q->StopTime >= 0)
5335             {
5336                 LogInfo("TimeoutQuestions: question %p %##s timed out, time %d", q, q->qname.c, m->timenow - q->StopTime);
5337                 q->LOAddressAnswers = 0; // unset since timing out the question
5338                 GenerateNegativeResponse(m, InterfaceID, QC_forceresponse);
5339                 if (m->CurrentQuestion == q) q->StopTime = 0;
5340             }
5341             else
5342             {
5343                 if (m->NextScheduledStopTime - q->StopTime > 0)
5344                     m->NextScheduledStopTime = q->StopTime;
5345             }
5346         }
5347         // If m->CurrentQuestion wasn't modified out from under us, advance it now
5348         // We can't do this at the start of the loop because GenerateNegativeResponse
5349         // depends on having m->CurrentQuestion point to the right question
5350         if (m->CurrentQuestion == q)
5351             m->CurrentQuestion = q->next;
5352     }
5353     m->CurrentQuestion = mDNSNULL;
5354 }
5355 
5356 mDNSlocal void TimeoutQuestions(mDNS *const m)
5357 {
5358     m->NextScheduledStopTime = m->timenow + FutureTime; // push reschedule of TimeoutQuestions to way off into the future
5359     TimeoutQuestions_internal(m, m->Questions, mDNSInterface_Any);
5360     TimeoutQuestions_internal(m, m->LocalOnlyQuestions, mDNSInterface_LocalOnly);
5361 }
5362 
5363 mDNSlocal void mDNSCoreFreeProxyRR(mDNS *const m)
5364 {
5365     AuthRecord *rrPtr = m->SPSRRSet, *rrNext = mDNSNULL;
5366     LogSPS("%s : Freeing stored sleep proxy A/AAAA records", __func__);
5367     while (rrPtr)
5368     {
5369         rrNext = rrPtr->next;
5370         mDNSPlatformMemFree(rrPtr);
5371         rrPtr  = rrNext;
5372     }
5373     m->SPSRRSet = mDNSNULL;
5374 }
5375 
5376 mDNSexport mDNSs32 mDNS_Execute(mDNS *const m)
5377 {
5378     mDNS_Lock(m);   // Must grab lock before trying to read m->timenow
5379 
5380     if (m->timenow - m->NextScheduledEvent >= 0)
5381     {
5382         int i;
5383         AuthRecord *head, *tail;
5384         mDNSu32 slot;
5385         AuthGroup *ag;
5386 
5387         verbosedebugf("mDNS_Execute");
5388 
5389         if (m->CurrentQuestion)
5390             LogMsg("mDNS_Execute: ERROR m->CurrentQuestion already set: %##s (%s)",
5391                    m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
5392 
5393         if (m->CurrentRecord)
5394             LogMsg("mDNS_Execute: ERROR m->CurrentRecord already set: %s", ARDisplayString(m, m->CurrentRecord));
5395 
5396         // 1. If we're past the probe suppression time, we can clear it
5397         if (m->SuppressProbes && m->timenow - m->SuppressProbes >= 0) m->SuppressProbes = 0;
5398 
5399         // 2. If it's been more than ten seconds since the last probe failure, we can clear the counter
5400         if (m->NumFailedProbes && m->timenow - m->ProbeFailTime >= mDNSPlatformOneSecond * 10) m->NumFailedProbes = 0;
5401 
5402         // 3. Purge our cache of stale old records
5403         if (m->rrcache_size && m->timenow - m->NextCacheCheck >= 0)
5404         {
5405             mDNSu32 numchecked = 0;
5406             m->NextCacheCheck = m->timenow + FutureTime;
5407             for (slot = 0; slot < CACHE_HASH_SLOTS; slot++)
5408             {
5409                 if (m->timenow - m->rrcache_nextcheck[slot] >= 0)
5410                 {
5411                     CacheGroup **cp = &m->rrcache_hash[slot];
5412                     m->rrcache_nextcheck[slot] = m->timenow + FutureTime;
5413                     while (*cp)
5414                     {
5415                         debugf("m->NextCacheCheck %4d Slot %3d %##s", numchecked, slot, *cp ? (*cp)->name : (domainname*)"\x04NULL");
5416                         numchecked++;
5417                         CheckCacheExpiration(m, slot, *cp);
5418                         if ((*cp)->members) cp=&(*cp)->next;
5419                         else ReleaseCacheGroup(m, cp);
5420                     }
5421                 }
5422                 // Even if we didn't need to actually check this slot yet, still need to
5423                 // factor its nextcheck time into our overall NextCacheCheck value
5424                 if (m->NextCacheCheck - m->rrcache_nextcheck[slot] > 0)
5425                     m->NextCacheCheck = m->rrcache_nextcheck[slot];
5426             }
5427             debugf("m->NextCacheCheck %4d checked, next in %d", numchecked, m->NextCacheCheck - m->timenow);
5428         }
5429 
5430         if (m->timenow - m->NextScheduledSPS >= 0)
5431         {
5432             m->NextScheduledSPS = m->timenow + FutureTime;
5433             CheckProxyRecords(m, m->DuplicateRecords);  // Clear m->DuplicateRecords first, then m->ResourceRecords
5434             CheckProxyRecords(m, m->ResourceRecords);
5435         }
5436 
5437         SetSPSProxyListChanged(mDNSNULL);       // Perform any deferred BPF reconfiguration now
5438 
5439         // Check to see if we need to send any keepalives. Do this after we called CheckProxyRecords above
5440         // as records could have expired during that check
5441         if (m->timenow - m->NextScheduledKA >= 0)
5442         {
5443             m->NextScheduledKA = m->timenow + FutureTime;
5444             mDNS_SendKeepalives(m);
5445         }
5446 
5447 #if BONJOUR_ON_DEMAND
5448         if (m->NextBonjourDisableTime && (m->timenow - m->NextBonjourDisableTime >= 0))
5449         {
5450             // Schedule immediate network change processing to leave the multicast group
5451             // since the delay time has expired since the previous active registration or query.
5452             m->NetworkChanged = m->timenow;
5453             m->NextBonjourDisableTime = 0;
5454             m->BonjourEnabled = 0;
5455 
5456             LogInfo("mDNS_Execute: Scheduled network changed processing to leave multicast group.");
5457         }
5458 #endif // BONJOUR_ON_DEMAND
5459 
5460         // Clear AnnounceOwner if necessary. (Do this *before* SendQueries() and SendResponses().)
5461         if (m->AnnounceOwner && m->timenow - m->AnnounceOwner >= 0)
5462         {
5463             m->AnnounceOwner = 0;
5464 
5465             // This is a good time to reset the delay counter used to prevent spurious conflicts
5466             m->DelayConflictProcessing = 0;
5467         }
5468 
5469         if (m->DelaySleep && m->timenow - m->DelaySleep >= 0)
5470         {
5471             m->DelaySleep = 0;
5472             if (m->SleepState == SleepState_Transferring)
5473             {
5474                 LogSPS("Re-sleep delay passed; now checking for Sleep Proxy Servers");
5475                 BeginSleepProcessing(m);
5476             }
5477         }
5478 
5479         // 4. See if we can answer any of our new local questions from the cache
5480         for (i=0; m->NewQuestions && i<1000; i++)
5481         {
5482             if (m->NewQuestions->DelayAnswering && m->timenow - m->NewQuestions->DelayAnswering < 0) break;
5483             AnswerNewQuestion(m);
5484         }
5485         if (i >= 1000) LogMsg("mDNS_Execute: AnswerNewQuestion exceeded loop limit");
5486 
5487         // Make sure we deliver *all* local RMV events, and clear the corresponding rr->AnsweredLocalQ flags, *before*
5488         // we begin generating *any* new ADD events in the m->NewLocalOnlyQuestions and m->NewLocalRecords loops below.
5489         for (i=0; i<1000 && m->LocalRemoveEvents; i++)
5490         {
5491             m->LocalRemoveEvents = mDNSfalse;
5492             m->CurrentRecord = m->ResourceRecords;
5493             CheckRmvEventsForLocalRecords(m);
5494             // Walk the LocalOnly records and deliver the RMV events
5495             for (slot = 0; slot < AUTH_HASH_SLOTS; slot++)
5496                 for (ag = m->rrauth.rrauth_hash[slot]; ag; ag = ag->next)
5497                 {
5498                     m->CurrentRecord = ag->members;
5499                     if (m->CurrentRecord) CheckRmvEventsForLocalRecords(m);
5500                 }
5501         }
5502 
5503         if (i >= 1000) LogMsg("mDNS_Execute: m->LocalRemoveEvents exceeded loop limit");
5504 
5505         for (i=0; m->NewLocalOnlyQuestions && i<1000; i++) AnswerNewLocalOnlyQuestion(m);
5506         if (i >= 1000) LogMsg("mDNS_Execute: AnswerNewLocalOnlyQuestion exceeded loop limit");
5507 
5508         head = tail = mDNSNULL;
5509         for (i=0; i<1000 && m->NewLocalRecords && m->NewLocalRecords != head; i++)
5510         {
5511             AuthRecord *rr = m->NewLocalRecords;
5512             m->NewLocalRecords = m->NewLocalRecords->next;
5513             if (LocalRecordReady(rr))
5514             {
5515                 debugf("mDNS_Execute: Delivering Add event with LocalAuthRecord %s", ARDisplayString(m, rr));
5516                 AnswerAllLocalQuestionsWithLocalAuthRecord(m, rr, QC_add);
5517             }
5518             else if (!rr->next)
5519             {
5520                 // If we have just one record that is not ready, we don't have to unlink and
5521                 // reinsert. As the NewLocalRecords will be NULL for this case, the loop will
5522                 // terminate and set the NewLocalRecords to rr.
5523                 debugf("mDNS_Execute: Just one LocalAuthRecord %s, breaking out of the loop early", ARDisplayString(m, rr));
5524                 if (head != mDNSNULL || m->NewLocalRecords != mDNSNULL)
5525                     LogMsg("mDNS_Execute: ERROR!!: head %p, NewLocalRecords %p", head, m->NewLocalRecords);
5526 
5527                 head = rr;
5528             }
5529             else
5530             {
5531                 AuthRecord **p = &m->ResourceRecords;   // Find this record in our list of active records
5532                 debugf("mDNS_Execute: Skipping LocalAuthRecord %s", ARDisplayString(m, rr));
5533                 // if this is the first record we are skipping, move to the end of the list.
5534                 // if we have already skipped records before, append it at the end.
5535                 while (*p && *p != rr) p=&(*p)->next;
5536                 if (*p) *p = rr->next;                  // Cut this record from the list
5537                 else { LogMsg("mDNS_Execute: ERROR!! Cannot find record %s in ResourceRecords list", ARDisplayString(m, rr)); break; }
5538                 if (!head)
5539                 {
5540                     while (*p) p=&(*p)->next;
5541                     *p = rr;
5542                     head = tail = rr;
5543                 }
5544                 else
5545                 {
5546                     tail->next = rr;
5547                     tail = rr;
5548                 }
5549                 rr->next = mDNSNULL;
5550             }
5551         }
5552         m->NewLocalRecords = head;
5553         debugf("mDNS_Execute: Setting NewLocalRecords to %s", (head ? ARDisplayString(m, head) : "NULL"));
5554 
5555         if (i >= 1000) LogMsg("mDNS_Execute: m->NewLocalRecords exceeded loop limit");
5556 
5557         // Check to see if we have any new LocalOnly/P2P records to examine for delivering
5558         // to our local questions
5559         if (m->NewLocalOnlyRecords)
5560         {
5561             m->NewLocalOnlyRecords = mDNSfalse;
5562             for (slot = 0; slot < AUTH_HASH_SLOTS; slot++)
5563                 for (ag = m->rrauth.rrauth_hash[slot]; ag; ag = ag->next)
5564                 {
5565                     for (i=0; i<100 && ag->NewLocalOnlyRecords; i++)
5566                     {
5567                         AuthRecord *rr = ag->NewLocalOnlyRecords;
5568                         ag->NewLocalOnlyRecords = ag->NewLocalOnlyRecords->next;
5569                         // LocalOnly records should always be ready as they never probe
5570                         if (LocalRecordReady(rr))
5571                         {
5572                             debugf("mDNS_Execute: Delivering Add event with LocalAuthRecord %s", ARDisplayString(m, rr));
5573                             AnswerAllLocalQuestionsWithLocalAuthRecord(m, rr, QC_add);
5574                         }
5575                         else LogMsg("mDNS_Execute: LocalOnlyRecord %s not ready", ARDisplayString(m, rr));
5576                     }
5577                     // We limit about 100 per AuthGroup that can be serviced at a time
5578                     if (i >= 100) LogMsg("mDNS_Execute: ag->NewLocalOnlyRecords exceeded loop limit");
5579                 }
5580         }
5581 
5582         // 5. See what packets we need to send
5583         if (m->mDNSPlatformStatus != mStatus_NoError || (m->SleepState == SleepState_Sleeping))
5584             DiscardDeregistrations(m);
5585         if (m->mDNSPlatformStatus == mStatus_NoError && (m->SuppressSending == 0 || m->timenow - m->SuppressSending >= 0))
5586         {
5587             // If the platform code is ready, and we're not suppressing packet generation right now
5588             // then send our responses, probes, and questions.
5589             // We check the cache first, because there might be records close to expiring that trigger questions to refresh them.
5590             // We send queries next, because there might be final-stage probes that complete their probing here, causing
5591             // them to advance to announcing state, and we want those to be included in any announcements we send out.
5592             // Finally, we send responses, including the previously mentioned records that just completed probing.
5593             m->SuppressSending = 0;
5594 
5595             // 6. Send Query packets. This may cause some probing records to advance to announcing state
5596             if (m->timenow - m->NextScheduledQuery >= 0 || m->timenow - m->NextScheduledProbe >= 0) SendQueries(m);
5597             if (m->timenow - m->NextScheduledQuery >= 0)
5598             {
5599                 DNSQuestion *q;
5600                 LogMsg("mDNS_Execute: SendQueries didn't send all its queries (%d - %d = %d) will try again in one second",
5601                        m->timenow, m->NextScheduledQuery, m->timenow - m->NextScheduledQuery);
5602                 m->NextScheduledQuery = m->timenow + mDNSPlatformOneSecond;
5603                 for (q = m->Questions; q && q != m->NewQuestions; q=q->next)
5604                     if (ActiveQuestion(q) && m->timenow - NextQSendTime(q) >= 0)
5605                         LogMsg("mDNS_Execute: SendQueries didn't send %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
5606             }
5607             if (m->timenow - m->NextScheduledProbe >= 0)
5608             {
5609                 LogMsg("mDNS_Execute: SendQueries didn't send all its probes (%d - %d = %d) will try again in one second",
5610                        m->timenow, m->NextScheduledProbe, m->timenow - m->NextScheduledProbe);
5611                 m->NextScheduledProbe = m->timenow + mDNSPlatformOneSecond;
5612             }
5613 
5614             // 7. Send Response packets, including probing records just advanced to announcing state
5615             if (m->timenow - m->NextScheduledResponse >= 0) SendResponses(m);
5616             if (m->timenow - m->NextScheduledResponse >= 0)
5617             {
5618                 LogMsg("mDNS_Execute: SendResponses didn't send all its responses; will try again in one second");
5619                 m->NextScheduledResponse = m->timenow + mDNSPlatformOneSecond;
5620             }
5621         }
5622 
5623         // Clear RandomDelay values, ready to pick a new different value next time
5624         m->RandomQueryDelay     = 0;
5625         m->RandomReconfirmDelay = 0;
5626 
5627         // See if any questions (or local-only questions) have timed out
5628         if (m->NextScheduledStopTime && m->timenow - m->NextScheduledStopTime >= 0) TimeoutQuestions(m);
5629 #ifndef UNICAST_DISABLED
5630         if (m->NextSRVUpdate && m->timenow - m->NextSRVUpdate >= 0) UpdateAllSRVRecords(m);
5631         if (m->timenow - m->NextScheduledNATOp >= 0) CheckNATMappings(m);
5632         if (m->timenow - m->NextuDNSEvent >= 0) uDNS_Tasks(m);
5633 #endif
5634 #if APPLE_OSX_mDNSResponder && ENABLE_BLE_TRIGGERED_BONJOUR
5635         extern void serviceBLE();
5636         if (m->NextBLEServiceTime && (m->timenow - m->NextBLEServiceTime >= 0)) serviceBLE();
5637 #endif // APPLE_OSX_mDNSResponder && ENABLE_BLE_TRIGGERED_BONJOUR
5638     }
5639 
5640     // Note about multi-threaded systems:
5641     // On a multi-threaded system, some other thread could run right after the mDNS_Unlock(),
5642     // performing mDNS API operations that change our next scheduled event time.
5643     //
5644     // On multi-threaded systems (like the current Windows implementation) that have a single main thread
5645     // calling mDNS_Execute() (and other threads allowed to call mDNS API routines) it is the responsibility
5646     // of the mDNSPlatformUnlock() routine to signal some kind of stateful condition variable that will
5647     // signal whatever blocking primitive the main thread is using, so that it will wake up and execute one
5648     // more iteration of its loop, and immediately call mDNS_Execute() again. The signal has to be stateful
5649     // in the sense that if the main thread has not yet entered its blocking primitive, then as soon as it
5650     // does, the state of the signal will be noticed, causing the blocking primitive to return immediately
5651     // without blocking. This avoids the race condition between the signal from the other thread arriving
5652     // just *before* or just *after* the main thread enters the blocking primitive.
5653     //
5654     // On multi-threaded systems (like the current Mac OS 9 implementation) that are entirely timer-driven,
5655     // with no main mDNS_Execute() thread, it is the responsibility of the mDNSPlatformUnlock() routine to
5656     // set the timer according to the m->NextScheduledEvent value, and then when the timer fires, the timer
5657     // callback function should call mDNS_Execute() (and ignore the return value, which may already be stale
5658     // by the time it gets to the timer callback function).
5659 
5660     mDNS_Unlock(m);     // Calling mDNS_Unlock is what gives m->NextScheduledEvent its new value
5661     return(m->NextScheduledEvent);
5662 }
5663 
5664 #ifndef UNICAST_DISABLED
5665 mDNSlocal void SuspendLLQs(mDNS *m)
5666 {
5667     DNSQuestion *q;
5668     for (q = m->Questions; q; q = q->next)
5669         if (ActiveQuestion(q) && !mDNSOpaque16IsZero(q->TargetQID) && q->LongLived && q->state == LLQ_Established)
5670         { q->ReqLease = 0; sendLLQRefresh(m, q); }
5671 }
5672 #endif // UNICAST_DISABLED
5673 
5674 mDNSlocal mDNSBool QuestionHasLocalAnswers(mDNS *const m, DNSQuestion *q)
5675 {
5676     AuthRecord *rr;
5677     AuthGroup *ag;
5678 
5679     ag = AuthGroupForName(&m->rrauth, q->qnamehash, &q->qname);
5680     if (ag)
5681     {
5682         for (rr = ag->members; rr; rr=rr->next)
5683             // Filter the /etc/hosts records - LocalOnly, Unique, A/AAAA/CNAME
5684             if (UniqueLocalOnlyRecord(rr) && LocalOnlyRecordAnswersQuestion(rr, q))
5685             {
5686                 LogInfo("QuestionHasLocalAnswers: Question %p %##s (%s) has local answer %s", q, q->qname.c, DNSTypeName(q->qtype), ARDisplayString(m, rr));
5687                 return mDNStrue;
5688             }
5689     }
5690     return mDNSfalse;
5691 }
5692 
5693 // ActivateUnicastQuery() is called from three places:
5694 // 1. When a new question is created
5695 // 2. On wake from sleep
5696 // 3. When the DNS configuration changes
5697 // In case 1 we don't want to mess with our established ThisQInterval and LastQTime (ScheduleImmediately is false)
5698 // In cases 2 and 3 we do want to cause the question to be resent immediately (ScheduleImmediately is true)
5699 mDNSlocal void ActivateUnicastQuery(mDNS *const m, DNSQuestion *const question, mDNSBool ScheduleImmediately)
5700 {
5701     // For now this AutoTunnel stuff is specific to Mac OS X.
5702     // In the future, if there's demand, we may see if we can abstract it out cleanly into the platform layer
5703 #if APPLE_OSX_mDNSResponder
5704     // Even though BTMM client tunnels are only useful for AAAA queries, we need to treat v4 and v6 queries equally.
5705     // Otherwise we can get the situation where the A query completes really fast (with an NXDOMAIN result) and the
5706     // caller then gives up waiting for the AAAA result while we're still in the process of setting up the tunnel.
5707     // To level the playing field, we block both A and AAAA queries while tunnel setup is in progress, and then
5708     // returns results for both at the same time. If we are looking for the _autotunnel6 record, then skip this logic
5709     // as this would trigger looking up _autotunnel6._autotunnel6 and end up failing the original query.
5710 
5711     if (RRTypeIsAddressType(question->qtype) && PrivateQuery(question) &&
5712         !SameDomainLabel(question->qname.c, (const mDNSu8 *)"\x0c_autotunnel6")&& question->QuestionCallback != AutoTunnelCallback)
5713     {
5714         question->NoAnswer = NoAnswer_Suspended;
5715         AddNewClientTunnel(question);
5716         return;
5717     }
5718 #endif // APPLE_OSX_mDNSResponder
5719 
5720     if (!question->DuplicateOf)
5721     {
5722         debugf("ActivateUnicastQuery: %##s %s%s%s",
5723                question->qname.c, DNSTypeName(question->qtype), PrivateQuery(question) ? " (Private)" : "", ScheduleImmediately ? " ScheduleImmediately" : "");
5724         question->CNAMEReferrals = 0;
5725         if (question->nta) { CancelGetZoneData(m, question->nta); question->nta = mDNSNULL; }
5726         if (question->LongLived)
5727         {
5728             question->state = LLQ_InitialRequest;
5729             question->id = zeroOpaque64;
5730             question->servPort = zeroIPPort;
5731             if (question->tcp) { DisposeTCPConn(question->tcp); question->tcp = mDNSNULL; }
5732         }
5733         // If the question has local answers, then we don't want answers from outside
5734         if (ScheduleImmediately && !QuestionHasLocalAnswers(m, question))
5735         {
5736             question->ThisQInterval = InitialQuestionInterval;
5737             question->LastQTime     = m->timenow - question->ThisQInterval;
5738             SetNextQueryTime(m, question);
5739         }
5740     }
5741 }
5742 
5743 // Caller should hold the lock
5744 mDNSexport void mDNSCoreRestartAddressQueries(mDNS *const m, mDNSBool SearchDomainsChanged, FlushCache flushCacheRecords,
5745                                               CallbackBeforeStartQuery BeforeStartCallback, void *context)
5746 {
5747     DNSQuestion *q;
5748     DNSQuestion *restart = mDNSNULL;
5749 
5750     mDNS_CheckLock(m);
5751 
5752     // 1. Flush the cache records
5753     if (flushCacheRecords) flushCacheRecords(m);
5754 
5755     // 2. Even though we may have purged the cache records above, before it can generate RMV event
5756     // we are going to stop the question. Hence we need to deliver the RMV event before we
5757     // stop the question.
5758     //
5759     // CurrentQuestion is used by RmvEventsForQuestion below. While delivering RMV events, the
5760     // application callback can potentially stop the current question (detected by CurrentQuestion) or
5761     // *any* other question which could be the next one that we may process here. RestartQuestion
5762     // points to the "next" question which will be automatically advanced in mDNS_StopQuery_internal
5763     // if the "next" question is stopped while the CurrentQuestion is stopped
5764 
5765     if (m->RestartQuestion)
5766         LogMsg("mDNSCoreRestartAddressQueries: ERROR!! m->RestartQuestion already set: %##s (%s)",
5767                m->RestartQuestion->qname.c, DNSTypeName(m->RestartQuestion->qtype));
5768 
5769     m->RestartQuestion = m->Questions;
5770     while (m->RestartQuestion)
5771     {
5772         q = m->RestartQuestion;
5773         m->RestartQuestion = q->next;
5774         // GetZoneData questions are referenced by other questions (original query that started the GetZoneData
5775         // question)  through their "nta" pointer. Normally when the original query stops, it stops the
5776         // GetZoneData question and also frees the memory (See CancelGetZoneData). If we stop the GetZoneData
5777         // question followed by the original query that refers to this GetZoneData question, we will end up
5778         // freeing the GetZoneData question and then start the "freed" question at the end.
5779 
5780         if (IsGetZoneDataQuestion(q))
5781         {
5782             DNSQuestion *refq = q->next;
5783             LogInfo("mDNSCoreRestartAddressQueries: Skipping GetZoneDataQuestion %p %##s (%s)", q, q->qname.c, DNSTypeName(q->qtype));
5784             // debug stuff, we just try to find the referencing question and don't do much with it
5785             while (refq)
5786             {
5787                 if (q == &refq->nta->question)
5788                 {
5789                     LogInfo("mDNSCoreRestartAddressQueries: Question %p %##s (%s) referring to GetZoneDataQuestion %p, not stopping", refq, refq->qname.c, DNSTypeName(refq->qtype), q);
5790                 }
5791                 refq = refq->next;
5792             }
5793             continue;
5794         }
5795 
5796         // This function is called when /etc/hosts changes and that could affect A, AAAA and CNAME queries
5797         if (q->qtype != kDNSType_A && q->qtype != kDNSType_AAAA && q->qtype != kDNSType_CNAME) continue;
5798 
5799         // If the search domains did not change, then we restart all the queries. Otherwise, only
5800         // for queries for which we "might" have appended search domains ("might" because we may
5801         // find results before we apply search domains even though AppendSearchDomains is set to 1)
5802         if (!SearchDomainsChanged || q->AppendSearchDomains)
5803         {
5804             // NOTE: CacheRecordRmvEventsForQuestion will not generate RMV events for queries that have non-zero
5805             // LOAddressAnswers. Hence it is important that we call CacheRecordRmvEventsForQuestion before
5806             // LocalRecordRmvEventsForQuestion (which decrements LOAddressAnswers). Let us say that
5807             // /etc/hosts has an A Record for web.apple.com. Any queries for web.apple.com will be answered locally.
5808             // But this can't prevent a CNAME/AAAA query to not to be sent on the wire. When it is sent on the wire,
5809             // it could create cache entries. When we are restarting queries, we can't deliver the cache RMV events
5810             // for the original query using these cache entries as ADDs were never delivered using these cache
5811             // entries and hence this order is needed.
5812 
5813             // If the query is suppressed, the RMV events won't be delivered
5814             if (!CacheRecordRmvEventsForQuestion(m, q)) { LogInfo("mDNSCoreRestartAddressQueries: Question deleted while delivering Cache Record RMV events"); continue; }
5815 
5816             // SuppressQuery status does not affect questions that are answered using local records
5817             if (!LocalRecordRmvEventsForQuestion(m, q)) { LogInfo("mDNSCoreRestartAddressQueries: Question deleted while delivering Local Record RMV events"); continue; }
5818 
5819             LogInfo("mDNSCoreRestartAddressQueries: Stop question %p %##s (%s), AppendSearchDomains %d, qnameOrig %p", q,
5820                     q->qname.c, DNSTypeName(q->qtype), q->AppendSearchDomains, q->qnameOrig);
5821             mDNS_StopQuery_internal(m, q);
5822             // Reset state so that it looks like it was in the beginning i.e it should look at /etc/hosts, cache
5823             // and then search domains should be appended. At the beginning, qnameOrig was NULL.
5824             if (q->qnameOrig)
5825             {
5826                 LogInfo("mDNSCoreRestartAddressQueries: qnameOrig %##s", q->qnameOrig);
5827                 AssignDomainName(&q->qname, q->qnameOrig);
5828                 mDNSPlatformMemFree(q->qnameOrig);
5829                 q->qnameOrig = mDNSNULL;
5830                 q->RetryWithSearchDomains = ApplySearchDomainsFirst(q) ? 1 : 0;
5831             }
5832             q->SearchListIndex = 0;
5833             q->next = restart;
5834             restart = q;
5835         }
5836     }
5837 
5838     // 3. Callback before we start the query
5839     if (BeforeStartCallback) BeforeStartCallback(m, context);
5840 
5841     // 4. Restart all the stopped queries
5842     while (restart)
5843     {
5844         q = restart;
5845         restart = restart->next;
5846         q->next = mDNSNULL;
5847         LogInfo("mDNSCoreRestartAddressQueries: Start question %p %##s (%s)", q, q->qname.c, DNSTypeName(q->qtype));
5848         mDNS_StartQuery_internal(m, q);
5849     }
5850 }
5851 
5852 mDNSexport void mDNSCoreRestartQueries(mDNS *const m)
5853 {
5854     DNSQuestion *q;
5855 
5856 #ifndef UNICAST_DISABLED
5857     // Retrigger all our uDNS questions
5858     if (m->CurrentQuestion)
5859         LogMsg("mDNSCoreRestartQueries: ERROR m->CurrentQuestion already set: %##s (%s)",
5860                m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
5861     m->CurrentQuestion = m->Questions;
5862     while (m->CurrentQuestion)
5863     {
5864         q = m->CurrentQuestion;
5865         m->CurrentQuestion = m->CurrentQuestion->next;
5866         if (!mDNSOpaque16IsZero(q->TargetQID) && ActiveQuestion(q)) ActivateUnicastQuery(m, q, mDNStrue);
5867     }
5868 #endif
5869 
5870     // Retrigger all our mDNS questions
5871     for (q = m->Questions; q; q=q->next)                // Scan our list of questions
5872             mDNSCoreRestartQuestion(m, q);
5873 }
5874 
5875 // restart question if it's multicast and currently active
5876 mDNSexport void mDNSCoreRestartQuestion(mDNS *const m, DNSQuestion *q)
5877 {
5878     if (mDNSOpaque16IsZero(q->TargetQID) && ActiveQuestion(q))
5879     {
5880         q->ThisQInterval    = InitialQuestionInterval;  // MUST be > zero for an active question
5881         q->RequestUnicast   = kDefaultRequestUnicastCount;
5882         q->LastQTime        = m->timenow - q->ThisQInterval;
5883         q->RecentAnswerPkts = 0;
5884         ExpireDupSuppressInfo(q->DupSuppress, m->timenow);
5885         m->NextScheduledQuery = m->timenow;
5886     }
5887 }
5888 
5889 // restart the probe/announce cycle for multicast record
5890 mDNSexport void mDNSCoreRestartRegistration(mDNS *const m, AuthRecord *rr, int announceCount)
5891 {
5892     if (!AuthRecord_uDNS(rr))
5893     {
5894         if (rr->resrec.RecordType == kDNSRecordTypeVerified && !rr->DependentOn) rr->resrec.RecordType = kDNSRecordTypeUnique;
5895         rr->ProbeCount     = DefaultProbeCountForRecordType(rr->resrec.RecordType);
5896 
5897         if (mDNS_KeepaliveRecord(&rr->resrec))
5898         {
5899             rr->AnnounceCount = 0; // Do not announce keepalive records
5900         }
5901         else
5902         {
5903             // announceCount < 0 indicates default announce count should be used
5904             if (announceCount < 0)
5905                 announceCount = InitialAnnounceCount;
5906             if (rr->AnnounceCount < (mDNSu8)announceCount)
5907                 rr->AnnounceCount = (mDNSu8)announceCount;
5908         }
5909 
5910         rr->SendNSECNow    = mDNSNULL;
5911         InitializeLastAPTime(m, rr);
5912     }
5913 }
5914 
5915 // ***************************************************************************
5916 #if COMPILER_LIKES_PRAGMA_MARK
5917 #pragma mark -
5918 #pragma mark - Power Management (Sleep/Wake)
5919 #endif
5920 
5921 mDNSexport void mDNS_UpdateAllowSleep(mDNS *const m)
5922 {
5923 #ifndef IDLESLEEPCONTROL_DISABLED
5924     mDNSBool allowSleep = mDNStrue;
5925     char reason[128];
5926 
5927     reason[0] = 0;
5928 
5929     if (m->SystemSleepOnlyIfWakeOnLAN)
5930     {
5931         // Don't sleep if we are a proxy for any services
5932         if (m->ProxyRecords)
5933         {
5934             allowSleep = mDNSfalse;
5935             mDNS_snprintf(reason, sizeof(reason), "sleep proxy for %d records", m->ProxyRecords);
5936             LogInfo("mDNS_UpdateAllowSleep: Sleep disabled because we are proxying %d records", m->ProxyRecords);
5937         }
5938 
5939         if (allowSleep && mDNSCoreHaveAdvertisedMulticastServices(m))
5940         {
5941             // Scan the list of active interfaces
5942             NetworkInterfaceInfo *intf;
5943             for (intf = GetFirstActiveInterface(m->HostInterfaces); intf; intf = GetFirstActiveInterface(intf->next))
5944             {
5945                 if (intf->McastTxRx && !intf->Loopback && !mDNSPlatformInterfaceIsD2D(intf->InterfaceID))
5946                 {
5947                     // Disallow sleep if this interface doesn't support NetWake
5948                     if (!intf->NetWake)
5949                     {
5950                         allowSleep = mDNSfalse;
5951                         mDNS_snprintf(reason, sizeof(reason), "%s does not support NetWake", intf->ifname);
5952                         LogInfo("mDNS_UpdateAllowSleep: Sleep disabled because %s does not support NetWake", intf->ifname);
5953                         break;
5954                     }
5955 
5956                     // If the interface can be an in-NIC Proxy, we should check if it can accomodate all the records
5957                     // that will be offloaded. If not, we should prevent sleep.
5958                     // This check will be possible once the lower layers provide an API to query the space available for offloads on the NIC.
5959 #if APPLE_OSX_mDNSResponder
5960                     if (!SupportsInNICProxy(intf))
5961 #endif
5962                     {
5963                         // Disallow sleep if there is no sleep proxy server
5964                         const CacheRecord *cr = FindSPSInCache1(m, &intf->NetWakeBrowse, mDNSNULL, mDNSNULL);
5965                         if ( cr == mDNSNULL)
5966                         {
5967                             allowSleep = mDNSfalse;
5968                             mDNS_snprintf(reason, sizeof(reason), "No sleep proxy server on %s", intf->ifname);
5969                             LogInfo("mDNS_UpdateAllowSleep: Sleep disabled because %s has no sleep proxy server", intf->ifname);
5970                             break;
5971                         }
5972                         else if (m->SPSType != 0)
5973                         {
5974                             mDNSu32 mymetric = LocalSPSMetric(m);
5975                             mDNSu32 metric   = SPSMetric(cr->resrec.rdata->u.name.c);
5976                             if (metric >= mymetric)
5977                             {
5978                                 allowSleep = mDNSfalse;
5979                                 mDNS_snprintf(reason, sizeof(reason), "No sleep proxy server with better metric on %s", intf->ifname);
5980                                 LogInfo("mDNS_UpdateAllowSleep: Sleep disabled because %s has no sleep proxy server with a better metric", intf->ifname);
5981                                 break;
5982                             }
5983                         }
5984                     }
5985                 }
5986             }
5987         }
5988     }
5989 
5990     // Call the platform code to enable/disable sleep
5991     mDNSPlatformSetAllowSleep(allowSleep, reason);
5992 #else
5993     (void) m;
5994 #endif /* !defined(IDLESLEEPCONTROL_DISABLED) */
5995 }
5996 
5997 mDNSlocal mDNSBool mDNSUpdateOkToSend(mDNS *const m, AuthRecord *rr, NetworkInterfaceInfo *const intf, mDNSu32 scopeid)
5998 {
5999     // If it is not a uDNS record, check to see if the updateid is zero. "updateid" is cleared when we have
6000     // sent the resource record on all the interfaces. If the update id is not zero, check to see if it is time
6001     // to send.
6002     if (AuthRecord_uDNS(rr) || (rr->AuthFlags & AuthFlagsWakeOnly) || mDNSOpaque16IsZero(rr->updateid) ||
6003         m->timenow - (rr->LastAPTime + rr->ThisAPInterval) < 0)
6004     {
6005         return mDNSfalse;
6006     }
6007 
6008     // If we have a pending registration for "scopeid", it is ok to send the update on that interface.
6009     // If the scopeid is too big to check for validity, we don't check against updateIntID. When
6010     // we successfully update on all the interfaces (with whatever set in "rr->updateIntID"), we clear
6011     // updateid and we should have returned from above.
6012     //
6013     // Note: scopeid is the same as intf->InterfaceID. It is passed in so that we don't have to call the
6014     // platform function to extract the value from "intf" every time.
6015 
6016     if ((scopeid >= (sizeof(rr->updateIntID) * mDNSNBBY) || bit_get_opaque64(rr->updateIntID, scopeid)) &&
6017         (!rr->resrec.InterfaceID || rr->resrec.InterfaceID == intf->InterfaceID))
6018         return mDNStrue;
6019 
6020     return mDNSfalse;
6021 }
6022 
6023 mDNSexport void UpdateRMAC(mDNS *const m, void *context)
6024 {
6025     IPAddressMACMapping *addrmap = (IPAddressMACMapping *)context ;
6026     m->CurrentRecord = m->ResourceRecords;
6027 
6028     if (!addrmap)
6029     {
6030         LogMsg("UpdateRMAC: Address mapping is NULL");
6031         return;
6032     }
6033 
6034     while (m->CurrentRecord)
6035     {
6036         AuthRecord *rr = m->CurrentRecord;
6037         // If this is a non-sleep proxy keepalive record and the remote IP address matches, update the RData
6038         if (!rr->WakeUp.HMAC.l[0] && mDNS_KeepaliveRecord(&rr->resrec))
6039         {
6040             mDNSAddr raddr;
6041             getKeepaliveRaddr(m, rr, &raddr);
6042             if (mDNSSameAddress(&raddr, &addrmap->ipaddr))
6043             {
6044                 // Update the MAC address only if it is not a zero MAC address
6045                 mDNSEthAddr macAddr;
6046                 mDNSu8 *ptr = GetValueForMACAddr((mDNSu8 *)(addrmap->ethaddr), (mDNSu8 *) (addrmap->ethaddr + sizeof(addrmap->ethaddr)), &macAddr);
6047                 if (ptr != mDNSNULL && !mDNSEthAddressIsZero(macAddr))
6048                 {
6049                     UpdateKeepaliveRData(m, rr, mDNSNULL, mDNStrue, (char *)(addrmap->ethaddr));
6050                 }
6051             }
6052         }
6053         m->CurrentRecord = rr->next;
6054     }
6055 
6056     if (addrmap)
6057         mDNSPlatformMemFree(addrmap);
6058 
6059 }
6060 
6061 mDNSexport mStatus UpdateKeepaliveRData(mDNS *const m, AuthRecord *rr, NetworkInterfaceInfo *const intf, mDNSBool updateMac, char *ethAddr)
6062 {
6063     mDNSu16 newrdlength;
6064     mDNSAddr laddr = zeroAddr;
6065     mDNSAddr raddr = zeroAddr;
6066     mDNSEthAddr eth = zeroEthAddr;
6067     mDNSIPPort lport = zeroIPPort;
6068     mDNSIPPort rport = zeroIPPort;
6069     mDNSu32 timeout = 0;
6070     mDNSu32 seq = 0;
6071     mDNSu32 ack = 0;
6072     mDNSu16 win = 0;
6073     UTF8str255 txt;
6074     int rdsize;
6075     RData *newrd;
6076     mDNSTCPInfo mti;
6077     mStatus ret;
6078 
6079     // Note: If we fail to update the  DNS NULL  record with additional information in this function, it will be registered
6080     // with the SPS like any other record. SPS will not send keepalives if it does not have additional information.
6081     mDNS_ExtractKeepaliveInfo(rr, &timeout, &laddr, &raddr, &eth, &seq, &ack, &lport, &rport, &win);
6082     if (!timeout || mDNSAddressIsZero(&laddr) || mDNSAddressIsZero(&raddr) || mDNSIPPortIsZero(lport) || mDNSIPPortIsZero(rport))
6083     {
6084         LogMsg("UpdateKeepaliveRData: not a valid record %s for keepalive %#a:%d %#a:%d", ARDisplayString(m, rr), &laddr, lport.NotAnInteger, &raddr, rport.NotAnInteger);
6085         return mStatus_UnknownErr;
6086     }
6087 
6088     if (updateMac)
6089     {
6090         if (laddr.type == mDNSAddrType_IPv4)
6091             newrdlength = mDNS_snprintf((char *)&txt.c[1], sizeof(txt.c) - 1, "t=%d i=%d c=%d h=%#a d=%#a l=%u r=%u m=%s", timeout, kKeepaliveRetryInterval, kKeepaliveRetryCount, &laddr, &raddr, mDNSVal16(lport), mDNSVal16(rport), ethAddr);
6092         else
6093             newrdlength = mDNS_snprintf((char *)&txt.c[1], sizeof(txt.c) - 1, "t=%d i=%d c=%d H=%#a D=%#a l=%u r=%u m=%s", timeout, kKeepaliveRetryInterval, kKeepaliveRetryCount, &laddr, &raddr,  mDNSVal16(lport), mDNSVal16(rport), ethAddr);
6094 
6095     }
6096     else
6097     {
6098         // If this keepalive packet would be sent on a different interface than the current one that we are processing
6099         // now, then we don't update the DNS NULL record. But we do not prevent it from registering with the SPS. When SPS sees
6100         // this DNS NULL record, it does not send any keepalives as it does not have all the information
6101         mDNSPlatformMemZero(&mti, sizeof (mDNSTCPInfo));
6102         ret = mDNSPlatformRetrieveTCPInfo(&laddr, &lport, &raddr, &rport, &mti);
6103         if (ret != mStatus_NoError)
6104         {
6105             LogMsg("mDNSPlatformRetrieveTCPInfo: mDNSPlatformRetrieveTCPInfo failed %d", ret);
6106             return ret;
6107         }
6108         if ((intf != mDNSNULL) && (mti.IntfId != intf->InterfaceID))
6109         {
6110             LogInfo("mDNSPlatformRetrieveTCPInfo: InterfaceID mismatch mti.IntfId = %p InterfaceID = %p",  mti.IntfId, intf->InterfaceID);
6111             return mStatus_BadParamErr;
6112         }
6113 
6114         if (laddr.type == mDNSAddrType_IPv4)
6115             newrdlength = mDNS_snprintf((char *)&txt.c[1], sizeof(txt.c) - 1, "t=%d i=%d c=%d h=%#a d=%#a l=%u r=%u m=%.6a s=%u a=%u w=%u", timeout, kKeepaliveRetryInterval, kKeepaliveRetryCount, &laddr, &raddr, mDNSVal16(lport), mDNSVal16(rport), &eth, mti.seq, mti.ack, mti.window);
6116         else
6117             newrdlength = mDNS_snprintf((char *)&txt.c[1], sizeof(txt.c) - 1, "t=%d i=%d c=%d H=%#a D=%#a l=%u r=%u m=%.6a s=%u a=%u w=%u", timeout, kKeepaliveRetryInterval, kKeepaliveRetryCount, &laddr, &raddr, mDNSVal16(lport), mDNSVal16(rport), &eth, mti.seq, mti.ack, mti.window);
6118     }
6119 
6120     // Did we insert a null byte at the end ?
6121     if (newrdlength == (sizeof(txt.c) - 1))
6122     {
6123         LogMsg("UpdateKeepaliveRData: could not allocate memory %s", ARDisplayString(m, rr));
6124         return mStatus_NoMemoryErr;
6125     }
6126 
6127     // Include the length for the null byte at the end
6128     txt.c[0] = newrdlength + 1;
6129     // Account for the first length byte and the null byte at the end
6130     newrdlength += 2;
6131 
6132     rdsize = newrdlength > sizeof(RDataBody) ? newrdlength : sizeof(RDataBody);
6133     newrd = mDNSPlatformMemAllocate(sizeof(RData) - sizeof(RDataBody) + rdsize);
6134     if (!newrd) { LogMsg("UpdateKeepaliveRData: ptr NULL"); return mStatus_NoMemoryErr; }
6135 
6136     newrd->MaxRDLength = (mDNSu16) rdsize;
6137     mDNSPlatformMemCopy(&newrd->u, txt.c, newrdlength);
6138 
6139     //  If we are updating the record for the first time, rdata points to rdatastorage as the rdata memory
6140     //  was allocated as part of the AuthRecord itself. We allocate memory when we update the AuthRecord.
6141     //  If the resource record has data that we allocated in a previous pass (to update MAC address),
6142     //  free that memory here before copying in the new data.
6143     if ( rr->resrec.rdata != &rr->rdatastorage)
6144     {
6145         LogSPS("UpdateKeepaliveRData: Freed allocated memory for keep alive packet: %s ", ARDisplayString(m, rr));
6146         mDNSPlatformMemFree(rr->resrec.rdata);
6147     }
6148     SetNewRData(&rr->resrec, newrd, newrdlength);    // Update our rdata
6149 
6150     LogSPS("UpdateKeepaliveRData: successfully updated the record %s", ARDisplayString(m, rr));
6151     return mStatus_NoError;
6152 }
6153 
6154 mDNSlocal void SendSPSRegistrationForOwner(mDNS *const m, NetworkInterfaceInfo *const intf, const mDNSOpaque16 id, const OwnerOptData *const owner)
6155 {
6156     const int optspace = DNSOpt_Header_Space + DNSOpt_LeaseData_Space + DNSOpt_Owner_Space(&m->PrimaryMAC, &intf->MAC);
6157     const int sps = intf->NextSPSAttempt / 3;
6158     AuthRecord *rr;
6159     mDNSOpaque16 msgid;
6160     mDNSu32 scopeid;
6161 
6162     scopeid = mDNSPlatformInterfaceIndexfromInterfaceID(m, intf->InterfaceID, mDNStrue);
6163     if (!intf->SPSAddr[sps].type)
6164     {
6165         intf->NextSPSAttemptTime = m->timenow + mDNSPlatformOneSecond;
6166         if (m->NextScheduledSPRetry - intf->NextSPSAttemptTime > 0)
6167             m->NextScheduledSPRetry = intf->NextSPSAttemptTime;
6168         LogSPS("SendSPSRegistration: %s SPS %d (%d) %##s not yet resolved", intf->ifname, intf->NextSPSAttempt, sps, intf->NetWakeResolve[sps].qname.c);
6169         goto exit;
6170     }
6171 
6172     // Mark our mDNS records (not unicast records) for transfer to SPS
6173     if (mDNSOpaque16IsZero(id))
6174     {
6175         // We may have to register this record over multiple interfaces and we don't want to
6176         // overwrite the id. We send the registration over interface X with id "IDX" and before
6177         // we get a response, we overwrite with id "IDY" for interface Y and we won't accept responses
6178         // for "IDX". Hence, we want to use the same ID across all interfaces.
6179         //
6180         // In the case of sleep proxy server transfering its records when it goes to sleep, the owner
6181         // option check below will set the same ID across the records from the same owner. Records
6182         // with different owner option gets different ID.
6183         msgid = mDNS_NewMessageID(m);
6184         for (rr = m->ResourceRecords; rr; rr=rr->next)
6185         {
6186             if (!(rr->AuthFlags & AuthFlagsWakeOnly) && rr->resrec.RecordType > kDNSRecordTypeDeregistering)
6187             {
6188                 if (rr->resrec.InterfaceID == intf->InterfaceID || (!rr->resrec.InterfaceID && (rr->ForceMCast || IsLocalDomain(rr->resrec.name))))
6189                 {
6190                     if (mDNSPlatformMemSame(owner, &rr->WakeUp, sizeof(*owner)))
6191                     {
6192                         rr->SendRNow = mDNSInterfaceMark;   // mark it now
6193                         // When we are registering on the first interface, rr->updateid is zero in which case
6194                         // initialize with the new ID. For subsequent interfaces, we want to use the same ID.
6195                         // At the end, all the updates sent across all the interfaces with the same ID.
6196                         if (mDNSOpaque16IsZero(rr->updateid))
6197                             rr->updateid = msgid;
6198                         else
6199                             msgid = rr->updateid;
6200                     }
6201                 }
6202             }
6203         }
6204     }
6205     else
6206         msgid = id;
6207 
6208     while (1)
6209     {
6210         mDNSu8 *p = m->omsg.data;
6211         // To comply with RFC 2782, PutResourceRecord suppresses name compression for SRV records in unicast updates.
6212         // For now we follow that same logic for SPS registrations too.
6213         // If we decide to compress SRV records in SPS registrations in the future, we can achieve that by creating our
6214         // initial DNSMessage with h.flags set to zero, and then update it to UpdateReqFlags right before sending the packet.
6215         InitializeDNSMessage(&m->omsg.h, msgid, UpdateReqFlags);
6216 
6217         for (rr = m->ResourceRecords; rr; rr=rr->next)
6218             if (rr->SendRNow || mDNSUpdateOkToSend(m, rr, intf, scopeid))
6219             {
6220                 if (mDNSPlatformMemSame(owner, &rr->WakeUp, sizeof(*owner)))
6221                 {
6222                     mDNSu8 *newptr;
6223                     const mDNSu8 *const limit = m->omsg.data + (m->omsg.h.mDNS_numUpdates ? NormalMaxDNSMessageData : AbsoluteMaxDNSMessageData) - optspace;
6224 
6225                     // If we can't update the keepalive record, don't send it
6226                     if (mDNS_KeepaliveRecord(&rr->resrec) && (UpdateKeepaliveRData(m, rr, intf, mDNSfalse, mDNSNULL) != mStatus_NoError))
6227                     {
6228                         if (scopeid < (sizeof(rr->updateIntID) * mDNSNBBY))
6229                         {
6230                             bit_clr_opaque64(rr->updateIntID, scopeid);
6231                         }
6232                         rr->SendRNow = mDNSNULL;
6233                         continue;
6234                     }
6235 
6236                     if (rr->resrec.RecordType & kDNSRecordTypeUniqueMask)
6237                         rr->resrec.rrclass |= kDNSClass_UniqueRRSet;    // Temporarily set the 'unique' bit so PutResourceRecord will set it
6238                     newptr = PutResourceRecordTTLWithLimit(&m->omsg, p, &m->omsg.h.mDNS_numUpdates, &rr->resrec, rr->resrec.rroriginalttl, limit);
6239                     rr->resrec.rrclass &= ~kDNSClass_UniqueRRSet;       // Make sure to clear 'unique' bit back to normal state
6240                     if (!newptr)
6241                         LogSPS("SendSPSRegistration put %s FAILED %d/%d %s", intf->ifname, p - m->omsg.data, limit - m->omsg.data, ARDisplayString(m, rr));
6242                     else
6243                     {
6244                         LogSPS("SendSPSRegistration put %s 0x%x 0x%x (updateid %d)  %s", intf->ifname, rr->updateIntID.l[1], rr->updateIntID.l[0], mDNSVal16(m->omsg.h.id), ARDisplayString(m, rr));
6245                         rr->SendRNow       = mDNSNULL;
6246                         rr->ThisAPInterval = mDNSPlatformOneSecond;
6247                         rr->LastAPTime     = m->timenow;
6248                         // should be initialized above
6249                         if (mDNSOpaque16IsZero(rr->updateid)) LogMsg("SendSPSRegistration: ERROR!! rr %s updateid is zero", ARDisplayString(m, rr));
6250                         if (m->NextScheduledResponse - (rr->LastAPTime + rr->ThisAPInterval) >= 0)
6251                             m->NextScheduledResponse = (rr->LastAPTime + rr->ThisAPInterval);
6252                         p = newptr;
6253                     }
6254                 }
6255             }
6256 
6257         if (!m->omsg.h.mDNS_numUpdates) break;
6258         else
6259         {
6260             AuthRecord opt;
6261             mDNS_SetupResourceRecord(&opt, mDNSNULL, mDNSInterface_Any, kDNSType_OPT, kStandardTTL, kDNSRecordTypeKnownUnique, AuthRecordAny, mDNSNULL, mDNSNULL);
6262             opt.resrec.rrclass    = NormalMaxDNSMessageData;
6263             opt.resrec.rdlength   = sizeof(rdataOPT) * 2;   // Two options in this OPT record
6264             opt.resrec.rdestimate = sizeof(rdataOPT) * 2;
6265             opt.resrec.rdata->u.opt[0].opt           = kDNSOpt_Lease;
6266             opt.resrec.rdata->u.opt[0].optlen        = DNSOpt_LeaseData_Space - 4;
6267             opt.resrec.rdata->u.opt[0].u.updatelease = DEFAULT_UPDATE_LEASE;
6268             if (!owner->HMAC.l[0])                                          // If no owner data,
6269                 SetupOwnerOpt(m, intf, &opt.resrec.rdata->u.opt[1]);        // use our own interface information
6270             else                                                            // otherwise, use the owner data we were given
6271             {
6272                 opt.resrec.rdata->u.opt[1].u.owner = *owner;
6273                 opt.resrec.rdata->u.opt[1].opt     = kDNSOpt_Owner;
6274                 opt.resrec.rdata->u.opt[1].optlen  = DNSOpt_Owner_Space(&owner->HMAC, &owner->IMAC) - 4;
6275             }
6276             LogSPS("SendSPSRegistration put %s %s", intf->ifname, ARDisplayString(m, &opt));
6277             p = PutResourceRecordTTLWithLimit(&m->omsg, p, &m->omsg.h.numAdditionals, &opt.resrec, opt.resrec.rroriginalttl, m->omsg.data + AbsoluteMaxDNSMessageData);
6278             if (!p)
6279                 LogMsg("SendSPSRegistration: Failed to put OPT record (%d updates) %s", m->omsg.h.mDNS_numUpdates, ARDisplayString(m, &opt));
6280             else
6281             {
6282                 mStatus err;
6283 
6284                 LogSPS("SendSPSRegistration: Sending Update %s %d (%d) id %5d with %d records %d bytes to %#a:%d", intf->ifname, intf->NextSPSAttempt, sps,
6285                        mDNSVal16(m->omsg.h.id), m->omsg.h.mDNS_numUpdates, p - m->omsg.data, &intf->SPSAddr[sps], mDNSVal16(intf->SPSPort[sps]));
6286                 // if (intf->NextSPSAttempt < 5) m->omsg.h.flags = zeroID;  // For simulating packet loss
6287                 err = mDNSSendDNSMessage(m, &m->omsg, p, intf->InterfaceID, mDNSNULL, &intf->SPSAddr[sps], intf->SPSPort[sps], mDNSNULL, mDNSNULL, mDNSfalse);
6288                 if (err) LogSPS("SendSPSRegistration: mDNSSendDNSMessage err %d", err);
6289                 if (err && intf->SPSAddr[sps].type == mDNSAddrType_IPv4 && intf->NetWakeResolve[sps].ThisQInterval == -1)
6290                 {
6291                     LogSPS("SendSPSRegistration %d %##s failed to send to IPv4 address; will try IPv6 instead", sps, intf->NetWakeResolve[sps].qname.c);
6292                     intf->NetWakeResolve[sps].qtype = kDNSType_AAAA;
6293                     mDNS_StartQuery_internal(m, &intf->NetWakeResolve[sps]);
6294                     return;
6295                 }
6296             }
6297         }
6298     }
6299 
6300     intf->NextSPSAttemptTime = m->timenow + mDNSPlatformOneSecond * 10;     // If successful, update NextSPSAttemptTime
6301 
6302 exit:
6303     if (mDNSOpaque16IsZero(id) && intf->NextSPSAttempt < 8) intf->NextSPSAttempt++;
6304 }
6305 
6306 mDNSlocal mDNSBool RecordIsFirstOccurrenceOfOwner(mDNS *const m, const AuthRecord *const rr)
6307 {
6308     AuthRecord *ar;
6309     for (ar = m->ResourceRecords; ar && ar != rr; ar=ar->next)
6310         if (mDNSPlatformMemSame(&rr->WakeUp, &ar->WakeUp, sizeof(rr->WakeUp))) return mDNSfalse;
6311     return mDNStrue;
6312 }
6313 
6314 mDNSlocal void mDNSCoreStoreProxyRR(mDNS *const m, const mDNSInterfaceID InterfaceID, AuthRecord *const rr)
6315 {
6316     AuthRecord *newRR = mDNSPlatformMemAllocate(sizeof(AuthRecord));
6317 
6318     if (newRR == mDNSNULL)
6319     {
6320         LogSPS("%s : could not allocate memory for new resource record", __func__);
6321         return;
6322     }
6323 
6324     mDNSPlatformMemZero(newRR, sizeof(AuthRecord));
6325     mDNS_SetupResourceRecord(newRR, mDNSNULL, InterfaceID, rr->resrec.rrtype,
6326                              rr->resrec.rroriginalttl, rr->resrec.RecordType,
6327                              rr->ARType, mDNSNULL, mDNSNULL);
6328 
6329     AssignDomainName(&newRR->namestorage, &rr->namestorage);
6330     newRR->resrec.rdlength = DomainNameLength(rr->resrec.name);
6331     newRR->resrec.namehash = DomainNameHashValue(newRR->resrec.name);
6332     newRR->resrec.rrclass  = rr->resrec.rrclass;
6333 
6334     if (rr->resrec.rrtype == kDNSType_A)
6335     {
6336         newRR->resrec.rdata->u.ipv4 =  rr->resrec.rdata->u.ipv4;
6337     }
6338     else if (rr->resrec.rrtype == kDNSType_AAAA)
6339     {
6340         newRR->resrec.rdata->u.ipv6 = rr->resrec.rdata->u.ipv6;
6341     }
6342     SetNewRData(&newRR->resrec, mDNSNULL, 0);
6343 
6344     // Insert the new node at the head of the list.
6345     newRR->next        = m->SPSRRSet;
6346     m->SPSRRSet        = newRR;
6347     LogSPS("%s : Storing proxy record : %s ", __func__, ARDisplayString(m, rr));
6348 }
6349 
6350 // Some records are interface specific and some are not. The ones that are supposed to be registered
6351 // on multiple interfaces need to be initialized with all the valid interfaces on which it will be sent.
6352 // updateIntID bit field tells us on which interfaces we need to register this record. When we get an
6353 // ack from the sleep proxy server, we clear the interface bit. This way, we know when a record completes
6354 // registration on all the interfaces
6355 mDNSlocal void SPSInitRecordsBeforeUpdate(mDNS *const m, mDNSOpaque64 updateIntID, mDNSBool *WakeOnlyService)
6356 {
6357     AuthRecord *ar;
6358     LogSPS("SPSInitRecordsBeforeUpdate: UpdateIntID 0x%x 0x%x", updateIntID.l[1], updateIntID.l[0]);
6359 
6360     *WakeOnlyService = mDNSfalse;
6361 
6362     // Before we store the A and AAAA records that we are going to register with the sleep proxy,
6363     // make sure that the old sleep proxy records are removed.
6364     mDNSCoreFreeProxyRR(m);
6365 
6366     // For records that are registered only on a specific interface, mark only that bit as it will
6367     // never be registered on any other interface. For others, it should be sent on all interfaces.
6368     for (ar = m->ResourceRecords; ar; ar=ar->next)
6369     {
6370         ar->updateIntID = zeroOpaque64;
6371         ar->updateid    = zeroID;
6372         if (AuthRecord_uDNS(ar))
6373         {
6374             continue;
6375         }
6376         if (ar->AuthFlags & AuthFlagsWakeOnly)
6377         {
6378             if (ar->resrec.RecordType == kDNSRecordTypeShared && ar->RequireGoodbye)
6379             {
6380                 ar->ImmedAnswer = mDNSInterfaceMark;
6381                 *WakeOnlyService = mDNStrue;
6382                 continue;
6383             }
6384         }
6385         if (!ar->resrec.InterfaceID)
6386         {
6387             LogSPS("Setting scopeid (ALL) 0x%x 0x%x for %s", updateIntID.l[1], updateIntID.l[0], ARDisplayString(m, ar));
6388             ar->updateIntID = updateIntID;
6389         }
6390         else
6391         {
6392             // Filter records that belong to interfaces that we won't register the records on. UpdateIntID captures
6393             // exactly this.
6394             mDNSu32 scopeid = mDNSPlatformInterfaceIndexfromInterfaceID(m, ar->resrec.InterfaceID, mDNStrue);
6395             if ((scopeid < (sizeof(updateIntID) * mDNSNBBY)) && bit_get_opaque64(updateIntID, scopeid))
6396             {
6397                 bit_set_opaque64(ar->updateIntID, scopeid);
6398                 LogSPS("SPSInitRecordsBeforeUpdate: Setting scopeid(%d) 0x%x 0x%x for %s", scopeid, ar->updateIntID.l[1],
6399                     ar->updateIntID.l[0], ARDisplayString(m, ar));
6400             }
6401             else
6402             {
6403                 LogSPS("SPSInitRecordsBeforeUpdate: scopeid %d beyond range or not valid for SPS registration", scopeid);
6404             }
6405         }
6406         // Store the A and AAAA records that we registered with the sleep proxy.
6407         // We will use this to prevent spurious name conflicts that may occur when we wake up
6408         if (ar->resrec.rrtype == kDNSType_A || ar->resrec.rrtype == kDNSType_AAAA)
6409         {
6410             mDNSCoreStoreProxyRR(m, ar->resrec.InterfaceID, ar);
6411         }
6412     }
6413 }
6414 
6415 mDNSlocal void SendSPSRegistration(mDNS *const m, NetworkInterfaceInfo *const intf, const mDNSOpaque16 id)
6416 {
6417     AuthRecord *ar;
6418     OwnerOptData owner = zeroOwner;
6419 
6420     SendSPSRegistrationForOwner(m, intf, id, &owner);
6421 
6422     for (ar = m->ResourceRecords; ar; ar=ar->next)
6423     {
6424         if (!mDNSPlatformMemSame(&owner, &ar->WakeUp, sizeof(owner)) && RecordIsFirstOccurrenceOfOwner(m, ar))
6425         {
6426             owner = ar->WakeUp;
6427             SendSPSRegistrationForOwner(m, intf, id, &owner);
6428         }
6429     }
6430 }
6431 
6432 // RetrySPSRegistrations is called from SendResponses, with the lock held
6433 mDNSlocal void RetrySPSRegistrations(mDNS *const m)
6434 {
6435     AuthRecord *rr;
6436     NetworkInterfaceInfo *intf;
6437 
6438     // First make sure none of our interfaces' NextSPSAttemptTimes are inadvertently set to m->timenow + mDNSPlatformOneSecond * 10
6439     for (intf = GetFirstActiveInterface(m->HostInterfaces); intf; intf = GetFirstActiveInterface(intf->next))
6440         if (intf->NextSPSAttempt && intf->NextSPSAttemptTime == m->timenow + mDNSPlatformOneSecond * 10)
6441             intf->NextSPSAttemptTime++;
6442 
6443     // Retry any record registrations that are due
6444     for (rr = m->ResourceRecords; rr; rr=rr->next)
6445         if (!AuthRecord_uDNS(rr) && !mDNSOpaque16IsZero(rr->updateid) && m->timenow - (rr->LastAPTime + rr->ThisAPInterval) >= 0)
6446         {
6447             for (intf = GetFirstActiveInterface(m->HostInterfaces); intf; intf = GetFirstActiveInterface(intf->next))
6448             {
6449                 // If we still have registrations pending on this interface, send it now
6450                 mDNSu32 scopeid = mDNSPlatformInterfaceIndexfromInterfaceID(m, intf->InterfaceID, mDNStrue);
6451                 if ((scopeid >= (sizeof(rr->updateIntID) * mDNSNBBY) || bit_get_opaque64(rr->updateIntID, scopeid)) &&
6452                     (!rr->resrec.InterfaceID || rr->resrec.InterfaceID == intf->InterfaceID))
6453                 {
6454                     LogSPS("RetrySPSRegistrations: 0x%x 0x%x (updateid %d) %s", rr->updateIntID.l[1], rr->updateIntID.l[0], mDNSVal16(rr->updateid), ARDisplayString(m, rr));
6455                     SendSPSRegistration(m, intf, rr->updateid);
6456                 }
6457             }
6458         }
6459 
6460     // For interfaces where we did an SPS registration attempt, increment intf->NextSPSAttempt
6461     for (intf = GetFirstActiveInterface(m->HostInterfaces); intf; intf = GetFirstActiveInterface(intf->next))
6462         if (intf->NextSPSAttempt && intf->NextSPSAttemptTime == m->timenow + mDNSPlatformOneSecond * 10 && intf->NextSPSAttempt < 8)
6463             intf->NextSPSAttempt++;
6464 }
6465 
6466 mDNSlocal void NetWakeResolve(mDNS *const m, DNSQuestion *question, const ResourceRecord *const answer, QC_result AddRecord)
6467 {
6468     NetworkInterfaceInfo *intf = (NetworkInterfaceInfo *)question->QuestionContext;
6469     int sps = (int)(question - intf->NetWakeResolve);
6470     (void)m;            // Unused
6471     LogSPS("NetWakeResolve: SPS: %d Add: %d %s", sps, AddRecord, RRDisplayString(m, answer));
6472 
6473     if (!AddRecord) return;                                             // Don't care about REMOVE events
6474     if (answer->rrtype != question->qtype) return;                      // Don't care about CNAMEs
6475 
6476     // if (answer->rrtype == kDNSType_AAAA && sps == 0) return; // To test failing to resolve sleep proxy's address
6477 
6478     if (answer->rrtype == kDNSType_SRV)
6479     {
6480         // 1. Got the SRV record; now look up the target host's IP address
6481         mDNS_StopQuery(m, question);
6482         intf->SPSPort[sps] = answer->rdata->u.srv.port;
6483         AssignDomainName(&question->qname, &answer->rdata->u.srv.target);
6484         question->qtype = kDNSType_A;
6485         mDNS_StartQuery(m, question);
6486     }
6487     else if (answer->rrtype == kDNSType_A && answer->rdlength == sizeof(mDNSv4Addr))
6488     {
6489         // 2. Got an IPv4 address for the target host; record address and initiate an SPS registration if appropriate
6490         mDNS_StopQuery(m, question);
6491         question->ThisQInterval = -1;
6492         intf->SPSAddr[sps].type = mDNSAddrType_IPv4;
6493         intf->SPSAddr[sps].ip.v4 = answer->rdata->u.ipv4;
6494         mDNS_Lock(m);
6495         if (sps == intf->NextSPSAttempt/3) SendSPSRegistration(m, intf, zeroID);    // If we're ready for this result, use it now
6496         mDNS_Unlock(m);
6497     }
6498     else if (answer->rrtype == kDNSType_A && answer->rdlength == 0)
6499     {
6500         // 3. Got negative response -- target host apparently has IPv6 disabled -- so try looking up the target host's IPv4 address(es) instead
6501         mDNS_StopQuery(m, question);
6502         LogSPS("NetWakeResolve: SPS %d %##s has no IPv4 address, will try IPv6 instead", sps, question->qname.c);
6503         question->qtype = kDNSType_AAAA;
6504         mDNS_StartQuery(m, question);
6505     }
6506     else if (answer->rrtype == kDNSType_AAAA && answer->rdlength == sizeof(mDNSv6Addr) && mDNSv6AddressIsLinkLocal(&answer->rdata->u.ipv6))
6507     {
6508         // 4. Got the target host's IPv6 link-local address; record address and initiate an SPS registration if appropriate
6509         mDNS_StopQuery(m, question);
6510         question->ThisQInterval = -1;
6511         intf->SPSAddr[sps].type = mDNSAddrType_IPv6;
6512         intf->SPSAddr[sps].ip.v6 = answer->rdata->u.ipv6;
6513         mDNS_Lock(m);
6514         if (sps == intf->NextSPSAttempt/3) SendSPSRegistration(m, intf, zeroID);    // If we're ready for this result, use it now
6515         mDNS_Unlock(m);
6516     }
6517 }
6518 
6519 mDNSexport mDNSBool mDNSCoreHaveAdvertisedMulticastServices(mDNS *const m)
6520 {
6521     AuthRecord *rr;
6522     for (rr = m->ResourceRecords; rr; rr=rr->next)
6523         if (mDNS_KeepaliveRecord(&rr->resrec) || (rr->resrec.rrtype == kDNSType_SRV && !AuthRecord_uDNS(rr) && !mDNSSameIPPort(rr->resrec.rdata->u.srv.port, DiscardPort)))
6524             return mDNStrue;
6525     return mDNSfalse;
6526 }
6527 
6528 #define WAKE_ONLY_SERVICE 1
6529 #define AC_ONLY_SERVICE   2
6530 
6531 #ifdef APPLE_OSX_mDNSResponder
6532 mDNSlocal void SendGoodbyesForSelectServices(mDNS *const m, mDNSBool *servicePresent, mDNSu32 serviceType)
6533 {
6534     AuthRecord *rr;
6535     *servicePresent = mDNSfalse;
6536 
6537     // Mark all the records we need to deregister and send them
6538     for (rr = m->ResourceRecords; rr; rr=rr->next)
6539     {
6540         // If the service type is wake only service and the auth flags match and requires a goodbye
6541         // OR if the service type is AC only and it is not a keepalive record,
6542         // mark the records we need to deregister and send them
6543         if ((serviceType == WAKE_ONLY_SERVICE && (rr->AuthFlags & AuthFlagsWakeOnly) &&
6544                 rr->resrec.RecordType == kDNSRecordTypeShared && rr->RequireGoodbye) ||
6545             (serviceType == AC_ONLY_SERVICE && !mDNS_KeepaliveRecord(&rr->resrec)))
6546         {
6547             rr->ImmedAnswer = mDNSInterfaceMark;
6548             *servicePresent = mDNStrue;
6549         }
6550     }
6551 }
6552 #endif
6553 
6554 #ifdef APPLE_OSX_mDNSResponder
6555 // This function is used only in the case of local NIC proxy. For external
6556 // sleep proxy server, we do this in SPSInitRecordsBeforeUpdate when we
6557 // walk the resource records.
6558 mDNSlocal void SendGoodbyesForWakeOnlyService(mDNS *const m, mDNSBool *WakeOnlyService)
6559 {
6560     return SendGoodbyesForSelectServices(m, WakeOnlyService, WAKE_ONLY_SERVICE);
6561 }
6562 #endif // APPLE_OSX_mDNSResponder
6563 
6564 
6565 mDNSlocal void SendSleepGoodbyes(mDNS *const m, mDNSBool AllInterfaces, mDNSBool unicast)
6566 {
6567     AuthRecord *rr;
6568     m->SleepState = SleepState_Sleeping;
6569 
6570     // If AllInterfaces is not set, the caller has already marked it appropriately
6571     // on which interfaces this should be sent.
6572     if (AllInterfaces)
6573     {
6574         NetworkInterfaceInfo *intf;
6575         for (intf = GetFirstActiveInterface(m->HostInterfaces); intf; intf = GetFirstActiveInterface(intf->next))
6576         {
6577             intf->SendGoodbyes = 1;
6578         }
6579     }
6580     if (unicast)
6581     {
6582 #ifndef UNICAST_DISABLED
6583         SleepRecordRegistrations(m);    // If we have no SPS, need to deregister our uDNS records
6584 #endif /* UNICAST_DISABLED */
6585     }
6586 
6587     // Mark all the records we need to deregister and send them
6588     for (rr = m->ResourceRecords; rr; rr=rr->next)
6589         if (rr->resrec.RecordType == kDNSRecordTypeShared && rr->RequireGoodbye)
6590             rr->ImmedAnswer = mDNSInterfaceMark;
6591     SendResponses(m);
6592 }
6593 
6594 /*
6595  * This function attempts to detect if multiple interfaces are on the same subnet.
6596  * It makes this determination based only on the IPv4 Addresses and subnet masks.
6597  * IPv6 link local addresses that are configured by default on all interfaces make
6598  * it hard to make this determination
6599  *
6600  * The 'real' fix for this would be to send out multicast packets over one interface
6601  * and conclude that multiple interfaces are on the same subnet only if these packets
6602  * are seen on other interfaces on the same system
6603  */
6604 mDNSlocal mDNSBool skipSameSubnetRegistration(mDNS *const m, mDNSInterfaceID *regID, mDNSu32 count, mDNSInterfaceID intfid)
6605 {
6606     NetworkInterfaceInfo *intf;
6607     NetworkInterfaceInfo *newIntf;
6608     mDNSu32 i;
6609 
6610     for (newIntf = FirstInterfaceForID(m, intfid); newIntf; newIntf = newIntf->next)
6611     {
6612         if ((newIntf->InterfaceID != intfid) ||
6613             (newIntf->ip.type     != mDNSAddrType_IPv4))
6614         {
6615             continue;
6616         }
6617         for ( i = 0; i < count; i++)
6618         {
6619             for (intf = FirstInterfaceForID(m, regID[i]); intf; intf = intf->next)
6620             {
6621                 if ((intf->InterfaceID != regID[i]) ||
6622                     (intf->ip.type     != mDNSAddrType_IPv4))
6623                 {
6624                     continue;
6625                 }
6626                 if ((intf->ip.ip.v4.NotAnInteger & intf->mask.ip.v4.NotAnInteger) == (newIntf->ip.ip.v4.NotAnInteger & newIntf->mask.ip.v4.NotAnInteger))
6627                 {
6628                     LogSPS("%s : Already registered for the same subnet (IPv4) for interface %s", __func__, intf->ifname);
6629                     return (mDNStrue);
6630                 }
6631             }
6632         }
6633     }
6634     return (mDNSfalse);
6635 }
6636 
6637 mDNSlocal void DoKeepaliveCallbacks(mDNS *m)
6638 {
6639     // Loop through the keepalive records and callback with an error
6640     m->CurrentRecord = m->ResourceRecords;
6641     while (m->CurrentRecord)
6642     {
6643         AuthRecord *const rr = m->CurrentRecord;
6644         if ((mDNS_KeepaliveRecord(&rr->resrec)) && (rr->resrec.RecordType != kDNSRecordTypeDeregistering))
6645         {
6646             LogSPS("DoKeepaliveCallbacks: Invoking the callback for %s", ARDisplayString(m, rr));
6647             if (rr->RecordCallback)
6648                 rr->RecordCallback(m, rr, mStatus_BadStateErr);
6649         }
6650         if (m->CurrentRecord == rr) // If m->CurrentRecord was not advanced for us, do it now
6651             m->CurrentRecord = rr->next;
6652     }
6653 }
6654 
6655 // BeginSleepProcessing is called, with the lock held, from either mDNS_Execute or mDNSCoreMachineSleep
6656 mDNSlocal void BeginSleepProcessing(mDNS *const m)
6657 {
6658     mDNSBool SendGoodbyes = mDNStrue;
6659     mDNSBool WakeOnlyService  = mDNSfalse;
6660     mDNSBool invokeKACallback = mDNStrue;
6661     const CacheRecord *sps[3] = { mDNSNULL };
6662     mDNSOpaque64 updateIntID = zeroOpaque64;
6663     mDNSInterfaceID registeredIntfIDS[128] = { 0 };
6664     mDNSu32 registeredCount = 0;
6665     int skippedRegistrations = 0;
6666 
6667     m->NextScheduledSPRetry = m->timenow;
6668 
6669     // Clear out the SCDynamic entry that stores the external SPS information
6670     mDNSPlatformClearSPSData();
6671 
6672     if      (!m->SystemWakeOnLANEnabled) LogSPS("BeginSleepProcessing: m->SystemWakeOnLANEnabled is false");
6673     else if (!mDNSCoreHaveAdvertisedMulticastServices(m)) LogSPS("BeginSleepProcessing: No advertised services");
6674     else    // If we have at least one advertised service
6675     {
6676         NetworkInterfaceInfo *intf;
6677         for (intf = GetFirstActiveInterface(m->HostInterfaces); intf; intf = GetFirstActiveInterface(intf->next))
6678         {
6679             mDNSBool skipFullSleepProxyRegistration = mDNSfalse;
6680             // Intialize it to false. These values make sense only when SleepState is set to Sleeping.
6681             intf->SendGoodbyes = 0;
6682 
6683             // If it is not multicast capable, we could not have possibly discovered sleep proxy
6684             // servers.
6685             if (!intf->McastTxRx || mDNSPlatformInterfaceIsD2D(intf->InterfaceID))
6686             {
6687                 LogSPS("BeginSleepProcessing: %-6s Ignoring for registrations", intf->ifname);
6688                 continue;
6689             }
6690 
6691             // If we are not capable of WOMP, then don't register with sleep proxy.
6692             //
6693             // Note: If we are not NetWake capable, we don't browse for the sleep proxy server.
6694             // We might find sleep proxy servers in the cache and start a resolve on them.
6695             // But then if the interface goes away, we won't stop these questions because
6696             // mDNS_DeactivateNetWake_internal assumes that a browse has been started for it
6697             // to stop both the browse and resolve questions.
6698             if (!intf->NetWake)
6699             {
6700                 LogSPS("BeginSleepProcessing: %-6s not capable of magic packet wakeup", intf->ifname);
6701                 intf->SendGoodbyes = 1;
6702                 skippedRegistrations++;
6703                 continue;
6704             }
6705 
6706             // Check if we have already registered with a sleep proxy for this subnet.
6707             // If so, then the subsequent in-NIC sleep proxy registration is limited to any keepalive records that belong
6708             // to the interface.
6709             if (skipSameSubnetRegistration(m, registeredIntfIDS, registeredCount, intf->InterfaceID))
6710             {
6711                 LogSPS("%s : Skipping full sleep proxy registration on %s", __func__, intf->ifname);
6712                 skipFullSleepProxyRegistration = mDNStrue;
6713             }
6714 
6715 #if APPLE_OSX_mDNSResponder
6716             if (SupportsInNICProxy(intf))
6717             {
6718                 mDNSBool keepaliveOnly = mDNSfalse;
6719                 const mStatus err = ActivateLocalProxy(intf, skipFullSleepProxyRegistration, &keepaliveOnly);
6720                 if (!skipFullSleepProxyRegistration && !err)
6721                 {
6722                     SendGoodbyesForWakeOnlyService(m, &WakeOnlyService);
6723 
6724                     // Send goodbyes for all advertised services if the only record offloaded was the keepalive record.
6725                     SendGoodbyes     = (keepaliveOnly) ? mDNStrue: mDNSfalse;
6726                     invokeKACallback = mDNSfalse;
6727                     LogSPS("BeginSleepProcessing: %-6s using local proxy", intf->ifname);
6728                     // This will leave m->SleepState set to SleepState_Transferring,
6729                     // which is okay because with no outstanding resolves, or updates in flight,
6730                     // mDNSCoreReadyForSleep() will conclude correctly that all the updates have already completed
6731 
6732                     // Setting this flag activates the SleepLimit which delays sleep by 5 seconds and
6733                     // will allow the system to deregister any BTMM records.
6734                     m->NextScheduledSPRetry  = m->timenow + (5 * mDNSPlatformOneSecond);
6735                     registeredIntfIDS[registeredCount] = intf->InterfaceID;
6736                     registeredCount++;
6737                 }
6738                 continue;
6739             }
6740 #endif // APPLE_OSX_mDNSResponder
6741             if (!skipFullSleepProxyRegistration)
6742             {
6743 #if APPLE_OSX_mDNSResponder
6744                 // If on battery, do not attempt to offload to external sleep proxies
6745                 if (m->SystemWakeOnLANEnabled == mDNS_WakeOnBattery)
6746                 {
6747                     LogSPS("BegingSleepProcessing: Not connected to AC power - Not registering with an external sleep proxy.");
6748                     return;
6749                 }
6750 #endif // APPLE_OSX_mDNSResponder
6751                 FindSPSInCache(m, &intf->NetWakeBrowse, sps);
6752                 if (!sps[0]) LogSPS("BeginSleepProcessing: %-6s %#a No Sleep Proxy Server found (Next Browse Q in %d, interval %d)",
6753                                     intf->ifname, &intf->ip, NextQSendTime(&intf->NetWakeBrowse) - m->timenow, intf->NetWakeBrowse.ThisQInterval);
6754                 else
6755                 {
6756                     int i;
6757                     mDNSu32 scopeid;
6758                     SendGoodbyes = mDNSfalse;
6759                     intf->NextSPSAttempt = 0;
6760                     intf->NextSPSAttemptTime = m->timenow + mDNSPlatformOneSecond;
6761 
6762                     scopeid = mDNSPlatformInterfaceIndexfromInterfaceID(m, intf->InterfaceID, mDNStrue);
6763                     // Now we know for sure that we have to wait for registration to complete on this interface.
6764                     if (scopeid < (sizeof(updateIntID) * mDNSNBBY))
6765                         bit_set_opaque64(updateIntID, scopeid);
6766 
6767                     // Don't need to set m->NextScheduledSPRetry here because we already set "m->NextScheduledSPRetry = m->timenow" above
6768                     for (i=0; i<3; i++)
6769                     {
6770 #if ForceAlerts
6771                         if (intf->SPSAddr[i].type)
6772                             LogFatalError("BeginSleepProcessing: %s %d intf->SPSAddr[i].type %d", intf->ifname, i, intf->SPSAddr[i].type);
6773                         if (intf->NetWakeResolve[i].ThisQInterval >= 0)
6774                             LogFatalError("BeginSleepProcessing: %s %d intf->NetWakeResolve[i].ThisQInterval %d", intf->ifname, i, intf->NetWakeResolve[i].ThisQInterval);
6775 #endif
6776                         intf->SPSAddr[i].type = mDNSAddrType_None;
6777                         if (intf->NetWakeResolve[i].ThisQInterval >= 0) mDNS_StopQuery(m, &intf->NetWakeResolve[i]);
6778                         intf->NetWakeResolve[i].ThisQInterval = -1;
6779                         if (sps[i])
6780                         {
6781                             LogSPS("BeginSleepProcessing: %-6s Found Sleep Proxy Server %d TTL %d %s", intf->ifname, i, sps[i]->resrec.rroriginalttl, CRDisplayString(m, sps[i]));
6782                             mDNS_SetupQuestion(&intf->NetWakeResolve[i], intf->InterfaceID, &sps[i]->resrec.rdata->u.name, kDNSType_SRV, NetWakeResolve, intf);
6783                             intf->NetWakeResolve[i].ReturnIntermed = mDNStrue;
6784                             mDNS_StartQuery_internal(m, &intf->NetWakeResolve[i]);
6785 
6786                             // If we are registering with a Sleep Proxy for a new subnet, add it to our list
6787                             registeredIntfIDS[registeredCount] = intf->InterfaceID;
6788                             registeredCount++;
6789                         }
6790                     }
6791                 }
6792             }
6793         }
6794     }
6795 
6796     // If we have at least one interface on which we are registering with an external sleep proxy,
6797     // initialize all the records appropriately.
6798     if (!mDNSOpaque64IsZero(&updateIntID))
6799         SPSInitRecordsBeforeUpdate(m, updateIntID, &WakeOnlyService);
6800 
6801     // Call the applicaitons that registered a keepalive record to inform them that we failed to offload
6802     // the records to a sleep proxy.
6803     if (invokeKACallback)
6804     {
6805         LogSPS("BeginSleepProcessing: Did not register with an in-NIC proxy - invoking the callbacks for KA records");
6806         DoKeepaliveCallbacks(m);
6807     }
6808 
6809     // SendSleepGoodbyes last two arguments control whether we send goodbyes on all
6810     // interfaces and also deregister unicast registrations.
6811     //
6812     // - If there are no sleep proxy servers, then send goodbyes on all interfaces
6813     //   for both multicast and unicast.
6814     //
6815     // - If we skipped registrations on some interfaces, then we have already marked
6816     //   them appropriately above. We don't need to send goodbyes for unicast as
6817     //   we have registered with at least one sleep proxy.
6818     //
6819     // - If we are not planning to send any goodbyes, then check for WakeOnlyServices.
6820     //
6821     // Note: If we are planning to send goodbyes, we mark the record with mDNSInterfaceAny
6822     // and call SendResponses which inturn calls ShouldSendGoodbyesBeforeSleep which looks
6823     // at WakeOnlyServices first.
6824     if (SendGoodbyes)
6825     {
6826         LogSPS("BeginSleepProcessing: Not registering with Sleep Proxy Server");
6827         SendSleepGoodbyes(m, mDNStrue, mDNStrue);
6828     }
6829     else if (skippedRegistrations)
6830     {
6831         LogSPS("BeginSleepProcessing: Not registering with Sleep Proxy Server on all interfaces");
6832         SendSleepGoodbyes(m, mDNSfalse, mDNSfalse);
6833     }
6834     else if (WakeOnlyService)
6835     {
6836         // If we saw WakeOnly service above, send the goodbyes now.
6837         LogSPS("BeginSleepProcessing: Sending goodbyes for WakeOnlyService");
6838         SendResponses(m);
6839     }
6840 }
6841 
6842 // Call mDNSCoreMachineSleep(m, mDNStrue) when the machine is about to go to sleep.
6843 // Call mDNSCoreMachineSleep(m, mDNSfalse) when the machine is has just woken up.
6844 // Normally, the platform support layer below mDNSCore should call this, not the client layer above.
6845 mDNSexport void mDNSCoreMachineSleep(mDNS *const m, mDNSBool sleep)
6846 {
6847     AuthRecord *rr;
6848 
6849     LogSPS("%s (old state %d) at %ld", sleep ? "Sleeping" : "Waking", m->SleepState, m->timenow);
6850 
6851     if (sleep && !m->SleepState)        // Going to sleep
6852     {
6853         mDNS_Lock(m);
6854         // If we're going to sleep, need to stop advertising that we're a Sleep Proxy Server
6855         if (m->SPSSocket)
6856         {
6857             mDNSu8 oldstate = m->SPSState;
6858             mDNS_DropLockBeforeCallback();      // mDNS_DeregisterService expects to be called without the lock held, so we emulate that here
6859             m->SPSState = 2;
6860 #ifndef SPC_DISABLED
6861             if (oldstate == 1) mDNS_DeregisterService(m, &m->SPSRecords);
6862 #else
6863             (void)oldstate;
6864 #endif
6865             mDNS_ReclaimLockAfterCallback();
6866         }
6867 #ifdef _LEGACY_NAT_TRAVERSAL_
6868         if (m->SSDPSocket)
6869         {
6870             mDNSPlatformUDPClose(m->SSDPSocket);
6871             m->SSDPSocket = mDNSNULL;
6872         }
6873 #endif
6874         m->SleepState = SleepState_Transferring;
6875         if (m->SystemWakeOnLANEnabled && m->DelaySleep)
6876         {
6877             // If we just woke up moments ago, allow ten seconds for networking to stabilize before going back to sleep
6878             LogSPS("mDNSCoreMachineSleep: Re-sleeping immediately after waking; will delay for %d ticks", m->DelaySleep - m->timenow);
6879             m->SleepLimit = NonZeroTime(m->DelaySleep + mDNSPlatformOneSecond * 10);
6880         }
6881         else
6882         {
6883             m->DelaySleep = 0;
6884             m->SleepLimit = NonZeroTime(m->timenow + mDNSPlatformOneSecond * 10);
6885             m->mDNSStats.Sleeps++;
6886             BeginSleepProcessing(m);
6887         }
6888 
6889 #ifndef UNICAST_DISABLED
6890         SuspendLLQs(m);
6891 #endif
6892 #if APPLE_OSX_mDNSResponder
6893         RemoveAutoTunnel6Record(m);
6894 #endif
6895         LogSPS("mDNSCoreMachineSleep: m->SleepState %d (%s) seq %d", m->SleepState,
6896                m->SleepState == SleepState_Transferring ? "Transferring" :
6897                m->SleepState == SleepState_Sleeping     ? "Sleeping"     : "?", m->SleepSeqNum);
6898         mDNS_Unlock(m);
6899     }
6900     else if (!sleep)        // Waking up
6901     {
6902         mDNSu32 slot;
6903         CacheGroup *cg;
6904         CacheRecord *cr;
6905         NetworkInterfaceInfo *intf;
6906         mDNSs32 currtime, diff;
6907 
6908         mDNS_Lock(m);
6909         // Reset SleepLimit back to 0 now that we're awake again.
6910         m->SleepLimit = 0;
6911 
6912         // If we were previously sleeping, but now we're not, increment m->SleepSeqNum to indicate that we're entering a new period of wakefulness
6913         if (m->SleepState != SleepState_Awake)
6914         {
6915             m->SleepState = SleepState_Awake;
6916             m->SleepSeqNum++;
6917             // If the machine wakes and then immediately tries to sleep again (e.g. a maintenance wake)
6918             // then we enforce a minimum delay of five seconds before we begin sleep processing.
6919             // This is to allow time for the Ethernet link to come up, DHCP to get an address, mDNS to issue queries, etc.,
6920             // before we make our determination of whether there's a Sleep Proxy out there we should register with.
6921             m->DelaySleep = NonZeroTime(m->timenow + kDarkWakeDelaySleep);
6922         }
6923 
6924         if (m->SPSState == 3)
6925         {
6926             m->SPSState = 0;
6927             mDNSCoreBeSleepProxyServer_internal(m, m->SPSType, m->SPSPortability, m->SPSMarginalPower, m->SPSTotalPower, m->SPSFeatureFlags);
6928         }
6929         m->mDNSStats.Wakes++;
6930         m->DelayConflictProcessing = MAX_CONFLICT_PROCESSING_DELAYS;
6931         // ... and the same for NextSPSAttempt
6932         for (intf = GetFirstActiveInterface(m->HostInterfaces); intf; intf = GetFirstActiveInterface(intf->next)) intf->NextSPSAttempt = -1;
6933 
6934         // Restart unicast and multicast queries
6935         mDNSCoreRestartQueries(m);
6936 
6937         // and reactivtate service registrations
6938         m->NextSRVUpdate = NonZeroTime(m->timenow + mDNSPlatformOneSecond);
6939         LogInfo("mDNSCoreMachineSleep waking: NextSRVUpdate in %d %d", m->NextSRVUpdate - m->timenow, m->timenow);
6940 
6941         // 2. Re-validate our cache records
6942         currtime = mDNSPlatformUTC();
6943 
6944         diff = currtime - m->TimeSlept;
6945         FORALL_CACHERECORDS(slot, cg, cr)
6946         {
6947             // Temporary fix: For unicast cache records, look at how much time we slept.
6948             // Adjust the RecvTime by the amount of time we slept so that we age the
6949             // cache record appropriately. If it is expired already, purge. If there
6950             // is a network change that happens after the wakeup, we might purge the
6951             // cache anyways and this helps only in the case where there are no network
6952             // changes across sleep/wakeup transition.
6953             //
6954             // Note: If there is a network/DNS server change that already happened and
6955             // these cache entries are already refreshed and we are getting a delayed
6956             // wake up notification, we might adjust the TimeRcvd based on the time slept
6957             // now which can cause the cache to purge pre-maturely. As this is not a very
6958             // common case, this should happen rarely.
6959             if (!cr->resrec.InterfaceID)
6960             {
6961                 if (diff > 0)
6962                 {
6963                     mDNSu32 uTTL = RRUnadjustedTTL(cr->resrec.rroriginalttl);
6964                     const mDNSs32 remain = uTTL - (m->timenow - cr->TimeRcvd) / mDNSPlatformOneSecond;
6965 
6966                     // -if we have slept longer than the remaining TTL, purge and start fresh.
6967                     // -if we have been sleeping for a long time, we could reduce TimeRcvd below by
6968                     //  a sufficiently big value which could cause the value to go into the future
6969                     //  because of the signed comparison of time. For this to happen, we should have been
6970                     //  sleeping really long (~24 days). For now, we want to be conservative and flush even
6971                     //  if we have slept for more than two days.
6972 
6973                     if (diff >= remain || diff > (2 * 24 * 3600))
6974                     {
6975                         LogInfo("mDNSCoreMachineSleep: %s: Purging cache entry SleptTime %d, Remaining TTL %d",
6976                             CRDisplayString(m, cr), diff, remain);
6977                         mDNS_PurgeCacheResourceRecord(m, cr);
6978                         continue;
6979                     }
6980                     cr->TimeRcvd -= (diff * mDNSPlatformOneSecond);
6981                     if (m->timenow - (cr->TimeRcvd + ((mDNSs32)uTTL * mDNSPlatformOneSecond)) >= 0)
6982                     {
6983                         LogInfo("mDNSCoreMachineSleep: %s: Purging after adjusting the remaining TTL %d by %d seconds",
6984                             CRDisplayString(m, cr), remain, diff);
6985                         mDNS_PurgeCacheResourceRecord(m, cr);
6986                     }
6987                     else
6988                     {
6989                         LogInfo("mDNSCoreMachineSleep: %s: Adjusted the remain ttl %u by %d seconds", CRDisplayString(m, cr), remain, diff);
6990                     }
6991                 }
6992             }
6993             else
6994             {
6995                 mDNS_Reconfirm_internal(m, cr, kDefaultReconfirmTimeForWake);
6996             }
6997         }
6998 
6999         // 3. Retrigger probing and announcing for all our authoritative records
7000         for (rr = m->ResourceRecords; rr; rr=rr->next)
7001         {
7002             if (AuthRecord_uDNS(rr))
7003             {
7004                 ActivateUnicastRegistration(m, rr);
7005             }
7006             else
7007             {
7008                 mDNSCoreRestartRegistration(m, rr, -1);
7009             }
7010         }
7011 
7012         // 4. Refresh NAT mappings
7013         // We don't want to have to assume that all hardware can necessarily keep accurate
7014         // track of passage of time while asleep, so on wake we refresh our NAT mappings.
7015         // We typically wake up with no interfaces active, so there's no need to rush to try to find our external address.
7016         // But if we do get a network configuration change, mDNSMacOSXNetworkChanged will call uDNS_SetupDNSConfig, which
7017         // will call mDNS_SetPrimaryInterfaceInfo, which will call RecreateNATMappings to refresh them, potentially sooner
7018         // than five seconds from now.
7019         LogInfo("mDNSCoreMachineSleep: recreating NAT mappings in 5 seconds");
7020         RecreateNATMappings(m, mDNSPlatformOneSecond * 5);
7021         mDNS_Unlock(m);
7022     }
7023 }
7024 
7025 mDNSexport mDNSBool mDNSCoreReadyForSleep(mDNS *m, mDNSs32 now)
7026 {
7027     DNSQuestion *q;
7028     AuthRecord *rr;
7029     NetworkInterfaceInfo *intf;
7030 
7031     mDNS_Lock(m);
7032 
7033     if (m->DelaySleep) goto notready;
7034 
7035     // If we've not hit the sleep limit time, and it's not time for our next retry, we can skip these checks
7036     if (m->SleepLimit - now > 0 && m->NextScheduledSPRetry - now > 0) goto notready;
7037 
7038     m->NextScheduledSPRetry = now + 0x40000000UL;
7039 
7040     // See if we might need to retransmit any lost Sleep Proxy Registrations
7041     for (intf = GetFirstActiveInterface(m->HostInterfaces); intf; intf = GetFirstActiveInterface(intf->next))
7042         if (intf->NextSPSAttempt >= 0)
7043         {
7044             if (now - intf->NextSPSAttemptTime >= 0)
7045             {
7046                 LogSPS("mDNSCoreReadyForSleep: retrying for %s SPS %d try %d",
7047                        intf->ifname, intf->NextSPSAttempt/3, intf->NextSPSAttempt);
7048                 SendSPSRegistration(m, intf, zeroID);
7049                 // Don't need to "goto notready" here, because if we do still have record registrations
7050                 // that have not been acknowledged yet, we'll catch that in the record list scan below.
7051             }
7052             else
7053             if (m->NextScheduledSPRetry - intf->NextSPSAttemptTime > 0)
7054                 m->NextScheduledSPRetry = intf->NextSPSAttemptTime;
7055         }
7056 
7057     // Scan list of interfaces, and see if we're still waiting for any sleep proxy resolves to complete
7058     for (intf = GetFirstActiveInterface(m->HostInterfaces); intf; intf = GetFirstActiveInterface(intf->next))
7059     {
7060         int sps = (intf->NextSPSAttempt == 0) ? 0 : (intf->NextSPSAttempt-1)/3;
7061         if (intf->NetWakeResolve[sps].ThisQInterval >= 0)
7062         {
7063             LogSPS("mDNSCoreReadyForSleep: waiting for SPS Resolve %s %##s (%s)",
7064                    intf->ifname, intf->NetWakeResolve[sps].qname.c, DNSTypeName(intf->NetWakeResolve[sps].qtype));
7065             goto spsnotready;
7066         }
7067     }
7068 
7069     // Scan list of registered records
7070     for (rr = m->ResourceRecords; rr; rr = rr->next)
7071         if (!AuthRecord_uDNS(rr))
7072             if (!mDNSOpaque64IsZero(&rr->updateIntID))
7073             { LogSPS("mDNSCoreReadyForSleep: waiting for SPS updateIntID 0x%x 0x%x (updateid %d) %s", rr->updateIntID.l[1], rr->updateIntID.l[0], mDNSVal16(rr->updateid), ARDisplayString(m,rr)); goto spsnotready; }
7074 
7075     // Scan list of private LLQs, and make sure they've all completed their handshake with the server
7076     for (q = m->Questions; q; q = q->next)
7077         if (!mDNSOpaque16IsZero(q->TargetQID) && q->LongLived && q->ReqLease == 0 && q->tcp)
7078         {
7079             LogSPS("mDNSCoreReadyForSleep: waiting for LLQ %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
7080             goto notready;
7081         }
7082 
7083     // Scan list of registered records
7084     for (rr = m->ResourceRecords; rr; rr = rr->next)
7085         if (AuthRecord_uDNS(rr))
7086         {
7087             if (rr->state == regState_Refresh && rr->tcp)
7088             { LogSPS("mDNSCoreReadyForSleep: waiting for Record updateIntID 0x%x 0x%x (updateid %d) %s", rr->updateIntID.l[1], rr->updateIntID.l[0], mDNSVal16(rr->updateid), ARDisplayString(m,rr)); goto notready; }
7089             #if APPLE_OSX_mDNSResponder
7090             if (!RecordReadyForSleep(rr)) { LogSPS("mDNSCoreReadyForSleep: waiting for %s", ARDisplayString(m, rr)); goto notready; }
7091             #endif
7092         }
7093 
7094     mDNS_Unlock(m);
7095     return mDNStrue;
7096 
7097 spsnotready:
7098 
7099     // If we failed to complete sleep proxy registration within ten seconds, we give up on that
7100     // and allow up to ten seconds more to complete wide-area deregistration instead
7101     if (now - m->SleepLimit >= 0)
7102     {
7103         LogMsg("Failed to register with SPS, now sending goodbyes");
7104 
7105         for (intf = GetFirstActiveInterface(m->HostInterfaces); intf; intf = GetFirstActiveInterface(intf->next))
7106             if (intf->NetWakeBrowse.ThisQInterval >= 0)
7107             {
7108                 LogSPS("ReadyForSleep mDNS_DeactivateNetWake %s %##s (%s)",
7109                        intf->ifname, intf->NetWakeResolve[0].qname.c, DNSTypeName(intf->NetWakeResolve[0].qtype));
7110                 mDNS_DeactivateNetWake_internal(m, intf);
7111             }
7112 
7113         for (rr = m->ResourceRecords; rr; rr = rr->next)
7114             if (!AuthRecord_uDNS(rr))
7115                 if (!mDNSOpaque64IsZero(&rr->updateIntID))
7116                 {
7117                     LogSPS("ReadyForSleep clearing updateIntID 0x%x 0x%x (updateid %d) for %s", rr->updateIntID.l[1], rr->updateIntID.l[0], mDNSVal16(rr->updateid), ARDisplayString(m, rr));
7118                     rr->updateIntID = zeroOpaque64;
7119                 }
7120 
7121         // We'd really like to allow up to ten seconds more here,
7122         // but if we don't respond to the sleep notification within 30 seconds
7123         // we'll be put back to sleep forcibly without the chance to schedule the next maintenance wake.
7124         // Right now we wait 16 sec after wake for all the interfaces to come up, then we wait up to 10 seconds
7125         // more for SPS resolves and record registrations to complete, which puts us at 26 seconds.
7126         // If we allow just one more second to send our goodbyes, that puts us at 27 seconds.
7127         m->SleepLimit = now + mDNSPlatformOneSecond * 1;
7128 
7129         SendSleepGoodbyes(m, mDNStrue, mDNStrue);
7130     }
7131 
7132 notready:
7133     mDNS_Unlock(m);
7134     return mDNSfalse;
7135 }
7136 
7137 mDNSexport mDNSs32 mDNSCoreIntervalToNextWake(mDNS *const m, mDNSs32 now)
7138 {
7139     AuthRecord *ar;
7140 
7141     // Even when we have no wake-on-LAN-capable interfaces, or we failed to find a sleep proxy, or we have other
7142     // failure scenarios, we still want to wake up in at most 120 minutes, to see if the network environment has changed.
7143     // E.g. we might wake up and find no wireless network because the base station got rebooted just at that moment,
7144     // and if that happens we don't want to just give up and go back to sleep and never try again.
7145     mDNSs32 e = now + (120 * 60 * mDNSPlatformOneSecond);       // Sleep for at most 120 minutes
7146 
7147     NATTraversalInfo *nat;
7148     for (nat = m->NATTraversals; nat; nat=nat->next)
7149         if (nat->Protocol && nat->ExpiryTime && nat->ExpiryTime - now > mDNSPlatformOneSecond*4)
7150         {
7151             mDNSs32 t = nat->ExpiryTime - (nat->ExpiryTime - now) / 10;     // Wake up when 90% of the way to the expiry time
7152             if (e - t > 0) e = t;
7153             LogSPS("ComputeWakeTime: %p %s Int %5d Ext %5d Err %d Retry %5d Interval %5d Expire %5d Wake %5d",
7154                    nat, nat->Protocol == NATOp_MapTCP ? "TCP" : "UDP",
7155                    mDNSVal16(nat->IntPort), mDNSVal16(nat->ExternalPort), nat->Result,
7156                    nat->retryPortMap ? (nat->retryPortMap - now) / mDNSPlatformOneSecond : 0,
7157                    nat->retryInterval / mDNSPlatformOneSecond,
7158                    nat->ExpiryTime ? (nat->ExpiryTime - now) / mDNSPlatformOneSecond : 0,
7159                    (t - now) / mDNSPlatformOneSecond);
7160         }
7161 
7162     // This loop checks both the time we need to renew wide-area registrations,
7163     // and the time we need to renew Sleep Proxy registrations
7164     for (ar = m->ResourceRecords; ar; ar = ar->next)
7165         if (ar->expire && ar->expire - now > mDNSPlatformOneSecond*4)
7166         {
7167             mDNSs32 t = ar->expire - (ar->expire - now) / 10;       // Wake up when 90% of the way to the expiry time
7168             if (e - t > 0) e = t;
7169             LogSPS("ComputeWakeTime: %p Int %7d Next %7d Expire %7d Wake %7d %s",
7170                    ar, ar->ThisAPInterval / mDNSPlatformOneSecond,
7171                    (ar->LastAPTime + ar->ThisAPInterval - now) / mDNSPlatformOneSecond,
7172                    ar->expire ? (ar->expire - now) / mDNSPlatformOneSecond : 0,
7173                    (t - now) / mDNSPlatformOneSecond, ARDisplayString(m, ar));
7174         }
7175 
7176     return(e - now);
7177 }
7178 
7179 // ***************************************************************************
7180 #if COMPILER_LIKES_PRAGMA_MARK
7181 #pragma mark -
7182 #pragma mark - Packet Reception Functions
7183 #endif
7184 
7185 #define MustSendRecord(RR) ((RR)->NR_AnswerTo || (RR)->NR_AdditionalTo)
7186 
7187 mDNSlocal mDNSu8 *GenerateUnicastResponse(const DNSMessage *const query, const mDNSu8 *const end,
7188                                           const mDNSInterfaceID InterfaceID, mDNSBool LegacyQuery, DNSMessage *const response, AuthRecord *ResponseRecords)
7189 {
7190     mDNSu8          *responseptr     = response->data;
7191     const mDNSu8    *const limit     = response->data + sizeof(response->data);
7192     const mDNSu8    *ptr             = query->data;
7193     AuthRecord  *rr;
7194     mDNSu32 maxttl = mDNSMaximumTTLSeconds;
7195     int i;
7196 
7197     // Initialize the response fields so we can answer the questions
7198     InitializeDNSMessage(&response->h, query->h.id, ResponseFlags);
7199 
7200     // ***
7201     // *** 1. Write out the list of questions we are actually going to answer with this packet
7202     // ***
7203     if (LegacyQuery)
7204     {
7205         maxttl = kStaticCacheTTL;
7206         for (i=0; i<query->h.numQuestions; i++)                     // For each question...
7207         {
7208             DNSQuestion q;
7209             ptr = getQuestion(query, ptr, end, InterfaceID, &q);    // get the question...
7210             if (!ptr) return(mDNSNULL);
7211 
7212             for (rr=ResponseRecords; rr; rr=rr->NextResponse)       // and search our list of proposed answers
7213             {
7214                 if (rr->NR_AnswerTo == ptr)                         // If we're going to generate a record answering this question
7215                 {                                                   // then put the question in the question section
7216                     responseptr = putQuestion(response, responseptr, limit, &q.qname, q.qtype, q.qclass);
7217                     if (!responseptr) { debugf("GenerateUnicastResponse: Ran out of space for questions!"); return(mDNSNULL); }
7218                     break;      // break out of the ResponseRecords loop, and go on to the next question
7219                 }
7220             }
7221         }
7222 
7223         if (response->h.numQuestions == 0) { LogMsg("GenerateUnicastResponse: ERROR! Why no questions?"); return(mDNSNULL); }
7224     }
7225 
7226     // ***
7227     // *** 2. Write Answers
7228     // ***
7229     for (rr=ResponseRecords; rr; rr=rr->NextResponse)
7230         if (rr->NR_AnswerTo)
7231         {
7232             mDNSu8 *p = PutResourceRecordTTL(response, responseptr, &response->h.numAnswers, &rr->resrec,
7233                                              maxttl < rr->resrec.rroriginalttl ? maxttl : rr->resrec.rroriginalttl);
7234             if (p) responseptr = p;
7235             else { debugf("GenerateUnicastResponse: Ran out of space for answers!"); response->h.flags.b[0] |= kDNSFlag0_TC; }
7236         }
7237 
7238     // ***
7239     // *** 3. Write Additionals
7240     // ***
7241     for (rr=ResponseRecords; rr; rr=rr->NextResponse)
7242         if (rr->NR_AdditionalTo && !rr->NR_AnswerTo)
7243         {
7244             mDNSu8 *p = PutResourceRecordTTL(response, responseptr, &response->h.numAdditionals, &rr->resrec,
7245                                              maxttl < rr->resrec.rroriginalttl ? maxttl : rr->resrec.rroriginalttl);
7246             if (p) responseptr = p;
7247             else debugf("GenerateUnicastResponse: No more space for additionals");
7248         }
7249 
7250     return(responseptr);
7251 }
7252 
7253 // AuthRecord *our is our Resource Record
7254 // CacheRecord *pkt is the Resource Record from the response packet we've witnessed on the network
7255 // Returns 0 if there is no conflict
7256 // Returns +1 if there was a conflict and we won
7257 // Returns -1 if there was a conflict and we lost and have to rename
7258 mDNSlocal int CompareRData(const AuthRecord *const our, const CacheRecord *const pkt)
7259 {
7260     mDNSu8 ourdata[256], *ourptr = ourdata, *ourend;
7261     mDNSu8 pktdata[256], *pktptr = pktdata, *pktend;
7262     if (!our) { LogMsg("CompareRData ERROR: our is NULL"); return(+1); }
7263     if (!pkt) { LogMsg("CompareRData ERROR: pkt is NULL"); return(+1); }
7264 
7265     ourend = putRData(mDNSNULL, ourdata, ourdata + sizeof(ourdata), &our->resrec);
7266     pktend = putRData(mDNSNULL, pktdata, pktdata + sizeof(pktdata), &pkt->resrec);
7267     while (ourptr < ourend && pktptr < pktend && *ourptr == *pktptr) { ourptr++; pktptr++; }
7268     if (ourptr >= ourend && pktptr >= pktend) return(0);            // If data identical, not a conflict
7269 
7270     if (ourptr >= ourend) return(-1);                               // Our data ran out first; We lost
7271     if (pktptr >= pktend) return(+1);                               // Packet data ran out first; We won
7272     if (*pktptr > *ourptr) return(-1);                              // Our data is numerically lower; We lost
7273     if (*pktptr < *ourptr) return(+1);                              // Packet data is numerically lower; We won
7274 
7275     LogMsg("CompareRData ERROR: Invalid state");
7276     return(-1);
7277 }
7278 
7279 // See if we have an authoritative record that's identical to this packet record,
7280 // whose canonical DependentOn record is the specified master record.
7281 // The DependentOn pointer is typically used for the TXT record of service registrations
7282 // It indicates that there is no inherent conflict detection for the TXT record
7283 // -- it depends on the SRV record to resolve name conflicts
7284 // If we find any identical ResourceRecords in our authoritative list, then follow their DependentOn
7285 // pointer chain (if any) to make sure we reach the canonical DependentOn record
7286 // If the record has no DependentOn, then just return that record's pointer
7287 // Returns NULL if we don't have any local RRs that are identical to the one from the packet
7288 mDNSlocal mDNSBool MatchDependentOn(const mDNS *const m, const CacheRecord *const pktrr, const AuthRecord *const master)
7289 {
7290     const AuthRecord *r1;
7291     for (r1 = m->ResourceRecords; r1; r1=r1->next)
7292     {
7293         if (IdenticalResourceRecord(&r1->resrec, &pktrr->resrec))
7294         {
7295             const AuthRecord *r2 = r1;
7296             while (r2->DependentOn) r2 = r2->DependentOn;
7297             if (r2 == master) return(mDNStrue);
7298         }
7299     }
7300     for (r1 = m->DuplicateRecords; r1; r1=r1->next)
7301     {
7302         if (IdenticalResourceRecord(&r1->resrec, &pktrr->resrec))
7303         {
7304             const AuthRecord *r2 = r1;
7305             while (r2->DependentOn) r2 = r2->DependentOn;
7306             if (r2 == master) return(mDNStrue);
7307         }
7308     }
7309     return(mDNSfalse);
7310 }
7311 
7312 // Find the canonical RRSet pointer for this RR received in a packet.
7313 // If we find any identical AuthRecord in our authoritative list, then follow its RRSet
7314 // pointers (if any) to make sure we return the canonical member of this name/type/class
7315 // Returns NULL if we don't have any local RRs that are identical to the one from the packet
7316 mDNSlocal const AuthRecord *FindRRSet(const mDNS *const m, const CacheRecord *const pktrr)
7317 {
7318     const AuthRecord *rr;
7319     for (rr = m->ResourceRecords; rr; rr=rr->next)
7320     {
7321         if (IdenticalResourceRecord(&rr->resrec, &pktrr->resrec))
7322         {
7323             while (rr->RRSet && rr != rr->RRSet) rr = rr->RRSet;
7324             return(rr);
7325         }
7326     }
7327     return(mDNSNULL);
7328 }
7329 
7330 // PacketRRConflict is called when we've received an RR (pktrr) which has the same name
7331 // as one of our records (our) but different rdata.
7332 // 1. If our record is not a type that's supposed to be unique, we don't care.
7333 // 2a. If our record is marked as dependent on some other record for conflict detection, ignore this one.
7334 // 2b. If the packet rr exactly matches one of our other RRs, and *that* record's DependentOn pointer
7335 //     points to our record, ignore this conflict (e.g. the packet record matches one of our
7336 //     TXT records, and that record is marked as dependent on 'our', its SRV record).
7337 // 3. If we have some *other* RR that exactly matches the one from the packet, and that record and our record
7338 //    are members of the same RRSet, then this is not a conflict.
7339 mDNSlocal mDNSBool PacketRRConflict(const mDNS *const m, const AuthRecord *const our, const CacheRecord *const pktrr)
7340 {
7341     // If not supposed to be unique, not a conflict
7342     if (!(our->resrec.RecordType & kDNSRecordTypeUniqueMask)) return(mDNSfalse);
7343 
7344     // If a dependent record, not a conflict
7345     if (our->DependentOn || MatchDependentOn(m, pktrr, our)) return(mDNSfalse);
7346     else
7347     {
7348         // If the pktrr matches a member of ourset, not a conflict
7349         const AuthRecord *ourset = our->RRSet ? our->RRSet : our;
7350         const AuthRecord *pktset = FindRRSet(m, pktrr);
7351         if (pktset == ourset) return(mDNSfalse);
7352 
7353         // For records we're proxying, where we don't know the full
7354         // relationship between the records, having any matching record
7355         // in our AuthRecords list is sufficient evidence of non-conflict
7356         if (our->WakeUp.HMAC.l[0] && pktset) return(mDNSfalse);
7357     }
7358 
7359     // Okay, this is a conflict
7360     return(mDNStrue);
7361 }
7362 
7363 // Note: ResolveSimultaneousProbe calls mDNS_Deregister_internal which can call a user callback, which may change
7364 // the record list and/or question list.
7365 // Any code walking either list must use the CurrentQuestion and/or CurrentRecord mechanism to protect against this.
7366 mDNSlocal void ResolveSimultaneousProbe(mDNS *const m, const DNSMessage *const query, const mDNSu8 *const end,
7367                                         DNSQuestion *q, AuthRecord *our)
7368 {
7369     int i;
7370     const mDNSu8 *ptr = LocateAuthorities(query, end);
7371     mDNSBool FoundUpdate = mDNSfalse;
7372 
7373     for (i = 0; i < query->h.numAuthorities; i++)
7374     {
7375         ptr = GetLargeResourceRecord(m, query, ptr, end, q->InterfaceID, kDNSRecordTypePacketAuth, &m->rec);
7376         if (!ptr) break;
7377         if (m->rec.r.resrec.RecordType != kDNSRecordTypePacketNegative && ResourceRecordAnswersQuestion(&m->rec.r.resrec, q))
7378         {
7379             FoundUpdate = mDNStrue;
7380             if (PacketRRConflict(m, our, &m->rec.r))
7381             {
7382                 int result          = (int)our->resrec.rrclass - (int)m->rec.r.resrec.rrclass;
7383                 if (!result) result = (int)our->resrec.rrtype  - (int)m->rec.r.resrec.rrtype;
7384                 if (!result) result = CompareRData(our, &m->rec.r);
7385                 if (result)
7386                 {
7387                     const char *const msg = (result < 0) ? "lost:" : (result > 0) ? "won: " : "tie: ";
7388                     LogMsg("ResolveSimultaneousProbe: %p Pkt Record:        %08lX %s", q->InterfaceID, m->rec.r.resrec.rdatahash, CRDisplayString(m, &m->rec.r));
7389                     LogMsg("ResolveSimultaneousProbe: %p Our Record %d %s %08lX %s", our->resrec.InterfaceID, our->ProbeCount, msg, our->resrec.rdatahash, ARDisplayString(m, our));
7390                 }
7391                 // If we lost the tie-break for simultaneous probes, we don't immediately give up, because we might be seeing stale packets on the network.
7392                 // Instead we pause for one second, to give the other host (if real) a chance to establish its name, and then try probing again.
7393                 // If there really is another live host out there with the same name, it will answer our probes and we'll then rename.
7394                 if (result < 0)
7395                 {
7396                     m->SuppressProbes   = NonZeroTime(m->timenow + mDNSPlatformOneSecond);
7397                     our->ProbeCount     = DefaultProbeCountForTypeUnique;
7398                     our->AnnounceCount  = InitialAnnounceCount;
7399                     InitializeLastAPTime(m, our);
7400                     goto exit;
7401                 }
7402             }
7403 #if 0
7404             else
7405             {
7406                 LogMsg("ResolveSimultaneousProbe: %p Pkt Record:        %08lX %s", q->InterfaceID, m->rec.r.resrec.rdatahash, CRDisplayString(m, &m->rec.r));
7407                 LogMsg("ResolveSimultaneousProbe: %p Our Record %d ign:  %08lX %s", our->resrec.InterfaceID, our->ProbeCount, our->resrec.rdatahash, ARDisplayString(m, our));
7408             }
7409 #endif
7410         }
7411         m->rec.r.resrec.RecordType = 0;     // Clear RecordType to show we're not still using it
7412     }
7413     if (!FoundUpdate)
7414         LogInfo("ResolveSimultaneousProbe: %##s (%s): No Update Record found", our->resrec.name->c, DNSTypeName(our->resrec.rrtype));
7415 exit:
7416     m->rec.r.resrec.RecordType = 0;     // Clear RecordType to show we're not still using it
7417 }
7418 
7419 mDNSlocal CacheRecord *FindIdenticalRecordInCache(const mDNS *const m, const ResourceRecord *const pktrr)
7420 {
7421     CacheGroup *cg = CacheGroupForRecord(m, pktrr);
7422     CacheRecord *rr;
7423     mDNSBool match;
7424     for (rr = cg ? cg->members : mDNSNULL; rr; rr=rr->next)
7425     {
7426         if (!pktrr->InterfaceID)
7427         {
7428             mDNSu16 id1 = (pktrr->rDNSServer ? pktrr->rDNSServer->resGroupID : 0);
7429             mDNSu16 id2 = (rr->resrec.rDNSServer ? rr->resrec.rDNSServer->resGroupID : 0);
7430             match = (id1 == id2);
7431         }
7432         else match = (pktrr->InterfaceID == rr->resrec.InterfaceID);
7433 
7434         if (match && IdenticalSameNameRecord(pktrr, &rr->resrec)) break;
7435     }
7436     return(rr);
7437 }
7438 mDNSlocal void DeregisterProxyRecord(mDNS *const m, AuthRecord *const rr)
7439 {
7440     rr->WakeUp.HMAC    = zeroEthAddr; // Clear HMAC so that mDNS_Deregister_internal doesn't waste packets trying to wake this host
7441     rr->RequireGoodbye = mDNSfalse;   // and we don't want to send goodbye for it
7442     mDNS_Deregister_internal(m, rr, mDNS_Dereg_normal);
7443     SetSPSProxyListChanged(m->rec.r.resrec.InterfaceID);
7444 }
7445 
7446 mDNSlocal void ClearKeepaliveProxyRecords(mDNS *const m, const OwnerOptData *const owner, AuthRecord *const thelist, const mDNSInterfaceID InterfaceID)
7447 {
7448     if (m->CurrentRecord)
7449         LogMsg("ClearKeepaliveProxyRecords ERROR m->CurrentRecord already set %s", ARDisplayString(m, m->CurrentRecord));
7450     m->CurrentRecord = thelist;
7451 
7452     // Normally, the RDATA of the keepalive record will be different each time and hence we always
7453     // clean up the keepalive record.
7454     while (m->CurrentRecord)
7455     {
7456         AuthRecord *const rr = m->CurrentRecord;
7457         if (InterfaceID == rr->resrec.InterfaceID && mDNSSameEthAddress(&owner->HMAC, &rr->WakeUp.HMAC))
7458         {
7459             if (mDNS_KeepaliveRecord(&m->rec.r.resrec))
7460             {
7461                 LogSPS("ClearKeepaliveProxyRecords: Removing %3d H-MAC %.6a I-MAC %.6a %d %d %s",
7462                        m->ProxyRecords, &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, rr->WakeUp.seq, owner->seq, ARDisplayString(m, rr));
7463                 DeregisterProxyRecord(m, rr);
7464             }
7465         }
7466         // Mustn't advance m->CurrentRecord until *after* mDNS_Deregister_internal, because
7467         // new records could have been added to the end of the list as a result of that call.
7468         if (m->CurrentRecord == rr) // If m->CurrentRecord was not advanced for us, do it now
7469             m->CurrentRecord = rr->next;
7470     }
7471 }
7472 
7473 // Called from mDNSCoreReceiveUpdate when we get a sleep proxy registration request,
7474 // to check our lists and discard any stale duplicates of this record we already have
7475 mDNSlocal void ClearIdenticalProxyRecords(mDNS *const m, const OwnerOptData *const owner, AuthRecord *const thelist)
7476 {
7477     if (m->CurrentRecord)
7478         LogMsg("ClearIdenticalProxyRecords ERROR m->CurrentRecord already set %s", ARDisplayString(m, m->CurrentRecord));
7479     m->CurrentRecord = thelist;
7480     while (m->CurrentRecord)
7481     {
7482         AuthRecord *const rr = m->CurrentRecord;
7483         if (m->rec.r.resrec.InterfaceID == rr->resrec.InterfaceID && mDNSSameEthAddress(&owner->HMAC, &rr->WakeUp.HMAC))
7484             if (IdenticalResourceRecord(&rr->resrec, &m->rec.r.resrec))
7485             {
7486                 LogSPS("ClearIdenticalProxyRecords: Removing %3d H-MAC %.6a I-MAC %.6a %d %d %s",
7487                        m->ProxyRecords, &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, rr->WakeUp.seq, owner->seq, ARDisplayString(m, rr));
7488                 DeregisterProxyRecord(m, rr);
7489             }
7490         // Mustn't advance m->CurrentRecord until *after* mDNS_Deregister_internal, because
7491         // new records could have been added to the end of the list as a result of that call.
7492         if (m->CurrentRecord == rr) // If m->CurrentRecord was not advanced for us, do it now
7493             m->CurrentRecord = rr->next;
7494     }
7495 }
7496 
7497 // Called from ProcessQuery when we get an mDNS packet with an owner record in it
7498 mDNSlocal void ClearProxyRecords(mDNS *const m, const OwnerOptData *const owner, AuthRecord *const thelist)
7499 {
7500     if (m->CurrentRecord)
7501         LogMsg("ClearProxyRecords ERROR m->CurrentRecord already set %s", ARDisplayString(m, m->CurrentRecord));
7502     m->CurrentRecord = thelist;
7503     while (m->CurrentRecord)
7504     {
7505         AuthRecord *const rr = m->CurrentRecord;
7506         if (m->rec.r.resrec.InterfaceID == rr->resrec.InterfaceID && mDNSSameEthAddress(&owner->HMAC, &rr->WakeUp.HMAC))
7507             if (owner->seq != rr->WakeUp.seq || m->timenow - rr->TimeRcvd > mDNSPlatformOneSecond * 60)
7508             {
7509                 if (rr->AddressProxy.type == mDNSAddrType_IPv6)
7510                 {
7511                     // We don't do this here because we know that the host is waking up at this point, so we don't send
7512                     // Unsolicited Neighbor Advertisements -- even Neighbor Advertisements agreeing with what the host should be
7513                     // saying itself -- because it can cause some IPv6 stacks to falsely conclude that there's an address conflict.
7514                     #if MDNS_USE_Unsolicited_Neighbor_Advertisements
7515                     LogSPS("NDP Announcement -- Releasing traffic for H-MAC %.6a I-MAC %.6a %s",
7516                            &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, ARDisplayString(m,rr));
7517                     SendNDP(m, NDP_Adv, NDP_Override, rr, &rr->AddressProxy.ip.v6, &rr->WakeUp.IMAC, &AllHosts_v6, &AllHosts_v6_Eth);
7518                     #endif
7519                 }
7520                 LogSPS("ClearProxyRecords: Removing %3d AC %2d %02X H-MAC %.6a I-MAC %.6a %d %d %s",
7521                        m->ProxyRecords, rr->AnnounceCount, rr->resrec.RecordType,
7522                        &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, rr->WakeUp.seq, owner->seq, ARDisplayString(m, rr));
7523                 if (rr->resrec.RecordType == kDNSRecordTypeDeregistering) rr->resrec.RecordType = kDNSRecordTypeShared;
7524                 rr->WakeUp.HMAC = zeroEthAddr;  // Clear HMAC so that mDNS_Deregister_internal doesn't waste packets trying to wake this host
7525                 rr->RequireGoodbye = mDNSfalse; // and we don't want to send goodbye for it, since real host is now back and functional
7526                 mDNS_Deregister_internal(m, rr, mDNS_Dereg_normal);
7527                 SetSPSProxyListChanged(m->rec.r.resrec.InterfaceID);
7528             }
7529         // Mustn't advance m->CurrentRecord until *after* mDNS_Deregister_internal, because
7530         // new records could have been added to the end of the list as a result of that call.
7531         if (m->CurrentRecord == rr) // If m->CurrentRecord was not advanced for us, do it now
7532             m->CurrentRecord = rr->next;
7533     }
7534 }
7535 
7536 // ProcessQuery examines a received query to see if we have any answers to give
7537 mDNSlocal mDNSu8 *ProcessQuery(mDNS *const m, const DNSMessage *const query, const mDNSu8 *const end,
7538                                const mDNSAddr *srcaddr, const mDNSInterfaceID InterfaceID, mDNSBool LegacyQuery, mDNSBool QueryWasMulticast,
7539                                mDNSBool QueryWasLocalUnicast, DNSMessage *const response)
7540 {
7541     mDNSBool FromLocalSubnet    = srcaddr && mDNS_AddressIsLocalSubnet(m, InterfaceID, srcaddr);
7542     AuthRecord   *ResponseRecords    = mDNSNULL;
7543     AuthRecord  **nrp                = &ResponseRecords;
7544 
7545 #if POOF_ENABLED
7546     mDNSBool    notD2D = !mDNSPlatformInterfaceIsD2D(InterfaceID);  // We don't run the POOF algorithm on D2D interfaces.
7547     CacheRecord  *ExpectedAnswers    = mDNSNULL;            // Records in our cache we expect to see updated
7548     CacheRecord **eap                = &ExpectedAnswers;
7549 #endif // POOF_ENABLED
7550 
7551     DNSQuestion  *DupQuestions       = mDNSNULL;            // Our questions that are identical to questions in this packet
7552     DNSQuestion **dqp                = &DupQuestions;
7553     mDNSs32 delayresponse      = 0;
7554     mDNSBool SendLegacyResponse = mDNSfalse;
7555     const mDNSu8 *ptr;
7556     mDNSu8       *responseptr        = mDNSNULL;
7557     AuthRecord   *rr;
7558     int i;
7559     CacheRecord *McastNSEC3Records   = mDNSNULL;
7560 
7561     // ***
7562     // *** 1. Look in Additional Section for an OPT record
7563     // ***
7564     ptr = LocateOptRR(query, end, DNSOpt_OwnerData_ID_Space);
7565     if (ptr)
7566     {
7567         ptr = GetLargeResourceRecord(m, query, ptr, end, InterfaceID, kDNSRecordTypePacketAdd, &m->rec);
7568         if (ptr && m->rec.r.resrec.RecordType != kDNSRecordTypePacketNegative && m->rec.r.resrec.rrtype == kDNSType_OPT)
7569         {
7570             const rdataOPT *opt;
7571             const rdataOPT *const e = (const rdataOPT *)&m->rec.r.resrec.rdata->u.data[m->rec.r.resrec.rdlength];
7572             // Find owner sub-option(s). We verify that the MAC is non-zero, otherwise we could inadvertently
7573             // delete all our own AuthRecords (which are identified by having zero MAC tags on them).
7574             for (opt = &m->rec.r.resrec.rdata->u.opt[0]; opt < e; opt++)
7575                 if (opt->opt == kDNSOpt_Owner && opt->u.owner.vers == 0 && opt->u.owner.HMAC.l[0])
7576                 {
7577                     ClearProxyRecords(m, &opt->u.owner, m->DuplicateRecords);
7578                     ClearProxyRecords(m, &opt->u.owner, m->ResourceRecords);
7579                 }
7580         }
7581         m->rec.r.resrec.RecordType = 0;     // Clear RecordType to show we're not still using it
7582     }
7583 
7584     //
7585     // Look in Authority Section for NSEC3 record
7586     //
7587 
7588     mDNSParseNSEC3Records(m, query, end, InterfaceID, &McastNSEC3Records);
7589 
7590     // ***
7591     // *** 2. Parse Question Section and mark potential answers
7592     // ***
7593     ptr = query->data;
7594     for (i=0; i<query->h.numQuestions; i++)                     // For each question...
7595     {
7596         mDNSBool QuestionNeedsMulticastResponse;
7597         int NumAnswersForThisQuestion = 0;
7598         AuthRecord *NSECAnswer = mDNSNULL;
7599         DNSQuestion pktq, *q;
7600         ptr = getQuestion(query, ptr, end, InterfaceID, &pktq); // get the question...
7601         if (!ptr) goto exit;
7602 
7603         pktq.AnonInfo = mDNSNULL;
7604         if (McastNSEC3Records)
7605             InitializeAnonInfoForQuestion(m, &McastNSEC3Records, &pktq);
7606         // The only queries that *need* a multicast response are:
7607         // * Queries sent via multicast
7608         // * from port 5353
7609         // * that don't have the kDNSQClass_UnicastResponse bit set
7610         // These queries need multicast responses because other clients will:
7611         // * suppress their own identical questions when they see these questions, and
7612         // * expire their cache records if they don't see the expected responses
7613         // For other queries, we may still choose to send the occasional multicast response anyway,
7614         // to keep our neighbours caches warm, and for ongoing conflict detection.
7615         QuestionNeedsMulticastResponse = QueryWasMulticast && !LegacyQuery && !(pktq.qclass & kDNSQClass_UnicastResponse);
7616 
7617         if (pktq.qclass & kDNSQClass_UnicastResponse)
7618             m->mDNSStats.UnicastBitInQueries++;
7619         else
7620             m->mDNSStats.NormalQueries++;
7621 
7622         // Clear the UnicastResponse flag -- don't want to confuse the rest of the code that follows later
7623         pktq.qclass &= ~kDNSQClass_UnicastResponse;
7624 
7625         // Note: We use the m->CurrentRecord mechanism here because calling ResolveSimultaneousProbe
7626         // can result in user callbacks which may change the record list and/or question list.
7627         // Also note: we just mark potential answer records here, without trying to build the
7628         // "ResponseRecords" list, because we don't want to risk user callbacks deleting records
7629         // from that list while we're in the middle of trying to build it.
7630         if (m->CurrentRecord)
7631             LogMsg("ProcessQuery ERROR m->CurrentRecord already set %s", ARDisplayString(m, m->CurrentRecord));
7632         m->CurrentRecord = m->ResourceRecords;
7633         while (m->CurrentRecord)
7634         {
7635             rr = m->CurrentRecord;
7636             m->CurrentRecord = rr->next;
7637             if (AnyTypeRecordAnswersQuestion(&rr->resrec, &pktq) && (QueryWasMulticast || QueryWasLocalUnicast || rr->AllowRemoteQuery))
7638             {
7639                 m->mDNSStats.MatchingAnswersForQueries++;
7640                 if (RRTypeAnswersQuestionType(&rr->resrec, pktq.qtype))
7641                 {
7642                     if (rr->resrec.RecordType == kDNSRecordTypeUnique)
7643                         ResolveSimultaneousProbe(m, query, end, &pktq, rr);
7644                     else if (ResourceRecordIsValidAnswer(rr))
7645                     {
7646                         NumAnswersForThisQuestion++;
7647                         // As we have verified this question to be part of the same subset,
7648                         // set the anonymous data which is needed below when walk the cache
7649                         // records to see what answers we should be expecting. The cache records
7650                         // may cache only the nsec3RR and not the anonymous data itself.
7651                         if (pktq.AnonInfo && rr->resrec.AnonInfo)
7652                             SetAnonData(&pktq, &rr->resrec, mDNStrue);
7653 
7654                         // Note: We should check here if this is a probe-type query, and if so, generate an immediate
7655                         // unicast answer back to the source, because timeliness in answering probes is important.
7656 
7657                         // Notes:
7658                         // NR_AnswerTo pointing into query packet means "answer via immediate legacy unicast" (may *also* choose to multicast)
7659                         // NR_AnswerTo == NR_AnswerUnicast   means "answer via delayed unicast" (to modern querier; may promote to multicast instead)
7660                         // NR_AnswerTo == NR_AnswerMulticast means "definitely answer via multicast" (can't downgrade to unicast later)
7661                         // If we're not multicasting this record because the kDNSQClass_UnicastResponse bit was set,
7662                         // but the multicast querier is not on a matching subnet (e.g. because of overlaid subnets on one link)
7663                         // then we'll multicast it anyway (if we unicast, the receiver will ignore it because it has an apparently non-local source)
7664                         if (QuestionNeedsMulticastResponse || (!FromLocalSubnet && QueryWasMulticast && !LegacyQuery))
7665                         {
7666                             // We only mark this question for sending if it is at least one second since the last time we multicast it
7667                             // on this interface. If it is more than a second, or LastMCInterface is different, then we may multicast it.
7668                             // This is to guard against the case where someone blasts us with queries as fast as they can.
7669                             if ((mDNSu32)(m->timenow - rr->LastMCTime) >= (mDNSu32)mDNSPlatformOneSecond ||
7670                                 (rr->LastMCInterface != mDNSInterfaceMark && rr->LastMCInterface != InterfaceID))
7671                                 rr->NR_AnswerTo = NR_AnswerMulticast;
7672                         }
7673                         else if (!rr->NR_AnswerTo) rr->NR_AnswerTo = LegacyQuery ? ptr : NR_AnswerUnicast;
7674                     }
7675                 }
7676                 else if ((rr->resrec.RecordType & kDNSRecordTypeActiveUniqueMask) && ResourceRecordIsValidAnswer(rr))
7677                 {
7678                     // If we don't have any answers for this question, but we do own another record with the same name,
7679                     // then we'll want to mark it to generate an NSEC record on this interface
7680                     if (!NSECAnswer) NSECAnswer = rr;
7681                 }
7682             }
7683         }
7684 
7685         if (NumAnswersForThisQuestion == 0 && NSECAnswer)
7686         {
7687             NumAnswersForThisQuestion++;
7688             NSECAnswer->SendNSECNow = InterfaceID;
7689             m->NextScheduledResponse = m->timenow;
7690         }
7691 
7692         // If we couldn't answer this question, someone else might be able to,
7693         // so use random delay on response to reduce collisions
7694         if (NumAnswersForThisQuestion == 0) delayresponse = mDNSPlatformOneSecond;  // Divided by 50 = 20ms
7695 
7696         if (query->h.flags.b[0] & kDNSFlag0_TC)
7697             m->mDNSStats.KnownAnswerMultiplePkts++;
7698         // We only do the following accelerated cache expiration and duplicate question suppression processing
7699         // for non-truncated multicast queries with multicast responses.
7700         // For any query generating a unicast response we don't do this because we can't assume we will see the response.
7701         // For truncated queries we don't do this because a response we're expecting might be suppressed by a subsequent
7702         // known-answer packet, and when there's packet loss we can't safely assume we'll receive *all* known-answer packets.
7703         if (QuestionNeedsMulticastResponse && !(query->h.flags.b[0] & kDNSFlag0_TC))
7704         {
7705 #if POOF_ENABLED
7706             if (notD2D)
7707             {
7708                 CacheGroup *cg = CacheGroupForName(m, pktq.qnamehash, &pktq.qname);
7709                 CacheRecord *cr;
7710 
7711                 // Make a list indicating which of our own cache records we expect to see updated as a result of this query
7712                 // Note: Records larger than 1K are not habitually multicast, so don't expect those to be updated
7713                 for (cr = cg ? cg->members : mDNSNULL; cr; cr=cr->next)
7714                     if (SameNameRecordAnswersQuestion(&cr->resrec, &pktq) && cr->resrec.rdlength <= SmallRecordLimit)
7715                         if (!cr->NextInKAList && eap != &cr->NextInKAList)
7716                         {
7717                             *eap = cr;
7718                             eap = &cr->NextInKAList;
7719                         }
7720             }
7721 #endif // POOF_ENABLED
7722 
7723             // Check if this question is the same as any of mine.
7724             // We only do this for non-truncated queries. Right now it would be too complicated to try
7725             // to keep track of duplicate suppression state between multiple packets, especially when we
7726             // can't guarantee to receive all of the Known Answer packets that go with a particular query.
7727             // For anonymous question, the duplicate suppressesion should happen if the
7728             // question belongs in the same group. As the group is expected to be
7729             // small, we don't do the optimization for now.
7730             if (!pktq.AnonInfo)
7731             {
7732                 for (q = m->Questions; q; q=q->next)
7733                     if (!q->Target.type && ActiveQuestion(q) && m->timenow - q->LastQTxTime > mDNSPlatformOneSecond / 4)
7734                         if (!q->InterfaceID || q->InterfaceID == InterfaceID)
7735                             if (q->NextInDQList == mDNSNULL && dqp != &q->NextInDQList)
7736                                 if (q->qtype == pktq.qtype &&
7737                                     q->qclass == pktq.qclass &&
7738                                     q->qnamehash == pktq.qnamehash && SameDomainName(&q->qname, &pktq.qname))
7739                                 { *dqp = q; dqp = &q->NextInDQList; }
7740             }
7741         }
7742         if (pktq.AnonInfo)
7743         {
7744             FreeAnonInfo(pktq.AnonInfo);
7745         }
7746     }
7747 
7748     // ***
7749     // *** 3. Now we can safely build the list of marked answers
7750     // ***
7751     for (rr = m->ResourceRecords; rr; rr=rr->next)              // Now build our list of potential answers
7752         if (rr->NR_AnswerTo)                                    // If we marked the record...
7753             AddRecordToResponseList(&nrp, rr, mDNSNULL);        // ... add it to the list
7754 
7755     // ***
7756     // *** 4. Add additional records
7757     // ***
7758     AddAdditionalsToResponseList(m, ResponseRecords, &nrp, InterfaceID);
7759 
7760     // ***
7761     // *** 5. Parse Answer Section and cancel any records disallowed by Known-Answer list
7762     // ***
7763     for (i=0; i<query->h.numAnswers; i++)                       // For each record in the query's answer section...
7764     {
7765         // Get the record...
7766         CacheRecord *ourcacherr;
7767         ptr = GetLargeResourceRecord(m, query, ptr, end, InterfaceID, kDNSRecordTypePacketAns, &m->rec);
7768         if (!ptr) goto exit;
7769         if (m->rec.r.resrec.RecordType != kDNSRecordTypePacketNegative)
7770         {
7771             // See if this Known-Answer suppresses any of our currently planned answers
7772             for (rr=ResponseRecords; rr; rr=rr->NextResponse)
7773             {
7774                 if (MustSendRecord(rr) && ShouldSuppressKnownAnswer(&m->rec.r, rr))
7775                 {
7776                     m->mDNSStats.KnownAnswerSuppressions++;
7777                     rr->NR_AnswerTo = mDNSNULL;
7778                     rr->NR_AdditionalTo = mDNSNULL;
7779                 }
7780             }
7781 
7782             // See if this Known-Answer suppresses any previously scheduled answers (for multi-packet KA suppression)
7783             for (rr=m->ResourceRecords; rr; rr=rr->next)
7784             {
7785                 // If we're planning to send this answer on this interface, and only on this interface, then allow KA suppression
7786                 if (rr->ImmedAnswer == InterfaceID && ShouldSuppressKnownAnswer(&m->rec.r, rr))
7787                 {
7788                     if (srcaddr->type == mDNSAddrType_IPv4)
7789                     {
7790                         if (mDNSSameIPv4Address(rr->v4Requester, srcaddr->ip.v4)) rr->v4Requester = zerov4Addr;
7791                     }
7792                     else if (srcaddr->type == mDNSAddrType_IPv6)
7793                     {
7794                         if (mDNSSameIPv6Address(rr->v6Requester, srcaddr->ip.v6)) rr->v6Requester = zerov6Addr;
7795                     }
7796                     if (mDNSIPv4AddressIsZero(rr->v4Requester) && mDNSIPv6AddressIsZero(rr->v6Requester))
7797                     {
7798                         m->mDNSStats.KnownAnswerSuppressions++;
7799                         rr->ImmedAnswer  = mDNSNULL;
7800                         rr->ImmedUnicast = mDNSfalse;
7801     #if MDNS_LOG_ANSWER_SUPPRESSION_TIMES
7802                         LogMsg("Suppressed after%4d: %s", m->timenow - rr->ImmedAnswerMarkTime, ARDisplayString(m, rr));
7803     #endif
7804                     }
7805                 }
7806             }
7807 
7808             ourcacherr = FindIdenticalRecordInCache(m, &m->rec.r.resrec);
7809 
7810 #if POOF_ENABLED
7811             if (notD2D)
7812             {
7813                 // Having built our ExpectedAnswers list from the questions in this packet, we then remove
7814                 // any records that are suppressed by the Known Answer list in this packet.
7815                 eap = &ExpectedAnswers;
7816                 while (*eap)
7817                 {
7818                     CacheRecord *cr = *eap;
7819                     if (cr->resrec.InterfaceID == InterfaceID && IdenticalResourceRecord(&m->rec.r.resrec, &cr->resrec))
7820                     { *eap = cr->NextInKAList; cr->NextInKAList = mDNSNULL; }
7821                     else eap = &cr->NextInKAList;
7822                 }
7823             }
7824 #endif // POOF_ENABLED
7825 
7826             // See if this Known-Answer is a surprise to us. If so, we shouldn't suppress our own query.
7827             if (!ourcacherr)
7828             {
7829                 dqp = &DupQuestions;
7830                 while (*dqp)
7831                 {
7832                     DNSQuestion *q = *dqp;
7833                     if (ResourceRecordAnswersQuestion(&m->rec.r.resrec, q))
7834                     { *dqp = q->NextInDQList; q->NextInDQList = mDNSNULL; }
7835                     else dqp = &q->NextInDQList;
7836                 }
7837             }
7838         }
7839         m->rec.r.resrec.RecordType = 0;     // Clear RecordType to show we're not still using it
7840     }
7841 
7842     // ***
7843     // *** 6. Cancel any additionals that were added because of now-deleted records
7844     // ***
7845     for (rr=ResponseRecords; rr; rr=rr->NextResponse)
7846         if (rr->NR_AdditionalTo && !MustSendRecord(rr->NR_AdditionalTo))
7847         { rr->NR_AnswerTo = mDNSNULL; rr->NR_AdditionalTo = mDNSNULL; }
7848 
7849     // ***
7850     // *** 7. Mark the send flags on the records we plan to send
7851     // ***
7852     for (rr=ResponseRecords; rr; rr=rr->NextResponse)
7853     {
7854         if (rr->NR_AnswerTo)
7855         {
7856             mDNSBool SendMulticastResponse = mDNSfalse;     // Send modern multicast response
7857             mDNSBool SendUnicastResponse   = mDNSfalse;     // Send modern unicast response (not legacy unicast response)
7858 
7859             // If it's been one TTL/4 since we multicast this, then send a multicast response
7860             // for conflict detection, etc.
7861             if ((mDNSu32)(m->timenow - rr->LastMCTime) >= (mDNSu32)TicksTTL(rr)/4)
7862             {
7863                 SendMulticastResponse = mDNStrue;
7864                 // If this record was marked for modern (delayed) unicast response, then mark it as promoted to
7865                 // multicast response instead (don't want to end up ALSO setting SendUnicastResponse in the check below).
7866                 // If this record was marked for legacy unicast response, then we mustn't change the NR_AnswerTo value.
7867                 if (rr->NR_AnswerTo == NR_AnswerUnicast)
7868                 {
7869                     m->mDNSStats.UnicastDemotedToMulticast++;
7870                     rr->NR_AnswerTo = NR_AnswerMulticast;
7871                 }
7872             }
7873 
7874             // If the client insists on a multicast response, then we'd better send one
7875             if      (rr->NR_AnswerTo == NR_AnswerMulticast)
7876             {
7877                 m->mDNSStats.MulticastResponses++;
7878                 SendMulticastResponse = mDNStrue;
7879             }
7880             else if (rr->NR_AnswerTo == NR_AnswerUnicast)
7881             {
7882                 m->mDNSStats.UnicastResponses++;
7883                 SendUnicastResponse   = mDNStrue;
7884             }
7885             else if (rr->NR_AnswerTo)
7886             {
7887                 SendLegacyResponse    = mDNStrue;
7888             }
7889 
7890             if (SendMulticastResponse || SendUnicastResponse)
7891             {
7892 #if MDNS_LOG_ANSWER_SUPPRESSION_TIMES
7893                 rr->ImmedAnswerMarkTime = m->timenow;
7894 #endif
7895                 m->NextScheduledResponse = m->timenow;
7896                 // If we're already planning to send this on another interface, just send it on all interfaces
7897                 if (rr->ImmedAnswer && rr->ImmedAnswer != InterfaceID)
7898                     rr->ImmedAnswer = mDNSInterfaceMark;
7899                 else
7900                 {
7901                     rr->ImmedAnswer = InterfaceID;          // Record interface to send it on
7902                     if (SendUnicastResponse) rr->ImmedUnicast = mDNStrue;
7903                     if (srcaddr->type == mDNSAddrType_IPv4)
7904                     {
7905                         if      (mDNSIPv4AddressIsZero(rr->v4Requester)) rr->v4Requester = srcaddr->ip.v4;
7906                         else if (!mDNSSameIPv4Address(rr->v4Requester, srcaddr->ip.v4)) rr->v4Requester = onesIPv4Addr;
7907                     }
7908                     else if (srcaddr->type == mDNSAddrType_IPv6)
7909                     {
7910                         if      (mDNSIPv6AddressIsZero(rr->v6Requester)) rr->v6Requester = srcaddr->ip.v6;
7911                         else if (!mDNSSameIPv6Address(rr->v6Requester, srcaddr->ip.v6)) rr->v6Requester = onesIPv6Addr;
7912                     }
7913                 }
7914             }
7915             // If TC flag is set, it means we should expect that additional known answers may be coming in another packet,
7916             // so we allow roughly half a second before deciding to reply (we've observed inter-packet delays of 100-200ms on 802.11)
7917             // else, if record is a shared one, spread responses over 100ms to avoid implosion of simultaneous responses
7918             // else, for a simple unique record reply, we can reply immediately; no need for delay
7919             if      (query->h.flags.b[0] & kDNSFlag0_TC) delayresponse = mDNSPlatformOneSecond * 20;            // Divided by 50 = 400ms
7920             else if (rr->resrec.RecordType == kDNSRecordTypeShared) delayresponse = mDNSPlatformOneSecond;      // Divided by 50 = 20ms
7921         }
7922         else if (rr->NR_AdditionalTo && rr->NR_AdditionalTo->NR_AnswerTo == NR_AnswerMulticast)
7923         {
7924             // Since additional records are an optimization anyway, we only ever send them on one interface at a time
7925             // If two clients on different interfaces do queries that invoke the same optional additional answer,
7926             // then the earlier client is out of luck
7927             rr->ImmedAdditional = InterfaceID;
7928             // No need to set m->NextScheduledResponse here
7929             // We'll send these additional records when we send them, or not, as the case may be
7930         }
7931     }
7932 
7933     // ***
7934     // *** 8. If we think other machines are likely to answer these questions, set our packet suppression timer
7935     // ***
7936     if (delayresponse && (!m->SuppressSending || (m->SuppressSending - m->timenow) < (delayresponse + 49) / 50))
7937     {
7938 #if MDNS_LOG_ANSWER_SUPPRESSION_TIMES
7939         mDNSs32 oldss = m->SuppressSending;
7940         if (oldss && delayresponse)
7941             LogMsg("Current SuppressSending delay%5ld; require%5ld", m->SuppressSending - m->timenow, (delayresponse + 49) / 50);
7942 #endif
7943         // Pick a random delay:
7944         // We start with the base delay chosen above (typically either 1 second or 20 seconds),
7945         // and add a random value in the range 0-5 seconds (making 1-6 seconds or 20-25 seconds).
7946         // This is an integer value, with resolution determined by the platform clock rate.
7947         // We then divide that by 50 to get the delay value in ticks. We defer the division until last
7948         // to get better results on platforms with coarse clock granularity (e.g. ten ticks per second).
7949         // The +49 before dividing is to ensure we round up, not down, to ensure that even
7950         // on platforms where the native clock rate is less than fifty ticks per second,
7951         // we still guarantee that the final calculated delay is at least one platform tick.
7952         // We want to make sure we don't ever allow the delay to be zero ticks,
7953         // because if that happens we'll fail the Bonjour Conformance Test.
7954         // Our final computed delay is 20-120ms for normal delayed replies,
7955         // or 400-500ms in the case of multi-packet known-answer lists.
7956         m->SuppressSending = m->timenow + (delayresponse + (mDNSs32)mDNSRandom((mDNSu32)mDNSPlatformOneSecond*5) + 49) / 50;
7957         if (m->SuppressSending == 0) m->SuppressSending = 1;
7958 #if MDNS_LOG_ANSWER_SUPPRESSION_TIMES
7959         if (oldss && delayresponse)
7960             LogMsg("Set     SuppressSending to   %5ld", m->SuppressSending - m->timenow);
7961 #endif
7962     }
7963 
7964     // ***
7965     // *** 9. If query is from a legacy client, or from a new client requesting a unicast reply, then generate a unicast response too
7966     // ***
7967     if (SendLegacyResponse)
7968         responseptr = GenerateUnicastResponse(query, end, InterfaceID, LegacyQuery, response, ResponseRecords);
7969 
7970 exit:
7971     m->rec.r.resrec.RecordType = 0;     // Clear RecordType to show we're not still using it
7972 
7973     // ***
7974     // *** 10. Finally, clear our link chains ready for use next time
7975     // ***
7976     while (ResponseRecords)
7977     {
7978         rr = ResponseRecords;
7979         ResponseRecords = rr->NextResponse;
7980         rr->NextResponse    = mDNSNULL;
7981         rr->NR_AnswerTo     = mDNSNULL;
7982         rr->NR_AdditionalTo = mDNSNULL;
7983     }
7984 
7985 #if POOF_ENABLED
7986     while (ExpectedAnswers && notD2D)
7987     {
7988         CacheRecord *cr = ExpectedAnswers;
7989         ExpectedAnswers = cr->NextInKAList;
7990         cr->NextInKAList = mDNSNULL;
7991 
7992         // For non-truncated queries, we can definitively say that we should expect
7993         // to be seeing a response for any records still left in the ExpectedAnswers list
7994         if (!(query->h.flags.b[0] & kDNSFlag0_TC))
7995             if (cr->UnansweredQueries == 0 || m->timenow - cr->LastUnansweredTime >= mDNSPlatformOneSecond * 3/4)
7996             {
7997                 cr->UnansweredQueries++;
7998                 cr->LastUnansweredTime = m->timenow;
7999                 if (cr->UnansweredQueries > 1)
8000                         debugf("ProcessQuery: UnansweredQueries %lu %s", cr->UnansweredQueries, CRDisplayString(m, cr));
8001                 SetNextCacheCheckTimeForRecord(m, cr);
8002             }
8003 
8004         // If we've seen multiple unanswered queries for this record,
8005         // then mark it to expire in five seconds if we don't get a response by then.
8006         if (cr->UnansweredQueries >= MaxUnansweredQueries)
8007         {
8008             // Only show debugging message if this record was not about to expire anyway
8009             if (RRExpireTime(cr) - m->timenow > (mDNSs32) kDefaultReconfirmTimeForNoAnswer * 4 / 3 + mDNSPlatformOneSecond)
8010                     LogInfo("ProcessQuery: UnansweredQueries %lu interface %lu TTL %lu mDNS_Reconfirm() for %s",
8011                        cr->UnansweredQueries, InterfaceID, (RRExpireTime(cr) - m->timenow + mDNSPlatformOneSecond-1) / mDNSPlatformOneSecond, CRDisplayString(m, cr));
8012 
8013             m->mDNSStats.PoofCacheDeletions++;
8014             mDNS_Reconfirm_internal(m, cr, kDefaultReconfirmTimeForNoAnswer);
8015         }
8016     }
8017 #endif // POOF_ENABLED
8018 
8019     while (DupQuestions)
8020     {
8021         DNSQuestion *q = DupQuestions;
8022         DupQuestions = q->NextInDQList;
8023         q->NextInDQList = mDNSNULL;
8024         RecordDupSuppressInfo(q->DupSuppress, m->timenow, InterfaceID, srcaddr->type);
8025         debugf("ProcessQuery: Recorded DSI for %##s (%s) on %p/%s", q->qname.c, DNSTypeName(q->qtype), InterfaceID,
8026                srcaddr->type == mDNSAddrType_IPv4 ? "v4" : "v6");
8027     }
8028 
8029     if (McastNSEC3Records)
8030     {
8031         debugf("ProcessQuery: McastNSEC3Records not used");
8032         FreeNSECRecords(m, McastNSEC3Records);
8033     }
8034 
8035     return(responseptr);
8036 }
8037 
8038 mDNSlocal void mDNSCoreReceiveQuery(mDNS *const m, const DNSMessage *const msg, const mDNSu8 *const end,
8039                                     const mDNSAddr *srcaddr, const mDNSIPPort srcport, const mDNSAddr *dstaddr, mDNSIPPort dstport,
8040                                     const mDNSInterfaceID InterfaceID)
8041 {
8042     mDNSu8    *responseend = mDNSNULL;
8043     mDNSBool QueryWasLocalUnicast = srcaddr && dstaddr &&
8044                                     !mDNSAddrIsDNSMulticast(dstaddr) && mDNS_AddressIsLocalSubnet(m, InterfaceID, srcaddr);
8045 
8046     if (!dstaddr || (!InterfaceID && mDNSAddrIsDNSMulticast(dstaddr)))
8047     {
8048         const char *const reason = !dstaddr ? "Received over TCP connection" : "Multicast, but no InterfaceID";
8049         LogMsg("Ignoring Query from %#-15a:%-5d to %#-15a:%-5d on 0x%p with "
8050                "%2d Question%s %2d Answer%s %2d Authorit%s %2d Additional%s %d bytes (%s)",
8051                srcaddr, mDNSVal16(srcport), dstaddr, mDNSVal16(dstport), InterfaceID,
8052                msg->h.numQuestions,   msg->h.numQuestions   == 1 ? ", "   : "s,",
8053                msg->h.numAnswers,     msg->h.numAnswers     == 1 ? ", "   : "s,",
8054                msg->h.numAuthorities, msg->h.numAuthorities == 1 ? "y,  " : "ies,",
8055                msg->h.numAdditionals, msg->h.numAdditionals == 1 ? " "    : "s", end - msg->data, reason);
8056         return;
8057     }
8058 
8059     verbosedebugf("Received Query from %#-15a:%-5d to %#-15a:%-5d on 0x%p with "
8060                   "%2d Question%s %2d Answer%s %2d Authorit%s %2d Additional%s %d bytes",
8061                   srcaddr, mDNSVal16(srcport), dstaddr, mDNSVal16(dstport), InterfaceID,
8062                   msg->h.numQuestions,   msg->h.numQuestions   == 1 ? ", "   : "s,",
8063                   msg->h.numAnswers,     msg->h.numAnswers     == 1 ? ", "   : "s,",
8064                   msg->h.numAuthorities, msg->h.numAuthorities == 1 ? "y,  " : "ies,",
8065                   msg->h.numAdditionals, msg->h.numAdditionals == 1 ? " "    : "s", end - msg->data);
8066 
8067     responseend = ProcessQuery(m, msg, end, srcaddr, InterfaceID,
8068                                !mDNSSameIPPort(srcport, MulticastDNSPort), mDNSAddrIsDNSMulticast(dstaddr), QueryWasLocalUnicast, &m->omsg);
8069 
8070     if (responseend)    // If responseend is non-null, that means we built a unicast response packet
8071     {
8072         debugf("Unicast Response: %d Question%s, %d Answer%s, %d Additional%s to %#-15a:%d on %p/%ld",
8073                m->omsg.h.numQuestions,   m->omsg.h.numQuestions   == 1 ? "" : "s",
8074                m->omsg.h.numAnswers,     m->omsg.h.numAnswers     == 1 ? "" : "s",
8075                m->omsg.h.numAdditionals, m->omsg.h.numAdditionals == 1 ? "" : "s",
8076                srcaddr, mDNSVal16(srcport), InterfaceID, srcaddr->type);
8077         mDNSSendDNSMessage(m, &m->omsg, responseend, InterfaceID, mDNSNULL, srcaddr, srcport, mDNSNULL, mDNSNULL, mDNSfalse);
8078     }
8079 }
8080 
8081 #if 0
8082 mDNSlocal mDNSBool TrustedSource(const mDNS *const m, const mDNSAddr *const srcaddr)
8083 {
8084     DNSServer *s;
8085     (void)m; // Unused
8086     (void)srcaddr; // Unused
8087     for (s = m->DNSServers; s; s = s->next)
8088         if (mDNSSameAddress(srcaddr, &s->addr)) return(mDNStrue);
8089     return(mDNSfalse);
8090 }
8091 #endif
8092 
8093 struct UDPSocket_struct
8094 {
8095     mDNSIPPort port; // MUST BE FIRST FIELD -- mDNSCoreReceive expects every UDPSocket_struct to begin with mDNSIPPort port
8096 };
8097 
8098 mDNSlocal DNSQuestion *ExpectingUnicastResponseForQuestion(const mDNS *const m, const mDNSIPPort port, const mDNSOpaque16 id, const DNSQuestion *const question, mDNSBool tcp, DNSQuestion ** suspiciousQ)
8099 {
8100     DNSQuestion *q;
8101     for (q = m->Questions; q; q=q->next)
8102     {
8103         if (!tcp && !q->LocalSocket) continue;
8104         if (mDNSSameIPPort(tcp ? q->tcpSrcPort : q->LocalSocket->port, port)       &&
8105             q->qtype                  == question->qtype     &&
8106             q->qclass                 == question->qclass    &&
8107             q->qnamehash              == question->qnamehash &&
8108             SameDomainName(&q->qname, &question->qname))
8109         {
8110             if (mDNSSameOpaque16(q->TargetQID, id)) return(q);
8111             else
8112             {
8113                 if (!tcp && suspiciousQ) *suspiciousQ = q;
8114                 return(mDNSNULL);
8115             }
8116         }
8117     }
8118     return(mDNSNULL);
8119 }
8120 
8121 // This function is called when we receive a unicast response. This could be the case of a unicast response from the
8122 // DNS server or a response to the QU query. Hence, the cache record's InterfaceId can be both NULL or non-NULL (QU case)
8123 mDNSlocal DNSQuestion *ExpectingUnicastResponseForRecord(mDNS *const m,
8124                                                          const mDNSAddr *const srcaddr, const mDNSBool SrcLocal, const mDNSIPPort port, const mDNSOpaque16 id, const CacheRecord *const rr, mDNSBool tcp)
8125 {
8126     DNSQuestion *q;
8127     (void)id;
8128     (void)srcaddr;
8129 
8130     for (q = m->Questions; q; q=q->next)
8131     {
8132         if (!q->DuplicateOf && ResourceRecordAnswersUnicastResponse(&rr->resrec, q))
8133         {
8134             if (!mDNSOpaque16IsZero(q->TargetQID))
8135             {
8136                 debugf("ExpectingUnicastResponseForRecord msg->h.id %d q->TargetQID %d for %s", mDNSVal16(id), mDNSVal16(q->TargetQID), CRDisplayString(m, rr));
8137 
8138                 if (mDNSSameOpaque16(q->TargetQID, id))
8139                 {
8140                     mDNSIPPort srcp;
8141                     if (!tcp)
8142                     {
8143 			if (q->LocalSocket)
8144                             srcp = q->LocalSocket->port;
8145 			else
8146                             srcp = zeroIPPort;
8147                     }
8148                     else
8149                     {
8150                         srcp = q->tcpSrcPort;
8151                     }
8152                     if (mDNSSameIPPort(srcp, port)) return(q);
8153 
8154                     //  if (mDNSSameAddress(srcaddr, &q->Target))                   return(mDNStrue);
8155                     //  if (q->LongLived && mDNSSameAddress(srcaddr, &q->servAddr)) return(mDNStrue); Shouldn't need this now that we have LLQType checking
8156                     //  if (TrustedSource(m, srcaddr))                              return(mDNStrue);
8157                     LogInfo("WARNING: Ignoring suspect uDNS response for %##s (%s) [q->Target %#a:%d] from %#a:%d %s",
8158                             q->qname.c, DNSTypeName(q->qtype), &q->Target, mDNSVal16(srcp), srcaddr, mDNSVal16(port), CRDisplayString(m, rr));
8159                     return(mDNSNULL);
8160                 }
8161             }
8162             else
8163             {
8164                 if (SrcLocal && q->ExpectUnicastResp && (mDNSu32)(m->timenow - q->ExpectUnicastResp) < (mDNSu32)(mDNSPlatformOneSecond*2))
8165                     return(q);
8166             }
8167         }
8168     }
8169     return(mDNSNULL);
8170 }
8171 
8172 // Certain data types need more space for in-memory storage than their in-packet rdlength would imply
8173 // Currently this applies only to rdata types containing more than one domainname,
8174 // or types where the domainname is not the last item in the structure.
8175 mDNSlocal mDNSu16 GetRDLengthMem(const ResourceRecord *const rr)
8176 {
8177     switch (rr->rrtype)
8178     {
8179     case kDNSType_SOA: return sizeof(rdataSOA);
8180     case kDNSType_RP:  return sizeof(rdataRP);
8181     case kDNSType_PX:  return sizeof(rdataPX);
8182     default:           return rr->rdlength;
8183     }
8184 }
8185 
8186 mDNSexport CacheRecord *CreateNewCacheEntry(mDNS *const m, const mDNSu32 slot, CacheGroup *cg, mDNSs32 delay, mDNSBool Add, const mDNSAddr *sourceAddress)
8187 {
8188     CacheRecord *rr = mDNSNULL;
8189     mDNSu16 RDLength = GetRDLengthMem(&m->rec.r.resrec);
8190 
8191     if (!m->rec.r.resrec.InterfaceID) debugf("CreateNewCacheEntry %s", CRDisplayString(m, &m->rec.r));
8192 
8193     //if (RDLength > InlineCacheRDSize)
8194     //  LogInfo("Rdata len %4d > InlineCacheRDSize %d %s", RDLength, InlineCacheRDSize, CRDisplayString(m, &m->rec.r));
8195 
8196     if (!cg) cg = GetCacheGroup(m, slot, &m->rec.r.resrec); // If we don't have a CacheGroup for this name, make one now
8197     if (cg) rr = GetCacheRecord(m, cg, RDLength);   // Make a cache record, being careful not to recycle cg
8198     if (!rr) NoCacheAnswer(m, &m->rec.r);
8199     else
8200     {
8201         RData *saveptr         = rr->resrec.rdata;   // Save the rr->resrec.rdata pointer
8202         *rr                    = m->rec.r;           // Block copy the CacheRecord object
8203         rr->resrec.rdata       = saveptr;            // Restore rr->resrec.rdata after the structure assignment
8204         rr->resrec.name        = cg->name;           // And set rr->resrec.name to point into our CacheGroup header
8205         rr->resrec.mortality   = Mortality_Mortal;
8206 
8207         // We need to add the anonymous info before we call CacheRecordAdd so that
8208         // if it finds a matching question with this record, it bumps up the counters like
8209         // CurrentAnswers etc. Otherwise, when a cache entry gets removed, CacheRecordRmv
8210         // will complain.
8211         if (m->rec.r.resrec.AnonInfo)
8212         {
8213             rr->resrec.AnonInfo = m->rec.r.resrec.AnonInfo;
8214             m->rec.r.resrec.AnonInfo = mDNSNULL;
8215         }
8216         rr->DelayDelivery = delay;
8217 
8218         // If this is an oversized record with external storage allocated, copy rdata to external storage
8219         if      (rr->resrec.rdata == (RData*)&rr->smallrdatastorage && RDLength > InlineCacheRDSize)
8220             LogMsg("rr->resrec.rdata == &rr->rdatastorage but length > InlineCacheRDSize %##s", m->rec.r.resrec.name->c);
8221         else if (rr->resrec.rdata != (RData*)&rr->smallrdatastorage && RDLength <= InlineCacheRDSize)
8222             LogMsg("rr->resrec.rdata != &rr->rdatastorage but length <= InlineCacheRDSize %##s", m->rec.r.resrec.name->c);
8223         if (RDLength > InlineCacheRDSize)
8224             mDNSPlatformMemCopy(rr->resrec.rdata, m->rec.r.resrec.rdata, sizeofRDataHeader + RDLength);
8225 
8226         rr->next = mDNSNULL;                    // Clear 'next' pointer
8227         rr->nsec = mDNSNULL;
8228         rr->soa  = mDNSNULL;
8229 
8230         if (sourceAddress)
8231             rr->sourceAddress = *sourceAddress;
8232 
8233         if (!rr->resrec.InterfaceID)
8234         {
8235             m->rrcache_totalused_unicast += rr->resrec.rdlength;
8236             if (DNSSECRecordType(rr->resrec.rrtype))
8237                 BumpDNSSECStats(m, kStatsActionIncrement, kStatsTypeMemoryUsage, rr->resrec.rdlength);
8238         }
8239 
8240         if (Add)
8241         {
8242             *(cg->rrcache_tail) = rr;               // Append this record to tail of cache slot list
8243             cg->rrcache_tail = &(rr->next);         // Advance tail pointer
8244             CacheRecordAdd(m, rr);  // CacheRecordAdd calls SetNextCacheCheckTimeForRecord(m, rr); for us
8245         }
8246         else
8247         {
8248             // Can't use the "cg->name" if we are not adding to the cache as the
8249             // CacheGroup may be released anytime if it is empty
8250             domainname *name = mDNSPlatformMemAllocate(DomainNameLength(cg->name));
8251             if (name)
8252             {
8253                 AssignDomainName(name, cg->name);
8254                 rr->resrec.name   = name;
8255             }
8256             else
8257             {
8258                 ReleaseCacheRecord(m, rr);
8259                 NoCacheAnswer(m, &m->rec.r);
8260                 rr = mDNSNULL;
8261             }
8262         }
8263     }
8264     return(rr);
8265 }
8266 
8267 mDNSlocal void RefreshCacheRecord(mDNS *const m, CacheRecord *rr, mDNSu32 ttl)
8268 {
8269     rr->TimeRcvd             = m->timenow;
8270     rr->resrec.rroriginalttl = ttl;
8271     rr->UnansweredQueries = 0;
8272     if (rr->resrec.mortality != Mortality_Mortal) rr->resrec.mortality = Mortality_Immortal;
8273     SetNextCacheCheckTimeForRecord(m, rr);
8274 }
8275 
8276 mDNSexport void GrantCacheExtensions(mDNS *const m, DNSQuestion *q, mDNSu32 lease)
8277 {
8278     CacheRecord *rr;
8279     CacheGroup *cg = CacheGroupForName(m, q->qnamehash, &q->qname);
8280     for (rr = cg ? cg->members : mDNSNULL; rr; rr=rr->next)
8281         if (rr->CRActiveQuestion == q)
8282         {
8283             //LogInfo("GrantCacheExtensions: new lease %d / %s", lease, CRDisplayString(m, rr));
8284             RefreshCacheRecord(m, rr, lease);
8285         }
8286 }
8287 
8288 mDNSlocal mDNSu32 GetEffectiveTTL(const uDNS_LLQType LLQType, mDNSu32 ttl)      // TTL in seconds
8289 {
8290     if      (LLQType == uDNS_LLQ_Entire) ttl = kLLQ_DefLease;
8291     else if (LLQType == uDNS_LLQ_Events)
8292     {
8293         // If the TTL is -1 for uDNS LLQ event packet, that means "remove"
8294         if (ttl == 0xFFFFFFFF) ttl = 0;
8295         else ttl = kLLQ_DefLease;
8296     }
8297     else    // else not LLQ (standard uDNS response)
8298     {
8299         // The TTL is already capped to a maximum value in GetLargeResourceRecord, but just to be extra safe we
8300         // also do this check here to make sure we can't get overflow below when we add a quarter to the TTL
8301         if (ttl > 0x60000000UL / mDNSPlatformOneSecond) ttl = 0x60000000UL / mDNSPlatformOneSecond;
8302 
8303         ttl = RRAdjustTTL(ttl);
8304 
8305         // For mDNS, TTL zero means "delete this record"
8306         // For uDNS, TTL zero means: this data is true at this moment, but don't cache it.
8307         // For the sake of network efficiency, we impose a minimum effective TTL of 15 seconds.
8308         // This means that we'll do our 80, 85, 90, 95% queries at 12.00, 12.75, 13.50, 14.25 seconds
8309         // respectively, and then if we get no response, delete the record from the cache at 15 seconds.
8310         // This gives the server up to three seconds to respond between when we send our 80% query at 12 seconds
8311         // and when we delete the record at 15 seconds. Allowing cache lifetimes less than 15 seconds would
8312         // (with the current code) result in the server having even less than three seconds to respond
8313         // before we deleted the record and reported a "remove" event to any active questions.
8314         // Furthermore, with the current code, if we were to allow a TTL of less than 2 seconds
8315         // then things really break (e.g. we end up making a negative cache entry).
8316         // In the future we may want to revisit this and consider properly supporting non-cached (TTL=0) uDNS answers.
8317         if (ttl < 15) ttl = 15;
8318     }
8319 
8320     return ttl;
8321 }
8322 
8323 // When the response does not match the question directly, we still want to cache them sometimes. The current response is
8324 // in m->rec.
8325 mDNSlocal mDNSBool IsResponseAcceptable(mDNS *const m, const CacheRecord *crlist, DNSQuestion *q, mDNSBool *nseclist)
8326 {
8327     CacheRecord *const newcr = &m->rec.r;
8328     ResourceRecord *rr = &newcr->resrec;
8329     const CacheRecord *cr;
8330 
8331     *nseclist = mDNSfalse;
8332     for (cr = crlist; cr != (CacheRecord*)1; cr = cr->NextInCFList)
8333     {
8334         domainname *target = GetRRDomainNameTarget(&cr->resrec);
8335         // When we issue a query for A record, the response might contain both a CNAME and A records. Only the CNAME would
8336         // match the question and we already created a cache entry in the previous pass of this loop. Now when we process
8337         // the A record, it does not match the question because the record name here is the CNAME. Hence we try to
8338         // match with the previous records to make it an AcceptableResponse. We have to be careful about setting the
8339         // DNSServer value that we got in the previous pass. This can happen for other record types like SRV also.
8340 
8341         if (target && cr->resrec.rdatahash == rr->namehash && SameDomainName(target, rr->name))
8342         {
8343             LogDebug("IsResponseAcceptable: Found a matching entry for %##s in the CacheFlushRecords %s", rr->name->c, CRDisplayString(m, cr));
8344             return (mDNStrue);
8345         }
8346     }
8347 
8348     // Either the question requires validation or we are validating a response with DNSSEC in which case
8349     // we need to accept the RRSIGs also so that we can validate the response. It is also possible that
8350     // we receive NSECs for our query which does not match the qname and we need to cache in that case
8351     // too. nseclist is set if they have to be cached as part of the negative cache record.
8352     if (q && DNSSECQuestion(q))
8353     {
8354         mDNSBool same = SameDomainName(&q->qname, rr->name);
8355         if (same && (q->qtype == rr->rrtype || rr->rrtype == kDNSType_CNAME))
8356         {
8357             LogInfo("IsResponseAcceptable: Accepting, same name and qtype %s, CR %s", DNSTypeName(q->qtype),
8358                     CRDisplayString(m, newcr));
8359             return mDNStrue;
8360         }
8361         // We cache RRSIGS if it covers the question type or NSEC.  If it covers a NSEC,
8362         // "nseclist" is set
8363         if (rr->rrtype == kDNSType_RRSIG)
8364         {
8365             RDataBody2 *const rdb = (RDataBody2 *)newcr->smallrdatastorage.data;
8366             rdataRRSig *rrsig = &rdb->rrsig;
8367             mDNSu16 typeCovered = swap16(rrsig->typeCovered);
8368 
8369             // Note the ordering. If we are looking up the NSEC record, then the RRSIG's typeCovered
8370             // would match the qtype and they are cached normally as they are not used to prove the
8371             // non-existence of any name. In that case, it is like any other normal dnssec validation
8372             // and hence nseclist should not be set.
8373 
8374             if (same && ((typeCovered == q->qtype) || (typeCovered == kDNSType_CNAME)))
8375             {
8376                 LogInfo("IsResponseAcceptable: Accepting RRSIG %s matches question type %s", CRDisplayString(m, newcr),
8377                         DNSTypeName(q->qtype));
8378                 return mDNStrue;
8379             }
8380             else if (typeCovered == kDNSType_NSEC || typeCovered == kDNSType_NSEC3)
8381             {
8382                 LogInfo("IsResponseAcceptable: Accepting RRSIG %s matches %s type (nseclist = 1)", CRDisplayString(m, newcr), DNSTypeName(typeCovered));
8383                 *nseclist = mDNStrue;
8384                 return mDNStrue;
8385             }
8386             else if (typeCovered == kDNSType_SOA)
8387             {
8388                 LogInfo("IsResponseAcceptable: Accepting RRSIG %s matches SOA type (nseclist = 1)", CRDisplayString(m, newcr));
8389                 *nseclist = mDNStrue;
8390                 return mDNStrue;
8391             }
8392             else return mDNSfalse;
8393         }
8394         if (rr->rrtype == kDNSType_NSEC)
8395         {
8396             if (!UNICAST_NSEC(rr))
8397             {
8398                 LogMsg("IsResponseAcceptable: ERROR!! Not a unicast NSEC %s", CRDisplayString(m, newcr));
8399                 return mDNSfalse;
8400             }
8401             LogInfo("IsResponseAcceptable: Accepting NSEC %s (nseclist = 1)", CRDisplayString(m, newcr));
8402             *nseclist = mDNStrue;
8403             return mDNStrue;
8404         }
8405         if (rr->rrtype == kDNSType_SOA)
8406         {
8407             LogInfo("IsResponseAcceptable: Accepting SOA %s (nseclist = 1)", CRDisplayString(m, newcr));
8408             *nseclist = mDNStrue;
8409             return mDNStrue;
8410         }
8411         else if (rr->rrtype == kDNSType_NSEC3)
8412         {
8413             LogInfo("IsResponseAcceptable: Accepting NSEC3 %s (nseclist = 1)", CRDisplayString(m, newcr));
8414             *nseclist = mDNStrue;
8415             return mDNStrue;
8416         }
8417     }
8418     return mDNSfalse;
8419 }
8420 
8421 mDNSlocal void FreeNSECRecords(mDNS *const m, CacheRecord *NSECRecords)
8422 {
8423     CacheRecord *rp, *next;
8424 
8425     for (rp = NSECRecords; rp; rp = next)
8426     {
8427         next = rp->next;
8428         ReleaseCacheRecord(m, rp);
8429     }
8430 }
8431 
8432 // If we received zero DNSSEC records even when the DO/EDNS0 bit was set, we need to provide this
8433 // information to ValidatingResponse question to indicate the DNSSEC status to the application
8434 mDNSlocal void mDNSCoreReceiveNoDNSSECAnswers(mDNS *const m, const DNSMessage *const response, const mDNSu8 *end, const mDNSAddr *dstaddr,
8435     mDNSIPPort dstport, const mDNSInterfaceID InterfaceID)
8436 {
8437     int i;
8438     const mDNSu8 *ptr = response->data;
8439 
8440     for (i = 0; i < response->h.numQuestions && ptr && ptr < end; i++)
8441     {
8442         DNSQuestion pktq;
8443         DNSQuestion *qptr = mDNSNULL;
8444         ptr = getQuestion(response, ptr, end, InterfaceID, &pktq);
8445         if (ptr && (qptr = ExpectingUnicastResponseForQuestion(m, dstport, response->h.id, &pktq, !dstaddr, mDNSNULL)) &&
8446             qptr->ValidatingResponse)
8447         {
8448             DNSQuestion *next, *q;
8449 
8450             if (qptr->DuplicateOf)
8451                 LogMsg("mDNSCoreReceiveNoDNSSECAnswers: ERROR!! qptr %##s (%s) Duplicate question matching response", qptr->qname.c, DNSTypeName(qptr->qtype));
8452 
8453             // Be careful to call the callback for duplicate questions first and then the original
8454             // question. If we called the callback on the original question, it could stop and
8455             // a duplicate question would become the original question.
8456             mDNS_DropLockBeforeCallback();      // Allow client (and us) to legally make mDNS API calls
8457             for (q = qptr->next ; q && q != m->NewQuestions; q = next)
8458             {
8459                 next = q->next;
8460                 if (q->DuplicateOf == qptr)
8461                 {
8462                     if (q->ValidatingResponse)
8463                         LogInfo("mDNSCoreReceiveNoDNSSECAnswers: qptr %##s (%s) Duplicate question found", q->qname.c, DNSTypeName(q->qtype));
8464                     else
8465                         LogMsg("mDNSCoreReceiveNoDNSSECAnswers: ERROR!! qptr %##s (%s) Duplicate question not ValidatingResponse", q->qname.c, DNSTypeName(q->qtype));
8466                     if (q->QuestionCallback)
8467                         q->QuestionCallback(m, q, mDNSNULL, QC_nodnssec);
8468                 }
8469             }
8470             if (qptr->QuestionCallback)
8471                 qptr->QuestionCallback(m, qptr, mDNSNULL, QC_nodnssec);
8472             mDNS_ReclaimLockAfterCallback();    // Decrement mDNS_reentrancy to block mDNS API calls again
8473         }
8474     }
8475 }
8476 
8477 mDNSlocal void mDNSCoreReceiveNoUnicastAnswers(mDNS *const m, const DNSMessage *const response, const mDNSu8 *end, const mDNSAddr *dstaddr,
8478                                                mDNSIPPort dstport, const mDNSInterfaceID InterfaceID, uDNS_LLQType LLQType, mDNSu8 rcode, CacheRecord *NSECRecords)
8479 {
8480     int i;
8481     const mDNSu8 *ptr   = response->data;
8482     CacheRecord *SOARecord = mDNSNULL;
8483 
8484     for (i = 0; i < response->h.numQuestions && ptr && ptr < end; i++)
8485     {
8486         DNSQuestion q;
8487         DNSQuestion *qptr = mDNSNULL;
8488         ptr = getQuestion(response, ptr, end, InterfaceID, &q);
8489         if (ptr && (qptr = ExpectingUnicastResponseForQuestion(m, dstport, response->h.id, &q, !dstaddr, mDNSNULL)))
8490         {
8491             CacheRecord *rr, *neg = mDNSNULL;
8492             CacheGroup *cg = CacheGroupForName(m, q.qnamehash, &q.qname);
8493             for (rr = cg ? cg->members : mDNSNULL; rr; rr=rr->next)
8494                 if (SameNameRecordAnswersQuestion(&rr->resrec, qptr))
8495                 {
8496                     // 1. If we got a fresh answer to this query, then don't need to generate a negative entry
8497                     if (RRExpireTime(rr) - m->timenow > 0) break;
8498                     // 2. If we already had a negative entry, keep track of it so we can resurrect it instead of creating a new one
8499                     if (rr->resrec.RecordType == kDNSRecordTypePacketNegative) neg = rr;
8500                 }
8501             // When we're doing parallel unicast and multicast queries for dot-local names (for supporting Microsoft
8502             // Active Directory sites) we don't want to waste memory making negative cache entries for all the unicast answers.
8503             // Otherwise we just fill up our cache with negative entries for just about every single multicast name we ever look up
8504             // (since the Microsoft Active Directory server is going to assert that pretty much every single multicast name doesn't exist).
8505             // This is not only a waste of memory, but there's also the problem of those negative entries confusing us later -- e.g. we
8506             // suppress sending our mDNS query packet because we think we already have a valid (negative) answer to that query in our cache.
8507             // The one exception is that we *DO* want to make a negative cache entry for "local. SOA", for the (common) case where we're
8508             // *not* on a Microsoft Active Directory network, and there is no authoritative server for "local". Note that this is not
8509             // in conflict with the mDNS spec, because that spec says, "Multicast DNS Zones have no SOA record," so it's okay to cache
8510             // negative answers for "local. SOA" from a uDNS server, because the mDNS spec already says that such records do not exist :-)
8511             //
8512             // By suppressing negative responses, it might take longer to timeout a .local question as it might be expecting a
8513             // response e.g., we deliver a positive "A" response and suppress negative "AAAA" response and the upper layer may
8514             // be waiting longer to get the AAAA response before returning the "A" response to the application. To handle this
8515             // case without creating the negative cache entries, we generate a negative response and let the layer above us
8516             // do the appropriate thing. This negative response is also needed for appending new search domains.
8517             if (!InterfaceID && q.qtype != kDNSType_SOA && IsLocalDomain(&q.qname))
8518             {
8519                 if (!rr)
8520                 {
8521                     LogInfo("mDNSCoreReceiveNoUnicastAnswers: Generate negative response for %##s (%s)", q.qname.c, DNSTypeName(q.qtype));
8522                     m->CurrentQuestion = qptr;
8523                     // We are not creating a cache record in this case, we need to pass back
8524                     // the error we got so that the proxy code can return the right one to
8525                     // the application
8526                     if (qptr->ProxyQuestion)
8527                         qptr->responseFlags = response->h.flags;
8528                     GenerateNegativeResponse(m, mDNSInterface_Any, QC_forceresponse);
8529                     m->CurrentQuestion = mDNSNULL;
8530                 }
8531                 else
8532                 {
8533                     LogInfo("mDNSCoreReceiveNoUnicastAnswers: Skipping check and not creating a negative cache entry for %##s (%s)", q.qname.c, DNSTypeName(q.qtype));
8534                 }
8535             }
8536             else
8537             {
8538                 if (!rr)
8539                 {
8540                     // We start off assuming a negative caching TTL of 60 seconds
8541                     // but then look to see if we can find an SOA authority record to tell us a better value we should be using
8542                     mDNSu32 negttl = 60;
8543                     int repeat = 0;
8544                     const domainname *name = &q.qname;
8545                     mDNSu32 hash = q.qnamehash;
8546 
8547                     // Special case for our special Microsoft Active Directory "local SOA" check.
8548                     // Some cheap home gateways don't include an SOA record in the authority section when
8549                     // they send negative responses, so we don't know how long to cache the negative result.
8550                     // Because we don't want to keep hitting the root name servers with our query to find
8551                     // if we're on a network using Microsoft Active Directory using "local" as a private
8552                     // internal top-level domain, we make sure to cache the negative result for at least one day.
8553                     if (q.qtype == kDNSType_SOA && SameDomainName(&q.qname, &localdomain)) negttl = 60 * 60 * 24;
8554 
8555                     // If we're going to make (or update) a negative entry, then look for the appropriate TTL from the SOA record
8556                     if (response->h.numAuthorities && (ptr = LocateAuthorities(response, end)) != mDNSNULL)
8557                     {
8558                         ptr = GetLargeResourceRecord(m, response, ptr, end, InterfaceID, kDNSRecordTypePacketAuth, &m->rec);
8559                         if (ptr && m->rec.r.resrec.RecordType != kDNSRecordTypePacketNegative && m->rec.r.resrec.rrtype == kDNSType_SOA)
8560                         {
8561                             CacheGroup *cgSOA = CacheGroupForRecord(m, &m->rec.r.resrec);
8562                             const rdataSOA *const soa = (const rdataSOA *)m->rec.r.resrec.rdata->u.data;
8563                             mDNSu32 ttl_s = soa->min;
8564                             // We use the lesser of the SOA.MIN field and the SOA record's TTL, *except*
8565                             // for the SOA record for ".", where the record is reported as non-cacheable
8566                             // (TTL zero) for some reason, so in this case we just take the SOA record's TTL as-is
8567                             if (ttl_s > m->rec.r.resrec.rroriginalttl && m->rec.r.resrec.name->c[0])
8568                                 ttl_s = m->rec.r.resrec.rroriginalttl;
8569                             if (negttl < ttl_s) negttl = ttl_s;
8570 
8571                             // Create the SOA record as we may have to return this to the questions
8572                             // that we are acting as a proxy for currently or in the future.
8573                             SOARecord = CreateNewCacheEntry(m, HashSlotFromNameHash(m->rec.r.resrec.namehash), cgSOA, 1, mDNSfalse, mDNSNULL);
8574 
8575                             // Special check for SOA queries: If we queried for a.b.c.d.com, and got no answer,
8576                             // with an Authority Section SOA record for d.com, then this is a hint that the authority
8577                             // is d.com, and consequently SOA records b.c.d.com and c.d.com don't exist either.
8578                             // To do this we set the repeat count so the while loop below will make a series of negative cache entries for us
8579                             //
8580                             // For ProxyQuestions, we don't do this as we need to create additional SOA records to cache them
8581                             // along with the negative cache record. For simplicity, we don't create the additional records.
8582                             if (!qptr->ProxyQuestion && q.qtype == kDNSType_SOA)
8583                             {
8584                                 int qcount = CountLabels(&q.qname);
8585                                 int scount = CountLabels(m->rec.r.resrec.name);
8586                                 if (qcount - 1 > scount)
8587                                     if (SameDomainName(SkipLeadingLabels(&q.qname, qcount - scount), m->rec.r.resrec.name))
8588                                         repeat = qcount - 1 - scount;
8589                             }
8590                         }
8591                         m->rec.r.resrec.RecordType = 0;     // Clear RecordType to show we're not still using it
8592                     }
8593 
8594                     // If we already had a negative entry in the cache, then we double our existing negative TTL. This is to avoid
8595                     // the case where the record doesn't exist (e.g. particularly for things like our lb._dns-sd._udp.<domain> query),
8596                     // and the server returns no SOA record (or an SOA record with a small MIN TTL) so we assume a TTL
8597                     // of 60 seconds, and we end up polling the server every minute for a record that doesn't exist.
8598                     // With this fix in place, when this happens, we double the effective TTL each time (up to one hour),
8599                     // so that we back off our polling rate and don't keep hitting the server continually.
8600                     if (neg)
8601                     {
8602                         if (negttl < neg->resrec.rroriginalttl * 2)
8603                             negttl = neg->resrec.rroriginalttl * 2;
8604                         if (negttl > 3600)
8605                             negttl = 3600;
8606                     }
8607 
8608                     negttl = GetEffectiveTTL(LLQType, negttl);  // Add 25% grace period if necessary
8609 
8610                     // If we already had a negative cache entry just update it, else make one or more new negative cache entries.
8611                     if (neg)
8612                     {
8613                         LogInfo("mDNSCoreReceiveNoUnicastAnswers: Renewing negative TTL from %d to %d %s", neg->resrec.rroriginalttl, negttl, CRDisplayString(m, neg));
8614                         RefreshCacheRecord(m, neg, negttl);
8615                         // When we created the cache for the first time and answered the question, the question's
8616                         // interval was set to MaxQuestionInterval. If the cache is about to expire and we are resending
8617                         // the queries, the interval should still be at MaxQuestionInterval. If the query is being
8618                         // restarted (setting it to InitialQuestionInterval) for other reasons e.g., wakeup,
8619                         // we should reset its question interval here to MaxQuestionInterval.
8620                         ResetQuestionState(m, qptr);
8621                         if (DNSSECQuestion(qptr))
8622                             neg->CRDNSSECQuestion = 1;
8623                         // Update the NSEC records again.
8624                         // TBD: Need to purge and revalidate if the cached NSECS and the new set are not same.
8625                         if (NSECRecords)
8626                         {
8627                             if (!AddNSECSForCacheRecord(m, NSECRecords, neg, rcode))
8628                             {
8629                                 // We might just have an SOA record for zones that are not signed and hence don't log
8630                                 // this as an error
8631                                 LogInfo("mDNSCoreReceiveNoUnicastAnswers: AddNSECSForCacheRecord failed to add NSEC for negcr %s during refresh", CRDisplayString(m, neg));
8632                                 FreeNSECRecords(m, NSECRecords);
8633                                 neg->CRDNSSECQuestion = 0;
8634                             }
8635                             NSECRecords = mDNSNULL;
8636                         }
8637                         if (SOARecord)
8638                         {
8639                             if (neg->soa)
8640                                 ReleaseCacheRecord(m, neg->soa);
8641                             neg->soa = SOARecord;
8642                             SOARecord = mDNSNULL;
8643                         }
8644                     }
8645                     else while (1)
8646                         {
8647                             CacheRecord *negcr;
8648                             debugf("mDNSCoreReceiveNoUnicastAnswers making negative cache entry TTL %d for %##s (%s)", negttl, name->c, DNSTypeName(q.qtype));
8649                             MakeNegativeCacheRecord(m, &m->rec.r, name, hash, q.qtype, q.qclass, negttl, mDNSInterface_Any, qptr->qDNSServer);
8650                             m->rec.r.responseFlags = response->h.flags;
8651                             // We create SOA records above which might create new cache groups. Earlier
8652                             // in the function we looked up the cache group for the name and it could have
8653                             // been NULL. If we pass NULL cg to new cache entries that we create below,
8654                             // it will create additional cache groups for the same name. To avoid that,
8655                             // look up the cache group again to re-initialize cg again.
8656                             cg = CacheGroupForName(m, hash, name);
8657                             if (NSECRecords && DNSSECQuestion(qptr))
8658                             {
8659                                 // Create the cache entry with delay and then add the NSEC records
8660                                 // to it and add it immediately.
8661                                 negcr = CreateNewCacheEntry(m, HashSlotFromNameHash(hash), cg, 1, mDNStrue, mDNSNULL);
8662                                 if (negcr)
8663                                 {
8664                                     negcr->CRDNSSECQuestion = 0;
8665                                     if (!AddNSECSForCacheRecord(m, NSECRecords, negcr, rcode))
8666                                     {
8667                                         LogInfo("mDNSCoreReceiveNoUnicastAnswers: AddNSECSForCacheRecord failed to add NSEC for negcr %s",
8668                                             CRDisplayString(m, negcr));
8669                                         FreeNSECRecords(m, NSECRecords);
8670                                     }
8671                                     else
8672                                     {
8673                                         negcr->CRDNSSECQuestion = 1;
8674                                         LogInfo("mDNSCoreReceiveNoUnicastAnswers: AddNSECSForCacheRecord added neg NSEC for %s", CRDisplayString(m, negcr));
8675                                     }
8676                                     NSECRecords = mDNSNULL;
8677                                     negcr->DelayDelivery = 0;
8678                                     CacheRecordDeferredAdd(m, negcr);
8679                                 }
8680                                 m->rec.r.resrec.RecordType = 0; // Clear RecordType to show we're not still using it
8681                                 break;
8682                             }
8683                             else
8684                             {
8685                                 // Need to add with a delay so that we can tag the SOA record
8686                                 negcr = CreateNewCacheEntry(m, HashSlotFromNameHash(hash), cg, 1, mDNStrue, mDNSNULL);
8687                                 if (negcr)
8688                                 {
8689                                     negcr->CRDNSSECQuestion = 0;
8690                                     if (DNSSECQuestion(qptr))
8691                                         negcr->CRDNSSECQuestion = 1;
8692                                     negcr->DelayDelivery = 0;
8693 
8694                                     if (SOARecord)
8695                                     {
8696                                         if (negcr->soa)
8697                                             ReleaseCacheRecord(m, negcr->soa);
8698                                         negcr->soa = SOARecord;
8699                                         SOARecord = mDNSNULL;
8700                                     }
8701                                     CacheRecordDeferredAdd(m, negcr);
8702                                 }
8703                             }
8704                             m->rec.r.responseFlags = zeroID;
8705                             m->rec.r.resrec.RecordType = 0; // Clear RecordType to show we're not still using it
8706                             if (!repeat) break;
8707                             repeat--;
8708                             name = (const domainname *)(name->c + 1 + name->c[0]);
8709                             hash = DomainNameHashValue(name);
8710                         }
8711                 }
8712             }
8713         }
8714     }
8715     if (NSECRecords) { LogInfo("mDNSCoreReceiveNoUnicastAnswers: NSECRecords not used"); FreeNSECRecords(m, NSECRecords); }
8716     if (SOARecord)   { LogInfo("mDNSCoreReceiveNoUnicastAnswers: SOARecord not used"); ReleaseCacheRecord(m, SOARecord); }
8717 }
8718 
8719 mDNSlocal void mDNSCorePrintStoredProxyRecords(mDNS *const m)
8720 {
8721     AuthRecord *rrPtr = mDNSNULL;
8722     LogSPS("Stored Proxy records :");
8723     for (rrPtr = m->SPSRRSet; rrPtr; rrPtr = rrPtr->next)
8724     {
8725         LogSPS("%s", ARDisplayString(m, rrPtr));
8726     }
8727 }
8728 
8729 mDNSlocal mDNSBool mDNSCoreRegisteredProxyRecord(mDNS *const m, AuthRecord *rr)
8730 {
8731     AuthRecord *rrPtr = mDNSNULL;
8732 
8733     for (rrPtr = m->SPSRRSet; rrPtr; rrPtr = rrPtr->next)
8734     {
8735         if (IdenticalResourceRecord(&rrPtr->resrec, &rr->resrec))
8736         {
8737             LogSPS("mDNSCoreRegisteredProxyRecord: Ignoring packet registered with sleep proxy : %s ", ARDisplayString(m, rr));
8738             return mDNStrue;
8739         }
8740     }
8741     mDNSCorePrintStoredProxyRecords(m);
8742     return mDNSfalse;
8743 }
8744 
8745 mDNSlocal CacheRecord* mDNSCoreReceiveCacheCheck(mDNS *const m, const DNSMessage *const response, uDNS_LLQType LLQType,
8746     const mDNSu32 slot, CacheGroup *cg, DNSQuestion *unicastQuestion, CacheRecord ***cfp, CacheRecord **NSECCachePtr,
8747     mDNSInterfaceID InterfaceID)
8748 {
8749     CacheRecord *rr;
8750     CacheRecord **cflocal = *cfp;
8751 
8752     for (rr = cg ? cg->members : mDNSNULL; rr; rr=rr->next)
8753     {
8754         mDNSBool match;
8755         // Resource record received via unicast, the resGroupID should match ?
8756         if (!InterfaceID)
8757         {
8758             mDNSu16 id1 = (rr->resrec.rDNSServer ? rr->resrec.rDNSServer->resGroupID : 0);
8759             mDNSu16 id2 = (m->rec.r.resrec.rDNSServer ? m->rec.r.resrec.rDNSServer->resGroupID : 0);
8760             match = (id1 == id2);
8761         }
8762         else
8763             match = (rr->resrec.InterfaceID == InterfaceID);
8764         // If we found this exact resource record, refresh its TTL
8765         if (match && IdenticalSameNameRecord(&m->rec.r.resrec, &rr->resrec))
8766         {
8767             if (m->rec.r.resrec.rdlength > InlineCacheRDSize)
8768                 verbosedebugf("mDNSCoreReceiveCacheCheck: Found record size %5d interface %p already in cache: %s",
8769                               m->rec.r.resrec.rdlength, InterfaceID, CRDisplayString(m, &m->rec.r));
8770 
8771             if (m->rec.r.resrec.RecordType & kDNSRecordTypePacketUniqueMask)
8772             {
8773                 // If this packet record has the kDNSClass_UniqueRRSet flag set, then add it to our cache flushing list
8774                 if (rr->NextInCFList == mDNSNULL && *cfp != &rr->NextInCFList && LLQType != uDNS_LLQ_Events)
8775                 {
8776                     *cflocal = rr;
8777                     cflocal = &rr->NextInCFList;
8778                     *cflocal = (CacheRecord*)1;
8779                     *cfp = &rr->NextInCFList;
8780                 }
8781 
8782                 // If this packet record is marked unique, and our previous cached copy was not, then fix it
8783                 if (!(rr->resrec.RecordType & kDNSRecordTypePacketUniqueMask))
8784                 {
8785                     DNSQuestion *q;
8786                     for (q = m->Questions; q; q=q->next)
8787                     {
8788                         if (ResourceRecordAnswersQuestion(&rr->resrec, q))
8789                             q->UniqueAnswers++;
8790                     }
8791                     rr->resrec.RecordType = m->rec.r.resrec.RecordType;
8792                 }
8793             }
8794 
8795             if (!SameRDataBody(&m->rec.r.resrec, &rr->resrec.rdata->u, SameDomainNameCS))
8796             {
8797                 // If the rdata of the packet record differs in name capitalization from the record in our cache
8798                 // then mDNSPlatformMemSame will detect this. In this case, throw the old record away, so that clients get
8799                 // a 'remove' event for the record with the old capitalization, and then an 'add' event for the new one.
8800                 // <rdar://problem/4015377> mDNS -F returns the same domain multiple times with different casing
8801                 rr->resrec.rroriginalttl = 0;
8802                 rr->TimeRcvd = m->timenow;
8803                 rr->UnansweredQueries = MaxUnansweredQueries;
8804                 SetNextCacheCheckTimeForRecord(m, rr);
8805                 LogInfo("mDNSCoreReceiveCacheCheck: Discarding due to domainname case change old: %s", CRDisplayString(m, rr));
8806                 LogInfo("mDNSCoreReceiveCacheCheck: Discarding due to domainname case change new: %s", CRDisplayString(m, &m->rec.r));
8807                 LogInfo("mDNSCoreReceiveCacheCheck: Discarding due to domainname case change in %d slot %3d in %d %d",
8808                         NextCacheCheckEvent(rr) - m->timenow, slot, m->rrcache_nextcheck[slot] - m->timenow, m->NextCacheCheck - m->timenow);
8809                 // DO NOT break out here -- we want to continue as if we never found it
8810             }
8811             else if (!IdenticalAnonInfo(m->rec.r.resrec.AnonInfo, rr->resrec.AnonInfo))
8812             {
8813                 // If the NSEC3 record changed, a few possibilities
8814                 //
8815                 // 1) the peer reinitialized e.g., after network change and still part of the
8816                 //    same set.
8817                 // 2) the peer went to a different set but we did not see the goodbyes. If we just
8818                 //    update the nsec3 record, it would be incorrect. Flush the cache so that we
8819                 //    can deliver a RMV followed by ADD.
8820                 // 3) if the peer is ourselves and we see the goodbye when moving to a different set
8821                 //    and so we flush the cache and create a new cache record with the new set information.
8822                 //    Now we move back to the original set. In this case, we can't just update the
8823                 //    NSEC3 record alone. We need to flush so that we can deliver an RMV followed by ADD
8824                 //    when we create the new cache entry.
8825                 //
8826                 // Note: For case (1), we could avoid flushing the cache but we can't tell the difference
8827                 // from the other cases.
8828                 rr->resrec.rroriginalttl = 0;
8829                 rr->TimeRcvd = m->timenow;
8830                 rr->UnansweredQueries = MaxUnansweredQueries;
8831                 SetNextCacheCheckTimeForRecord(m, rr);
8832                 LogInfo("mDNSCoreReceiveCacheCheck: AnonInfo changed for %s", CRDisplayString(m, rr));
8833                 // DO NOT break out here -- we want to continue as if we never found it. When we return
8834                 // from this function, we will create a new cache entry with the new NSEC3 record
8835             }
8836             else if (m->rec.r.resrec.rroriginalttl > 0)
8837             {
8838                 DNSQuestion *q;
8839 
8840                 m->mDNSStats.CacheRefreshed++;
8841 
8842                 if (rr->resrec.mortality == Mortality_Ghost && unicastQuestion && (unicastQuestion->allowExpired != AllowExpired_AllowExpiredAnswers) && !rr->DelayDelivery)
8843                 {
8844                     rr->DelayDelivery = NonZeroTime(m->timenow);
8845                     debugf("mDNSCoreReceiveCacheCheck: Reset DelayDelivery for mortalityExpired EXP:%d RR %s", m->timenow - RRExpireTime(rr), CRDisplayString(m, rr));
8846                 }
8847 
8848                 if (rr->resrec.rroriginalttl == 0) debugf("uDNS rescuing %s", CRDisplayString(m, rr));
8849                 RefreshCacheRecord(m, rr, m->rec.r.resrec.rroriginalttl);
8850                 rr->responseFlags = response->h.flags;
8851 
8852                 // If we may have NSEC records returned with the answer (which we don't know yet as it
8853                 // has not been processed), we need to cache them along with the first cache
8854                 // record in the list that answers the question so that it can be used for validation
8855                 // later. The "type" check below is to make sure that we cache on the cache record
8856                 // that would answer the question. It is possible that we might cache additional things
8857                 // e.g., MX question might cache A records also, and we want to cache the NSEC on
8858                 // the record that answers the question.
8859                 if (response->h.numAnswers && unicastQuestion && unicastQuestion->qtype == rr->resrec.rrtype
8860                     && !(*NSECCachePtr))
8861                 {
8862                     LogInfo("mDNSCoreReceiveCacheCheck: rescuing RR %s", CRDisplayString(m, rr));
8863                     *NSECCachePtr = rr;
8864                 }
8865                 // We have to reset the question interval to MaxQuestionInterval so that we don't keep
8866                 // polling the network once we get a valid response back. For the first time when a new
8867                 // cache entry is created, AnswerCurrentQuestionWithResourceRecord does that.
8868                 // Subsequently, if we reissue questions from within the mDNSResponder e.g., DNS server
8869                 // configuration changed, without flushing the cache, we reset the question interval here.
8870                 // Currently, we do this for for both multicast and unicast questions as long as the record
8871                 // type is unique. For unicast, resource record is always unique and for multicast it is
8872                 // true for records like A etc. but not for PTR.
8873                 if (rr->resrec.RecordType & kDNSRecordTypePacketUniqueMask)
8874                 {
8875                     for (q = m->Questions; q; q=q->next)
8876                     {
8877                         if (!q->DuplicateOf && !q->LongLived &&
8878                             ActiveQuestion(q) && ResourceRecordAnswersQuestion(&rr->resrec, q))
8879                         {
8880                             ResetQuestionState(m, q);
8881                             debugf("mDNSCoreReceiveCacheCheck: Set MaxQuestionInterval for %p %##s (%s)", q, q->qname.c, DNSTypeName(q->qtype));
8882                             break;      // Why break here? Aren't there other questions we might want to look at?-- SC July 2010
8883                         }
8884                     }
8885                 }
8886                 break;
8887             }
8888             else
8889             {
8890                 // If the packet TTL is zero, that means we're deleting this record.
8891                 // To give other hosts on the network a chance to protest, we push the deletion
8892                 // out one second into the future. Also, we set UnansweredQueries to MaxUnansweredQueries.
8893                 // Otherwise, we'll do final queries for this record at 80% and 90% of its apparent
8894                 // lifetime (800ms and 900ms from now) which is a pointless waste of network bandwidth.
8895                 // If record's current expiry time is more than a second from now, we set it to expire in one second.
8896                 // If the record is already going to expire in less than one second anyway, we leave it alone --
8897                 // we don't want to let the goodbye packet *extend* the record's lifetime in our cache.
8898                 debugf("DE for %s", CRDisplayString(m, rr));
8899                 if (RRExpireTime(rr) - m->timenow > mDNSPlatformOneSecond)
8900                 {
8901                     rr->resrec.rroriginalttl = 1;
8902                     rr->TimeRcvd = m->timenow;
8903                     rr->UnansweredQueries = MaxUnansweredQueries;
8904                     SetNextCacheCheckTimeForRecord(m, rr);
8905                 }
8906                 break;
8907             }
8908         }
8909     }
8910     return rr;
8911 }
8912 
8913 mDNSlocal void mDNSParseNSEC3Records(mDNS *const m, const DNSMessage *const response, const mDNSu8 *end,
8914     const mDNSInterfaceID InterfaceID, CacheRecord **NSEC3Records)
8915 {
8916     const mDNSu8 *ptr;
8917     CacheRecord *rr;
8918     int i;
8919 
8920     if (!response->h.numAuthorities)
8921         return;
8922     ptr = LocateAuthorities(response, end);
8923     if (!ptr)
8924     {
8925         LogInfo("mDNSParseNSEC3Records: ERROR can't locate authorities");
8926         return;
8927     }
8928     for (i = 0; i < response->h.numAuthorities && ptr && ptr < end; i++)
8929     {
8930         CacheGroup *cg;
8931 
8932         ptr = GetLargeResourceRecord(m, response, ptr, end, InterfaceID, kDNSRecordTypePacketAuth, &m->rec);
8933         if (!ptr || m->rec.r.resrec.RecordType == kDNSRecordTypePacketNegative || m->rec.r.resrec.rrtype != kDNSType_NSEC3)
8934         {
8935             debugf("mDNSParseNSEC3Records: ptr %p, Record %s, ignoring", ptr, CRDisplayString(m, &m->rec.r));
8936             m->rec.r.resrec.RecordType = 0;
8937             continue;
8938         }
8939         cg = CacheGroupForRecord(m, &m->rec.r.resrec);
8940         // Create the cache entry but don't add it to the cache it. We need
8941         // to cache this along with the main cache record.
8942         rr = CreateNewCacheEntry(m, HashSlotFromNameHash(m->rec.r.resrec.namehash), cg, 0, mDNSfalse, mDNSNULL);
8943         if (rr)
8944         {
8945             debugf("mDNSParseNSEC3Records: %s", CRDisplayString(m, rr));
8946             *NSEC3Records = rr;
8947             NSEC3Records = &rr->next;
8948         }
8949         m->rec.r.resrec.RecordType = 0;     // Clear RecordType to show we're not still using it
8950     }
8951 }
8952 
8953 mDNSlocal void mDNSCoreResetRecord(mDNS *const m)
8954 {
8955     m->rec.r.resrec.RecordType = 0;     // Clear RecordType to show we're not still using it
8956     if (m->rec.r.resrec.AnonInfo)
8957     {
8958         FreeAnonInfo(m->rec.r.resrec.AnonInfo);
8959         m->rec.r.resrec.AnonInfo = mDNSNULL;
8960     }
8961 }
8962 
8963 // Note: mDNSCoreReceiveResponse calls mDNS_Deregister_internal which can call a user callback, which may change
8964 // the record list and/or question list.
8965 // Any code walking either list must use the CurrentQuestion and/or CurrentRecord mechanism to protect against this.
8966 // InterfaceID non-NULL tells us the interface this multicast response was received on
8967 // InterfaceID NULL tells us this was a unicast response
8968 // dstaddr NULL tells us we received this over an outgoing TCP connection we made
8969 mDNSlocal void mDNSCoreReceiveResponse(mDNS *const m,
8970                                        const DNSMessage *const response, const mDNSu8 *end,
8971                                        const mDNSAddr *srcaddr, const mDNSIPPort srcport, const mDNSAddr *dstaddr, mDNSIPPort dstport,
8972                                        const mDNSInterfaceID InterfaceID)
8973 {
8974     int i;
8975     mDNSBool ResponseMCast    = dstaddr && mDNSAddrIsDNSMulticast(dstaddr);
8976     mDNSBool ResponseSrcLocal = !srcaddr || mDNS_AddressIsLocalSubnet(m, InterfaceID, srcaddr);
8977     DNSQuestion *llqMatch = mDNSNULL;
8978     DNSQuestion *unicastQuestion = mDNSNULL;
8979     uDNS_LLQType LLQType      = uDNS_recvLLQResponse(m, response, end, srcaddr, srcport, &llqMatch);
8980 
8981     // "(CacheRecord*)1" is a special (non-zero) end-of-list marker
8982     // We use this non-zero marker so that records in our CacheFlushRecords list will always have NextInCFList
8983     // set non-zero, and that tells GetCacheEntity() that they're not, at this moment, eligible for recycling.
8984     CacheRecord *CacheFlushRecords = (CacheRecord*)1;
8985     CacheRecord **cfp = &CacheFlushRecords;
8986     CacheRecord *NSECRecords = mDNSNULL;
8987     CacheRecord *NSECCachePtr = mDNSNULL;
8988     CacheRecord **nsecp = &NSECRecords;
8989     CacheRecord *McastNSEC3Records = mDNSNULL;
8990     mDNSBool nseclist;
8991     mDNSu8 rcode = '\0';
8992     mDNSBool rrsigsCreated = mDNSfalse;
8993     mDNSBool DNSSECQuestion = mDNSfalse;
8994     NetworkInterfaceInfo *llintf = FirstIPv4LLInterfaceForID(m, InterfaceID);
8995     mDNSBool    recordAcceptedInResponse = mDNSfalse; // Set if a record is accepted from a unicast mDNS response that answers an existing question.
8996 
8997     // All records in a DNS response packet are treated as equally valid statements of truth. If we want
8998     // to guard against spoof responses, then the only credible protection against that is cryptographic
8999     // security, e.g. DNSSEC., not worrying about which section in the spoof packet contained the record.
9000     int firstauthority  =                   response->h.numAnswers;
9001     int firstadditional = firstauthority  + response->h.numAuthorities;
9002     int totalrecords    = firstadditional + response->h.numAdditionals;
9003     const mDNSu8 *ptr   = response->data;
9004     DNSServer *uDNSServer = mDNSNULL;
9005 
9006     debugf("Received Response from %#-15a addressed to %#-15a on %p with "
9007            "%2d Question%s %2d Answer%s %2d Authorit%s %2d Additional%s %d bytes LLQType %d",
9008            srcaddr, dstaddr, InterfaceID,
9009            response->h.numQuestions,   response->h.numQuestions   == 1 ? ", "   : "s,",
9010            response->h.numAnswers,     response->h.numAnswers     == 1 ? ", "   : "s,",
9011            response->h.numAuthorities, response->h.numAuthorities == 1 ? "y,  " : "ies,",
9012            response->h.numAdditionals, response->h.numAdditionals == 1 ? " "    : "s", end - response->data, LLQType);
9013 
9014 #if AWD_METRICS
9015     if (mDNSSameIPPort(srcport, UnicastDNSPort))
9016     {
9017         MetricsUpdateDNSResponseSize((mDNSu32)(end - (mDNSu8 *)response));
9018     }
9019 #endif
9020 
9021     // According to RFC 2181 <http://www.ietf.org/rfc/rfc2181.txt>
9022     //    When a DNS client receives a reply with TC
9023     //    set, it should ignore that response, and query again, using a
9024     //    mechanism, such as a TCP connection, that will permit larger replies.
9025     // It feels wrong to be throwing away data after the network went to all the trouble of delivering it to us, but
9026     // delivering some records of the RRSet first and then the remainder a couple of milliseconds later was causing
9027     // failures in our Microsoft Active Directory client, which expects to get the entire set of answers at once.
9028     // <rdar://problem/6690034> Can't bind to Active Directory
9029     // In addition, if the client immediately canceled its query after getting the initial partial response, then we'll
9030     // abort our TCP connection, and not complete the operation, and end up with an incomplete RRSet in our cache.
9031     // Next time there's a query for this RRSet we'll see answers in our cache, and assume we have the whole RRSet already,
9032     // and not even do the TCP query.
9033     // Accordingly, if we get a uDNS reply with kDNSFlag0_TC set, we bail out and wait for the TCP response containing the
9034     // entire RRSet, with the following exception. If the response contains an answer section and one or more records in
9035     // either the authority section or additional section, then that implies that truncation occurred beyond the answer
9036     // section, and the answer section is therefore assumed to be complete.
9037     //
9038     // From section 6.2 of RFC 1035 <https://tools.ietf.org/html/rfc1035>:
9039     //    When a response is so long that truncation is required, the truncation
9040     //    should start at the end of the response and work forward in the
9041     //    datagram.  Thus if there is any data for the authority section, the
9042     //    answer section is guaranteed to be unique.
9043     if (!InterfaceID && (response->h.flags.b[0] & kDNSFlag0_TC) &&
9044         ((response->h.numAnswers == 0) || ((response->h.numAuthorities == 0) && (response->h.numAdditionals == 0)))) return;
9045 
9046     if (LLQType == uDNS_LLQ_Ignore) return;
9047 
9048     // 1. We ignore questions (if any) in mDNS response packets
9049     // 2. If this is an LLQ response, we handle it much the same
9050     // Otherwise, this is a authoritative uDNS answer, so arrange for any stale records to be purged
9051     if (ResponseMCast || LLQType == uDNS_LLQ_Events)
9052         ptr = LocateAnswers(response, end);
9053     // Otherwise, for one-shot queries, any answers in our cache that are not also contained
9054     // in this response packet are immediately deemed to be invalid.
9055     else
9056     {
9057         mDNSBool failure, returnEarly;
9058         rcode = (mDNSu8)(response->h.flags.b[1] & kDNSFlag1_RC_Mask);
9059         failure = !(rcode == kDNSFlag1_RC_NoErr || rcode == kDNSFlag1_RC_NXDomain || rcode == kDNSFlag1_RC_NotAuth);
9060         returnEarly = mDNSfalse;
9061         // We could possibly combine this with the similar loop at the end of this function --
9062         // instead of tagging cache records here and then rescuing them if we find them in the answer section,
9063         // we could instead use the "m->PktNum" mechanism to tag each cache record with the packet number in
9064         // which it was received (or refreshed), and then at the end if we find any cache records which
9065         // answer questions in this packet's question section, but which aren't tagged with this packet's
9066         // packet number, then we deduce they are old and delete them
9067         for (i = 0; i < response->h.numQuestions && ptr && ptr < end; i++)
9068         {
9069             DNSQuestion q, *qptr = mDNSNULL, *suspiciousForQ = mDNSNULL;
9070             ptr = getQuestion(response, ptr, end, InterfaceID, &q);
9071             if (ptr && (qptr = ExpectingUnicastResponseForQuestion(m, dstport, response->h.id, &q, !dstaddr, &suspiciousForQ)))
9072             {
9073                 if (!failure)
9074                 {
9075                     CacheRecord *rr;
9076                     // Remember the unicast question that we found, which we use to make caching
9077                     // decisions later on in this function
9078                     CacheGroup *cg = CacheGroupForName(m, q.qnamehash, &q.qname);
9079                     if (!mDNSOpaque16IsZero(response->h.id))
9080                     {
9081                         unicastQuestion = qptr;
9082                         if (qptr->qDNSServer && DNSSECQuestion(qptr))
9083                         {
9084                             LogInfo("mDNSCoreReceiveResponse: Setting aware for %##s (%s) on %#a", qptr->qname.c,
9085                                 DNSTypeName(qptr->qtype), &qptr->qDNSServer->addr);
9086                             qptr->qDNSServer->DNSSECAware = mDNStrue;
9087                             qptr->qDNSServer->req_DO = mDNStrue;
9088                         }
9089                         if (qptr->ValidatingResponse)
9090                             DNSSECQuestion = mDNStrue;
9091                     }
9092                     for (rr = cg ? cg->members : mDNSNULL; rr; rr=rr->next)
9093                         if (SameNameRecordAnswersQuestion(&rr->resrec, qptr))
9094                         {
9095                             debugf("uDNS marking %p %##s (%s) %p %s", q.InterfaceID, q.qname.c, DNSTypeName(q.qtype),
9096                                    rr->resrec.InterfaceID, CRDisplayString(m, rr));
9097                             // Don't want to disturb rroriginalttl here, because code below might need it for the exponential backoff doubling algorithm
9098                             rr->TimeRcvd          = m->timenow - TicksTTL(rr) - 1;
9099                             rr->UnansweredQueries = MaxUnansweredQueries;
9100                             rr->CRDNSSECQuestion = 0;
9101                             if (unicastQuestion && DNSSECQuestion(unicastQuestion))
9102                             {
9103                                 LogInfo("mDNSCoreReceiveResponse: CRDNSSECQuestion set for record %s, question %##s (%s)", CRDisplayString(m, rr),
9104                                     unicastQuestion->qname.c, DNSTypeName(unicastQuestion->qtype));
9105                                 rr->CRDNSSECQuestion = 1;
9106                             }
9107                         }
9108                 }
9109                 else
9110                 {
9111                     if (qptr)
9112                     {
9113                         // If we recv any error from the DNSServer for a DNSSEC Query and if we know that the server
9114                         // is not DNSSEC aware, stop doing DNSSEC for that DNSServer. Note that by setting the
9115                         // req_DO to false here, the next retransmission for this question will turn off validation
9116                         // and hence retransmit without the EDNS0/DOK option.
9117                         if (DNSSECOptionalQuestion(qptr) && qptr->qDNSServer && !qptr->qDNSServer->DNSSECAware)
9118                         {
9119                             LogInfo("mDNSCoreReceiveResponse: Server %p responded with code %d to DNSSEC Query %##s (%s), clear DO flag",
9120                                     qptr->qDNSServer, rcode, q.qname.c, DNSTypeName(q.qtype));
9121                             qptr->qDNSServer->req_DO = mDNSfalse;
9122                         }
9123                         // For Unicast DNS Queries, penalize the DNSServer
9124                         else
9125                         {
9126                             LogInfo("mDNSCoreReceiveResponse: Server %p responded with code %d to query %##s (%s)",
9127                                     qptr->qDNSServer, rcode, q.qname.c, DNSTypeName(q.qtype));
9128                             PenalizeDNSServer(m, qptr, response->h.flags);
9129                         }
9130                     }
9131                     returnEarly = mDNStrue;
9132                 }
9133             }
9134             else if (!InterfaceID && suspiciousForQ)
9135             {
9136                 // If a response is suspicious for a question, then reissue the question via TCP
9137                 LogInfo("mDNSCoreReceiveResponse: Server %p responded suspiciously to query %##s (%s) qID %d != rID: %d",
9138                         suspiciousForQ->qDNSServer, q.qname.c, DNSTypeName(q.qtype),
9139                         mDNSVal16(suspiciousForQ->TargetQID), mDNSVal16(response->h.id));
9140                 uDNS_RestartQuestionAsTCP(m, suspiciousForQ, srcaddr, srcport);
9141                 return;
9142             }
9143         }
9144         if (returnEarly)
9145         {
9146             LogInfo("Ignoring %2d Answer%s %2d Authorit%s %2d Additional%s",
9147                     response->h.numAnswers,     response->h.numAnswers     == 1 ? ", " : "s,",
9148                     response->h.numAuthorities, response->h.numAuthorities == 1 ? "y,  " : "ies,",
9149                     response->h.numAdditionals, response->h.numAdditionals == 1 ? "" : "s");
9150             // not goto exit because we won't have any CacheFlushRecords and we do not want to
9151             // generate negative cache entries (we want to query the next server)
9152             return;
9153         }
9154         if (unicastQuestion && DNSSECQuestion(unicastQuestion))
9155         {
9156             BumpDNSSECStats(m, kStatsActionSet, kStatsTypeMsgSize, (end - response->data));
9157         }
9158     }
9159 
9160     // Parse the NSEC3 records from the Authority section before we process
9161     // the Answer section so that we can cache them along with the proper
9162     // cache records we create.
9163     if (mDNSOpaque16IsZero(response->h.id))
9164         mDNSParseNSEC3Records(m, response, end, InterfaceID, &McastNSEC3Records);
9165 
9166     for (i = 0; i < totalrecords && ptr && ptr < end; i++)
9167     {
9168         // All responses sent via LL multicast are acceptable for caching
9169         // All responses received over our outbound TCP connections are acceptable for caching
9170         // We accept all records in a unicast response to a multicast query once we find one that
9171         // answers an active question.
9172         mDNSBool AcceptableResponse = ResponseMCast || !dstaddr || LLQType || recordAcceptedInResponse;
9173         // (Note that just because we are willing to cache something, that doesn't necessarily make it a trustworthy answer
9174         // to any specific question -- any code reading records from the cache needs to make that determination for itself.)
9175 
9176         const mDNSu8 RecordType =
9177             (i < firstauthority ) ? (mDNSu8)kDNSRecordTypePacketAns  :
9178             (i < firstadditional) ? (mDNSu8)kDNSRecordTypePacketAuth : (mDNSu8)kDNSRecordTypePacketAdd;
9179         ptr = GetLargeResourceRecord(m, response, ptr, end, InterfaceID, RecordType, &m->rec);
9180         if (!ptr) goto exit;        // Break out of the loop and clean up our CacheFlushRecords list before exiting
9181 
9182         if (m->rec.r.resrec.RecordType == kDNSRecordTypePacketNegative)
9183         {
9184             mDNSCoreResetRecord(m);
9185             continue;
9186         }
9187 
9188         // We have already parsed the NSEC3 records and cached them approrpriately for
9189         // multicast responses.
9190         if (mDNSOpaque16IsZero(response->h.id) && m->rec.r.resrec.rrtype == kDNSType_NSEC3)
9191         {
9192             mDNSCoreResetRecord(m);
9193             continue;
9194         }
9195         // Don't want to cache OPT or TSIG pseudo-RRs
9196         if (m->rec.r.resrec.rrtype == kDNSType_TSIG)
9197         {
9198             mDNSCoreResetRecord(m);
9199             continue;
9200         }
9201         if (m->rec.r.resrec.rrtype == kDNSType_OPT)
9202         {
9203             const rdataOPT *opt;
9204             const rdataOPT *const e = (const rdataOPT *)&m->rec.r.resrec.rdata->u.data[m->rec.r.resrec.rdlength];
9205             // Find owner sub-option(s). We verify that the MAC is non-zero, otherwise we could inadvertently
9206             // delete all our own AuthRecords (which are identified by having zero MAC tags on them).
9207             for (opt = &m->rec.r.resrec.rdata->u.opt[0]; opt < e; opt++)
9208                 if (opt->opt == kDNSOpt_Owner && opt->u.owner.vers == 0 && opt->u.owner.HMAC.l[0])
9209                 {
9210                     ClearProxyRecords(m, &opt->u.owner, m->DuplicateRecords);
9211                     ClearProxyRecords(m, &opt->u.owner, m->ResourceRecords);
9212                 }
9213             mDNSCoreResetRecord(m);
9214             continue;
9215         }
9216         // if a CNAME record points to itself, then don't add it to the cache
9217         if ((m->rec.r.resrec.rrtype == kDNSType_CNAME) && SameDomainName(m->rec.r.resrec.name, &m->rec.r.resrec.rdata->u.name))
9218         {
9219             LogInfo("mDNSCoreReceiveResponse: CNAME loop domain name %##s", m->rec.r.resrec.name->c);
9220             mDNSCoreResetRecord(m);
9221             continue;
9222         }
9223 
9224         // When we receive uDNS LLQ responses, we assume a long cache lifetime --
9225         // In the case of active LLQs, we'll get remove events when the records actually do go away
9226         // In the case of polling LLQs, we assume the record remains valid until the next poll
9227         if (!mDNSOpaque16IsZero(response->h.id))
9228             m->rec.r.resrec.rroriginalttl = GetEffectiveTTL(LLQType, m->rec.r.resrec.rroriginalttl);
9229 
9230         // If response was not sent via LL multicast,
9231         // then see if it answers a recent query of ours, which would also make it acceptable for caching.
9232         if (!ResponseMCast)
9233         {
9234             if (LLQType)
9235             {
9236                 // For Long Lived queries that are both sent over UDP and Private TCP, LLQType is set.
9237                 // Even though it is AcceptableResponse, we need a matching DNSServer pointer for the
9238                 // queries to get ADD/RMV events. To lookup the question, we can't use
9239                 // ExpectingUnicastResponseForRecord as the port numbers don't match. uDNS_recvLLQRespose
9240                 // has already matched the question using the 64 bit Id in the packet and we use that here.
9241 
9242                 if (llqMatch != mDNSNULL) m->rec.r.resrec.rDNSServer = uDNSServer = llqMatch->qDNSServer;
9243 
9244                 // If this is a DNSSEC question that is also LongLived, don't accept records from the
9245                 // Additional/Authority section blindly. We need to go through IsAcceptableResponse below
9246                 // so that NSEC/NSEC3 record are cached in the nseclist if we accept them. This can happen
9247                 // for both negative responses and wildcard expanded positive responses as both of come
9248                 // back with NSEC/NSEC3s.
9249                 if (unicastQuestion && DNSSECQuestion(unicastQuestion))
9250                     AcceptableResponse = mDNSfalse;
9251             }
9252             else if (!AcceptableResponse || !dstaddr)
9253             {
9254                 // For responses that come over TCP (Responses that can't fit within UDP) or TLS (Private queries
9255                 // that are not long lived e.g., AAAA lookup in a Private domain), it is indicated by !dstaddr.
9256                 // Even though it is AcceptableResponse, we still need a DNSServer pointer for the resource records that
9257                 // we create.
9258 
9259                 DNSQuestion *q = ExpectingUnicastResponseForRecord(m, srcaddr, ResponseSrcLocal, dstport, response->h.id, &m->rec.r, !dstaddr);
9260 
9261                 // Initialize the DNS server on the resource record which will now filter what questions we answer with
9262                 // this record.
9263                 //
9264                 // We could potentially lookup the DNS server based on the source address, but that may not work always
9265                 // and that's why ExpectingUnicastResponseForRecord does not try to verify whether the response came
9266                 // from the DNS server that queried. We follow the same logic here. If we can find a matching quetion based
9267                 // on the "id" and "source port", then this response answers the question and assume the response
9268                 // came from the same DNS server that we sent the query to.
9269 
9270                 if (q != mDNSNULL)
9271                 {
9272                     AcceptableResponse = mDNStrue;
9273                     if (!InterfaceID)
9274                     {
9275                         debugf("mDNSCoreReceiveResponse: InterfaceID %p %##s (%s)", q->InterfaceID, q->qname.c, DNSTypeName(q->qtype));
9276                         m->rec.r.resrec.rDNSServer = uDNSServer = q->qDNSServer;
9277                         if (!unicastQuestion) unicastQuestion = q;      //  Acceptable responses to unicast questions need to have (unicastQuestion != nil)
9278                     }
9279                     else
9280                     {
9281                         // Accept all remaining records in this unicast response to an mDNS query.
9282                         recordAcceptedInResponse = mDNStrue;
9283                         LogInfo("mDNSCoreReceiveResponse: Accepting response for query: %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
9284                     }
9285                 }
9286                 else
9287                 {
9288                     // If we can't find a matching question, we need to see whether we have seen records earlier that matched
9289                     // the question. The code below does that. So, make this record unacceptable for now
9290                     if (!InterfaceID)
9291                     {
9292                         debugf("mDNSCoreReceiveResponse: Can't find question for record name %##s", m->rec.r.resrec.name->c);
9293                         AcceptableResponse = mDNSfalse;
9294                     }
9295                 }
9296             }
9297         }
9298         else if (llintf && llintf->IgnoreIPv4LL && m->rec.r.resrec.rrtype == kDNSType_A)
9299         {
9300             // There are some routers (rare, thankfully) that generate bogus ARP responses for
9301             // any IPv4 address they don’t recognize, including RFC 3927 IPv4 link-local addresses.
9302             // To work with these broken routers, client devices need to blacklist these broken
9303             // routers and ignore their bogus ARP responses. Some devices implement a technique
9304             // such as the one described in US Patent 7436783, which lets clients detect and
9305             // ignore these broken routers: <https://www.google.com/patents/US7436783>
9306 
9307             // OS X and iOS do not implement this defensive mechanism, instead taking a simpler
9308             // approach of just detecting these broken routers and completely disabling IPv4
9309             // link-local communication on interfaces where a broken router is detected.
9310             // OS X and iOS set the IFEF_ARPLL interface flag on interfaces
9311             // that are deemed “safe” for IPv4 link-local communication;
9312             // the flag is cleared on interfaces where a broken router is detected.
9313 
9314             // OS X and iOS will not even try to communicate with an IPv4
9315             // link-local destination on an interface without the IFEF_ARPLL flag set.
9316             // This can cause some badly written applications to freeze for a long time if they
9317             // attempt to connect to an IPv4 link-local destination address and then wait for
9318             // that connection attempt to time out before trying other candidate addresses.
9319 
9320             // To mask this client bug, we suppress acceptance of IPv4 link-local address
9321             // records on interfaces where we know the OS will be unwilling even to attempt
9322             // communication with those IPv4 link-local destination addresses.
9323             // <rdar://problem/9400639> kSuppress IPv4LL answers on interfaces without IFEF_ARPLL
9324 
9325             const CacheRecord *const rr = &m->rec.r;
9326             const RDataBody2 *const rdb = (RDataBody2 *)rr->smallrdatastorage.data;
9327             if (mDNSv4AddressIsLinkLocal(&rdb->ipv4))
9328             {
9329                 LogInfo("mDNSResponder: Dropping LinkLocal packet %s", CRDisplayString(m, &m->rec.r));
9330                 mDNSCoreResetRecord(m);
9331                 continue;
9332             }
9333         }
9334 
9335         // 1. Check that this packet resource record does not conflict with any of ours
9336         if (mDNSOpaque16IsZero(response->h.id) && m->rec.r.resrec.rrtype != kDNSType_NSEC)
9337         {
9338             if (m->CurrentRecord)
9339                 LogMsg("mDNSCoreReceiveResponse ERROR m->CurrentRecord already set %s", ARDisplayString(m, m->CurrentRecord));
9340             m->CurrentRecord = m->ResourceRecords;
9341             while (m->CurrentRecord)
9342             {
9343                 AuthRecord *rr = m->CurrentRecord;
9344                 m->CurrentRecord = rr->next;
9345                 // We accept all multicast responses, and unicast responses resulting from queries we issued
9346                 // For other unicast responses, this code accepts them only for responses with an
9347                 // (apparently) local source address that pertain to a record of our own that's in probing state
9348                 if (!AcceptableResponse && !(ResponseSrcLocal && rr->resrec.RecordType == kDNSRecordTypeUnique)) continue;
9349 
9350                 if (PacketRRMatchesSignature(&m->rec.r, rr))        // If interface, name, type (if shared record) and class match...
9351                 {
9352                     // ... check to see if type and rdata are identical
9353                     if (IdenticalSameNameRecord(&m->rec.r.resrec, &rr->resrec))
9354                     {
9355                         // If the RR in the packet is identical to ours, just check they're not trying to lower the TTL on us
9356                         if (m->rec.r.resrec.rroriginalttl >= rr->resrec.rroriginalttl/2 || m->SleepState)
9357                         {
9358                             // If we were planning to send on this -- and only this -- interface, then we don't need to any more
9359                             if      (rr->ImmedAnswer == InterfaceID) { rr->ImmedAnswer = mDNSNULL; rr->ImmedUnicast = mDNSfalse; }
9360                         }
9361                         else
9362                         {
9363                             if      (rr->ImmedAnswer == mDNSNULL)    { rr->ImmedAnswer = InterfaceID;       m->NextScheduledResponse = m->timenow; }
9364                             else if (rr->ImmedAnswer != InterfaceID) { rr->ImmedAnswer = mDNSInterfaceMark; m->NextScheduledResponse = m->timenow; }
9365                         }
9366                     }
9367                     // else, the packet RR has different type or different rdata -- check to see if this is a conflict
9368                     else if (m->rec.r.resrec.rroriginalttl > 0 && PacketRRConflict(m, rr, &m->rec.r))
9369                     {
9370                         LogInfo("mDNSCoreReceiveResponse: Pkt Record: %08lX %s", m->rec.r.resrec.rdatahash, CRDisplayString(m, &m->rec.r));
9371                         LogInfo("mDNSCoreReceiveResponse: Our Record: %08lX %s", rr->resrec.rdatahash, ARDisplayString(m, rr));
9372 
9373                         // If this record is marked DependentOn another record for conflict detection purposes,
9374                         // then *that* record has to be bumped back to probing state to resolve the conflict
9375                         if (rr->DependentOn)
9376                         {
9377                             while (rr->DependentOn) rr = rr->DependentOn;
9378                             LogInfo("mDNSCoreReceiveResponse: Dep Record: %08lX %s", rr->resrec.rdatahash, ARDisplayString(m, rr));
9379                         }
9380 
9381                         // If we've just whacked this record's ProbeCount, don't need to do it again
9382                         if (rr->ProbeCount > DefaultProbeCountForTypeUnique)
9383                             LogInfo("mDNSCoreReceiveResponse: Already reset to Probing: %s", ARDisplayString(m, rr));
9384                         else if (rr->ProbeCount == DefaultProbeCountForTypeUnique)
9385                             LogInfo("mDNSCoreReceiveResponse: Ignoring response received before we even began probing: %s", ARDisplayString(m, rr));
9386                         else
9387                         {
9388                             LogMsg("mDNSCoreReceiveResponse: Received from %#a:%d %s", srcaddr, mDNSVal16(srcport), CRDisplayString(m, &m->rec.r));
9389                             // If we'd previously verified this record, put it back to probing state and try again
9390                             if (rr->resrec.RecordType == kDNSRecordTypeVerified)
9391                             {
9392                                 LogMsg("mDNSCoreReceiveResponse: Resetting to Probing: %s", ARDisplayString(m, rr));
9393                                 rr->resrec.RecordType     = kDNSRecordTypeUnique;
9394                                 // We set ProbeCount to one more than the usual value so we know we've already touched this record.
9395                                 // This is because our single probe for "example-name.local" could yield a response with (say) two A records and
9396                                 // three AAAA records in it, and we don't want to call RecordProbeFailure() five times and count that as five conflicts.
9397                                 // This special value is recognised and reset to DefaultProbeCountForTypeUnique in SendQueries().
9398                                 rr->ProbeCount     = DefaultProbeCountForTypeUnique + 1;
9399                                 rr->AnnounceCount  = InitialAnnounceCount;
9400                                 InitializeLastAPTime(m, rr);
9401                                 RecordProbeFailure(m, rr);  // Repeated late conflicts also cause us to back off to the slower probing rate
9402                             }
9403                             // If we're probing for this record, we just failed
9404                             else if (rr->resrec.RecordType == kDNSRecordTypeUnique)
9405                             {
9406 	                            // At this point in the code, we're probing for uniqueness.
9407 	                            // We've sent at least one probe (rr->ProbeCount < DefaultProbeCountForTypeUnique)
9408 	                            // but we haven't completed probing yet (rr->resrec.RecordType == kDNSRecordTypeUnique).
9409                                 // Before we call deregister, check if this is a packet we registered with the sleep proxy.
9410                                 if (!mDNSCoreRegisteredProxyRecord(m, rr))
9411                                 {
9412                                     // This may be a conflict due to stale packets on the network. Delay probing by a second.
9413                                     // If there are conflicts after 3 such attempts, then it is a true conflict.
9414                                     if (m->DelayConflictProcessing)
9415                                     {
9416                                         m->DelayConflictProcessing--;
9417                                         LogMsg("Possible spurious conflict for %s. Attempt %d at suppressing probes for one second",
9418                                                ARDisplayString(m, rr), (MAX_CONFLICT_PROCESSING_DELAYS - m->DelayConflictProcessing));
9419                                         rr->ProbeCount     = DefaultProbeCountForTypeUnique + 1;
9420                                         rr->AnnounceCount  = InitialAnnounceCount;
9421                                         m->SuppressProbes  = NonZeroTime(m->timenow + mDNSPlatformOneSecond);
9422                                         InitializeLastAPTime(m, rr);
9423                                         RecordProbeFailure(m, rr);  // Repeated late conflicts also cause us to back off to the slower probing rate
9424                                     }
9425                                     else
9426                                     {
9427                                         LogMsg("mDNSCoreReceiveResponse: ProbeCount %d; will deregister %s", rr->ProbeCount, ARDisplayString(m, rr));
9428                                         m->mDNSStats.NameConflicts++;
9429 #if APPLE_OSX_mDNSResponder
9430                                         // See if this record was also registered with any D2D plugins.
9431                                         D2D_stop_advertising_record(rr);
9432 #endif
9433                                         mDNS_Deregister_internal(m, rr, mDNS_Dereg_conflict);
9434                                     }
9435 
9436                                 }
9437                             }
9438                             // We assumed this record must be unique, but we were wrong. (e.g. There are two mDNSResponders on the
9439                             // same machine giving different answers for the reverse mapping record, or there are two machines on the
9440                             // network using the same IP address.) This is simply a misconfiguration, and there's nothing we can do
9441                             // to fix it -- e.g. it's not our job to be trying to change the machine's IP address. We just discard our
9442                             // record to avoid continued conflicts (as we do for a conflict on our Unique records) and get on with life.
9443                             else if (rr->resrec.RecordType == kDNSRecordTypeKnownUnique)
9444                             {
9445                                 LogMsg("mDNSCoreReceiveResponse: Unexpected conflict discarding %s", ARDisplayString(m, rr));
9446                                 m->mDNSStats.KnownUniqueNameConflicts++;
9447 #if APPLE_OSX_mDNSResponder
9448                                 D2D_stop_advertising_record(rr);
9449 #endif
9450                                 mDNS_Deregister_internal(m, rr, mDNS_Dereg_conflict);
9451                             }
9452                             else
9453                                 LogMsg("mDNSCoreReceiveResponse: Unexpected record type %X %s", rr->resrec.RecordType, ARDisplayString(m, rr));
9454                         }
9455                     }
9456                     // Else, matching signature, different type or rdata, but not a considered a conflict.
9457                     // If the packet record has the cache-flush bit set, then we check to see if we
9458                     // have any record(s) of the same type that we should re-assert to rescue them
9459                     // (see note about "multi-homing and bridged networks" at the end of this function).
9460                     else if (m->rec.r.resrec.rrtype == rr->resrec.rrtype)
9461                         if ((m->rec.r.resrec.RecordType & kDNSRecordTypePacketUniqueMask) && (mDNSu32)(m->timenow - rr->LastMCTime) > (mDNSu32)mDNSPlatformOneSecond/2)
9462                         { rr->ImmedAnswer = mDNSInterfaceMark; m->NextScheduledResponse = m->timenow; }
9463                 }
9464             }
9465         }
9466 
9467         nseclist = mDNSfalse;
9468         if (!AcceptableResponse)
9469         {
9470             AcceptableResponse = IsResponseAcceptable(m, CacheFlushRecords, unicastQuestion, &nseclist);
9471             if (AcceptableResponse) m->rec.r.resrec.rDNSServer = uDNSServer;
9472         }
9473 
9474         // 2. See if we want to add this packet resource record to our cache
9475         // We only try to cache answers if we have a cache to put them in
9476         // Also, we ignore any apparent attempts at cache poisoning unicast to us that do not answer any outstanding active query
9477         if (!AcceptableResponse) LogInfo("mDNSCoreReceiveResponse ignoring %s", CRDisplayString(m, &m->rec.r));
9478         if (m->rrcache_size && AcceptableResponse)
9479         {
9480             const mDNSu32 slot = HashSlotFromNameHash(m->rec.r.resrec.namehash);
9481             CacheGroup *cg = CacheGroupForRecord(m, &m->rec.r.resrec);
9482             CacheRecord *rr = mDNSNULL;
9483 
9484             if (McastNSEC3Records)
9485                 InitializeAnonInfoForCR(m, &McastNSEC3Records, &m->rec.r);
9486 
9487             // 2a. Check if this packet resource record is already in our cache.
9488             //
9489             // If this record should go in the nseclist, don't look in the cache for updating it.
9490             // They are supposed to be cached under the "nsec" field of the cache record for
9491             // validation. Just create the cache record.
9492             if (!nseclist)
9493             {
9494                 rr = mDNSCoreReceiveCacheCheck(m, response, LLQType, slot, cg, unicastQuestion, &cfp, &NSECCachePtr, InterfaceID);
9495             }
9496 
9497             // If packet resource record not in our cache, add it now
9498             // (unless it is just a deletion of a record we never had, in which case we don't care)
9499             if (!rr && m->rec.r.resrec.rroriginalttl > 0)
9500             {
9501                 const mDNSBool AddToCFList = (m->rec.r.resrec.RecordType & kDNSRecordTypePacketUniqueMask) && (LLQType != uDNS_LLQ_Events);
9502                 mDNSs32 delay;
9503 
9504                 if (AddToCFList)
9505                     delay = NonZeroTime(m->timenow + mDNSPlatformOneSecond);
9506                 else
9507                     delay = CheckForSoonToExpireRecords(m, m->rec.r.resrec.name, m->rec.r.resrec.namehash);
9508 
9509                 // If unique, assume we may have to delay delivery of this 'add' event.
9510                 // Below, where we walk the CacheFlushRecords list, we either call CacheRecordDeferredAdd()
9511                 // to immediately to generate answer callbacks, or we call ScheduleNextCacheCheckTime()
9512                 // to schedule an mDNS_Execute task at the appropriate time.
9513                 rr = CreateNewCacheEntry(m, slot, cg, delay, !nseclist, srcaddr);
9514                 if (rr)
9515                 {
9516                     rr->responseFlags = response->h.flags;
9517                     // If we are not creating signatures, then we need to inform DNSSEC so that
9518                     // it does not wait forever. Don't do this if we got NSEC records
9519                     // as it indicates that this name does not exist.
9520                     if (rr->resrec.rrtype == kDNSType_RRSIG && !nseclist)
9521                     {
9522                         rrsigsCreated = mDNStrue;
9523                     }
9524                     // Remember whether we created a cache record in response to a DNSSEC question.
9525                     // This helps DNSSEC code not to reissue the question to fetch the DNSSEC records.
9526                     rr->CRDNSSECQuestion = 0;
9527                     if (unicastQuestion && DNSSECQuestion(unicastQuestion))
9528                     {
9529                         LogInfo("mDNSCoreReceiveResponse: CRDNSSECQuestion set for new record %s, question %##s (%s)", CRDisplayString(m, rr),
9530                             unicastQuestion->qname.c, DNSTypeName(unicastQuestion->qtype));
9531                         rr->CRDNSSECQuestion = 1;
9532                     }
9533                     // NSEC/NSEC3 records and its signatures are cached with the negative cache entry
9534                     // which we should be creating below. It is also needed in the wildcard
9535                     // expanded answer case and in that case it is cached along with the answer.
9536                     if (nseclist)
9537                     {
9538                         rr->TimeRcvd = m->timenow;
9539                         *nsecp = rr;
9540                         nsecp = &rr->next;
9541                     }
9542                     else if (AddToCFList)
9543                     {
9544                         *cfp = rr;
9545                         cfp = &rr->NextInCFList;
9546                         *cfp = (CacheRecord*)1;
9547                     }
9548                     else if (rr->DelayDelivery)
9549                     {
9550                         ScheduleNextCacheCheckTime(m, slot, rr->DelayDelivery);
9551                     }
9552                 }
9553             }
9554             else
9555             {
9556                 if (rr && rr->resrec.AnonInfo && m->rec.r.resrec.AnonInfo)
9557                 {
9558                     CopyAnonInfoForCR(m, rr, &m->rec.r);
9559                 }
9560             }
9561         }
9562         mDNSCoreResetRecord(m);
9563     }
9564 
9565 exit:
9566     mDNSCoreResetRecord(m);
9567 
9568     // If we've just received one or more records with their cache flush bits set,
9569     // then scan that cache slot to see if there are any old stale records we need to flush
9570     while (CacheFlushRecords != (CacheRecord*)1)
9571     {
9572         CacheRecord *r1 = CacheFlushRecords, *r2;
9573         const mDNSu32 slot = HashSlotFromNameHash(r1->resrec.namehash);
9574         const CacheGroup *cg = CacheGroupForRecord(m, &r1->resrec);
9575         mDNSBool purgedRecords = mDNSfalse;
9576         CacheFlushRecords = CacheFlushRecords->NextInCFList;
9577         r1->NextInCFList = mDNSNULL;
9578 
9579         // Look for records in the cache with the same signature as this new one with the cache flush
9580         // bit set, and either (a) if they're fresh, just make sure the whole RRSet has the same TTL
9581         // (as required by DNS semantics) or (b) if they're old, mark them for deletion in one second.
9582         // We make these TTL adjustments *only* for records that still have *more* than one second
9583         // remaining to live. Otherwise, a record that we tagged for deletion half a second ago
9584         // (and now has half a second remaining) could inadvertently get its life extended, by either
9585         // (a) if we got an explicit goodbye packet half a second ago, the record would be considered
9586         // "fresh" and would be incorrectly resurrected back to the same TTL as the rest of the RRSet,
9587         // or (b) otherwise, the record would not be fully resurrected, but would be reset to expire
9588         // in one second, thereby inadvertently delaying its actual expiration, instead of hastening it.
9589         // If this were to happen repeatedly, the record's expiration could be deferred indefinitely.
9590         // To avoid this, we need to ensure that the cache flushing operation will only act to
9591         // *decrease* a record's remaining lifetime, never *increase* it.
9592         for (r2 = cg ? cg->members : mDNSNULL; r2; r2=r2->next)
9593         {
9594             mDNSu16 id1;
9595             mDNSu16 id2;
9596             if (!r1->resrec.InterfaceID)
9597             {
9598                 id1 = (r1->resrec.rDNSServer ? r1->resrec.rDNSServer->resGroupID : 0);
9599                 id2 = (r2->resrec.rDNSServer ? r2->resrec.rDNSServer->resGroupID : 0);
9600             }
9601             else
9602             {
9603                 id1 = id2 = 0;
9604             }
9605             // When we receive new RRSIGs e.g., for DNSKEY record, we should not flush the old
9606             // RRSIGS e.g., for TXT record. To do so, we need to look at the typeCovered field of
9607             // the new RRSIG that we received. Process only if the typeCovered matches.
9608             if ((r1->resrec.rrtype == r2->resrec.rrtype) && (r1->resrec.rrtype == kDNSType_RRSIG))
9609             {
9610                 rdataRRSig *rrsig1 = (rdataRRSig *)(((RDataBody2 *)(r1->resrec.rdata->u.data))->data);
9611                 rdataRRSig *rrsig2 = (rdataRRSig *)(((RDataBody2 *)(r2->resrec.rdata->u.data))->data);
9612                 if (swap16(rrsig1->typeCovered) != swap16(rrsig2->typeCovered))
9613                 {
9614                     debugf("mDNSCoreReceiveResponse: Received RRSIG typeCovered %s, found %s, not processing",
9615                         DNSTypeName(swap16(rrsig1->typeCovered)), DNSTypeName(swap16(rrsig2->typeCovered)));
9616                     continue;
9617                 }
9618             }
9619 
9620             // For Unicast (null InterfaceID) the resolver IDs should also match
9621             if ((r1->resrec.InterfaceID == r2->resrec.InterfaceID) &&
9622                 (r1->resrec.InterfaceID || (id1 == id2)) &&
9623                 r1->resrec.rrtype      == r2->resrec.rrtype &&
9624                 r1->resrec.rrclass     == r2->resrec.rrclass)
9625             {
9626                 if (r1->resrec.mortality == Mortality_Mortal && r2->resrec.mortality != Mortality_Mortal)
9627                 {
9628                     verbosedebugf("mDNSCoreReceiveResponse: R1(%p) is being immortalized by R2(%p)", r1, r2);
9629                     r1->resrec.mortality = Mortality_Immortal;   //  Immortalize the replacement record
9630                 }
9631 
9632                 // If record is recent, just ensure the whole RRSet has the same TTL (as required by DNS semantics)
9633                 // else, if record is old, mark it to be flushed
9634                 if (m->timenow - r2->TimeRcvd < mDNSPlatformOneSecond && RRExpireTime(r2) - m->timenow > mDNSPlatformOneSecond)
9635                 {
9636                     // If we find mismatched TTLs in an RRSet, correct them.
9637                     // We only do this for records with a TTL of 2 or higher. It's possible to have a
9638                     // goodbye announcement with the cache flush bit set (or a case-change on record rdata,
9639                     // which we treat as a goodbye followed by an addition) and in that case it would be
9640                     // inappropriate to synchronize all the other records to a TTL of 0 (or 1).
9641 
9642                     // We suppress the message for the specific case of correcting from 240 to 60 for type TXT,
9643                     // because certain early Bonjour devices are known to have this specific mismatch, and
9644                     // there's no point filling syslog with messages about something we already know about.
9645                     // We also don't log this for uDNS responses, since a caching name server is obliged
9646                     // to give us an aged TTL to correct for how long it has held the record,
9647                     // so our received TTLs are expected to vary in that case
9648 
9649                     // We also suppress log message in the case of SRV records that are received
9650                     // with a TTL of 4500 that are already cached with a TTL of 120 seconds, since
9651                     // this behavior was observed for a number of discoveryd based AppleTV's in iOS 8
9652                     // GM builds.
9653                     if (r2->resrec.rroriginalttl != r1->resrec.rroriginalttl && r1->resrec.rroriginalttl > 1)
9654                     {
9655                         if (!(r2->resrec.rroriginalttl == 240 && r1->resrec.rroriginalttl == 60 && r2->resrec.rrtype == kDNSType_TXT) &&
9656                             !(r2->resrec.rroriginalttl == 120 && r1->resrec.rroriginalttl == 4500 && r2->resrec.rrtype == kDNSType_SRV) &&
9657                             mDNSOpaque16IsZero(response->h.id))
9658                             LogInfo("Correcting TTL from %4d to %4d for %s",
9659                                     r2->resrec.rroriginalttl, r1->resrec.rroriginalttl, CRDisplayString(m, r2));
9660                         r2->resrec.rroriginalttl = r1->resrec.rroriginalttl;
9661                     }
9662                     r2->TimeRcvd = m->timenow;
9663                     SetNextCacheCheckTimeForRecord(m, r2);
9664                 }
9665                 else if (r2->resrec.InterfaceID) // else, if record is old, mark it to be flushed
9666                 {
9667                     verbosedebugf("Cache flush new %p age %d expire in %d %s", r1, m->timenow - r1->TimeRcvd, RRExpireTime(r1) - m->timenow, CRDisplayString(m, r1));
9668                     verbosedebugf("Cache flush old %p age %d expire in %d %s", r2, m->timenow - r2->TimeRcvd, RRExpireTime(r2) - m->timenow, CRDisplayString(m, r2));
9669                     // We set stale records to expire in one second.
9670                     // This gives the owner a chance to rescue it if necessary.
9671                     // This is important in the case of multi-homing and bridged networks:
9672                     //   Suppose host X is on Ethernet. X then connects to an AirPort base station, which happens to be
9673                     //   bridged onto the same Ethernet. When X announces its AirPort IP address with the cache-flush bit
9674                     //   set, the AirPort packet will be bridged onto the Ethernet, and all other hosts on the Ethernet
9675                     //   will promptly delete their cached copies of the (still valid) Ethernet IP address record.
9676                     //   By delaying the deletion by one second, we give X a change to notice that this bridging has
9677                     //   happened, and re-announce its Ethernet IP address to rescue it from deletion from all our caches.
9678 
9679                     // We set UnansweredQueries to MaxUnansweredQueries to avoid expensive and unnecessary
9680                     // final expiration queries for this record.
9681 
9682                     // If a record is deleted twice, first with an explicit DE record, then a second time by virtue of the cache
9683                     // flush bit on the new record replacing it, then we allow the record to be deleted immediately, without the usual
9684                     // one-second grace period. This improves responsiveness for mDNS_Update(), as used for things like iChat status updates.
9685                     // <rdar://problem/5636422> Updating TXT records is too slow
9686                     // We check for "rroriginalttl == 1" because we want to include records tagged by the "packet TTL is zero" check above,
9687                     // which sets rroriginalttl to 1, but not records tagged by the rdata case-change check, which sets rroriginalttl to 0.
9688                     if (r2->TimeRcvd == m->timenow && r2->resrec.rroriginalttl == 1 && r2->UnansweredQueries == MaxUnansweredQueries)
9689                     {
9690                         LogInfo("Cache flush for DE record %s", CRDisplayString(m, r2));
9691                         r2->resrec.rroriginalttl = 0;
9692                     }
9693                     else if (RRExpireTime(r2) - m->timenow > mDNSPlatformOneSecond)
9694                     {
9695                         // We only set a record to expire in one second if it currently has *more* than a second to live
9696                         // If it's already due to expire in a second or less, we just leave it alone
9697                         r2->resrec.rroriginalttl = 1;
9698                         r2->UnansweredQueries = MaxUnansweredQueries;
9699                         r2->TimeRcvd = m->timenow - 1;
9700                         // We use (m->timenow - 1) instead of m->timenow, because we use that to identify records
9701                         // that we marked for deletion via an explicit DE record
9702                     }
9703                     SetNextCacheCheckTimeForRecord(m, r2);
9704                 }
9705                 else
9706                 {
9707 #if AWD_METRICS
9708                     if (r2->resrec.mortality == Mortality_Ghost)
9709                     {
9710                         DNSQuestion * q;
9711                         for (q = m->Questions; q; q=q->next)
9712                         {
9713                             if (!q->LongLived && ActiveQuestion(q) &&
9714                                 ResourceRecordAnswersQuestion(&r2->resrec, q) &&
9715                                 q->metrics.expiredAnswerState == ExpiredAnswer_AnsweredWithExpired)
9716                             {
9717                                 q->metrics.expiredAnswerState = ExpiredAnswer_ExpiredAnswerChanged;
9718                             }
9719                         }
9720                     }
9721 #endif
9722                     // Old uDNS records are scheduled to be purged instead of given at most one second to live.
9723                     r2->resrec.mortality = Mortality_Mortal;       //  We want it purged, so remove any immortality
9724                     mDNS_PurgeCacheResourceRecord(m, r2);
9725                     purgedRecords = mDNStrue;
9726                 }
9727             }
9728         }
9729 
9730         if (r1->DelayDelivery)  // If we were planning to delay delivery of this record, see if we still need to
9731         {
9732             // If we had a unicast question for this response with at least one positive answer and we
9733             // have NSECRecords, it is most likely a wildcard expanded answer. Cache the NSEC and its
9734             // signatures along with the cache record which will be used for validation later. If
9735             // we rescued a few records earlier in this function, then NSECCachePtr would be set. In that
9736             // use that instead.
9737             if (response->h.numAnswers && unicastQuestion && NSECRecords)
9738             {
9739                 if (!NSECCachePtr)
9740                 {
9741                     LogInfo("mDNSCoreReceiveResponse: Updating NSECCachePtr to %s", CRDisplayString(m, r1));
9742                     NSECCachePtr = r1;
9743                 }
9744                 // Note: We need to do this before we call CacheRecordDeferredAdd as this
9745                 // might start the verification process which needs these NSEC records
9746                 if (!AddNSECSForCacheRecord(m, NSECRecords, NSECCachePtr, rcode))
9747                 {
9748                     LogInfo("mDNSCoreReceiveResponse: AddNSECSForCacheRecord failed to add NSEC for %s", CRDisplayString(m, NSECCachePtr));
9749                     FreeNSECRecords(m, NSECRecords);
9750                 }
9751                 NSECRecords = mDNSNULL;
9752                 NSECCachePtr = mDNSNULL;
9753             }
9754             if (r1->resrec.InterfaceID)
9755             {
9756                 r1->DelayDelivery = CheckForSoonToExpireRecords(m, r1->resrec.name, r1->resrec.namehash);
9757             }
9758             else
9759             {
9760                 // If uDNS records from an older RRset were scheduled to be purged, then delay delivery slightly to allow
9761                 // them to be deleted before any ADD events for this record.
9762                 r1->DelayDelivery = purgedRecords ? NonZeroTime(m->timenow) : 0;
9763             }
9764             // If no longer delaying, deliver answer now, else schedule delivery for the appropriate time
9765             if (!r1->DelayDelivery) CacheRecordDeferredAdd(m, r1);
9766             else ScheduleNextCacheCheckTime(m, slot, r1->DelayDelivery);
9767         }
9768     }
9769 
9770     // If we have not consumed the NSEC records yet e.g., just refreshing the cache,
9771     // update them now for future validations.
9772     if (NSECRecords && NSECCachePtr)
9773     {
9774         LogInfo("mDNSCoreReceieveResponse: Updating NSEC records in %s", CRDisplayString(m, NSECCachePtr));
9775         if (!AddNSECSForCacheRecord(m, NSECRecords, NSECCachePtr, rcode))
9776         {
9777             LogInfo("mDNSCoreReceiveResponse: AddNSECSForCacheRecord failed to add NSEC for %s", CRDisplayString(m, NSECCachePtr));
9778             FreeNSECRecords(m, NSECRecords);
9779         }
9780         NSECRecords = mDNSNULL;
9781         NSECCachePtr = mDNSNULL;
9782     }
9783 
9784     // If there is at least one answer and we did not create RRSIGs and there was a
9785     // ValidatingResponse question waiting for this response, give a hint that no RRSIGs
9786     // were created. We don't need to give a hint:
9787     //
9788     // - if we have no answers, the mDNSCoreReceiveNoUnicastAnswers below should
9789     //   generate a negative response
9790     //
9791     // - if we have NSECRecords, it means we might have a potential proof for
9792     //   non-existence of name that we are looking for
9793     //
9794     if (response->h.numAnswers && !rrsigsCreated && DNSSECQuestion && !NSECRecords)
9795         mDNSCoreReceiveNoDNSSECAnswers(m, response, end, dstaddr, dstport, InterfaceID);
9796 
9797     // See if we need to generate negative cache entries for unanswered unicast questions
9798     mDNSCoreReceiveNoUnicastAnswers(m, response, end, dstaddr, dstport, InterfaceID, LLQType, rcode, NSECRecords);
9799 
9800     if (McastNSEC3Records)
9801     {
9802         debugf("mDNSCoreReceiveResponse: McastNSEC3Records not used");
9803         FreeNSECRecords(m, McastNSEC3Records);
9804     }
9805 }
9806 
9807 // ScheduleWakeup causes all proxy records with WakeUp.HMAC matching mDNSEthAddr 'e' to be deregistered, causing
9808 // multiple wakeup magic packets to be sent if appropriate, and all records to be ultimately freed after a few seconds.
9809 // ScheduleWakeup is called on mDNS record conflicts, ARP conflicts, NDP conflicts, or reception of trigger traffic
9810 // that warrants waking the sleeping host.
9811 // ScheduleWakeup must be called with the lock held (ScheduleWakeupForList uses mDNS_Deregister_internal)
9812 
9813 mDNSlocal void ScheduleWakeupForList(mDNS *const m, mDNSInterfaceID InterfaceID, mDNSEthAddr *e, AuthRecord *const thelist)
9814 {
9815     // We need to use the m->CurrentRecord mechanism here when dealing with DuplicateRecords list as
9816     // mDNS_Deregister_internal deregisters duplicate records immediately as they are not used
9817     // to send wakeups or goodbyes. See the comment in that function for more details. To keep it
9818     // simple, we use the same mechanism for both lists.
9819     if (!e->l[0])
9820     {
9821         LogMsg("ScheduleWakeupForList ERROR: Target HMAC is zero");
9822         return;
9823     }
9824     m->CurrentRecord = thelist;
9825     while (m->CurrentRecord)
9826     {
9827         AuthRecord *const rr = m->CurrentRecord;
9828         if (rr->resrec.InterfaceID == InterfaceID && rr->resrec.RecordType != kDNSRecordTypeDeregistering && mDNSSameEthAddress(&rr->WakeUp.HMAC, e))
9829         {
9830             LogInfo("ScheduleWakeupForList: Scheduling wakeup packets for %s", ARDisplayString(m, rr));
9831             mDNS_Deregister_internal(m, rr, mDNS_Dereg_normal);
9832         }
9833         if (m->CurrentRecord == rr) // If m->CurrentRecord was not advanced for us, do it now
9834             m->CurrentRecord = rr->next;
9835     }
9836 }
9837 
9838 mDNSlocal void ScheduleWakeup(mDNS *const m, mDNSInterfaceID InterfaceID, mDNSEthAddr *e)
9839 {
9840     if (!e->l[0]) { LogMsg("ScheduleWakeup ERROR: Target HMAC is zero"); return; }
9841     ScheduleWakeupForList(m, InterfaceID, e, m->DuplicateRecords);
9842     ScheduleWakeupForList(m, InterfaceID, e, m->ResourceRecords);
9843 }
9844 
9845 mDNSlocal void SPSRecordCallback(mDNS *const m, AuthRecord *const ar, mStatus result)
9846 {
9847     if (result && result != mStatus_MemFree)
9848         LogInfo("SPS Callback %d %s", result, ARDisplayString(m, ar));
9849 
9850     if (result == mStatus_NameConflict)
9851     {
9852         mDNS_Lock(m);
9853         LogMsg("%-7s Conflicting mDNS -- waking %.6a %s", InterfaceNameForID(m, ar->resrec.InterfaceID), &ar->WakeUp.HMAC, ARDisplayString(m, ar));
9854         if (ar->WakeUp.HMAC.l[0])
9855         {
9856             SendWakeup(m, ar->resrec.InterfaceID, &ar->WakeUp.IMAC, &ar->WakeUp.password, mDNSfalse);  // Send one wakeup magic packet
9857             ScheduleWakeup(m, ar->resrec.InterfaceID, &ar->WakeUp.HMAC);                               // Schedule all other records with the same owner to be woken
9858         }
9859         mDNS_Unlock(m);
9860     }
9861 
9862     if (result == mStatus_NameConflict || result == mStatus_MemFree)
9863     {
9864         m->ProxyRecords--;
9865         mDNSPlatformMemFree(ar);
9866         mDNS_UpdateAllowSleep(m);
9867     }
9868 }
9869 
9870 mDNSlocal mDNSu8 *GetValueForMACAddr(mDNSu8 *ptr, mDNSu8 *limit, mDNSEthAddr *eth)
9871 {
9872     int     i;
9873     mDNSs8  hval   = 0;
9874     int     colons = 0;
9875     mDNSu16  val    = 0; /* need to use 16 bit int to detect overflow */
9876 
9877     for (i = 0; ptr < limit && *ptr != ' ' && i < 17; i++, ptr++)
9878     {
9879         hval = HexVal(*ptr);
9880         if (hval != -1)
9881         {
9882             val <<= 4;
9883             val |= hval;
9884         }
9885         else if (*ptr == ':')
9886         {
9887             if (colons >=5)
9888             {
9889                 LogMsg("GetValueForMACAddr: Address malformed colons %d val %d", colons, val);
9890                 return mDNSNULL;
9891             }
9892             eth->b[colons] = (mDNSs8)val;
9893             colons++;
9894             val = 0;
9895         }
9896     }
9897     if (colons != 5)
9898     {
9899         LogMsg("GetValueForMACAddr: Address malformed colons %d", colons);
9900         return mDNSNULL;
9901     }
9902     eth->b[colons] = (mDNSs8)val;
9903     return ptr;
9904 }
9905 
9906 mDNSlocal mDNSu8 *GetValueForIPv6Addr(mDNSu8 *ptr, mDNSu8 *limit, mDNSv6Addr *v6)
9907 {
9908     int hval;
9909     int value;
9910     int numBytes;
9911     int digitsProcessed;
9912     int zeroFillStart;
9913     int numColons;
9914     mDNSu8 v6addr[16];
9915 
9916     // RFC 3513: Section 2.2 specifies IPv6 presentation format. The following parsing
9917     // handles both (1) and (2) and does not handle embedded IPv4 addresses.
9918     //
9919     // First forms a address in "v6addr", then expands to fill the zeroes in and returns
9920     // the result in "v6"
9921 
9922     numColons = numBytes = value = digitsProcessed = zeroFillStart = 0;
9923     while (ptr < limit && *ptr != ' ')
9924     {
9925         hval = HexVal(*ptr);
9926         if (hval != -1)
9927         {
9928             value <<= 4;
9929             value |= hval;
9930             digitsProcessed = 1;
9931         }
9932         else if (*ptr == ':')
9933         {
9934             if (!digitsProcessed)
9935             {
9936                 // If we have already seen a "::", we should not see one more. Handle the special
9937                 // case of "::"
9938                 if (numColons)
9939                 {
9940                     // if we never filled any bytes and the next character is space (we have reached the end)
9941                     // we are done
9942                     if (!numBytes && (ptr + 1) < limit && *(ptr + 1) == ' ')
9943                     {
9944                         mDNSPlatformMemZero(v6->b, 16);
9945                         return ptr + 1;
9946                     }
9947                     LogMsg("GetValueForIPv6Addr: zeroFillStart non-zero %d", zeroFillStart);
9948                     return mDNSNULL;
9949                 }
9950 
9951                 // We processed "::". We need to fill zeroes later. For now, mark the
9952                 // point where we will start filling zeroes from.
9953                 zeroFillStart = numBytes;
9954                 numColons++;
9955             }
9956             else if ((ptr + 1) < limit && *(ptr + 1) == ' ')
9957             {
9958                 // We have a trailing ":" i.e., no more characters after ":"
9959                 LogMsg("GetValueForIPv6Addr: Trailing colon");
9960                 return mDNSNULL;
9961             }
9962             else
9963             {
9964                 // For a fully expanded IPv6 address, we fill the 14th and 15th byte outside of this while
9965                 // loop below as there is no ":" at the end. Hence, the last two bytes that can possibly
9966                 // filled here is 12 and 13.
9967                 if (numBytes > 13) { LogMsg("GetValueForIPv6Addr:1: numBytes is %d", numBytes); return mDNSNULL; }
9968 
9969                 v6addr[numBytes++] = (mDNSu8) ((value >> 8) & 0xFF);
9970                 v6addr[numBytes++] = (mDNSu8) (value & 0xFF);
9971                 digitsProcessed = value = 0;
9972 
9973                 // Make sure that we did not fill the 13th and 14th byte above
9974                 if (numBytes > 14) { LogMsg("GetValueForIPv6Addr:2: numBytes is %d", numBytes); return mDNSNULL; }
9975             }
9976         }
9977         ptr++;
9978     }
9979 
9980     // We should be processing the last set of bytes following the last ":" here
9981     if (!digitsProcessed)
9982     {
9983         LogMsg("GetValueForIPv6Addr: no trailing bytes after colon, numBytes is %d", numBytes);
9984         return mDNSNULL;
9985     }
9986 
9987     if (numBytes > 14) { LogMsg("GetValueForIPv6Addr:3: numBytes is %d", numBytes); return mDNSNULL; }
9988     v6addr[numBytes++] = (mDNSu8) ((value >> 8) & 0xFF);
9989     v6addr[numBytes++] = (mDNSu8) (value & 0xFF);
9990 
9991     if (zeroFillStart)
9992     {
9993         int i, j, n;
9994         for (i = 0; i < zeroFillStart; i++)
9995             v6->b[i] = v6addr[i];
9996         for (j = i, n = 0; n < 16 - numBytes; j++, n++)
9997             v6->b[j] = 0;
9998         for (; j < 16; i++, j++)
9999             v6->b[j] = v6addr[i];
10000     }
10001     else if (numBytes == 16)
10002         mDNSPlatformMemCopy(v6->b, v6addr, 16);
10003     else
10004     {
10005         LogMsg("GetValueForIPv6addr: Not enough bytes for IPv6 address, numBytes is %d", numBytes);
10006         return mDNSNULL;
10007     }
10008     return ptr;
10009 }
10010 
10011 mDNSlocal mDNSu8 *GetValueForIPv4Addr(mDNSu8 *ptr, mDNSu8 *limit, mDNSv4Addr *v4)
10012 {
10013     mDNSu32 val;
10014     int dots = 0;
10015     val = 0;
10016 
10017     for ( ; ptr < limit && *ptr != ' '; ptr++)
10018     {
10019         if (*ptr >= '0' &&  *ptr <= '9')
10020             val = val * 10 + *ptr - '0';
10021         else if (*ptr == '.')
10022         {
10023             if (val > 255 || dots >= 3)
10024             {
10025                 LogMsg("GetValueForIPv4Addr: something wrong ptr(%p) %c, limit %p, dots %d", ptr, *ptr, limit, dots);
10026                 return mDNSNULL;
10027             }
10028             v4->b[dots++] = val;
10029             val = 0;
10030         }
10031         else
10032         {
10033             // We have a zero at the end and if we reached that, then we are done.
10034             if (*ptr == 0 && ptr == limit - 1 && dots == 3)
10035             {
10036                 v4->b[dots] = val;
10037                 return ptr + 1;
10038             }
10039             else { LogMsg("GetValueForIPv4Addr: something wrong ptr(%p) %c, limit %p, dots %d", ptr, *ptr, limit, dots); return mDNSNULL; }
10040         }
10041     }
10042     if (dots != 3) { LogMsg("GetValueForIPv4Addr: Address malformed dots %d", dots); return mDNSNULL; }
10043     v4->b[dots] = val;
10044     return ptr;
10045 }
10046 
10047 mDNSlocal mDNSu8 *GetValueForKeepalive(mDNSu8 *ptr, mDNSu8 *limit, mDNSu32 *value)
10048 {
10049     mDNSu32 val;
10050 
10051     val = 0;
10052     for ( ; ptr < limit && *ptr != ' '; ptr++)
10053     {
10054         if (*ptr < '0' || *ptr > '9')
10055         {
10056             // We have a zero at the end and if we reached that, then we are done.
10057             if (*ptr == 0 && ptr == limit - 1)
10058             {
10059                 *value = val;
10060                 return ptr + 1;
10061             }
10062             else { LogMsg("GetValueForKeepalive: *ptr %d, ptr %p, limit %p, ptr +1 %d", *ptr, ptr, limit, *(ptr + 1)); return mDNSNULL; }
10063         }
10064         val = val * 10 + *ptr - '0';
10065     }
10066     *value = val;
10067     return ptr;
10068 }
10069 
10070 mDNSexport mDNSBool mDNSValidKeepAliveRecord(AuthRecord *rr)
10071 {
10072     mDNSAddr    laddr, raddr;
10073     mDNSEthAddr eth;
10074     mDNSIPPort  lport, rport;
10075     mDNSu32     timeout, seq, ack;
10076     mDNSu16     win;
10077 
10078     if (!mDNS_KeepaliveRecord(&rr->resrec))
10079     {
10080         return mDNSfalse;
10081     }
10082 
10083     timeout = seq = ack = 0;
10084     win = 0;
10085     laddr = raddr = zeroAddr;
10086     lport = rport = zeroIPPort;
10087     eth = zeroEthAddr;
10088 
10089     mDNS_ExtractKeepaliveInfo(rr, &timeout, &laddr, &raddr, &eth, &seq, &ack, &lport, &rport, &win);
10090 
10091     if (mDNSAddressIsZero(&laddr) || mDNSIPPortIsZero(lport) ||
10092         mDNSAddressIsZero(&raddr) || mDNSIPPortIsZero(rport) ||
10093         mDNSEthAddressIsZero(eth))
10094     {
10095         return mDNSfalse;
10096     }
10097 
10098     return mDNStrue;
10099 }
10100 
10101 
10102 mDNSlocal void mDNS_ExtractKeepaliveInfo(AuthRecord *ar, mDNSu32 *timeout, mDNSAddr *laddr, mDNSAddr *raddr, mDNSEthAddr *eth, mDNSu32 *seq,
10103                                          mDNSu32 *ack, mDNSIPPort *lport, mDNSIPPort *rport, mDNSu16 *win)
10104 {
10105     if (ar->resrec.rrtype != kDNSType_NULL)
10106         return;
10107 
10108     if (mDNS_KeepaliveRecord(&ar->resrec))
10109     {
10110         int len = ar->resrec.rdlength;
10111         mDNSu8 *ptr = &ar->resrec.rdata->u.txt.c[1];
10112         mDNSu8 *limit = ptr + len - 1; // Exclude the first byte that is the length
10113         mDNSu32 value = 0;
10114 
10115         while (ptr < limit)
10116         {
10117             mDNSu8 param = *ptr;
10118             ptr += 2;   // Skip the letter and the "="
10119             if (param == 'h')
10120             {
10121                 laddr->type = mDNSAddrType_IPv4;
10122                 ptr = GetValueForIPv4Addr(ptr, limit, &laddr->ip.v4);
10123             }
10124             else if (param == 'd')
10125             {
10126                 raddr->type = mDNSAddrType_IPv4;
10127                 ptr = GetValueForIPv4Addr(ptr, limit, &raddr->ip.v4);
10128             }
10129             else if (param == 'H')
10130             {
10131                 laddr->type = mDNSAddrType_IPv6;
10132                 ptr = GetValueForIPv6Addr(ptr, limit, &laddr->ip.v6);
10133             }
10134             else if (param == 'D')
10135             {
10136                 raddr->type = mDNSAddrType_IPv6;
10137                 ptr = GetValueForIPv6Addr(ptr, limit, &raddr->ip.v6);
10138             }
10139             else if (param == 'm')
10140             {
10141                 ptr = GetValueForMACAddr(ptr, limit, eth);
10142             }
10143             else
10144             {
10145                 ptr = GetValueForKeepalive(ptr, limit, &value);
10146             }
10147             if (!ptr) { LogMsg("mDNS_ExtractKeepaliveInfo: Cannot parse\n"); return; }
10148 
10149             // Extract everything in network order so that it is easy for sending a keepalive and also
10150             // for matching incoming TCP packets
10151             switch (param)
10152             {
10153             case 't':
10154                 *timeout = value;
10155                 //if (*timeout < 120) *timeout = 120;
10156                 break;
10157             case 'h':
10158             case 'H':
10159             case 'd':
10160             case 'D':
10161             case 'm':
10162             case 'i':
10163             case 'c':
10164                 break;
10165             case 'l':
10166                 lport->NotAnInteger = swap16((mDNSu16)value);
10167                 break;
10168             case 'r':
10169                 rport->NotAnInteger = swap16((mDNSu16)value);
10170                 break;
10171             case 's':
10172                 *seq = swap32(value);
10173                 break;
10174             case 'a':
10175                 *ack = swap32(value);
10176                 break;
10177             case 'w':
10178                 *win = swap16((mDNSu16)value);
10179                 break;
10180             default:
10181                 LogMsg("mDNS_ExtractKeepaliveInfo: unknown value %c\n", param);
10182                 ptr = limit;
10183                 break;
10184             }
10185             ptr++; // skip the space
10186         }
10187     }
10188 }
10189 
10190 // Matches the proxied auth records to the incoming TCP packet and returns the match and its sequence and ack in "rseq" and "rack" so that
10191 // the clients need not retrieve this information from the auth record again.
10192 mDNSlocal AuthRecord* mDNS_MatchKeepaliveInfo(mDNS *const m, const mDNSAddr* pladdr, const mDNSAddr* praddr, const mDNSIPPort plport,
10193                                               const mDNSIPPort prport, mDNSu32 *rseq, mDNSu32 *rack)
10194 {
10195     AuthRecord *ar;
10196     mDNSAddr laddr, raddr;
10197     mDNSEthAddr eth;
10198     mDNSIPPort lport, rport;
10199     mDNSu32 timeout, seq, ack;
10200     mDNSu16 win;
10201 
10202     for (ar = m->ResourceRecords; ar; ar=ar->next)
10203     {
10204         timeout = seq = ack = 0;
10205         win = 0;
10206         laddr = raddr = zeroAddr;
10207         lport = rport = zeroIPPort;
10208 
10209         if (!ar->WakeUp.HMAC.l[0]) continue;
10210 
10211         mDNS_ExtractKeepaliveInfo(ar, &timeout, &laddr, &raddr, &eth, &seq, &ack, &lport, &rport, &win);
10212 
10213         // Did we parse correctly ?
10214         if (!timeout || mDNSAddressIsZero(&laddr) || mDNSAddressIsZero(&raddr) || !seq || !ack || mDNSIPPortIsZero(lport) || mDNSIPPortIsZero(rport) || !win)
10215         {
10216             debugf("mDNS_MatchKeepaliveInfo: not a valid record %s for keepalive", ARDisplayString(m, ar));
10217             continue;
10218         }
10219 
10220         debugf("mDNS_MatchKeepaliveInfo: laddr %#a pladdr %#a, raddr %#a praddr %#a, lport %d plport %d, rport %d prport %d",
10221                &laddr, pladdr, &raddr, praddr, mDNSVal16(lport), mDNSVal16(plport), mDNSVal16(rport), mDNSVal16(prport));
10222 
10223         // Does it match the incoming TCP packet ?
10224         if (mDNSSameAddress(&laddr, pladdr) && mDNSSameAddress(&raddr, praddr) && mDNSSameIPPort(lport, plport) && mDNSSameIPPort(rport, prport))
10225         {
10226             // returning in network order
10227             *rseq = seq;
10228             *rack = ack;
10229             return ar;
10230         }
10231     }
10232     return mDNSNULL;
10233 }
10234 
10235 mDNSlocal void mDNS_SendKeepalives(mDNS *const m)
10236 {
10237     AuthRecord *ar;
10238 
10239     for (ar = m->ResourceRecords; ar; ar=ar->next)
10240     {
10241         mDNSu32 timeout, seq, ack;
10242         mDNSu16 win;
10243         mDNSAddr laddr, raddr;
10244         mDNSEthAddr eth;
10245         mDNSIPPort lport, rport;
10246 
10247         timeout = seq = ack = 0;
10248         win = 0;
10249 
10250         laddr = raddr = zeroAddr;
10251         lport = rport = zeroIPPort;
10252 
10253         if (!ar->WakeUp.HMAC.l[0]) continue;
10254 
10255         mDNS_ExtractKeepaliveInfo(ar, &timeout, &laddr, &raddr, &eth, &seq, &ack, &lport, &rport, &win);
10256 
10257         if (!timeout || mDNSAddressIsZero(&laddr) || mDNSAddressIsZero(&raddr) || !seq || !ack || mDNSIPPortIsZero(lport) || mDNSIPPortIsZero(rport) || !win)
10258         {
10259             debugf("mDNS_SendKeepalives: not a valid record %s for keepalive", ARDisplayString(m, ar));
10260             continue;
10261         }
10262         LogMsg("mDNS_SendKeepalives: laddr %#a raddr %#a lport %d rport %d", &laddr, &raddr, mDNSVal16(lport), mDNSVal16(rport));
10263 
10264         // When we receive a proxy update, we set KATimeExpire to zero so that we always send a keepalive
10265         // immediately (to detect any potential problems). After that we always set it to a non-zero value.
10266         if (!ar->KATimeExpire || (m->timenow - ar->KATimeExpire >= 0))
10267         {
10268             mDNSPlatformSendKeepalive(&laddr, &raddr, &lport, &rport, seq, ack, win);
10269             ar->KATimeExpire = NonZeroTime(m->timenow + timeout * mDNSPlatformOneSecond);
10270         }
10271         if (m->NextScheduledKA - ar->KATimeExpire > 0)
10272             m->NextScheduledKA = ar->KATimeExpire;
10273     }
10274 }
10275 
10276 mDNSlocal void mDNS_SendKeepaliveACK(mDNS *const m, AuthRecord *ar)
10277 {
10278     mDNSu32     timeout, seq, ack, seqInc;
10279     mDNSu16     win;
10280     mDNSAddr    laddr, raddr;
10281     mDNSEthAddr eth;
10282     mDNSIPPort  lport, rport;
10283     mDNSu8      *ptr;
10284 
10285     if (ar == mDNSNULL)
10286     {
10287         LogInfo("mDNS_SendKeepalivesACK: AuthRecord is NULL");
10288         return;
10289     }
10290 
10291     timeout = seq = ack = 0;
10292     win = 0;
10293 
10294     laddr = raddr = zeroAddr;
10295     lport = rport = zeroIPPort;
10296 
10297     mDNS_ExtractKeepaliveInfo(ar, &timeout, &laddr, &raddr, &eth, &seq, &ack, &lport, &rport, &win);
10298 
10299     if (!timeout || mDNSAddressIsZero(&laddr) || mDNSAddressIsZero(&raddr) || !seq || !ack || mDNSIPPortIsZero(lport) || mDNSIPPortIsZero(rport) || !win)
10300     {
10301         LogInfo("mDNS_SendKeepaliveACK: not a valid record %s for keepalive", ARDisplayString(m, ar));
10302         return;
10303     }
10304 
10305     // To send a keepalive ACK, we need to add one to the sequence number from the keepalive
10306     // record, which is the TCP connection's "next" sequence number minus one. Otherwise, the
10307     // keepalive ACK also ends up being a keepalive probe. Also, seq is in network byte order, so
10308     // it's converted to host byte order before incrementing it by one.
10309     ptr = (mDNSu8 *)&seq;
10310     seqInc = (mDNSu32)((ptr[0] << 24) | (ptr[1] << 16) | (ptr[2] << 8) | ptr[3]) + 1;
10311     ptr[0] = (mDNSu8)((seqInc >> 24) & 0xFF);
10312     ptr[1] = (mDNSu8)((seqInc >> 16) & 0xFF);
10313     ptr[2] = (mDNSu8)((seqInc >>  8) & 0xFF);
10314     ptr[3] = (mDNSu8)((seqInc      ) & 0xFF);
10315     LogMsg("mDNS_SendKeepaliveACK: laddr %#a raddr %#a lport %d rport %d", &laddr, &raddr, mDNSVal16(lport), mDNSVal16(rport));
10316     mDNSPlatformSendKeepalive(&laddr, &raddr, &lport, &rport, seq, ack, win);
10317 }
10318 
10319 mDNSlocal void mDNSCoreReceiveUpdate(mDNS *const m,
10320                                      const DNSMessage *const msg, const mDNSu8 *end,
10321                                      const mDNSAddr *srcaddr, const mDNSIPPort srcport, const mDNSAddr *dstaddr, mDNSIPPort dstport,
10322                                      const mDNSInterfaceID InterfaceID)
10323 {
10324     int i;
10325     AuthRecord opt;
10326     mDNSu8 *p = m->omsg.data;
10327     OwnerOptData owner = zeroOwner;     // Need to zero this, so we'll know if this Update packet was missing its Owner option
10328     mDNSu32 updatelease = 0;
10329     const mDNSu8 *ptr;
10330 
10331     LogSPS("Received Update from %#-15a:%-5d to %#-15a:%-5d on 0x%p with "
10332            "%2d Question%s %2d Answer%s %2d Authorit%s %2d Additional%s %d bytes",
10333            srcaddr, mDNSVal16(srcport), dstaddr, mDNSVal16(dstport), InterfaceID,
10334            msg->h.numQuestions,   msg->h.numQuestions   == 1 ? ", "   : "s,",
10335            msg->h.numAnswers,     msg->h.numAnswers     == 1 ? ", "   : "s,",
10336            msg->h.numAuthorities, msg->h.numAuthorities == 1 ? "y,  " : "ies,",
10337            msg->h.numAdditionals, msg->h.numAdditionals == 1 ? " "    : "s", end - msg->data);
10338 
10339     if (!InterfaceID || !m->SPSSocket || !mDNSSameIPPort(dstport, m->SPSSocket->port)) return;
10340 
10341     if (mDNS_PacketLoggingEnabled)
10342         DumpPacket(mStatus_NoError, mDNSfalse, "UDP", srcaddr, srcport, dstaddr, dstport, msg, end);
10343 
10344     ptr = LocateOptRR(msg, end, DNSOpt_LeaseData_Space + DNSOpt_OwnerData_ID_Space);
10345     if (ptr)
10346     {
10347         ptr = GetLargeResourceRecord(m, msg, ptr, end, 0, kDNSRecordTypePacketAdd, &m->rec);
10348         if (ptr && m->rec.r.resrec.RecordType != kDNSRecordTypePacketNegative && m->rec.r.resrec.rrtype == kDNSType_OPT)
10349         {
10350             const rdataOPT *o;
10351             const rdataOPT *const e = (const rdataOPT *)&m->rec.r.resrec.rdata->u.data[m->rec.r.resrec.rdlength];
10352             for (o = &m->rec.r.resrec.rdata->u.opt[0]; o < e; o++)
10353             {
10354                 if      (o->opt == kDNSOpt_Lease) updatelease = o->u.updatelease;
10355                 else if (o->opt == kDNSOpt_Owner && o->u.owner.vers == 0) owner       = o->u.owner;
10356             }
10357         }
10358         m->rec.r.resrec.RecordType = 0;     // Clear RecordType to show we're not still using it
10359     }
10360 
10361     InitializeDNSMessage(&m->omsg.h, msg->h.id, UpdateRespFlags);
10362 
10363     if (!updatelease || !owner.HMAC.l[0])
10364     {
10365         static int msgs = 0;
10366         if (msgs < 100)
10367         {
10368             msgs++;
10369             LogMsg("Refusing sleep proxy registration from %#a:%d:%s%s", srcaddr, mDNSVal16(srcport),
10370                    !updatelease ? " No lease" : "", !owner.HMAC.l[0] ? " No owner" : "");
10371         }
10372         m->omsg.h.flags.b[1] |= kDNSFlag1_RC_FormErr;
10373     }
10374     else if (m->ProxyRecords + msg->h.mDNS_numUpdates > MAX_PROXY_RECORDS)
10375     {
10376         static int msgs = 0;
10377         if (msgs < 100)
10378         {
10379             msgs++;
10380             LogMsg("Refusing sleep proxy registration from %#a:%d: Too many records %d + %d = %d > %d", srcaddr, mDNSVal16(srcport),
10381                    m->ProxyRecords, msg->h.mDNS_numUpdates, m->ProxyRecords + msg->h.mDNS_numUpdates, MAX_PROXY_RECORDS);
10382         }
10383         m->omsg.h.flags.b[1] |= kDNSFlag1_RC_Refused;
10384     }
10385     else
10386     {
10387         LogSPS("Received Update for H-MAC %.6a I-MAC %.6a Password %.6a seq %d", &owner.HMAC, &owner.IMAC, &owner.password, owner.seq);
10388 
10389         if (updatelease > 24 * 60 * 60)
10390             updatelease = 24 * 60 * 60;
10391 
10392         if (updatelease > 0x40000000UL / mDNSPlatformOneSecond)
10393             updatelease = 0x40000000UL / mDNSPlatformOneSecond;
10394 
10395         ptr = LocateAuthorities(msg, end);
10396 
10397         // Clear any stale TCP keepalive records that may exist
10398         ClearKeepaliveProxyRecords(m, &owner, m->DuplicateRecords, InterfaceID);
10399         ClearKeepaliveProxyRecords(m, &owner, m->ResourceRecords, InterfaceID);
10400 
10401         for (i = 0; i < msg->h.mDNS_numUpdates && ptr && ptr < end; i++)
10402         {
10403             ptr = GetLargeResourceRecord(m, msg, ptr, end, InterfaceID, kDNSRecordTypePacketAuth, &m->rec);
10404             if (ptr && m->rec.r.resrec.RecordType != kDNSRecordTypePacketNegative)
10405             {
10406                 mDNSu16 RDLengthMem = GetRDLengthMem(&m->rec.r.resrec);
10407                 AuthRecord *ar = mDNSPlatformMemAllocate(sizeof(AuthRecord) - sizeof(RDataBody) + RDLengthMem);
10408                 if (!ar)
10409                 {
10410                     m->omsg.h.flags.b[1] |= kDNSFlag1_RC_Refused;
10411                     break;
10412                 }
10413                 else
10414                 {
10415                     mDNSu8 RecordType = m->rec.r.resrec.RecordType & kDNSRecordTypePacketUniqueMask ? kDNSRecordTypeUnique : kDNSRecordTypeShared;
10416                     m->rec.r.resrec.rrclass &= ~kDNSClass_UniqueRRSet;
10417                     // All stale keepalive records have been flushed prior to this loop.
10418                     if (!mDNS_KeepaliveRecord(&m->rec.r.resrec))
10419                     {
10420                         ClearIdenticalProxyRecords(m, &owner, m->DuplicateRecords); // Make sure we don't have any old stale duplicates of this record
10421                         ClearIdenticalProxyRecords(m, &owner, m->ResourceRecords);
10422                     }
10423                     mDNS_SetupResourceRecord(ar, mDNSNULL, InterfaceID, m->rec.r.resrec.rrtype, m->rec.r.resrec.rroriginalttl, RecordType, AuthRecordAny, SPSRecordCallback, ar);
10424                     AssignDomainName(&ar->namestorage, m->rec.r.resrec.name);
10425                     ar->resrec.rdlength = GetRDLength(&m->rec.r.resrec, mDNSfalse);
10426                     ar->resrec.rdata->MaxRDLength = RDLengthMem;
10427                     mDNSPlatformMemCopy(ar->resrec.rdata->u.data, m->rec.r.resrec.rdata->u.data, RDLengthMem);
10428                     ar->ForceMCast = mDNStrue;
10429                     ar->WakeUp     = owner;
10430                     if (m->rec.r.resrec.rrtype == kDNSType_PTR)
10431                     {
10432                         mDNSs32 t = ReverseMapDomainType(m->rec.r.resrec.name);
10433                         if      (t == mDNSAddrType_IPv4) GetIPv4FromName(&ar->AddressProxy, m->rec.r.resrec.name);
10434                         else if (t == mDNSAddrType_IPv6) GetIPv6FromName(&ar->AddressProxy, m->rec.r.resrec.name);
10435                         debugf("mDNSCoreReceiveUpdate: PTR %d %d %#a %s", t, ar->AddressProxy.type, &ar->AddressProxy, ARDisplayString(m, ar));
10436                         if (ar->AddressProxy.type) SetSPSProxyListChanged(InterfaceID);
10437                     }
10438                     ar->TimeRcvd   = m->timenow;
10439                     ar->TimeExpire = m->timenow + updatelease * mDNSPlatformOneSecond;
10440                     if (m->NextScheduledSPS - ar->TimeExpire > 0)
10441                         m->NextScheduledSPS = ar->TimeExpire;
10442                     ar->KATimeExpire = 0;
10443                     mDNS_Register_internal(m, ar);
10444 
10445                     m->ProxyRecords++;
10446                     mDNS_UpdateAllowSleep(m);
10447                     LogSPS("SPS Registered %4d %X %s", m->ProxyRecords, RecordType, ARDisplayString(m,ar));
10448                 }
10449             }
10450             m->rec.r.resrec.RecordType = 0;     // Clear RecordType to show we're not still using it
10451         }
10452 
10453         if (m->omsg.h.flags.b[1] & kDNSFlag1_RC_Mask)
10454         {
10455             LogMsg("Refusing sleep proxy registration from %#a:%d: Out of memory", srcaddr, mDNSVal16(srcport));
10456             ClearProxyRecords(m, &owner, m->DuplicateRecords);
10457             ClearProxyRecords(m, &owner, m->ResourceRecords);
10458         }
10459         else
10460         {
10461             mDNS_SetupResourceRecord(&opt, mDNSNULL, mDNSInterface_Any, kDNSType_OPT, kStandardTTL, kDNSRecordTypeKnownUnique, AuthRecordAny, mDNSNULL, mDNSNULL);
10462             opt.resrec.rrclass    = NormalMaxDNSMessageData;
10463             opt.resrec.rdlength   = sizeof(rdataOPT);   // One option in this OPT record
10464             opt.resrec.rdestimate = sizeof(rdataOPT);
10465             opt.resrec.rdata->u.opt[0].opt           = kDNSOpt_Lease;
10466             opt.resrec.rdata->u.opt[0].u.updatelease = updatelease;
10467             p = PutResourceRecordTTLWithLimit(&m->omsg, p, &m->omsg.h.numAdditionals, &opt.resrec, opt.resrec.rroriginalttl, m->omsg.data + AbsoluteMaxDNSMessageData);
10468         }
10469     }
10470 
10471     if (p) mDNSSendDNSMessage(m, &m->omsg, p, InterfaceID, m->SPSSocket, srcaddr, srcport, mDNSNULL, mDNSNULL, mDNSfalse);
10472     mDNS_SendKeepalives(m);
10473 }
10474 
10475 mDNSlocal mDNSu32 mDNSGenerateOwnerOptForInterface(mDNS *const m, const mDNSInterfaceID InterfaceID, DNSMessage *msg)
10476 {
10477     mDNSu8 *ptr    = msg->data;
10478     mDNSu8 *end    = mDNSNULL;
10479     mDNSu32 length = 0;
10480     AuthRecord opt;
10481     NetworkInterfaceInfo *intf;
10482 
10483     mDNS_SetupResourceRecord(&opt, mDNSNULL, mDNSInterface_Any, kDNSType_OPT, kStandardTTL, kDNSRecordTypeKnownUnique, AuthRecordAny, mDNSNULL, mDNSNULL);
10484     opt.resrec.rrclass    = NormalMaxDNSMessageData;
10485     opt.resrec.rdlength   = sizeof(rdataOPT);
10486     opt.resrec.rdestimate = sizeof(rdataOPT);
10487 
10488     intf = FirstInterfaceForID(m, InterfaceID);
10489     SetupOwnerOpt(m, intf, &opt.resrec.rdata->u.opt[0]);
10490 
10491     LogSPS("Generated OPT record : %s", ARDisplayString(m, &opt));
10492     end = PutResourceRecord(msg, ptr, &msg->h.numAdditionals, &opt.resrec);
10493     if (end != mDNSNULL)
10494     {
10495         // Put all the integer values in IETF byte-order (MSB first, LSB second)
10496         SwapDNSHeaderBytes(msg);
10497         length = (end - msg->data);
10498     }
10499     else
10500         LogSPS("mDNSGenerateOwnerOptForInterface: Failed to generate owner OPT record");
10501 
10502     return length;
10503 }
10504 
10505 // Note that this routine is called both for Sleep Proxy Registrations, and for Standard Dynamic
10506 // DNS registrations, but (currently) only has to handle the Sleep Proxy Registration reply case,
10507 // and should ignore Standard Dynamic DNS registration replies, because those are handled elsewhere.
10508 // Really, both should be unified and handled in one place.
10509 mDNSlocal void mDNSCoreReceiveUpdateR(mDNS *const m, const DNSMessage *const msg, const mDNSu8 *end, const mDNSAddr *srcaddr, const mDNSInterfaceID InterfaceID)
10510 {
10511     if (InterfaceID)
10512     {
10513         mDNSu32 pktlease = 0, spsupdates = 0;
10514         const mDNSBool gotlease = GetPktLease(m, msg, end, &pktlease);
10515         const mDNSu32 updatelease = gotlease ? pktlease : 60 * 60; // If SPS fails to indicate lease time, assume one hour
10516         if (gotlease) LogSPS("DNS Update response contains lease option granting %4d seconds, updateid %d, InterfaceID %p", updatelease, mDNSVal16(msg->h.id), InterfaceID);
10517 
10518         if (m->CurrentRecord)
10519             LogMsg("mDNSCoreReceiveUpdateR ERROR m->CurrentRecord already set %s", ARDisplayString(m, m->CurrentRecord));
10520         m->CurrentRecord = m->ResourceRecords;
10521         while (m->CurrentRecord)
10522         {
10523             AuthRecord *const rr = m->CurrentRecord;
10524             if (rr->resrec.InterfaceID == InterfaceID || (!rr->resrec.InterfaceID && (rr->ForceMCast || IsLocalDomain(rr->resrec.name))))
10525                 if (mDNSSameOpaque16(rr->updateid, msg->h.id))
10526                 {
10527                     // We successfully completed this record's registration on this "InterfaceID". Clear that bit.
10528                     // Clear the updateid when we are done sending on all interfaces.
10529                     mDNSu32 scopeid = mDNSPlatformInterfaceIndexfromInterfaceID(m, InterfaceID, mDNStrue);
10530                     if (scopeid < (sizeof(rr->updateIntID) * mDNSNBBY))
10531                         bit_clr_opaque64(rr->updateIntID, scopeid);
10532                     if (mDNSOpaque64IsZero(&rr->updateIntID))
10533                         rr->updateid = zeroID;
10534                     rr->expire   = NonZeroTime(m->timenow + updatelease * mDNSPlatformOneSecond);
10535                     spsupdates++;
10536                     LogSPS("Sleep Proxy %s record %2d %5d 0x%x 0x%x (%d) %s", rr->WakeUp.HMAC.l[0] ? "transferred" : "registered", spsupdates, updatelease, rr->updateIntID.l[1], rr->updateIntID.l[0], mDNSVal16(rr->updateid), ARDisplayString(m,rr));
10537                     if (rr->WakeUp.HMAC.l[0])
10538                     {
10539                         rr->WakeUp.HMAC = zeroEthAddr;  // Clear HMAC so that mDNS_Deregister_internal doesn't waste packets trying to wake this host
10540                         rr->RequireGoodbye = mDNSfalse; // and we don't want to send goodbye for it
10541                         mDNS_Deregister_internal(m, rr, mDNS_Dereg_normal);
10542                     }
10543                 }
10544             // Mustn't advance m->CurrentRecord until *after* mDNS_Deregister_internal, because
10545             // new records could have been added to the end of the list as a result of that call.
10546             if (m->CurrentRecord == rr) // If m->CurrentRecord was not advanced for us, do it now
10547                 m->CurrentRecord = rr->next;
10548         }
10549         if (spsupdates) // Only do this dynamic store stuff if this was, in fact, a Sleep Proxy Update response
10550         {
10551             char *ifname;
10552             mDNSAddr spsaddr;
10553             DNSMessage optMsg;
10554             int length;
10555             // Update the dynamic store with the IP Address and MAC address of the sleep proxy
10556             ifname = InterfaceNameForID(m, InterfaceID);
10557             mDNSPlatformMemCopy(&spsaddr, srcaddr, sizeof (mDNSAddr));
10558             mDNSPlatformStoreSPSMACAddr(&spsaddr, ifname);
10559 
10560             // Store the Owner OPT record for this interface.
10561             // Configd may use the OPT record if it detects a conflict with the BSP when the system wakes up
10562             InitializeDNSMessage(&optMsg.h, zeroID, ResponseFlags);
10563             length = mDNSGenerateOwnerOptForInterface(m, InterfaceID, &optMsg);
10564             if (length != 0)
10565             {
10566                 length += sizeof(DNSMessageHeader);
10567                 mDNSPlatformStoreOwnerOptRecord(ifname, &optMsg, length);
10568             }
10569         }
10570     }
10571     // If we were waiting to go to sleep, then this SPS registration or wide-area record deletion
10572     // may have been the thing we were waiting for, so schedule another check to see if we can sleep now.
10573     if (m->SleepLimit) m->NextScheduledSPRetry = m->timenow;
10574 }
10575 
10576 mDNSexport void MakeNegativeCacheRecord(mDNS *const m, CacheRecord *const cr,
10577                                         const domainname *const name, const mDNSu32 namehash, const mDNSu16 rrtype, const mDNSu16 rrclass, mDNSu32 ttl_seconds, mDNSInterfaceID InterfaceID, DNSServer *dnsserver)
10578 {
10579     if (cr == &m->rec.r && m->rec.r.resrec.RecordType)
10580         LogFatalError("MakeNegativeCacheRecord: m->rec appears to be already in use for %s", CRDisplayString(m, &m->rec.r));
10581 
10582     // Create empty resource record
10583     cr->resrec.RecordType    = kDNSRecordTypePacketNegative;
10584     cr->resrec.InterfaceID   = InterfaceID;
10585     cr->resrec.rDNSServer    = dnsserver;
10586     cr->resrec.name          = name;    // Will be updated to point to cg->name when we call CreateNewCacheEntry
10587     cr->resrec.rrtype        = rrtype;
10588     cr->resrec.rrclass       = rrclass;
10589     cr->resrec.rroriginalttl = ttl_seconds;
10590     cr->resrec.rdlength      = 0;
10591     cr->resrec.rdestimate    = 0;
10592     cr->resrec.namehash      = namehash;
10593     cr->resrec.rdatahash     = 0;
10594     cr->resrec.rdata = (RData*)&cr->smallrdatastorage;
10595     cr->resrec.rdata->MaxRDLength = 0;
10596 
10597     cr->NextInKAList       = mDNSNULL;
10598     cr->TimeRcvd           = m->timenow;
10599     cr->DelayDelivery      = 0;
10600     cr->NextRequiredQuery  = m->timenow;
10601     cr->CRActiveQuestion   = mDNSNULL;
10602     cr->UnansweredQueries  = 0;
10603     cr->LastUnansweredTime = 0;
10604     cr->NextInCFList       = mDNSNULL;
10605     cr->nsec               = mDNSNULL;
10606     cr->soa                = mDNSNULL;
10607     cr->CRDNSSECQuestion   = 0;
10608     // Initialize to the basic one and the caller can set it to more
10609     // specific based on the response if any
10610     cr->responseFlags      = ResponseFlags;
10611 }
10612 
10613 mDNSexport void mDNSCoreReceive(mDNS *const m, DNSMessage *const msg, const mDNSu8 *const end,
10614                                 const mDNSAddr *const srcaddr, const mDNSIPPort srcport, const mDNSAddr *dstaddr, const mDNSIPPort dstport,
10615                                 const mDNSInterfaceID InterfaceID)
10616 {
10617     mDNSInterfaceID ifid = InterfaceID;
10618     const mDNSu8 *const pkt = (mDNSu8 *)msg;
10619     const mDNSu8 StdQ = kDNSFlag0_QR_Query    | kDNSFlag0_OP_StdQuery;
10620     const mDNSu8 StdR = kDNSFlag0_QR_Response | kDNSFlag0_OP_StdQuery;
10621     const mDNSu8 UpdQ = kDNSFlag0_QR_Query    | kDNSFlag0_OP_Update;
10622     const mDNSu8 UpdR = kDNSFlag0_QR_Response | kDNSFlag0_OP_Update;
10623     mDNSu8 QR_OP;
10624     mDNSu8 *ptr = mDNSNULL;
10625     mDNSBool TLS = (dstaddr == (mDNSAddr *)1);  // For debug logs: dstaddr = 0 means TCP; dstaddr = 1 means TLS
10626     if (TLS) dstaddr = mDNSNULL;
10627 
10628 #ifndef UNICAST_DISABLED
10629     if (mDNSSameAddress(srcaddr, &m->Router))
10630     {
10631 #ifdef _LEGACY_NAT_TRAVERSAL_
10632         if (mDNSSameIPPort(srcport, SSDPPort) || (m->SSDPSocket && mDNSSameIPPort(dstport, m->SSDPSocket->port)))
10633         {
10634             mDNS_Lock(m);
10635             LNT_ConfigureRouterInfo(m, InterfaceID, (mDNSu8 *)msg, (mDNSu16)(end - pkt));
10636             mDNS_Unlock(m);
10637             return;
10638         }
10639 #endif
10640         if (mDNSSameIPPort(srcport, NATPMPPort))
10641         {
10642             mDNS_Lock(m);
10643             uDNS_ReceiveNATPacket(m, InterfaceID, (mDNSu8 *)msg, (mDNSu16)(end - pkt));
10644             mDNS_Unlock(m);
10645             return;
10646         }
10647     }
10648 #ifdef _LEGACY_NAT_TRAVERSAL_
10649     else if (m->SSDPSocket && mDNSSameIPPort(dstport, m->SSDPSocket->port)) { debugf("Ignoring SSDP response from %#a:%d", srcaddr, mDNSVal16(srcport)); return; }
10650 #endif
10651 
10652 #endif
10653     if ((unsigned)(end - pkt) < sizeof(DNSMessageHeader))
10654     {
10655         LogMsg("DNS Message from %#a:%d to %#a:%d length %d too short", srcaddr, mDNSVal16(srcport), dstaddr, mDNSVal16(dstport), (int)(end - pkt));
10656         return;
10657     }
10658     QR_OP = (mDNSu8)(msg->h.flags.b[0] & kDNSFlag0_QROP_Mask);
10659     // Read the integer parts which are in IETF byte-order (MSB first, LSB second)
10660     ptr = (mDNSu8 *)&msg->h.numQuestions;
10661     msg->h.numQuestions   = (mDNSu16)((mDNSu16)ptr[0] << 8 | ptr[1]);
10662     msg->h.numAnswers     = (mDNSu16)((mDNSu16)ptr[2] << 8 | ptr[3]);
10663     msg->h.numAuthorities = (mDNSu16)((mDNSu16)ptr[4] << 8 | ptr[5]);
10664     msg->h.numAdditionals = (mDNSu16)((mDNSu16)ptr[6] << 8 | ptr[7]);
10665 
10666     if (!m) { LogMsg("mDNSCoreReceive ERROR m is NULL"); return; }
10667 
10668     // We use zero addresses and all-ones addresses at various places in the code to indicate special values like "no address"
10669     // If we accept and try to process a packet with zero or all-ones source address, that could really mess things up
10670     if (srcaddr && !mDNSAddressIsValid(srcaddr)) { debugf("mDNSCoreReceive ignoring packet from %#a", srcaddr); return; }
10671 
10672     mDNS_Lock(m);
10673     m->PktNum++;
10674     if (mDNSOpaque16IsZero(msg->h.id))
10675     {
10676         m->MPktNum++;
10677 #if APPLE_OSX_mDNSResponder
10678         // Track the number of multicast packets received from a source outside our subnet.
10679         // Check the destination address to avoid accounting for spurious packets that
10680         // comes in with message id zero.
10681         if (!mDNS_AddressIsLocalSubnet(m, InterfaceID, srcaddr) && dstaddr &&
10682             mDNSAddressIsAllDNSLinkGroup(dstaddr))
10683         {
10684             m->RemoteSubnet++;
10685         }
10686 #endif // #if APPLE_OSX_mDNSResponder
10687     }
10688 
10689 #ifndef UNICAST_DISABLED
10690     if (!dstaddr || (!mDNSAddressIsAllDNSLinkGroup(dstaddr) && (QR_OP == StdR || QR_OP == UpdR)))
10691         if (!mDNSOpaque16IsZero(msg->h.id)) // uDNS_ReceiveMsg only needs to get real uDNS responses, not "QU" mDNS responses
10692         {
10693             ifid = mDNSInterface_Any;
10694             if (mDNS_PacketLoggingEnabled)
10695                 DumpPacket(mStatus_NoError, mDNSfalse, TLS ? "TLS" : !dstaddr ? "TCP" : "UDP", srcaddr, srcport, dstaddr, dstport, msg, end);
10696             uDNS_ReceiveMsg(m, msg, end, srcaddr, srcport);
10697             // Note: mDNSCore also needs to get access to received unicast responses
10698         }
10699 #endif
10700     if      (QR_OP == StdQ) mDNSCoreReceiveQuery   (m, msg, end, srcaddr, srcport, dstaddr, dstport, ifid);
10701     else if (QR_OP == StdR) mDNSCoreReceiveResponse(m, msg, end, srcaddr, srcport, dstaddr, dstport, ifid);
10702     else if (QR_OP == UpdQ) mDNSCoreReceiveUpdate  (m, msg, end, srcaddr, srcport, dstaddr, dstport, InterfaceID);
10703     else if (QR_OP == UpdR) mDNSCoreReceiveUpdateR (m, msg, end, srcaddr,                            InterfaceID);
10704     else
10705     {
10706         if (mDNS_LoggingEnabled)
10707         {
10708             static int msgCount = 0;
10709             if (msgCount < 1000) {
10710                 int i = 0;
10711                 msgCount++;
10712                 LogInfo("Unknown DNS packet type %02X%02X from %#-15a:%-5d to %#-15a:%-5d length %d on %p (ignored)",
10713                         msg->h.flags.b[0], msg->h.flags.b[1], srcaddr, mDNSVal16(srcport), dstaddr, mDNSVal16(dstport), (int)(end - pkt), InterfaceID);
10714                 while (i < (int)(end - pkt))
10715                 {
10716                     char buffer[128];
10717                     char *p = buffer + mDNS_snprintf(buffer, sizeof(buffer), "%04X", i);
10718                     do if (i < (int)(end - pkt)) p += mDNS_snprintf(p, sizeof(buffer), " %02X", pkt[i]);while (++i & 15);
10719                     LogInfo("%s", buffer);
10720                 }
10721             }
10722         }
10723     }
10724     // Packet reception often causes a change to the task list:
10725     // 1. Inbound queries can cause us to need to send responses
10726     // 2. Conflicing response packets received from other hosts can cause us to need to send defensive responses
10727     // 3. Other hosts announcing deletion of shared records can cause us to need to re-assert those records
10728     // 4. Response packets that answer questions may cause our client to issue new questions
10729     mDNS_Unlock(m);
10730 }
10731 
10732 // ***************************************************************************
10733 #if COMPILER_LIKES_PRAGMA_MARK
10734 #pragma mark -
10735 #pragma mark - Searcher Functions
10736 #endif
10737 
10738 // Targets are considered the same if both queries are untargeted, or
10739 // if both are targeted to the same address+port
10740 // (If Target address is zero, TargetPort is undefined)
10741 #define SameQTarget(A,B) (((A)->Target.type == mDNSAddrType_None && (B)->Target.type == mDNSAddrType_None) || \
10742                           (mDNSSameAddress(& (A)->Target, & (B)->Target) && mDNSSameIPPort((A)->TargetPort, (B)->TargetPort)))
10743 
10744 // SameQuestionKind is true if *both* questions are either multicast or unicast
10745 // TargetQID is used for this determination.
10746 #define SameQuestionKind(A,B) ((mDNSOpaque16IsZero(A) && mDNSOpaque16IsZero(B)) || \
10747                                ((!mDNSOpaque16IsZero(A)) && (!mDNSOpaque16IsZero(B))))
10748 
10749 // Note: We explicitly disallow making a public query be a duplicate of a private one. This is to avoid the
10750 // circular deadlock where a client does a query for something like "dns-sd -Q _dns-query-tls._tcp.company.com SRV"
10751 // and we have a key for company.com, so we try to locate the private query server for company.com, which necessarily entails
10752 // doing a standard DNS query for the _dns-query-tls._tcp SRV record for company.com. If we make the latter (public) query
10753 // a duplicate of the former (private) query, then it will block forever waiting for an answer that will never come.
10754 //
10755 // We keep SuppressUnusable questions separate so that we can return a quick response to them and not get blocked behind
10756 // the queries that are not marked SuppressUnusable. But if the query is not suppressed, they are treated the same as
10757 // non-SuppressUnusable questions. This should be fine as the goal of SuppressUnusable is to return quickly only if it
10758 // is suppressed. If it is not suppressed, we do try all the DNS servers for valid answers like any other question.
10759 // The main reason for this design is that cache entries point to a *single* question and that question is responsible
10760 // for keeping the cache fresh as long as it is active. Having multiple active question for a single cache entry
10761 // breaks this design principle.
10762 //
10763 
10764 // If IsLLQ(Q) is true, it means the question is both:
10765 // (a) long-lived and
10766 // (b) being performed by a unicast DNS long-lived query (either full LLQ, or polling)
10767 // for multicast questions, we don't want to treat LongLived as anything special
10768 #define IsLLQ(Q) ((Q)->LongLived && !mDNSOpaque16IsZero((Q)->TargetQID))
10769 #define IsAWDLIncluded(Q) (((Q)->flags & kDNSServiceFlagsIncludeAWDL) != 0)
10770 
10771 mDNSlocal DNSQuestion *FindDuplicateQuestion(const mDNS *const m, const DNSQuestion *const question)
10772 {
10773     DNSQuestion *q;
10774     // Note: A question can only be marked as a duplicate of one that occurs *earlier* in the list.
10775     // This prevents circular references, where two questions are each marked as a duplicate of the other.
10776     // Accordingly, we break out of the loop when we get to 'question', because there's no point searching
10777     // further in the list.
10778     for (q = m->Questions; q && q != question; q=q->next)       // Scan our list for another question
10779         if (q->InterfaceID == question->InterfaceID &&          // with the same InterfaceID,
10780             SameQTarget(q, question)                &&          // and same unicast/multicast target settings
10781             q->qtype      == question->qtype        &&          // type,
10782             q->qclass     == question->qclass       &&          // class,
10783             IsLLQ(q)      == IsLLQ(question)        &&          // and long-lived status matches
10784             (!q->AuthInfo || question->AuthInfo)    &&          // to avoid deadlock, don't make public query dup of a private one
10785             (q->AnonInfo  == question->AnonInfo)    &&          // Anonymous query not a dup of normal query
10786             (q->SuppressQuery == question->SuppressQuery) &&    // Questions that are suppressed/not suppressed
10787             (q->ValidationRequired == question->ValidationRequired) &&  // Questions that require DNSSEC validation
10788             (q->ValidatingResponse == question->ValidatingResponse) &&  // Questions that are validating responses using DNSSEC
10789             (q->DisallowPID == question->DisallowPID)     &&            // Disallowing a PID should not affect a PID that is allowed
10790             (q->BrowseThreshold == question->BrowseThreshold) &&  // browse thresholds must match
10791             q->qnamehash  == question->qnamehash    &&
10792             (IsAWDLIncluded(q) == IsAWDLIncluded(question)) &&     // Inclusion of AWDL interface must match
10793             SameQuestionKind(q->TargetQID, question->TargetQID) && // mDNS or uDNS must match
10794             SameDomainName(&q->qname, &question->qname))           // and name
10795             return(q);
10796     return(mDNSNULL);
10797 }
10798 
10799 // This is called after a question is deleted, in case other identical questions were being suppressed as duplicates
10800 mDNSlocal void UpdateQuestionDuplicates(mDNS *const m, DNSQuestion *const question)
10801 {
10802     DNSQuestion *q;
10803     DNSQuestion *first = mDNSNULL;
10804 
10805     // This is referring to some other question as duplicate. No other question can refer to this
10806     // question as a duplicate.
10807     if (question->DuplicateOf)
10808     {
10809         LogInfo("UpdateQuestionDuplicates: question %p %##s (%s) duplicate of %p %##s (%s)",
10810                 question, question->qname.c, DNSTypeName(question->qtype),
10811                 question->DuplicateOf, question->DuplicateOf->qname.c, DNSTypeName(question->DuplicateOf->qtype));
10812         return;
10813     }
10814 
10815     for (q = m->Questions; q; q=q->next)        // Scan our list of questions
10816         if (q->DuplicateOf == question)         // To see if any questions were referencing this as their duplicate
10817         {
10818             q->DuplicateOf = first;
10819             if (!first)
10820             {
10821                 first = q;
10822                 // If q used to be a duplicate, but now is not,
10823                 // then inherit the state from the question that's going away
10824                 q->LastQTime         = question->LastQTime;
10825                 q->ThisQInterval     = question->ThisQInterval;
10826                 q->ExpectUnicastResp = question->ExpectUnicastResp;
10827                 q->LastAnswerPktNum  = question->LastAnswerPktNum;
10828                 q->RecentAnswerPkts  = question->RecentAnswerPkts;
10829                 q->RequestUnicast    = question->RequestUnicast;
10830                 q->LastQTxTime       = question->LastQTxTime;
10831                 q->CNAMEReferrals    = question->CNAMEReferrals;
10832                 q->nta               = question->nta;
10833                 q->servAddr          = question->servAddr;
10834                 q->servPort          = question->servPort;
10835                 q->qDNSServer        = question->qDNSServer;
10836                 q->validDNSServers   = question->validDNSServers;
10837                 q->unansweredQueries = question->unansweredQueries;
10838                 q->noServerResponse  = question->noServerResponse;
10839                 q->triedAllServersOnce = question->triedAllServersOnce;
10840 
10841                 q->TargetQID         = question->TargetQID;
10842                 q->LocalSocket       = question->LocalSocket;
10843                 // No need to close old q->LocalSocket first -- duplicate questions can't have their own sockets
10844 
10845                 q->state             = question->state;
10846                 //  q->tcp               = question->tcp;
10847                 q->ReqLease          = question->ReqLease;
10848                 q->expire            = question->expire;
10849                 q->ntries            = question->ntries;
10850                 q->id                = question->id;
10851 
10852                 question->LocalSocket = mDNSNULL;
10853                 question->nta        = mDNSNULL;    // If we've got a GetZoneData in progress, transfer it to the newly active question
10854                 //  question->tcp        = mDNSNULL;
10855 
10856                 if (q->LocalSocket)
10857                     debugf("UpdateQuestionDuplicates transferred LocalSocket pointer for %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
10858 
10859                 if (q->nta)
10860                 {
10861                     LogInfo("UpdateQuestionDuplicates transferred nta pointer for %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
10862                     q->nta->ZoneDataContext = q;
10863                 }
10864 
10865                 // Need to work out how to safely transfer this state too -- appropriate context pointers need to be updated or the code will crash
10866                 if (question->tcp) LogInfo("UpdateQuestionDuplicates did not transfer tcp pointer");
10867 
10868                 if (question->state == LLQ_Established)
10869                 {
10870                     LogInfo("UpdateQuestionDuplicates transferred LLQ state for %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
10871                     question->state = 0;    // Must zero question->state, or mDNS_StopQuery_internal will clean up and cancel our LLQ from the server
10872                 }
10873 
10874                 SetNextQueryTime(m,q);
10875             }
10876         }
10877 }
10878 
10879 mDNSexport McastResolver *mDNS_AddMcastResolver(mDNS *const m, const domainname *d, const mDNSInterfaceID interface, mDNSu32 timeout)
10880 {
10881     McastResolver **p = &m->McastResolvers;
10882     McastResolver *tmp = mDNSNULL;
10883 
10884     if (!d) d = (const domainname *)"";
10885 
10886     LogInfo("mDNS_AddMcastResolver: Adding %##s, InterfaceID %p, timeout %u", d->c, interface, timeout);
10887 
10888     mDNS_CheckLock(m);
10889 
10890     while (*p)  // Check if we already have this {interface, domain} tuple registered
10891     {
10892         if ((*p)->interface == interface && SameDomainName(&(*p)->domain, d))
10893         {
10894             if (!((*p)->flags & McastResolver_FlagDelete)) LogMsg("Note: Mcast Resolver domain %##s (%p) registered more than once", d->c, interface);
10895             (*p)->flags &= ~McastResolver_FlagDelete;
10896             tmp = *p;
10897             *p = tmp->next;
10898             tmp->next = mDNSNULL;
10899         }
10900         else
10901             p=&(*p)->next;
10902     }
10903 
10904     if (tmp) *p = tmp; // move to end of list, to ensure ordering from platform layer
10905     else
10906     {
10907         // allocate, add to list
10908         *p = mDNSPlatformMemAllocate(sizeof(**p));
10909         if (!*p) LogMsg("mDNS_AddMcastResolver: ERROR!! - malloc");
10910         else
10911         {
10912             (*p)->interface = interface;
10913             (*p)->flags     = McastResolver_FlagNew;
10914             (*p)->timeout   = timeout;
10915             AssignDomainName(&(*p)->domain, d);
10916             (*p)->next = mDNSNULL;
10917         }
10918     }
10919     return(*p);
10920 }
10921 
10922 mDNSinline mDNSs32 PenaltyTimeForServer(mDNS *m, DNSServer *server)
10923 {
10924     mDNSs32 ptime = 0;
10925     if (server->penaltyTime != 0)
10926     {
10927         ptime = server->penaltyTime - m->timenow;
10928         if (ptime < 0)
10929         {
10930             // This should always be a positive value between 0 and DNSSERVER_PENALTY_TIME
10931             // If it does not get reset in ResetDNSServerPenalties for some reason, we do it
10932             // here
10933             LogMsg("PenaltyTimeForServer: PenaltyTime negative %d, (server penaltyTime %d, timenow %d) resetting the penalty",
10934                    ptime, server->penaltyTime, m->timenow);
10935             server->penaltyTime = 0;
10936             ptime = 0;
10937         }
10938     }
10939     return ptime;
10940 }
10941 
10942 //Checks to see whether the newname is a better match for the name, given the best one we have
10943 //seen so far (given in bestcount).
10944 //Returns -1 if the newname is not a better match
10945 //Returns 0 if the newname is the same as the old match
10946 //Returns 1 if the newname is a better match
10947 mDNSlocal int BetterMatchForName(const domainname *name, int namecount, const domainname *newname, int newcount,
10948                                  int bestcount)
10949 {
10950     // If the name contains fewer labels than the new server's domain or the new name
10951     // contains fewer labels than the current best, then it can't possibly be a better match
10952     if (namecount < newcount || newcount < bestcount) return -1;
10953 
10954     // If there is no match, return -1 and the caller will skip this newname for
10955     // selection
10956     //
10957     // If we find a match and the number of labels is the same as bestcount, then
10958     // we return 0 so that the caller can do additional logic to pick one of
10959     // the best based on some other factors e.g., penaltyTime
10960     //
10961     // If we find a match and the number of labels is more than bestcount, then we
10962     // return 1 so that the caller can pick this over the old one.
10963     //
10964     // Note: newcount can either be equal or greater than bestcount beause of the
10965     // check above.
10966 
10967     if (SameDomainName(SkipLeadingLabels(name, namecount - newcount), newname))
10968         return bestcount == newcount ? 0 : 1;
10969     else
10970         return -1;
10971 }
10972 
10973 // Normally, we have McastResolvers for .local, in-addr.arpa and ip6.arpa. But there
10974 // can be queries that can forced to multicast (ForceMCast) even though they don't end in these
10975 // names. In that case, we give a default timeout of 5 seconds
10976 #define DEFAULT_MCAST_TIMEOUT   5
10977 mDNSlocal mDNSu32 GetTimeoutForMcastQuestion(mDNS *m, DNSQuestion *question)
10978 {
10979     McastResolver *curmatch = mDNSNULL;
10980     int bestmatchlen = -1, namecount = CountLabels(&question->qname);
10981     McastResolver *curr;
10982     int bettermatch, currcount;
10983     for (curr = m->McastResolvers; curr; curr = curr->next)
10984     {
10985         currcount = CountLabels(&curr->domain);
10986         bettermatch = BetterMatchForName(&question->qname, namecount, &curr->domain, currcount, bestmatchlen);
10987         // Take the first best match. If there are multiple equally good matches (bettermatch = 0), we take
10988         // the timeout value from the first one
10989         if (bettermatch == 1)
10990         {
10991             curmatch = curr;
10992             bestmatchlen = currcount;
10993         }
10994     }
10995     LogInfo("GetTimeoutForMcastQuestion: question %##s curmatch %p, Timeout %d", question->qname.c, curmatch,
10996             curmatch ? curmatch->timeout : DEFAULT_MCAST_TIMEOUT);
10997     return ( curmatch ? curmatch->timeout : DEFAULT_MCAST_TIMEOUT);
10998 }
10999 
11000 // Returns true if it is a Domain Enumeration Query
11001 mDNSexport mDNSBool DomainEnumQuery(const domainname *qname)
11002 {
11003     const mDNSu8 *mDNS_DEQLabels[] = { (const mDNSu8 *)"\001b", (const mDNSu8 *)"\002db", (const mDNSu8 *)"\002lb",
11004                                        (const mDNSu8 *)"\001r", (const mDNSu8 *)"\002dr", (const mDNSu8 *)mDNSNULL, };
11005     const domainname *d = qname;
11006     const mDNSu8 *label;
11007     int i = 0;
11008 
11009     // We need at least 3 labels (DEQ prefix) + one more label to make a meaningful DE query
11010     if (CountLabels(qname) < 4) { debugf("DomainEnumQuery: question %##s, not enough labels", qname->c); return mDNSfalse; }
11011 
11012     label = (const mDNSu8 *)d;
11013     while (mDNS_DEQLabels[i] != (const mDNSu8 *)mDNSNULL)
11014     {
11015         if (SameDomainLabel(mDNS_DEQLabels[i], label)) {debugf("DomainEnumQuery: DEQ %##s, label1 match", qname->c); break;}
11016         i++;
11017     }
11018     if (mDNS_DEQLabels[i] == (const mDNSu8 *)mDNSNULL)
11019     {
11020         debugf("DomainEnumQuery: Not a DEQ %##s, label1 mismatch", qname->c);
11021         return mDNSfalse;
11022     }
11023     debugf("DomainEnumQuery: DEQ %##s, label1 match", qname->c);
11024 
11025     // CountLabels already verified the number of labels
11026     d = (const domainname *)(d->c + 1 + d->c[0]);   // Second Label
11027     label = (const mDNSu8 *)d;
11028     if (!SameDomainLabel(label, (const mDNSu8 *)"\007_dns-sd"))
11029     {
11030         debugf("DomainEnumQuery: Not a DEQ %##s, label2 mismatch", qname->c);
11031         return(mDNSfalse);
11032     }
11033     debugf("DomainEnumQuery: DEQ %##s, label2 match", qname->c);
11034 
11035     d = (const domainname *)(d->c + 1 + d->c[0]);   // Third Label
11036     label = (const mDNSu8 *)d;
11037     if (!SameDomainLabel(label, (const mDNSu8 *)"\004_udp"))
11038     {
11039         debugf("DomainEnumQuery: Not a DEQ %##s, label3 mismatch", qname->c);
11040         return(mDNSfalse);
11041     }
11042     debugf("DomainEnumQuery: DEQ %##s, label3 match", qname->c);
11043 
11044     debugf("DomainEnumQuery: Question %##s is a Domain Enumeration query", qname->c);
11045 
11046     return mDNStrue;
11047 }
11048 
11049 // Note: InterfaceID is the InterfaceID of the question
11050 mDNSlocal mDNSBool DNSServerMatch(DNSServer *d, mDNSInterfaceID InterfaceID, mDNSs32 ServiceID)
11051 {
11052     // 1) Unscoped questions (NULL InterfaceID) should  consider *only* unscoped DNSServers ( DNSServer
11053     // with "scoped" set to kScopeNone)
11054     //
11055     // 2) Scoped questions (non-NULL InterfaceID) should consider *only* scoped DNSServers (DNSServer
11056     // with "scoped" set to kScopeInterfaceId) and their InterfaceIDs should match.
11057     //
11058     // 3) Scoped questions (non-zero ServiceID) should consider *only* scoped DNSServers (DNSServer
11059     // with "scoped" set to kScopeServiceID) and their ServiceIDs should match.
11060     //
11061     // The first condition in the "if" statement checks to see if both the question and the DNSServer are
11062     // unscoped. The question is unscoped only if InterfaceID is zero and ServiceID is -1.
11063     //
11064     // If the first condition fails, following are the possible cases (the notes below are using
11065     // InterfaceID for discussion and the same holds good for ServiceID):
11066     //
11067     // - DNSServer is not scoped, InterfaceID is not NULL - we should skip the current DNSServer entry
11068     //   as scoped questions should not pick non-scoped DNSServer entry (Refer to (2) above).
11069     //
11070     // - DNSServer is scoped, InterfaceID is NULL - we should skip the current DNSServer entry as
11071     //   unscoped question should not match scoped DNSServer (Refer to (1) above). The InterfaceID check
11072     //   would fail in this case.
11073     //
11074     // - DNSServer is scoped and InterfaceID is not NULL - the InterfaceID of the question and the DNSServer
11075     //   should match (Refer to (2) above).
11076     //
11077     // Note: mDNSInterface_Unicast is used only by .local unicast questions and are treated as unscoped.
11078     // If a question is scoped both to InterfaceID and ServiceID, the question will be scoped to InterfaceID.
11079 
11080     if (((d->scoped == kScopeNone) && ((!InterfaceID && ServiceID == -1) || InterfaceID == mDNSInterface_Unicast)) ||
11081         ((d->scoped == kScopeInterfaceID) && d->interface == InterfaceID) ||
11082         ((d->scoped == kScopeServiceID) && d->serviceID == ServiceID))
11083     {
11084         return mDNStrue;
11085     }
11086     return mDNSfalse;
11087 }
11088 
11089 // Sets all the Valid DNS servers for a question
11090 mDNSexport mDNSu32 SetValidDNSServers(mDNS *m, DNSQuestion *question)
11091 {
11092     int bestmatchlen = -1, namecount = CountLabels(&question->qname);
11093     DNSServer *curr;
11094     int bettermatch, currcount;
11095     int index = 0;
11096     mDNSu32 timeout = 0;
11097     mDNSBool DEQuery;
11098 
11099     question->validDNSServers = zeroOpaque128;
11100     DEQuery = DomainEnumQuery(&question->qname);
11101     for (curr = m->DNSServers; curr; curr = curr->next)
11102     {
11103         debugf("SetValidDNSServers: Parsing DNS server Address %#a (Domain %##s), Scope: %d", &curr->addr, curr->domain.c, curr->scoped);
11104         // skip servers that will soon be deleted
11105         if (curr->flags & DNSServer_FlagDelete)
11106         {
11107             debugf("SetValidDNSServers: Delete set for index %d, DNS server %#a (Domain %##s), scoped %d", index, &curr->addr, curr->domain.c, curr->scoped);
11108             continue;
11109         }
11110 
11111         // This happens normally when you unplug the interface where we reset the interfaceID to mDNSInterface_Any for all
11112         // the DNS servers whose scope match the interfaceID. Few seconds later, we also receive the updated DNS configuration.
11113         // But any questions that has mDNSInterface_Any scope that are started/restarted before we receive the update
11114         // (e.g., CheckSuppressUnusableQuestions is called when interfaces are deregistered with the core) should not
11115         // match the scoped entries by mistake.
11116         //
11117         // Note: DNS configuration change will help pick the new dns servers but currently it does not affect the timeout
11118 
11119         // Skip DNSServers that are InterfaceID Scoped but have no valid interfaceid set OR DNSServers that are ServiceID Scoped but have no valid serviceid set
11120         if ((curr->scoped == kScopeInterfaceID && curr->interface == mDNSInterface_Any) || (curr->scoped == kScopeServiceID && curr->serviceID <= 0))
11121         {
11122             LogInfo("SetValidDNSServers: ScopeType[%d] Skipping DNS server %#a (Domain %##s) Interface:[%p] Serviceid:[%d]", curr->scoped, &curr->addr, curr->domain.c, curr->interface, curr->serviceID);
11123             continue;
11124         }
11125 
11126         currcount = CountLabels(&curr->domain);
11127         if ((!curr->cellIntf || (!DEQuery && !(question->flags & kDNSServiceFlagsDenyCellular))) &&
11128             (!curr->isExpensive || !(question->flags & kDNSServiceFlagsDenyExpensive)) &&
11129             DNSServerMatch(curr, question->InterfaceID, question->ServiceID))
11130         {
11131             bettermatch = BetterMatchForName(&question->qname, namecount, &curr->domain, currcount, bestmatchlen);
11132 
11133             // If we found a better match (bettermatch == 1) then clear all the bits
11134             // corresponding to the old DNSServers that we have may set before and start fresh.
11135             // If we find an equal match, then include that DNSServer also by setting the corresponding
11136             // bit
11137             if ((bettermatch == 1) || (bettermatch == 0))
11138             {
11139                 bestmatchlen = currcount;
11140                 if (bettermatch)
11141                 {
11142                     debugf("SetValidDNSServers: Resetting all the bits");
11143                     question->validDNSServers = zeroOpaque128;
11144                     timeout = 0;
11145                 }
11146                 debugf("SetValidDNSServers: question %##s Setting the bit for DNS server Address %#a (Domain %##s), Scoped:%d index %d,"
11147                        " Timeout %d, interface %p", question->qname.c, &curr->addr, curr->domain.c, curr->scoped, index, curr->timeout,
11148                        curr->interface);
11149                 timeout += curr->timeout;
11150                 if (DEQuery)
11151                     debugf("DomainEnumQuery: Question %##s, DNSServer %#a, cell %d", question->qname.c, &curr->addr, curr->cellIntf);
11152                 bit_set_opaque128(question->validDNSServers, index);
11153             }
11154         }
11155         index++;
11156     }
11157     question->noServerResponse = 0;
11158 
11159     debugf("SetValidDNSServers: ValidDNSServer bits  0x%x%x%x%x for question %p %##s (%s)",
11160            question->validDNSServers.l[3], question->validDNSServers.l[2], question->validDNSServers.l[1], question->validDNSServers.l[0], question, question->qname.c, DNSTypeName(question->qtype));
11161     // If there are no matching resolvers, then use the default timeout value.
11162     // For ProxyQuestion, shorten the timeout so that dig does not timeout on us in case of no response.
11163     return ((question->ProxyQuestion || question->ValidatingResponse) ? DEFAULT_UDNSSEC_TIMEOUT : timeout ? timeout : DEFAULT_UDNS_TIMEOUT);
11164 }
11165 
11166 // Get the Best server that matches a name. If you find penalized servers, look for the one
11167 // that will come out of the penalty box soon
11168 mDNSlocal DNSServer *GetBestServer(mDNS *m, const domainname *name, mDNSInterfaceID InterfaceID, mDNSs32 ServiceID, mDNSOpaque128 validBits,
11169     int *selected, mDNSBool nameMatch)
11170 {
11171     DNSServer *curmatch = mDNSNULL;
11172     int bestmatchlen = -1, namecount = name ? CountLabels(name) : 0;
11173     DNSServer *curr;
11174     mDNSs32 bestPenaltyTime, currPenaltyTime;
11175     int bettermatch, currcount;
11176     int index = 0;
11177     int currindex = -1;
11178 
11179     debugf("GetBestServer: ValidDNSServer bits  0x%x%x", validBits.l[1], validBits.l[0]);
11180     bestPenaltyTime = DNSSERVER_PENALTY_TIME + 1;
11181     for (curr = m->DNSServers; curr; curr = curr->next)
11182     {
11183         // skip servers that will soon be deleted
11184         if (curr->flags & DNSServer_FlagDelete)
11185         {
11186             debugf("GetBestServer: Delete set for index %d, DNS server %#a (Domain %##s), scoped %d", index, &curr->addr, curr->domain.c, curr->scoped);
11187             continue;
11188         }
11189 
11190         // Check if this is a valid DNSServer
11191         if (!bit_get_opaque64(validBits, index))
11192         {
11193             debugf("GetBestServer: continuing for index %d", index);
11194             index++;
11195             continue;
11196         }
11197 
11198         currcount = CountLabels(&curr->domain);
11199         currPenaltyTime = PenaltyTimeForServer(m, curr);
11200 
11201         debugf("GetBestServer: Address %#a (Domain %##s), PenaltyTime(abs) %d, PenaltyTime(rel) %d",
11202                &curr->addr, curr->domain.c, curr->penaltyTime, currPenaltyTime);
11203 
11204         // If there are multiple best servers for a given question, we will pick the first one
11205         // if none of them are penalized. If some of them are penalized in that list, we pick
11206         // the least penalized one. BetterMatchForName walks through all best matches and
11207         // "currPenaltyTime < bestPenaltyTime" check lets us either pick the first best server
11208         // in the list when there are no penalized servers and least one among them
11209         // when there are some penalized servers.
11210 
11211         if (DNSServerMatch(curr, InterfaceID, ServiceID))
11212         {
11213 
11214             // If we know that all the names are already equally good matches, then skip calling BetterMatchForName.
11215             // This happens when we initially walk all the DNS servers and set the validity bit on the question.
11216             // Actually we just need PenaltyTime match, but for the sake of readability we just skip the expensive
11217             // part and still do some redundant steps e.g., InterfaceID match
11218 
11219             if (nameMatch)
11220                 bettermatch = BetterMatchForName(name, namecount, &curr->domain, currcount, bestmatchlen);
11221             else
11222                 bettermatch = 0;
11223 
11224             // If we found a better match (bettermatch == 1) then we don't need to
11225             // compare penalty times. But if we found an equal match, then we compare
11226             // the penalty times to pick a better match
11227 
11228             if ((bettermatch == 1) || ((bettermatch == 0) && currPenaltyTime < bestPenaltyTime))
11229             {
11230                 currindex = index;
11231                 curmatch = curr;
11232                 bestmatchlen = currcount;
11233                 bestPenaltyTime = currPenaltyTime;
11234             }
11235         }
11236         index++;
11237     }
11238     if (selected) *selected = currindex;
11239     return curmatch;
11240 }
11241 
11242 // Look up a DNS Server, matching by name and InterfaceID
11243 mDNSlocal DNSServer *GetServerForName(mDNS *m, const domainname *name, mDNSInterfaceID InterfaceID, mDNSs32 ServiceID)
11244 {
11245     DNSServer *curmatch = mDNSNULL;
11246     char *ifname = mDNSNULL;    // for logging purposes only
11247     mDNSOpaque128 allValid;
11248 
11249     if ((InterfaceID == mDNSInterface_Unicast) || (InterfaceID == mDNSInterface_LocalOnly))
11250         InterfaceID = mDNSNULL;
11251 
11252     if (InterfaceID) ifname = InterfaceNameForID(m, InterfaceID);
11253 
11254     // By passing in all ones, we make sure that every DNS server is considered
11255     allValid.l[0] = allValid.l[1] = allValid.l[2] = allValid.l[3] = 0xFFFFFFFF;
11256 
11257     curmatch = GetBestServer(m, name, InterfaceID, ServiceID, allValid, mDNSNULL, mDNStrue);
11258 
11259     if (curmatch != mDNSNULL)
11260         LogInfo("GetServerForName: DNS server %#a:%d (Penalty Time Left %d) (Scope %s:%p) for %##s", &curmatch->addr,
11261                 mDNSVal16(curmatch->port), (curmatch->penaltyTime ? (curmatch->penaltyTime - m->timenow) : 0), ifname ? ifname : "None",
11262                 InterfaceID, name);
11263     else
11264         LogInfo("GetServerForName: no DNS server (Scope %s:%p) for %##s", ifname ? ifname : "None", InterfaceID, name);
11265 
11266     return(curmatch);
11267 }
11268 
11269 // Look up a DNS Server for a question within its valid DNSServer bits
11270 mDNSexport DNSServer *GetServerForQuestion(mDNS *m, DNSQuestion *question)
11271 {
11272     DNSServer *curmatch = mDNSNULL;
11273     char *ifname = mDNSNULL;    // for logging purposes only
11274     mDNSInterfaceID InterfaceID = question->InterfaceID;
11275     const domainname *name = &question->qname;
11276     int currindex;
11277 
11278     if ((InterfaceID == mDNSInterface_Unicast) || (InterfaceID == mDNSInterface_LocalOnly))
11279         InterfaceID = mDNSNULL;
11280 
11281     if (InterfaceID)
11282         ifname = InterfaceNameForID(m, InterfaceID);
11283 
11284     if (!mDNSOpaque128IsZero(&question->validDNSServers))
11285     {
11286         curmatch = GetBestServer(m, name, InterfaceID, question->ServiceID, question->validDNSServers, &currindex, mDNSfalse);
11287         if (currindex != -1)
11288             bit_clr_opaque128(question->validDNSServers, currindex);
11289     }
11290 
11291     if (curmatch != mDNSNULL)
11292     {
11293         LogInfo("GetServerForQuestion: %p DNS server (%p) %#a:%d (Penalty Time Left %d) (Scope %s:%p:%d) for %##s (%s)",
11294                 question, curmatch, &curmatch->addr, mDNSVal16(curmatch->port),
11295                 (curmatch->penaltyTime ? (curmatch->penaltyTime - m->timenow) : 0), ifname ? ifname : "None",
11296                 InterfaceID, question->ServiceID, name, DNSTypeName(question->qtype));
11297     }
11298     else
11299     {
11300         LogInfo("GetServerForQuestion: %p no DNS server (Scope %s:%p:%d) for %##s (%s)",
11301             question, ifname ? ifname : "None", InterfaceID, question->ServiceID, name, DNSTypeName(question->qtype));
11302     }
11303 
11304     return(curmatch);
11305 }
11306 
11307 
11308 #define ValidQuestionTarget(Q) (((Q)->Target.type == mDNSAddrType_IPv4 || (Q)->Target.type == mDNSAddrType_IPv6) && \
11309                                 (mDNSSameIPPort((Q)->TargetPort, UnicastDNSPort) || mDNSSameIPPort((Q)->TargetPort, MulticastDNSPort)))
11310 
11311 // Called in normal client context (lock not held)
11312 mDNSlocal void LLQNATCallback(mDNS *m, NATTraversalInfo *n)
11313 {
11314     DNSQuestion *q;
11315     mDNS_Lock(m);
11316     LogInfo("LLQNATCallback external address:port %.4a:%u, NAT result %d", &n->ExternalAddress, mDNSVal16(n->ExternalPort), n->Result);
11317     n->clientContext = mDNSNULL; // we received at least one callback since starting this NAT-T
11318     for (q = m->Questions; q; q=q->next)
11319         if (ActiveQuestion(q) && !mDNSOpaque16IsZero(q->TargetQID) && q->LongLived)
11320             startLLQHandshake(m, q);    // If ExternalPort is zero, will do StartLLQPolling instead
11321 #if APPLE_OSX_mDNSResponder
11322     UpdateAutoTunnelDomainStatuses(m);
11323 #endif
11324     mDNS_Unlock(m);
11325 }
11326 
11327 mDNSlocal mDNSBool IsPrivateDomain(mDNS *const m, DNSQuestion *q)
11328 {
11329     DomainAuthInfo *AuthInfo;
11330     // Skip Private domains as we have special addresses to get the hosts in the Private domain
11331     AuthInfo = GetAuthInfoForName_internal(m, &q->qname);
11332     if (AuthInfo && !AuthInfo->deltime && AuthInfo->AutoTunnel)
11333     {
11334         debugf("IsPrivateDomain: %##s true", q->qname.c);
11335         return mDNStrue;
11336     }
11337     else
11338     {
11339         debugf("IsPrivateDomain: %##s false", q->qname.c);
11340         return mDNSfalse;
11341     }
11342 }
11343 
11344 #define TrueFalseStr(X) ((X) ? "true" : "false")
11345 
11346 // This function takes the DNSServer as a separate argument because sometimes the
11347 // caller has not yet assigned the DNSServer, but wants to evaluate the SuppressQuery
11348 // status before switching to it.
11349 mDNSlocal mDNSBool ShouldSuppressUnicastQuery(mDNS *const m, DNSQuestion *q, DNSServer *d)
11350 {
11351     // Some callers don't check for the qtype
11352     if (q->qtype != kDNSType_A && q->qtype != kDNSType_AAAA)
11353     {
11354         LogDebug("ShouldSuppressUnicastQuery: Query not suppressed for %##s, qtype %s, not A/AAAA type", q->qname.c, DNSTypeName(q->qtype));
11355         return mDNSfalse;
11356     }
11357 
11358     // Private domains are exempted irrespective of what the DNSServer says
11359     if (IsPrivateDomain(m, q))
11360     {
11361         LogDebug("ShouldSuppressUnicastQuery: Query not suppressed for %##s, qtype %s, Private Domain", q->qname.c, DNSTypeName(q->qtype));
11362         return mDNSfalse;
11363     }
11364 
11365     if (!d)
11366     {
11367         LogInfo("ShouldSuppressUnicastQuery: Query suppressed for %##s, qtype %s, as the DNS server is NULL", q->qname.c, DNSTypeName(q->qtype));
11368         return mDNStrue;
11369     }
11370 
11371     // Check if the DNS Configuration allows A/AAAA queries to be sent
11372     if ((q->qtype == kDNSType_A) && d->req_A)
11373     {
11374         // The server's configuration allows A record queries, so don't suppress this query unless
11375         //     1. the interface associated with the server is CLAT46; and
11376         //     2. the query has the kDNSServiceFlagsPathEvaluationDone flag, which indicates that it came from libnetcore.
11377         // See <rdar://problem/42672030> for more info.
11378         if (!(d->isCLAT46 && (q->flags & kDNSServiceFlagsPathEvaluationDone)))
11379         {
11380             LogDebug("ShouldSuppressUnicastQuery: Query not suppressed for %##s, qtype %s, DNSServer %##s %#a:%d allows A queries", q->qname.c,
11381                      DNSTypeName(q->qtype), d->domain.c, &d->addr, mDNSVal16(d->port));
11382             return mDNSfalse;
11383         }
11384     }
11385     if ((q->qtype == kDNSType_AAAA) && d->req_AAAA)
11386     {
11387         LogDebug("ShouldSuppressUnicastQuery: Query not suppressed for %##s, qtype %s, DNSServer %##s %#a:%d allows AAAA queries", q->qname.c,
11388                 DNSTypeName(q->qtype), d->domain.c, &d->addr, mDNSVal16(d->port));
11389         return mDNSfalse;
11390     }
11391 #if USE_DNS64
11392     if (DNS64IsQueryingARecord(q->dns64.state))
11393     {
11394         LogDebug("ShouldSuppressUnicastQuery: DNS64 query not suppressed for %##s, qtype %s", q->qname.c, DNSTypeName(q->qtype));
11395         return mDNSfalse;
11396     }
11397 #endif
11398 
11399     LogInfo("ShouldSuppressUnicastQuery: Query suppressed for %##s, qtype %s, since DNS Configuration does not allow (req_A %s, req_AAAA %s, CLAT46 %s)",
11400         q->qname.c, DNSTypeName(q->qtype), TrueFalseStr(d->req_A), TrueFalseStr(d->req_AAAA), TrueFalseStr(d->isCLAT46));
11401 
11402     return mDNStrue;
11403 }
11404 
11405 mDNSlocal mDNSBool ShouldSuppressDotLocalQuery(mDNS *const m, DNSQuestion *q)
11406 {
11407     NetworkInterfaceInfo *intf;
11408     AuthRecord *rr;
11409     mDNSBool ret;
11410 
11411     // Check to see if there is at least one interface other than loopback and don't suppress
11412     // .local questions if you find one. If we have at least one interface, it means that
11413     // we can send unicast queries for the .local name and we don't want to suppress
11414     // multicast in that case as upper layers don't know how to handle if we return a
11415     // negative response for multicast followed by a positive response for unicast.
11416     //
11417     // Note: we used to check for multicast capable interfaces instead of just any interface
11418     // present. That did not work in the case where we have a valid interface for unicast
11419     // but not multicast capable e.g., cellular, as we ended up delivering a negative response
11420     // first and the upper layer did not wait for the positive response that came later.
11421     for (intf = m->HostInterfaces; intf; intf = intf->next)
11422     {
11423         if (intf->InterfaceActive && !intf->Loopback)
11424         {
11425             LogInfo("ShouldSuppressDotLocalQuery: Found interface %s, not suppressing", intf->ifname);
11426             return mDNSfalse;
11427         }
11428     }
11429 
11430     // 1. If we find a LocalOnly or P2P record answering this question, then don't suppress it.
11431     //    Set m->CurrentQuestion as it is required by AnswerQuestionWithLORecord.
11432     m->CurrentQuestion = q;
11433     ret = AnswerQuestionWithLORecord(m, q, mDNStrue);
11434     m->CurrentQuestion = mDNSNULL;
11435 
11436     if (ret)
11437     {
11438         LogInfo("ShouldSuppressDotLocalQuery: Found LocalOnly record for %##s (%s), not suppressing", q->qname.c,
11439             DNSTypeName(q->qtype));
11440         return mDNSfalse;
11441     }
11442 
11443     // 2. If we find a local AuthRecord answering this question, then don't suppress it.
11444     for (rr = m->ResourceRecords; rr; rr = rr->next)
11445     {
11446         if (ResourceRecordAnswersQuestion(&rr->resrec, q))
11447         {
11448             LogInfo("ShouldSuppressDotLocalQuery: Found resource record %s for %##s (%s) not suppressing", ARDisplayString(m, rr),
11449                 q->qname.c, DNSTypeName(q->qtype));
11450             return mDNSfalse;
11451         }
11452     }
11453     return mDNStrue;
11454 }
11455 
11456 mDNSlocal mDNSBool ShouldSuppressQuery(mDNS *const m, DNSQuestion *q)
11457 {
11458     if (q->InterfaceID == mDNSInterface_LocalOnly)
11459     {
11460         LogInfo("ShouldSuppressQuery: LocalOnly query not suppressed for %##s, qtype %s", q->qname.c, DNSTypeName(q->qtype));
11461         return mDNSfalse;
11462     }
11463 
11464     if (q->qtype != kDNSType_A && q->qtype != kDNSType_AAAA)
11465     {
11466         LogInfo("ShouldSuppressQuery: Query not suppressed for %##s, qtype %s, not A/AAAA type", q->qname.c, DNSTypeName(q->qtype));
11467         return mDNSfalse;
11468     }
11469 
11470     // We still want the ability to be able to listen to the local services and hence
11471     // don't fail .local query if we have local records that can potentially answer
11472     // the question.
11473     if (q->InterfaceID != mDNSInterface_Unicast && IsLocalDomain(&q->qname))
11474     {
11475         if (!ShouldSuppressDotLocalQuery(m, q))
11476         {
11477             LogInfo("ShouldSuppressQuery: Query not suppressed for %##s, qtype %s, Local question", q->qname.c, DNSTypeName(q->qtype));
11478             return mDNSfalse;
11479         }
11480         else
11481         {
11482             LogInfo("ShouldSuppressQuery: Query suppressed for %##s, qtype %s, Local question", q->qname.c, DNSTypeName(q->qtype));
11483             return mDNStrue;
11484         }
11485     }
11486 
11487     return (ShouldSuppressUnicastQuery(m, q, q->qDNSServer));
11488 }
11489 
11490 mDNSlocal void CacheRecordRmvEventsForCurrentQuestion(mDNS *const m, DNSQuestion *q)
11491 {
11492     CacheRecord *rr;
11493     CacheGroup *cg;
11494 
11495     cg = CacheGroupForName(m, q->qnamehash, &q->qname);
11496     for (rr = cg ? cg->members : mDNSNULL; rr; rr=rr->next)
11497     {
11498         // Don't deliver RMV events for negative records
11499         if (rr->resrec.RecordType == kDNSRecordTypePacketNegative)
11500         {
11501             LogInfo("CacheRecordRmvEventsForCurrentQuestion: CacheRecord %s Suppressing RMV events for question %p %##s (%s), CRActiveQuestion %p, CurrentAnswers %d",
11502                     CRDisplayString(m, rr), q, q->qname.c, DNSTypeName(q->qtype), rr->CRActiveQuestion, q->CurrentAnswers);
11503             continue;
11504         }
11505 
11506         if (SameNameRecordAnswersQuestion(&rr->resrec, q))
11507         {
11508             LogInfo("CacheRecordRmvEventsForCurrentQuestion: Calling AnswerCurrentQuestionWithResourceRecord (RMV) for question %##s using resource record %s LocalAnswers %d",
11509                     q->qname.c, CRDisplayString(m, rr), q->LOAddressAnswers);
11510 
11511             q->CurrentAnswers--;
11512             if (rr->resrec.rdlength > SmallRecordLimit) q->LargeAnswers--;
11513             if (rr->resrec.RecordType & kDNSRecordTypePacketUniqueMask) q->UniqueAnswers--;
11514 
11515             if (rr->CRActiveQuestion == q)
11516             {
11517                 DNSQuestion *qptr;
11518                 // If this was the active question for this cache entry, it was the one that was
11519                 // responsible for keeping the cache entry fresh when the cache entry was reaching
11520                 // its expiry. We need to handover the responsibility to someone else. Otherwise,
11521                 // when the cache entry is about to expire, we won't find an active question
11522                 // (pointed by CRActiveQuestion) to refresh the cache.
11523                 for (qptr = m->Questions; qptr; qptr=qptr->next)
11524                     if (qptr != q && ActiveQuestion(qptr) && ResourceRecordAnswersQuestion(&rr->resrec, qptr))
11525                         break;
11526 
11527                 if (qptr)
11528                     LogInfo("CacheRecordRmvEventsForCurrentQuestion: Updating CRActiveQuestion to %p for cache record %s, "
11529                             "Original question CurrentAnswers %d, new question CurrentAnswers %d, SuppressUnusable %d, SuppressQuery %d",
11530                             qptr, CRDisplayString(m,rr), q->CurrentAnswers, qptr->CurrentAnswers, qptr->SuppressUnusable, qptr->SuppressQuery);
11531 
11532                 rr->CRActiveQuestion = qptr;        // Question used to be active; new value may or may not be null
11533                 if (!qptr) m->rrcache_active--; // If no longer active, decrement rrcache_active count
11534             }
11535             AnswerCurrentQuestionWithResourceRecord(m, rr, QC_rmv);
11536             if (m->CurrentQuestion != q) break;     // If callback deleted q, then we're finished here
11537         }
11538     }
11539 }
11540 
11541 mDNSlocal mDNSBool IsQuestionNew(mDNS *const m, DNSQuestion *question)
11542 {
11543     DNSQuestion *q;
11544     for (q = m->NewQuestions; q; q = q->next)
11545         if (q == question) return mDNStrue;
11546     return mDNSfalse;
11547 }
11548 
11549 mDNSlocal mDNSBool LocalRecordRmvEventsForQuestion(mDNS *const m, DNSQuestion *q)
11550 {
11551     AuthRecord *rr;
11552     AuthGroup *ag;
11553 
11554     if (m->CurrentQuestion)
11555         LogMsg("LocalRecordRmvEventsForQuestion: ERROR m->CurrentQuestion already set: %##s (%s)",
11556                m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
11557 
11558     if (IsQuestionNew(m, q))
11559     {
11560         LogInfo("LocalRecordRmvEventsForQuestion: New Question %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
11561         return mDNStrue;
11562     }
11563     m->CurrentQuestion = q;
11564     ag = AuthGroupForName(&m->rrauth, q->qnamehash, &q->qname);
11565     if (ag)
11566     {
11567         for (rr = ag->members; rr; rr=rr->next)
11568             // Filter the /etc/hosts records - LocalOnly, Unique, A/AAAA/CNAME
11569             if (UniqueLocalOnlyRecord(rr) && LocalOnlyRecordAnswersQuestion(rr, q))
11570             {
11571                 LogInfo("LocalRecordRmvEventsForQuestion: Delivering possible Rmv events with record %s",
11572                         ARDisplayString(m, rr));
11573                 if (q->CurrentAnswers <= 0 || q->LOAddressAnswers <= 0)
11574                 {
11575                     LogMsg("LocalRecordRmvEventsForQuestion: ERROR!! CurrentAnswers or LOAddressAnswers is zero %p %##s"
11576                            " (%s) CurrentAnswers %d, LOAddressAnswers %d", q, q->qname.c, DNSTypeName(q->qtype),
11577                            q->CurrentAnswers, q->LOAddressAnswers);
11578                     continue;
11579                 }
11580                 AnswerLocalQuestionWithLocalAuthRecord(m, rr, QC_rmv);      // MUST NOT dereference q again
11581                 if (m->CurrentQuestion != q) { m->CurrentQuestion = mDNSNULL; return mDNSfalse; }
11582             }
11583     }
11584     m->CurrentQuestion = mDNSNULL;
11585     return mDNStrue;
11586 }
11587 
11588 // Returns false if the question got deleted while delivering the RMV events
11589 // The caller should handle the case
11590 mDNSexport mDNSBool CacheRecordRmvEventsForQuestion(mDNS *const m, DNSQuestion *q)
11591 {
11592     if (m->CurrentQuestion)
11593         LogMsg("CacheRecordRmvEventsForQuestion: ERROR m->CurrentQuestion already set: %##s (%s)",
11594                m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
11595 
11596     // If it is a new question, we have not delivered any ADD events yet. So, don't deliver RMV events.
11597     // If this question was answered using local auth records, then you can't deliver RMVs using cache
11598     if (!IsQuestionNew(m, q) && !q->LOAddressAnswers)
11599     {
11600         m->CurrentQuestion = q;
11601         CacheRecordRmvEventsForCurrentQuestion(m, q);
11602         if (m->CurrentQuestion != q) { m->CurrentQuestion = mDNSNULL; return mDNSfalse; }
11603         m->CurrentQuestion = mDNSNULL;
11604     }
11605     else { LogInfo("CacheRecordRmvEventsForQuestion: Question %p %##s (%s) is a new question", q, q->qname.c, DNSTypeName(q->qtype)); }
11606     return mDNStrue;
11607 }
11608 
11609 mDNSlocal void SuppressStatusChanged(mDNS *const m, DNSQuestion *q, DNSQuestion **restart)
11610 {
11611     // NOTE: CacheRecordRmvEventsForQuestion will not generate RMV events for queries that have non-zero
11612     // LOAddressAnswers. Hence it is important that we call CacheRecordRmvEventsForQuestion before
11613     // LocalRecordRmvEventsForQuestion (which decrements LOAddressAnswers)
11614     if (q->SuppressQuery)
11615     {
11616         q->SuppressQuery = mDNSfalse;
11617         if (!CacheRecordRmvEventsForQuestion(m, q))
11618         {
11619             LogInfo("SuppressStatusChanged: Question deleted while delivering RMV events from cache");
11620             return;
11621         }
11622         q->SuppressQuery = mDNStrue;
11623     }
11624 
11625     // SuppressUnusable does not affect questions that are answered from the local records (/etc/hosts)
11626     // and SuppressQuery status does not mean anything for these questions. As we are going to stop the
11627     // question below, we need to deliver the RMV events so that the ADDs that will be delivered during
11628     // the restart will not be a duplicate ADD
11629     if (!LocalRecordRmvEventsForQuestion(m, q))
11630     {
11631         LogInfo("SuppressStatusChanged: Question deleted while delivering RMV events from Local AuthRecords");
11632         return;
11633     }
11634 
11635     // There are two cases here.
11636     //
11637     // 1. Previously it was suppressed and now it is not suppressed, restart the question so
11638     // that it will start as a new question. Note that we can't just call ActivateUnicastQuery
11639     // because when we get the response, if we had entries in the cache already, it will not answer
11640     // this question if the cache entry did not change. Hence, we need to restart
11641     // the query so that it can be answered from the cache.
11642     //
11643     // 2. Previously it was not suppressed and now it is suppressed. We need to restart the questions
11644     // so that we redo the duplicate checks in mDNS_StartQuery_internal. A SuppressUnusable question
11645     // is a duplicate of non-SuppressUnusable question if it is not suppressed (SuppressQuery is false).
11646     // A SuppressUnusable question is not a duplicate of non-SuppressUnusable question if it is suppressed
11647     // (SuppressQuery is true). The reason for this is that when a question is suppressed, we want an
11648     // immediate response and not want to be blocked behind a question that is querying DNS servers. When
11649     // the question is not suppressed, we don't want two active questions sending packets on the wire.
11650     // This affects both efficiency and also the current design where there is only one active question
11651     // pointed to from a cache entry.
11652     //
11653     // We restart queries in a two step process by first calling stop and build a temporary list which we
11654     // will restart at the end. The main reason for the two step process is to handle duplicate questions.
11655     // If there are duplicate questions, calling stop inherits the values from another question on the list (which
11656     // will soon become the real question) including q->ThisQInterval which might be zero if it was
11657     // suppressed before. At the end when we have restarted all questions, none of them is active as each
11658     // inherits from one another and we need to reactivate one of the questions here which is a little hacky.
11659     //
11660     // It is much cleaner and less error prone to build a list of questions and restart at the end.
11661 
11662     LogInfo("SuppressStatusChanged: Stop question %p %##s (%s)", q, q->qname.c, DNSTypeName(q->qtype));
11663     mDNS_StopQuery_internal(m, q);
11664     q->next = *restart;
11665     *restart = q;
11666 }
11667 
11668 // The caller should hold the lock
11669 mDNSexport void CheckSuppressUnusableQuestions(mDNS *const m)
11670 {
11671     DNSQuestion *q;
11672     DNSQuestion *restart = mDNSNULL;
11673 
11674     // We look through all questions including new questions. During network change events,
11675     // we potentially restart questions here in this function that ends up as new questions,
11676     // which may be suppressed at this instance. Before it is handled we get another network
11677     // event that changes the status e.g., address becomes available. If we did not process
11678     // new questions, we would never change its SuppressQuery status.
11679     //
11680     // CurrentQuestion is used by RmvEventsForQuestion below. While delivering RMV events, the
11681     // application callback can potentially stop the current question (detected by CurrentQuestion) or
11682     // *any* other question which could be the next one that we may process here. RestartQuestion
11683     // points to the "next" question which will be automatically advanced in mDNS_StopQuery_internal
11684     // if the "next" question is stopped while the CurrentQuestion is stopped
11685     if (m->RestartQuestion)
11686         LogMsg("CheckSuppressUnusableQuestions: ERROR!! m->RestartQuestion already set: %##s (%s)",
11687                m->RestartQuestion->qname.c, DNSTypeName(m->RestartQuestion->qtype));
11688     m->RestartQuestion = m->Questions;
11689     while (m->RestartQuestion)
11690     {
11691         q = m->RestartQuestion;
11692         m->RestartQuestion = q->next;
11693         if (q->SuppressUnusable)
11694         {
11695             mDNSBool old = q->SuppressQuery;
11696             q->SuppressQuery = ShouldSuppressQuery(m, q);
11697             if (q->SuppressQuery != old)
11698             {
11699                 // Previously it was not suppressed, Generate RMV events for the ADDs that we might have delivered before
11700                 // followed by a negative cache response. Temporarily turn off suppression so that
11701                 // AnswerCurrentQuestionWithResourceRecord can answer the question
11702                 SuppressStatusChanged(m, q, &restart);
11703             }
11704         }
11705     }
11706     while (restart)
11707     {
11708         q = restart;
11709         restart = restart->next;
11710         q->next = mDNSNULL;
11711         LogInfo("CheckSuppressUnusableQuestions: Start question %p %##s (%s)", q, q->qname.c, DNSTypeName(q->qtype));
11712         mDNS_StartQuery_internal(m, q);
11713     }
11714 }
11715 
11716 mDNSlocal void RestartUnicastQuestions(mDNS *const m)
11717 {
11718     DNSQuestion *q;
11719     DNSQuestion *restart = mDNSNULL;
11720 
11721     if (m->RestartQuestion)
11722         LogMsg("RestartUnicastQuestions: ERROR!! m->RestartQuestion already set: %##s (%s)",
11723                m->RestartQuestion->qname.c, DNSTypeName(m->RestartQuestion->qtype));
11724     m->RestartQuestion = m->Questions;
11725     while (m->RestartQuestion)
11726     {
11727         q = m->RestartQuestion;
11728         m->RestartQuestion = q->next;
11729         if (q->Restart)
11730         {
11731             if (mDNSOpaque16IsZero(q->TargetQID))
11732                 LogMsg("RestartUnicastQuestions: ERROR!! Restart set for multicast question %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
11733 
11734             q->Restart = 0;
11735             SuppressStatusChanged(m, q, &restart);
11736         }
11737     }
11738     while (restart)
11739     {
11740         q = restart;
11741         restart = restart->next;
11742         q->next = mDNSNULL;
11743         LogInfo("RestartUnicastQuestions: Start question %p %##s (%s)", q, q->qname.c, DNSTypeName(q->qtype));
11744         mDNS_StartQuery_internal(m, q);
11745     }
11746 }
11747 
11748 
11749 // ValidateParameters() is called by mDNS_StartQuery_internal() to check the client parameters of
11750 // DNS Question that are already set by the client before calling mDNS_StartQuery()
11751 mDNSlocal mStatus ValidateParameters(mDNS *const m, DNSQuestion *const question)
11752 {
11753 
11754     if (question->Target.type && !ValidQuestionTarget(question))
11755     {
11756         LogMsg("ValidateParameters: Warning! Target.type = %ld port = %u (Client forgot to initialize before calling mDNS_StartQuery? for question %##s)",
11757                question->Target.type, mDNSVal16(question->TargetPort), question->qname.c);
11758         question->Target.type = mDNSAddrType_None;
11759     }
11760 
11761     // If no question->Target specified, clear TargetPort
11762     if (!question->Target.type)
11763         question->TargetPort = zeroIPPort;
11764 
11765     if (!ValidateDomainName(&question->qname))
11766     {
11767         LogMsg("ValidateParameters: Attempt to start query with invalid qname %##s (%s)", question->qname.c, DNSTypeName(question->qtype));
11768         return(mStatus_Invalid);
11769     }
11770 
11771     // If this question is referencing a specific interface, verify it exists
11772     if (question->InterfaceID && !LocalOnlyOrP2PInterface(question->InterfaceID) && question->InterfaceID != mDNSInterface_Unicast)
11773     {
11774         NetworkInterfaceInfo *intf = FirstInterfaceForID(m, question->InterfaceID);
11775         if (!intf)
11776             LogInfo("ValidateParameters: Note: InterfaceID %d for question %##s (%s) not currently found in active interface list",
11777                     (uint32_t)question->InterfaceID, question->qname.c, DNSTypeName(question->qtype));
11778     }
11779 
11780     return(mStatus_NoError);
11781 }
11782 
11783 // InitDNSConfig() is called by InitCommonState() to initialize the DNS configuration of the Question.
11784 // These are a subset of the internal uDNS fields. Must be done before ShouldSuppressQuery() & mDNS_PurgeBeforeResolve()
11785 mDNSlocal void InitDNSConfig(mDNS *const m, DNSQuestion *const question)
11786 {
11787     // First reset all DNS Configuration
11788     question->qDNSServer          = mDNSNULL;
11789     question->validDNSServers     = zeroOpaque128;
11790     question->triedAllServersOnce = 0;
11791     question->noServerResponse    = 0;
11792     question->StopTime            = (question->TimeoutQuestion) ? question->StopTime : 0;
11793 #if AWD_METRICS
11794     mDNSPlatformMemZero(&question->metrics, sizeof(question->metrics));
11795     question->metrics.expiredAnswerState = (question->allowExpired != AllowExpired_None) ? ExpiredAnswer_Allowed : ExpiredAnswer_None;
11796 #endif
11797 
11798     // Need not initialize the DNS Configuration for Local Only OR P2P Questions when timeout not specified
11799     if (LocalOnlyOrP2PInterface(question->InterfaceID) && !question->TimeoutQuestion)
11800         return;
11801     // Proceed to initialize DNS Configuration (some are set in SetValidDNSServers())
11802     if (!mDNSOpaque16IsZero(question->TargetQID))
11803     {
11804         mDNSu32 timeout = SetValidDNSServers(m, question);
11805         // We set the timeout value the first time mDNS_StartQuery_internal is called for a question.
11806         // So if a question is restarted when a network change occurs, the StopTime is not reset.
11807         // Note that we set the timeout for all questions. If this turns out to be a duplicate,
11808         // it gets a full timeout value even if the original question times out earlier.
11809         if (question->TimeoutQuestion && !question->StopTime)
11810         {
11811             question->StopTime = NonZeroTime(m->timenow + timeout * mDNSPlatformOneSecond);
11812             LogInfo("InitDNSConfig: Setting StopTime on the uDNS question %p %##s (%s)", question, question->qname.c, DNSTypeName(question->qtype));
11813         }
11814 
11815         question->qDNSServer = GetServerForQuestion(m, question);
11816         LogDebug("InitDNSConfig: question %p %##s (%s) Timeout %d, DNS Server %#a:%d",
11817                  question, question->qname.c, DNSTypeName(question->qtype), timeout,
11818                  question->qDNSServer ? &question->qDNSServer->addr : mDNSNULL,
11819                  mDNSVal16(question->qDNSServer ? question->qDNSServer->port : zeroIPPort));
11820     }
11821     else if (question->TimeoutQuestion && !question->StopTime)
11822     {
11823         // If the question is to be timed out and its a multicast, local-only or P2P case,
11824         // then set it's stop time.
11825         mDNSu32 timeout = LocalOnlyOrP2PInterface(question->InterfaceID) ?
11826                             DEFAULT_LO_OR_P2P_TIMEOUT : GetTimeoutForMcastQuestion(m, question);
11827         question->StopTime = NonZeroTime(m->timenow + timeout * mDNSPlatformOneSecond);
11828         LogInfo("InitDNSConfig: Setting StopTime on question %p %##s (%s)", question, question->qname.c, DNSTypeName(question->qtype));
11829     }
11830     // Set StopTime here since it is a part of DNS Configuration
11831     if (question->StopTime)
11832         SetNextQueryStopTime(m, question);
11833     // Don't call SetNextQueryTime() if a LocalOnly OR P2P Question since those questions
11834     // will never be transmitted on the wire.
11835     if (!(LocalOnlyOrP2PInterface(question->InterfaceID)))
11836         SetNextQueryTime(m,question);
11837 }
11838 
11839 // InitCommonState() is called by mDNS_StartQuery_internal() to initialize the common(uDNS/mDNS) internal
11840 // state fields of the DNS Question. These are independent of the Client layer.
11841 mDNSlocal void InitCommonState(mDNS *const m, DNSQuestion *const question)
11842 {
11843     int i;
11844     mDNSBool isBlocked = mDNSfalse;
11845 
11846     // Note: In the case where we already have the answer to this question in our cache, that may be all the client
11847     // wanted, and they may immediately cancel their question. In this case, sending an actual query on the wire would
11848     // be a waste. For that reason, we schedule our first query to go out in half a second (InitialQuestionInterval).
11849     // If AnswerNewQuestion() finds that we have *no* relevant answers currently in our cache, then it will accelerate
11850     // that to go out immediately.
11851     question->next              = mDNSNULL;
11852     // ThisQInterval should be initialized before any memory allocations occur. If malloc
11853     // debugging is turned on within mDNSResponder (see mDNSDebug.h for details) it validates
11854     // the question list to check if ThisQInterval is negative which means the question has been
11855     // stopped and can't be on the list. The question is already on the list and ThisQInterval
11856     // can be negative if the caller just stopped it and starting it again. Hence, it always has to
11857     // be initialized. CheckForSoonToExpireRecords below prints the cache records when logging is
11858     // turned ON which can allocate memory e.g., base64 encoding, in the case of DNSSEC.
11859     question->ThisQInterval     = InitialQuestionInterval;                  // MUST be > zero for an active question
11860     question->qnamehash         = DomainNameHashValue(&question->qname);
11861     question->DelayAnswering    = mDNSOpaque16IsZero(question->TargetQID) ? CheckForSoonToExpireRecords(m, &question->qname, question->qnamehash) : 0;
11862     question->LastQTime         = m->timenow;
11863     question->ExpectUnicastResp = 0;
11864     question->LastAnswerPktNum  = m->PktNum;
11865     question->RecentAnswerPkts  = 0;
11866     question->CurrentAnswers    = 0;
11867 
11868 #if APPLE_OSX_mDNSResponder
11869 
11870 // Initial browse threshold used by Finder.
11871 #define mDNSFinderBrowseThreshold 20
11872 
11873     // Set the threshold at which we move to a passive browse state,
11874     // not actively sending queries.
11875     if (question->flags & kDNSServiceFlagsThresholdOne)
11876         question->BrowseThreshold   = 1;
11877     else if (question->flags & kDNSServiceFlagsThresholdFinder)
11878         question->BrowseThreshold   = mDNSFinderBrowseThreshold;
11879     else
11880         question->BrowseThreshold   = 0;
11881 
11882 #else   // APPLE_OSX_mDNSResponder
11883    question->BrowseThreshold   = 0;
11884 #endif  // APPLE_OSX_mDNSResponder
11885     question->CachedAnswerNeedsUpdate = mDNSfalse;
11886 
11887     question->LargeAnswers      = 0;
11888     question->UniqueAnswers     = 0;
11889     question->LOAddressAnswers  = 0;
11890     question->FlappingInterface1 = mDNSNULL;
11891     question->FlappingInterface2 = mDNSNULL;
11892 
11893     // if kDNSServiceFlagsServiceIndex flag is SET by the client, then do NOT call mDNSPlatformGetDNSRoutePolicy()
11894     // since we would already have the question->ServiceID in that case.
11895     if (!(question->flags & kDNSServiceFlagsServiceIndex))
11896     {
11897 #if APPLE_OSX_mDNSResponder
11898         mDNSPlatformGetDNSRoutePolicy(question, &isBlocked);
11899 #else
11900         question->ServiceID = -1;
11901 #endif
11902     }
11903     else
11904         LogInfo("InitCommonState: Query for %##s (%s), PID[%d], EUID[%d], ServiceID[%d] is already set by client", question->qname.c,
11905                 DNSTypeName(question->qtype), question->pid, question->euid, question->ServiceID);
11906 
11907     InitDNSConfig(m, question);
11908 
11909     question->AuthInfo          = GetAuthInfoForQuestion(m, question);
11910     question->SuppressQuery     = 0;
11911     if (question->SuppressUnusable)
11912         question->SuppressQuery = ShouldSuppressQuery(m, question);
11913 
11914     // If ServiceID is 0 or the policy disallows making DNS requests,
11915     // set DisallowPID
11916     question->DisallowPID       = (question->ServiceID == 0 || isBlocked);
11917     if (question->DisallowPID)
11918         LogInfo("InitCommonState: Query suppressed for %##s (%s), PID %d/ServiceID %d not allowed", question->qname.c,
11919             DNSTypeName(question->qtype), question->pid, question->ServiceID);
11920 
11921     question->NextInDQList      = mDNSNULL;
11922     question->SendQNow          = mDNSNULL;
11923     question->SendOnAll         = mDNSfalse;
11924     question->RequestUnicast    = kDefaultRequestUnicastCount;
11925 
11926 #if APPLE_OSX_mDNSResponder
11927     // Set the QU bit in the first query for the following options.
11928     if ((question->flags & kDNSServiceFlagsUnicastResponse) || (question->flags & kDNSServiceFlagsThresholdFinder))
11929     {
11930         question->RequestUnicast    = SET_QU_IN_FIRST_QUERY;
11931         LogInfo("InitCommonState: setting RequestUnicast = %d for %##s (%s)", question->RequestUnicast, question->qname.c,
11932             DNSTypeName(question->qtype));
11933     }
11934 #endif  // APPLE_OSX_mDNSResponder
11935 
11936     question->LastQTxTime       = m->timenow;
11937     question->CNAMEReferrals    = 0;
11938 
11939     question->WakeOnResolveCount = 0;
11940     if (question->WakeOnResolve)
11941     {
11942         question->WakeOnResolveCount = InitialWakeOnResolveCount;
11943     }
11944 
11945     for (i=0; i<DupSuppressInfoSize; i++)
11946         question->DupSuppress[i].InterfaceID = mDNSNULL;
11947 
11948     question->Restart = 0;
11949 
11950     debugf("InitCommonState: Question %##s (%s) Interface %p Now %d Send in %d Answer in %d (%p) %s (%p)",
11951             question->qname.c, DNSTypeName(question->qtype), question->InterfaceID, m->timenow,
11952             NextQSendTime(question) - m->timenow,
11953             question->DelayAnswering ? question->DelayAnswering - m->timenow : 0,
11954             question, question->DuplicateOf ? "duplicate of" : "not duplicate", question->DuplicateOf);
11955 
11956     if (question->DelayAnswering)
11957         LogInfo("InitCommonState: Delaying answering for %d ticks while cache stabilizes for %##s (%s)",
11958                  question->DelayAnswering - m->timenow, question->qname.c, DNSTypeName(question->qtype));
11959 }
11960 
11961 // Excludes the DNS Config fields which are already handled by InitDNSConfig()
11962 mDNSlocal void InitWABState(DNSQuestion *const question)
11963 {
11964     // We'll create our question->LocalSocket on demand, if needed.
11965     // We won't need one for duplicate questions, or from questions answered immediately out of the cache.
11966     // We also don't need one for LLQs because (when we're using NAT) we want them all to share a single
11967     // NAT mapping for receiving inbound add/remove events.
11968     question->LocalSocket       = mDNSNULL;
11969     question->unansweredQueries = 0;
11970     question->nta               = mDNSNULL;
11971     question->servAddr          = zeroAddr;
11972     question->servPort          = zeroIPPort;
11973     question->tcp               = mDNSNULL;
11974     question->NoAnswer          = NoAnswer_Normal;
11975 }
11976 
11977 mDNSlocal void InitLLQNATState(mDNS *const m)
11978 {
11979     // If we don't have our NAT mapping active, start it now
11980     if (!m->LLQNAT.clientCallback)
11981     {
11982         m->LLQNAT.Protocol       = NATOp_MapUDP;
11983         m->LLQNAT.IntPort        = m->UnicastPort4;
11984         m->LLQNAT.RequestedPort  = m->UnicastPort4;
11985         m->LLQNAT.clientCallback = LLQNATCallback;
11986         m->LLQNAT.clientContext  = (void*)1; // Means LLQ NAT Traversal just started
11987         mDNS_StartNATOperation_internal(m, &m->LLQNAT);
11988     }
11989 }
11990 
11991 mDNSlocal void InitLLQState(DNSQuestion *const question)
11992 {
11993     question->state             = LLQ_InitialRequest;
11994     question->ReqLease          = 0;
11995     question->expire            = 0;
11996     question->ntries            = 0;
11997     question->id                = zeroOpaque64;
11998 }
11999 
12000 #ifdef DNS_PUSH_ENABLED
12001 mDNSlocal void InitDNSPNState(DNSQuestion *const question)
12002 {
12003     question->dnsPushState = DNSPUSH_INIT;
12004 }
12005 #endif // DNS_PUSH_ENABLED
12006 
12007 // InitDNSSECProxyState() is called by mDNS_StartQuery_internal() to initialize
12008 // DNSSEC & DNS Proxy fields of the DNS Question.
12009 mDNSlocal void InitDNSSECProxyState(mDNS *const m, DNSQuestion *const question)
12010 {
12011     (void) m;
12012 
12013     // DNS server selection affects DNSSEC. Turn off validation if req_DO is not set
12014     // or the request is going over cellular interface.
12015     //
12016     // Note: This needs to be done here before we call FindDuplicateQuestion as it looks
12017     // at ValidationRequired setting also.
12018     if (question->qDNSServer)
12019     {
12020         if (question->qDNSServer->cellIntf)
12021         {
12022             debugf("InitDNSSECProxyState: Turning off validation for %##s (%s); going over cell", question->qname.c, DNSTypeName(question->qtype));
12023             question->ValidationRequired = mDNSfalse;
12024         }
12025         if (DNSSECOptionalQuestion(question) && !(question->qDNSServer->req_DO))
12026         {
12027             LogInfo("InitDNSSECProxyState: Turning off validation for %##s (%s); req_DO false",
12028                 question->qname.c, DNSTypeName(question->qtype));
12029             question->ValidationRequired = DNSSEC_VALIDATION_NONE;
12030         }
12031     }
12032     question->ValidationState = (question->ValidationRequired ? DNSSECValRequired : DNSSECValNotRequired);
12033     question->ValidationStatus = 0;
12034     question->responseFlags    = zeroID;
12035 }
12036 
12037 // Once the question is completely initialized including the duplicate logic, this function
12038 // is called to finalize the unicast question which requires flushing the cache if needed,
12039 // activating the query etc.
12040 mDNSlocal void FinalizeUnicastQuestion(mDNS *const m, DNSQuestion *question)
12041 {
12042     // Ensure DNS related info of duplicate question is same as the orig question
12043     if (question->DuplicateOf)
12044     {
12045         question->validDNSServers = question->DuplicateOf->validDNSServers;
12046         // If current(dup) question has DNS Server assigned but the original question has no DNS Server assigned to it,
12047         // then we log a line as it could indicate an issue
12048         if (question->DuplicateOf->qDNSServer == mDNSNULL)
12049         {
12050             if (question->qDNSServer)
12051                 LogInfo("FinalizeUnicastQuestion: Current(dup) question %p has DNSServer(%#a:%d) but original question(%p) has no DNS Server! %##s (%s)",
12052                         question, question->qDNSServer ? &question->qDNSServer->addr : mDNSNULL,
12053                         mDNSVal16(question->qDNSServer ? question->qDNSServer->port : zeroIPPort),
12054                         question->DuplicateOf, question->qname.c, DNSTypeName(question->qtype));
12055         }
12056         question->qDNSServer = question->DuplicateOf->qDNSServer;
12057         LogInfo("FinalizeUnicastQuestion: Duplicate question %p (%p) %##s (%s), DNS Server %#a:%d",
12058                  question, question->DuplicateOf, question->qname.c, DNSTypeName(question->qtype),
12059                  question->qDNSServer ? &question->qDNSServer->addr : mDNSNULL,
12060                  mDNSVal16(question->qDNSServer ? question->qDNSServer->port : zeroIPPort));
12061     }
12062 
12063     ActivateUnicastQuery(m, question, mDNSfalse);
12064 
12065     if (!question->DuplicateOf && DNSSECQuestion(question))
12066     {
12067         // For DNSSEC questions, we need to have the RRSIGs also for verification.
12068         CheckForDNSSECRecords(m, question);
12069     }
12070     if (question->LongLived)
12071     {
12072         // Unlike other initializations, InitLLQNATState should be done after
12073         // we determine that it is a unicast question.  LongLived is set for
12074         // both multicast and unicast browse questions but we should initialize
12075         // the LLQ NAT state only for unicast. Otherwise we will unnecessarily
12076         // start the NAT traversal that is not needed.
12077         InitLLQNATState(m);
12078 #if APPLE_OSX_mDNSResponder
12079         UpdateAutoTunnelDomainStatuses(m);
12080 #endif
12081     }
12082 }
12083 
12084 mDNSexport mStatus mDNS_StartQuery_internal(mDNS *const m, DNSQuestion *const question)
12085 {
12086     DNSQuestion **q;
12087     mStatus vStatus;
12088 
12089     // First check for cache space (can't do queries if there is no cache space allocated)
12090     if (m->rrcache_size == 0)
12091         return(mStatus_NoCache);
12092 
12093     vStatus = ValidateParameters(m, question);
12094     if (vStatus)
12095         return(vStatus);
12096 
12097 #ifdef USE_LIBIDN
12098     // If the TLD includes high-ascii bytes, assume it will need to be converted to Punycode.
12099     // (In the future the root name servers may answer UTF-8 queries directly, but for now they do not.)
12100     if (IsHighASCIILabel(LastLabel(&question->qname)))
12101     {
12102         domainname newname;
12103         if (PerformNextPunycodeConversion(question, &newname))
12104             AssignDomainName(&question->qname, &newname);
12105     }
12106 #endif // USE_LIBIDN
12107 
12108     question->TargetQID =
12109 #ifndef UNICAST_DISABLED
12110                           (question->Target.type || Question_uDNS(question)) ? mDNS_NewMessageID(m) :
12111 #endif // UNICAST_DISABLED
12112                           zeroID;
12113     debugf("mDNS_StartQuery_internal: %##s (%s)", question->qname.c, DNSTypeName(question->qtype));
12114 
12115     // Note: It important that new questions are appended at the *end* of the list, not prepended at the start
12116     q = &m->Questions;
12117     if (LocalOnlyOrP2PInterface(question->InterfaceID))
12118         q = &m->LocalOnlyQuestions;
12119     while (*q && *q != question)
12120         q=&(*q)->next;
12121 
12122     if (*q)
12123     {
12124         LogMsg("mDNS_StartQuery_internal: Error! Tried to add a question %##s (%s) %p that's already in the active list",
12125                 question->qname.c, DNSTypeName(question->qtype), question);
12126         return(mStatus_AlreadyRegistered);
12127     }
12128     *q = question;
12129 
12130     // Intialize the question. The only ordering constraint we have today is that
12131     // InitDNSSECProxyState should be called after the DNS server is selected (in
12132     // InitCommonState -> InitDNSConfig) as DNS server selection affects DNSSEC
12133     // validation.
12134 
12135     InitCommonState(m, question);
12136     InitWABState(question);
12137     InitLLQState(question);
12138 #ifdef DNS_PUSH_ENABLED
12139     InitDNSPNState(question);
12140 #endif // DNS_PUSH_ENABLED
12141     InitDNSSECProxyState(m, question);
12142 
12143     // FindDuplicateQuestion should be called last after all the intialization
12144     // as the duplicate logic could be potentially based on any field in the
12145     // question.
12146     question->DuplicateOf  = FindDuplicateQuestion(m, question);
12147     if (question->DuplicateOf)
12148         question->AuthInfo = question->DuplicateOf->AuthInfo;
12149 
12150     if (LocalOnlyOrP2PInterface(question->InterfaceID))
12151     {
12152         if (!m->NewLocalOnlyQuestions)
12153             m->NewLocalOnlyQuestions = question;
12154     }
12155     else
12156     {
12157         if (!m->NewQuestions)
12158             m->NewQuestions = question;
12159 
12160         // If the question's id is non-zero, then it's Wide Area
12161         // MUST NOT do this Wide Area setup until near the end of
12162         // mDNS_StartQuery_internal -- this code may itself issue queries (e.g. SOA,
12163         // NS, etc.) and if we haven't finished setting up our own question and setting
12164         // m->NewQuestions if necessary then we could end up recursively re-entering
12165         // this routine with the question list data structures in an inconsistent state.
12166         if (!mDNSOpaque16IsZero(question->TargetQID))
12167         {
12168             FinalizeUnicastQuestion(m, question);
12169         }
12170         else
12171         {
12172 #if BONJOUR_ON_DEMAND
12173             m->NumAllInterfaceQuestions++;
12174             LogInfo("mDNS_StartQuery_internal: NumAllInterfaceRecords %d NumAllInterfaceQuestions %d %##s (%s)",
12175                 m->NumAllInterfaceRecords, m->NumAllInterfaceQuestions, question->qname.c, DNSTypeName(question->qtype));
12176             if (m->NumAllInterfaceRecords + m->NumAllInterfaceQuestions == 1)
12177             {
12178                 m->NextBonjourDisableTime = 0;
12179                 if (m->BonjourEnabled == 0)
12180                 {
12181                     // Enable Bonjour immediately by scheduling network changed processing where
12182                     // we will join the multicast group on each active interface.
12183                     m->BonjourEnabled = 1;
12184                     m->NetworkChanged = m->timenow;
12185                 }
12186             }
12187 #endif // BONJOUR_ON_DEMAND
12188             if (question->WakeOnResolve)
12189             {
12190                 LogInfo("mDNS_StartQuery_internal: Purging for %##s", question->qname.c);
12191                 mDNS_PurgeBeforeResolve(m, question);
12192             }
12193         }
12194     }
12195 
12196     return(mStatus_NoError);
12197 }
12198 
12199 // CancelGetZoneData is an internal routine (i.e. must be called with the lock already held)
12200 mDNSexport void CancelGetZoneData(mDNS *const m, ZoneData *nta)
12201 {
12202     debugf("CancelGetZoneData %##s (%s)", nta->question.qname.c, DNSTypeName(nta->question.qtype));
12203     // This function may be called anytime to free the zone information.The question may or may not have stopped.
12204     // If it was already stopped, mDNS_StopQuery_internal would have set q->ThisQInterval to -1 and should not
12205     // call it again
12206     if (nta->question.ThisQInterval != -1)
12207     {
12208         mDNS_StopQuery_internal(m, &nta->question);
12209         if (nta->question.ThisQInterval != -1)
12210             LogMsg("CancelGetZoneData: Question %##s (%s) ThisQInterval %d not -1", nta->question.qname.c, DNSTypeName(nta->question.qtype), nta->question.ThisQInterval);
12211     }
12212     mDNSPlatformMemFree(nta);
12213 }
12214 
12215 mDNSexport mStatus mDNS_StopQuery_internal(mDNS *const m, DNSQuestion *const question)
12216 {
12217     CacheGroup *cg = CacheGroupForName(m, question->qnamehash, &question->qname);
12218     CacheRecord *rr;
12219     DNSQuestion **qp = &m->Questions;
12220 
12221     //LogInfo("mDNS_StopQuery_internal %##s (%s)", question->qname.c, DNSTypeName(question->qtype));
12222 
12223     if (LocalOnlyOrP2PInterface(question->InterfaceID))
12224         qp = &m->LocalOnlyQuestions;
12225     while (*qp && *qp != question) qp=&(*qp)->next;
12226     if (*qp) *qp = (*qp)->next;
12227     else
12228     {
12229 #if !ForceAlerts
12230         if (question->ThisQInterval >= 0)   // Only log error message if the query was supposed to be active
12231 #endif
12232         LogFatalError("mDNS_StopQuery_internal: Question %##s (%s) not found in active list", question->qname.c, DNSTypeName(question->qtype));
12233         return(mStatus_BadReferenceErr);
12234     }
12235 
12236 #if BONJOUR_ON_DEMAND
12237     if (!LocalOnlyOrP2PInterface(question->InterfaceID) && mDNSOpaque16IsZero(question->TargetQID))
12238     {
12239         if (m->NumAllInterfaceRecords + m->NumAllInterfaceQuestions == 1)
12240             m->NextBonjourDisableTime = NonZeroTime(m->timenow + (BONJOUR_DISABLE_DELAY * mDNSPlatformOneSecond));
12241         m->NumAllInterfaceQuestions--;
12242         LogInfo("mDNS_StopQuery_internal:  NumAllInterfaceRecords %d NumAllInterfaceQuestions %d %##s (%s)",
12243             m->NumAllInterfaceRecords, m->NumAllInterfaceQuestions, question->qname.c, DNSTypeName(question->qtype));
12244     }
12245 #endif // BONJOUR_ON_DEMAND
12246 
12247 #if AWD_METRICS
12248     if (Question_uDNS(question) && !question->metrics.answered && (question->metrics.querySendCount > 0))
12249     {
12250         const domainname *  queryName;
12251         mDNSBool            isForCell;
12252         mDNSu32             durationMs;
12253 
12254         queryName  = question->metrics.originalQName ? question->metrics.originalQName : &question->qname;
12255         isForCell  = (question->qDNSServer && question->qDNSServer->cellIntf);
12256         durationMs = ((m->timenow - question->metrics.firstQueryTime) * 1000) / mDNSPlatformOneSecond;
12257         MetricsUpdateDNSQueryStats(queryName, question->qtype, mDNSNULL, question->metrics.querySendCount, question->metrics.expiredAnswerState, durationMs, isForCell);
12258     }
12259 #endif
12260     // Take care to cut question from list *before* calling UpdateQuestionDuplicates
12261     UpdateQuestionDuplicates(m, question);
12262     // But don't trash ThisQInterval until afterwards.
12263     question->ThisQInterval = -1;
12264 
12265     // If there are any cache records referencing this as their active question, then see if there is any
12266     // other question that is also referencing them, else their CRActiveQuestion needs to get set to NULL.
12267     for (rr = cg ? cg->members : mDNSNULL; rr; rr=rr->next)
12268     {
12269         if (rr->CRActiveQuestion == question)
12270         {
12271             DNSQuestion *q;
12272             DNSQuestion *replacement = mDNSNULL;
12273             // If we find an active question that is answered by this cached record, use it as the cache record's
12274             // CRActiveQuestion replacement. If there are no such questions, but there's at least one unsuppressed inactive
12275             // question that is answered by this cache record, then use an inactive one to not forgo generating RMV events
12276             // via CacheRecordRmv() when the cache record expires.
12277             for (q = m->Questions; q && (q != m->NewQuestions); q = q->next)
12278             {
12279                 if (!q->DuplicateOf && !QuerySuppressed(q) && ResourceRecordAnswersQuestion(&rr->resrec, q))
12280                 {
12281                     if (q->ThisQInterval > 0)
12282                     {
12283                         replacement = q;
12284                         break;
12285                     }
12286                     else if (!replacement)
12287                     {
12288                         replacement = q;
12289                     }
12290                 }
12291             }
12292             if (replacement)
12293                 debugf("mDNS_StopQuery_internal: Updating CRActiveQuestion to %p for cache record %s, Original question CurrentAnswers %d, new question "
12294                        "CurrentAnswers %d, SuppressQuery %d", replacement, CRDisplayString(m,rr), question->CurrentAnswers, replacement->CurrentAnswers, replacement->SuppressQuery);
12295             rr->CRActiveQuestion = replacement;    // Question used to be active; new value may or may not be null
12296             if (!replacement) m->rrcache_active--; // If no longer active, decrement rrcache_active count
12297         }
12298     }
12299 
12300     // If we just deleted the question that CacheRecordAdd() or CacheRecordRmv() is about to look at,
12301     // bump its pointer forward one question.
12302     if (m->CurrentQuestion == question)
12303     {
12304         debugf("mDNS_StopQuery_internal: Just deleted the currently active question: %##s (%s)",
12305                question->qname.c, DNSTypeName(question->qtype));
12306         m->CurrentQuestion = question->next;
12307     }
12308 
12309     if (m->NewQuestions == question)
12310     {
12311         debugf("mDNS_StopQuery_internal: Just deleted a new question that wasn't even answered yet: %##s (%s)",
12312                question->qname.c, DNSTypeName(question->qtype));
12313         m->NewQuestions = question->next;
12314     }
12315 
12316     if (m->NewLocalOnlyQuestions == question) m->NewLocalOnlyQuestions = question->next;
12317 
12318     if (m->RestartQuestion == question)
12319     {
12320         LogMsg("mDNS_StopQuery_internal: Just deleted the current restart question: %##s (%s)",
12321                question->qname.c, DNSTypeName(question->qtype));
12322         m->RestartQuestion = question->next;
12323     }
12324 
12325     if (m->ValidationQuestion == question)
12326     {
12327         LogInfo("mDNS_StopQuery_internal: Just deleted the current Validation question: %##s (%s)",
12328                question->qname.c, DNSTypeName(question->qtype));
12329         m->ValidationQuestion = question->next;
12330     }
12331 
12332     // Take care not to trash question->next until *after* we've updated m->CurrentQuestion and m->NewQuestions
12333     question->next = mDNSNULL;
12334 
12335     // LogMsg("mDNS_StopQuery_internal: Question %##s (%s) removed", question->qname.c, DNSTypeName(question->qtype));
12336 
12337     // And finally, cancel any associated GetZoneData operation that's still running.
12338     // Must not do this until last, because there's a good chance the GetZoneData question is the next in the list,
12339     // so if we delete it earlier in this routine, we could find that our "question->next" pointer above is already
12340     // invalid before we even use it. By making sure that we update m->CurrentQuestion and m->NewQuestions if necessary
12341     // *first*, then they're all ready to be updated a second time if necessary when we cancel our GetZoneData query.
12342     if (question->tcp) { DisposeTCPConn(question->tcp); question->tcp = mDNSNULL; }
12343     if (question->LocalSocket) { mDNSPlatformUDPClose(question->LocalSocket); question->LocalSocket = mDNSNULL; }
12344     if (!mDNSOpaque16IsZero(question->TargetQID) && question->LongLived)
12345     {
12346         // Scan our list to see if any more wide-area LLQs remain. If not, stop our NAT Traversal.
12347         DNSQuestion *q;
12348         for (q = m->Questions; q; q=q->next)
12349             if (!mDNSOpaque16IsZero(q->TargetQID) && q->LongLived) break;
12350         if (!q)
12351         {
12352             if (!m->LLQNAT.clientCallback)       // Should never happen, but just in case...
12353             {
12354                 LogMsg("mDNS_StopQuery ERROR LLQNAT.clientCallback NULL");
12355             }
12356             else
12357             {
12358                 LogInfo("Stopping LLQNAT");
12359                 mDNS_StopNATOperation_internal(m, &m->LLQNAT);
12360                 m->LLQNAT.clientCallback = mDNSNULL; // Means LLQ NAT Traversal not running
12361             }
12362         }
12363 
12364         // If necessary, tell server it can delete this LLQ state
12365         if (question->state == LLQ_Established)
12366         {
12367             question->ReqLease = 0;
12368             sendLLQRefresh(m, question);
12369             // If we need need to make a TCP connection to cancel the LLQ, that's going to take a little while.
12370             // We clear the tcp->question backpointer so that when the TCP connection completes, it doesn't
12371             // crash trying to access our cancelled question, but we don't cancel the TCP operation itself --
12372             // we let that run out its natural course and complete asynchronously.
12373             if (question->tcp)
12374             {
12375                 question->tcp->question = mDNSNULL;
12376                 question->tcp           = mDNSNULL;
12377             }
12378         }
12379 #ifdef DNS_PUSH_ENABLED
12380         else if (question->dnsPushState == DNSPUSH_ESTABLISHED)
12381         {
12382             if (question->tcp)
12383             {
12384                 UnSubscribeToDNSPushNotificationServer(m, q);
12385                 question->tcp->question = mDNSNULL;
12386                 question->tcp           = mDNSNULL;
12387             }
12388         }
12389 #endif // DNS_PUSH_ENABLED
12390 #if APPLE_OSX_mDNSResponder
12391         UpdateAutoTunnelDomainStatuses(m);
12392 #endif
12393     }
12394     // wait until we send the refresh above which needs the nta
12395     if (question->nta) { CancelGetZoneData(m, question->nta); question->nta = mDNSNULL; }
12396 
12397     if (question->ValidationRequired && question->DNSSECAuthInfo)
12398     {
12399         LogInfo("mDNS_StopQuery_internal: freeing DNSSECAuthInfo %##s", question->qname.c);
12400         question->DAIFreeCallback(m, question->DNSSECAuthInfo);
12401         question->DNSSECAuthInfo = mDNSNULL;
12402     }
12403     if (question->AnonInfo)
12404     {
12405         FreeAnonInfo(question->AnonInfo);
12406         question->AnonInfo = mDNSNULL;
12407     }
12408 #if AWD_METRICS
12409     if (question->metrics.originalQName)
12410     {
12411         mDNSPlatformMemFree(question->metrics.originalQName);
12412         question->metrics.originalQName = mDNSNULL;
12413     }
12414 #endif
12415 
12416 #if USE_DNS64
12417     DNS64ResetState(question);
12418 #endif
12419 
12420     return(mStatus_NoError);
12421 }
12422 
12423 mDNSexport mStatus mDNS_StartQuery(mDNS *const m, DNSQuestion *const question)
12424 {
12425     mStatus status;
12426     mDNS_Lock(m);
12427     status = mDNS_StartQuery_internal(m, question);
12428     mDNS_Unlock(m);
12429     return(status);
12430 }
12431 
12432 mDNSexport mStatus mDNS_StopQuery(mDNS *const m, DNSQuestion *const question)
12433 {
12434     mStatus status;
12435     mDNS_Lock(m);
12436     status = mDNS_StopQuery_internal(m, question);
12437     mDNS_Unlock(m);
12438     return(status);
12439 }
12440 
12441 // Note that mDNS_StopQueryWithRemoves() does not currently implement the full generality of the other APIs
12442 // Specifically, question callbacks invoked as a result of this call cannot themselves make API calls.
12443 // We invoke the callback without using mDNS_DropLockBeforeCallback/mDNS_ReclaimLockAfterCallback
12444 // specifically to catch and report if the client callback does try to make API calls
12445 mDNSexport mStatus mDNS_StopQueryWithRemoves(mDNS *const m, DNSQuestion *const question)
12446 {
12447     mStatus status;
12448     DNSQuestion *qq;
12449     mDNS_Lock(m);
12450 
12451     // Check if question is new -- don't want to give remove events for a question we haven't even answered yet
12452     for (qq = m->NewQuestions; qq; qq=qq->next) if (qq == question) break;
12453 
12454     status = mDNS_StopQuery_internal(m, question);
12455     if (status == mStatus_NoError && !qq)
12456     {
12457         const CacheRecord *rr;
12458         CacheGroup *const cg = CacheGroupForName(m, question->qnamehash, &question->qname);
12459         LogInfo("Generating terminal removes for %##s (%s)", question->qname.c, DNSTypeName(question->qtype));
12460         for (rr = cg ? cg->members : mDNSNULL; rr; rr=rr->next)
12461             if (rr->resrec.RecordType != kDNSRecordTypePacketNegative && SameNameRecordAnswersQuestion(&rr->resrec, question))
12462             {
12463                 // Don't use mDNS_DropLockBeforeCallback() here, since we don't allow API calls
12464                 if (question->QuestionCallback)
12465                     question->QuestionCallback(m, question, &rr->resrec, QC_rmv);
12466             }
12467     }
12468     mDNS_Unlock(m);
12469     return(status);
12470 }
12471 
12472 mDNSexport mStatus mDNS_Reconfirm(mDNS *const m, CacheRecord *const cr)
12473 {
12474     mStatus status;
12475     mDNS_Lock(m);
12476     status = mDNS_Reconfirm_internal(m, cr, kDefaultReconfirmTimeForNoAnswer);
12477     if (status == mStatus_NoError) ReconfirmAntecedents(m, cr->resrec.name, cr->resrec.namehash, cr->resrec.InterfaceID, 0);
12478     mDNS_Unlock(m);
12479     return(status);
12480 }
12481 
12482 mDNSexport mStatus mDNS_ReconfirmByValue(mDNS *const m, ResourceRecord *const rr)
12483 {
12484     mStatus status = mStatus_BadReferenceErr;
12485     CacheRecord *cr;
12486     mDNS_Lock(m);
12487     cr = FindIdenticalRecordInCache(m, rr);
12488     debugf("mDNS_ReconfirmByValue: %p %s", cr, RRDisplayString(m, rr));
12489     if (cr) status = mDNS_Reconfirm_internal(m, cr, kDefaultReconfirmTimeForNoAnswer);
12490     if (status == mStatus_NoError) ReconfirmAntecedents(m, cr->resrec.name, cr->resrec.namehash, cr->resrec.InterfaceID, 0);
12491     mDNS_Unlock(m);
12492     return(status);
12493 }
12494 
12495 mDNSlocal mStatus mDNS_StartBrowse_internal(mDNS *const m, DNSQuestion *const question,
12496                                             const domainname *const srv, const domainname *const domain,
12497                                             const mDNSu8 *anondata, const mDNSInterfaceID InterfaceID, mDNSu32 flags,
12498                                             mDNSBool ForceMCast, mDNSBool useBackgroundTrafficClass,
12499                                             mDNSQuestionCallback *Callback, void *Context)
12500 {
12501     question->InterfaceID      = InterfaceID;
12502     question->flags            = flags;
12503     question->Target           = zeroAddr;
12504     question->qtype            = kDNSType_PTR;
12505     question->qclass           = kDNSClass_IN;
12506     question->LongLived        = mDNStrue;
12507     question->ExpectUnique     = mDNSfalse;
12508     question->ForceMCast       = ForceMCast;
12509     question->ReturnIntermed   = (flags & kDNSServiceFlagsReturnIntermediates) != 0;
12510     question->SuppressUnusable = mDNSfalse;
12511     question->SearchListIndex  = 0;
12512     question->AppendSearchDomains = 0;
12513     question->RetryWithSearchDomains = mDNSfalse;
12514     question->TimeoutQuestion  = 0;
12515     question->WakeOnResolve    = 0;
12516     question->UseBackgroundTrafficClass = useBackgroundTrafficClass;
12517     question->ValidationRequired = 0;
12518     question->ValidatingResponse = 0;
12519     question->ProxyQuestion    = 0;
12520     question->qnameOrig        = mDNSNULL;
12521     question->AnonInfo         = mDNSNULL;
12522     question->QuestionCallback = Callback;
12523     question->QuestionContext  = Context;
12524 
12525     if (!ConstructServiceName(&question->qname, mDNSNULL, srv, domain))
12526         return(mStatus_BadParamErr);
12527 
12528     if (anondata)
12529     {
12530         question->AnonInfo = AllocateAnonInfo(&question->qname, anondata, mDNSPlatformStrLen(anondata), mDNSNULL);
12531         if (!question->AnonInfo)
12532             return(mStatus_BadParamErr);
12533     }
12534 
12535     return(mDNS_StartQuery_internal(m, question));
12536 }
12537 
12538 mDNSexport mStatus mDNS_StartBrowse(mDNS *const m, DNSQuestion *const question,
12539                                     const domainname *const srv, const domainname *const domain,
12540                                     const mDNSu8 *anondata, const mDNSInterfaceID InterfaceID, mDNSu32 flags,
12541                                     mDNSBool ForceMCast, mDNSBool useBackgroundTrafficClass,
12542                                     mDNSQuestionCallback *Callback, void *Context)
12543 {
12544     mStatus status;
12545     mDNS_Lock(m);
12546     status = mDNS_StartBrowse_internal(m, question, srv, domain, anondata, InterfaceID, flags, ForceMCast, useBackgroundTrafficClass, Callback, Context);
12547     mDNS_Unlock(m);
12548     return(status);
12549 }
12550 
12551 
12552 mDNSexport mStatus mDNS_GetDomains(mDNS *const m, DNSQuestion *const question, mDNS_DomainType DomainType, const domainname *dom,
12553                                    const mDNSInterfaceID InterfaceID, mDNSQuestionCallback *Callback, void *Context)
12554 {
12555     question->InterfaceID      = InterfaceID;
12556     question->flags            = 0;
12557     question->Target           = zeroAddr;
12558     question->qtype            = kDNSType_PTR;
12559     question->qclass           = kDNSClass_IN;
12560     question->LongLived        = mDNSfalse;
12561     question->ExpectUnique     = mDNSfalse;
12562     question->ForceMCast       = mDNSfalse;
12563     question->ReturnIntermed   = mDNSfalse;
12564     question->SuppressUnusable = mDNSfalse;
12565     question->SearchListIndex  = 0;
12566     question->AppendSearchDomains = 0;
12567     question->RetryWithSearchDomains = mDNSfalse;
12568     question->TimeoutQuestion  = 0;
12569     question->WakeOnResolve    = 0;
12570     question->UseBackgroundTrafficClass = mDNSfalse;
12571     question->ValidationRequired = 0;
12572     question->ValidatingResponse = 0;
12573     question->ProxyQuestion    = 0;
12574     question->qnameOrig        = mDNSNULL;
12575     question->AnonInfo         = mDNSNULL;
12576     question->pid              = mDNSPlatformGetPID();
12577     question->euid             = 0;
12578     question->QuestionCallback = Callback;
12579     question->QuestionContext  = Context;
12580     if (DomainType > mDNS_DomainTypeMax) return(mStatus_BadParamErr);
12581     if (!MakeDomainNameFromDNSNameString(&question->qname, mDNS_DomainTypeNames[DomainType])) return(mStatus_BadParamErr);
12582     if (!dom) dom = &localdomain;
12583     if (!AppendDomainName(&question->qname, dom)) return(mStatus_BadParamErr);
12584     return(mDNS_StartQuery(m, question));
12585 }
12586 
12587 // ***************************************************************************
12588 #if COMPILER_LIKES_PRAGMA_MARK
12589 #pragma mark -
12590 #pragma mark - Responder Functions
12591 #endif
12592 
12593 mDNSexport mStatus mDNS_Register(mDNS *const m, AuthRecord *const rr)
12594 {
12595     mStatus status;
12596     mDNS_Lock(m);
12597     status = mDNS_Register_internal(m, rr);
12598     mDNS_Unlock(m);
12599     return(status);
12600 }
12601 
12602 mDNSexport mStatus mDNS_Update(mDNS *const m, AuthRecord *const rr, mDNSu32 newttl,
12603                                const mDNSu16 newrdlength, RData *const newrdata, mDNSRecordUpdateCallback *Callback)
12604 {
12605     if (!ValidateRData(rr->resrec.rrtype, newrdlength, newrdata))
12606     {
12607         LogMsg("Attempt to update record with invalid rdata: %s", GetRRDisplayString_rdb(&rr->resrec, &newrdata->u, m->MsgBuffer));
12608         return(mStatus_Invalid);
12609     }
12610 
12611     mDNS_Lock(m);
12612 
12613     // If TTL is unspecified, leave TTL unchanged
12614     if (newttl == 0) newttl = rr->resrec.rroriginalttl;
12615 
12616     // If we already have an update queued up which has not gone through yet, give the client a chance to free that memory
12617     if (rr->NewRData)
12618     {
12619         RData *n = rr->NewRData;
12620         rr->NewRData = mDNSNULL;                            // Clear the NewRData pointer ...
12621         if (rr->UpdateCallback)
12622             rr->UpdateCallback(m, rr, n, rr->newrdlength);  // ...and let the client free this memory, if necessary
12623     }
12624 
12625     rr->NewRData             = newrdata;
12626     rr->newrdlength          = newrdlength;
12627     rr->UpdateCallback       = Callback;
12628 
12629 #ifndef UNICAST_DISABLED
12630     if (rr->ARType != AuthRecordLocalOnly && rr->ARType != AuthRecordP2P && !IsLocalDomain(rr->resrec.name))
12631     {
12632         mStatus status = uDNS_UpdateRecord(m, rr);
12633         // The caller frees the memory on error, don't retain stale pointers
12634         if (status != mStatus_NoError) { rr->NewRData = mDNSNULL; rr->newrdlength = 0; }
12635         mDNS_Unlock(m);
12636         return(status);
12637     }
12638 #endif
12639 
12640     if (RRLocalOnly(rr) || (rr->resrec.rroriginalttl == newttl &&
12641                             rr->resrec.rdlength == newrdlength && mDNSPlatformMemSame(rr->resrec.rdata->u.data, newrdata->u.data, newrdlength)))
12642         CompleteRDataUpdate(m, rr);
12643     else
12644     {
12645         rr->AnnounceCount = InitialAnnounceCount;
12646         InitializeLastAPTime(m, rr);
12647         while (rr->NextUpdateCredit && m->timenow - rr->NextUpdateCredit >= 0) GrantUpdateCredit(rr);
12648         if (!rr->UpdateBlocked && rr->UpdateCredits) rr->UpdateCredits--;
12649         if (!rr->NextUpdateCredit) rr->NextUpdateCredit = NonZeroTime(m->timenow + kUpdateCreditRefreshInterval);
12650         if (rr->AnnounceCount > rr->UpdateCredits + 1) rr->AnnounceCount = (mDNSu8)(rr->UpdateCredits + 1);
12651         if (rr->UpdateCredits <= 5)
12652         {
12653             mDNSu32 delay = 6 - rr->UpdateCredits;      // Delay 1 second, then 2, then 3, etc. up to 6 seconds maximum
12654             if (!rr->UpdateBlocked) rr->UpdateBlocked = NonZeroTime(m->timenow + (mDNSs32)delay * mDNSPlatformOneSecond);
12655             rr->ThisAPInterval *= 4;
12656             rr->LastAPTime = rr->UpdateBlocked - rr->ThisAPInterval;
12657             LogMsg("Excessive update rate for %##s; delaying announcement by %ld second%s",
12658                    rr->resrec.name->c, delay, delay > 1 ? "s" : "");
12659         }
12660         rr->resrec.rroriginalttl = newttl;
12661     }
12662 
12663     mDNS_Unlock(m);
12664     return(mStatus_NoError);
12665 }
12666 
12667 // Note: mDNS_Deregister calls mDNS_Deregister_internal which can call a user callback, which may change
12668 // the record list and/or question list.
12669 // Any code walking either list must use the CurrentQuestion and/or CurrentRecord mechanism to protect against this.
12670 mDNSexport mStatus mDNS_Deregister(mDNS *const m, AuthRecord *const rr)
12671 {
12672     mStatus status;
12673     mDNS_Lock(m);
12674     status = mDNS_Deregister_internal(m, rr, mDNS_Dereg_normal);
12675     mDNS_Unlock(m);
12676     return(status);
12677 }
12678 
12679 // Circular reference: AdvertiseInterface references mDNS_HostNameCallback, which calls mDNS_SetFQDN, which call AdvertiseInterface
12680 mDNSlocal void mDNS_HostNameCallback(mDNS *const m, AuthRecord *const rr, mStatus result);
12681 
12682 mDNSlocal NetworkInterfaceInfo *FindFirstAdvertisedInterface(mDNS *const m)
12683 {
12684     NetworkInterfaceInfo *intf;
12685     for (intf = m->HostInterfaces; intf; intf = intf->next)
12686         if (intf->Advertise) break;
12687     return(intf);
12688 }
12689 
12690 // The parameter "set" here refers to the set of AuthRecords used to advertise this interface.
12691 // (It's a set of records, not a set of interfaces.)
12692 mDNSlocal void AdvertiseInterface(mDNS *const m, NetworkInterfaceInfo *set)
12693 {
12694     char buffer[MAX_REVERSE_MAPPING_NAME];
12695     NetworkInterfaceInfo *primary;
12696     mDNSu8 recordType;
12697 
12698     if (m->AutoTargetServices == 0)
12699     {
12700         LogInfo("AdvertiseInterface: Returning due to AutoTargetServices zero for %s", set->ifname);
12701         return;
12702     }
12703 
12704     primary = FindFirstAdvertisedInterface(m);
12705     if (!primary) primary = set; // If no existing advertised interface, this new NetworkInterfaceInfo becomes our new primary
12706     // We should never have primary be NULL, because even if there is
12707     // no other interface yet, we should always find ourself in the list.
12708 
12709     // If interface is marked as a direct link, we can assume the address record is unique
12710     // and does not need to go through the probe phase of the probe/announce packet sequence.
12711     recordType = (set->DirectLink ? kDNSRecordTypeKnownUnique : kDNSRecordTypeUnique);
12712 
12713     if (set->DirectLink)
12714         LogInfo("AdvertiseInterface: Marking address record as kDNSRecordTypeKnownUnique for %s", set->ifname);
12715 
12716     // Send dynamic update for non-linklocal IPv4 Addresses
12717     mDNS_SetupResourceRecord(&set->RR_A,     mDNSNULL, set->InterfaceID, kDNSType_A,     kHostNameTTL, recordType,                AuthRecordAny, mDNS_HostNameCallback, set);
12718     mDNS_SetupResourceRecord(&set->RR_PTR,   mDNSNULL, set->InterfaceID, kDNSType_PTR,   kHostNameTTL, kDNSRecordTypeKnownUnique, AuthRecordAny, mDNSNULL,              mDNSNULL);
12719     mDNS_SetupResourceRecord(&set->RR_HINFO, mDNSNULL, set->InterfaceID, kDNSType_HINFO, kHostNameTTL, kDNSRecordTypeUnique,      AuthRecordAny, mDNSNULL,              mDNSNULL);
12720 
12721 #if ANSWER_REMOTE_HOSTNAME_QUERIES
12722     set->RR_A.AllowRemoteQuery  = mDNStrue;
12723     set->RR_PTR.AllowRemoteQuery  = mDNStrue;
12724     set->RR_HINFO.AllowRemoteQuery  = mDNStrue;
12725 #endif
12726     // 1. Set up Address record to map from host name ("foo.local.") to IP address
12727     // 2. Set up reverse-lookup PTR record to map from our address back to our host name
12728     AssignDomainName(&set->RR_A.namestorage, &m->MulticastHostname);
12729     if (set->ip.type == mDNSAddrType_IPv4)
12730     {
12731         set->RR_A.resrec.rrtype = kDNSType_A;
12732         set->RR_A.resrec.rdata->u.ipv4 = set->ip.ip.v4;
12733         // Note: This is reverse order compared to a normal dotted-decimal IP address, so we can't use our customary "%.4a" format code
12734         mDNS_snprintf(buffer, sizeof(buffer), "%d.%d.%d.%d.in-addr.arpa.",
12735                       set->ip.ip.v4.b[3], set->ip.ip.v4.b[2], set->ip.ip.v4.b[1], set->ip.ip.v4.b[0]);
12736     }
12737     else if (set->ip.type == mDNSAddrType_IPv6)
12738     {
12739         int i;
12740         set->RR_A.resrec.rrtype = kDNSType_AAAA;
12741         set->RR_A.resrec.rdata->u.ipv6 = set->ip.ip.v6;
12742         for (i = 0; i < 16; i++)
12743         {
12744             static const char hexValues[] = "0123456789ABCDEF";
12745             buffer[i * 4    ] = hexValues[set->ip.ip.v6.b[15 - i] & 0x0F];
12746             buffer[i * 4 + 1] = '.';
12747             buffer[i * 4 + 2] = hexValues[set->ip.ip.v6.b[15 - i] >> 4];
12748             buffer[i * 4 + 3] = '.';
12749         }
12750         mDNS_snprintf(&buffer[64], sizeof(buffer)-64, "ip6.arpa.");
12751     }
12752 
12753     MakeDomainNameFromDNSNameString(&set->RR_PTR.namestorage, buffer);
12754     set->RR_PTR.AutoTarget = Target_AutoHost;   // Tell mDNS that the target of this PTR is to be kept in sync with our host name
12755     set->RR_PTR.ForceMCast = mDNStrue;          // This PTR points to our dot-local name, so don't ever try to write it into a uDNS server
12756 
12757     set->RR_A.RRSet = &primary->RR_A;           // May refer to self
12758 
12759     mDNS_Register_internal(m, &set->RR_A);
12760     mDNS_Register_internal(m, &set->RR_PTR);
12761 
12762 #if APPLE_OSX_mDNSResponder
12763     // must be after the mDNS_Register_internal() calls so that records have complete rdata fields, etc
12764     D2D_start_advertising_interface(set);
12765 #endif // APPLE_OSX_mDNSResponder
12766 
12767     if (!NO_HINFO && m->HIHardware.c[0] > 0 && m->HISoftware.c[0] > 0 && m->HIHardware.c[0] + m->HISoftware.c[0] <= 254)
12768     {
12769         mDNSu8 *p = set->RR_HINFO.resrec.rdata->u.data;
12770         AssignDomainName(&set->RR_HINFO.namestorage, &m->MulticastHostname);
12771         set->RR_HINFO.DependentOn = &set->RR_A;
12772         mDNSPlatformMemCopy(p, &m->HIHardware, 1 + (mDNSu32)m->HIHardware.c[0]);
12773         p += 1 + (int)p[0];
12774         mDNSPlatformMemCopy(p, &m->HISoftware, 1 + (mDNSu32)m->HISoftware.c[0]);
12775         mDNS_Register_internal(m, &set->RR_HINFO);
12776     }
12777     else
12778     {
12779         debugf("Not creating HINFO record: platform support layer provided no information");
12780         set->RR_HINFO.resrec.RecordType = kDNSRecordTypeUnregistered;
12781     }
12782 }
12783 
12784 mDNSlocal void DeadvertiseInterface(mDNS *const m, NetworkInterfaceInfo *set)
12785 {
12786     if (m->AutoTargetServices == 0)
12787     {
12788         LogInfo("DeadvertiseInterface: Returning due to AutoTargetServices zero for %s", set->ifname);
12789         return;
12790     }
12791 
12792 #if APPLE_OSX_mDNSResponder
12793     D2D_stop_advertising_interface(set);
12794 #endif // APPLE_OSX_mDNSResponder
12795 
12796     // Unregister these records.
12797     // When doing the mDNS_Exit processing, we first call DeadvertiseInterface for each interface, so by the time the platform
12798     // support layer gets to call mDNS_DeregisterInterface, the address and PTR records have already been deregistered for it.
12799     // Also, in the event of a name conflict, one or more of our records will have been forcibly deregistered.
12800     // To avoid unnecessary and misleading warning messages, we check the RecordType before calling mDNS_Deregister_internal().
12801     if (set->RR_A    .resrec.RecordType) mDNS_Deregister_internal(m, &set->RR_A,     mDNS_Dereg_normal);
12802     if (set->RR_PTR  .resrec.RecordType) mDNS_Deregister_internal(m, &set->RR_PTR,   mDNS_Dereg_normal);
12803     if (set->RR_HINFO.resrec.RecordType) mDNS_Deregister_internal(m, &set->RR_HINFO, mDNS_Dereg_normal);
12804 }
12805 
12806 mDNSlocal void AdvertiseAllInterfaceRecords(mDNS *const m)
12807 {
12808     NetworkInterfaceInfo *intf;
12809     for (intf = m->HostInterfaces; intf; intf = intf->next)
12810     {
12811         if (intf->Advertise)
12812         {
12813             LogInfo("AdvertiseInterface: Advertising for ifname %s", intf->ifname);
12814             AdvertiseInterface(m, intf);
12815         }
12816     }
12817 }
12818 
12819 mDNSlocal void DeadvertiseAllInterfaceRecords(mDNS *const m)
12820 {
12821     NetworkInterfaceInfo *intf;
12822     for (intf = m->HostInterfaces; intf; intf = intf->next)
12823     {
12824         if (intf->Advertise)
12825         {
12826             LogInfo("DeadvertiseInterface: Deadvertising for ifname %s", intf->ifname);
12827             DeadvertiseInterface(m, intf);
12828         }
12829     }
12830 }
12831 
12832 // Change target host name for record.
12833 mDNSlocal void UpdateTargetHostName(mDNS *const m, AuthRecord *const rr)
12834 {
12835 #if APPLE_OSX_mDNSResponder
12836         // If this record was also registered with any D2D plugins, stop advertising
12837         // the version with the old host name.
12838         D2D_stop_advertising_record(rr);
12839 #endif
12840 
12841     SetTargetToHostName(m, rr);
12842 
12843 #if APPLE_OSX_mDNSResponder
12844         // Advertise the record with the updated host name with the D2D plugins if appropriate.
12845         D2D_start_advertising_record(rr);
12846 #endif
12847 }
12848 
12849 mDNSexport void mDNS_SetFQDN(mDNS *const m)
12850 {
12851     domainname newmname;
12852     AuthRecord *rr;
12853     newmname.c[0] = 0;
12854 
12855     if (!AppendDomainLabel(&newmname, &m->hostlabel))  { LogMsg("ERROR: mDNS_SetFQDN: Cannot create MulticastHostname"); return; }
12856     if (!AppendLiteralLabelString(&newmname, "local")) { LogMsg("ERROR: mDNS_SetFQDN: Cannot create MulticastHostname"); return; }
12857 
12858     mDNS_Lock(m);
12859 
12860     if (SameDomainNameCS(&m->MulticastHostname, &newmname)) debugf("mDNS_SetFQDN - hostname unchanged");
12861     else
12862     {
12863         AssignDomainName(&m->MulticastHostname, &newmname);
12864         DeadvertiseAllInterfaceRecords(m);
12865         AdvertiseAllInterfaceRecords(m);
12866     }
12867 
12868     // 3. Make sure that any AutoTarget SRV records (and the like) get updated
12869     for (rr = m->ResourceRecords;  rr; rr=rr->next) if (rr->AutoTarget) UpdateTargetHostName(m, rr);
12870     for (rr = m->DuplicateRecords; rr; rr=rr->next) if (rr->AutoTarget) UpdateTargetHostName(m, rr);
12871 
12872     mDNS_Unlock(m);
12873 }
12874 
12875 mDNSlocal void mDNS_HostNameCallback(mDNS *const m, AuthRecord *const rr, mStatus result)
12876 {
12877     (void)rr;   // Unused parameter
12878 
12879     #if MDNS_DEBUGMSGS
12880     {
12881         char *msg = "Unknown result";
12882         if      (result == mStatus_NoError) msg = "Name registered";
12883         else if (result == mStatus_NameConflict) msg = "Name conflict";
12884         debugf("mDNS_HostNameCallback: %##s (%s) %s (%ld)", rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype), msg, result);
12885     }
12886     #endif
12887 
12888     if (result == mStatus_NoError)
12889     {
12890         // Notify the client that the host name is successfully registered
12891         if (m->MainCallback)
12892             m->MainCallback(m, mStatus_NoError);
12893     }
12894     else if (result == mStatus_NameConflict)
12895     {
12896         domainlabel oldlabel = m->hostlabel;
12897 
12898         // 1. First give the client callback a chance to pick a new name
12899         if (m->MainCallback)
12900             m->MainCallback(m, mStatus_NameConflict);
12901 
12902         // 2. If the client callback didn't do it, add (or increment) an index ourselves
12903         // This needs to be case-INSENSITIVE compare, because we need to know that the name has been changed so as to
12904         // remedy the conflict, and a name that differs only in capitalization will just suffer the exact same conflict again.
12905         if (SameDomainLabel(m->hostlabel.c, oldlabel.c))
12906             IncrementLabelSuffix(&m->hostlabel, mDNSfalse);
12907 
12908         // 3. Generate the FQDNs from the hostlabel,
12909         // and make sure all SRV records, etc., are updated to reference our new hostname
12910         mDNS_SetFQDN(m);
12911         LogMsg("Local Hostname %#s.local already in use; will try %#s.local instead", oldlabel.c, m->hostlabel.c);
12912     }
12913     else if (result == mStatus_MemFree)
12914     {
12915         // .local hostnames do not require goodbyes - we ignore the MemFree (which is sent directly by
12916         // mDNS_Deregister_internal), and allow the caller to deallocate immediately following mDNS_DeadvertiseInterface
12917         debugf("mDNS_HostNameCallback: MemFree (ignored)");
12918     }
12919     else
12920         LogMsg("mDNS_HostNameCallback: Unknown error %d for registration of record %s", result,  rr->resrec.name->c);
12921 }
12922 
12923 mDNSlocal void UpdateInterfaceProtocols(mDNS *const m, NetworkInterfaceInfo *active)
12924 {
12925     NetworkInterfaceInfo *intf;
12926     active->IPv4Available = mDNSfalse;
12927     active->IPv6Available = mDNSfalse;
12928     for (intf = m->HostInterfaces; intf; intf = intf->next)
12929         if (intf->InterfaceID == active->InterfaceID)
12930         {
12931             if (intf->ip.type == mDNSAddrType_IPv4 && intf->McastTxRx) active->IPv4Available = mDNStrue;
12932             if (intf->ip.type == mDNSAddrType_IPv6 && intf->McastTxRx) active->IPv6Available = mDNStrue;
12933         }
12934 }
12935 
12936 mDNSlocal void RestartRecordGetZoneData(mDNS * const m)
12937 {
12938     AuthRecord *rr;
12939     LogInfo("RestartRecordGetZoneData: ResourceRecords");
12940     for (rr = m->ResourceRecords; rr; rr=rr->next)
12941         if (AuthRecord_uDNS(rr) && rr->state != regState_NoTarget)
12942         {
12943             debugf("RestartRecordGetZoneData: StartGetZoneData for %##s", rr->resrec.name->c);
12944             // Zero out the updateid so that if we have a pending response from the server, it won't
12945             // be accepted as a valid response. If we accept the response, we might free the new "nta"
12946             if (rr->nta) { rr->updateid = zeroID; CancelGetZoneData(m, rr->nta); }
12947             rr->nta = StartGetZoneData(m, rr->resrec.name, ZoneServiceUpdate, RecordRegistrationGotZoneData, rr);
12948         }
12949 }
12950 
12951 mDNSlocal void InitializeNetWakeState(mDNS *const m, NetworkInterfaceInfo *set)
12952 {
12953     int i;
12954     // We initialize ThisQInterval to -1 indicating that the question has not been started
12955     // yet. If the question (browse) is started later during interface registration, it will
12956     // be stopped during interface deregistration. We can't sanity check to see if the
12957     // question has been stopped or not before initializing it to -1 because we need to
12958     // initialize it to -1 the very first time.
12959 
12960     set->NetWakeBrowse.ThisQInterval = -1;
12961     for (i=0; i<3; i++)
12962     {
12963         set->NetWakeResolve[i].ThisQInterval = -1;
12964         set->SPSAddr[i].type = mDNSAddrType_None;
12965     }
12966     set->NextSPSAttempt     = -1;
12967     set->NextSPSAttemptTime = m->timenow;
12968 }
12969 
12970 mDNSexport void mDNS_ActivateNetWake_internal(mDNS *const m, NetworkInterfaceInfo *set)
12971 {
12972     NetworkInterfaceInfo *p = m->HostInterfaces;
12973     while (p && p != set) p=p->next;
12974     if (!p) { LogMsg("mDNS_ActivateNetWake_internal: NetworkInterfaceInfo %p not found in active list", set); return; }
12975 
12976     if (set->InterfaceActive)
12977     {
12978         LogSPS("ActivateNetWake for %s (%#a)", set->ifname, &set->ip);
12979         mDNS_StartBrowse_internal(m, &set->NetWakeBrowse, &SleepProxyServiceType, &localdomain, mDNSNULL, set->InterfaceID, 0, mDNSfalse, mDNSfalse, m->SPSBrowseCallback, set);
12980     }
12981 }
12982 
12983 mDNSexport void mDNS_DeactivateNetWake_internal(mDNS *const m, NetworkInterfaceInfo *set)
12984 {
12985     NetworkInterfaceInfo *p = m->HostInterfaces;
12986     while (p && p != set) p=p->next;
12987     if (!p) { LogMsg("mDNS_DeactivateNetWake_internal: NetworkInterfaceInfo %p not found in active list", set); return; }
12988 
12989     // Note: We start the browse only if the interface is NetWake capable and we use this to
12990     // stop the resolves also. Hence, the resolves should not be started without the browse
12991     // being started i.e, resolves should not happen unless NetWake capable which is
12992     // guaranteed by BeginSleepProcessing.
12993     if (set->NetWakeBrowse.ThisQInterval >= 0)
12994     {
12995         int i;
12996         LogSPS("DeactivateNetWake for %s (%#a)", set->ifname, &set->ip);
12997 
12998         // Stop our browse and resolve operations
12999         mDNS_StopQuery_internal(m, &set->NetWakeBrowse);
13000         for (i=0; i<3; i++) if (set->NetWakeResolve[i].ThisQInterval >= 0) mDNS_StopQuery_internal(m, &set->NetWakeResolve[i]);
13001 
13002         // Make special call to the browse callback to let it know it can to remove all records for this interface
13003         if (m->SPSBrowseCallback)
13004         {
13005             mDNS_DropLockBeforeCallback();      // Allow client to legally make mDNS API calls from the callback
13006             m->SPSBrowseCallback(m, &set->NetWakeBrowse, mDNSNULL, QC_rmv);
13007             mDNS_ReclaimLockAfterCallback();    // Decrement mDNS_reentrancy to block mDNS API calls again
13008         }
13009 
13010         // Reset our variables back to initial state, so we're ready for when NetWake is turned back on
13011         // (includes resetting NetWakeBrowse.ThisQInterval back to -1)
13012         InitializeNetWakeState(m, set);
13013     }
13014 }
13015 
13016 mDNSexport mStatus mDNS_RegisterInterface(mDNS *const m, NetworkInterfaceInfo *set, InterfaceActivationSpeed activationSpeed)
13017 {
13018     AuthRecord *rr;
13019     mDNSBool FirstOfType = mDNStrue;
13020     NetworkInterfaceInfo **p = &m->HostInterfaces;
13021 
13022     if (!set->InterfaceID)
13023     { LogMsg("mDNS_RegisterInterface: Error! Tried to register a NetworkInterfaceInfo %#a with zero InterfaceID", &set->ip); return(mStatus_Invalid); }
13024 
13025     if (!mDNSAddressIsValidNonZero(&set->mask))
13026     { LogMsg("mDNS_RegisterInterface: Error! Tried to register a NetworkInterfaceInfo %#a with invalid mask %#a", &set->ip, &set->mask); return(mStatus_Invalid); }
13027 
13028     mDNS_Lock(m);
13029 
13030     // Assume this interface will be active now, unless we find a duplicate already in the list
13031     set->InterfaceActive = mDNStrue;
13032     set->IPv4Available   = (mDNSu8)(set->ip.type == mDNSAddrType_IPv4 && set->McastTxRx);
13033     set->IPv6Available   = (mDNSu8)(set->ip.type == mDNSAddrType_IPv6 && set->McastTxRx);
13034 
13035     InitializeNetWakeState(m, set);
13036 
13037     // Scan list to see if this InterfaceID is already represented
13038     while (*p)
13039     {
13040         if (*p == set)
13041         {
13042             LogMsg("mDNS_RegisterInterface: Error! Tried to register a NetworkInterfaceInfo that's already in the list");
13043             mDNS_Unlock(m);
13044             return(mStatus_AlreadyRegistered);
13045         }
13046 
13047         if ((*p)->InterfaceID == set->InterfaceID)
13048         {
13049             // This InterfaceID already represented by a different interface in the list, so mark this instance inactive for now
13050             set->InterfaceActive = mDNSfalse;
13051             if (set->ip.type == (*p)->ip.type) FirstOfType = mDNSfalse;
13052             if (set->ip.type == mDNSAddrType_IPv4 && set->McastTxRx) (*p)->IPv4Available = mDNStrue;
13053             if (set->ip.type == mDNSAddrType_IPv6 && set->McastTxRx) (*p)->IPv6Available = mDNStrue;
13054         }
13055 
13056         p=&(*p)->next;
13057     }
13058 
13059     set->next = mDNSNULL;
13060     *p = set;
13061 
13062     if (set->Advertise)
13063         AdvertiseInterface(m, set);
13064 
13065     LogInfo("mDNS_RegisterInterface: InterfaceID %d %s (%#a) %s",
13066             (uint32_t)set->InterfaceID, set->ifname, &set->ip,
13067             set->InterfaceActive ?
13068             "not represented in list; marking active and retriggering queries" :
13069             "already represented in list; marking inactive for now");
13070 
13071     if (set->NetWake) mDNS_ActivateNetWake_internal(m, set);
13072 
13073     // In early versions of OS X the IPv6 address remains on an interface even when the interface is turned off,
13074     // giving the false impression that there's an active representative of this interface when there really isn't.
13075     // Therefore, when registering an interface, we want to re-trigger our questions and re-probe our Resource Records,
13076     // even if we believe that we previously had an active representative of this interface.
13077     if (set->McastTxRx && (FirstOfType || set->InterfaceActive))
13078     {
13079         DNSQuestion *q;
13080         // Normally, after an interface comes up, we pause half a second before beginning probing.
13081         // This is to guard against cases where there's rapid interface changes, where we could be confused by
13082         // seeing packets we ourselves sent just moments ago (perhaps when this interface had a different address)
13083         // which are then echoed back after a short delay by some Ethernet switches and some 802.11 base stations.
13084         // We don't want to do a probe, and then see a stale echo of an announcement we ourselves sent,
13085         // and think it's a conflicting answer to our probe.
13086         // In the case of a flapping interface, we pause for five seconds, and reduce the announcement count to one packet.
13087         mDNSs32 probedelay;
13088         mDNSu8 numannounce;
13089         switch (activationSpeed)
13090         {
13091             case FastActivation:
13092                 probedelay = (mDNSs32)0;
13093                 numannounce = InitialAnnounceCount;
13094                 LogMsg("mDNS_RegisterInterface: Using fast activation for DirectLink interface %s (%#a)", set->ifname, &set->ip);
13095                 break;
13096 
13097             case SlowActivation:
13098                 probedelay = mDNSPlatformOneSecond * 5;
13099                 numannounce = (mDNSu8)1;
13100                 LogMsg("mDNS_RegisterInterface: Frequent transitions for interface %s (%#a), doing slow activation", set->ifname, &set->ip);
13101                 m->mDNSStats.InterfaceUpFlap++;
13102                 break;
13103 
13104             case NormalActivation:
13105             default:
13106                 probedelay = mDNSPlatformOneSecond / 2;
13107                 numannounce = InitialAnnounceCount;
13108                 break;
13109         }
13110 
13111         LogInfo("mDNS_RegisterInterface: %s (%#a) probedelay %d", set->ifname, &set->ip, probedelay);
13112 
13113         // No probe or sending suppression on DirectLink type interfaces.
13114         if (activationSpeed == FastActivation)
13115         {
13116             m->SuppressSending = 0;
13117             m->SuppressProbes = 0;
13118         }
13119         else
13120         {
13121 	        // Use a small amount of randomness:
13122 	        // In the case of a network administrator turning on an Ethernet hub so that all the
13123 	        // connected machines establish link at exactly the same time, we don't want them all
13124 	        // to go and hit the network with identical queries at exactly the same moment.
13125 	        // We set a random delay of up to InitialQuestionInterval (1/3 second).
13126 	        // We must *never* set m->SuppressSending to more than that (or set it repeatedly in a way
13127 	        // that causes mDNSResponder to remain in a prolonged state of SuppressSending, because
13128 	        // suppressing packet sending for more than about 1/3 second can cause protocol correctness
13129 	        // to start to break down (e.g. we don't answer probes fast enough, and get name conflicts).
13130 	        // See <rdar://problem/4073853> mDNS: m->SuppressSending set too enthusiastically
13131             if (!m->SuppressSending) m->SuppressSending = m->timenow + (mDNSs32)mDNSRandom((mDNSu32)InitialQuestionInterval);
13132 
13133             if (m->SuppressProbes == 0 ||
13134                 m->SuppressProbes - NonZeroTime(m->timenow + probedelay) < 0)
13135                 m->SuppressProbes = NonZeroTime(m->timenow + probedelay);
13136         }
13137 
13138         // Include OWNER option in packets for 60 seconds after connecting to the network. Setting
13139         // it here also handles the wake up case as the network link comes UP after waking causing
13140         // us to reconnect to the network. If we do this as part of the wake up code, it is possible
13141         // that the network link comes UP after 60 seconds and we never set the OWNER option
13142         m->AnnounceOwner = NonZeroTime(m->timenow + 60 * mDNSPlatformOneSecond);
13143         LogInfo("mDNS_RegisterInterface: Setting AnnounceOwner");
13144 
13145         m->mDNSStats.InterfaceUp++;
13146         for (q = m->Questions; q; q=q->next)                                // Scan our list of questions
13147         {
13148             if (mDNSOpaque16IsZero(q->TargetQID))
13149             {
13150                 if (!q->InterfaceID || q->InterfaceID == set->InterfaceID)      // If non-specific Q, or Q on this specific interface,
13151                 {                                                               // then reactivate this question
13152                     // If flapping, delay between first and second queries is nine seconds instead of one second
13153                     mDNSBool dodelay = (activationSpeed == SlowActivation) && (q->FlappingInterface1 == set->InterfaceID || q->FlappingInterface2 == set->InterfaceID);
13154                     mDNSs32 initial  = dodelay ? InitialQuestionInterval * QuestionIntervalStep2 : InitialQuestionInterval;
13155                     mDNSs32 qdelay   = dodelay ? kDefaultQueryDelayTimeForFlappingInterface : 0;
13156                     if (dodelay) LogInfo("No cache records expired for %##s (%s); delaying questions by %d seconds", q->qname.c, DNSTypeName(q->qtype), qdelay);
13157 
13158                     if (!q->ThisQInterval || q->ThisQInterval > initial)
13159                     {
13160                         q->ThisQInterval  = initial;
13161                         q->RequestUnicast = kDefaultRequestUnicastCount;
13162                     }
13163                     q->LastQTime = m->timenow - q->ThisQInterval + qdelay;
13164                     q->RecentAnswerPkts = 0;
13165                     // Change the salt
13166                     ReInitAnonInfo(&q->AnonInfo, &q->qname);
13167                     SetNextQueryTime(m,q);
13168                 }
13169             }
13170         }
13171 
13172         // For all our non-specific authoritative resource records (and any dormant records specific to this interface)
13173         // we now need them to re-probe if necessary, and then re-announce.
13174         for (rr = m->ResourceRecords; rr; rr=rr->next)
13175         {
13176             if (!rr->resrec.InterfaceID || rr->resrec.InterfaceID == set->InterfaceID)
13177             {
13178                 // Change the salt
13179                 ReInitAnonInfo(&rr->resrec.AnonInfo, rr->resrec.name);
13180                 mDNSCoreRestartRegistration(m, rr, numannounce);
13181             }
13182         }
13183 #if APPLE_OSX_mDNSResponder && !TARGET_OS_IPHONE
13184         DNSSECProbe(m);
13185 #endif
13186     }
13187 
13188     RestartRecordGetZoneData(m);
13189 
13190     mDNS_UpdateAllowSleep(m);
13191 
13192     mDNS_Unlock(m);
13193     return(mStatus_NoError);
13194 }
13195 
13196 // Note: mDNS_DeregisterInterface calls mDNS_Deregister_internal which can call a user callback, which may change
13197 // the record list and/or question list.
13198 // Any code walking either list must use the CurrentQuestion and/or CurrentRecord mechanism to protect against this.
13199 mDNSexport void mDNS_DeregisterInterface(mDNS *const m, NetworkInterfaceInfo *set, InterfaceActivationSpeed activationSpeed)
13200 {
13201     NetworkInterfaceInfo **p = &m->HostInterfaces;
13202     mDNSBool revalidate = mDNSfalse;
13203     NetworkInterfaceInfo *primary;
13204     NetworkInterfaceInfo *intf;
13205     AuthRecord *A;
13206 
13207     mDNS_Lock(m);
13208 
13209     // Find this record in our list
13210     while (*p && *p != set) p=&(*p)->next;
13211     if (!*p) { debugf("mDNS_DeregisterInterface: NetworkInterfaceInfo not found in list"); mDNS_Unlock(m); return; }
13212 
13213     mDNS_DeactivateNetWake_internal(m, set);
13214 
13215     // Unlink this record from our list
13216     *p = (*p)->next;
13217     set->next = mDNSNULL;
13218 
13219     if (!set->InterfaceActive)
13220     {
13221         // If this interface not the active member of its set, update the v4/v6Available flags for the active member
13222         for (intf = m->HostInterfaces; intf; intf = intf->next)
13223             if (intf->InterfaceActive && intf->InterfaceID == set->InterfaceID)
13224                 UpdateInterfaceProtocols(m, intf);
13225     }
13226     else
13227     {
13228         intf = FirstInterfaceForID(m, set->InterfaceID);
13229         if (intf)
13230         {
13231             LogInfo("mDNS_DeregisterInterface: Another representative of InterfaceID %d %s (%#a) exists;"
13232                     " making it active", (uint32_t)set->InterfaceID, set->ifname, &set->ip);
13233             if (intf->InterfaceActive)
13234                 LogMsg("mDNS_DeregisterInterface: ERROR intf->InterfaceActive already set for %s (%#a)", set->ifname, &set->ip);
13235             intf->InterfaceActive = mDNStrue;
13236             UpdateInterfaceProtocols(m, intf);
13237 
13238             if (intf->NetWake) mDNS_ActivateNetWake_internal(m, intf);
13239 
13240             // See if another representative *of the same type* exists. If not, we mave have gone from
13241             // dual-stack to v6-only (or v4-only) so we need to reconfirm which records are still valid.
13242             for (intf = m->HostInterfaces; intf; intf = intf->next)
13243                 if (intf->InterfaceID == set->InterfaceID && intf->ip.type == set->ip.type)
13244                     break;
13245             if (!intf) revalidate = mDNStrue;
13246         }
13247         else
13248         {
13249             mDNSu32 slot;
13250             CacheGroup *cg;
13251             CacheRecord *rr;
13252             DNSQuestion *q;
13253 
13254             LogInfo("mDNS_DeregisterInterface: Last representative of InterfaceID %d %s (%#a) deregistered;"
13255                     " marking questions etc. dormant", (uint32_t)set->InterfaceID, set->ifname, &set->ip);
13256 
13257             m->mDNSStats.InterfaceDown++;
13258 
13259             if (set->McastTxRx && (activationSpeed == SlowActivation))
13260             {
13261                 LogMsg("mDNS_DeregisterInterface: Frequent transitions for interface %s (%#a)", set->ifname, &set->ip);
13262                 m->mDNSStats.InterfaceDownFlap++;
13263             }
13264 
13265             // 1. Deactivate any questions specific to this interface, and tag appropriate questions
13266             // so that mDNS_RegisterInterface() knows how swiftly it needs to reactivate them
13267             for (q = m->Questions; q; q=q->next)
13268             {
13269                 if (q->InterfaceID == set->InterfaceID) q->ThisQInterval = 0;
13270                 if (!q->InterfaceID || q->InterfaceID == set->InterfaceID)
13271                 {
13272                     q->FlappingInterface2 = q->FlappingInterface1;
13273                     q->FlappingInterface1 = set->InterfaceID;       // Keep history of the last two interfaces to go away
13274                 }
13275             }
13276 
13277             // 2. Flush any cache records received on this interface
13278             revalidate = mDNSfalse;     // Don't revalidate if we're flushing the records
13279             FORALL_CACHERECORDS(slot, cg, rr)
13280             {
13281                 if (rr->resrec.InterfaceID == set->InterfaceID)
13282                 {
13283                     // If this interface is deemed flapping,
13284                     // postpone deleting the cache records in case the interface comes back again
13285                     if (set->McastTxRx && (activationSpeed == SlowActivation))
13286                     {
13287                         // For a flapping interface we want these records to go away after
13288                         // kDefaultReconfirmTimeForFlappingInterface seconds if they are not reconfirmed.
13289                         mDNS_Reconfirm_internal(m, rr, kDefaultReconfirmTimeForFlappingInterface);
13290                         // We set UnansweredQueries = MaxUnansweredQueries so we don't waste time doing any queries for them --
13291                         // if the interface does come back, any relevant questions will be reactivated anyway
13292                         rr->UnansweredQueries = MaxUnansweredQueries;
13293                     }
13294                     else
13295                     {
13296                         rr->resrec.mortality = Mortality_Mortal;
13297                         mDNS_PurgeCacheResourceRecord(m, rr);
13298                     }
13299                 }
13300             }
13301         }
13302     }
13303 
13304     // If we still have address records referring to this one, update them.
13305     // This is safe, because this NetworkInterfaceInfo has already been unlinked from the list,
13306     // so the call to FindFirstAdvertisedInterface() won’t accidentally find it.
13307     primary = FindFirstAdvertisedInterface(m);
13308     A = primary ? &primary->RR_A : mDNSNULL;
13309     for (intf = m->HostInterfaces; intf; intf = intf->next)
13310         if (intf->RR_A.RRSet == &set->RR_A)
13311             intf->RR_A.RRSet = A;
13312 
13313     // If we were advertising on this interface, deregister those address and reverse-lookup records now
13314     if (set->Advertise) DeadvertiseInterface(m, set);
13315 
13316     // If we have any cache records received on this interface that went away, then re-verify them.
13317     // In some versions of OS X the IPv6 address remains on an interface even when the interface is turned off,
13318     // giving the false impression that there's an active representative of this interface when there really isn't.
13319     // Don't need to do this when shutting down, because *all* interfaces are about to go away
13320     if (revalidate && !m->ShutdownTime)
13321     {
13322         mDNSu32 slot;
13323         CacheGroup *cg;
13324         CacheRecord *rr;
13325         FORALL_CACHERECORDS(slot, cg, rr)
13326         if (rr->resrec.InterfaceID == set->InterfaceID)
13327             mDNS_Reconfirm_internal(m, rr, kDefaultReconfirmTimeForFlappingInterface);
13328     }
13329 
13330     mDNS_UpdateAllowSleep(m);
13331 
13332     mDNS_Unlock(m);
13333 }
13334 
13335 mDNSlocal void SetAnonInfoSRS(ServiceRecordSet *sr, int NumSubTypes)
13336 {
13337     int i, len;
13338 
13339     if (!sr->AnonData)
13340         return;
13341 
13342     len = mDNSPlatformStrLen(sr->AnonData);
13343     if (sr->RR_PTR.resrec.AnonInfo)
13344     {
13345         LogMsg("SetAnonInfoSRS: Freeing AnonInfo for PTR record %##s, should have been freed already", sr->RR_PTR.resrec.name->c);
13346         FreeAnonInfo(sr->RR_PTR.resrec.AnonInfo);
13347     }
13348     sr->RR_PTR.resrec.AnonInfo = AllocateAnonInfo(sr->RR_PTR.resrec.name, sr->AnonData, len, mDNSNULL);
13349     for (i=0; i<NumSubTypes; i++)
13350     {
13351         if (sr->SubTypes[i].resrec.AnonInfo)
13352         {
13353             LogMsg("SetAnonInfoSRS: Freeing AnonInfo for subtype record %##s, should have been freed already", sr->SubTypes[i].resrec.name->c);
13354             FreeAnonInfo(sr->SubTypes[i].resrec.AnonInfo);
13355         }
13356         sr->SubTypes[i].resrec.AnonInfo = AllocateAnonInfo(sr->SubTypes[i].resrec.name, sr->AnonData, len, mDNSNULL);
13357     }
13358 }
13359 
13360 mDNSlocal void ResetAnonInfoSRS(ServiceRecordSet *sr, int NumSubTypes)
13361 {
13362     int i;
13363 
13364     if (!sr->AnonData)
13365         return;
13366     if (sr->RR_PTR.resrec.AnonInfo)
13367     {
13368         FreeAnonInfo(sr->RR_PTR.resrec.AnonInfo);
13369         sr->RR_PTR.resrec.AnonInfo = mDNSNULL;
13370     }
13371     for (i=0; i<NumSubTypes; i++)
13372     {
13373         if (sr->SubTypes[i].resrec.AnonInfo)
13374         {
13375             FreeAnonInfo(sr->SubTypes[i].resrec.AnonInfo);
13376             sr->SubTypes[i].resrec.AnonInfo = mDNSNULL;
13377         }
13378     }
13379 }
13380 
13381 mDNSlocal void ServiceCallback(mDNS *const m, AuthRecord *const rr, mStatus result)
13382 {
13383     ServiceRecordSet *sr = (ServiceRecordSet *)rr->RecordContext;
13384     (void)m;    // Unused parameter
13385 
13386     #if MDNS_DEBUGMSGS
13387     {
13388         char *msg = "Unknown result";
13389         if      (result == mStatus_NoError) msg = "Name Registered";
13390         else if (result == mStatus_NameConflict) msg = "Name Conflict";
13391         else if (result == mStatus_MemFree) msg = "Memory Free";
13392         debugf("ServiceCallback: %##s (%s) %s (%d)", rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype), msg, result);
13393     }
13394     #endif
13395 
13396     // Only pass on the NoError acknowledgement for the SRV record (when it finishes probing)
13397     if (result == mStatus_NoError && rr != &sr->RR_SRV) return;
13398 
13399     // If we got a name conflict on either SRV or TXT, forcibly deregister this service, and record that we did that
13400     if (result == mStatus_NameConflict)
13401     {
13402         sr->Conflict = mDNStrue;                // Record that this service set had a conflict
13403         mDNS_DeregisterService(m, sr);          // Unlink the records from our list
13404         return;
13405     }
13406 
13407     if (result == mStatus_MemFree)
13408     {
13409         // If the SRV/TXT/PTR records, or the _services._dns-sd._udp record, or any of the subtype PTR records,
13410         // are still in the process of deregistering, don't pass on the NameConflict/MemFree message until
13411         // every record is finished cleaning up.
13412         mDNSu32 i;
13413         ExtraResourceRecord *e = sr->Extras;
13414 
13415         if (sr->RR_SRV.resrec.RecordType != kDNSRecordTypeUnregistered) return;
13416         if (sr->RR_TXT.resrec.RecordType != kDNSRecordTypeUnregistered) return;
13417         if (sr->RR_PTR.resrec.RecordType != kDNSRecordTypeUnregistered) return;
13418         if (sr->RR_ADV.resrec.RecordType != kDNSRecordTypeUnregistered) return;
13419         for (i=0; i<sr->NumSubTypes; i++) if (sr->SubTypes[i].resrec.RecordType != kDNSRecordTypeUnregistered) return;
13420 
13421         while (e)
13422         {
13423             if (e->r.resrec.RecordType != kDNSRecordTypeUnregistered) return;
13424             e = e->next;
13425         }
13426         ResetAnonInfoSRS(sr, sr->NumSubTypes);
13427 
13428         // If this ServiceRecordSet was forcibly deregistered, and now its memory is ready for reuse,
13429         // then we can now report the NameConflict to the client
13430         if (sr->Conflict) result = mStatus_NameConflict;
13431 
13432     }
13433 
13434     LogInfo("ServiceCallback: All records %s for %##s", (result == mStatus_MemFree ? "Unregistered" : "Registered"), sr->RR_PTR.resrec.name->c);
13435     // CAUTION: MUST NOT do anything more with sr after calling sr->Callback(), because the client's callback
13436     // function is allowed to do anything, including deregistering this service and freeing its memory.
13437     if (sr->ServiceCallback)
13438         sr->ServiceCallback(m, sr, result);
13439 }
13440 
13441 mDNSlocal void NSSCallback(mDNS *const m, AuthRecord *const rr, mStatus result)
13442 {
13443     ServiceRecordSet *sr = (ServiceRecordSet *)rr->RecordContext;
13444     if (sr->ServiceCallback)
13445         sr->ServiceCallback(m, sr, result);
13446 }
13447 
13448 
13449 // Derive AuthRecType from the kDNSServiceFlags* values.
13450 mDNSlocal AuthRecType setAuthRecType(mDNSInterfaceID InterfaceID, mDNSu32 flags)
13451 {
13452     AuthRecType artype;
13453 
13454     if (InterfaceID == mDNSInterface_LocalOnly)
13455         artype = AuthRecordLocalOnly;
13456     else if (InterfaceID == mDNSInterface_P2P || InterfaceID == mDNSInterface_BLE)
13457         artype = AuthRecordP2P;
13458     else if ((InterfaceID == mDNSInterface_Any) && (flags & kDNSServiceFlagsIncludeP2P)
13459             && (flags & kDNSServiceFlagsIncludeAWDL))
13460         artype = AuthRecordAnyIncludeAWDLandP2P;
13461     else if ((InterfaceID == mDNSInterface_Any) && (flags & kDNSServiceFlagsIncludeP2P))
13462         artype = AuthRecordAnyIncludeP2P;
13463     else if ((InterfaceID == mDNSInterface_Any) && (flags & kDNSServiceFlagsIncludeAWDL))
13464         artype = AuthRecordAnyIncludeAWDL;
13465     else
13466         artype = AuthRecordAny;
13467 
13468     return artype;
13469 }
13470 
13471 // Used to derive the original D2D specific flags specified by the client in the registration
13472 // when we don't have access to the original flag (kDNSServiceFlags*) values.
13473 mDNSexport mDNSu32 deriveD2DFlagsFromAuthRecType(AuthRecType authRecType)
13474 {
13475     mDNSu32 flags = 0;
13476     if ((authRecType == AuthRecordAnyIncludeP2P) || (authRecType == AuthRecordAnyIncludeAWDLandP2P))
13477         flags |= kDNSServiceFlagsIncludeP2P;
13478     else if ((authRecType == AuthRecordAnyIncludeAWDL) || (authRecType == AuthRecordAnyIncludeAWDLandP2P))
13479         flags |= kDNSServiceFlagsIncludeAWDL;
13480     return flags;
13481 }
13482 
13483 // Note:
13484 // Name is first label of domain name (any dots in the name are actual dots, not label separators)
13485 // Type is service type (e.g. "_ipp._tcp.")
13486 // Domain is fully qualified domain name (i.e. ending with a null label)
13487 // We always register a TXT, even if it is empty (so that clients are not
13488 // left waiting forever looking for a nonexistent record.)
13489 // If the host parameter is mDNSNULL or the root domain (ASCII NUL),
13490 // then the default host name (m->MulticastHostname) is automatically used
13491 // If the optional target host parameter is set, then the storage it points to must remain valid for the lifetime of the service registration
13492 mDNSexport mStatus mDNS_RegisterService(mDNS *const m, ServiceRecordSet *sr,
13493                                         const domainlabel *const name, const domainname *const type, const domainname *const domain,
13494                                         const domainname *const host, mDNSIPPort port, RData *const txtrdata, const mDNSu8 txtinfo[], mDNSu16 txtlen,
13495                                         AuthRecord *SubTypes, mDNSu32 NumSubTypes,
13496                                         mDNSInterfaceID InterfaceID, mDNSServiceCallback Callback, void *Context, mDNSu32 flags)
13497 {
13498     mStatus err;
13499     mDNSu32 i;
13500     mDNSu32 hostTTL;
13501     AuthRecType artype;
13502     mDNSu8 recordType = (flags & kDNSServiceFlagsKnownUnique) ? kDNSRecordTypeKnownUnique : kDNSRecordTypeUnique;
13503 
13504     sr->ServiceCallback = Callback;
13505     sr->ServiceContext  = Context;
13506     sr->Conflict        = mDNSfalse;
13507 
13508     sr->Extras          = mDNSNULL;
13509     sr->NumSubTypes     = NumSubTypes;
13510     sr->SubTypes        = SubTypes;
13511     sr->flags           = flags;
13512 
13513     artype = setAuthRecType(InterfaceID, flags);
13514 
13515     // Initialize the AuthRecord objects to sane values
13516     // Need to initialize everything correctly *before* making the decision whether to do a RegisterNoSuchService and bail out
13517     mDNS_SetupResourceRecord(&sr->RR_ADV, mDNSNULL, InterfaceID, kDNSType_PTR, kStandardTTL, kDNSRecordTypeAdvisory, artype, ServiceCallback, sr);
13518     mDNS_SetupResourceRecord(&sr->RR_PTR, mDNSNULL, InterfaceID, kDNSType_PTR, kStandardTTL, kDNSRecordTypeShared,   artype, ServiceCallback, sr);
13519 
13520     if (flags & kDNSServiceFlagsWakeOnlyService)
13521     {
13522         sr->RR_PTR.AuthFlags = AuthFlagsWakeOnly;
13523     }
13524 
13525     if (SameDomainName(type, (const domainname *) "\x4" "_ubd" "\x4" "_tcp"))
13526         hostTTL = kHostNameSmallTTL;
13527     else
13528         hostTTL = kHostNameTTL;
13529 
13530     mDNS_SetupResourceRecord(&sr->RR_SRV, mDNSNULL, InterfaceID, kDNSType_SRV, hostTTL, recordType, artype, ServiceCallback, sr);
13531     mDNS_SetupResourceRecord(&sr->RR_TXT, txtrdata, InterfaceID, kDNSType_TXT, kStandardTTL, recordType, artype, ServiceCallback, sr);
13532 
13533     // If port number is zero, that means the client is really trying to do a RegisterNoSuchService
13534     if (mDNSIPPortIsZero(port))
13535         return(mDNS_RegisterNoSuchService(m, &sr->RR_SRV, name, type, domain, mDNSNULL, InterfaceID, NSSCallback, sr, flags));
13536 
13537     // If the caller is registering an oversized TXT record,
13538     // it is the caller's responsibility to allocate a ServiceRecordSet structure that is large enough for it
13539     if (sr->RR_TXT.resrec.rdata->MaxRDLength < txtlen)
13540         sr->RR_TXT.resrec.rdata->MaxRDLength = txtlen;
13541 
13542     // Set up the record names
13543     // For now we only create an advisory record for the main type, not for subtypes
13544     // We need to gain some operational experience before we decide if there's a need to create them for subtypes too
13545     if (ConstructServiceName(&sr->RR_ADV.namestorage, (const domainlabel*)"\x09_services", (const domainname*)"\x07_dns-sd\x04_udp", domain) == mDNSNULL)
13546         return(mStatus_BadParamErr);
13547     if (ConstructServiceName(&sr->RR_PTR.namestorage, mDNSNULL, type, domain) == mDNSNULL) return(mStatus_BadParamErr);
13548     if (ConstructServiceName(&sr->RR_SRV.namestorage, name,     type, domain) == mDNSNULL) return(mStatus_BadParamErr);
13549     AssignDomainName(&sr->RR_TXT.namestorage, sr->RR_SRV.resrec.name);
13550 
13551     // 1. Set up the ADV record rdata to advertise our service type
13552     AssignDomainName(&sr->RR_ADV.resrec.rdata->u.name, sr->RR_PTR.resrec.name);
13553 
13554     // 2. Set up the PTR record rdata to point to our service name
13555     // We set up two additionals, so when a client asks for this PTR we automatically send the SRV and the TXT too
13556     // Note: uDNS registration code assumes that Additional1 points to the SRV record
13557     AssignDomainName(&sr->RR_PTR.resrec.rdata->u.name, sr->RR_SRV.resrec.name);
13558     sr->RR_PTR.Additional1 = &sr->RR_SRV;
13559     sr->RR_PTR.Additional2 = &sr->RR_TXT;
13560 
13561     // 2a. Set up any subtype PTRs to point to our service name
13562     // If the client is using subtypes, it is the client's responsibility to have
13563     // already set the first label of the record name to the subtype being registered
13564     for (i=0; i<NumSubTypes; i++)
13565     {
13566         domainname st;
13567         AssignDomainName(&st, sr->SubTypes[i].resrec.name);
13568         st.c[1+st.c[0]] = 0;            // Only want the first label, not the whole FQDN (particularly for mDNS_RenameAndReregisterService())
13569         AppendDomainName(&st, type);
13570         mDNS_SetupResourceRecord(&sr->SubTypes[i], mDNSNULL, InterfaceID, kDNSType_PTR, kStandardTTL, kDNSRecordTypeShared, artype, ServiceCallback, sr);
13571         if (ConstructServiceName(&sr->SubTypes[i].namestorage, mDNSNULL, &st, domain) == mDNSNULL) return(mStatus_BadParamErr);
13572         AssignDomainName(&sr->SubTypes[i].resrec.rdata->u.name, &sr->RR_SRV.namestorage);
13573         sr->SubTypes[i].Additional1 = &sr->RR_SRV;
13574         sr->SubTypes[i].Additional2 = &sr->RR_TXT;
13575     }
13576 
13577     SetAnonInfoSRS(sr, NumSubTypes);
13578 
13579     // 3. Set up the SRV record rdata.
13580     sr->RR_SRV.resrec.rdata->u.srv.priority = 0;
13581     sr->RR_SRV.resrec.rdata->u.srv.weight   = 0;
13582     sr->RR_SRV.resrec.rdata->u.srv.port     = port;
13583 
13584     // Setting AutoTarget tells DNS that the target of this SRV is to be automatically kept in sync with our host name
13585     if (host && host->c[0]) AssignDomainName(&sr->RR_SRV.resrec.rdata->u.srv.target, host);
13586     else { sr->RR_SRV.AutoTarget = Target_AutoHost; sr->RR_SRV.resrec.rdata->u.srv.target.c[0] = '\0'; }
13587 
13588     // 4. Set up the TXT record rdata,
13589     // and set DependentOn because we're depending on the SRV record to find and resolve conflicts for us
13590     // Note: uDNS registration code assumes that DependentOn points to the SRV record
13591     if (txtinfo == mDNSNULL) sr->RR_TXT.resrec.rdlength = 0;
13592     else if (txtinfo != sr->RR_TXT.resrec.rdata->u.txt.c)
13593     {
13594         sr->RR_TXT.resrec.rdlength = txtlen;
13595         if (sr->RR_TXT.resrec.rdlength > sr->RR_TXT.resrec.rdata->MaxRDLength) return(mStatus_BadParamErr);
13596         mDNSPlatformMemCopy(sr->RR_TXT.resrec.rdata->u.txt.c, txtinfo, txtlen);
13597     }
13598     sr->RR_TXT.DependentOn = &sr->RR_SRV;
13599 
13600     mDNS_Lock(m);
13601     // It is important that we register SRV first. uDNS assumes that SRV is registered first so
13602     // that if the SRV cannot find a target, rest of the records that belong to this service
13603     // will not be activated.
13604     err = mDNS_Register_internal(m, &sr->RR_SRV);
13605     // If we can't register the SRV record due to errors, bail out. It has not been inserted in
13606     // any list and hence no need to deregister. We could probably do similar checks for other
13607     // records below and bail out. For now, this seems to be sufficient to address rdar://9304275
13608     if (err)
13609     {
13610         mDNS_Unlock(m);
13611         return err;
13612     }
13613     if (!err) err = mDNS_Register_internal(m, &sr->RR_TXT);
13614     // We register the RR_PTR last, because we want to be sure that in the event of a forced call to
13615     // mDNS_StartExit, the RR_PTR will be the last one to be forcibly deregistered, since that is what triggers
13616     // the mStatus_MemFree callback to ServiceCallback, which in turn passes on the mStatus_MemFree back to
13617     // the client callback, which is then at liberty to free the ServiceRecordSet memory at will. We need to
13618     // make sure we've deregistered all our records and done any other necessary cleanup before that happens.
13619     if (!err) err = mDNS_Register_internal(m, &sr->RR_ADV);
13620     for (i=0; i<NumSubTypes; i++) if (!err) err = mDNS_Register_internal(m, &sr->SubTypes[i]);
13621     if (!err) err = mDNS_Register_internal(m, &sr->RR_PTR);
13622 
13623     mDNS_Unlock(m);
13624 
13625     if (err) mDNS_DeregisterService(m, sr);
13626     return(err);
13627 }
13628 
13629 mDNSexport mStatus mDNS_AddRecordToService(mDNS *const m, ServiceRecordSet *sr,
13630                                            ExtraResourceRecord *extra, RData *rdata, mDNSu32 ttl,  mDNSu32 flags)
13631 {
13632     ExtraResourceRecord **e;
13633     mStatus status;
13634     AuthRecType artype;
13635     mDNSInterfaceID InterfaceID = sr->RR_PTR.resrec.InterfaceID;
13636     ResourceRecord *rr;
13637 
13638     artype = setAuthRecType(InterfaceID, flags);
13639 
13640     extra->next = mDNSNULL;
13641     mDNS_SetupResourceRecord(&extra->r, rdata, sr->RR_PTR.resrec.InterfaceID,
13642                              extra->r.resrec.rrtype, ttl, kDNSRecordTypeUnique, artype, ServiceCallback, sr);
13643     AssignDomainName(&extra->r.namestorage, sr->RR_SRV.resrec.name);
13644 
13645     mDNS_Lock(m);
13646     rr = mDNSNULL;
13647     if (extra->r.resrec.rrtype == kDNSType_TXT)
13648     {
13649         if (sr->RR_TXT.resrec.RecordType & kDNSRecordTypeUniqueMask) rr = &sr->RR_TXT.resrec;
13650     }
13651     else if (extra->r.resrec.rrtype == kDNSType_SRV)
13652     {
13653         if (sr->RR_SRV.resrec.RecordType & kDNSRecordTypeUniqueMask) rr = &sr->RR_SRV.resrec;
13654     }
13655 
13656     if (!rr)
13657     {
13658         ExtraResourceRecord *srExtra;
13659 
13660         for (srExtra = sr->Extras; srExtra; srExtra = srExtra->next)
13661         {
13662             if ((srExtra->r.resrec.rrtype == extra->r.resrec.rrtype) && (srExtra->r.resrec.RecordType & kDNSRecordTypeUniqueMask))
13663             {
13664                 rr = &srExtra->r.resrec;
13665                 break;
13666             }
13667         }
13668     }
13669 
13670     if (rr && (extra->r.resrec.rroriginalttl != rr->rroriginalttl))
13671     {
13672         LogMsg("mDNS_AddRecordToService: Correcting TTL from %4d to %4d for %s",
13673             extra->r.resrec.rroriginalttl, rr->rroriginalttl, RRDisplayString(m, &extra->r.resrec));
13674         extra->r.resrec.rroriginalttl = rr->rroriginalttl;
13675     }
13676 
13677     e = &sr->Extras;
13678     while (*e) e = &(*e)->next;
13679 
13680     extra->r.DependentOn = &sr->RR_SRV;
13681 
13682     debugf("mDNS_AddRecordToService adding record to %##s %s %d",
13683            extra->r.resrec.name->c, DNSTypeName(extra->r.resrec.rrtype), extra->r.resrec.rdlength);
13684 
13685     status = mDNS_Register_internal(m, &extra->r);
13686     if (status == mStatus_NoError) *e = extra;
13687 
13688     mDNS_Unlock(m);
13689     return(status);
13690 }
13691 
13692 mDNSexport mStatus mDNS_RemoveRecordFromService(mDNS *const m, ServiceRecordSet *sr, ExtraResourceRecord *extra,
13693                                                 mDNSRecordCallback MemFreeCallback, void *Context)
13694 {
13695     ExtraResourceRecord **e;
13696     mStatus status;
13697 
13698     mDNS_Lock(m);
13699     e = &sr->Extras;
13700     while (*e && *e != extra) e = &(*e)->next;
13701     if (!*e)
13702     {
13703         debugf("mDNS_RemoveRecordFromService failed to remove record from %##s", extra->r.resrec.name->c);
13704         status = mStatus_BadReferenceErr;
13705     }
13706     else
13707     {
13708         debugf("mDNS_RemoveRecordFromService removing record from %##s", extra->r.resrec.name->c);
13709         extra->r.RecordCallback = MemFreeCallback;
13710         extra->r.RecordContext  = Context;
13711         *e = (*e)->next;
13712         status = mDNS_Deregister_internal(m, &extra->r, mDNS_Dereg_normal);
13713     }
13714     mDNS_Unlock(m);
13715     return(status);
13716 }
13717 
13718 mDNSexport mStatus mDNS_RenameAndReregisterService(mDNS *const m, ServiceRecordSet *const sr, const domainlabel *newname)
13719 {
13720     // Note: Don't need to use mDNS_Lock(m) here, because this code is just using public routines
13721     // mDNS_RegisterService() and mDNS_AddRecordToService(), which do the right locking internally.
13722     domainlabel name1, name2;
13723     domainname type, domain;
13724     const domainname *host = sr->RR_SRV.AutoTarget ? mDNSNULL : &sr->RR_SRV.resrec.rdata->u.srv.target;
13725     ExtraResourceRecord *extras = sr->Extras;
13726     mStatus err;
13727 
13728     DeconstructServiceName(sr->RR_SRV.resrec.name, &name1, &type, &domain);
13729     if (!newname)
13730     {
13731         name2 = name1;
13732         IncrementLabelSuffix(&name2, mDNStrue);
13733         newname = &name2;
13734     }
13735 
13736     if (SameDomainName(&domain, &localdomain))
13737         debugf("%##s service renamed from \"%#s\" to \"%#s\"", type.c, name1.c, newname->c);
13738     else debugf("%##s service (domain %##s) renamed from \"%#s\" to \"%#s\"",type.c, domain.c, name1.c, newname->c);
13739 
13740     err = mDNS_RegisterService(m, sr, newname, &type, &domain,
13741                                host, sr->RR_SRV.resrec.rdata->u.srv.port,
13742                                (sr->RR_TXT.resrec.rdata != &sr->RR_TXT.rdatastorage) ? sr->RR_TXT.resrec.rdata : mDNSNULL,
13743                                sr->RR_TXT.resrec.rdata->u.txt.c, sr->RR_TXT.resrec.rdlength,
13744                                sr->SubTypes, sr->NumSubTypes,
13745                                sr->RR_PTR.resrec.InterfaceID, sr->ServiceCallback, sr->ServiceContext, sr->flags);
13746 
13747     // mDNS_RegisterService() just reset sr->Extras to NULL.
13748     // Fortunately we already grabbed ourselves a copy of this pointer (above), so we can now run
13749     // through the old list of extra records, and re-add them to our freshly created service registration
13750     while (!err && extras)
13751     {
13752         ExtraResourceRecord *e = extras;
13753         extras = extras->next;
13754         err = mDNS_AddRecordToService(m, sr, e, e->r.resrec.rdata, e->r.resrec.rroriginalttl, 0);
13755     }
13756 
13757     return(err);
13758 }
13759 
13760 // Note: mDNS_DeregisterService calls mDNS_Deregister_internal which can call a user callback,
13761 // which may change the record list and/or question list.
13762 // Any code walking either list must use the CurrentQuestion and/or CurrentRecord mechanism to protect against this.
13763 mDNSexport mStatus mDNS_DeregisterService_drt(mDNS *const m, ServiceRecordSet *sr, mDNS_Dereg_type drt)
13764 {
13765     // If port number is zero, that means this was actually registered using mDNS_RegisterNoSuchService()
13766     if (mDNSIPPortIsZero(sr->RR_SRV.resrec.rdata->u.srv.port)) return(mDNS_DeregisterNoSuchService(m, &sr->RR_SRV));
13767 
13768     if (sr->RR_PTR.resrec.RecordType == kDNSRecordTypeUnregistered)
13769     {
13770         debugf("Service set for %##s already deregistered", sr->RR_SRV.resrec.name->c);
13771         return(mStatus_BadReferenceErr);
13772     }
13773     else if (sr->RR_PTR.resrec.RecordType == kDNSRecordTypeDeregistering)
13774     {
13775         LogInfo("Service set for %##s already in the process of deregistering", sr->RR_SRV.resrec.name->c);
13776         // Avoid race condition:
13777         // If a service gets a conflict, then we set the Conflict flag to tell us to generate
13778         // an mStatus_NameConflict message when we get the mStatus_MemFree for our PTR record.
13779         // If the client happens to deregister the service in the middle of that process, then
13780         // we clear the flag back to the normal state, so that we deliver a plain mStatus_MemFree
13781         // instead of incorrectly promoting it to mStatus_NameConflict.
13782         // This race condition is exposed particularly when the conformance test generates
13783         // a whole batch of simultaneous conflicts across a range of services all advertised
13784         // using the same system default name, and if we don't take this precaution then
13785         // we end up incrementing m->nicelabel multiple times instead of just once.
13786         // <rdar://problem/4060169> Bug when auto-renaming Computer Name after name collision
13787         sr->Conflict = mDNSfalse;
13788         return(mStatus_NoError);
13789     }
13790     else
13791     {
13792         mDNSu32 i;
13793         mStatus status;
13794         ExtraResourceRecord *e;
13795         mDNS_Lock(m);
13796         e = sr->Extras;
13797 
13798         // We use mDNS_Dereg_repeat because, in the event of a collision, some or all of the
13799         // SRV, TXT, or Extra records could have already been automatically deregistered, and that's okay
13800         mDNS_Deregister_internal(m, &sr->RR_SRV, mDNS_Dereg_repeat);
13801         mDNS_Deregister_internal(m, &sr->RR_TXT, mDNS_Dereg_repeat);
13802 
13803         mDNS_Deregister_internal(m, &sr->RR_ADV, drt);
13804 
13805         // We deregister all of the extra records, but we leave the sr->Extras list intact
13806         // in case the client wants to do a RenameAndReregister and reinstate the registration
13807         while (e)
13808         {
13809             mDNS_Deregister_internal(m, &e->r, mDNS_Dereg_repeat);
13810             e = e->next;
13811         }
13812 
13813         for (i=0; i<sr->NumSubTypes; i++)
13814             mDNS_Deregister_internal(m, &sr->SubTypes[i], drt);
13815 
13816         status = mDNS_Deregister_internal(m, &sr->RR_PTR, drt);
13817         mDNS_Unlock(m);
13818         return(status);
13819     }
13820 }
13821 
13822 // Create a registration that asserts that no such service exists with this name.
13823 // This can be useful where there is a given function is available through several protocols.
13824 // For example, a printer called "Stuart's Printer" may implement printing via the "pdl-datastream" and "IPP"
13825 // protocols, but not via "LPR". In this case it would be prudent for the printer to assert the non-existence of an
13826 // "LPR" service called "Stuart's Printer". Without this precaution, another printer than offers only "LPR" printing
13827 // could inadvertently advertise its service under the same name "Stuart's Printer", which might be confusing for users.
13828 mDNSexport mStatus mDNS_RegisterNoSuchService(mDNS *const m, AuthRecord *const rr,
13829                                               const domainlabel *const name, const domainname *const type, const domainname *const domain,
13830                                               const domainname *const host,
13831                                               const mDNSInterfaceID InterfaceID, mDNSRecordCallback Callback, void *Context, mDNSu32 flags)
13832 {
13833     AuthRecType artype;
13834 
13835     artype = setAuthRecType(InterfaceID, flags);
13836 
13837     mDNS_SetupResourceRecord(rr, mDNSNULL, InterfaceID, kDNSType_SRV, kHostNameTTL, kDNSRecordTypeUnique, artype, Callback, Context);
13838     if (ConstructServiceName(&rr->namestorage, name, type, domain) == mDNSNULL) return(mStatus_BadParamErr);
13839     rr->resrec.rdata->u.srv.priority    = 0;
13840     rr->resrec.rdata->u.srv.weight      = 0;
13841     rr->resrec.rdata->u.srv.port        = zeroIPPort;
13842     if (host && host->c[0]) AssignDomainName(&rr->resrec.rdata->u.srv.target, host);
13843     else rr->AutoTarget = Target_AutoHost;
13844     return(mDNS_Register(m, rr));
13845 }
13846 
13847 mDNSexport mStatus mDNS_AdvertiseDomains(mDNS *const m, AuthRecord *rr,
13848                                          mDNS_DomainType DomainType, const mDNSInterfaceID InterfaceID, char *domname)
13849 {
13850     AuthRecType artype;
13851 
13852     if (InterfaceID == mDNSInterface_LocalOnly)
13853         artype = AuthRecordLocalOnly;
13854     else if (InterfaceID == mDNSInterface_P2P || InterfaceID == mDNSInterface_BLE)
13855         artype = AuthRecordP2P;
13856     else
13857         artype = AuthRecordAny;
13858     mDNS_SetupResourceRecord(rr, mDNSNULL, InterfaceID, kDNSType_PTR, kStandardTTL, kDNSRecordTypeShared, artype, mDNSNULL, mDNSNULL);
13859     if (!MakeDomainNameFromDNSNameString(&rr->namestorage, mDNS_DomainTypeNames[DomainType])) return(mStatus_BadParamErr);
13860     if (!MakeDomainNameFromDNSNameString(&rr->resrec.rdata->u.name, domname)) return(mStatus_BadParamErr);
13861     return(mDNS_Register(m, rr));
13862 }
13863 
13864 mDNSlocal mDNSBool mDNS_IdUsedInResourceRecordsList(mDNS * const m, mDNSOpaque16 id)
13865 {
13866     AuthRecord *r;
13867     for (r = m->ResourceRecords; r; r=r->next) if (mDNSSameOpaque16(id, r->updateid)) return mDNStrue;
13868     return mDNSfalse;
13869 }
13870 
13871 mDNSlocal mDNSBool mDNS_IdUsedInQuestionsList(mDNS * const m, mDNSOpaque16 id)
13872 {
13873     DNSQuestion *q;
13874     for (q = m->Questions; q; q=q->next) if (mDNSSameOpaque16(id, q->TargetQID)) return mDNStrue;
13875     return mDNSfalse;
13876 }
13877 
13878 mDNSexport mDNSOpaque16 mDNS_NewMessageID(mDNS * const m)
13879 {
13880     mDNSOpaque16 id;
13881     int i;
13882 
13883     for (i=0; i<10; i++)
13884     {
13885         id = mDNSOpaque16fromIntVal(1 + (mDNSu16)mDNSRandom(0xFFFE));
13886         if (!mDNS_IdUsedInResourceRecordsList(m, id) && !mDNS_IdUsedInQuestionsList(m, id)) break;
13887     }
13888 
13889     debugf("mDNS_NewMessageID: %5d", mDNSVal16(id));
13890 
13891     return id;
13892 }
13893 
13894 // ***************************************************************************
13895 #if COMPILER_LIKES_PRAGMA_MARK
13896 #pragma mark -
13897 #pragma mark - Sleep Proxy Server
13898 #endif
13899 
13900 mDNSlocal void RestartARPProbing(mDNS *const m, AuthRecord *const rr)
13901 {
13902     // If we see an ARP from a machine we think is sleeping, then either
13903     // (i) the machine has woken, or
13904     // (ii) it's just a stray old packet from before the machine slept
13905     // To handle the second case, we reset ProbeCount, so we'll suppress our own answers for a while, to avoid
13906     // generating ARP conflicts with a waking machine, and set rr->LastAPTime so we'll start probing again in 10 seconds.
13907     // If the machine has just woken then we'll discard our records when we see the first new mDNS probe from that machine.
13908     // If it was a stray old packet, then after 10 seconds we'll probe again and then start answering ARPs again. In this case we *do*
13909     // need to send new ARP Announcements, because the owner's ARP broadcasts will have updated neighboring ARP caches, so we need to
13910     // re-assert our (temporary) ownership of that IP address in order to receive subsequent packets addressed to that IPv4 address.
13911 
13912     rr->resrec.RecordType = kDNSRecordTypeUnique;
13913     rr->ProbeCount        = DefaultProbeCountForTypeUnique;
13914     rr->ProbeRestartCount++;
13915 
13916     // If we haven't started announcing yet (and we're not already in ten-second-delay mode) the machine is probably
13917     // still going to sleep, so we just reset rr->ProbeCount so we'll continue probing until it stops responding.
13918     // If we *have* started announcing, the machine is probably in the process of waking back up, so in that case
13919     // we're more cautious and we wait ten seconds before probing it again. We do this because while waking from
13920     // sleep, some network interfaces tend to lose or delay inbound packets, and without this delay, if the waking machine
13921     // didn't answer our three probes within three seconds then we'd announce and cause it an unnecessary address conflict.
13922     if (rr->AnnounceCount == InitialAnnounceCount && m->timenow - rr->LastAPTime >= 0)
13923         InitializeLastAPTime(m, rr);
13924     else
13925     {
13926         rr->AnnounceCount  = InitialAnnounceCount;
13927         rr->ThisAPInterval = mDNSPlatformOneSecond;
13928         rr->LastAPTime     = m->timenow + mDNSPlatformOneSecond * 9;    // Send first packet at rr->LastAPTime + rr->ThisAPInterval, i.e. 10 seconds from now
13929         SetNextAnnounceProbeTime(m, rr);
13930     }
13931 }
13932 
13933 mDNSlocal void mDNSCoreReceiveRawARP(mDNS *const m, const ARP_EthIP *const arp, const mDNSInterfaceID InterfaceID)
13934 {
13935     static const mDNSOpaque16 ARP_op_request = { { 0, 1 } };
13936     AuthRecord *rr;
13937     NetworkInterfaceInfo *intf = FirstInterfaceForID(m, InterfaceID);
13938     if (!intf) return;
13939 
13940     mDNS_Lock(m);
13941 
13942     // Pass 1:
13943     // Process ARP Requests and Probes (but not Announcements), and generate an ARP Reply if necessary.
13944     // We also process ARPs from our own kernel (and 'answer' them by injecting a local ARP table entry)
13945     // We ignore ARP Announcements here -- Announcements are not questions, they're assertions, so we don't need to answer them.
13946     // The times we might need to react to an ARP Announcement are:
13947     // (i) as an indication that the host in question has not gone to sleep yet (so we should delay beginning to proxy for it) or
13948     // (ii) if it's a conflicting Announcement from another host
13949     // -- and we check for these in Pass 2 below.
13950     if (mDNSSameOpaque16(arp->op, ARP_op_request) && !mDNSSameIPv4Address(arp->spa, arp->tpa))
13951     {
13952         for (rr = m->ResourceRecords; rr; rr=rr->next)
13953             if (rr->resrec.InterfaceID == InterfaceID && rr->resrec.RecordType != kDNSRecordTypeDeregistering &&
13954                 rr->AddressProxy.type == mDNSAddrType_IPv4 && mDNSSameIPv4Address(rr->AddressProxy.ip.v4, arp->tpa))
13955             {
13956                 static const char msg1[] = "ARP Req from owner -- re-probing";
13957                 static const char msg2[] = "Ignoring  ARP Request from      ";
13958                 static const char msg3[] = "Creating Local ARP Cache entry  ";
13959                 static const char msg4[] = "Answering ARP Request from      ";
13960                 const char *const msg = mDNSSameEthAddress(&arp->sha, &rr->WakeUp.IMAC) ? msg1 :
13961                                         (rr->AnnounceCount == InitialAnnounceCount)     ? msg2 :
13962                                         mDNSSameEthAddress(&arp->sha, &intf->MAC)       ? msg3 : msg4;
13963                 LogMsg("Arp %-7s %s %.6a %.4a for %.4a -- H-MAC %.6a I-MAC %.6a %s",
13964                        intf->ifname, msg, arp->sha.b, arp->spa.b, arp->tpa.b,
13965                        &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, ARDisplayString(m, rr));
13966                 if (msg == msg1)
13967                 {
13968                     if ( rr->ProbeRestartCount < MAX_PROBE_RESTARTS)
13969                         RestartARPProbing(m, rr);
13970                     else
13971                         LogSPS("Reached maximum number of restarts for probing - %s", ARDisplayString(m,rr));
13972                 }
13973                 else if (msg == msg3)
13974                 {
13975                     mDNSPlatformSetLocalAddressCacheEntry(&rr->AddressProxy, &rr->WakeUp.IMAC, InterfaceID);
13976                 }
13977                 else if (msg == msg4)
13978                 {
13979 		    mDNSv4Addr tpa = arp->tpa;
13980 		    mDNSv4Addr spa = arp->spa;
13981                     SendARP(m, 2, rr, &tpa, &arp->sha, &spa, &arp->sha);
13982                 }
13983             }
13984     }
13985 
13986     // Pass 2:
13987     // For all types of ARP packet we check the Sender IP address to make sure it doesn't conflict with any AddressProxy record we're holding.
13988     // (Strictly speaking we're only checking Announcement/Request/Reply packets, since ARP Probes have zero Sender IP address,
13989     // so by definition (and by design) they can never conflict with any real (i.e. non-zero) IP address).
13990     // We ignore ARPs we sent ourselves (Sender MAC address is our MAC address) because our own proxy ARPs do not constitute a conflict that we need to handle.
13991     // If we see an apparently conflicting ARP, we check the sender hardware address:
13992     //   If the sender hardware address is the original owner this is benign, so we just suppress our own proxy answering for a while longer.
13993     //   If the sender hardware address is *not* the original owner, then this is a conflict, and we need to wake the sleeping machine to handle it.
13994     if (mDNSSameEthAddress(&arp->sha, &intf->MAC))
13995         debugf("ARP from self for %.4a", arp->tpa.b);
13996     else
13997     {
13998         if (!mDNSSameIPv4Address(arp->spa, zerov4Addr))
13999             for (rr = m->ResourceRecords; rr; rr=rr->next)
14000                 if (rr->resrec.InterfaceID == InterfaceID && rr->resrec.RecordType != kDNSRecordTypeDeregistering &&
14001                     rr->AddressProxy.type == mDNSAddrType_IPv4 && mDNSSameIPv4Address(rr->AddressProxy.ip.v4, arp->spa) && (rr->ProbeRestartCount < MAX_PROBE_RESTARTS))
14002                 {
14003                     if (mDNSSameEthAddress(&zeroEthAddr, &rr->WakeUp.HMAC))
14004                     {
14005                         LogMsg("%-7s ARP from %.6a %.4a for %.4a -- Invalid H-MAC %.6a I-MAC %.6a %s", intf->ifname,
14006                                 arp->sha.b, arp->spa.b, arp->tpa.b, &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, ARDisplayString(m, rr));
14007                     }
14008                     else
14009                     {
14010                         RestartARPProbing(m, rr);
14011                         if (mDNSSameEthAddress(&arp->sha, &rr->WakeUp.IMAC))
14012                         {
14013                             LogMsg("%-7s ARP %s from owner %.6a %.4a for %-15.4a -- re-starting probing for %s", intf->ifname,
14014                                     mDNSSameIPv4Address(arp->spa, arp->tpa) ? "Announcement " : mDNSSameOpaque16(arp->op, ARP_op_request) ? "Request      " : "Response     ",
14015                                     arp->sha.b, arp->spa.b, arp->tpa.b, ARDisplayString(m, rr));
14016                         }
14017                         else
14018                         {
14019                             LogMsg("%-7s Conflicting ARP from %.6a %.4a for %.4a -- waking H-MAC %.6a I-MAC %.6a %s", intf->ifname,
14020                                     arp->sha.b, arp->spa.b, arp->tpa.b, &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, ARDisplayString(m, rr));
14021                             ScheduleWakeup(m, rr->resrec.InterfaceID, &rr->WakeUp.HMAC);
14022                         }
14023                     }
14024                 }
14025     }
14026 
14027     mDNS_Unlock(m);
14028 }
14029 
14030 /*
14031    // Option 1 is Source Link Layer Address Option
14032    // Option 2 is Target Link Layer Address Option
14033    mDNSlocal const mDNSEthAddr *GetLinkLayerAddressOption(const IPv6NDP *const ndp, const mDNSu8 *const end, mDNSu8 op)
14034     {
14035     const mDNSu8 *options = (mDNSu8 *)(ndp+1);
14036     while (options < end)
14037         {
14038         debugf("NDP Option %02X len %2d %d", options[0], options[1], end - options);
14039         if (options[0] == op && options[1] == 1) return (const mDNSEthAddr*)(options+2);
14040         options += options[1] * 8;
14041         }
14042     return mDNSNULL;
14043     }
14044  */
14045 
14046 mDNSlocal void mDNSCoreReceiveRawND(mDNS *const m, const mDNSEthAddr *const sha, const mDNSv6Addr *spa,
14047                                     const IPv6NDP *const ndp, const mDNSu8 *const end, const mDNSInterfaceID InterfaceID)
14048 {
14049     AuthRecord *rr;
14050     NetworkInterfaceInfo *intf = FirstInterfaceForID(m, InterfaceID);
14051     if (!intf) return;
14052 
14053     mDNS_Lock(m);
14054 
14055     // Pass 1: Process Neighbor Solicitations, and generate a Neighbor Advertisement if necessary.
14056     if (ndp->type == NDP_Sol)
14057     {
14058         //const mDNSEthAddr *const sha = GetLinkLayerAddressOption(ndp, end, NDP_SrcLL);
14059         (void)end;
14060         for (rr = m->ResourceRecords; rr; rr=rr->next)
14061             if (rr->resrec.InterfaceID == InterfaceID && rr->resrec.RecordType != kDNSRecordTypeDeregistering &&
14062                 rr->AddressProxy.type == mDNSAddrType_IPv6 && mDNSSameIPv6Address(rr->AddressProxy.ip.v6, ndp->target))
14063             {
14064                 static const char msg1[] = "NDP Req from owner -- re-probing";
14065                 static const char msg2[] = "Ignoring  NDP Request from      ";
14066                 static const char msg3[] = "Creating Local NDP Cache entry  ";
14067                 static const char msg4[] = "Answering NDP Request from      ";
14068                 static const char msg5[] = "Answering NDP Probe   from      ";
14069                 const char *const msg = sha && mDNSSameEthAddress(sha, &rr->WakeUp.IMAC) ? msg1 :
14070                                         (rr->AnnounceCount == InitialAnnounceCount)      ? msg2 :
14071                                         sha && mDNSSameEthAddress(sha, &intf->MAC)       ? msg3 :
14072                                         spa && mDNSIPv6AddressIsZero(*spa)               ? msg4 : msg5;
14073                 LogSPS("%-7s %s %.6a %.16a for %.16a -- H-MAC %.6a I-MAC %.6a %s",
14074                        intf->ifname, msg, sha, spa, &ndp->target, &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, ARDisplayString(m, rr));
14075                 if (msg == msg1)
14076                 {
14077                     if (rr->ProbeRestartCount < MAX_PROBE_RESTARTS)
14078                         RestartARPProbing(m, rr);
14079                     else
14080                         LogSPS("Reached maximum number of restarts for probing - %s", ARDisplayString(m,rr));
14081                 }
14082                 else if (msg == msg3)
14083                     mDNSPlatformSetLocalAddressCacheEntry(&rr->AddressProxy, &rr->WakeUp.IMAC, InterfaceID);
14084                 else if (msg == msg4)
14085                     SendNDP(m, NDP_Adv, NDP_Solicited, rr, &ndp->target, mDNSNULL, spa, sha);
14086                 else if (msg == msg5)
14087                     SendNDP(m, NDP_Adv, 0, rr, &ndp->target, mDNSNULL, &AllHosts_v6, &AllHosts_v6_Eth);
14088             }
14089     }
14090 
14091     // Pass 2: For all types of NDP packet we check the Sender IP address to make sure it doesn't conflict with any AddressProxy record we're holding.
14092     if (mDNSSameEthAddress(sha, &intf->MAC))
14093         debugf("NDP from self for %.16a", &ndp->target);
14094     else
14095     {
14096         // For Neighbor Advertisements we check the Target address field, not the actual IPv6 source address.
14097         // When a machine has both link-local and routable IPv6 addresses, it may send NDP packets making assertions
14098         // about its routable IPv6 address, using its link-local address as the source address for all NDP packets.
14099         // Hence it is the NDP target address we care about, not the actual packet source address.
14100         if (ndp->type == NDP_Adv) spa = &ndp->target;
14101         if (!mDNSSameIPv6Address(*spa, zerov6Addr))
14102             for (rr = m->ResourceRecords; rr; rr=rr->next)
14103                 if (rr->resrec.InterfaceID == InterfaceID && rr->resrec.RecordType != kDNSRecordTypeDeregistering &&
14104                     rr->AddressProxy.type == mDNSAddrType_IPv6 && mDNSSameIPv6Address(rr->AddressProxy.ip.v6, *spa) && (rr->ProbeRestartCount < MAX_PROBE_RESTARTS))
14105                 {
14106                     if (mDNSSameEthAddress(&zeroEthAddr, &rr->WakeUp.HMAC))
14107                     {
14108                         LogSPS("%-7s NDP from %.6a %.16a for %.16a -- Invalid H-MAC %.6a I-MAC %.6a %s", intf->ifname,
14109                                     sha, spa, &ndp->target, &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, ARDisplayString(m, rr));
14110                     }
14111                     else
14112                     {
14113                         RestartARPProbing(m, rr);
14114                         if (mDNSSameEthAddress(sha, &rr->WakeUp.IMAC))
14115                         {
14116                             LogSPS("%-7s NDP %s from owner %.6a %.16a for %.16a -- re-starting probing for %s", intf->ifname,
14117                                     ndp->type == NDP_Sol ? "Solicitation " : "Advertisement", sha, spa, &ndp->target, ARDisplayString(m, rr));
14118                         }
14119                         else
14120                         {
14121                             LogMsg("%-7s Conflicting NDP from %.6a %.16a for %.16a -- waking H-MAC %.6a I-MAC %.6a %s", intf->ifname,
14122                                     sha, spa, &ndp->target, &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, ARDisplayString(m, rr));
14123                             ScheduleWakeup(m, rr->resrec.InterfaceID, &rr->WakeUp.HMAC);
14124                         }
14125                     }
14126                 }
14127     }
14128 
14129     mDNS_Unlock(m);
14130 }
14131 
14132 mDNSlocal void mDNSCoreReceiveRawTransportPacket(mDNS *const m, const mDNSEthAddr *const sha, const mDNSAddr *const src, const mDNSAddr *const dst, const mDNSu8 protocol,
14133                                                  const mDNSu8 *const p, const TransportLayerPacket *const t, const mDNSu8 *const end, const mDNSInterfaceID InterfaceID, const mDNSu16 len)
14134 {
14135     const mDNSIPPort port = (protocol == 0x06) ? t->tcp.dst : (protocol == 0x11) ? t->udp.dst : zeroIPPort;
14136     mDNSBool wake = mDNSfalse;
14137     mDNSBool kaWake = mDNSfalse;
14138 
14139     switch (protocol)
14140     {
14141         #define XX wake ? "Received" : "Ignoring", end-p
14142     case 0x01:  LogSPS("Ignoring %d-byte ICMP from %#a to %#a", end-p, src, dst);
14143         break;
14144 
14145     case 0x06:  {
14146         AuthRecord *kr;
14147         mDNSu32 seq, ack;
14148                     #define TH_FIN  0x01
14149                     #define TH_SYN  0x02
14150                     #define TH_RST  0x04
14151                     #define TH_ACK  0x10
14152 
14153         kr = mDNS_MatchKeepaliveInfo(m, dst, src, port, t->tcp.src, &seq, &ack);
14154         if (kr)
14155         {
14156             LogSPS("mDNSCoreReceiveRawTransportPacket: Found a Keepalive record from %#a:%d  to %#a:%d", src, mDNSVal16(t->tcp.src), dst, mDNSVal16(port));
14157             // Plan to wake if
14158             // (a) RST or FIN is set (the keepalive that we sent could have caused a reset)
14159             // (b) packet that contains new data and acks a sequence number higher than the one
14160             //     we have been sending in the keepalive
14161 
14162             wake = ((t->tcp.flags & TH_RST) || (t->tcp.flags & TH_FIN)) ;
14163             if (!wake)
14164             {
14165                 mDNSu8 *ptr;
14166                 mDNSu32 pseq, pack;
14167                 mDNSBool data = mDNSfalse;
14168                 mDNSu8 tcphlen;
14169 
14170                 // Convert to host order
14171                 ptr = (mDNSu8 *)&seq;
14172                 seq = ptr[0] << 24 | ptr[1] << 16 | ptr[2] << 8 | ptr[3];
14173 
14174                 ptr = (mDNSu8 *)&ack;
14175                 ack = ptr[0] << 24 | ptr[1] << 16 | ptr[2] << 8 | ptr[3];
14176 
14177                 pseq = t->tcp.seq;
14178                 ptr = (mDNSu8 *)&pseq;
14179                 pseq = ptr[0] << 24 | ptr[1] << 16 | ptr[2] << 8 | ptr[3];
14180 
14181                 pack = t->tcp.ack;
14182                 ptr = (mDNSu8 *)&pack;
14183                 pack = ptr[0] << 24 | ptr[1] << 16 | ptr[2] << 8 | ptr[3];
14184 
14185                 // If the other side is acking one more than our sequence number (keepalive is one
14186                 // less than the last valid sequence sent) and it's sequence is more than what we
14187                 // acked before
14188                 //if (end - p - 34  - ((t->tcp.offset >> 4) * 4) > 0) data = mDNStrue;
14189                 tcphlen = ((t->tcp.offset >> 4) * 4);
14190                 if (end - ((mDNSu8 *)t + tcphlen) > 0) data = mDNStrue;
14191                 wake = ((int)(pack - seq) > 0) && ((int)(pseq - ack) >= 0) && data;
14192 
14193                 // If we got a regular keepalive on a connection that was registed with the KeepAlive API, respond with an ACK
14194                 if ((t->tcp.flags & TH_ACK) && (data == mDNSfalse) &&
14195                     ((int)(ack - pseq) == 1))
14196                 {
14197                     // Send an ACK;
14198                     mDNS_SendKeepaliveACK(m, kr);
14199                 }
14200                 LogSPS("mDNSCoreReceiveRawTransportPacket: End %p, hlen %d, Datalen %d, pack %u, seq %u, pseq %u, ack %u, wake %d",
14201                        end, tcphlen, end - ((mDNSu8 *)t + tcphlen), pack, seq, pseq, ack, wake);
14202             }
14203             else { LogSPS("mDNSCoreReceiveRawTransportPacket: waking because of RST or FIN th_flags %d", t->tcp.flags); }
14204             kaWake = wake;
14205         }
14206         else
14207         {
14208             // Plan to wake if
14209             // (a) RST is not set, AND
14210             // (b) packet is SYN, SYN+FIN, or plain data packet (no SYN or FIN). We won't wake for FIN alone.
14211             wake = (!(t->tcp.flags & TH_RST) && (t->tcp.flags & (TH_FIN|TH_SYN)) != TH_FIN);
14212 
14213             // For now, to reduce spurious wakeups, we wake only for TCP SYN,
14214             // except for ssh connections, where we'll wake for plain data packets too
14215             if  (!mDNSSameIPPort(port, SSHPort) && !(t->tcp.flags & 2)) wake = mDNSfalse;
14216 
14217             LogSPS("%s %d-byte TCP from %#a:%d to %#a:%d%s%s%s", XX,
14218                    src, mDNSVal16(t->tcp.src), dst, mDNSVal16(port),
14219                    (t->tcp.flags & 2) ? " SYN" : "",
14220                    (t->tcp.flags & 1) ? " FIN" : "",
14221                    (t->tcp.flags & 4) ? " RST" : "");
14222         }
14223         break;
14224     }
14225 
14226     case 0x11:  {
14227                     #define ARD_AsNumber 3283
14228         static const mDNSIPPort ARD = { { ARD_AsNumber >> 8, ARD_AsNumber & 0xFF } };
14229         const mDNSu16 udplen = (mDNSu16)((mDNSu16)t->bytes[4] << 8 | t->bytes[5]);                  // Length *including* 8-byte UDP header
14230         if (udplen >= sizeof(UDPHeader))
14231         {
14232             const mDNSu16 datalen = udplen - sizeof(UDPHeader);
14233             wake = mDNStrue;
14234 
14235             // For Back to My Mac UDP port 4500 (IPSEC) packets, we do some special handling
14236             if (mDNSSameIPPort(port, IPSECPort))
14237             {
14238                 // Specifically ignore NAT keepalive packets
14239                 if (datalen == 1 && end >= &t->bytes[9] && t->bytes[8] == 0xFF) wake = mDNSfalse;
14240                 else
14241                 {
14242                     // Skip over the Non-ESP Marker if present
14243                     const mDNSBool NonESP = (end >= &t->bytes[12] && t->bytes[8] == 0 && t->bytes[9] == 0 && t->bytes[10] == 0 && t->bytes[11] == 0);
14244                     const IKEHeader *const ike    = (IKEHeader *)(t + (NonESP ? 12 : 8));
14245                     const mDNSu16 ikelen = datalen - (NonESP ? 4 : 0);
14246                     if (ikelen >= sizeof(IKEHeader) && end >= ((mDNSu8 *)ike) + sizeof(IKEHeader))
14247                         if ((ike->Version & 0x10) == 0x10)
14248                         {
14249                             // ExchangeType ==  5 means 'Informational' <http://www.ietf.org/rfc/rfc2408.txt>
14250                             // ExchangeType == 34 means 'IKE_SA_INIT'   <http://www.iana.org/assignments/ikev2-parameters>
14251                             if (ike->ExchangeType == 5 || ike->ExchangeType == 34) wake = mDNSfalse;
14252                             LogSPS("%s %d-byte IKE ExchangeType %d", XX, ike->ExchangeType);
14253                         }
14254                 }
14255             }
14256 
14257             // For now, because we haven't yet worked out a clean elegant way to do this, we just special-case the
14258             // Apple Remote Desktop port number -- we ignore all packets to UDP 3283 (the "Net Assistant" port),
14259             // except for Apple Remote Desktop's explicit manual wakeup packet, which looks like this:
14260             // UDP header (8 bytes)
14261             // Payload: 13 88 00 6a 41 4e 41 20 (8 bytes) ffffffffffff (6 bytes) 16xMAC (96 bytes) = 110 bytes total
14262             if (mDNSSameIPPort(port, ARD)) wake = (datalen >= 110 && end >= &t->bytes[10] && t->bytes[8] == 0x13 && t->bytes[9] == 0x88);
14263 
14264             LogSPS("%s %d-byte UDP from %#a:%d to %#a:%d", XX, src, mDNSVal16(t->udp.src), dst, mDNSVal16(port));
14265         }
14266     }
14267     break;
14268 
14269     case 0x3A:  if (&t->bytes[len] <= end)
14270         {
14271             mDNSu16 checksum = IPv6CheckSum(&src->ip.v6, &dst->ip.v6, protocol, t->bytes, len);
14272             if (!checksum) mDNSCoreReceiveRawND(m, sha, &src->ip.v6, &t->ndp, &t->bytes[len], InterfaceID);
14273             else LogInfo("IPv6CheckSum bad %04X %02X%02X from %#a to %#a", checksum, t->bytes[2], t->bytes[3], src, dst);
14274         }
14275         break;
14276 
14277     default:    LogSPS("Ignoring %d-byte IP packet unknown protocol %d from %#a to %#a", end-p, protocol, src, dst);
14278         break;
14279     }
14280 
14281     if (wake)
14282     {
14283         AuthRecord *rr, *r2;
14284 
14285         mDNS_Lock(m);
14286         for (rr = m->ResourceRecords; rr; rr=rr->next)
14287             if (rr->resrec.InterfaceID == InterfaceID &&
14288                 rr->resrec.RecordType != kDNSRecordTypeDeregistering &&
14289                 rr->AddressProxy.type && mDNSSameAddress(&rr->AddressProxy, dst))
14290             {
14291                 const mDNSu8 *const tp = (protocol == 6) ? (const mDNSu8 *)"\x4_tcp" : (const mDNSu8 *)"\x4_udp";
14292                 for (r2 = m->ResourceRecords; r2; r2=r2->next)
14293                     if (r2->resrec.InterfaceID == InterfaceID && mDNSSameEthAddress(&r2->WakeUp.HMAC, &rr->WakeUp.HMAC) &&
14294                         r2->resrec.RecordType != kDNSRecordTypeDeregistering &&
14295                         r2->resrec.rrtype == kDNSType_SRV && mDNSSameIPPort(r2->resrec.rdata->u.srv.port, port) &&
14296                         SameDomainLabel(ThirdLabel(r2->resrec.name)->c, tp))
14297                         break;
14298                 if (!r2 && mDNSSameIPPort(port, IPSECPort)) r2 = rr;    // So that we wake for BTMM IPSEC packets, even without a matching SRV record
14299                 if (!r2 && kaWake) r2 = rr;                             // So that we wake for keepalive packets, even without a matching SRV record
14300                 if (r2)
14301                 {
14302                     LogMsg("Waking host at %s %#a H-MAC %.6a I-MAC %.6a for %s",
14303                            InterfaceNameForID(m, rr->resrec.InterfaceID), dst, &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, ARDisplayString(m, r2));
14304                     ScheduleWakeup(m, rr->resrec.InterfaceID, &rr->WakeUp.HMAC);
14305                 }
14306                 else
14307                     LogSPS("Sleeping host at %s %#a %.6a has no service on %#s %d",
14308                            InterfaceNameForID(m, rr->resrec.InterfaceID), dst, &rr->WakeUp.HMAC, tp, mDNSVal16(port));
14309             }
14310         mDNS_Unlock(m);
14311     }
14312 }
14313 
14314 mDNSexport void mDNSCoreReceiveRawPacket(mDNS *const m, const mDNSu8 *const p, const mDNSu8 *const end, const mDNSInterfaceID InterfaceID)
14315 {
14316     static const mDNSOpaque16 Ethertype_ARP  = { { 0x08, 0x06 } };  // Ethertype 0x0806 = ARP
14317     static const mDNSOpaque16 Ethertype_IPv4 = { { 0x08, 0x00 } };  // Ethertype 0x0800 = IPv4
14318     static const mDNSOpaque16 Ethertype_IPv6 = { { 0x86, 0xDD } };  // Ethertype 0x86DD = IPv6
14319     static const mDNSOpaque16 ARP_hrd_eth    = { { 0x00, 0x01 } };  // Hardware address space (Ethernet = 1)
14320     static const mDNSOpaque16 ARP_pro_ip     = { { 0x08, 0x00 } };  // Protocol address space (IP = 0x0800)
14321 
14322     // Note: BPF guarantees that the NETWORK LAYER header will be word aligned, not the link-layer header.
14323     // In other words, we can safely assume that pkt below (ARP, IPv4 or IPv6) is properly word aligned,
14324     // but if pkt is 4-byte aligned, that necessarily means that eth CANNOT also be 4-byte aligned
14325     // since it points to a an address 14 bytes before pkt.
14326     const EthernetHeader     *const eth = (const EthernetHeader *)p;
14327     const NetworkLayerPacket *const pkt = (const NetworkLayerPacket *)(eth+1);
14328     mDNSAddr src, dst;
14329     #define RequiredCapLen(P) ((P)==0x01 ? 4 : (P)==0x06 ? 20 : (P)==0x11 ? 8 : (P)==0x3A ? 24 : 0)
14330 
14331     // Is ARP? Length must be at least 14 + 28 = 42 bytes
14332     if (end >= p+42 && mDNSSameOpaque16(eth->ethertype, Ethertype_ARP) && mDNSSameOpaque16(pkt->arp.hrd, ARP_hrd_eth) && mDNSSameOpaque16(pkt->arp.pro, ARP_pro_ip))
14333         mDNSCoreReceiveRawARP(m, &pkt->arp, InterfaceID);
14334     // Is IPv4 with zero fragmentation offset? Length must be at least 14 + 20 = 34 bytes
14335     else if (end >= p+34 && mDNSSameOpaque16(eth->ethertype, Ethertype_IPv4) && (pkt->v4.flagsfrags.b[0] & 0x1F) == 0 && pkt->v4.flagsfrags.b[1] == 0)
14336     {
14337         const mDNSu8 *const trans = p + 14 + (pkt->v4.vlen & 0xF) * 4;
14338         const mDNSu8 * transEnd = p + 14 + mDNSVal16(pkt->v4.totlen);
14339         if (transEnd > end) transEnd = end;
14340         debugf("Got IPv4 %02X from %.4a to %.4a", pkt->v4.protocol, &pkt->v4.src, &pkt->v4.dst);
14341         src.type = mDNSAddrType_IPv4; src.ip.v4 = pkt->v4.src;
14342         dst.type = mDNSAddrType_IPv4; dst.ip.v4 = pkt->v4.dst;
14343         if (transEnd >= trans + RequiredCapLen(pkt->v4.protocol))
14344             mDNSCoreReceiveRawTransportPacket(m, &eth->src, &src, &dst, pkt->v4.protocol, p, (TransportLayerPacket*)trans, transEnd, InterfaceID, 0);
14345     }
14346     // Is IPv6? Length must be at least 14 + 28 = 42 bytes
14347     else if (end >= p+54 && mDNSSameOpaque16(eth->ethertype, Ethertype_IPv6))
14348     {
14349         const mDNSu8 *const trans = p + 54;
14350         debugf("Got IPv6  %02X from %.16a to %.16a", pkt->v6.pro, &pkt->v6.src, &pkt->v6.dst);
14351         src.type = mDNSAddrType_IPv6; src.ip.v6 = pkt->v6.src;
14352         dst.type = mDNSAddrType_IPv6; dst.ip.v6 = pkt->v6.dst;
14353         if (end >= trans + RequiredCapLen(pkt->v6.pro))
14354             mDNSCoreReceiveRawTransportPacket(m, &eth->src, &src, &dst, pkt->v6.pro, p, (TransportLayerPacket*)trans, end, InterfaceID,
14355                                               (mDNSu16)pkt->bytes[4] << 8 | pkt->bytes[5]);
14356     }
14357 }
14358 
14359 mDNSlocal void ConstructSleepProxyServerName(mDNS *const m, domainlabel *name)
14360 {
14361     name->c[0] = (mDNSu8)mDNS_snprintf((char*)name->c+1, 62, "%d-%d-%d-%d.%d %#s",
14362                                        m->SPSType, m->SPSPortability, m->SPSMarginalPower, m->SPSTotalPower, m->SPSFeatureFlags, &m->nicelabel);
14363 }
14364 
14365 #ifndef SPC_DISABLED
14366 mDNSlocal void SleepProxyServerCallback(mDNS *const m, ServiceRecordSet *const srs, mStatus result)
14367 {
14368     if (result == mStatus_NameConflict)
14369         mDNS_RenameAndReregisterService(m, srs, mDNSNULL);
14370     else if (result == mStatus_MemFree)
14371     {
14372         if (m->SleepState)
14373             m->SPSState = 3;
14374         else
14375         {
14376             m->SPSState = (mDNSu8)(m->SPSSocket != mDNSNULL);
14377             if (m->SPSState)
14378             {
14379                 domainlabel name;
14380                 ConstructSleepProxyServerName(m, &name);
14381                 mDNS_RegisterService(m, srs,
14382                                      &name, &SleepProxyServiceType, &localdomain,
14383                                      mDNSNULL, m->SPSSocket->port, // Host, port
14384                                      mDNSNULL,
14385                                      (mDNSu8 *)"", 1,           // TXT data, length
14386                                      mDNSNULL, 0,               // Subtypes (none)
14387                                      mDNSInterface_Any,         // Interface ID
14388                                      SleepProxyServerCallback, mDNSNULL, 0); // Callback, context, flags
14389             }
14390             LogSPS("Sleep Proxy Server %#s %s", srs->RR_SRV.resrec.name->c, m->SPSState ? "started" : "stopped");
14391         }
14392     }
14393 }
14394 #endif
14395 
14396 // Called with lock held
14397 mDNSexport void mDNSCoreBeSleepProxyServer_internal(mDNS *const m, mDNSu8 sps, mDNSu8 port, mDNSu8 marginalpower, mDNSu8 totpower, mDNSu8 features)
14398 {
14399     // This routine uses mDNS_DeregisterService and calls SleepProxyServerCallback, so we execute in user callback context
14400     mDNS_DropLockBeforeCallback();
14401 
14402     // If turning off SPS, close our socket
14403     // (Do this first, BEFORE calling mDNS_DeregisterService below)
14404     if (!sps && m->SPSSocket) { mDNSPlatformUDPClose(m->SPSSocket); m->SPSSocket = mDNSNULL; }
14405 
14406     // If turning off, or changing type, deregister old name
14407 #ifndef SPC_DISABLED
14408     if (m->SPSState == 1 && sps != m->SPSType)
14409     { m->SPSState = 2; mDNS_DeregisterService_drt(m, &m->SPSRecords, sps ? mDNS_Dereg_rapid : mDNS_Dereg_normal); }
14410 #endif // SPC_DISABLED
14411 
14412     // Record our new SPS parameters
14413     m->SPSType          = sps;
14414     m->SPSPortability   = port;
14415     m->SPSMarginalPower = marginalpower;
14416     m->SPSTotalPower    = totpower;
14417     m->SPSFeatureFlags  = features;
14418     // If turning on, open socket and advertise service
14419     if (sps)
14420     {
14421         if (!m->SPSSocket)
14422         {
14423             m->SPSSocket = mDNSPlatformUDPSocket(zeroIPPort);
14424             if (!m->SPSSocket) { LogMsg("mDNSCoreBeSleepProxyServer: Failed to allocate SPSSocket"); goto fail; }
14425         }
14426 #ifndef SPC_DISABLED
14427         if (m->SPSState == 0) SleepProxyServerCallback(m, &m->SPSRecords, mStatus_MemFree);
14428 #endif // SPC_DISABLED
14429     }
14430     else if (m->SPSState)
14431     {
14432         LogSPS("mDNSCoreBeSleepProxyServer turning off from state %d; will wake clients", m->SPSState);
14433         m->NextScheduledSPS = m->timenow;
14434     }
14435 fail:
14436     mDNS_ReclaimLockAfterCallback();
14437 }
14438 
14439 // ***************************************************************************
14440 #if COMPILER_LIKES_PRAGMA_MARK
14441 #pragma mark -
14442 #pragma mark - Startup and Shutdown
14443 #endif
14444 
14445 mDNSlocal void mDNS_GrowCache_internal(mDNS *const m, CacheEntity *storage, mDNSu32 numrecords)
14446 {
14447     if (storage && numrecords)
14448     {
14449         mDNSu32 i;
14450         debugf("Adding cache storage for %d more records (%d bytes)", numrecords, numrecords*sizeof(CacheEntity));
14451         for (i=0; i<numrecords; i++) storage[i].next = &storage[i+1];
14452         storage[numrecords-1].next = m->rrcache_free;
14453         m->rrcache_free = storage;
14454         m->rrcache_size += numrecords;
14455     }
14456 }
14457 
14458 mDNSexport void mDNS_GrowCache(mDNS *const m, CacheEntity *storage, mDNSu32 numrecords)
14459 {
14460     mDNS_Lock(m);
14461     mDNS_GrowCache_internal(m, storage, numrecords);
14462     mDNS_Unlock(m);
14463 }
14464 
14465 mDNSlocal mStatus mDNS_InitStorage(mDNS *const m, mDNS_PlatformSupport *const p,
14466                                    CacheEntity *rrcachestorage, mDNSu32 rrcachesize,
14467                                    mDNSBool AdvertiseLocalAddresses, mDNSCallback *Callback, void *Context)
14468 {
14469     mDNSu32 slot;
14470     mDNSs32 timenow;
14471     mStatus result;
14472 
14473     if (!rrcachestorage) rrcachesize = 0;
14474 
14475     m->p                             = p;
14476     m->NetworkChanged                = 0;
14477     m->CanReceiveUnicastOn5353       = mDNSfalse; // Assume we can't receive unicasts on 5353, unless platform layer tells us otherwise
14478     m->AdvertiseLocalAddresses       = AdvertiseLocalAddresses;
14479     m->DivertMulticastAdvertisements = mDNSfalse;
14480     m->mDNSPlatformStatus            = mStatus_Waiting;
14481     m->UnicastPort4                  = zeroIPPort;
14482     m->UnicastPort6                  = zeroIPPort;
14483     m->PrimaryMAC                    = zeroEthAddr;
14484     m->MainCallback                  = Callback;
14485     m->MainContext                   = Context;
14486     m->rec.r.resrec.RecordType       = 0;
14487     m->rec.r.resrec.AnonInfo         = mDNSNULL;
14488 
14489     // For debugging: To catch and report locking failures
14490     m->mDNS_busy               = 0;
14491     m->mDNS_reentrancy         = 0;
14492     m->ShutdownTime            = 0;
14493     m->lock_rrcache            = 0;
14494     m->lock_Questions          = 0;
14495     m->lock_Records            = 0;
14496 
14497     // Task Scheduling variables
14498     result = mDNSPlatformTimeInit();
14499     if (result != mStatus_NoError) return(result);
14500     m->timenow_adjust = (mDNSs32)mDNSRandom(0xFFFFFFFF);
14501     timenow = mDNS_TimeNow_NoLock(m);
14502 
14503     m->timenow                 = 0;     // MUST only be set within mDNS_Lock/mDNS_Unlock section
14504     m->timenow_last            = timenow;
14505     m->NextScheduledEvent      = timenow;
14506     m->SuppressSending         = timenow;
14507     m->NextCacheCheck          = timenow + FutureTime;
14508     m->NextScheduledQuery      = timenow + FutureTime;
14509     m->NextScheduledProbe      = timenow + FutureTime;
14510     m->NextScheduledResponse   = timenow + FutureTime;
14511     m->NextScheduledNATOp      = timenow + FutureTime;
14512     m->NextScheduledSPS        = timenow + FutureTime;
14513     m->NextScheduledKA         = timenow + FutureTime;
14514     m->NextScheduledStopTime   = timenow + FutureTime;
14515     m->NextBLEServiceTime      = 0;    // zero indicates inactive
14516 
14517 #if BONJOUR_ON_DEMAND
14518     m->NextBonjourDisableTime  = 0; // Timer active when non zero.
14519     m->BonjourEnabled          = 0; // Set when Bonjour on Demand is enabled and Bonjour is currently enabled.
14520 #endif // BONJOUR_ON_DEMAND
14521 
14522     m->DelayConflictProcessing = MAX_CONFLICT_PROCESSING_DELAYS;
14523     m->RandomQueryDelay        = 0;
14524     m->RandomReconfirmDelay    = 0;
14525     m->PktNum                  = 0;
14526     m->MPktNum                 = 0;
14527     m->LocalRemoveEvents       = mDNSfalse;
14528     m->SleepState              = SleepState_Awake;
14529     m->SleepSeqNum             = 0;
14530     m->SystemWakeOnLANEnabled  = mDNSfalse;
14531     m->AnnounceOwner           = NonZeroTime(timenow + 60 * mDNSPlatformOneSecond);
14532     m->DelaySleep              = 0;
14533     m->SleepLimit              = 0;
14534 
14535 #if APPLE_OSX_mDNSResponder
14536     m->UnicastPacketsSent      = 0;
14537     m->MulticastPacketsSent    = 0;
14538     m->RemoteSubnet            = 0;
14539 #endif // APPLE_OSX_mDNSResponder
14540 
14541     // These fields only required for mDNS Searcher...
14542     m->Questions               = mDNSNULL;
14543     m->NewQuestions            = mDNSNULL;
14544     m->CurrentQuestion         = mDNSNULL;
14545     m->LocalOnlyQuestions      = mDNSNULL;
14546     m->NewLocalOnlyQuestions   = mDNSNULL;
14547     m->RestartQuestion         = mDNSNULL;
14548     m->ValidationQuestion      = mDNSNULL;
14549     m->rrcache_size            = 0;
14550     m->rrcache_totalused       = 0;
14551     m->rrcache_active          = 0;
14552     m->rrcache_report          = 10;
14553     m->rrcache_free            = mDNSNULL;
14554 
14555     for (slot = 0; slot < CACHE_HASH_SLOTS; slot++)
14556     {
14557         m->rrcache_hash[slot]      = mDNSNULL;
14558         m->rrcache_nextcheck[slot] = timenow + FutureTime;;
14559     }
14560 
14561     mDNS_GrowCache_internal(m, rrcachestorage, rrcachesize);
14562     m->rrauth.rrauth_free            = mDNSNULL;
14563 
14564     for (slot = 0; slot < AUTH_HASH_SLOTS; slot++)
14565         m->rrauth.rrauth_hash[slot] = mDNSNULL;
14566 
14567     // Fields below only required for mDNS Responder...
14568     m->hostlabel.c[0]          = 0;
14569     m->nicelabel.c[0]          = 0;
14570     m->MulticastHostname.c[0]  = 0;
14571     m->HIHardware.c[0]         = 0;
14572     m->HISoftware.c[0]         = 0;
14573     m->ResourceRecords         = mDNSNULL;
14574     m->DuplicateRecords        = mDNSNULL;
14575     m->NewLocalRecords         = mDNSNULL;
14576     m->NewLocalOnlyRecords     = mDNSfalse;
14577     m->CurrentRecord           = mDNSNULL;
14578     m->HostInterfaces          = mDNSNULL;
14579     m->ProbeFailTime           = 0;
14580     m->NumFailedProbes         = 0;
14581     m->SuppressProbes          = 0;
14582 
14583 #ifndef UNICAST_DISABLED
14584     m->NextuDNSEvent            = timenow + FutureTime;
14585     m->NextSRVUpdate            = timenow + FutureTime;
14586 
14587     m->DNSServers               = mDNSNULL;
14588 
14589     m->Router                   = zeroAddr;
14590     m->AdvertisedV4             = zeroAddr;
14591     m->AdvertisedV6             = zeroAddr;
14592 
14593     m->AuthInfoList             = mDNSNULL;
14594 
14595     m->ReverseMap.ThisQInterval = -1;
14596     m->StaticHostname.c[0]      = 0;
14597     m->FQDN.c[0]                = 0;
14598     m->Hostnames                = mDNSNULL;
14599     m->AutoTunnelNAT.clientContext = mDNSNULL;
14600 
14601     m->WABBrowseQueriesCount    = 0;
14602     m->WABLBrowseQueriesCount   = 0;
14603     m->WABRegQueriesCount       = 0;
14604     m->AutoTargetServices       = 1;
14605 
14606 #if BONJOUR_ON_DEMAND
14607     m->NumAllInterfaceRecords   = 0;
14608     m->NumAllInterfaceQuestions = 0;
14609 #endif
14610     // NAT traversal fields
14611     m->LLQNAT.clientCallback    = mDNSNULL;
14612     m->LLQNAT.clientContext     = mDNSNULL;
14613     m->NATTraversals            = mDNSNULL;
14614     m->CurrentNATTraversal      = mDNSNULL;
14615     m->retryIntervalGetAddr     = 0;    // delta between time sent and retry
14616     m->retryGetAddr             = timenow + FutureTime; // absolute time when we retry
14617     m->ExtAddress               = zerov4Addr;
14618     m->PCPNonce[0]              = mDNSRandom(-1);
14619     m->PCPNonce[1]              = mDNSRandom(-1);
14620     m->PCPNonce[2]              = mDNSRandom(-1);
14621 
14622     m->NATMcastRecvskt          = mDNSNULL;
14623     m->LastNATupseconds         = 0;
14624     m->LastNATReplyLocalTime    = timenow;
14625     m->LastNATMapResultCode     = NATErr_None;
14626 
14627     m->UPnPInterfaceID          = 0;
14628     m->SSDPSocket               = mDNSNULL;
14629     m->SSDPWANPPPConnection     = mDNSfalse;
14630     m->UPnPRouterPort           = zeroIPPort;
14631     m->UPnPSOAPPort             = zeroIPPort;
14632     m->UPnPRouterURL            = mDNSNULL;
14633     m->UPnPWANPPPConnection     = mDNSfalse;
14634     m->UPnPSOAPURL              = mDNSNULL;
14635     m->UPnPRouterAddressString  = mDNSNULL;
14636     m->UPnPSOAPAddressString    = mDNSNULL;
14637     m->SPSType                  = 0;
14638     m->SPSPortability           = 0;
14639     m->SPSMarginalPower         = 0;
14640     m->SPSTotalPower            = 0;
14641     m->SPSFeatureFlags          = 0;
14642     m->SPSState                 = 0;
14643     m->SPSProxyListChanged      = mDNSNULL;
14644     m->SPSSocket                = mDNSNULL;
14645     m->SPSBrowseCallback        = mDNSNULL;
14646     m->ProxyRecords             = 0;
14647 
14648     m->DNSPushServers           = mDNSNULL;
14649     m->DNSPushZones             = mDNSNULL;
14650 #endif
14651 
14652 #if APPLE_OSX_mDNSResponder
14653     m->TunnelClients            = mDNSNULL;
14654 
14655 #if !NO_WCF
14656     CHECK_WCF_FUNCTION(WCFConnectionNew)
14657     {
14658         m->WCF = WCFConnectionNew();
14659         if (!m->WCF) { LogMsg("WCFConnectionNew failed"); return -1; }
14660     }
14661 #endif
14662 
14663 #endif
14664 
14665     return(result);
14666 }
14667 
14668 mDNSexport mStatus mDNS_Init(mDNS *const m, mDNS_PlatformSupport *const p,
14669                              CacheEntity *rrcachestorage, mDNSu32 rrcachesize,
14670                              mDNSBool AdvertiseLocalAddresses, mDNSCallback *Callback, void *Context)
14671 {
14672     mStatus result = mDNS_InitStorage(m, p, rrcachestorage, rrcachesize, AdvertiseLocalAddresses, Callback, Context);
14673     if (result != mStatus_NoError)
14674         return(result);
14675 
14676     result = mDNSPlatformInit(m);
14677 
14678 #ifndef UNICAST_DISABLED
14679     // It's better to do this *after* the platform layer has set up the
14680     // interface list and security credentials
14681     uDNS_SetupDNSConfig(m);                     // Get initial DNS configuration
14682 #endif
14683 
14684     return(result);
14685 }
14686 
14687 mDNSexport void mDNS_ConfigChanged(mDNS *const m)
14688 {
14689     if (m->SPSState == 1)
14690     {
14691         domainlabel name, newname;
14692 #ifndef SPC_DISABLED
14693         domainname type, domain;
14694         DeconstructServiceName(m->SPSRecords.RR_SRV.resrec.name, &name, &type, &domain);
14695 #endif // SPC_DISABLED
14696         ConstructSleepProxyServerName(m, &newname);
14697         if (!SameDomainLabelCS(name.c, newname.c))
14698         {
14699             LogSPS("Renaming SPS from “%#s” to “%#s”", name.c, newname.c);
14700             // When SleepProxyServerCallback gets the mStatus_MemFree message,
14701             // it will reregister the service under the new name
14702             m->SPSState = 2;
14703 #ifndef SPC_DISABLED
14704             mDNS_DeregisterService_drt(m, &m->SPSRecords, mDNS_Dereg_rapid);
14705 #endif // SPC_DISABLED
14706         }
14707     }
14708 
14709     if (m->MainCallback)
14710         m->MainCallback(m, mStatus_ConfigChanged);
14711 }
14712 
14713 mDNSlocal void DynDNSHostNameCallback(mDNS *const m, AuthRecord *const rr, mStatus result)
14714 {
14715     (void)m;    // unused
14716     debugf("NameStatusCallback: result %d for registration of name %##s", result, rr->resrec.name->c);
14717     mDNSPlatformDynDNSHostNameStatusChanged(rr->resrec.name, result);
14718 }
14719 
14720 mDNSlocal void PurgeOrReconfirmCacheRecord(mDNS *const m, CacheRecord *cr, const DNSServer * const ptr, mDNSBool lameduck)
14721 {
14722     mDNSBool purge = cr->resrec.RecordType == kDNSRecordTypePacketNegative ||
14723                      cr->resrec.rrtype     == kDNSType_A ||
14724                      cr->resrec.rrtype     == kDNSType_AAAA ||
14725                      cr->resrec.rrtype     == kDNSType_SRV ||
14726                      cr->resrec.rrtype     == kDNSType_CNAME;
14727 
14728     (void) lameduck;
14729     (void) ptr;
14730     debugf("PurgeOrReconfirmCacheRecord: %s cache record due to %s server %p %#a:%d (%##s): %s",
14731            purge    ? "purging"   : "reconfirming",
14732            lameduck ? "lame duck" : "new",
14733            ptr, &ptr->addr, mDNSVal16(ptr->port), ptr->domain.c, CRDisplayString(m, cr));
14734 
14735     if (purge)
14736     {
14737         LogInfo("PurgeorReconfirmCacheRecord: Purging Resourcerecord %s, RecordType %x", CRDisplayString(m, cr), cr->resrec.RecordType);
14738         mDNS_PurgeCacheResourceRecord(m, cr);
14739     }
14740     else
14741     {
14742         LogInfo("PurgeorReconfirmCacheRecord: Reconfirming Resourcerecord %s, RecordType %x", CRDisplayString(m, cr), cr->resrec.RecordType);
14743         mDNS_Reconfirm_internal(m, cr, kDefaultReconfirmTimeForNoAnswer);
14744     }
14745 }
14746 
14747 mDNSlocal void mDNS_PurgeBeforeResolve(mDNS *const m, DNSQuestion *q)
14748 {
14749     CacheGroup *const cg = CacheGroupForName(m, q->qnamehash, &q->qname);
14750     CacheRecord *rp;
14751     mDNSu8 validatingResponse = 0;
14752 
14753     // For DNSSEC questions, purge the corresponding RRSIGs also.
14754     if (DNSSECQuestion(q))
14755     {
14756         validatingResponse = q->ValidatingResponse;
14757         q->ValidatingResponse = mDNStrue;
14758     }
14759     for (rp = cg ? cg->members : mDNSNULL; rp; rp = rp->next)
14760     {
14761         if (SameNameRecordAnswersQuestion(&rp->resrec, q))
14762         {
14763             LogInfo("mDNS_PurgeBeforeResolve: Flushing %s", CRDisplayString(m, rp));
14764             mDNS_PurgeCacheResourceRecord(m, rp);
14765         }
14766     }
14767     if (DNSSECQuestion(q))
14768     {
14769         q->ValidatingResponse = validatingResponse;
14770     }
14771 }
14772 
14773 // For DNSSEC question, we need the DNSSEC records also. If the cache does not
14774 // have the DNSSEC records, we need to re-issue the question with EDNS0/DO bit set.
14775 // Just re-issuing the question for RRSIGs does not work in practice as the response
14776 // may not contain the RRSIGs whose typeCovered field matches the question's qtype.
14777 //
14778 // For negative responses, we need the NSECs to prove the non-existence. If we don't
14779 // have the cached NSECs, purge them. For positive responses, if we don't have the
14780 // RRSIGs and if we have not already issued the question with EDNS0/DO bit set, purge
14781 // them.
14782 mDNSlocal void CheckForDNSSECRecords(mDNS *const m, DNSQuestion *q)
14783 {
14784     CacheGroup *const cg = CacheGroupForName(m, q->qnamehash, &q->qname);
14785     CacheRecord *rp;
14786 
14787     for (rp = cg ? cg->members : mDNSNULL; rp; rp = rp->next)
14788     {
14789         if (SameNameRecordAnswersQuestion(&rp->resrec, q))
14790         {
14791             if (rp->resrec.RecordType != kDNSRecordTypePacketNegative || !rp->nsec)
14792             {
14793                 if (!rp->CRDNSSECQuestion)
14794                 {
14795                     LogInfo("CheckForDNSSECRecords: Flushing %s", CRDisplayString(m, rp));
14796                     mDNS_PurgeCacheResourceRecord(m, rp);
14797                 }
14798             }
14799         }
14800     }
14801 }
14802 
14803 // Check for a positive unicast response to the question but with qtype
14804 mDNSexport mDNSBool mDNS_CheckForCacheRecord(mDNS *const m, DNSQuestion *q, mDNSu16 qtype)
14805 {
14806     DNSQuestion question;
14807     CacheGroup *const cg = CacheGroupForName(m, q->qnamehash, &q->qname);
14808     CacheRecord *rp;
14809 
14810     // Create an identical question but with qtype
14811     mDNS_SetupQuestion(&question, q->InterfaceID, &q->qname, qtype, mDNSNULL, mDNSNULL);
14812     question.qDNSServer = q->qDNSServer;
14813 
14814     for (rp = cg ? cg->members : mDNSNULL; rp; rp = rp->next)
14815     {
14816         if (!rp->resrec.InterfaceID && rp->resrec.RecordType != kDNSRecordTypePacketNegative &&
14817             SameNameRecordAnswersQuestion(&rp->resrec, &question))
14818         {
14819             LogInfo("mDNS_CheckForCacheRecord: Found %s", CRDisplayString(m, rp));
14820             return mDNStrue;
14821         }
14822     }
14823     return mDNSfalse;
14824 }
14825 
14826 mDNSexport void DNSServerChangeForQuestion(mDNS *const m, DNSQuestion *q, DNSServer *new)
14827 {
14828     DNSQuestion *qptr;
14829 
14830     (void) m;
14831 
14832     if (q->DuplicateOf)
14833         LogMsg("DNSServerChangeForQuestion: ERROR: Called for duplicate question %##s", q->qname.c);
14834 
14835     // Make sure all the duplicate questions point to the same DNSServer so that delivery
14836     // of events for all of them are consistent. Duplicates for a question are always inserted
14837     // after in the list.
14838     q->qDNSServer = new;
14839     for (qptr = q->next ; qptr; qptr = qptr->next)
14840     {
14841         if (qptr->DuplicateOf == q) { qptr->validDNSServers = q->validDNSServers; qptr->qDNSServer = new; }
14842     }
14843 }
14844 
14845 mDNSlocal void SetConfigState(mDNS *const m, mDNSBool delete)
14846 {
14847     McastResolver *mr;
14848     DNSServer *ptr;
14849 
14850     if (delete)
14851     {
14852         for (ptr = m->DNSServers; ptr; ptr = ptr->next)
14853         {
14854             ptr->penaltyTime = 0;
14855             NumUnicastDNSServers--;
14856             ptr->flags |= DNSServer_FlagDelete;
14857 #if APPLE_OSX_mDNSResponder
14858             if (ptr->flags & DNSServer_FlagUnreachable)
14859                 NumUnreachableDNSServers--;
14860 #endif
14861         }
14862         // We handle the mcast resolvers here itself as mDNSPlatformSetDNSConfig looks at
14863         // mcast resolvers. Today we get both mcast and ucast configuration using the same
14864         // API
14865         for (mr = m->McastResolvers; mr; mr = mr->next)
14866             mr->flags |= McastResolver_FlagDelete;
14867     }
14868     else
14869     {
14870         for (ptr = m->DNSServers; ptr; ptr = ptr->next)
14871         {
14872             ptr->penaltyTime = 0;
14873             NumUnicastDNSServers++;
14874             ptr->flags &= ~DNSServer_FlagDelete;
14875 #if APPLE_OSX_mDNSResponder
14876             if (ptr->flags & DNSServer_FlagUnreachable)
14877                 NumUnreachableDNSServers++;
14878 #endif
14879         }
14880         for (mr = m->McastResolvers; mr; mr = mr->next)
14881             mr->flags &= ~McastResolver_FlagDelete;
14882     }
14883 }
14884 
14885 mDNSlocal void SetDynDNSHostNameIfChanged(mDNS *const m, domainname *const fqdn)
14886 {
14887     // Did our FQDN change?
14888     if (!SameDomainName(fqdn, &m->FQDN))
14889     {
14890         if (m->FQDN.c[0]) mDNS_RemoveDynDNSHostName(m, &m->FQDN);
14891 
14892         AssignDomainName(&m->FQDN, fqdn);
14893 
14894         if (m->FQDN.c[0])
14895         {
14896             mDNSPlatformDynDNSHostNameStatusChanged(&m->FQDN, 1);
14897             mDNS_AddDynDNSHostName(m, &m->FQDN, DynDNSHostNameCallback, mDNSNULL);
14898         }
14899     }
14900 }
14901 
14902 mDNSexport mStatus uDNS_SetupDNSConfig(mDNS *const m)
14903 {
14904     mDNSu32 slot;
14905     CacheGroup *cg;
14906     CacheRecord *cr;
14907     mDNSBool Restart = mDNSfalse;
14908     mDNSAddr v4, v6, r;
14909     domainname fqdn;
14910     DNSServer   *ptr, **p = &m->DNSServers;
14911     const DNSServer *oldServers = m->DNSServers;
14912     DNSQuestion *q;
14913     McastResolver *mr, **mres = &m->McastResolvers;
14914 
14915     debugf("uDNS_SetupDNSConfig: entry");
14916 
14917     // Let the platform layer get the current DNS information and setup the WAB queries if needed.
14918     uDNS_SetupWABQueries(m);
14919 
14920     mDNS_Lock(m);
14921 
14922     // We need to first mark all the entries to be deleted. If the configuration changed, then
14923     // the entries would be undeleted appropriately. Otherwise, we need to clear them.
14924     //
14925     // Note: The last argument to mDNSPlatformSetDNSConfig is "mDNStrue" which means ack the
14926     // configuration. We already processed search domains in uDNS_SetupWABQueries above and
14927     // hence we are ready to ack the configuration as this is the last call to mDNSPlatformSetConfig
14928     // for the dns configuration change notification.
14929     SetConfigState(m, mDNStrue);
14930     if (!mDNSPlatformSetDNSConfig(mDNStrue, mDNSfalse, &fqdn, mDNSNULL, mDNSNULL, mDNStrue))
14931     {
14932         SetDynDNSHostNameIfChanged(m, &fqdn);
14933         SetConfigState(m, mDNSfalse);
14934         mDNS_Unlock(m);
14935         LogInfo("uDNS_SetupDNSConfig: No configuration change");
14936         return mStatus_NoError;
14937     }
14938 
14939     // For now, we just delete the mcast resolvers. We don't deal with cache or
14940     // questions here. Neither question nor cache point to mcast resolvers. Questions
14941     // do inherit the timeout values from mcast resolvers. But we don't bother
14942     // affecting them as they never change.
14943     while (*mres)
14944     {
14945         if (((*mres)->flags & McastResolver_FlagDelete) != 0)
14946         {
14947             mr = *mres;
14948             *mres = (*mres)->next;
14949             debugf("uDNS_SetupDNSConfig: Deleting mcast resolver %##s", mr, mr->domain.c);
14950             mDNSPlatformMemFree(mr);
14951         }
14952         else
14953         {
14954             (*mres)->flags &= ~McastResolver_FlagNew;
14955             mres = &(*mres)->next;
14956         }
14957     }
14958 
14959     // Update our qDNSServer pointers before we go and free the DNSServer object memory
14960     //
14961     // All non-scoped resolvers share the same resGroupID. At no point in time a cache entry using DNSServer
14962     // from scoped resolver will be used to answer non-scoped questions and vice versa, as scoped and non-scoped
14963     // resolvers don't share the same resGroupID. A few examples to describe the interaction with how we pick
14964     // DNSServers and flush the cache.
14965     //
14966     // - A non-scoped question picks DNSServer X, creates a cache entry with X. If a new resolver gets added later that
14967     //   is a better match, we pick the new DNSServer for the question and activate the unicast query. We may or may not
14968     //   flush the cache (See PurgeOrReconfirmCacheRecord). In either case, we don't change the cache record's DNSServer
14969     //   pointer immediately (qDNSServer and rDNSServer may be different but still share the same resGroupID). If we don't
14970     //   flush the cache immediately, the record's rDNSServer pointer will be updated (in mDNSCoreReceiveResponse)
14971     //   later when we get the response. If we purge the cache, we still deliver a RMV when it is purged even though
14972     //   we don't update the cache record's DNSServer pointer to match the question's DNSSever, as they both point to
14973     //   the same resGroupID.
14974     //
14975     //   Note: If the new DNSServer comes back with a different response than what we have in the cache, we will deliver a RMV
14976     //   of the old followed by ADD of the new records.
14977     //
14978     // - A non-scoped question picks DNSServer X,  creates a cache entry with X. If the resolver gets removed later, we will
14979     //   pick a new DNSServer for the question which may or may not be NULL and set the cache record's pointer to the same
14980     //   as in question's qDNSServer if the cache record is not flushed. If there is no active question, it will be set to NULL.
14981     //
14982     // - Two questions scoped and non-scoped for the same name will pick two different DNSServer and will end up creating separate
14983     //   cache records and as the resGroupID is different, you can't use the cache record from the scoped DNSServer to answer the
14984     //   non-scoped question and vice versa.
14985     //
14986 #if USE_DNS64
14987     DNS64RestartQuestions(m);
14988 #endif
14989     for (q = m->Questions; q; q=q->next)
14990     {
14991         if (!mDNSOpaque16IsZero(q->TargetQID))
14992         {
14993             DNSServer *s, *t;
14994             DNSQuestion *qptr;
14995             if (q->DuplicateOf) continue;
14996             SetValidDNSServers(m, q);
14997             q->triedAllServersOnce = 0;
14998             s = GetServerForQuestion(m, q);
14999             t = q->qDNSServer;
15000             if (t != s)
15001             {
15002                 mDNSBool old, new;
15003 		mDNSIPPort tport, sport;
15004 
15005 		if (t)
15006 			tport = t->port;
15007 		else
15008 			tport = zeroIPPort;
15009 
15010 		if (s)
15011 			sport = s->port;
15012 		else
15013 			sport = zeroIPPort;
15014                 // If DNS Server for this question has changed, reactivate it
15015                 LogInfo("uDNS_SetupDNSConfig: Updating DNS Server from %#a:%d (%##s) to %#a:%d (%##s) for question %##s (%s) (scope:%p)",
15016                         t ? &t->addr : mDNSNULL, mDNSVal16(tport), t ? t->domain.c : (mDNSu8*)"",
15017                         s ? &s->addr : mDNSNULL, mDNSVal16(sport), s ? s->domain.c : (mDNSu8*)"",
15018                         q->qname.c, DNSTypeName(q->qtype), q->InterfaceID);
15019 
15020                 old = q->SuppressQuery;
15021                 new = ShouldSuppressUnicastQuery(m, q, s);
15022                 if (old != new)
15023                 {
15024                     // Changing the DNS server affected the SuppressQuery status. We need to
15025                     // deliver RMVs for the previous ADDs (if any) before switching to the new
15026                     // DNSServer.  To keep it simple, we walk all the questions and mark them
15027                     // to be restarted and then handle all of them at once.
15028                     q->Restart = 1;
15029                     q->SuppressQuery = new;
15030                     for (qptr = q->next ; qptr; qptr = qptr->next)
15031                     {
15032                         if (qptr->DuplicateOf == q)
15033                             qptr->Restart = 1;
15034                     }
15035                     Restart = mDNStrue;
15036                 }
15037                 else
15038                 {
15039                     DNSServerChangeForQuestion(m, q, s);
15040                     q->unansweredQueries = 0;
15041 
15042                     // If we had sent a query out to DNSServer "t" and we are changing to "s", we
15043                     // need to ignore the responses coming back from "t" as the DNS configuration
15044                     // has changed e.g., when a new interface is coming up and that becomes the primary
15045                     // interface, we switch to the DNS servers configured for the primary interface. In
15046                     // this case, we should not accept responses associated with the previous interface as
15047                     // the "name" could resolve differently on this new primary interface. Hence, discard
15048                     // in-flight responses.
15049                     q->TargetQID = mDNS_NewMessageID(m);
15050 
15051                     if (!QuerySuppressed(q))
15052                     {
15053                         debugf("uDNS_SetupDNSConfig: Activating query %p %##s (%s)", q, q->qname.c, DNSTypeName(q->qtype));
15054                         ActivateUnicastQuery(m, q, mDNStrue);
15055                         // ActivateUnicastQuery is called for duplicate questions also as it does something
15056                         // special for AutoTunnel questions
15057                         for (qptr = q->next ; qptr; qptr = qptr->next)
15058                         {
15059                             if (qptr->DuplicateOf == q) ActivateUnicastQuery(m, qptr, mDNStrue);
15060                         }
15061                     }
15062                 }
15063             }
15064             else
15065             {
15066 		mDNSIPPort zp = zeroIPPort;
15067                 debugf("uDNS_SetupDNSConfig: Not Updating DNS server question %p %##s (%s) DNS server %#a:%d %p %d",
15068                        q, q->qname.c, DNSTypeName(q->qtype), t ? &t->addr : mDNSNULL, mDNSVal16(t ? t->port : zp), q->DuplicateOf, q->SuppressUnusable);
15069                 for (qptr = q->next ; qptr; qptr = qptr->next)
15070                     if (qptr->DuplicateOf == q) { qptr->validDNSServers = q->validDNSServers; qptr->qDNSServer = q->qDNSServer; }
15071             }
15072         }
15073     }
15074     if (Restart)
15075         RestartUnicastQuestions(m);
15076 
15077     FORALL_CACHERECORDS(slot, cg, cr)
15078     {
15079         if (cr->resrec.InterfaceID)
15080             continue;
15081 
15082         // We already walked the questions and restarted/reactivated them if the dns server
15083         // change affected the question. That should take care of updating the cache. But
15084         // what if there is no active question at this point when the DNS server change
15085         // happened ? There could be old cache entries lying around and if we don't flush
15086         // them, a new question after the DNS server change could pick up these stale
15087         // entries and get a wrong answer.
15088         //
15089         // For cache entries that have active questions we might have skipped rescheduling
15090         // the questions if they were suppressed (see above). To keep it simple, we walk
15091         // all the cache entries to make sure that there are no stale entries. We use the
15092         // active question's InterfaceID/ServiceID for looking up the right DNS server.
15093         // Note that the unscoped value for ServiceID is -1.
15094         //
15095         // Note: If GetServerForName returns NULL, it could either mean that there are no
15096         // DNS servers or no matching DNS servers for this question. In either case,
15097         // the cache should get purged below when we process deleted DNS servers.
15098 
15099         ptr = GetServerForName(m, cr->resrec.name,
15100                                (cr->CRActiveQuestion ? cr->CRActiveQuestion->InterfaceID : mDNSNULL),
15101                                (cr->CRActiveQuestion ? cr->CRActiveQuestion->ServiceID   : -1));
15102 
15103         // Purge or Reconfirm if this cache entry would use the new DNS server
15104         if (ptr && (ptr != cr->resrec.rDNSServer))
15105         {
15106             // As the DNSServers for this cache record is not the same anymore, we don't
15107             // want any new questions to pick this old value. If there is no active question,
15108             // we can't possibly re-confirm, so purge in that case. If it is a DNSSEC question,
15109             // purge the cache as the DNSSEC capabilities of the DNS server may have changed.
15110 
15111             if (cr->CRActiveQuestion == mDNSNULL || DNSSECQuestion(cr->CRActiveQuestion))
15112             {
15113                 LogInfo("uDNS_SetupDNSConfig: Purging Resourcerecord %s, New DNS server %#a , Old DNS server %#a", CRDisplayString(m, cr),
15114                         &ptr->addr, (cr->resrec.rDNSServer != mDNSNULL ?  &cr->resrec.rDNSServer->addr : mDNSNULL));
15115                 cr->resrec.mortality = Mortality_Mortal;
15116                 mDNS_PurgeCacheResourceRecord(m, cr);
15117             }
15118             else
15119             {
15120                 LogInfo("uDNS_SetupDNSConfig: Purging/Reconfirming Resourcerecord %s, New DNS server %#a, Old DNS server %#a", CRDisplayString(m, cr),
15121                         &ptr->addr, (cr->resrec.rDNSServer != mDNSNULL ?  &cr->resrec.rDNSServer->addr : mDNSNULL));
15122                 PurgeOrReconfirmCacheRecord(m, cr, ptr, mDNSfalse);
15123             }
15124         }
15125 
15126         // If a cache record's DNSServer pointer is NULL, but its active question got a DNSServer in this DNS configuration
15127         // update, then use its DNSServer. This way, the active question and its duplicates don't miss out on RMV events.
15128         if (!cr->resrec.rDNSServer && cr->CRActiveQuestion && cr->CRActiveQuestion->qDNSServer)
15129         {
15130             cr->resrec.rDNSServer = cr->CRActiveQuestion->qDNSServer;
15131             LogInfo("uDNS_SetupDNSConfig: Using active question's DNS server %#a for cache record %s", &cr->resrec.rDNSServer->addr, CRDisplayString(m, cr));
15132         }
15133     }
15134 
15135     while (*p)
15136     {
15137         if (((*p)->flags & DNSServer_FlagDelete) != 0)
15138         {
15139             // Scan our cache, looking for uDNS records that we would have queried this server for.
15140             // We reconfirm any records that match, because in this world of split DNS, firewalls, etc.
15141             // different DNS servers can give different answers to the same question.
15142             ptr = *p;
15143             FORALL_CACHERECORDS(slot, cg, cr)
15144             {
15145                 if (cr->resrec.InterfaceID) continue;
15146                 if (cr->resrec.rDNSServer == ptr)
15147                 {
15148                     // If we don't have an active question for this cache record, neither Purge can
15149                     // generate RMV events nor Reconfirm can send queries out. Just set the DNSServer
15150                     // pointer on the record NULL so that we don't point to freed memory (We might dereference
15151                     // DNSServer pointers from resource record for logging purposes).
15152                     //
15153                     // If there is an active question, point to its DNSServer as long as it does not point to the
15154                     // freed one. We already went through the questions above and made them point at either the
15155                     // new server or NULL if there is no server.
15156 
15157                     if (cr->CRActiveQuestion)
15158                     {
15159                         DNSQuestion *qptr = cr->CRActiveQuestion;
15160 
15161                         if (qptr->qDNSServer == ptr)
15162                         {
15163                             LogMsg("uDNS_SetupDNSConfig: ERROR!! Cache Record %s  Active question %##s (%s) (scope:%p) pointing to DNSServer Address %#a"
15164                                    " to be freed", CRDisplayString(m, cr),  qptr->qname.c, DNSTypeName(qptr->qtype), qptr->InterfaceID, &ptr->addr);
15165                             qptr->validDNSServers = zeroOpaque128;
15166                             qptr->qDNSServer = mDNSNULL;
15167                             cr->resrec.rDNSServer = mDNSNULL;
15168                         }
15169                         else
15170                         {
15171                             LogInfo("uDNS_SetupDNSConfig: Cache Record %s,  Active question %##s (%s) (scope:%p), pointing to DNSServer %#a (to be deleted),"
15172                                     " resetting to  question's DNSServer Address %#a", CRDisplayString(m, cr),  qptr->qname.c, DNSTypeName(qptr->qtype),
15173                                     qptr->InterfaceID, &ptr->addr, (qptr->qDNSServer) ? &qptr->qDNSServer->addr : mDNSNULL);
15174                             cr->resrec.rDNSServer = qptr->qDNSServer;
15175                         }
15176                     }
15177                     else
15178                     {
15179                         LogInfo("uDNS_SetupDNSConfig: Cache Record %##s has no Active question, Record's DNSServer Address %#a, Server to be deleted %#a",
15180                                 cr->resrec.name, &cr->resrec.rDNSServer->addr, &ptr->addr);
15181                         cr->resrec.rDNSServer = mDNSNULL;
15182                     }
15183 
15184                     cr->resrec.mortality = Mortality_Mortal;
15185                     PurgeOrReconfirmCacheRecord(m, cr, ptr, mDNStrue);
15186                 }
15187             }
15188             *p = (*p)->next;
15189             LogInfo("uDNS_SetupDNSConfig: Deleting server %p %#a:%d (%##s) %d", ptr, &ptr->addr, mDNSVal16(ptr->port), ptr->domain.c, NumUnicastDNSServers);
15190             mDNSPlatformMemFree(ptr);
15191         }
15192         else
15193         {
15194             (*p)->flags &= ~DNSServer_FlagNew;
15195             p = &(*p)->next;
15196         }
15197     }
15198 
15199     // If we now have no DNS servers at all and we used to have some, then immediately purge all unicast cache records (including for LLQs).
15200     // This is important for giving prompt remove events when the user disconnects the Ethernet cable or turns off wireless.
15201     // Otherwise, stale data lingers for 5-10 seconds, which is not the user-experience people expect from Bonjour.
15202     // Similarly, if we now have some DNS servers and we used to have none, we want to purge any fake negative results we may have generated.
15203     if ((m->DNSServers != mDNSNULL) != (oldServers != mDNSNULL))
15204     {
15205         int count = 0;
15206         FORALL_CACHERECORDS(slot, cg, cr)
15207         {
15208             if (!cr->resrec.InterfaceID)
15209             {
15210                 mDNS_PurgeCacheResourceRecord(m, cr);
15211                 count++;
15212             }
15213         }
15214         LogInfo("uDNS_SetupDNSConfig: %s available; purged %d unicast DNS records from cache",
15215                 m->DNSServers ? "DNS server became" : "No DNS servers", count);
15216 
15217         // Force anything that needs to get zone data to get that information again
15218         RestartRecordGetZoneData(m);
15219     }
15220 
15221     SetDynDNSHostNameIfChanged(m, &fqdn);
15222 
15223     mDNS_Unlock(m);
15224 
15225     // handle router and primary interface changes
15226     v4 = v6 = r = zeroAddr;
15227     v4.type = r.type = mDNSAddrType_IPv4;
15228 
15229     if (mDNSPlatformGetPrimaryInterface(&v4, &v6, &r) == mStatus_NoError && !mDNSv4AddressIsLinkLocal(&v4.ip.v4))
15230     {
15231         mDNS_SetPrimaryInterfaceInfo(m,
15232                                      !mDNSIPv4AddressIsZero(v4.ip.v4) ? &v4 : mDNSNULL,
15233                                      !mDNSIPv6AddressIsZero(v6.ip.v6) ? &v6 : mDNSNULL,
15234                                      !mDNSIPv4AddressIsZero(r.ip.v4) ? &r  : mDNSNULL);
15235     }
15236     else
15237     {
15238         mDNS_SetPrimaryInterfaceInfo(m, mDNSNULL, mDNSNULL, mDNSNULL);
15239         if (m->FQDN.c[0]) mDNSPlatformDynDNSHostNameStatusChanged(&m->FQDN, 1); // Set status to 1 to indicate temporary failure
15240     }
15241 
15242     debugf("uDNS_SetupDNSConfig: number of unicast DNS servers %d", NumUnicastDNSServers);
15243     return mStatus_NoError;
15244 }
15245 
15246 mDNSexport void mDNSCoreInitComplete(mDNS *const m, mStatus result)
15247 {
15248     m->mDNSPlatformStatus = result;
15249     if (m->MainCallback)
15250     {
15251         mDNS_Lock(m);
15252         mDNS_DropLockBeforeCallback();      // Allow client to legally make mDNS API calls from the callback
15253         m->MainCallback(m, mStatus_NoError);
15254         mDNS_ReclaimLockAfterCallback();    // Decrement mDNS_reentrancy to block mDNS API calls again
15255         mDNS_Unlock(m);
15256     }
15257 }
15258 
15259 mDNSlocal void DeregLoop(mDNS *const m, AuthRecord *const start)
15260 {
15261     m->CurrentRecord = start;
15262     while (m->CurrentRecord)
15263     {
15264         AuthRecord *rr = m->CurrentRecord;
15265         LogInfo("DeregLoop: %s deregistration for %p %02X %s",
15266                 (rr->resrec.RecordType != kDNSRecordTypeDeregistering) ? "Initiating  " : "Accelerating",
15267                 rr, rr->resrec.RecordType, ARDisplayString(m, rr));
15268         if (rr->resrec.RecordType != kDNSRecordTypeDeregistering)
15269             mDNS_Deregister_internal(m, rr, mDNS_Dereg_rapid);
15270         else if (rr->AnnounceCount > 1)
15271         {
15272             rr->AnnounceCount = 1;
15273             rr->LastAPTime = m->timenow - rr->ThisAPInterval;
15274         }
15275         // Mustn't advance m->CurrentRecord until *after* mDNS_Deregister_internal, because
15276         // new records could have been added to the end of the list as a result of that call.
15277         if (m->CurrentRecord == rr) // If m->CurrentRecord was not advanced for us, do it now
15278             m->CurrentRecord = rr->next;
15279     }
15280 }
15281 
15282 mDNSexport void mDNS_StartExit(mDNS *const m)
15283 {
15284     AuthRecord *rr;
15285 
15286     mDNS_Lock(m);
15287 
15288     LogInfo("mDNS_StartExit");
15289     m->ShutdownTime = NonZeroTime(m->timenow + mDNSPlatformOneSecond * 5);
15290 
15291     mDNSCoreBeSleepProxyServer_internal(m, 0, 0, 0, 0, 0);
15292 
15293 #if APPLE_OSX_mDNSResponder
15294 #if !NO_WCF
15295     CHECK_WCF_FUNCTION(WCFConnectionDealloc)
15296     {
15297         if (m->WCF) WCFConnectionDealloc((WCFConnection *)m->WCF);
15298     }
15299 #endif
15300 #endif
15301 
15302 #ifndef UNICAST_DISABLED
15303     {
15304         SearchListElem *s;
15305         SuspendLLQs(m);
15306         // Don't need to do SleepRecordRegistrations() here
15307         // because we deregister all records and services later in this routine
15308         while (m->Hostnames) mDNS_RemoveDynDNSHostName(m, &m->Hostnames->fqdn);
15309 
15310         // For each member of our SearchList, deregister any records it may have created, and cut them from the list.
15311         // Otherwise they'll be forcibly deregistered for us (without being cut them from the appropriate list)
15312         // and we may crash because the list still contains dangling pointers.
15313         for (s = SearchList; s; s = s->next)
15314             while (s->AuthRecs)
15315             {
15316                 ARListElem *dereg = s->AuthRecs;
15317                 s->AuthRecs = s->AuthRecs->next;
15318                 mDNS_Deregister_internal(m, &dereg->ar, mDNS_Dereg_normal); // Memory will be freed in the FreeARElemCallback
15319             }
15320     }
15321 #endif
15322 
15323     DeadvertiseAllInterfaceRecords(m);
15324 
15325     // Shut down all our active NAT Traversals
15326     while (m->NATTraversals)
15327     {
15328         NATTraversalInfo *t = m->NATTraversals;
15329         mDNS_StopNATOperation_internal(m, t);       // This will cut 't' from the list, thereby advancing m->NATTraversals in the process
15330 
15331         // After stopping the NAT Traversal, we zero out the fields.
15332         // This has particularly important implications for our AutoTunnel records --
15333         // when we deregister our AutoTunnel records below, we don't want their mStatus_MemFree
15334         // handlers to just turn around and attempt to re-register those same records.
15335         // Clearing t->ExternalPort/t->RequestedPort will cause the mStatus_MemFree callback handlers
15336         // to not do this.
15337         t->ExternalAddress = zerov4Addr;
15338         t->NewAddress      = zerov4Addr;
15339         t->ExternalPort    = zeroIPPort;
15340         t->RequestedPort   = zeroIPPort;
15341         t->Lifetime        = 0;
15342         t->Result          = mStatus_NoError;
15343     }
15344 
15345     // Make sure there are nothing but deregistering records remaining in the list
15346     if (m->CurrentRecord)
15347         LogMsg("mDNS_StartExit: ERROR m->CurrentRecord already set %s", ARDisplayString(m, m->CurrentRecord));
15348 
15349     // We're in the process of shutting down, so queries, etc. are no longer available.
15350     // Consequently, determining certain information, e.g. the uDNS update server's IP
15351     // address, will not be possible.  The records on the main list are more likely to
15352     // already contain such information, so we deregister the duplicate records first.
15353     LogInfo("mDNS_StartExit: Deregistering duplicate resource records");
15354     DeregLoop(m, m->DuplicateRecords);
15355     LogInfo("mDNS_StartExit: Deregistering resource records");
15356     DeregLoop(m, m->ResourceRecords);
15357 
15358     // If we scheduled a response to send goodbye packets, we set NextScheduledResponse to now. Normally when deregistering records,
15359     // we allow up to 100ms delay (to help improve record grouping) but when shutting down we don't want any such delay.
15360     if (m->NextScheduledResponse - m->timenow < mDNSPlatformOneSecond)
15361     {
15362         m->NextScheduledResponse = m->timenow;
15363         m->SuppressSending = 0;
15364     }
15365 
15366     if (m->ResourceRecords) LogInfo("mDNS_StartExit: Sending final record deregistrations");
15367     else LogInfo("mDNS_StartExit: No deregistering records remain");
15368 
15369     for (rr = m->DuplicateRecords; rr; rr = rr->next)
15370         LogMsg("mDNS_StartExit: Should not still have Duplicate Records remaining: %02X %s", rr->resrec.RecordType, ARDisplayString(m, rr));
15371 
15372     // If any deregistering records remain, send their deregistration announcements before we exit
15373     if (m->mDNSPlatformStatus != mStatus_NoError) DiscardDeregistrations(m);
15374 
15375     mDNS_Unlock(m);
15376 
15377     LogInfo("mDNS_StartExit: done");
15378 }
15379 
15380 mDNSexport void mDNS_FinalExit(mDNS *const m)
15381 {
15382     mDNSu32 rrcache_active = 0;
15383     mDNSu32 rrcache_totalused = m->rrcache_totalused;
15384     mDNSu32 slot;
15385     AuthRecord *rr;
15386 
15387     LogInfo("mDNS_FinalExit: mDNSPlatformClose");
15388     mDNSPlatformClose(m);
15389 
15390     for (slot = 0; slot < CACHE_HASH_SLOTS; slot++)
15391     {
15392         while (m->rrcache_hash[slot])
15393         {
15394             CacheGroup *cg = m->rrcache_hash[slot];
15395             while (cg->members)
15396             {
15397                 CacheRecord *cr = cg->members;
15398                 cg->members = cg->members->next;
15399                 if (cr->CRActiveQuestion) rrcache_active++;
15400                 ReleaseCacheRecord(m, cr);
15401             }
15402             cg->rrcache_tail = &cg->members;
15403             ReleaseCacheGroup(m, &m->rrcache_hash[slot]);
15404         }
15405     }
15406     debugf("mDNS_FinalExit: RR Cache was using %ld records, %lu active", rrcache_totalused, rrcache_active);
15407     if (rrcache_active != m->rrcache_active)
15408         LogMsg("*** ERROR *** rrcache_totalused %lu; rrcache_active %lu != m->rrcache_active %lu", rrcache_totalused, rrcache_active, m->rrcache_active);
15409 
15410     for (rr = m->ResourceRecords; rr; rr = rr->next)
15411         LogMsg("mDNS_FinalExit failed to send goodbye for: %p %02X %s", rr, rr->resrec.RecordType, ARDisplayString(m, rr));
15412 
15413     LogInfo("mDNS_FinalExit: done");
15414 }
15415 
15416 #ifdef UNIT_TEST
15417 #include "../unittests/mdns_ut.c"
15418 #endif
15419